VTK  9.3.20240622
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkOSPRayRendererNode Class Reference

links vtkRenderers to OSPRay More...

#include <vtkOSPRayRendererNode.h>

Inheritance diagram for vtkOSPRayRendererNode:
[legend]
Collaboration diagram for vtkOSPRayRendererNode:
[legend]

Public Types

enum  BackgroundMode {
  None , Backplate , Environment , Both ,
  NumberOfMode
}
 
typedef vtkRendererNode Superclass
 
- Public Types inherited from vtkRendererNode
typedef vtkViewNode Superclass
 
- Public Types inherited from vtkViewNode
enum  operation_type {
  noop , build , synchronize , render ,
  invalidate
}
 internal mechanics of graph traversal and actions More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkOSPRayRendererNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Build (bool prepass) override
 Builds myself.
 
void Render (bool prepass) override
 Traverse graph in ospray's preferred order and render.
 
void Invalidate (bool prepass) override
 Invalidates cached rendering data.
 
virtual void WriteLayer (unsigned char *buffer, float *zbuffer, int buffx, int buffy, int layer)
 Put my results into the correct place in the provided pixel buffer.
 
OSPRenderer GetORenderer ()
 Methods for other nodes to access.
 
void AddLight (OSPLight light)
 
virtual void * GetBuffer ()
 Get the last rendered ColorBuffer.
 
virtual float * GetZBuffer ()
 Get the last rendered ZBuffer.
 
virtual int GetColorBufferTextureGL ()
 
virtual int GetDepthBufferTextureGL ()
 
void Traverse (int operation) override
 
vtkRendererGetRenderer ()
 
RTW::BackendGetBackend ()
 
- Public Member Functions inherited from vtkRendererNode
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRendererNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Build (bool prepass) override
 Build containers for our child nodes.
 
virtual int * GetSize ()
 Get/Set the framebuffer size.
 
virtual void GetSize (int &, int &)
 
virtual void GetSize (int[2])
 
virtual void SetSize (int, int)
 
void SetSize (int[2])
 
virtual double * GetViewport ()
 Get/Set the window viewport.
 
virtual void GetViewport (double &, double &, double &, double &)
 
virtual void GetViewport (double[4])
 
virtual void SetViewport (double, double, double, double)
 
virtual void SetViewport (double[4])
 
virtual int * GetScale ()
 Get/Set the window tile scale.
 
virtual void GetScale (int &, int &)
 
virtual void GetScale (int[2])
 
virtual void SetScale (int, int)
 
void SetScale (int[2])
 
- Public Member Functions inherited from vtkViewNode
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkViewNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Build (bool)
 Builds myself.
 
virtual void Synchronize (bool)
 Ensures that my state agrees with my Renderable's.
 
virtual void Render (bool)
 Makes calls to make self visible.
 
virtual void Invalidate (bool)
 Clear any cached data.
 
vtkViewNodeGetViewNodeFor (vtkObject *)
 Returns the view node that corresponding to the provided object Will return NULL if a match is not found in self or descendents.
 
vtkViewNodeGetFirstAncestorOfType (const char *type)
 Find the first parent/grandparent of the desired type.
 
vtkViewNodeGetFirstChildOfType (const char *type)
 Find the first child of the desired type.
 
virtual void SetRenderable (vtkObject *)
 Allow explicit setting of the renderable for a view node.
 
virtual void Traverse (int operation)
 
virtual void TraverseAllPasses ()
 
virtual vtkObjectGetRenderable ()
 This is the VTK class that this node stands in for.
 
virtual void SetParent (vtkViewNode *)
 Access the node that owns this one.
 
virtual vtkViewNodeGetParent ()
 Access the node that owns this one.
 
virtual std::list< vtkViewNode * > const & GetChildren ()
 Access nodes that this one owns.
 
virtual void SetMyFactory (vtkViewNodeFactory *)
 A factory that creates particular subclasses for different rendering back ends.
 
virtual vtkViewNodeFactoryGetMyFactory ()
 A factory that creates particular subclasses for different rendering back ends.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkOSPRayRendererNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOSPRayRendererNodeSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeySAMPLES_PER_PIXEL ()
 When present on renderer, controls the number of primary rays shot per pixel default is 1.
 
static vtkInformationDoubleKeyMAX_CONTRIBUTION ()
 When present on renderer, samples are clamped to this value before they are accumulated into the framebuffer default is 2.0.
 
static vtkInformationIntegerKeyMAX_DEPTH ()
 When present on renderer, controls the maximum ray recursion depth default is 20.
 
static vtkInformationDoubleKeyMIN_CONTRIBUTION ()
 When present on renderer, sample contributions below this value will be neglected to speedup rendering default is 0.01.
 
static vtkInformationIntegerKeyROULETTE_DEPTH ()
 When present on renderer, controls the ray recursion depth at which to start Russian roulette termination default is 5.
 
static vtkInformationDoubleKeyVARIANCE_THRESHOLD ()
 When present on renderer, controls the threshold for adaptive accumulation default is 0.3.
 
static vtkInformationIntegerKeyAMBIENT_SAMPLES ()
 When present on renderer, controls the number of ambient occlusion samples shot per hit.
 
static vtkInformationDoubleKeyVOLUME_SAMPLING_RATE ()
 the rate of sampling for volumes, higher numbers increase the number of samples.
 
static vtkInformationIntegerKeyCOMPOSITE_ON_GL ()
 used to make the renderer add ospray's content onto GL rendered content on the window
 
static vtkInformationDoubleVectorKeyNORTH_POLE ()
 World space direction of north pole for gradient and texture background.
 
static vtkInformationDoubleVectorKeyEAST_POLE ()
 World space direction of east pole for texture background.
 
static vtkInformationObjectBaseKeyMATERIAL_LIBRARY ()
 Material Library attached to the renderer.
 
static vtkInformationDoubleKeyVIEW_TIME ()
 Requested time to show in a renderer and to lookup in a temporal cache.
 
static vtkInformationIntegerKeyTIME_CACHE_SIZE ()
 Temporal cache size.
 
static vtkOSPRayRendererNodeGetRendererNode (vtkViewNode *)
 Convenience method to get and downcast renderable.
 
static vtkInformationIntegerKeyDENOISER_THRESHOLD ()
 Accumulation threshold when above which denoising kicks in.
 
static void SetSamplesPerPixel (int, vtkRenderer *renderer)
 Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.
 
static int GetSamplesPerPixel (vtkRenderer *renderer)
 Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.
 
static void SetMaxContribution (double, vtkRenderer *renderer)
 Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.
 
static double GetMaxContribution (vtkRenderer *renderer)
 Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.
 
static void SetMaxDepth (int, vtkRenderer *renderer)
 Convenience method to set/get MAX_DEPTH on a vtkRenderer.
 
static int GetMaxDepth (vtkRenderer *renderer)
 Convenience method to set/get MAX_DEPTH on a vtkRenderer.
 
static void SetMinContribution (double, vtkRenderer *renderer)
 Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.
 
static double GetMinContribution (vtkRenderer *renderer)
 Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.
 
static void SetRouletteDepth (int, vtkRenderer *renderer)
 Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.
 
static int GetRouletteDepth (vtkRenderer *renderer)
 Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.
 
static void SetVarianceThreshold (double, vtkRenderer *renderer)
 Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.
 
static double GetVarianceThreshold (vtkRenderer *renderer)
 Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.
 
static vtkInformationIntegerKeyMAX_FRAMES ()
 When present on renderer, controls the number of ospray render calls for each refresh.
 
static void SetMaxFrames (int, vtkRenderer *renderer)
 When present on renderer, controls the number of ospray render calls for each refresh.
 
static int GetMaxFrames (vtkRenderer *renderer)
 When present on renderer, controls the number of ospray render calls for each refresh.
 
static vtkInformationStringKeyRENDERER_TYPE ()
 Set the OSPRay renderer type to use (e.g.
 
static void SetRendererType (std::string name, vtkRenderer *renderer)
 Set the OSPRay renderer type to use (e.g.
 
static std::string GetRendererType (vtkRenderer *renderer)
 Set the OSPRay renderer type to use (e.g.
 
static void SetAmbientSamples (int, vtkRenderer *renderer)
 Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.
 
static int GetAmbientSamples (vtkRenderer *renderer)
 Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.
 
static void SetVolumeSamplingRate (double, vtkRenderer *renderer)
 Convenience method VOLUME_SAMPLING_RATE on a vtkRenderer.
 
static double GetVolumeSamplingRate (vtkRenderer *renderer)
 Convenience method VOLUME_SAMPLING_RATE on a vtkRenderer.
 
static void SetCompositeOnGL (int, vtkRenderer *renderer)
 Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.
 
static int GetCompositeOnGL (vtkRenderer *renderer)
 Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.
 
static void SetNorthPole (double *, vtkRenderer *renderer)
 Convenience method to set/get NORTH_POLE on a vtkRenderer.
 
static double * GetNorthPole (vtkRenderer *renderer)
 Convenience method to set/get NORTH_POLE on a vtkRenderer.
 
static void SetEastPole (double *, vtkRenderer *renderer)
 Convenience method to set/get EAST_POLE on a vtkRenderer.
 
static double * GetEastPole (vtkRenderer *renderer)
 Convenience method to set/get EAST_POLE on a vtkRenderer.
 
static void SetMaterialLibrary (vtkOSPRayMaterialLibrary *, vtkRenderer *renderer)
 Convenience method to set/get Material library on a renderer.
 
static vtkOSPRayMaterialLibraryGetMaterialLibrary (vtkRenderer *renderer)
 Convenience method to set/get Material library on a renderer.
 
static void SetViewTime (double, vtkRenderer *renderer)
 Convenience method to set/get VIEW_TIME on a vtkRenderer.
 
static double GetViewTime (vtkRenderer *renderer)
 Convenience method to set/get VIEW_TIME on a vtkRenderer.
 
static void SetTimeCacheSize (int, vtkRenderer *renderer)
 Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.
 
static int GetTimeCacheSize (vtkRenderer *renderer)
 Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.
 
static void SetDenoiserThreshold (int, vtkRenderer *renderer)
 Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.
 
static int GetDenoiserThreshold (vtkRenderer *renderer)
 Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.
 
static vtkInformationIntegerKeyENABLE_DENOISER ()
 Enable denoising (if supported).
 
static void SetEnableDenoiser (int, vtkRenderer *renderer)
 Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.
 
static int GetEnableDenoiser (vtkRenderer *renderer)
 Enable denoising (if supported).
 
static vtkInformationIntegerKeyBACKGROUND_MODE ()
 Control use of the path tracer backplate and environmental background.
 
static void SetBackgroundMode (BackgroundMode, vtkRenderer *renderer)
 Control use of the path tracer backplate and environmental background.
 
static BackgroundMode GetBackgroundMode (vtkRenderer *renderer)
 Control use of the path tracer backplate and environmental background.
 
- Static Public Member Functions inherited from vtkRendererNode
static vtkRendererNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRendererNodeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkViewNode
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewNodeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Public Attributes

std::vector< OSPGeometricModelGeometricModels
 
std::vector< OSPVolumetricModelVolumetricModels
 
std::vector< OSPInstanceInstances
 
- Public Attributes inherited from vtkViewNode
vtkMTimeType RenderTime
 Allows smart caching.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOSPRayRendererNode ()
 
 ~vtkOSPRayRendererNode () override
 
void Denoise ()
 Denoise the colors stored in ColorBuffer and put into Buffer.
 
- Protected Member Functions inherited from vtkRendererNode
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRendererNode ()
 
 ~vtkRendererNode () override
 
- Protected Member Functions inherited from vtkViewNode
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkViewNode ()
 
 ~vtkViewNode () override
 
virtual void Apply (int operation, bool prepass)
 
void RemoveUnusedNodes ()
 Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.
 
virtual vtkViewNodeCreateViewNode (vtkObject *obj)
 Create the correct ViewNode subclass for the passed in object.
 
void AddMissingNode (vtkObject *obj)
 convenience method to add node or nodes if missing from our current list
 
void AddMissingNodes (vtkCollection *col)
 convenience method to add node or nodes if missing from our current list
 
void PrepareNodes ()
 Called first before adding missing nodes.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::vector< float > Buffer
 
std::vector< float > ZBuffer
 
int ColorBufferTex
 
int DepthBufferTex
 
OSPWorld OWorld { nullptr }
 
OSPRenderer ORenderer { nullptr }
 
OSPFrameBuffer OFrameBuffer { nullptr }
 
OSPCamera OCamera { nullptr }
 
int ImageX
 
int ImageY
 
std::vector< OSPLightLights
 
int NumActors
 
bool ComputeDepth
 
bool Accumulate
 
bool CompositeOnGL
 
bool UseBackplate { true }
 
std::vector< float > ODepthBuffer
 
int AccumulateCount
 
int ActorCount
 
vtkMTimeType AccumulateTime
 
vtkMatrix4x4AccumulateMatrix
 
vtkOSPRayRendererNodeInternals * Internal
 
std::string PreviousType
 
bool DenoiserDirty { true }
 
std::vector< osp::vec4f > ColorBuffer
 
std::vector< osp::vec3f > NormalBuffer
 
std::vector< osp::vec3f > AlbedoBuffer
 
std::vector< osp::vec4f > DenoisedBuffer
 
vtkOSPRayCache< vtkOSPRayCacheItemObject > * Cache
 
std::set< OSPWorldCacheContents
 
- Protected Attributes inherited from vtkRendererNode
int Size [2]
 
double Viewport [4]
 
int Scale [2]
 
- Protected Attributes inherited from vtkViewNode
vtkObjectRenderable
 
vtkWeakPointer< vtkViewNodeParent
 
std::list< vtkViewNode * > Children
 
vtkViewNodeFactoryMyFactory
 
std::map< vtkObject *, vtkViewNode * > Renderables
 
bool Used
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkViewNode
static const char * operation_type_strings []
 

Detailed Description

links vtkRenderers to OSPRay

Translates vtkRenderer state into OSPRay rendering calls

Tests:
vtkOSPRayRendererNode (Tests)

Definition at line 39 of file vtkOSPRayRendererNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkOSPRayRendererNode.h.

Member Enumeration Documentation

◆ BackgroundMode

Enumerator
None 
Backplate 
Environment 
Both 
NumberOfMode 

Definition at line 335 of file vtkOSPRayRendererNode.h.

Constructor & Destructor Documentation

◆ vtkOSPRayRendererNode()

vtkOSPRayRendererNode::vtkOSPRayRendererNode ( )
protected

◆ ~vtkOSPRayRendererNode()

vtkOSPRayRendererNode::~vtkOSPRayRendererNode ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOSPRayRendererNode * vtkOSPRayRendererNode::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkOSPRayRendererNode::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkOSPRayRendererNode::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRendererNode.

◆ SafeDownCast()

static vtkOSPRayRendererNode * vtkOSPRayRendererNode::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOSPRayRendererNode::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRendererNode.

◆ NewInstance()

vtkOSPRayRendererNode * vtkOSPRayRendererNode::NewInstance ( ) const

◆ PrintSelf()

void vtkOSPRayRendererNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ Build()

void vtkOSPRayRendererNode::Build ( bool  prepass)
overridevirtual

Builds myself.

Reimplemented from vtkViewNode.

◆ Render()

void vtkOSPRayRendererNode::Render ( bool  prepass)
overridevirtual

Traverse graph in ospray's preferred order and render.

Reimplemented from vtkViewNode.

◆ Invalidate()

void vtkOSPRayRendererNode::Invalidate ( bool  prepass)
overridevirtual

Invalidates cached rendering data.

Reimplemented from vtkViewNode.

◆ WriteLayer()

virtual void vtkOSPRayRendererNode::WriteLayer ( unsigned char *  buffer,
float *  zbuffer,
int  buffx,
int  buffy,
int  layer 
)
virtual

Put my results into the correct place in the provided pixel buffer.

◆ SAMPLES_PER_PIXEL()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::SAMPLES_PER_PIXEL ( )
static

When present on renderer, controls the number of primary rays shot per pixel default is 1.

◆ SetSamplesPerPixel()

static void vtkOSPRayRendererNode::SetSamplesPerPixel ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

◆ GetSamplesPerPixel()

static int vtkOSPRayRendererNode::GetSamplesPerPixel ( vtkRenderer renderer)
static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

◆ MAX_CONTRIBUTION()

static vtkInformationDoubleKey * vtkOSPRayRendererNode::MAX_CONTRIBUTION ( )
static

When present on renderer, samples are clamped to this value before they are accumulated into the framebuffer default is 2.0.

◆ SetMaxContribution()

static void vtkOSPRayRendererNode::SetMaxContribution ( double  ,
vtkRenderer renderer 
)
static

Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.

◆ GetMaxContribution()

static double vtkOSPRayRendererNode::GetMaxContribution ( vtkRenderer renderer)
static

Convenience method to set/get MAX_CONTRIBUTION on a vtkRenderer.

◆ MAX_DEPTH()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_DEPTH ( )
static

When present on renderer, controls the maximum ray recursion depth default is 20.

◆ SetMaxDepth()

static void vtkOSPRayRendererNode::SetMaxDepth ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get MAX_DEPTH on a vtkRenderer.

◆ GetMaxDepth()

static int vtkOSPRayRendererNode::GetMaxDepth ( vtkRenderer renderer)
static

Convenience method to set/get MAX_DEPTH on a vtkRenderer.

◆ MIN_CONTRIBUTION()

static vtkInformationDoubleKey * vtkOSPRayRendererNode::MIN_CONTRIBUTION ( )
static

When present on renderer, sample contributions below this value will be neglected to speedup rendering default is 0.01.

◆ SetMinContribution()

static void vtkOSPRayRendererNode::SetMinContribution ( double  ,
vtkRenderer renderer 
)
static

Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.

◆ GetMinContribution()

static double vtkOSPRayRendererNode::GetMinContribution ( vtkRenderer renderer)
static

Convenience method to set/get MIN_CONTRIBUTION on a vtkRenderer.

◆ ROULETTE_DEPTH()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::ROULETTE_DEPTH ( )
static

When present on renderer, controls the ray recursion depth at which to start Russian roulette termination default is 5.

◆ SetRouletteDepth()

static void vtkOSPRayRendererNode::SetRouletteDepth ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.

◆ GetRouletteDepth()

static int vtkOSPRayRendererNode::GetRouletteDepth ( vtkRenderer renderer)
static

Convenience method to set/get ROULETTE_DEPTH on a vtkRenderer.

◆ VARIANCE_THRESHOLD()

static vtkInformationDoubleKey * vtkOSPRayRendererNode::VARIANCE_THRESHOLD ( )
static

When present on renderer, controls the threshold for adaptive accumulation default is 0.3.

◆ SetVarianceThreshold()

static void vtkOSPRayRendererNode::SetVarianceThreshold ( double  ,
vtkRenderer renderer 
)
static

Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.

◆ GetVarianceThreshold()

static double vtkOSPRayRendererNode::GetVarianceThreshold ( vtkRenderer renderer)
static

Convenience method to set/get VARIANCE_THRESHOLD on a vtkRenderer.

◆ MAX_FRAMES()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_FRAMES ( )
static

When present on renderer, controls the number of ospray render calls for each refresh.

default is 1

◆ SetMaxFrames()

static void vtkOSPRayRendererNode::SetMaxFrames ( int  ,
vtkRenderer renderer 
)
static

When present on renderer, controls the number of ospray render calls for each refresh.

default is 1

◆ GetMaxFrames()

static int vtkOSPRayRendererNode::GetMaxFrames ( vtkRenderer renderer)
static

When present on renderer, controls the number of ospray render calls for each refresh.

default is 1

◆ RENDERER_TYPE()

static vtkInformationStringKey * vtkOSPRayRendererNode::RENDERER_TYPE ( )
static

Set the OSPRay renderer type to use (e.g.

scivis vs. pathtracer) default is scivis

◆ SetRendererType()

static void vtkOSPRayRendererNode::SetRendererType ( std::string  name,
vtkRenderer renderer 
)
static

Set the OSPRay renderer type to use (e.g.

scivis vs. pathtracer) default is scivis

◆ GetRendererType()

static std::string vtkOSPRayRendererNode::GetRendererType ( vtkRenderer renderer)
static

Set the OSPRay renderer type to use (e.g.

scivis vs. pathtracer) default is scivis

◆ AMBIENT_SAMPLES()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::AMBIENT_SAMPLES ( )
static

When present on renderer, controls the number of ambient occlusion samples shot per hit.

default is 4

◆ SetAmbientSamples()

static void vtkOSPRayRendererNode::SetAmbientSamples ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.

◆ GetAmbientSamples()

static int vtkOSPRayRendererNode::GetAmbientSamples ( vtkRenderer renderer)
static

Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.

◆ VOLUME_SAMPLING_RATE()

static vtkInformationDoubleKey * vtkOSPRayRendererNode::VOLUME_SAMPLING_RATE ( )
static

the rate of sampling for volumes, higher numbers increase the number of samples.

Defaults to 1.0.

◆ SetVolumeSamplingRate()

static void vtkOSPRayRendererNode::SetVolumeSamplingRate ( double  ,
vtkRenderer renderer 
)
static

Convenience method VOLUME_SAMPLING_RATE on a vtkRenderer.

◆ GetVolumeSamplingRate()

static double vtkOSPRayRendererNode::GetVolumeSamplingRate ( vtkRenderer renderer)
static

Convenience method VOLUME_SAMPLING_RATE on a vtkRenderer.

◆ COMPOSITE_ON_GL()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::COMPOSITE_ON_GL ( )
static

used to make the renderer add ospray's content onto GL rendered content on the window

◆ SetCompositeOnGL()

static void vtkOSPRayRendererNode::SetCompositeOnGL ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.

◆ GetCompositeOnGL()

static int vtkOSPRayRendererNode::GetCompositeOnGL ( vtkRenderer renderer)
static

Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.

◆ NORTH_POLE()

static vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::NORTH_POLE ( )
static

World space direction of north pole for gradient and texture background.

◆ SetNorthPole()

static void vtkOSPRayRendererNode::SetNorthPole ( double *  ,
vtkRenderer renderer 
)
static

Convenience method to set/get NORTH_POLE on a vtkRenderer.

◆ GetNorthPole()

static double * vtkOSPRayRendererNode::GetNorthPole ( vtkRenderer renderer)
static

Convenience method to set/get NORTH_POLE on a vtkRenderer.

◆ EAST_POLE()

static vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::EAST_POLE ( )
static

World space direction of east pole for texture background.

◆ SetEastPole()

static void vtkOSPRayRendererNode::SetEastPole ( double *  ,
vtkRenderer renderer 
)
static

Convenience method to set/get EAST_POLE on a vtkRenderer.

◆ GetEastPole()

static double * vtkOSPRayRendererNode::GetEastPole ( vtkRenderer renderer)
static

Convenience method to set/get EAST_POLE on a vtkRenderer.

◆ MATERIAL_LIBRARY()

static vtkInformationObjectBaseKey * vtkOSPRayRendererNode::MATERIAL_LIBRARY ( )
static

Material Library attached to the renderer.

◆ SetMaterialLibrary()

static void vtkOSPRayRendererNode::SetMaterialLibrary ( vtkOSPRayMaterialLibrary ,
vtkRenderer renderer 
)
static

Convenience method to set/get Material library on a renderer.

◆ GetMaterialLibrary()

static vtkOSPRayMaterialLibrary * vtkOSPRayRendererNode::GetMaterialLibrary ( vtkRenderer renderer)
static

Convenience method to set/get Material library on a renderer.

◆ VIEW_TIME()

static vtkInformationDoubleKey * vtkOSPRayRendererNode::VIEW_TIME ( )
static

Requested time to show in a renderer and to lookup in a temporal cache.

◆ SetViewTime()

static void vtkOSPRayRendererNode::SetViewTime ( double  ,
vtkRenderer renderer 
)
static

Convenience method to set/get VIEW_TIME on a vtkRenderer.

◆ GetViewTime()

static double vtkOSPRayRendererNode::GetViewTime ( vtkRenderer renderer)
static

Convenience method to set/get VIEW_TIME on a vtkRenderer.

◆ TIME_CACHE_SIZE()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::TIME_CACHE_SIZE ( )
static

Temporal cache size.

◆ SetTimeCacheSize()

static void vtkOSPRayRendererNode::SetTimeCacheSize ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.

◆ GetTimeCacheSize()

static int vtkOSPRayRendererNode::GetTimeCacheSize ( vtkRenderer renderer)
static

Convenience method to set/get TIME_CACHE_SIZE on a vtkRenderer.

◆ GetORenderer()

OSPRenderer vtkOSPRayRendererNode::GetORenderer ( )
inline

Methods for other nodes to access.

Definition at line 281 of file vtkOSPRayRendererNode.h.

◆ AddLight()

void vtkOSPRayRendererNode::AddLight ( OSPLight  light)
inline

Definition at line 282 of file vtkOSPRayRendererNode.h.

◆ GetBuffer()

virtual void * vtkOSPRayRendererNode::GetBuffer ( )
inlinevirtual

Get the last rendered ColorBuffer.

Definition at line 287 of file vtkOSPRayRendererNode.h.

◆ GetZBuffer()

virtual float * vtkOSPRayRendererNode::GetZBuffer ( )
inlinevirtual

Get the last rendered ZBuffer.

Definition at line 292 of file vtkOSPRayRendererNode.h.

◆ GetColorBufferTextureGL()

virtual int vtkOSPRayRendererNode::GetColorBufferTextureGL ( )
inlinevirtual

Definition at line 295 of file vtkOSPRayRendererNode.h.

◆ GetDepthBufferTextureGL()

virtual int vtkOSPRayRendererNode::GetDepthBufferTextureGL ( )
inlinevirtual

Definition at line 298 of file vtkOSPRayRendererNode.h.

◆ Traverse()

void vtkOSPRayRendererNode::Traverse ( int  operation)
overridevirtual

Reimplemented from vtkViewNode.

◆ GetRendererNode()

static vtkOSPRayRendererNode * vtkOSPRayRendererNode::GetRendererNode ( vtkViewNode )
static

Convenience method to get and downcast renderable.

◆ GetRenderer()

vtkRenderer * vtkOSPRayRendererNode::GetRenderer ( )

◆ GetBackend()

RTW::Backend * vtkOSPRayRendererNode::GetBackend ( )

◆ DENOISER_THRESHOLD()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::DENOISER_THRESHOLD ( )
static

Accumulation threshold when above which denoising kicks in.

◆ SetDenoiserThreshold()

static void vtkOSPRayRendererNode::SetDenoiserThreshold ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.

◆ GetDenoiserThreshold()

static int vtkOSPRayRendererNode::GetDenoiserThreshold ( vtkRenderer renderer)
static

Convenience method to set/get DENOISER_THRESHOLD on a vtkRenderer.

◆ ENABLE_DENOISER()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::ENABLE_DENOISER ( )
static

Enable denoising (if supported).

◆ SetEnableDenoiser()

static void vtkOSPRayRendererNode::SetEnableDenoiser ( int  ,
vtkRenderer renderer 
)
static

Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.

◆ GetEnableDenoiser()

static int vtkOSPRayRendererNode::GetEnableDenoiser ( vtkRenderer renderer)
static

Enable denoising (if supported).

◆ BACKGROUND_MODE()

static vtkInformationIntegerKey * vtkOSPRayRendererNode::BACKGROUND_MODE ( )
static

Control use of the path tracer backplate and environmental background.

0 means neither is shown, 1 means only backplate is shown, 2 (the default) means only environment is shown, 3 means that both are enabled and therefore backblate shows on screen but actors acquire color from the environment.

◆ SetBackgroundMode()

static void vtkOSPRayRendererNode::SetBackgroundMode ( BackgroundMode  ,
vtkRenderer renderer 
)
static

Control use of the path tracer backplate and environmental background.

0 means neither is shown, 1 means only backplate is shown, 2 (the default) means only environment is shown, 3 means that both are enabled and therefore backblate shows on screen but actors acquire color from the environment.

◆ GetBackgroundMode()

static BackgroundMode vtkOSPRayRendererNode::GetBackgroundMode ( vtkRenderer renderer)
static

Control use of the path tracer backplate and environmental background.

0 means neither is shown, 1 means only backplate is shown, 2 (the default) means only environment is shown, 3 means that both are enabled and therefore backblate shows on screen but actors acquire color from the environment.

◆ Denoise()

void vtkOSPRayRendererNode::Denoise ( )
protected

Denoise the colors stored in ColorBuffer and put into Buffer.

Member Data Documentation

◆ GeometricModels

std::vector<OSPGeometricModel> vtkOSPRayRendererNode::GeometricModels

Definition at line 357 of file vtkOSPRayRendererNode.h.

◆ VolumetricModels

std::vector<OSPVolumetricModel> vtkOSPRayRendererNode::VolumetricModels

Definition at line 358 of file vtkOSPRayRendererNode.h.

◆ Instances

std::vector<OSPInstance> vtkOSPRayRendererNode::Instances

Definition at line 359 of file vtkOSPRayRendererNode.h.

◆ Buffer

std::vector<float> vtkOSPRayRendererNode::Buffer
protected

Definition at line 371 of file vtkOSPRayRendererNode.h.

◆ ZBuffer

std::vector<float> vtkOSPRayRendererNode::ZBuffer
protected

Definition at line 372 of file vtkOSPRayRendererNode.h.

◆ ColorBufferTex

int vtkOSPRayRendererNode::ColorBufferTex
protected

Definition at line 374 of file vtkOSPRayRendererNode.h.

◆ DepthBufferTex

int vtkOSPRayRendererNode::DepthBufferTex
protected

Definition at line 375 of file vtkOSPRayRendererNode.h.

◆ OWorld

OSPWorld vtkOSPRayRendererNode::OWorld { nullptr }
protected

Definition at line 377 of file vtkOSPRayRendererNode.h.

◆ ORenderer

OSPRenderer vtkOSPRayRendererNode::ORenderer { nullptr }
protected

Definition at line 378 of file vtkOSPRayRendererNode.h.

◆ OFrameBuffer

OSPFrameBuffer vtkOSPRayRendererNode::OFrameBuffer { nullptr }
protected

Definition at line 379 of file vtkOSPRayRendererNode.h.

◆ OCamera

OSPCamera vtkOSPRayRendererNode::OCamera { nullptr }
protected

Definition at line 380 of file vtkOSPRayRendererNode.h.

◆ ImageX

int vtkOSPRayRendererNode::ImageX
protected

Definition at line 381 of file vtkOSPRayRendererNode.h.

◆ ImageY

int vtkOSPRayRendererNode::ImageY
protected

Definition at line 381 of file vtkOSPRayRendererNode.h.

◆ Lights

std::vector<OSPLight> vtkOSPRayRendererNode::Lights
protected

Definition at line 382 of file vtkOSPRayRendererNode.h.

◆ NumActors

int vtkOSPRayRendererNode::NumActors
protected

Definition at line 383 of file vtkOSPRayRendererNode.h.

◆ ComputeDepth

bool vtkOSPRayRendererNode::ComputeDepth
protected

Definition at line 384 of file vtkOSPRayRendererNode.h.

◆ Accumulate

bool vtkOSPRayRendererNode::Accumulate
protected

Definition at line 385 of file vtkOSPRayRendererNode.h.

◆ CompositeOnGL

bool vtkOSPRayRendererNode::CompositeOnGL
protected

Definition at line 386 of file vtkOSPRayRendererNode.h.

◆ UseBackplate

bool vtkOSPRayRendererNode::UseBackplate { true }
protected

Definition at line 387 of file vtkOSPRayRendererNode.h.

◆ ODepthBuffer

std::vector<float> vtkOSPRayRendererNode::ODepthBuffer
protected

Definition at line 388 of file vtkOSPRayRendererNode.h.

◆ AccumulateCount

int vtkOSPRayRendererNode::AccumulateCount
protected

Definition at line 389 of file vtkOSPRayRendererNode.h.

◆ ActorCount

int vtkOSPRayRendererNode::ActorCount
protected

Definition at line 390 of file vtkOSPRayRendererNode.h.

◆ AccumulateTime

vtkMTimeType vtkOSPRayRendererNode::AccumulateTime
protected

Definition at line 391 of file vtkOSPRayRendererNode.h.

◆ AccumulateMatrix

vtkMatrix4x4* vtkOSPRayRendererNode::AccumulateMatrix
protected

Definition at line 392 of file vtkOSPRayRendererNode.h.

◆ Internal

vtkOSPRayRendererNodeInternals* vtkOSPRayRendererNode::Internal
protected

Definition at line 393 of file vtkOSPRayRendererNode.h.

◆ PreviousType

std::string vtkOSPRayRendererNode::PreviousType
protected

Definition at line 394 of file vtkOSPRayRendererNode.h.

◆ DenoiserDirty

bool vtkOSPRayRendererNode::DenoiserDirty { true }
protected

Definition at line 400 of file vtkOSPRayRendererNode.h.

◆ ColorBuffer

std::vector<osp::vec4f> vtkOSPRayRendererNode::ColorBuffer
protected

Definition at line 401 of file vtkOSPRayRendererNode.h.

◆ NormalBuffer

std::vector<osp::vec3f> vtkOSPRayRendererNode::NormalBuffer
protected

Definition at line 402 of file vtkOSPRayRendererNode.h.

◆ AlbedoBuffer

std::vector<osp::vec3f> vtkOSPRayRendererNode::AlbedoBuffer
protected

Definition at line 403 of file vtkOSPRayRendererNode.h.

◆ DenoisedBuffer

std::vector<osp::vec4f> vtkOSPRayRendererNode::DenoisedBuffer
protected

Definition at line 404 of file vtkOSPRayRendererNode.h.

◆ Cache

vtkOSPRayCache<vtkOSPRayCacheItemObject>* vtkOSPRayRendererNode::Cache
protected

Definition at line 406 of file vtkOSPRayRendererNode.h.

◆ CacheContents

std::set<OSPWorld> vtkOSPRayRendererNode::CacheContents
protected

Definition at line 407 of file vtkOSPRayRendererNode.h.


The documentation for this class was generated from the following file: