vtkAnariDevice Class Reference

base class to objects which create + manage a ANARI library + device More...

#include <vtkAnariDevice.h>

Inheritance diagram for vtkAnariDevice:

Collaboration diagram for vtkAnariDevice:

Public Types
using	OnNewDeviceCallback = std::function< void(anari::Device)>
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.
vtkAnariDevice *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetAnariDebugConfig (const char *traceDir, const char *traceMode)
	Setup the trace directory and trace mode strings for the debug device for when SetupAnariDeviceFromLibrary() is called.
bool	SetupAnariDeviceFromLibrary (const char *libraryName, const char *deviceName, bool enableDebugLayer=false)
	Initialize this vtkAnariDevice from the name of an anari::Library and anari::Device to be loaded.
bool	AnariInitialized () const
	Check if ANARI has been initialized with SetupAnariDeviceFromLibrary.
anari::Device	GetHandle () const
	Get the current ANARI device, which will be NULL if not yet setup.
const anari::Extensions &	GetAnariDeviceExtensions () const
	Get the current ANARI device extensions, which will be empty if not yet setup.
const char *const *	GetAnariDeviceExtensionStrings () const
	Get the current ANARI device extensions as list of strings.
void	SetOnNewDeviceCallback (OnNewDeviceCallback &&cb)
	Set a callback that gets called whenever a new device has been created.
void	SetParameterc (const char *param, char *)
	Methods to set/commit generic parameteters on the underlying anari::Renderer object.
void	SetParameterb (const char *param, bool)
void	SetParameteri (const char *param, int)
void	SetParameter2i (const char *param, int, int)
void	SetParameter3i (const char *param, int, int, int)
void	SetParameter4i (const char *param, int, int, int, int)
void	SetParameterf (const char *param, float)
void	SetParameter2f (const char *param, float, float)
void	SetParameter3f (const char *param, float, float, float)
void	SetParameter4f (const char *param, float, float, float, float)
void	SetParameterd (const char *param, double)
void	CommitParameters ()
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 vtkAnariDevice *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAnariDevice *	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
	vtkAnariDevice ()
	Default constructor.
virtual	~vtkAnariDevice ()
	Destructor.
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
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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

Detailed Description

base class to objects which create + manage a ANARI library + device

Multiple VTK-ANARI objects are potentially responsible for creating and managing ANARI libraries and devices, so this base class consolidates the common functionality between them.

Definition at line 27 of file vtkAnariDevice.h.

Member Typedef Documentation

OnNewDeviceCallback

using vtkAnariDevice::OnNewDeviceCallback = std::function<void(anari::Device)>

Definition at line 30 of file vtkAnariDevice.h.

Superclass

typedef vtkObject vtkAnariDevice::Superclass

Definition at line 33 of file vtkAnariDevice.h.

Constructor & Destructor Documentation

vtkAnariDevice()

vtkAnariDevice::vtkAnariDevice ( )

protected

Default constructor.

~vtkAnariDevice()

virtual vtkAnariDevice::~vtkAnariDevice ( )

protectedvirtual

Destructor.

Member Function Documentation

New()

static vtkAnariDevice * vtkAnariDevice::New ( )

static

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkAnariDevice::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkAnariDevice * vtkAnariDevice::NewInstance

(

)

const

PrintSelf()

void vtkAnariDevice::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 vtkObjectBase.

SetAnariDebugConfig()

void vtkAnariDevice::SetAnariDebugConfig	(	const char *	traceDir,
		const char *	traceMode
	)

Setup the trace directory and trace mode strings for the debug device for when SetupAnariDeviceFromLibrary() is called.

Once the Anari device is created, this method will have no effect.

SetupAnariDeviceFromLibrary()

bool vtkAnariDevice::SetupAnariDeviceFromLibrary	(	const char *	libraryName,
		const char *	deviceName,
		bool	enableDebugLayer = false
	)

Initialize this vtkAnariDevice from the name of an anari::Library and anari::Device to be loaded.

This initialization will use whatever debug configuration set by SetupAnariDebugConfig() prior to this function when 'enableDebugLayer' is true. Returns success of getting everything setup.

AnariInitialized()

bool vtkAnariDevice::AnariInitialized

(

)

const

Check if ANARI has been initialized with SetupAnariDeviceFromLibrary.

GetHandle()

anari::Device vtkAnariDevice::GetHandle

(

)

const

Get the current ANARI device, which will be NULL if not yet setup.

GetAnariDeviceExtensions()

const anari::Extensions & vtkAnariDevice::GetAnariDeviceExtensions

(

)

const

Get the current ANARI device extensions, which will be empty if not yet setup.

GetAnariDeviceExtensionStrings()

const char *const * vtkAnariDevice::GetAnariDeviceExtensionStrings

(

)

const

Get the current ANARI device extensions as list of strings.

SetOnNewDeviceCallback()

void vtkAnariDevice::SetOnNewDeviceCallback

(

OnNewDeviceCallback &&

cb

)

Set a callback that gets called whenever a new device has been created.

SetParameterc()

void vtkAnariDevice::SetParameterc	(	const char *	param,
		char *
	)

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

These are primarily to support setting parameters from Python – C++ users can also use the ANARI API directly by using anari::setParameter() and anari::commitParameters() directly as it is equivalent.

SetParameterb()

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

SetParameteri()

void vtkAnariDevice::SetParameteri	(	const char *	param,
		int
	)

SetParameter2i()

void vtkAnariDevice::SetParameter2i	(	const char *	param,
		int	,
		int
	)

SetParameter3i()

void vtkAnariDevice::SetParameter3i	(	const char *	param,
		int	,
		int	,
		int
	)

SetParameter4i()

void vtkAnariDevice::SetParameter4i	(	const char *	param,
		int	,
		int	,
		int	,
		int
	)

SetParameterf()

void vtkAnariDevice::SetParameterf	(	const char *	param,
		float
	)

SetParameter2f()

void vtkAnariDevice::SetParameter2f	(	const char *	param,
		float	,
		float
	)

SetParameter3f()

void vtkAnariDevice::SetParameter3f	(	const char *	param,
		float	,
		float	,
		float
	)

SetParameter4f()

void vtkAnariDevice::SetParameter4f	(	const char *	param,
		float	,
		float	,
		float	,
		float
	)

SetParameterd()

void vtkAnariDevice::SetParameterd	(	const char *	param,
		double
	)

CommitParameters()

void vtkAnariDevice::CommitParameters

(

)

---

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

• Rendering/ANARI/vtkAnariDevice.h