Header file that contains utility functions for OpenXR. More...

#include <vtkOpenXRUtilities.h>

Inheritance diagram for vtkOpenXRUtilities:

Collaboration diagram for vtkOpenXRUtilities:

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

vtkOpenXRUtilities *	NewInstance () const

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenXRUtilities *	SafeDownCast (vtkObjectBase *o)

static void	CreateProjectionFov (vtkMatrix4x4 *result, XrFovf fov, float nearZ, float farZ)
	Given a field of view (left, right, up, down angles) and near/far clipping builds, return a projection matrix in result. More...

static void	SetMatrixFromXrPose (vtkMatrix4x4 *result, const XrPosef &xrPose)
	Given an XR pose (orientation quaternion + position vector), set the provided matrix from it. More...

static void	CreateFromQuaternion (double result[16], const XrQuaternionf &quat)
	Given a quaternion, return elements of equivalent matrix as an array. More...

static const char *	GetActionTypeAsString (const XrActionType &actionType)
	Return string representation of given XrActionType. More...

static const char *	GetViewConfigurationTypeAsString (const XrViewConfigurationType &viewConfigType)
	Return string representation of given XrViewConfigurationType. More...

static const char *	GetStructureTypeAsString (const XrStructureType &structureType)
	Return string representation of given XrStructureType. More...

static const XrPosef &	GetIdentityPose ()

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

	vtkOpenXRUtilities ()=default

	~vtkOpenXRUtilities () override=default

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

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

Header file that contains utility functions for OpenXR.

@class vtkOpenXRUtilities

This class contains inline functions to create matrices from OpenXR pose And other functions to convert OpenXR structures to string.

vtkOpenXRUtilities

Definition at line 21 of file vtkOpenXRUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOpenXRUtilities::Superclass

Definition at line 25 of file vtkOpenXRUtilities.h.

Constructor & Destructor Documentation

◆ vtkOpenXRUtilities()

vtkOpenXRUtilities::vtkOpenXRUtilities ( )

protecteddefault

◆ ~vtkOpenXRUtilities()

vtkOpenXRUtilities::~vtkOpenXRUtilities ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkOpenXRUtilities* vtkOpenXRUtilities::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOpenXRUtilities::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 vtkOpenXRUtilities* vtkOpenXRUtilities::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenXRUtilities::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOpenXRUtilities* vtkOpenXRUtilities::NewInstance ( ) const

◆ CreateProjectionFov()

void vtkOpenXRUtilities::CreateProjectionFov	(	vtkMatrix4x4 *	result,
		XrFovf	fov,
		float	nearZ,
		float	farZ
	)

inlinestatic

Given a field of view (left, right, up, down angles) and near/far clipping builds, return a projection matrix in result.

Definition at line 82 of file vtkOpenXRUtilities.h.

◆ SetMatrixFromXrPose()

void vtkOpenXRUtilities::SetMatrixFromXrPose	(	vtkMatrix4x4 *	result,
		const XrPosef &	xrPose
	)

inlinestatic

Given an XR pose (orientation quaternion + position vector), set the provided matrix from it.

Definition at line 192 of file vtkOpenXRUtilities.h.

◆ CreateFromQuaternion()

void vtkOpenXRUtilities::CreateFromQuaternion	(	double	result[16],
		const XrQuaternionf &	quat
	)

inlinestatic

Given a quaternion, return elements of equivalent matrix as an array.

Definition at line 152 of file vtkOpenXRUtilities.h.

◆ GetActionTypeAsString()

const char * vtkOpenXRUtilities::GetActionTypeAsString ( const XrActionType & actionType )

inlinestatic

Return string representation of given XrActionType.

Definition at line 209 of file vtkOpenXRUtilities.h.

◆ GetViewConfigurationTypeAsString()

const char * vtkOpenXRUtilities::GetViewConfigurationTypeAsString ( const XrViewConfigurationType & viewConfigType )

inlinestatic

Return string representation of given XrViewConfigurationType.

Definition at line 229 of file vtkOpenXRUtilities.h.

◆ GetStructureTypeAsString()

const char * vtkOpenXRUtilities::GetStructureTypeAsString ( const XrStructureType & structureType )

inlinestatic

Return string representation of given XrStructureType.

Definition at line 248 of file vtkOpenXRUtilities.h.

◆ GetIdentityPose()

const XrPosef & vtkOpenXRUtilities::GetIdentityPose ( )

inlinestatic

Definition at line 72 of file vtkOpenXRUtilities.h.

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

Rendering/OpenXR/vtkOpenXRUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

@class vtkOpenXRUtilities

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenXRUtilities()

◆ ~vtkOpenXRUtilities()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ CreateProjectionFov()

◆ SetMatrixFromXrPose()

◆ CreateFromQuaternion()

◆ GetActionTypeAsString()

◆ GetViewConfigurationTypeAsString()

◆ GetStructureTypeAsString()

◆ GetIdentityPose()