VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkInteractorStyle3D Class Reference

extends interaction to support 3D input More...

#include <vtkInteractorStyle3D.h>

Inheritance diagram for vtkInteractorStyle3D:
[legend]
Collaboration diagram for vtkInteractorStyle3D:
[legend]

Public Types

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.
 
vtkInteractorStyle3DNewInstance () 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.
 
- 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.
 
vtkInteractorStyleNewInstance () 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 *)
 
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 vtkTDxInteractorStyleGetTDxStyle ()
 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.
 
vtkInteractorObserverNewInstance () 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 vtkRenderWindowInteractorGetInteractor ()
 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 vtkRendererGetDefaultRenderer ()
 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 vtkRendererGetCurrentRenderer ()
 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)
 
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.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

Static Public Member Functions

static vtkInteractorStyle3DNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyle3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyleNew ()
 This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyleSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (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 vtkObjectNew ()
 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 (int 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 int 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
- Protected Member Functions inherited from vtkInteractorStyle
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInteractorStyle ()
 
 ~vtkInteractorStyle () override
 
- Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager.
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager.
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong.
 
vtkAssemblyPathGetAssemblyPath (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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
vtkAbstractPropPickerInteractionPicker
 Get/Set the interaction picker.
 
vtkProp3DInteractionProp
 Get/Set the interaction picker.
 
vtkMatrix3x3TempMatrix3
 Get/Set the interaction picker.
 
vtkMatrix4x4TempMatrix4
 Get/Set the interaction picker.
 
vtkTransformTempTransform
 Get/Set the interaction picker.
 
double AppliedTranslation [3]
 Get/Set the interaction picker.
 
double DollyPhysicalSpeed
 Get/Set the interaction picker.
 
vtkNew< vtkTimerLogLastDolly3DEventTime
 Get/Set the interaction picker.
 
double LastTrackPadPosition [2]
 Get/Set the interaction picker.
 
virtual vtkAbstractPropPickerGetInteractionPicker ()
 Get/Set the interaction picker.
 
void SetInteractionPicker (vtkAbstractPropPicker *prop)
 Get/Set the interaction picker.
 
 vtkInteractorStyle3D ()
 Get/Set the interaction picker.
 
 ~vtkInteractorStyle3D () override
 Get/Set the interaction picker.
 
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.
 

Additional Inherited Members

- 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 inherited from vtkInteractorStyle
int State
 
int AnimState
 
vtkTypeBool HandleObservers
 
vtkTypeBool UseTimers
 
int TimerId
 
vtkTypeBool AutoAdjustCameraClippingRange
 
vtkOutlineSourceOutline
 
vtkPolyDataMapperOutlineMapper
 
vtkActorOutlineActor
 
vtkRendererPickedRenderer
 
vtkPropCurrentProp
 
vtkActor2DPickedActor2D
 
int PropPicked
 
double PickColor [3]
 
double MouseWheelMotionFactor
 
unsigned long TimerDuration
 
vtkEventForwarderCommandEventForwarder
 
vtkTDxInteractorStyleTDxStyle
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

extends interaction to support 3D input

vtkInteractorStyle3D allows the user to interact with (rotate, pan, etc.) objects in the scene indendent of each other. It is designed to use 3d positions and orientations instead of 2D.

The following interactions are specified by default.

A click and hold in 3D within the bounding box of a prop will pick up that prop allowing you to translate and orient that prop as desired with the 3D controller.

Click/dragging two controllers and pulling them apart or pushing them together will initial a scale gesture that will scale the world larger or smaller.

Click/dragging two controllers and translating them in the same direction will translate the camera/world pushing them together will initial a scale gesture that will scale the world larger or smaller.

If a controller is right clicked (push touchpad on Vive) then it starts a fly motion where the camer moves in the direction the controller is pointing. It moves at a speed scaled by the position of your thumb on the trackpad. Higher moves faster forward. Lower moves faster backwards.

For the Vive left click is mapped to the trigger and right click is mapped to pushing the trackpad down.

See also
vtkRenderWindowInteractor3D

Definition at line 66 of file vtkInteractorStyle3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 70 of file vtkInteractorStyle3D.h.

Constructor & Destructor Documentation

◆ vtkInteractorStyle3D()

vtkInteractorStyle3D::vtkInteractorStyle3D ( )
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

◆ ~vtkInteractorStyle3D()

vtkInteractorStyle3D::~vtkInteractorStyle3D ( )
overrideprotected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Member Function Documentation

◆ New()

static vtkInteractorStyle3D * vtkInteractorStyle3D::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkOpenVRInteractorStyle.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInteractorStyle3D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkOpenVRInteractorStyle.

◆ NewInstance()

vtkInteractorStyle3D * vtkInteractorStyle3D::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkOpenVRInteractorStyle.

◆ PositionProp()

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

Reimplemented in vtkOpenVRInteractorStyle.

◆ Dolly3D()

virtual void vtkInteractorStyle3D::Dolly3D ( vtkEventData )
virtual

◆ SetDollyPhysicalSpeed()

virtual void vtkInteractorStyle3D::SetDollyPhysicalSpeed ( double  )
virtual

Set/Get the maximum dolly speed used when flying in 3D, in meters per second.

Default is 1.6666, corresponding to walking speed (= 6 km/h). This speed is scaled by the touchpad position as well.

◆ GetDollyPhysicalSpeed()

virtual double vtkInteractorStyle3D::GetDollyPhysicalSpeed ( )
virtual

Set/Get the maximum dolly speed used when flying in 3D, in meters per second.

Default is 1.6666, corresponding to walking speed (= 6 km/h). This speed is scaled by the touchpad position as well.

◆ SetScale()

virtual void vtkInteractorStyle3D::SetScale ( vtkCamera cam,
double  newScale 
)
virtual

Set the scaling factor from world to physical space.

In VR when we set it to a new value we also adjust the HMD position to maintain the same relative position.

◆ GetInteractionPicker()

virtual vtkAbstractPropPicker * vtkInteractorStyle3D::GetInteractionPicker ( )
virtual

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

◆ SetInteractionPicker()

void vtkInteractorStyle3D::SetInteractionPicker ( vtkAbstractPropPicker prop)

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

◆ FindPickedActor()

void vtkInteractorStyle3D::FindPickedActor ( double  pos[3],
double  orient[4] 
)
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

◆ Prop3DTransform()

void vtkInteractorStyle3D::Prop3DTransform ( vtkProp3D prop3D,
double *  boxCenter,
int  NumRotation,
double **  rotate,
double *  scale 
)
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Member Data Documentation

◆ InteractionPicker

vtkAbstractPropPicker* vtkInteractorStyle3D::InteractionPicker
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 118 of file vtkInteractorStyle3D.h.

◆ InteractionProp

vtkProp3D* vtkInteractorStyle3D::InteractionProp
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 119 of file vtkInteractorStyle3D.h.

◆ TempMatrix3

vtkMatrix3x3* vtkInteractorStyle3D::TempMatrix3
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 120 of file vtkInteractorStyle3D.h.

◆ TempMatrix4

vtkMatrix4x4* vtkInteractorStyle3D::TempMatrix4
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 121 of file vtkInteractorStyle3D.h.

◆ TempTransform

vtkTransform* vtkInteractorStyle3D::TempTransform
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 123 of file vtkInteractorStyle3D.h.

◆ AppliedTranslation

double vtkInteractorStyle3D::AppliedTranslation[3]
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 124 of file vtkInteractorStyle3D.h.

◆ DollyPhysicalSpeed

double vtkInteractorStyle3D::DollyPhysicalSpeed
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 126 of file vtkInteractorStyle3D.h.

◆ LastDolly3DEventTime

vtkNew<vtkTimerLog> vtkInteractorStyle3D::LastDolly3DEventTime
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 127 of file vtkInteractorStyle3D.h.

◆ LastTrackPadPosition

double vtkInteractorStyle3D::LastTrackPadPosition[2]
protected

Get/Set the interaction picker.

By default, a vtkPropPicker is instancied.

Definition at line 128 of file vtkInteractorStyle3D.h.


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