VTK  9.3.20240712
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenXRModel Class Reference

OpenXR device model. More...

#include <vtkOpenXRModel.h>

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

Public Types

typedef vtkVRModel Superclass
 
- Public Types inherited from vtkVRModel
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.
 
vtkOpenXRModelNewInstance () const
 
- Public Member Functions inherited from vtkVRModel
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkVRModelNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool Build (vtkOpenGLRenderWindow *win)
 
void Render (vtkOpenGLRenderWindow *win, vtkMatrix4x4 *poseInTrackingCoordinates)
 
const std::string & GetName () const
 
void SetName (const std::string &modelName)
 
void SetVisibility (bool v)
 
bool GetVisibility ()
 
void SetShowRay (bool v)
 
void SetRayLength (double length)
 
void SetRayColor (double r, double g, double b)
 
vtkVRRayGetRay ()
 
void ReleaseGraphicsResources (vtkWindow *win)
 
- 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 vtkOpenXRModelNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenXRModelSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkVRModel
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVRModelSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkOpenXRModel ()=default
 
 ~vtkOpenXRModel () override=default
 
void FillModelHelper () override
 
void SetPositionAndTCoords () override
 
void CreateTextureObject (vtkOpenGLRenderWindow *win) override
 
void LoadModelAndTexture (vtkOpenGLRenderWindow *win) override
 
void AsyncLoad ()
 
- Protected Member Functions inherited from vtkVRModel
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVRModel ()
 
 ~vtkVRModel () override
 
virtual void FillModelHelper ()=0
 
virtual void SetPositionAndTCoords ()=0
 
virtual void CreateTextureObject (vtkOpenGLRenderWindow *win)=0
 
virtual void LoadModelAndTexture (vtkOpenGLRenderWindow *win)=0
 
- 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 &)
 

Protected Attributes

std::atomic< bool > ModelLoading { false }
 
std::atomic< bool > ModelLoaded { false }
 
std::vector< float > ModelVBOData
 
std::vector< uint16_t > ModelIBOData
 
std::vector< uint8_t > TextureData
 
- Protected Attributes inherited from vtkVRModel
std::string ModelName
 
bool Visibility
 
bool Loaded
 
bool FailedToLoad
 
vtkOpenGLHelper ModelHelper
 
vtkOpenGLVertexBufferObjectModelVBO
 
vtkNew< vtkTextureObjectTextureObject
 
vtkNew< vtkMatrix4x4ModelToProjectionMatrix
 
vtkNew< vtkVRRayRay
 
- 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

OpenXR device model.

This internal class is used to load models such as for the trackers and controllers and to render them in the scene

Definition at line 21 of file vtkOpenXRModel.h.

Member Typedef Documentation

◆ Superclass

Definition at line 25 of file vtkOpenXRModel.h.

Constructor & Destructor Documentation

◆ vtkOpenXRModel()

vtkOpenXRModel::vtkOpenXRModel ( )
protecteddefault

◆ ~vtkOpenXRModel()

vtkOpenXRModel::~vtkOpenXRModel ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkOpenXRModel * vtkOpenXRModel::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenXRModel::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVRModel.

◆ NewInstance()

vtkOpenXRModel * vtkOpenXRModel::NewInstance ( ) const

◆ FillModelHelper()

void vtkOpenXRModel::FillModelHelper ( )
overrideprotectedvirtual

Implements vtkVRModel.

◆ SetPositionAndTCoords()

void vtkOpenXRModel::SetPositionAndTCoords ( )
overrideprotectedvirtual

Implements vtkVRModel.

◆ CreateTextureObject()

void vtkOpenXRModel::CreateTextureObject ( vtkOpenGLRenderWindow win)
overrideprotectedvirtual

Implements vtkVRModel.

◆ LoadModelAndTexture()

void vtkOpenXRModel::LoadModelAndTexture ( vtkOpenGLRenderWindow win)
overrideprotectedvirtual

Implements vtkVRModel.

◆ AsyncLoad()

void vtkOpenXRModel::AsyncLoad ( )
protected

Member Data Documentation

◆ ModelLoading

std::atomic<bool> vtkOpenXRModel::ModelLoading { false }
protected

Definition at line 36 of file vtkOpenXRModel.h.

◆ ModelLoaded

std::atomic<bool> vtkOpenXRModel::ModelLoaded { false }
protected

Definition at line 37 of file vtkOpenXRModel.h.

◆ ModelVBOData

std::vector<float> vtkOpenXRModel::ModelVBOData
protected

Definition at line 40 of file vtkOpenXRModel.h.

◆ ModelIBOData

std::vector<uint16_t> vtkOpenXRModel::ModelIBOData
protected

Definition at line 41 of file vtkOpenXRModel.h.

◆ TextureData

std::vector<uint8_t> vtkOpenXRModel::TextureData
protected

Definition at line 42 of file vtkOpenXRModel.h.


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