Tooltip helper explaining controls Helper class to draw one tooltip per button around the controller. More...

#include <vtkVRControlsHelper.h>

Inheritance diagram for vtkVRControlsHelper:

Collaboration diagram for vtkVRControlsHelper:

Public Types
enum	ButtonSides { Back = -1 , Front = 1 }

enum	DrawSides { Left = -1 , Right = 1 }

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
void	SetTooltipInfo (const char s, int buttonSide, int drawSide, const char txt)

void	SetEnabled (bool enabled)

virtual bool	GetEnabled ()

virtual void	EnabledOn ()

virtual void	EnabledOff ()

void	SetDevice (vtkEventDataDevice val)

virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()


void	BuildRepresentation ()
	Methods to interface with the vtkVRPanelWidget.

void	UpdateRepresentation ()
	Methods to interface with the vtkVRPanelWidget.


void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting the rendering process.

int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting the rendering process.

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting the rendering process.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting the rendering process.


void	SetText (const std::string &str)
	Set Tooltip text (used by TextActor)

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

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

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Protected Member Functions
	vtkVRControlsHelper ()

	~vtkVRControlsHelper () override

virtual void	InitControlPosition ()=0
	Must be overridden in subclasses to init the member variable ControlPositionLC to position the tooltip on the component.

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp () override

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	MoveEvent (vtkObject object, unsigned long event, void clientdata, void *calldata)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
double	FrameSize [2]

vtkTextActor3D *	TextActor

std::string	Text

vtkLineSource *	LineSource

vtkPolyDataMapper *	LineMapper

vtkActor *	LineActor

vtkEventDataDevice	Device

std::string	ComponentName

int	DrawSide

int	ButtonSide

bool	Enabled

double	ControlPositionLC [3]

vtkWeakPointer< vtkRenderer >	Renderer

vtkCallbackCommand *	MoveCallbackCommand

unsigned long	ObserverTag

vtkNew< vtkTransform >	TempTransform

double	LastPhysicalTranslation [3]

double	LastEventPosition [3]

double	LastEventOrientation [4]

bool	NeedUpdate

bool	LabelVisible

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

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

typedef vtkProp	Superclass
	Standard methods for the class.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for the class.

static vtkVRControlsHelper *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for the class.

vtkVRControlsHelper *	NewInstance () const
	Standard methods for the class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for the class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for the class.

Additional Inherited Members
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Detailed Description

Tooltip helper explaining controls Helper class to draw one tooltip per button around the controller.

See also: vtkVRPanelRepresentation

Definition at line 31 of file vtkVRControlsHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp vtkVRControlsHelper::Superclass

Standard methods for the class.

Definition at line 38 of file vtkVRControlsHelper.h.

Member Enumeration Documentation

◆ ButtonSides

enum vtkVRControlsHelper::ButtonSides

Enumerator
Back
Front

Definition at line 42 of file vtkVRControlsHelper.h.

◆ DrawSides

enum vtkVRControlsHelper::DrawSides

Enumerator
Left
Right

Definition at line 48 of file vtkVRControlsHelper.h.

Constructor & Destructor Documentation

◆ vtkVRControlsHelper()

vtkVRControlsHelper::vtkVRControlsHelper ( )

protected

◆ ~vtkVRControlsHelper()

vtkVRControlsHelper::~vtkVRControlsHelper ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods for the class.

◆ IsA()

virtual vtkTypeBool vtkVRControlsHelper::IsA ( const char * type )

virtual

Standard methods for the class.

Reimplemented from vtkProp.

Reimplemented in vtkOpenVRControlsHelper, and vtkOpenXRControlsHelper.

◆ SafeDownCast()

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

static

Standard methods for the class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVRControlsHelper::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkProp.

Reimplemented in vtkOpenVRControlsHelper, and vtkOpenXRControlsHelper.

◆ NewInstance()

vtkVRControlsHelper * vtkVRControlsHelper::NewInstance ( ) const

Standard methods for the class.

◆ PrintSelf()

void vtkVRControlsHelper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for the class.

Reimplemented from vtkProp.

◆ BuildRepresentation()

void vtkVRControlsHelper::BuildRepresentation ( )

Methods to interface with the vtkVRPanelWidget.

◆ UpdateRepresentation()

void vtkVRControlsHelper::UpdateRepresentation ( )

Methods to interface with the vtkVRPanelWidget.

◆ ReleaseGraphicsResources()

void vtkVRControlsHelper::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkVRControlsHelper::RenderOpaqueGeometry ( vtkViewport * )

overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkVRControlsHelper::RenderTranslucentPolygonalGeometry ( vtkViewport * )

overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkVRControlsHelper::HasTranslucentPolygonalGeometry ( )

overridevirtual

Methods supporting the rendering process.

Reimplemented from vtkProp.

◆ SetText()

void vtkVRControlsHelper::SetText ( const std::string & str )

Set Tooltip text (used by TextActor)

◆ SetTooltipInfo()

void vtkVRControlsHelper::SetTooltipInfo	(	const char *	s,
		int	buttonSide,
		int	drawSide,
		const char *	txt
	)

inline

Definition at line 79 of file vtkVRControlsHelper.h.

◆ SetEnabled()

void vtkVRControlsHelper::SetEnabled ( bool enabled )

◆ GetEnabled()

virtual bool vtkVRControlsHelper::GetEnabled ( )

virtual

◆ EnabledOn()

virtual void vtkVRControlsHelper::EnabledOn ( )

virtual

◆ EnabledOff()

virtual void vtkVRControlsHelper::EnabledOff ( )

virtual

◆ SetDevice()

void vtkVRControlsHelper::SetDevice ( vtkEventDataDevice val )

◆ SetRenderer()

virtual void vtkVRControlsHelper::SetRenderer ( vtkRenderer * ren )

virtual

◆ GetRenderer()

virtual vtkRenderer * vtkVRControlsHelper::GetRenderer ( )

virtual

◆ MoveEvent()

static void vtkVRControlsHelper::MoveEvent	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

◆ InitControlPosition()

virtual void vtkVRControlsHelper::InitControlPosition ( )

protectedpure virtual

Must be overridden in subclasses to init the member variable ControlPositionLC to position the tooltip on the component.

Implemented in vtkOpenVRControlsHelper, and vtkOpenXRControlsHelper.

Member Data Documentation

◆ FrameSize

double vtkVRControlsHelper::FrameSize[2]

protected

Definition at line 104 of file vtkVRControlsHelper.h.

◆ TextActor

vtkTextActor3D* vtkVRControlsHelper::TextActor

protected

Definition at line 107 of file vtkVRControlsHelper.h.

◆ Text

std::string vtkVRControlsHelper::Text

protected

Definition at line 108 of file vtkVRControlsHelper.h.

◆ LineSource

vtkLineSource* vtkVRControlsHelper::LineSource

protected

Definition at line 111 of file vtkVRControlsHelper.h.

◆ LineMapper

vtkPolyDataMapper* vtkVRControlsHelper::LineMapper

protected

Definition at line 112 of file vtkVRControlsHelper.h.

◆ LineActor

vtkActor* vtkVRControlsHelper::LineActor

protected

Definition at line 113 of file vtkVRControlsHelper.h.

◆ Device

vtkEventDataDevice vtkVRControlsHelper::Device

protected

Definition at line 115 of file vtkVRControlsHelper.h.

◆ ComponentName

std::string vtkVRControlsHelper::ComponentName

protected

Definition at line 118 of file vtkVRControlsHelper.h.

◆ DrawSide

int vtkVRControlsHelper::DrawSide

protected

Definition at line 119 of file vtkVRControlsHelper.h.

◆ ButtonSide

int vtkVRControlsHelper::ButtonSide

protected

Definition at line 120 of file vtkVRControlsHelper.h.

◆ Enabled

bool vtkVRControlsHelper::Enabled

protected

Definition at line 122 of file vtkVRControlsHelper.h.

◆ ControlPositionLC

double vtkVRControlsHelper::ControlPositionLC[3]

protected

Definition at line 124 of file vtkVRControlsHelper.h.

◆ Renderer

vtkWeakPointer<vtkRenderer> vtkVRControlsHelper::Renderer

protected

Definition at line 127 of file vtkVRControlsHelper.h.

◆ MoveCallbackCommand

vtkCallbackCommand* vtkVRControlsHelper::MoveCallbackCommand

protected

Definition at line 129 of file vtkVRControlsHelper.h.

◆ ObserverTag

unsigned long vtkVRControlsHelper::ObserverTag

protected

Definition at line 130 of file vtkVRControlsHelper.h.

◆ TempTransform

vtkNew<vtkTransform> vtkVRControlsHelper::TempTransform

protected

Definition at line 139 of file vtkVRControlsHelper.h.

◆ LastPhysicalTranslation

double vtkVRControlsHelper::LastPhysicalTranslation[3]

protected

Definition at line 140 of file vtkVRControlsHelper.h.

◆ LastEventPosition

double vtkVRControlsHelper::LastEventPosition[3]

protected

Definition at line 141 of file vtkVRControlsHelper.h.

◆ LastEventOrientation

double vtkVRControlsHelper::LastEventOrientation[4]

protected

Definition at line 142 of file vtkVRControlsHelper.h.

◆ NeedUpdate

bool vtkVRControlsHelper::NeedUpdate

protected

Definition at line 143 of file vtkVRControlsHelper.h.

◆ LabelVisible

bool vtkVRControlsHelper::LabelVisible

protected

Definition at line 144 of file vtkVRControlsHelper.h.

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

Rendering/VR/vtkVRControlsHelper.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ButtonSides

◆ DrawSides

Constructor & Destructor Documentation

◆ vtkVRControlsHelper()

◆ ~vtkVRControlsHelper()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ BuildRepresentation()

◆ UpdateRepresentation()

◆ ReleaseGraphicsResources()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ SetText()

◆ SetTooltipInfo()

◆ SetEnabled()

◆ GetEnabled()

◆ EnabledOn()

◆ EnabledOff()

◆ SetDevice()

◆ SetRenderer()

◆ GetRenderer()

◆ MoveEvent()

◆ InitControlPosition()

Member Data Documentation

◆ FrameSize

◆ TextActor

◆ Text

◆ LineSource

◆ LineMapper

◆ LineActor

◆ Device

◆ ComponentName

◆ DrawSide

◆ ButtonSide

◆ Enabled

◆ ControlPositionLC

◆ Renderer

◆ MoveCallbackCommand

◆ ObserverTag

◆ TempTransform

◆ LastPhysicalTranslation

◆ LastEventPosition

◆ LastEventOrientation

◆ NeedUpdate

◆ LabelVisible