VTK  9.4.20241121
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkOpenXRUtilities Class Reference

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

#include <vtkOpenXRUtilities.h>

Inheritance diagram for vtkOpenXRUtilities:
[legend]
Collaboration diagram for vtkOpenXRUtilities:
[legend]

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.
 
vtkOpenXRUtilitiesNewInstance () const
 
- 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.
 
vtkCommandGetCommand (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 vtkOpenXRUtilitiesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenXRUtilitiesSafeDownCast (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.
 
static void SetMatrixFromXrPose (vtkMatrix4x4 *result, const XrPosef &xrPose)
 Given an XR pose (orientation quaternion + position vector), set the provided matrix from it.
 
static void CreateFromQuaternion (double result[16], const XrQuaternionf &quat)
 Given a quaternion, return elements of equivalent matrix as an array.
 
static const char * GetActionTypeAsString (const XrActionType &actionType)
 Return string representation of given XrActionType.
 
static const char * GetViewConfigurationTypeAsString (const XrViewConfigurationType &viewConfigType)
 Return string representation of given XrViewConfigurationType.
 
static const char * GetStructureTypeAsString (const XrStructureType &structureType)
 Return string representation of given XrStructureType.
 
static const XrPosef & GetIdentityPose ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () 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.
 
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

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

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: