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

OpenVR overlay. More...

#include <vtkOpenVROverlay.h>

Inheritance diagram for vtkOpenVROverlay:
[legend]
Collaboration diagram for vtkOpenVROverlay:
[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...
 
vtkOpenVROverlayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Render ()
 Render the overlay. More...
 
virtual void Create (vtkOpenVRRenderWindow *rw)
 Create the overlay. More...
 
vr::VROverlayHandle_t GetOverlayHandle ()
 Get handle to the overlay. More...
 
vtkTextureObjectGetOverlayTexture ()
 Get handle to the overlay texture. More...
 
virtual void MouseMoved (int x, int y)
 methods to support events on the overlay More...
 
virtual void MouseButtonPress (int x, int y)
 
virtual void MouseButtonRelease (int x, int y)
 
vtkOpenVROverlaySpotGetLastSpot ()
 
std::vector< vtkOpenVROverlaySpot > & GetSpots ()
 
virtual void UpdateSpot (vtkOpenVROverlaySpot *spot)
 
void SetSessionName (const std::string &name)
 Set/Get a prefix for saving camera poses. More...
 
std::string GetSessionName ()
 
void SetDashboardImageFileName (const std::string &name)
 Set/Get a file for the dashboard image. More...
 
std::string GetDashboardImageFileName ()
 
vtkOpenVRCameraPoseGetSavedCameraPose (int i)
 
virtual void SetSavedCameraPose (int i, vtkOpenVRCameraPose *)
 
virtual void WriteCameraPoses (ostream &os)
 
virtual void WriteCameraPoses ()
 
virtual void ReadCameraPoses ()
 
virtual void ReadCameraPoses (istream &is)
 
virtual void ReadCameraPoses (vtkXMLDataElement *xml)
 
virtual void SaveCameraPose (int num)
 
virtual void LoadCameraPose (int num)
 
virtual void LoadNextCameraPose ()
 
virtual std::map< int, vtkOpenVRCameraPose > & GetSavedCameraPoses ()
 
void Show ()
 
void Hide ()
 
- 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 vtkOpenVROverlayNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenVROverlaySafeDownCast (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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenVROverlay ()
 
 ~vtkOpenVROverlay ()
 
virtual void SetupSpots ()
 
virtual void SetDashboardImageData (vtkJPEGReader *rdr)
 
- 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

vr::IVRSystem * VRSystem
 
vr::VROverlayHandle_t OverlayHandle
 
vr::VROverlayHandle_t OverlayThumbnailHandle
 
vtkNew< vtkTextureObjectOverlayTexture
 
unsigned char * OriginalTextureData
 
unsigned char * CurrentTextureData
 
std::vector< vtkOpenVROverlaySpotSpots
 
vtkOpenVROverlaySpotLastSpot
 
std::string SessionName
 
std::string DashboardImageFileName
 
std::map< int, vtkOpenVRCameraPoseSavedCameraPoses
 
vtkWeakPointer< vtkOpenVRRenderWindowWindow
 
int LastCameraPoseIndex
 
double LastSpotIntensity
 
double ActiveSpotIntensity
 
- 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 overlay.

vtkOpenVROverlay support for VR overlays

Definition at line 40 of file vtkOpenVROverlay.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkOpenVROverlay.h.

Constructor & Destructor Documentation

◆ vtkOpenVROverlay()

vtkOpenVROverlay::vtkOpenVROverlay ( )
protected

◆ ~vtkOpenVROverlay()

vtkOpenVROverlay::~vtkOpenVROverlay ( )
protected

Member Function Documentation

◆ New()

static vtkOpenVROverlay* vtkOpenVROverlay::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenVROverlay::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkOpenVRDefaultOverlay.

◆ NewInstance()

vtkOpenVROverlay* vtkOpenVROverlay::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenVROverlay::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.

◆ Render()

virtual void vtkOpenVROverlay::Render ( )
virtual

Render the overlay.

Reimplemented in vtkOpenVRDefaultOverlay.

◆ Create()

virtual void vtkOpenVROverlay::Create ( vtkOpenVRRenderWindow rw)
virtual

Create the overlay.

◆ GetOverlayHandle()

vr::VROverlayHandle_t vtkOpenVROverlay::GetOverlayHandle ( )
inline

Get handle to the overlay.

Definition at line 60 of file vtkOpenVROverlay.h.

◆ GetOverlayTexture()

vtkTextureObject* vtkOpenVROverlay::GetOverlayTexture ( )
inline

Get handle to the overlay texture.

Definition at line 66 of file vtkOpenVROverlay.h.

◆ MouseMoved()

virtual void vtkOpenVROverlay::MouseMoved ( int  x,
int  y 
)
virtual

methods to support events on the overlay

◆ MouseButtonPress()

virtual void vtkOpenVROverlay::MouseButtonPress ( int  x,
int  y 
)
virtual

◆ MouseButtonRelease()

virtual void vtkOpenVROverlay::MouseButtonRelease ( int  x,
int  y 
)
virtual

◆ GetLastSpot()

vtkOpenVROverlaySpot* vtkOpenVROverlay::GetLastSpot ( )
inline

Definition at line 78 of file vtkOpenVROverlay.h.

◆ GetSpots()

std::vector<vtkOpenVROverlaySpot>& vtkOpenVROverlay::GetSpots ( )
inline

Definition at line 81 of file vtkOpenVROverlay.h.

◆ UpdateSpot()

virtual void vtkOpenVROverlay::UpdateSpot ( vtkOpenVROverlaySpot spot)
virtual

◆ SetSessionName()

void vtkOpenVROverlay::SetSessionName ( const std::string &  name)
inline

Set/Get a prefix for saving camera poses.

Definition at line 92 of file vtkOpenVROverlay.h.

◆ GetSessionName()

std::string vtkOpenVROverlay::GetSessionName ( )
inline

Definition at line 94 of file vtkOpenVROverlay.h.

◆ SetDashboardImageFileName()

void vtkOpenVROverlay::SetDashboardImageFileName ( const std::string &  name)
inline

Set/Get a file for the dashboard image.

Definition at line 102 of file vtkOpenVROverlay.h.

◆ GetDashboardImageFileName()

std::string vtkOpenVROverlay::GetDashboardImageFileName ( )
inline

Definition at line 104 of file vtkOpenVROverlay.h.

◆ GetSavedCameraPose()

vtkOpenVRCameraPose* vtkOpenVROverlay::GetSavedCameraPose ( int  i)

◆ SetSavedCameraPose()

virtual void vtkOpenVROverlay::SetSavedCameraPose ( int  i,
vtkOpenVRCameraPose  
)
virtual

◆ WriteCameraPoses() [1/2]

virtual void vtkOpenVROverlay::WriteCameraPoses ( ostream &  os)
virtual

◆ WriteCameraPoses() [2/2]

virtual void vtkOpenVROverlay::WriteCameraPoses ( )
virtual

◆ ReadCameraPoses() [1/3]

virtual void vtkOpenVROverlay::ReadCameraPoses ( )
virtual

◆ ReadCameraPoses() [2/3]

virtual void vtkOpenVROverlay::ReadCameraPoses ( istream &  is)
virtual

◆ ReadCameraPoses() [3/3]

virtual void vtkOpenVROverlay::ReadCameraPoses ( vtkXMLDataElement xml)
virtual

◆ SaveCameraPose()

virtual void vtkOpenVROverlay::SaveCameraPose ( int  num)
virtual

◆ LoadCameraPose()

virtual void vtkOpenVROverlay::LoadCameraPose ( int  num)
virtual

◆ LoadNextCameraPose()

virtual void vtkOpenVROverlay::LoadNextCameraPose ( )
virtual

◆ GetSavedCameraPoses()

virtual std::map<int, vtkOpenVRCameraPose>& vtkOpenVROverlay::GetSavedCameraPoses ( )
inlinevirtual

Definition at line 118 of file vtkOpenVROverlay.h.

◆ Show()

void vtkOpenVROverlay::Show ( )

◆ Hide()

void vtkOpenVROverlay::Hide ( )

◆ SetupSpots()

virtual void vtkOpenVROverlay::SetupSpots ( )
inlineprotectedvirtual

Reimplemented in vtkOpenVRDefaultOverlay.

Definition at line 129 of file vtkOpenVROverlay.h.

◆ SetDashboardImageData()

virtual void vtkOpenVROverlay::SetDashboardImageData ( vtkJPEGReader rdr)
protectedvirtual

Member Data Documentation

◆ VRSystem

vr::IVRSystem* vtkOpenVROverlay::VRSystem
protected

Definition at line 129 of file vtkOpenVROverlay.h.

◆ OverlayHandle

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayHandle
protected

Definition at line 134 of file vtkOpenVROverlay.h.

◆ OverlayThumbnailHandle

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayThumbnailHandle
protected

Definition at line 135 of file vtkOpenVROverlay.h.

◆ OverlayTexture

vtkNew<vtkTextureObject> vtkOpenVROverlay::OverlayTexture
protected

Definition at line 136 of file vtkOpenVROverlay.h.

◆ OriginalTextureData

unsigned char* vtkOpenVROverlay::OriginalTextureData
protected

Definition at line 141 of file vtkOpenVROverlay.h.

◆ CurrentTextureData

unsigned char* vtkOpenVROverlay::CurrentTextureData
protected

Definition at line 142 of file vtkOpenVROverlay.h.

◆ Spots

std::vector<vtkOpenVROverlaySpot> vtkOpenVROverlay::Spots
protected

Definition at line 144 of file vtkOpenVROverlay.h.

◆ LastSpot

vtkOpenVROverlaySpot* vtkOpenVROverlay::LastSpot
protected

Definition at line 145 of file vtkOpenVROverlay.h.

◆ SessionName

std::string vtkOpenVROverlay::SessionName
protected

Definition at line 147 of file vtkOpenVROverlay.h.

◆ DashboardImageFileName

std::string vtkOpenVROverlay::DashboardImageFileName
protected

Definition at line 148 of file vtkOpenVROverlay.h.

◆ SavedCameraPoses

std::map<int,vtkOpenVRCameraPose> vtkOpenVROverlay::SavedCameraPoses
protected

Definition at line 149 of file vtkOpenVROverlay.h.

◆ Window

vtkWeakPointer<vtkOpenVRRenderWindow> vtkOpenVROverlay::Window
protected

Definition at line 151 of file vtkOpenVROverlay.h.

◆ LastCameraPoseIndex

int vtkOpenVROverlay::LastCameraPoseIndex
protected

Definition at line 152 of file vtkOpenVROverlay.h.

◆ LastSpotIntensity

double vtkOpenVROverlay::LastSpotIntensity
protected

Definition at line 154 of file vtkOpenVROverlay.h.

◆ ActiveSpotIntensity

double vtkOpenVROverlay::ActiveSpotIntensity
protected

Definition at line 155 of file vtkOpenVROverlay.h.


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