VTK  9.3.20240418
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkOpenVRModel Class Reference

OpenVR device model. More...

#include <vtkOpenVRModel.h>

Inheritance diagram for vtkOpenVRModel:
[legend]
Collaboration diagram for vtkOpenVRModel:
[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. More...
 
vtkOpenVRModelNewInstance () const
 
- Public Member Functions inherited from vtkVRModel
vtkVRModelNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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. 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...
 
vtkCommandGetCommand (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 vtkOpenVRModelNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenVRModelSafeDownCast (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. 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 vtkObjectBaseNew ()
 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...
 

Public Attributes

vr::RenderModel_t * RawModel
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenVRModel ()
 
 ~vtkOpenVRModel () override=default
 
void FillModelHelper () override
 
void SetPositionAndTCoords () override
 
void CreateTextureObject (vtkOpenGLRenderWindow *win) override
 
void LoadModelAndTexture (vtkOpenGLRenderWindow *win) override
 
- Protected Member Functions inherited from vtkVRModel
 vtkVRModel ()
 
 ~vtkVRModel () override
 
- 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

vr::RenderModel_TextureMap_t * RawTexture
 
- 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

OpenVR 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 20 of file vtkOpenVRModel.h.

Member Typedef Documentation

◆ Superclass

Definition at line 24 of file vtkOpenVRModel.h.

Constructor & Destructor Documentation

◆ vtkOpenVRModel()

vtkOpenVRModel::vtkOpenVRModel ( )
protected

◆ ~vtkOpenVRModel()

vtkOpenVRModel::~vtkOpenVRModel ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkOpenVRModel* vtkOpenVRModel::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenVRModel::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVRModel.

◆ NewInstance()

vtkOpenVRModel* vtkOpenVRModel::NewInstance ( ) const

◆ FillModelHelper()

void vtkOpenVRModel::FillModelHelper ( )
overrideprotectedvirtual

Implements vtkVRModel.

◆ SetPositionAndTCoords()

void vtkOpenVRModel::SetPositionAndTCoords ( )
overrideprotectedvirtual

Implements vtkVRModel.

◆ CreateTextureObject()

void vtkOpenVRModel::CreateTextureObject ( vtkOpenGLRenderWindow win)
overrideprotectedvirtual

Implements vtkVRModel.

◆ LoadModelAndTexture()

void vtkOpenVRModel::LoadModelAndTexture ( vtkOpenGLRenderWindow win)
overrideprotectedvirtual

Implements vtkVRModel.

Member Data Documentation

◆ RawModel

vr::RenderModel_t* vtkOpenVRModel::RawModel

Definition at line 26 of file vtkOpenVRModel.h.

◆ RawTexture

vr::RenderModel_TextureMap_t* vtkOpenVRModel::RawTexture
protected

Definition at line 36 of file vtkOpenVRModel.h.


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