Extended from vtkInteractorStyle3D to override command methods. More...

#include <vtkVRInteractorStyle.h>

Inheritance diagram for vtkVRInteractorStyle:

Collaboration diagram for vtkVRInteractorStyle:

Public Types
enum	MovementStyle { FLY_STYLE , GROUNDED_STYLE }

typedef vtkInteractorStyle3D	Superclass

Public Types inherited from vtkInteractorStyle3D
typedef vtkInteractorStyle	Superclass

Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass

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

vtkVRInteractorStyle *	NewInstance () const

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

void	GroundMovement3D (vtkEventDataDevice3D *)
	Move the camera on the "XY" plan (ground) using the thumbstick/trackpad position (up/down and left/right), according to the headset view direction.

void	Elevation3D (vtkEventDataDevice3D *)
	Move the camera following the "Z" axis (elevation) using the thumbstick/trackpad position (up/down).

void	Teleportation3D (vtkEventDataDevice3D *edd)
	Instant movement to the picked point.

void	AddTooltipForInput (vtkEventDataDevice device, vtkEventDataDeviceInput input, const std::string &text={})
	Define the helper text that goes with an input.

virtual vtkVRControlsHelper *	MakeControlsHelper ()=0
	Creates a new ControlsHelper suitable for use with the child class.

int	GetInteractionState (vtkEventDataDevice device)
	Return interaction state for the specified device (dolly, pick, none, etc...).

void	SetInteractionState (vtkEventDataDevice device, int state)
	Set interaction state for the specified device (dolly, pick, none, etc...).

void	ShowPickSphere (double pos, double radius, vtkProp3D )
	Make the pick actor a sphere of given radius centered at given position, and show it.

void	ShowPickCell (vtkCell cell, vtkProp3D )
	Make the pick actor a polydata built from the points and edges of the given cell, and show it.

void	HidePickActor ()
	Hide the pick actor (sphere or polydata).

void	SetInteractor (vtkRenderWindowInteractor *iren) override
	Set the Interactor wrapper being controlled by this object.

virtual void	SetupActions (vtkRenderWindowInteractor *iren)=0
	Setup default actions defined with an action path and a corresponding command.

vtkVRMenuWidget *	GetMenu ()
	Return the menu to allow the user to add options to it.


void	OnSelect3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.

void	OnNextPose3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.

void	OnViewerMovement3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.

void	OnMove3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.

void	OnMenu3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.

void	OnElevation3D (vtkEventData *edata) override
	Override generic event bindings to call the corresponding action.


virtual void	StartPick (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	EndPick (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	StartLoadCamPose (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	EndLoadCamPose (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	StartPositionProp (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	EndPositionProp (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	StartClip (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	EndClip (vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	StartMovement3D (int interactionState, vtkEventDataDevice3D *)
	Interaction mode entry points.

virtual void	EndMovement3D (vtkEventDataDevice3D *)
	Interaction mode entry points.


void	OnPan () override
	Complex gesture events binding.

void	OnPinch () override
	Complex gesture events binding.

void	OnRotate () override
	Complex gesture events binding.


void	ProbeData (vtkEventDataDevice controller)
	Methods for interaction.

void	PositionProp (vtkEventData , double lwpos=nullptr, double *lwori=nullptr) override
	Methods for interaction.

void	Clip (vtkEventDataDevice3D *)
	Methods for interaction.

virtual void	LoadNextCameraPose ()=0
	Methods for interaction.


void	MapInputToAction (vtkCommand::EventIds eid, int state)
	Map controller inputs to actions.

void	MapInputToAction (vtkCommand::EventIds eid, vtkEventDataAction action, int state)
	Map controller inputs to actions.

int	GetMappedAction (vtkCommand::EventIds eid, vtkEventDataAction action=vtkEventDataAction::Press)
	Map controller inputs to actions.


virtual void	SetHoverPick (bool)
	Indicates if picking should be updated every frame.

virtual bool	GetHoverPick ()
	Indicates if picking should be updated every frame.

virtual void	HoverPickOn ()
	Indicates if picking should be updated every frame.

virtual void	HoverPickOff ()
	Indicates if picking should be updated every frame.


virtual void	SetGrabWithRay (bool)
	Specify if the grab mode uses the ray to grab distant objects.

virtual bool	GetGrabWithRay ()
	Specify if the grab mode uses the ray to grab distant objects.

virtual void	GrabWithRayOn ()
	Specify if the grab mode uses the ray to grab distant objects.

virtual void	GrabWithRayOff ()
	Specify if the grab mode uses the ray to grab distant objects.


virtual void	SetStyle (MovementStyle)
	Specify the movement style between 'Flying" and "Grounded".

virtual MovementStyle	GetStyle ()
	Specify the movement style between 'Flying" and "Grounded".


void	ShowRay (vtkEventDataDevice controller)
	Show/hide the ray for the specified controller.

void	HideRay (vtkEventDataDevice controller)
	Show/hide the ray for the specified controller.


void	ShowBillboard (const std::string &text)
	Show/hide billboard with given text string.

void	HideBillboard ()
	Show/hide billboard with given text string.


void	ToggleDrawControls ()
	Control visibility of descriptive tooltips for controller/HMD models.

void	SetDrawControls (bool)
	Control visibility of descriptive tooltips for controller/HMD models.

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

vtkInteractorStyle3D *	NewInstance () const

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

virtual void	PositionProp (vtkEventData , double lwpos=nullptr, double *lwori=nullptr)

virtual void	Dolly3D (vtkEventData *)

virtual void	SetScale (vtkCamera *cam, double newScale)
	Set the scaling factor from world to physical space.

virtual void	SetDollyPhysicalSpeed (double)
	Set/Get the maximum dolly speed used when flying in 3D, in meters per second.

virtual double	GetDollyPhysicalSpeed ()
	Set/Get the maximum dolly speed used when flying in 3D, in meters per second.

virtual vtkAbstractPropPicker *	GetInteractionPicker ()
	Get/Set the interaction picker.

void	SetInteractionPicker (vtkAbstractPropPicker *prop)
	Get/Set the interaction picker.

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

vtkInteractorStyle *	NewInstance () const

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

void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	Set/Get the Interactor wrapper being controlled by this object.

void	SetEnabled (int) override
	Turn on/off this interactor.

void	FindPokedRenderer (int, int)
	When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers.

virtual void	OnMouseMove ()
	Generic event bindings can be overridden in subclasses.

virtual void	OnLeftButtonDown ()

virtual void	OnLeftButtonUp ()

virtual void	OnMiddleButtonDown ()

virtual void	OnMiddleButtonUp ()

virtual void	OnRightButtonDown ()

virtual void	OnRightButtonUp ()

virtual void	OnLeftButtonDoubleClick ()

virtual void	OnMiddleButtonDoubleClick ()

virtual void	OnRightButtonDoubleClick ()

virtual void	OnMouseWheelForward ()

virtual void	OnMouseWheelBackward ()

virtual void	OnMouseWheelLeft ()

virtual void	OnMouseWheelRight ()

virtual void	OnFourthButtonDown ()

virtual void	OnFourthButtonUp ()

virtual void	OnFifthButtonDown ()

virtual void	OnFifthButtonUp ()

virtual void	OnMove3D (vtkEventData *)
	Generic 3D event bindings can be overridden in subclasses.

virtual void	OnButton3D (vtkEventData *)

virtual void	OnPick3D (vtkEventData *)

virtual void	OnClip3D (vtkEventData *)

virtual void	OnSelect3D (vtkEventData *)

virtual void	OnMenu3D (vtkEventData *)

virtual void	OnNextPose3D (vtkEventData *)

virtual void	OnPositionProp3D (vtkEventData *)

virtual void	OnViewerMovement3D (vtkEventData *)

virtual void	OnElevation3D (vtkEventData *)

void	OnChar () override
	OnChar is triggered when an ASCII key is pressed.

virtual void	OnKeyDown ()

virtual void	OnKeyUp ()

virtual void	OnKeyPress ()

virtual void	OnKeyRelease ()

virtual void	OnExpose ()
	These are more esoteric events, but are useful in some cases.

virtual void	OnConfigure ()

virtual void	OnEnter ()

virtual void	OnLeave ()

virtual void	OnTimer ()
	OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses.

virtual void	Rotate ()
	These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion.

virtual void	Spin ()

virtual void	Pan ()

virtual void	Dolly ()

virtual void	Zoom ()

virtual void	UniformScale ()

virtual void	EnvironmentRotate ()

virtual void	OnStartSwipe ()
	gesture based events

virtual void	OnSwipe ()

virtual void	OnEndSwipe ()

virtual void	OnStartPinch ()

virtual void	OnPinch ()

virtual void	OnEndPinch ()

virtual void	OnStartRotate ()

virtual void	OnRotate ()

virtual void	OnEndRotate ()

virtual void	OnStartPan ()

virtual void	OnPan ()

virtual void	OnEndPan ()

virtual void	OnTap ()

virtual void	OnLongTap ()

virtual void	OnDropLocation (double *vtkNotUsed(position))
	When the mouse location is updated while dragging files.

virtual void	OnDropFiles (vtkStringArray *vtkNotUsed(filePaths))
	When files are dropped on the render window.

void	DelegateTDxEvent (unsigned long event, void *calldata)
	Called by the callback to process 3DConnexion device events.

virtual void	SetAutoAdjustCameraClippingRange (vtkTypeBool)
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual vtkTypeBool	GetAutoAdjustCameraClippingRange ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOn ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOff ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual int	GetState ()
	Some useful information for interaction.

virtual vtkTypeBool	GetUseTimers ()
	Set/Get timer hint.

virtual void	SetUseTimers (vtkTypeBool)
	Set/Get timer hint.

virtual void	UseTimersOn ()
	Set/Get timer hint.

virtual void	UseTimersOff ()
	Set/Get timer hint.

virtual void	SetTimerDuration (unsigned long)
	If using timers, specify the default timer interval (in milliseconds).

virtual unsigned long	GetTimerDuration ()
	If using timers, specify the default timer interval (in milliseconds).

virtual void	SetHandleObservers (vtkTypeBool)
	Does ProcessEvents handle observers on this class or not.

virtual vtkTypeBool	GetHandleObservers ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOn ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOff ()
	Does ProcessEvents handle observers on this class or not.

virtual void	StartState (int newstate)
	utility routines used by state changes

virtual void	StopState ()
	utility routines used by state changes

virtual void	StartAnimate ()
	Interaction mode entry points used internally.

virtual void	StopAnimate ()
	Interaction mode entry points used internally.

virtual void	StartRotate ()
	Interaction mode entry points used internally.

virtual void	EndRotate ()
	Interaction mode entry points used internally.

virtual void	StartZoom ()
	Interaction mode entry points used internally.

virtual void	EndZoom ()
	Interaction mode entry points used internally.

virtual void	StartPan ()
	Interaction mode entry points used internally.

virtual void	EndPan ()
	Interaction mode entry points used internally.

virtual void	StartSpin ()
	Interaction mode entry points used internally.

virtual void	EndSpin ()
	Interaction mode entry points used internally.

virtual void	StartDolly ()
	Interaction mode entry points used internally.

virtual void	EndDolly ()
	Interaction mode entry points used internally.

virtual void	StartUniformScale ()
	Interaction mode entry points used internally.

virtual void	EndUniformScale ()
	Interaction mode entry points used internally.

virtual void	StartTimer ()
	Interaction mode entry points used internally.

virtual void	EndTimer ()
	Interaction mode entry points used internally.

virtual void	StartTwoPointer ()
	Interaction mode entry points used internally.

virtual void	EndTwoPointer ()
	Interaction mode entry points used internally.

virtual void	StartGesture ()
	Interaction mode entry points used internally.

virtual void	EndGesture ()
	Interaction mode entry points used internally.

virtual void	StartEnvRotate ()
	Interaction mode entry points used internally.

virtual void	EndEnvRotate ()
	Interaction mode entry points used internally.

virtual void	HighlightProp (vtkProp *prop)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightActor2D (vtkActor2D *actor2D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightProp3D (vtkProp3D *prop3D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	SetPickColor (double, double, double)
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetPickColor (double[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual double *	GetPickColor ()
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	GetPickColor (double data[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetMouseWheelMotionFactor (double)
	Set/Get the mouse wheel motion factor.

virtual double	GetMouseWheelMotionFactor ()
	Set/Get the mouse wheel motion factor.

virtual vtkTDxInteractorStyle *	GetTDxStyle ()
	3Dconnexion device interactor style.

virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
	3Dconnexion device interactor style.

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

vtkInteractorObserver *	NewInstance () const

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

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkVRInteractorStyle *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyle3D
static vtkInteractorStyle3D *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyle3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()
	This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVRInteractorStyle ()

	~vtkVRInteractorStyle () override

virtual void	UpdateRay (vtkEventDataDevice controller)
	Update and draw the ray.

void	EndPickCallback (vtkSelection *sel)

void	StartAction (int VTKIS_STATE, vtkEventDataDevice3D *edata)
	Utility routines.

void	EndAction (int VTKIS_STATE, vtkEventDataDevice3D *edata)

bool	HardwareSelect (vtkEventDataDevice controller, bool actorPassOnly)
	Pick using hardware selector.

void	Movement3D (int interactionState, vtkEventData *edata)
	Update the 3D movement according to the given interaction state.

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

void	FindPickedActor (double pos[3], double orient[4])
	Get/Set the interaction picker.

void	Prop3DTransform (vtkProp3D prop3D, double boxCenter, int NumRotation, double *rotate, double scale)
	Get/Set the interaction picker.

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

	vtkInteractorStyle ()

	~vtkInteractorStyle () override

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

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

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	MenuCallback (vtkObject object, unsigned long event, void clientdata, void *calldata)

Static Protected Member Functions inherited from vtkInteractorStyle
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Main process event method.

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
bool	HoverPick = false

bool	GrabWithRay = true

vtkNew< vtkVRMenuWidget >	Menu

vtkNew< vtkVRMenuRepresentation >	MenuRepresentation

vtkNew< vtkCallbackCommand >	MenuCommand

vtkNew< vtkTextActor3D >	TextActor3D

vtkNew< vtkActor >	PickActor

vtkNew< vtkSphereSource >	Sphere

vtkNew< vtkVRHardwarePicker >	HardwarePicker

std::map< std::tuple< vtkCommand::EventIds, vtkEventDataAction >, int >	InputMap

vtkVRControlsHelper *	ControlsHelpers [vtkEventDataNumberOfDevices][vtkEventDataNumberOfInputs]

int	InteractionState [vtkEventDataNumberOfDevices]

std::vector< vtkSmartPointer< vtkProp3D > >	InteractionProps

std::vector< vtkSmartPointer< vtkPlane > >	ClippingPlanes

double	HeadsetDir [3] = { 0, 0, 0 }

MovementStyle	Style = vtkVRInteractorStyle::FLY_STYLE

vtkNew< vtkTimerLog >	LastGroundMovement3DEventTime

vtkNew< vtkTimerLog >	LastElevation3DEventTime

double	LastGroundMovementTrackPadPosition [2] = { 0, 0 }

double	LastElevationTrackPadPosition [2] = { 0, 0 }

Protected Attributes inherited from vtkInteractorStyle3D
vtkAbstractPropPicker *	InteractionPicker
	Get/Set the interaction picker.

vtkProp3D *	InteractionProp
	Get/Set the interaction picker.

vtkMatrix3x3 *	TempMatrix3
	Get/Set the interaction picker.

vtkMatrix4x4 *	TempMatrix4
	Get/Set the interaction picker.

vtkTransform *	TempTransform
	Get/Set the interaction picker.

double	AppliedTranslation [3]
	Get/Set the interaction picker.

double	DollyPhysicalSpeed
	Get/Set the interaction picker.

vtkNew< vtkTimerLog >	LastDolly3DEventTime
	Get/Set the interaction picker.

double	LastTrackPadPosition [2]
	Get/Set the interaction picker.

Protected Attributes inherited from vtkInteractorStyle
int	State

int	AnimState

vtkTypeBool	HandleObservers

vtkTypeBool	UseTimers

int	TimerId

vtkTypeBool	AutoAdjustCameraClippingRange

vtkOutlineSource *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

vtkRenderer *	PickedRenderer

vtkProp *	CurrentProp

vtkActor2D *	PickedActor2D

int	PropPicked

double	PickColor [3]

double	MouseWheelMotionFactor

unsigned long	TimerDuration

vtkEventForwarderCommand *	EventForwarder

vtkTDxInteractorStyle *	TDxStyle

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

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

Detailed Description

Extended from vtkInteractorStyle3D to override command methods.

This abstract class defines an interactor style in a virtual reality context.

Events:: vtkCommand::EndPickEvent vtkCommand::InteractionEvent vtkCommand::StartPickEvent

Definition at line 38 of file vtkVRInteractorStyle.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorStyle3D vtkVRInteractorStyle::Superclass

Definition at line 41 of file vtkVRInteractorStyle.h.

Member Enumeration Documentation

◆ MovementStyle

enum vtkVRInteractorStyle::MovementStyle

Enumerator
FLY_STYLE
GROUNDED_STYLE

Definition at line 152 of file vtkVRInteractorStyle.h.

Constructor & Destructor Documentation

◆ vtkVRInteractorStyle()

vtkVRInteractorStyle::vtkVRInteractorStyle ( )

protected

◆ ~vtkVRInteractorStyle()

vtkVRInteractorStyle::~vtkVRInteractorStyle ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkVRInteractorStyle::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 vtkInteractorStyle3D.

Reimplemented in vtkOpenVRInteractorStyle, and vtkOpenXRInteractorStyle.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVRInteractorStyle::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyle3D.

Reimplemented in vtkOpenVRInteractorStyle, and vtkOpenXRInteractorStyle.

◆ NewInstance()

vtkVRInteractorStyle * vtkVRInteractorStyle::NewInstance ( ) const

◆ PrintSelf()

void vtkVRInteractorStyle::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 vtkInteractorStyle3D.

◆ OnSelect3D()

void vtkVRInteractorStyle::OnSelect3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.

◆ OnNextPose3D()

void vtkVRInteractorStyle::OnNextPose3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.

◆ OnViewerMovement3D()

void vtkVRInteractorStyle::OnViewerMovement3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.

◆ OnMove3D()

void vtkVRInteractorStyle::OnMove3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.

◆ OnMenu3D()

void vtkVRInteractorStyle::OnMenu3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.

◆ OnElevation3D()

void vtkVRInteractorStyle::OnElevation3D ( vtkEventData * edata )

overridevirtual

Override generic event bindings to call the corresponding action.

Reimplemented from vtkInteractorStyle.