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	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 (const std::string &name)
	Set/Get a file for the dashboard image. More...

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)

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

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

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

void	PrintRevisions (ostream &)
	Legacy. 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 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 (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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenVROverlay ()

	~vtkOpenVROverlay ()

virtual void	SetupSpots ()

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

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

OpenVR overlay.

vtkOpenVROverlay support for VR overlays

Definition at line 39 of file vtkOpenVROverlay.h.

Member Typedef Documentation

typedef vtkObject vtkOpenVROverlay::Superclass

Definition at line 43 of file vtkOpenVROverlay.h.

Constructor & Destructor Documentation

vtkOpenVROverlay::vtkOpenVROverlay ( )

protected

vtkOpenVROverlay::~vtkOpenVROverlay ( )

protected

Member Function Documentation

static vtkOpenVROverlay* vtkOpenVROverlay::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkOpenVROverlay::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenVRDefaultOverlay.

vtkOpenVROverlay* vtkOpenVROverlay::NewInstance ( ) const

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.

virtual void vtkOpenVROverlay::Render ( )

virtual

Render the overlay.

Reimplemented in vtkOpenVRDefaultOverlay.

virtual void vtkOpenVROverlay::Create ( vtkOpenVRRenderWindow * rw )

virtual

Create the overlay.

vr::VROverlayHandle_t vtkOpenVROverlay::GetOverlayHandle ( )

inline

Get handle to the overlay.

Definition at line 59 of file vtkOpenVROverlay.h.

vtkTextureObject* vtkOpenVROverlay::GetOverlayTexture ( )

inline

Get handle to the overlay texture.

Definition at line 65 of file vtkOpenVROverlay.h.

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

virtual

methods to support events on the overlay

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

virtual

methods to support events on the overlay

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

virtual

methods to support events on the overlay

vtkOpenVROverlaySpot* vtkOpenVROverlay::GetLastSpot ( )

inline

Definition at line 77 of file vtkOpenVROverlay.h.

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

inline

Definition at line 80 of file vtkOpenVROverlay.h.

virtual void vtkOpenVROverlay::UpdateSpot ( vtkOpenVROverlaySpot * spot )

virtual

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

inline

Set/Get a prefix for saving camera poses.

Definition at line 92 of file vtkOpenVROverlay.h.

std::string vtkOpenVROverlay::GetSessionName ( )

inline

Set/Get a prefix for saving camera poses.

Definition at line 94 of file vtkOpenVROverlay.h.

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

inline

Set/Get a file for the dashboard image.

Definition at line 102 of file vtkOpenVROverlay.h.

std::string vtkOpenVROverlay::GetDashboardImageFileName ( )

inline

Set/Get a file for the dashboard image.

Definition at line 104 of file vtkOpenVROverlay.h.

vtkOpenVRCameraPose* vtkOpenVROverlay::GetSavedCameraPose ( int i )

virtual void vtkOpenVROverlay::WriteCameraPoses ( ostream & os )

virtual

virtual void vtkOpenVROverlay::WriteCameraPoses ( )

virtual

virtual void vtkOpenVROverlay::ReadCameraPoses ( )

virtual

virtual void vtkOpenVROverlay::ReadCameraPoses ( istream & is )

virtual

virtual void vtkOpenVROverlay::ReadCameraPoses ( vtkXMLDataElement * xml )

virtual

virtual void vtkOpenVROverlay::SaveCameraPose ( int num )

virtual

virtual void vtkOpenVROverlay::LoadCameraPose ( int num )

virtual

virtual void vtkOpenVROverlay::LoadNextCameraPose ( )

virtual

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

inlinevirtual

Definition at line 117 of file vtkOpenVROverlay.h.

void vtkOpenVROverlay::Show ( )

void vtkOpenVROverlay::Hide ( )

virtual void vtkOpenVROverlay::SetupSpots ( )

inlineprotectedvirtual

Reimplemented in vtkOpenVRDefaultOverlay.

Definition at line 128 of file vtkOpenVROverlay.h.

Member Data Documentation

vr::IVRSystem* vtkOpenVROverlay::VRSystem

protected

Definition at line 128 of file vtkOpenVROverlay.h.

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayHandle

protected

Definition at line 133 of file vtkOpenVROverlay.h.

vr::VROverlayHandle_t vtkOpenVROverlay::OverlayThumbnailHandle

protected

Definition at line 134 of file vtkOpenVROverlay.h.

vtkNew<vtkTextureObject> vtkOpenVROverlay::OverlayTexture

protected

Definition at line 135 of file vtkOpenVROverlay.h.

unsigned char* vtkOpenVROverlay::OriginalTextureData

protected

Definition at line 138 of file vtkOpenVROverlay.h.

unsigned char* vtkOpenVROverlay::CurrentTextureData

protected

Definition at line 139 of file vtkOpenVROverlay.h.

std::vector<vtkOpenVROverlaySpot> vtkOpenVROverlay::Spots

protected

Definition at line 141 of file vtkOpenVROverlay.h.

vtkOpenVROverlaySpot* vtkOpenVROverlay::LastSpot

protected

Definition at line 142 of file vtkOpenVROverlay.h.

std::string vtkOpenVROverlay::SessionName

protected

Definition at line 144 of file vtkOpenVROverlay.h.

std::string vtkOpenVROverlay::DashboardImageFileName

protected

Definition at line 145 of file vtkOpenVROverlay.h.

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

protected

Definition at line 146 of file vtkOpenVROverlay.h.

vtkWeakPointer<vtkOpenVRRenderWindow> vtkOpenVROverlay::Window

protected

Definition at line 148 of file vtkOpenVROverlay.h.

int vtkOpenVROverlay::LastCameraPoseIndex

protected

Definition at line 149 of file vtkOpenVROverlay.h.

double vtkOpenVROverlay::LastSpotIntensity

protected

Definition at line 151 of file vtkOpenVROverlay.h.

double vtkOpenVROverlay::ActiveSpotIntensity

protected

Definition at line 152 of file vtkOpenVROverlay.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenVR/vtkOpenVROverlay.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation