base class to objects which create + manage an ANARI library, device, and renderer More...

#include <vtkAnariRenderer.h>

Inheritance diagram for vtkAnariRenderer:

Collaboration diagram for vtkAnariRenderer:

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

vtkAnariRenderer *	NewInstance () const

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

void	SetSubtype (const char *subtype="default")
	Set the underlying subtype of the anari::Renderer. More...

const char *	GetSubtype () const
	Get the subtype of the current underlying anari::Renderer. More...

anari::Renderer	GetHandle () const
	Get the current ANARI renderer, which will be NULL if not yet setup. More...

std::vector< std::pair< std::string, int > >	GetRendererParameters () const
	Returns a list of parameter names, and their respective ANARI type. More...

std::string	GetRendererParameterDescription (std::pair< std::string, int > rparam) const
	Provide description for a given renderer parameter. More...

bool	IsRendererParameterRequired (std::pair< std::string, int > rparam) const
	Check if a given renderer parameter is required. More...


void	SetAnariDevice (vtkAnariDevice *d)
	Set/Get the anari device. More...

virtual vtkAnariDevice *	GetAnariDevice ()
	Set/Get the anari device. More...


void	SetParameterb (const char *param, bool)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameteri (const char *param, int)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter2i (const char *param, int, int)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter3i (const char *param, int, int, int)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter4i (const char *param, int, int, int, int)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameterf (const char *param, float)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter2f (const char *param, float, float)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter3f (const char *param, float, float, float)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...

void	SetParameter4f (const char *param, float, float, float, float)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object. More...


const void *	GetRendererParameterDefault (std::pair< std::string, int > rparam)
	Get default, min, max, and current value for a given renderer parameter. More...

const void *	GetRendererParameterMinimum (std::pair< std::string, int > rparam)
	Get default, min, max, and current value for a given renderer parameter. More...

const void *	GetRendererParameterMaximum (std::pair< std::string, int > rparam)
	Get default, min, max, and current value for a given renderer parameter. More...

const void *	GetRendererParameterValue (std::pair< std::string, int > rparam)
	Get default, min, max, and current value for a given renderer parameter. 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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

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

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkAnariRenderer *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAnariRenderer *	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 (vtkTypeBool 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 vtkTypeBool	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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnariRenderer ()
	Default constructor. More...

	~vtkAnariRenderer () override
	Destructor. 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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkAnariDevice >	AnariDevice = nullptr

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

base class to objects which create + manage an ANARI library, device, and renderer

This class extends vtkAnariDevice to also manage an instance of an ANARI renderer object, as well as being able to query what renderer subtypes are available and setting parameters on the object. Note that applications which set any 'background' parameters on the handle directly will conflict with vtkAnariRendererNode setting it to whatever the vtkRenderer values are.

Definition at line 30 of file vtkAnariRenderer.h.

Member Typedef Documentation

typedef vtkObject vtkAnariRenderer::Superclass

Definition at line 34 of file vtkAnariRenderer.h.

Constructor & Destructor Documentation

vtkAnariRenderer::vtkAnariRenderer ( )

protected

Default constructor.

vtkAnariRenderer::~vtkAnariRenderer ( )

overrideprotected

Destructor.

Member Function Documentation

static vtkAnariRenderer* vtkAnariRenderer::New ( )

static

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

static

virtual vtkTypeBool vtkAnariRenderer::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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkAnariRenderer::NewInstanceInternal ( ) const

protectedvirtual

vtkAnariRenderer* vtkAnariRenderer::NewInstance ( ) const

void vtkAnariRenderer::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 vtkObject.

void vtkAnariRenderer::SetAnariDevice ( vtkAnariDevice * d )

Set/Get the anari device.

virtual vtkAnariDevice* vtkAnariRenderer::GetAnariDevice ( )

virtual

Set/Get the anari device.

void vtkAnariRenderer::SetSubtype ( const char * subtype = "default" )

Set the underlying subtype of the anari::Renderer.

When a different subtype is passed from what was already in-use, a new anari::Renderer handle will be created and will not keep any parameter values set on the previous anari::Renderer. Calling this without having a setup anari::Device will cause a default setup of the anari::Device to be done using the 'environment' device.

const char* vtkAnariRenderer::GetSubtype ( ) const

Get the subtype of the current underlying anari::Renderer.

Empty if not yet set.

void vtkAnariRenderer::SetParameterb	(	const char *	param,
		bool
	)

Methods to set/commit generic parameteters on the underlying anari::Renderer object.