VTK  9.1.20211027
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkVRModel Class Referenceabstract

VR device model. More...

#include <vtkVRModel.h>

Inheritance diagram for vtkVRModel:
[legend]
Collaboration diagram for vtkVRModel:
[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...
 
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, const float poseInTrackingCoordinates[][4])
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
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)
 This method invokes an event and return whether the event was aborted or not. 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...
 
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...
 
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...
 

Static Public Member Functions

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 (int 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 int 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

vtkEventDataDevice TrackedDevice = vtkEventDataDevice::Unknown
 

Protected Member Functions

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

std::string ModelName
 
bool Visibility
 
bool Loaded
 
bool FailedToLoad
 
vtkOpenGLHelper ModelHelper
 
vtkOpenGLVertexBufferObjectModelVBO
 
vtkNew< vtkTextureObjectTextureObject
 
vtkNew< vtkMatrix4x4PoseMatrix
 
vtkNew< vtkVRRayRay
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

VR device model.

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

Definition at line 40 of file vtkVRModel.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkVRModel.h.

Constructor & Destructor Documentation

◆ vtkVRModel()

vtkVRModel::vtkVRModel ( )
protected

◆ ~vtkVRModel()

vtkVRModel::~vtkVRModel ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkOpenVRModel.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVRModel::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkOpenVRModel.

◆ NewInstance()

vtkVRModel* vtkVRModel::NewInstance ( ) const

◆ PrintSelf()

void vtkVRModel::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 vtkVRModel::Build ( vtkOpenGLRenderWindow win)

◆ Render()

void vtkVRModel::Render ( vtkOpenGLRenderWindow win,
const float  poseInTrackingCoordinates[][4] 
)

◆ GetName()

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

Definition at line 50 of file vtkVRModel.h.

◆ SetName()

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

Definition at line 51 of file vtkVRModel.h.

◆ SetVisibility()

void vtkVRModel::SetVisibility ( bool  v)
inline

Definition at line 54 of file vtkVRModel.h.

◆ GetVisibility()

bool vtkVRModel::GetVisibility ( )
inline

Definition at line 55 of file vtkVRModel.h.

◆ SetShowRay()

void vtkVRModel::SetShowRay ( bool  v)

◆ SetRayLength()

void vtkVRModel::SetRayLength ( double  length)

◆ SetRayColor()

void vtkVRModel::SetRayColor ( double  r,
double  g,
double  b 
)

◆ GetRay()

vtkVRRay* vtkVRModel::GetRay ( )
inline

Definition at line 61 of file vtkVRModel.h.

◆ ReleaseGraphicsResources()

void vtkVRModel::ReleaseGraphicsResources ( vtkWindow win)

◆ FillModelHelper()

virtual void vtkVRModel::FillModelHelper ( )
protectedpure virtual

Implemented in vtkOpenVRModel.

◆ SetPositionAndTCoords()

virtual void vtkVRModel::SetPositionAndTCoords ( )
protectedpure virtual

Implemented in vtkOpenVRModel.

◆ CreateTextureObject()

virtual void vtkVRModel::CreateTextureObject ( vtkOpenGLRenderWindow win)
protectedpure virtual

Implemented in vtkOpenVRModel.

◆ LoadModelAndTexture()

virtual void vtkVRModel::LoadModelAndTexture ( vtkOpenGLRenderWindow win)
protectedpure virtual

Implemented in vtkOpenVRModel.

Member Data Documentation

◆ TrackedDevice

vtkEventDataDevice vtkVRModel::TrackedDevice = vtkEventDataDevice::Unknown

Definition at line 66 of file vtkVRModel.h.

◆ ModelName

std::string vtkVRModel::ModelName
protected

Definition at line 77 of file vtkVRModel.h.

◆ Visibility

bool vtkVRModel::Visibility
protected

Definition at line 79 of file vtkVRModel.h.

◆ Loaded

bool vtkVRModel::Loaded
protected

Definition at line 80 of file vtkVRModel.h.

◆ FailedToLoad

bool vtkVRModel::FailedToLoad
protected

Definition at line 81 of file vtkVRModel.h.

◆ ModelHelper

vtkOpenGLHelper vtkVRModel::ModelHelper
protected

Definition at line 83 of file vtkVRModel.h.

◆ ModelVBO

vtkOpenGLVertexBufferObject* vtkVRModel::ModelVBO
protected

Definition at line 84 of file vtkVRModel.h.

◆ TextureObject

vtkNew<vtkTextureObject> vtkVRModel::TextureObject
protected

Definition at line 85 of file vtkVRModel.h.

◆ PoseMatrix

vtkNew<vtkMatrix4x4> vtkVRModel::PoseMatrix
protected

Definition at line 86 of file vtkVRModel.h.

◆ Ray

vtkNew<vtkVRRay> vtkVRModel::Ray
protected

Definition at line 89 of file vtkVRModel.h.


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