OpenVR overlay. More...

#include <vtkOpenVROverlay.h>

Inheritance diagram for vtkOpenVROverlay:

Collaboration diagram for vtkOpenVROverlay:

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

vtkOpenVROverlay *	NewInstance () 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...

vtkTextureObject *	GetOverlayTexture ()
	Get handle to the overlay texture. More...

vtkOpenVROverlaySpot *	GetLastSpot ()

std::vector< vtkOpenVROverlaySpot > &	GetSpots ()

virtual void	UpdateSpot (vtkOpenVROverlaySpot *spot)

vtkOpenVRCameraPose *	GetSavedCameraPose (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 ()


virtual void	MouseMoved (int x, int y)
	methods to support events on the overlay More...

virtual void	MouseButtonPress (int x, int y)
	methods to support events on the overlay More...

virtual void	MouseButtonRelease (int x, int y)
	methods to support events on the overlay More...


void	SetSessionName (const std::string &name)
	Set/Get a prefix for saving camera poses. More...

std::string	GetSessionName ()
	Set/Get a prefix for saving camera poses. More...


void	SetDashboardImageFileName (VTK_FILEPATH const std::string &name)
	Set/Get a file for the dashboard image. More...

VTK_FILEPATH std::string	GetDashboardImageFileName ()
	Set/Get a file for the dashboard image. More...

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

vtkCommand *	GetCommand (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 vtkOpenVROverlay *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenVROverlay *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenVROverlay ()

	~vtkOpenVROverlay () override

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 ()
	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::IVRSystem *	VRSystem

vr::VROverlayHandle_t	OverlayHandle

vr::VROverlayHandle_t	OverlayThumbnailHandle

vtkNew< vtkTextureObject >	OverlayTexture

unsigned char *	OriginalTextureData

unsigned char *	CurrentTextureData

std::vector< vtkOpenVROverlaySpot >	Spots

vtkOpenVROverlaySpot *	LastSpot

std::string	SessionName

std::string	DashboardImageFileName

std::map< int, vtkOpenVRCameraPose >	SavedCameraPoses

vtkWeakPointer< vtkOpenVRRenderWindow >	Window

int	LastCameraPoseIndex

double	LastSpotIntensity

double	ActiveSpotIntensity

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

vtkOpenVROverlay support for VR overlays

Events:: vtkCommand::LoadStateEvent vtkCommand::SaveStateEvent

Definition at line 33 of file vtkOpenVROverlay.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOpenVROverlay::Superclass

Definition at line 37 of file vtkOpenVROverlay.h.

Constructor & Destructor Documentation

◆ vtkOpenVROverlay()

vtkOpenVROverlay::vtkOpenVROverlay ( )

protected

◆ ~vtkOpenVROverlay()

vtkOpenVROverlay::~vtkOpenVROverlay ( )

overrideprotected

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 53 of file vtkOpenVROverlay.h.

◆ GetOverlayTexture()

vtkTextureObject* vtkOpenVROverlay::GetOverlayTexture ( )

inline

Get handle to the overlay texture.

Definition at line 58 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

methods to support events on the overlay

◆ MouseButtonRelease()

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

virtual

methods to support events on the overlay

◆ GetLastSpot()

vtkOpenVROverlaySpot* vtkOpenVROverlay::GetLastSpot ( )

inline

Definition at line 69 of file vtkOpenVROverlay.h.

◆ GetSpots()

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

inline

Definition at line 71 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 82 of file vtkOpenVROverlay.h.

◆ GetSessionName()

std::string vtkOpenVROverlay::GetSessionName ( )

inline

Set/Get a prefix for saving camera poses.

Definition at line 83 of file vtkOpenVROverlay.h.

◆ SetDashboardImageFileName()

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

inline

Set/Get a file for the dashboard image.

Definition at line 90 of file vtkOpenVROverlay.h.

◆ GetDashboardImageFileName()

VTK_FILEPATH std::string vtkOpenVROverlay::GetDashboardImageFileName ( )

inline

Set/Get a file for the dashboard image.

Definition at line 94 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 107 of file vtkOpenVROverlay.h.

◆ Show()

void vtkOpenVROverlay::Show ( )

◆ Hide()

void vtkOpenVROverlay::Hide ( )

◆ SetupSpots()

virtual void vtkOpenVROverlay::SetupSpots ( )

inlineprotectedvirtual

Reimplemented in vtkOpenVRDefaultOverlay.

Definition at line 120 of file vtkOpenVROverlay.h.

◆ SetDashboardImageData()

virtual void vtkOpenVROverlay::SetDashboardImageData ( vtkJPEGReader * rdr )

protectedvirtual

Member Data Documentation

◆ VRSystem

vr::IVRSystem* vtkOpenVROverlay::VRSystem

protected

Definition at line 122 of file vtkOpenVROverlay.h.

◆ OverlayHandle

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayHandle

protected

Definition at line 125 of file vtkOpenVROverlay.h.

◆ OverlayThumbnailHandle

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayThumbnailHandle

protected

Definition at line 126 of file vtkOpenVROverlay.h.

◆ OverlayTexture

vtkNew<vtkTextureObject> vtkOpenVROverlay::OverlayTexture

protected

Definition at line 127 of file vtkOpenVROverlay.h.

◆ OriginalTextureData

unsigned char* vtkOpenVROverlay::OriginalTextureData

protected

Definition at line 132 of file vtkOpenVROverlay.h.

◆ CurrentTextureData

unsigned char* vtkOpenVROverlay::CurrentTextureData

protected

Definition at line 133 of file vtkOpenVROverlay.h.

◆ Spots

std::vector<vtkOpenVROverlaySpot> vtkOpenVROverlay::Spots

protected

Definition at line 135 of file vtkOpenVROverlay.h.

◆ LastSpot

vtkOpenVROverlaySpot* vtkOpenVROverlay::LastSpot

protected

Definition at line 136 of file vtkOpenVROverlay.h.

◆ SessionName

std::string vtkOpenVROverlay::SessionName

protected

Definition at line 138 of file vtkOpenVROverlay.h.

◆ DashboardImageFileName

std::string vtkOpenVROverlay::DashboardImageFileName

protected

Definition at line 139 of file vtkOpenVROverlay.h.

◆ SavedCameraPoses

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

protected

Definition at line 140 of file vtkOpenVROverlay.h.

◆ Window

vtkWeakPointer<vtkOpenVRRenderWindow> vtkOpenVROverlay::Window

protected

Definition at line 142 of file vtkOpenVROverlay.h.

◆ LastCameraPoseIndex

int vtkOpenVROverlay::LastCameraPoseIndex

protected

Definition at line 143 of file vtkOpenVROverlay.h.

◆ LastSpotIntensity

double vtkOpenVROverlay::LastSpotIntensity

protected

Definition at line 145 of file vtkOpenVROverlay.h.

◆ ActiveSpotIntensity

double vtkOpenVROverlay::ActiveSpotIntensity

protected

Definition at line 146 of file vtkOpenVROverlay.h.

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

Rendering/OpenVR/vtkOpenVROverlay.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenVROverlay()

◆ ~vtkOpenVROverlay()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Render()

◆ Create()

◆ GetOverlayHandle()

◆ GetOverlayTexture()

◆ MouseMoved()

◆ MouseButtonPress()

◆ MouseButtonRelease()

◆ GetLastSpot()

◆ GetSpots()

◆ UpdateSpot()

◆ SetSessionName()

◆ GetSessionName()

◆ SetDashboardImageFileName()

◆ GetDashboardImageFileName()

◆ GetSavedCameraPose()

◆ SetSavedCameraPose()

◆ WriteCameraPoses() [1/2]

◆ WriteCameraPoses() [2/2]

◆ ReadCameraPoses() [1/3]

◆ ReadCameraPoses() [2/3]

◆ ReadCameraPoses() [3/3]

◆ SaveCameraPose()

◆ LoadCameraPose()

◆ LoadNextCameraPose()

◆ GetSavedCameraPoses()

◆ Show()

◆ Hide()

◆ SetupSpots()

◆ SetDashboardImageData()

Member Data Documentation

◆ VRSystem

◆ OverlayHandle

◆ OverlayThumbnailHandle

◆ OverlayTexture

◆ OriginalTextureData

◆ CurrentTextureData

◆ Spots

◆ LastSpot

◆ SessionName

◆ DashboardImageFileName

◆ SavedCameraPoses

◆ Window

◆ LastCameraPoseIndex

◆ LastSpotIntensity

◆ ActiveSpotIntensity