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

links vtkRenderers to OptiX More...

#include <vtkOptiXRendererNode.h>

Inheritance diagram for vtkOptiXRendererNode:
[legend]
Collaboration diagram for vtkOptiXRendererNode:
[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 vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOptiXRendererNodeNewInstance () 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 OptiX's preferred order and render. 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...
 
virtual unsigned char * GetBuffer ()
 Get the last rendered ColorBuffer. More...
 
virtual floatGetZBuffer ()
 Get the last rendered ZBuffer. More...
 
virtual optix::ContextObj * GetOptiXContext ()
 Get the OptiX Context. More...
 
virtual optix::GeometryGroupObj * GetOptiXGeometryGroup ()
 Get the top level GeometryGroup. More...
 
vtkOptiXPtxLoaderGetOptiXPtxLoader ()
 Get the OptiX Ptx loader. More...
 
virtual void AddLight (const vtkopt::Light &light)
 Add a Light. More...
 
virtual void Traverse (int operation)
 If you want to traverse your children in a specific order or way override this method. More...
 
virtual void Synchronize (bool prepass)
 Synchronizes render output by recreating depth/color buffer. More...
 
- Public Member Functions inherited from vtkRendererNode
vtkRendererNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkViewNode
vtkViewNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 Invalidate (bool)
 Clear any cached data. 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 *)
 Allow 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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkOptiXRendererNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOptiXRendererNodeSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeySAMPLES_PER_PIXEL ()
 When present on renderer, controls the number of primary rays shot per pixel. 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 OptiX render calls for each refresh. More...
 
static void SetMaxFrames (int, vtkRenderer *renderer)
 
static int GetMaxFrames (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)
 
static int GetAmbientSamples (vtkRenderer *renderer)
 
- 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. 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
 
 vtkOptiXRendererNode ()
 
 ~vtkOptiXRendererNode ()
 
- 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)
 convenience 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=nullptr)
 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
 
vtkOptiXRendererNodeInternals * Internals
 
vtkOptiXPtxLoaderOptiXPtxLoader
 
std::vector< vtkopt::LightLights
 
int NumActors
 
- 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 OptiX

Translates vtkRenderer state into OptiX rendering calls

Tests:
vtkOptiXRendererNode (Tests)

Definition at line 50 of file vtkOptiXRendererNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkOptiXRendererNode.h.

Constructor & Destructor Documentation

◆ vtkOptiXRendererNode()

vtkOptiXRendererNode::vtkOptiXRendererNode ( )
protected

◆ ~vtkOptiXRendererNode()

vtkOptiXRendererNode::~vtkOptiXRendererNode ( )
protected

Member Function Documentation

◆ New()

static vtkOptiXRendererNode* vtkOptiXRendererNode::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOptiXRendererNode::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 vtkOptiXRendererNode* vtkOptiXRendererNode::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOptiXRendererNode::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRendererNode.

◆ NewInstance()

vtkOptiXRendererNode* vtkOptiXRendererNode::NewInstance ( ) const

◆ PrintSelf()

void vtkOptiXRendererNode::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 vtkOptiXRendererNode::Build ( bool  prepass)
virtual

Builds myself.

Reimplemented from vtkRendererNode.

◆ Render()

virtual void vtkOptiXRendererNode::Render ( bool  prepass)
virtual

Traverse graph in OptiX's preferred order and render.

Reimplemented from vtkViewNode.

◆ WriteLayer()

virtual void vtkOptiXRendererNode::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* vtkOptiXRendererNode::SAMPLES_PER_PIXEL ( )
static

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

default is 1

◆ SetSamplesPerPixel()

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

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

◆ GetSamplesPerPixel()

static int vtkOptiXRendererNode::GetSamplesPerPixel ( vtkRenderer renderer)
static

◆ MAX_FRAMES()

static vtkInformationIntegerKey* vtkOptiXRendererNode::MAX_FRAMES ( )
static

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

default is 1

◆ SetMaxFrames()

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

◆ GetMaxFrames()

static int vtkOptiXRendererNode::GetMaxFrames ( vtkRenderer renderer)
static

◆ AMBIENT_SAMPLES()

static vtkInformationIntegerKey* vtkOptiXRendererNode::AMBIENT_SAMPLES ( )
static

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

default is 4

◆ SetAmbientSamples()

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

◆ GetAmbientSamples()

static int vtkOptiXRendererNode::GetAmbientSamples ( vtkRenderer renderer)
static

◆ GetBuffer()

virtual unsigned char* vtkOptiXRendererNode::GetBuffer ( )
inlinevirtual

Get the last rendered ColorBuffer.

Definition at line 115 of file vtkOptiXRendererNode.h.

◆ GetZBuffer()

virtual float* vtkOptiXRendererNode::GetZBuffer ( )
inlinevirtual

Get the last rendered ZBuffer.

Definition at line 120 of file vtkOptiXRendererNode.h.

◆ GetOptiXContext()

virtual optix::ContextObj* vtkOptiXRendererNode::GetOptiXContext ( )
virtual

Get the OptiX Context.

◆ GetOptiXGeometryGroup()

virtual optix::GeometryGroupObj* vtkOptiXRendererNode::GetOptiXGeometryGroup ( )
virtual

Get the top level GeometryGroup.

◆ GetOptiXPtxLoader()

vtkOptiXPtxLoader* vtkOptiXRendererNode::GetOptiXPtxLoader ( )

Get the OptiX Ptx loader.

◆ AddLight()

virtual void vtkOptiXRendererNode::AddLight ( const vtkopt::Light light)
virtual

Add a Light.

◆ Traverse()

virtual void vtkOptiXRendererNode::Traverse ( int  operation)
virtual

If you want to traverse your children in a specific order or way override this method.

Reimplemented from vtkViewNode.

◆ Synchronize()

virtual void vtkOptiXRendererNode::Synchronize ( bool  prepass)
virtual

Synchronizes render output by recreating depth/color buffer.

Reimplemented from vtkRendererNode.

Member Data Documentation

◆ Buffer

unsigned char* vtkOptiXRendererNode::Buffer
protected

Definition at line 158 of file vtkOptiXRendererNode.h.

◆ ZBuffer

float* vtkOptiXRendererNode::ZBuffer
protected

Definition at line 159 of file vtkOptiXRendererNode.h.

◆ Internals

vtkOptiXRendererNodeInternals* vtkOptiXRendererNode::Internals
protected

Definition at line 161 of file vtkOptiXRendererNode.h.

◆ OptiXPtxLoader

vtkOptiXPtxLoader* vtkOptiXRendererNode::OptiXPtxLoader
protected

Definition at line 162 of file vtkOptiXRendererNode.h.

◆ Lights

std::vector<vtkopt::Light> vtkOptiXRendererNode::Lights
protected

Definition at line 164 of file vtkOptiXRendererNode.h.

◆ NumActors

int vtkOptiXRendererNode::NumActors
protected

Definition at line 166 of file vtkOptiXRendererNode.h.


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