VTK
Public Types | Public Member Functions | Static Public Member Functions | 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

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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOSPRayRendererNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Build (bool prepass)
 Builds myself. More...
 
virtual void Render (bool prepass)
 Traverse graph in ospray's prefered order and render. More...
 
virtual void Invalidate (bool prepass)
 Invalidates cached rendering data. More...
 
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. More...
 
OSPModel GetOModel ()
 Methods for other nodes to access. More...
 
OSPRenderer GetORenderer ()
 
void AddLight (OSPLight light)
 
virtual unsigned char * GetBuffer ()
 Get the last rendered ColorBuffer. More...
 
virtual floatGetZBuffer ()
 Get the last rendered ZBuffer. More...
 
virtual void Traverse (int operation)
 
- Public Member Functions inherited from vtkRendererNode
vtkRendererNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Synchronize (bool prepass)
 Synchronize our state. More...
 
- Public Member Functions inherited from vtkViewNode
vtkViewNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkObjectGetRenderable ()
 This is the VTK class that this node stands in for. More...
 
virtual void SetParent (vtkViewNode *)
 Access the node that owns this one. More...
 
virtual vtkViewNodeGetParent ()
 
virtual void SetChildren (vtkViewNodeCollection *)
 Access nodes that this one owns. More...
 
virtual vtkViewNodeCollectionGetChildren ()
 
virtual void SetMyFactory (vtkViewNodeFactory *)
 A factory that creates particular subclasses for different rendering back ends. More...
 
virtual vtkViewNodeFactoryGetMyFactory ()
 
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. More...
 
vtkViewNodeGetFirstAncestorOfType (const char *type)
 Find the first parent/grandparent of the desired type. More...
 
virtual void SetRenderable (vtkObject *)
 Alow explicit setting of the renderable for a view node. More...
 
virtual void TraverseAllPasses ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOSPRayRendererNodeNew ()
 
static int 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. More...
 
static void SetSamplesPerPixel (int, vtkRenderer *renderer)
 Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer. More...
 
static int GetSamplesPerPixel (vtkRenderer *renderer)
 
static vtkInformationIntegerKeyMAX_FRAMES ()
 When present on renderer, controls the number of ospray render calls for each refresh. More...
 
static void SetMaxFrames (int, vtkRenderer *renderer)
 
static int GetMaxFrames (vtkRenderer *renderer)
 
static vtkInformationStringKeyRENDERER_TYPE ()
 Set the OSPRay renderer type to use (e.g. More...
 
static void SetRendererType (std::string name, vtkRenderer *renderer)
 
static std::string GetRendererType (vtkRenderer *renderer)
 
static vtkInformationIntegerKeyAMBIENT_SAMPLES ()
 When present on renderer, controls the number of ambient occlusion samples shot per hit. More...
 
static void SetAmbientSamples (int, vtkRenderer *renderer)
 Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer. More...
 
static int GetAmbientSamples (vtkRenderer *renderer)
 
static vtkInformationIntegerKeyCOMPOSITE_ON_GL ()
 used to make the renderer add ospray's content onto GL rendered content on the window More...
 
static void SetCompositeOnGL (int, vtkRenderer *renderer)
 Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer. More...
 
static int GetCompositeOnGL (vtkRenderer *renderer)
 
- Static Public Member Functions inherited from vtkRendererNode
static vtkRendererNodeNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRendererNodeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkViewNode
static int 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOSPRayRendererNode ()
 
 ~vtkOSPRayRendererNode ()
 
- Protected Member Functions inherited from vtkRendererNode
 vtkRendererNode ()
 
 ~vtkRendererNode ()
 
- Protected Member Functions inherited from vtkViewNode
 vtkViewNode ()
 
 ~vtkViewNode ()
 
void Apply (int operation, bool prepass)
 
void AddMissingNode (vtkObject *obj)
 convienience method to add node or nodes if missing from our current list More...
 
void AddMissingNodes (vtkCollection *col)
 
void PrepareNodes ()
 Called first before adding missing nodes. More...
 
void RemoveUnusedNodes ()
 Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes. More...
 
virtual vtkViewNodeCreateViewNode (vtkObject *obj)
 Create the correct ViewNode subclass for the passed in object. More...
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

unsigned char * Buffer
 
floatZBuffer
 
OSPModel OModel
 
OSPRenderer ORenderer
 
OSPFrameBuffer OFrameBuffer
 
int ImageX
 
int ImageY
 
std::vector< OSPLightLights
 
int NumActors
 
bool ComputeDepth
 
bool Accumulate
 
bool CompositeOnGL
 
floatODepthBuffer
 
- Protected Attributes inherited from vtkRendererNode
int Size [2]
 
- Protected Attributes inherited from vtkViewNode
vtkCollectionPreparedNodes
 
vtkObjectRenderable
 
vtkWeakPointer< vtkViewNodeParent
 
vtkViewNodeCollectionChildren
 
vtkViewNodeFactoryMyFactory
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkViewNode
vtkMTimeType RenderTime
 Allows smart caching. More...
 
- 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 50 of file vtkOSPRayRendererNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkOSPRayRendererNode.h.

Constructor & Destructor Documentation

◆ vtkOSPRayRendererNode()

vtkOSPRayRendererNode::vtkOSPRayRendererNode ( )
protected

◆ ~vtkOSPRayRendererNode()

vtkOSPRayRendererNode::~vtkOSPRayRendererNode ( )
protected

Member Function Documentation

◆ New()

static vtkOSPRayRendererNode* vtkOSPRayRendererNode::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual int 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 
)
virtual

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()

virtual void vtkOSPRayRendererNode::Build ( bool  prepass)
virtual

Builds myself.

Reimplemented from vtkRendererNode.

◆ Render()

virtual void vtkOSPRayRendererNode::Render ( bool  prepass)
virtual

Traverse graph in ospray's prefered order and render.

Reimplemented from vtkViewNode.

◆ Invalidate()

virtual void vtkOSPRayRendererNode::Invalidate ( bool  prepass)
virtual

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

◆ 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 TODO: NOT CURRENTLY USED

◆ SetMaxFrames()

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

◆ GetMaxFrames()

static int vtkOSPRayRendererNode::GetMaxFrames ( vtkRenderer renderer)
static

◆ 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

◆ GetRendererType()

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

◆ 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

◆ 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

◆ GetOModel()

OSPModel vtkOSPRayRendererNode::GetOModel ( )
inline

Methods for other nodes to access.

Definition at line 148 of file vtkOSPRayRendererNode.h.

◆ GetORenderer()

OSPRenderer vtkOSPRayRendererNode::GetORenderer ( )
inline

Definition at line 149 of file vtkOSPRayRendererNode.h.

◆ AddLight()

void vtkOSPRayRendererNode::AddLight ( OSPLight  light)
inline

Definition at line 150 of file vtkOSPRayRendererNode.h.

◆ GetBuffer()

virtual unsigned char* vtkOSPRayRendererNode::GetBuffer ( )
inlinevirtual

Get the last rendered ColorBuffer.

Definition at line 156 of file vtkOSPRayRendererNode.h.

◆ GetZBuffer()

virtual float* vtkOSPRayRendererNode::GetZBuffer ( )
inlinevirtual

Get the last rendered ZBuffer.

Definition at line 162 of file vtkOSPRayRendererNode.h.

◆ Traverse()

virtual void vtkOSPRayRendererNode::Traverse ( int  operation)
virtual

Reimplemented from vtkViewNode.

Member Data Documentation

◆ Buffer

unsigned char* vtkOSPRayRendererNode::Buffer
protected

Definition at line 174 of file vtkOSPRayRendererNode.h.

◆ ZBuffer

float* vtkOSPRayRendererNode::ZBuffer
protected

Definition at line 175 of file vtkOSPRayRendererNode.h.

◆ OModel

OSPModel vtkOSPRayRendererNode::OModel
protected

Definition at line 177 of file vtkOSPRayRendererNode.h.

◆ ORenderer

OSPRenderer vtkOSPRayRendererNode::ORenderer
protected

Definition at line 178 of file vtkOSPRayRendererNode.h.

◆ OFrameBuffer

OSPFrameBuffer vtkOSPRayRendererNode::OFrameBuffer
protected

Definition at line 179 of file vtkOSPRayRendererNode.h.

◆ ImageX

int vtkOSPRayRendererNode::ImageX
protected

Definition at line 180 of file vtkOSPRayRendererNode.h.

◆ ImageY

int vtkOSPRayRendererNode::ImageY
protected

Definition at line 180 of file vtkOSPRayRendererNode.h.

◆ Lights

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

Definition at line 181 of file vtkOSPRayRendererNode.h.

◆ NumActors

int vtkOSPRayRendererNode::NumActors
protected

Definition at line 182 of file vtkOSPRayRendererNode.h.

◆ ComputeDepth

bool vtkOSPRayRendererNode::ComputeDepth
protected

Definition at line 183 of file vtkOSPRayRendererNode.h.

◆ Accumulate

bool vtkOSPRayRendererNode::Accumulate
protected

Definition at line 184 of file vtkOSPRayRendererNode.h.

◆ CompositeOnGL

bool vtkOSPRayRendererNode::CompositeOnGL
protected

Definition at line 185 of file vtkOSPRayRendererNode.h.

◆ ODepthBuffer

float* vtkOSPRayRendererNode::ODepthBuffer
protected

Definition at line 186 of file vtkOSPRayRendererNode.h.


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