links vtkActor and vtkMapper to OSPRay More...

#include <vtkOSPRayActorNode.h>

Inheritance diagram for vtkOSPRayActorNode:

Collaboration diagram for vtkOSPRayActorNode:

Public Types
enum	ScalingMode { ALL_EXACT = -1 , ALL_APPROXIMATE , EACH_MAPPED , EACH_EXACT }
	Scaling modes for the spheres and cylinders that the raytracer renders for points and lines created by VTK. More...

typedef vtkActorNode	Superclass

Public Types inherited from vtkActorNode
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.

vtkOSPRayActorNode *	NewInstance () const

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

vtkMTimeType	GetMTime () override
	Overridden to take into account my renderables time, including mapper and data into mapper inclusive of composite input.

Public Member Functions inherited from vtkActorNode
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkActorNode *	NewInstance () 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.

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.

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

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.

vtkViewNode *	GetFirstAncestorOfType (const char *type)
	Find the first parent/grandparent of the desired type.

vtkViewNode *	GetFirstChildOfType (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 vtkObject *	GetRenderable ()
	This is the VTK class that this node stands in for.

virtual void	SetParent (vtkViewNode *)
	Access the node that owns this one.

virtual vtkViewNode *	GetParent ()
	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 vtkViewNodeFactory *	GetMyFactory ()
	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.

vtkCommand *	GetCommand (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 vtkOSPRayActorNode *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOSPRayActorNode *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	ENABLE_SCALING ()
	A key to set the ScalingMode.

static vtkInformationStringKey *	SCALE_ARRAY_NAME ()
	Name of a point aligned, single component wide, double valued array that, when added to the mapper, will be used to scale each element in the sphere and cylinder representations individually.

static void	SetScaleArrayName (const char scaleArrayName, vtkActor )
	Convenience method to set a scale_array_name on my renderable.

static vtkInformationObjectBaseKey *	SCALE_FUNCTION ()
	A piecewise function for values from the scale array that alters the resulting radii arbitrarily.

static void	SetScaleFunction (vtkPiecewiseFunction scaleFunction, vtkActor )
	Convenience method to set a scale_function on my renderable.

static vtkInformationDoubleKey *	LUMINOSITY ()
	Indicates that the actor acts as a light emitting object.


static void	SetEnableScaling (int value, vtkActor *)
	Convenience method to set enable_scaling on my renderable.

static int	GetEnableScaling (vtkActor *)
	Convenience method to set enable_scaling on my renderable.


static void	SetLuminosity (double value, vtkProperty *)
	Convenience method to set luminosity on my renderable.

static double	GetLuminosity (vtkProperty *)
	Convenience method to set luminosity on my renderable.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkActorNode *	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.

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 vtkObjectBase *	New ()
	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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOSPRayActorNode ()

	~vtkOSPRayActorNode () override

Protected Member Functions inherited from vtkActorNode
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkActorNode ()

	~vtkActorNode () override

Protected Member Functions inherited from vtkViewNode
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkViewNode ()

	~vtkViewNode () override

virtual void	Apply (int operation, bool prepass)

void	RemoveUnusedNodes ()
	Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.

virtual vtkViewNode *	CreateViewNode (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 &)

Additional Inherited Members
Public Attributes inherited from vtkViewNode
vtkMTimeType	RenderTime
	Allows smart caching.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkViewNode
vtkObject *	Renderable

vtkWeakPointer< vtkViewNode >	Parent

std::list< vtkViewNode * >	Children

vtkViewNodeFactory *	MyFactory

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

Static Protected Attributes inherited from vtkViewNode
static const char *	operation_type_strings []

Detailed Description

links vtkActor and vtkMapper to OSPRay

Translates vtkActor/Mapper state into OSPRay rendering calls

Tests:: vtkOSPRayActorNode (Tests)

Definition at line 35 of file vtkOSPRayActorNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkActorNode vtkOSPRayActorNode::Superclass

Definition at line 39 of file vtkOSPRayActorNode.h.

Member Enumeration Documentation

◆ ScalingMode

enum vtkOSPRayActorNode::ScalingMode

Scaling modes for the spheres and cylinders that the raytracer renders for points and lines created by VTK.

Enumerator
ALL_EXACT
ALL_APPROXIMATE
EACH_MAPPED
EACH_EXACT

Definition at line 52 of file vtkOSPRayActorNode.h.

Constructor & Destructor Documentation

◆ vtkOSPRayActorNode()

vtkOSPRayActorNode::vtkOSPRayActorNode ( )

protected

◆ ~vtkOSPRayActorNode()

vtkOSPRayActorNode::~vtkOSPRayActorNode ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOSPRayActorNode * vtkOSPRayActorNode::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOSPRayActorNode::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 vtkActorNode.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOSPRayActorNode::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActorNode.

◆ NewInstance()

vtkOSPRayActorNode * vtkOSPRayActorNode::NewInstance ( ) const

◆ PrintSelf()

void vtkOSPRayActorNode::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 vtkActorNode.

◆ GetMTime()

vtkMTimeType vtkOSPRayActorNode::GetMTime ( )

overridevirtual

Overridden to take into account my renderables time, including mapper and data into mapper inclusive of composite input.

Reimplemented from vtkObject.

◆ ENABLE_SCALING()

static vtkInformationIntegerKey * vtkOSPRayActorNode::ENABLE_SCALING ( )

static

A key to set the ScalingMode.

The default is ALL_APPROXIMATE. ALL_EXACT means use vtkActor.PointSize/LineWidth for all radii. ALL_APPROXIMATE sets all radii to approximate GL's pixel sizes via a function of PointSize/LineWidth and object bounding box. EACH_MAPPED means map every value from SCALE_ARRAY_NAME through the SCALE_FUNCTION lookup table to set each radius independently. EACH_EXACT means use the SCALE_ARRAY_NAME to set each radius directly.

◆ SetEnableScaling()

static void vtkOSPRayActorNode::SetEnableScaling	(	int	value,
		vtkActor *
	)

static

Convenience method to set enable_scaling on my renderable.

◆ GetEnableScaling()

static int vtkOSPRayActorNode::GetEnableScaling ( vtkActor * )

static

Convenience method to set enable_scaling on my renderable.

◆ SCALE_ARRAY_NAME()

static vtkInformationStringKey * vtkOSPRayActorNode::SCALE_ARRAY_NAME ( )

static

Name of a point aligned, single component wide, double valued array that, when added to the mapper, will be used to scale each element in the sphere and cylinder representations individually.

When not supplied the radius is constant across all elements and is a function of the Mapper's PointSize and LineWidth.

◆ SetScaleArrayName()

static void vtkOSPRayActorNode::SetScaleArrayName	(	const char *	scaleArrayName,
		vtkActor *
	)

static

Convenience method to set a scale_array_name on my renderable.

◆ SCALE_FUNCTION()

static vtkInformationObjectBaseKey * vtkOSPRayActorNode::SCALE_FUNCTION ( )

static

A piecewise function for values from the scale array that alters the resulting radii arbitrarily.

◆ SetScaleFunction()

static void vtkOSPRayActorNode::SetScaleFunction	(	vtkPiecewiseFunction *	scaleFunction,
		vtkActor *
	)

static

Convenience method to set a scale_function on my renderable.

◆ LUMINOSITY()

static vtkInformationDoubleKey * vtkOSPRayActorNode::LUMINOSITY ( )

static

Indicates that the actor acts as a light emitting object.

◆ SetLuminosity()

static void vtkOSPRayActorNode::SetLuminosity	(	double	value,
		vtkProperty *
	)

static

Convenience method to set luminosity on my renderable.

◆ GetLuminosity()

static double vtkOSPRayActorNode::GetLuminosity ( vtkProperty * )

static

Convenience method to set luminosity on my renderable.

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

Rendering/RayTracing/vtkOSPRayActorNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ScalingMode

Constructor & Destructor Documentation

◆ vtkOSPRayActorNode()

◆ ~vtkOSPRayActorNode()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ ENABLE_SCALING()

◆ SetEnableScaling()

◆ GetEnableScaling()

◆ SCALE_ARRAY_NAME()

◆ SetScaleArrayName()

◆ SCALE_FUNCTION()

◆ SetScaleFunction()

◆ LUMINOSITY()

◆ SetLuminosity()

◆ GetLuminosity()