links vtkRenderers to OSPRay More...

#include <vtkOSPRayRendererNode.h>

Inheritance diagram for vtkOSPRayRendererNode:

Collaboration diagram for vtkOSPRayRendererNode:

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

vtkOSPRayRendererNode *	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 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 float *	GetZBuffer ()
	Get the last rendered ZBuffer. More...

virtual void	Traverse (int operation)

Public Member Functions inherited from vtkRendererNode
vtkRendererNode *	NewInstance () 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
vtkViewNode *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. 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 *)
	Alow 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 ()

int	HasObserver (unsigned long event)

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

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

int	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 vtkOSPRayRendererNode *	New ()

static int	IsTypeOf (const char *type)

static vtkOSPRayRendererNode *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	SAMPLES_PER_PIXEL ()
	When present on renderer, controls the number of primary rays shot per pixel default is 1. More...

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

static vtkInformationIntegerKey *	COMPOSITE_ON_GL ()
	used to make the renderer add ospray's content onto GL rendered content on the window 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 ospray render calls for each refresh. More...

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

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


static vtkInformationStringKey *	RENDERER_TYPE ()
	Set the OSPRay renderer type to use (e.g. More...

static void	SetRendererType (std::string name, vtkRenderer *renderer)
	Set the OSPRay renderer type to use (e.g. More...

static std::string	GetRendererType (vtkRenderer *renderer)
	Set the OSPRay renderer type to use (e.g. More...


static void	SetAmbientSamples (int, vtkRenderer *renderer)
	Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer. More...

static int	GetAmbientSamples (vtkRenderer *renderer)
	Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer. More...


static void	SetCompositeOnGL (int, vtkRenderer *renderer)
	Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer. More...

static int	GetCompositeOnGL (vtkRenderer *renderer)
	Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer. More...

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

static int	IsTypeOf (const char *type)

static vtkRendererNode *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkViewNode
static int	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

	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	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)
	convienience method to add node or nodes if missing from our current list More...

void	AddMissingNodes (vtkCollection *col)
	convienience 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=NULL)
	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

OSPModel	OModel

OSPRenderer	ORenderer

OSPFrameBuffer	OFrameBuffer

int	ImageX

int	ImageY

std::vector< OSPLight >	Lights

int	NumActors

bool	ComputeDepth

bool	Accumulate

bool	CompositeOnGL

float *	ODepthBuffer

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 OSPRay

Translates vtkRenderer state into OSPRay rendering calls

Tests:: vtkOSPRayRendererNode (Tests)

Definition at line 50 of file vtkOSPRayRendererNode.h.

Member Typedef Documentation

typedef vtkRendererNode vtkOSPRayRendererNode::Superclass

Definition at line 55 of file vtkOSPRayRendererNode.h.

Constructor & Destructor Documentation

vtkOSPRayRendererNode::vtkOSPRayRendererNode ( )

protected

vtkOSPRayRendererNode::~vtkOSPRayRendererNode ( )

protected

Member Function Documentation

static vtkOSPRayRendererNode* vtkOSPRayRendererNode::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkOSPRayRendererNode::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRendererNode.

vtkOSPRayRendererNode* vtkOSPRayRendererNode::NewInstance ( ) const

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.

virtual void vtkOSPRayRendererNode::Build ( bool prepass )

virtual

Builds myself.

Reimplemented from vtkRendererNode.

virtual void vtkOSPRayRendererNode::Render ( bool prepass )

virtual

Traverse graph in ospray's prefered order and render.

Reimplemented from vtkViewNode.

virtual void vtkOSPRayRendererNode::Invalidate ( bool prepass )

virtual

Invalidates cached rendering data.

Reimplemented from vtkViewNode.

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.

static vtkInformationIntegerKey* vtkOSPRayRendererNode::SAMPLES_PER_PIXEL ( )

static

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

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

static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

static int vtkOSPRayRendererNode::GetSamplesPerPixel ( vtkRenderer * renderer )

static

Convenience method to set/get SAMPLES_PER_PIXEL on a vtkRenderer.

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

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

static int vtkOSPRayRendererNode::GetMaxFrames ( vtkRenderer * renderer )

static

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

default is 1 TODO: NOT CURRENTLY USED

static vtkInformationStringKey* vtkOSPRayRendererNode::RENDERER_TYPE ( )

static

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

scivis vs. pathtracer) default is scivis

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

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

static

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

scivis vs. pathtracer) default is scivis

static vtkInformationIntegerKey* vtkOSPRayRendererNode::AMBIENT_SAMPLES ( )

static

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

default is 4

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

static

Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.

static int vtkOSPRayRendererNode::GetAmbientSamples ( vtkRenderer * renderer )

static

Convenience method to set/get AMBIENT_SAMPLES on a vtkRenderer.

static vtkInformationIntegerKey* vtkOSPRayRendererNode::COMPOSITE_ON_GL ( )

static

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

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

static

Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.

static int vtkOSPRayRendererNode::GetCompositeOnGL ( vtkRenderer * renderer )

static

Convenience method to set/get COMPOSITE_ON_GL on a vtkRenderer.

OSPModel vtkOSPRayRendererNode::GetOModel ( )

inline

Methods for other nodes to access.

Definition at line 148 of file vtkOSPRayRendererNode.h.

OSPRenderer vtkOSPRayRendererNode::GetORenderer ( )

inline

Definition at line 149 of file vtkOSPRayRendererNode.h.

void vtkOSPRayRendererNode::AddLight ( OSPLight light )

inline

Definition at line 150 of file vtkOSPRayRendererNode.h.

virtual unsigned char* vtkOSPRayRendererNode::GetBuffer ( )

inlinevirtual

Get the last rendered ColorBuffer.

Definition at line 156 of file vtkOSPRayRendererNode.h.

virtual float* vtkOSPRayRendererNode::GetZBuffer ( )

inlinevirtual

Get the last rendered ZBuffer.

Definition at line 162 of file vtkOSPRayRendererNode.h.

virtual void vtkOSPRayRendererNode::Traverse ( int operation )

virtual

Reimplemented from vtkViewNode.

Member Data Documentation

unsigned char* vtkOSPRayRendererNode::Buffer

protected

Definition at line 174 of file vtkOSPRayRendererNode.h.

float* vtkOSPRayRendererNode::ZBuffer

protected

Definition at line 175 of file vtkOSPRayRendererNode.h.

OSPModel vtkOSPRayRendererNode::OModel

protected

Definition at line 177 of file vtkOSPRayRendererNode.h.

OSPRenderer vtkOSPRayRendererNode::ORenderer

protected

Definition at line 178 of file vtkOSPRayRendererNode.h.

OSPFrameBuffer vtkOSPRayRendererNode::OFrameBuffer

protected

Definition at line 179 of file vtkOSPRayRendererNode.h.

int vtkOSPRayRendererNode::ImageX

protected

Definition at line 180 of file vtkOSPRayRendererNode.h.

int vtkOSPRayRendererNode::ImageY

protected

Definition at line 180 of file vtkOSPRayRendererNode.h.

std::vector<OSPLight> vtkOSPRayRendererNode::Lights

protected

Definition at line 181 of file vtkOSPRayRendererNode.h.

int vtkOSPRayRendererNode::NumActors

protected

Definition at line 182 of file vtkOSPRayRendererNode.h.

bool vtkOSPRayRendererNode::ComputeDepth

protected

Definition at line 183 of file vtkOSPRayRendererNode.h.

bool vtkOSPRayRendererNode::Accumulate

protected

Definition at line 184 of file vtkOSPRayRendererNode.h.

bool vtkOSPRayRendererNode::CompositeOnGL

protected

Definition at line 185 of file vtkOSPRayRendererNode.h.

float* vtkOSPRayRendererNode::ODepthBuffer

protected

Definition at line 186 of file vtkOSPRayRendererNode.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OSPRay/vtkOSPRayRendererNode.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