VTK
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 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
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Build (vtkOpenVRRenderWindow *win)
 
void Render (vtkOpenVRRenderWindow *win, const vr::TrackedDevicePose_t &pose)
 
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)
 
vtkOpenVRRayGetRay ()
 
void ReleaseGraphicsResources (vtkRenderWindow *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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOpenVRModelNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenVRModelSafeDownCast (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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

vr::TrackedDeviceIndex_t TrackedDevice
 
vr::RenderModel_t * RawModel
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenVRModel ()
 
 ~vtkOpenVRModel () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::string ModelName
 
bool Visibility
 
bool Loaded
 
bool FailedToLoad
 
vr::RenderModel_TextureMap_t * RawTexture
 
vtkOpenGLHelper ModelHelper
 
vtkOpenGLVertexBufferObjectModelVBO
 
vtkNew< vtkTextureObjectTextureObject
 
vtkNew< vtkMatrix4x4PoseMatrix
 
vtkNew< vtkOpenVRRayRay
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkOpenVRModel.h.

Constructor & Destructor Documentation

◆ vtkOpenVRModel()

vtkOpenVRModel::vtkOpenVRModel ( )
protected

◆ ~vtkOpenVRModel()

vtkOpenVRModel::~vtkOpenVRModel ( )
overrideprotected

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenVRModel::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenVRModel* vtkOpenVRModel::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenVRModel::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 vtkObject.

◆ Build()

bool vtkOpenVRModel::Build ( vtkOpenVRRenderWindow win)

◆ Render()

void vtkOpenVRModel::Render ( vtkOpenVRRenderWindow win,
const vr::TrackedDevicePose_t &  pose 
)

◆ GetName()

const std::string& vtkOpenVRModel::GetName ( ) const
inline

Definition at line 50 of file vtkOpenVRModel.h.

◆ SetName()

void vtkOpenVRModel::SetName ( const std::string &  modelName)
inline

Definition at line 53 of file vtkOpenVRModel.h.

◆ SetVisibility()

void vtkOpenVRModel::SetVisibility ( bool  v)
inline

Definition at line 58 of file vtkOpenVRModel.h.

◆ GetVisibility()

bool vtkOpenVRModel::GetVisibility ( )
inline

Definition at line 61 of file vtkOpenVRModel.h.

◆ SetShowRay()

void vtkOpenVRModel::SetShowRay ( bool  v)

◆ SetRayLength()

void vtkOpenVRModel::SetRayLength ( double  length)

◆ GetRay()

vtkOpenVRRay* vtkOpenVRModel::GetRay ( )
inline

Definition at line 68 of file vtkOpenVRModel.h.

◆ ReleaseGraphicsResources()

void vtkOpenVRModel::ReleaseGraphicsResources ( vtkRenderWindow win)

Member Data Documentation

◆ TrackedDevice

vr::TrackedDeviceIndex_t vtkOpenVRModel::TrackedDevice

Definition at line 73 of file vtkOpenVRModel.h.

◆ RawModel

vr::RenderModel_t* vtkOpenVRModel::RawModel

Definition at line 75 of file vtkOpenVRModel.h.

◆ ModelName

std::string vtkOpenVRModel::ModelName
protected

Definition at line 81 of file vtkOpenVRModel.h.

◆ Visibility

bool vtkOpenVRModel::Visibility
protected

Definition at line 83 of file vtkOpenVRModel.h.

◆ Loaded

bool vtkOpenVRModel::Loaded
protected

Definition at line 84 of file vtkOpenVRModel.h.

◆ FailedToLoad

bool vtkOpenVRModel::FailedToLoad
protected

Definition at line 85 of file vtkOpenVRModel.h.

◆ RawTexture

vr::RenderModel_TextureMap_t* vtkOpenVRModel::RawTexture
protected

Definition at line 87 of file vtkOpenVRModel.h.

◆ ModelHelper

vtkOpenGLHelper vtkOpenVRModel::ModelHelper
protected

Definition at line 88 of file vtkOpenVRModel.h.

◆ ModelVBO

vtkOpenGLVertexBufferObject* vtkOpenVRModel::ModelVBO
protected

Definition at line 89 of file vtkOpenVRModel.h.

◆ TextureObject

vtkNew<vtkTextureObject> vtkOpenVRModel::TextureObject
protected

Definition at line 90 of file vtkOpenVRModel.h.

◆ PoseMatrix

vtkNew<vtkMatrix4x4> vtkOpenVRModel::PoseMatrix
protected

Definition at line 91 of file vtkOpenVRModel.h.

◆ Ray

vtkNew<vtkOpenVRRay> vtkOpenVRModel::Ray
protected

Definition at line 94 of file vtkOpenVRModel.h.


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