links vtkRenderers to OptiX More...

#include <vtkOptiXRendererNode.h>

Inheritance diagram for vtkOptiXRendererNode:

Collaboration diagram for vtkOptiXRendererNode:

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...

vtkOptiXRendererNode *	NewInstance () 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 float *	GetZBuffer ()
	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...

vtkOptiXPtxLoader *	GetOptiXPtxLoader ()
	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
vtkRendererNode *	NewInstance () 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
vtkViewNode *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Invalidate (bool)
	Clear any cached data. More...

vtkViewNode *	GetViewNodeFor (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...

vtkViewNode *	GetFirstAncestorOfType (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 ()

virtual vtkObject *	GetRenderable ()
	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 vtkViewNode *	GetParent ()
	Access the node that owns this one. More...

virtual void	SetChildren (vtkViewNodeCollection *)
	Access nodes that this one owns. More...

virtual vtkViewNodeCollection *	GetChildren ()
	Access nodes that this one owns. More...

virtual void	SetMyFactory (vtkViewNodeFactory *)
	A factory that creates particular subclasses for different rendering back ends. More...

virtual vtkViewNodeFactory *	GetMyFactory ()
	A factory that creates particular subclasses for different rendering back ends. More...

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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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	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...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkOptiXRendererNode *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOptiXRendererNode *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	SAMPLES_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)
	Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer. More...


static vtkInformationIntegerKey *	MAX_FRAMES ()
	When present on renderer, controls the number of OptiX render calls for each refresh. More...

static void	SetMaxFrames (int, vtkRenderer *renderer)
	When present on renderer, controls the number of OptiX render calls for each refresh. More...

static int	GetMaxFrames (vtkRenderer *renderer)
	When present on renderer, controls the number of OptiX render calls for each refresh. More...


static vtkInformationIntegerKey *	AMBIENT_SAMPLES ()
	When present on renderer, controls the number of ambient occlusion samples shot per hit. More...

static void	SetAmbientSamples (int, vtkRenderer *renderer)
	When present on renderer, controls the number of ambient occlusion samples shot per hit. More...

static int	GetAmbientSamples (vtkRenderer *renderer)
	When present on renderer, controls the number of ambient occlusion samples shot per hit. More...

Static Public Member Functions inherited from vtkRendererNode
static vtkRendererNode *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRendererNode *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkViewNode
static vtkTypeBool	IsTypeOf (const char *type)

static vtkViewNode *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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	RemoveUnusedNodes ()
	Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes. More...

virtual vtkViewNode *	CreateViewNode (vtkObject *obj)
	Create the correct ViewNode subclass for the passed in object. More...

void	AddMissingNode (vtkObject *obj)
	convenience method to add node or nodes if missing from our current list More...

void	AddMissingNodes (vtkCollection *col)
	convenience method to add node or nodes if missing from our current list More...

void	PrepareNodes ()
	Called first before adding missing nodes. 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 ()
	These methods allow a command to exclusively grab all events. More...

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

float *	ZBuffer

vtkOptiXRendererNodeInternals *	Internals

vtkOptiXPtxLoader *	OptiXPtxLoader

std::vector< vtkopt::Light >	Lights

int	NumActors

Protected Attributes inherited from vtkRendererNode
int	Size [2]

Protected Attributes inherited from vtkViewNode
vtkObject *	Renderable

vtkWeakPointer< vtkViewNode >	Parent

vtkViewNodeCollection *	Children

vtkViewNodeFactory *	MyFactory

vtkCollection *	PreparedNodes
	Called first before adding missing nodes. More...

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

typedef vtkRendererNode vtkOptiXRendererNode::Superclass

Definition at line 54 of file vtkOptiXRendererNode.h.

Constructor & Destructor Documentation

vtkOptiXRendererNode::vtkOptiXRendererNode ( )

protected

vtkOptiXRendererNode::~vtkOptiXRendererNode ( )

protected

Member Function Documentation

static vtkOptiXRendererNode* vtkOptiXRendererNode::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkOptiXRendererNode::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRendererNode.

vtkOptiXRendererNode* vtkOptiXRendererNode::NewInstance ( ) const

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.

virtual void vtkOptiXRendererNode::Build ( bool prepass )

virtual

Builds myself.

Reimplemented from vtkRendererNode.

virtual void vtkOptiXRendererNode::Render ( bool prepass )

virtual

Traverse graph in OptiX's preferred order and render.

Reimplemented from vtkViewNode.

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.

static vtkInformationIntegerKey* vtkOptiXRendererNode::SAMPLES_PER_PIXEL ( )

static

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

default is 1

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

static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

static int vtkOptiXRendererNode::GetSamplesPerPixel ( vtkRenderer * renderer )

static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

static vtkInformationIntegerKey* vtkOptiXRendererNode::MAX_FRAMES ( )

static

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

default is 1

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

static

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

default is 1

static int vtkOptiXRendererNode::GetMaxFrames ( vtkRenderer * renderer )

static

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

default is 1

static vtkInformationIntegerKey* vtkOptiXRendererNode::AMBIENT_SAMPLES ( )

static

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

default is 4

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

static

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

default is 4

static int vtkOptiXRendererNode::GetAmbientSamples ( vtkRenderer * renderer )

static

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

default is 4

virtual unsigned char* vtkOptiXRendererNode::GetBuffer ( )

inlinevirtual

Get the last rendered ColorBuffer.

Definition at line 115 of file vtkOptiXRendererNode.h.

virtual float* vtkOptiXRendererNode::GetZBuffer ( )

inlinevirtual

Get the last rendered ZBuffer.

Definition at line 120 of file vtkOptiXRendererNode.h.

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

virtual

Get the OptiX Context.

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

virtual

Get the top level GeometryGroup.

vtkOptiXPtxLoader* vtkOptiXRendererNode::GetOptiXPtxLoader ( )

Get the OptiX Ptx loader.

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

virtual

Add a Light.

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.

virtual void vtkOptiXRendererNode::Synchronize ( bool prepass )

virtual

Synchronizes render output by recreating depth/color buffer.

Reimplemented from vtkRendererNode.

Member Data Documentation

unsigned char* vtkOptiXRendererNode::Buffer

protected

Definition at line 158 of file vtkOptiXRendererNode.h.

float* vtkOptiXRendererNode::ZBuffer

protected

Definition at line 159 of file vtkOptiXRendererNode.h.

vtkOptiXRendererNodeInternals* vtkOptiXRendererNode::Internals

protected

Definition at line 161 of file vtkOptiXRendererNode.h.

vtkOptiXPtxLoader* vtkOptiXRendererNode::OptiXPtxLoader

protected

Definition at line 162 of file vtkOptiXRendererNode.h.

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

protected

Definition at line 164 of file vtkOptiXRendererNode.h.

int vtkOptiXRendererNode::NumActors

protected

Definition at line 166 of file vtkOptiXRendererNode.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OptiX/vtkOptiXRendererNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation