OpenVR overlay. More...

#include <vtkOpenVRDefaultOverlay.h>

Inheritance diagram for vtkOpenVRDefaultOverlay:

Collaboration diagram for vtkOpenVRDefaultOverlay:

Public Types
typedef vtkOpenVROverlay	Superclass

Public Types inherited from vtkOpenVROverlay
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...

vtkOpenVRDefaultOverlay *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Render () override
	Render the overlay, we set some opf the spots based on current settings. More...

Public Member Functions inherited from vtkOpenVROverlay
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	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 vtkOpenVRDefaultOverlay *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenVRDefaultOverlay *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenVROverlay
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

	vtkOpenVRDefaultOverlay ()

	~vtkOpenVRDefaultOverlay ()

void	SetupSpots () override

Protected Member Functions inherited from vtkOpenVROverlay
	vtkOpenVROverlay ()

	~vtkOpenVROverlay ()

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

Additional Inherited Members
Protected Attributes inherited from vtkOpenVROverlay
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.

vtkOpenVRDefaultOverlay support for VR overlays

Definition at line 27 of file vtkOpenVRDefaultOverlay.h.

Member Typedef Documentation

typedef vtkOpenVROverlay vtkOpenVRDefaultOverlay::Superclass

Definition at line 31 of file vtkOpenVRDefaultOverlay.h.

Constructor & Destructor Documentation

vtkOpenVRDefaultOverlay::vtkOpenVRDefaultOverlay ( )

protected

vtkOpenVRDefaultOverlay::~vtkOpenVRDefaultOverlay ( )

protected

Member Function Documentation

static vtkOpenVRDefaultOverlay* vtkOpenVRDefaultOverlay::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkOpenVRDefaultOverlay::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenVROverlay.

vtkOpenVRDefaultOverlay* vtkOpenVRDefaultOverlay::NewInstance ( ) const

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

void vtkOpenVRDefaultOverlay::Render ( )

overridevirtual

Render the overlay, we set some opf the spots based on current settings.

Reimplemented from vtkOpenVROverlay.

void vtkOpenVRDefaultOverlay::SetupSpots ( )

overrideprotectedvirtual

Reimplemented from vtkOpenVROverlay.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation