VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkInteractorStyle Class Reference

provide event-driven interface to the rendering window (defines trackball mode) More...

#include <vtkInteractorStyle.h>

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

Public Types

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. More...
 
vtkInteractorStyleNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetInteractor (vtkRenderWindowInteractor *interactor) override
 Set/Get the Interactor wrapper being controlled by this object. More...
 
void SetEnabled (int) override
 Turn on/off this interactor. More...
 
void FindPokedRenderer (int, int)
 When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. More...
 
virtual void OnMouseMove ()
 Generic event bindings can be overridden in subclasses. More...
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnMiddleButtonDown ()
 
virtual void OnMiddleButtonUp ()
 
virtual void OnRightButtonDown ()
 
virtual void OnRightButtonUp ()
 
virtual void OnMouseWheelForward ()
 
virtual void OnMouseWheelBackward ()
 
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. More...
 
virtual void OnButton3D (vtkEventData *)
 
void OnChar () override
 OnChar is triggered when an ASCII key is pressed. More...
 
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. More...
 
virtual void OnConfigure ()
 
virtual void OnEnter ()
 
virtual void OnLeave ()
 
virtual void OnTimer ()
 OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses. More...
 
virtual void Rotate ()
 These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion. More...
 
virtual void Spin ()
 
virtual void Pan ()
 
virtual void Dolly ()
 
virtual void Zoom ()
 
virtual void UniformScale ()
 
virtual void OnPinch ()
 gesture based events More...
 
virtual void OnRotate ()
 
virtual void OnPan ()
 
virtual void OnTap ()
 
virtual void OnLongTap ()
 
virtual void OnSwipe ()
 
void DelegateTDxEvent (unsigned long event, void *calldata)
 Called by the callback to process 3DConnexion device events. More...
 
virtual void SetAutoAdjustCameraClippingRange (vtkTypeBool)
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual vtkTypeBool GetAutoAdjustCameraClippingRange ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual void AutoAdjustCameraClippingRangeOn ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual void AutoAdjustCameraClippingRangeOff ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual int GetState ()
 Some useful information for interaction. More...
 
virtual vtkTypeBool GetUseTimers ()
 Set/Get timer hint. More...
 
virtual void SetUseTimers (vtkTypeBool)
 Set/Get timer hint. More...
 
virtual void UseTimersOn ()
 Set/Get timer hint. More...
 
virtual void UseTimersOff ()
 Set/Get timer hint. More...
 
virtual void SetTimerDuration (unsigned long)
 If using timers, specify the default timer interval (in milliseconds). More...
 
virtual unsigned long GetTimerDuration ()
 If using timers, specify the default timer interval (in milliseconds). More...
 
virtual void SetHandleObservers (vtkTypeBool)
 Does ProcessEvents handle observers on this class or not. More...
 
virtual vtkTypeBool GetHandleObservers ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void HandleObserversOn ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void HandleObserversOff ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void StartState (int newstate)
 utility routines used by state changes More...
 
virtual void StopState ()
 utility routines used by state changes More...
 
virtual void StartAnimate ()
 Interaction mode entry points used internally. More...
 
virtual void StopAnimate ()
 Interaction mode entry points used internally. More...
 
virtual void StartRotate ()
 Interaction mode entry points used internally. More...
 
virtual void EndRotate ()
 Interaction mode entry points used internally. More...
 
virtual void StartZoom ()
 Interaction mode entry points used internally. More...
 
virtual void EndZoom ()
 Interaction mode entry points used internally. More...
 
virtual void StartPan ()
 Interaction mode entry points used internally. More...
 
virtual void EndPan ()
 Interaction mode entry points used internally. More...
 
virtual void StartSpin ()
 Interaction mode entry points used internally. More...
 
virtual void EndSpin ()
 Interaction mode entry points used internally. More...
 
virtual void StartDolly ()
 Interaction mode entry points used internally. More...
 
virtual void EndDolly ()
 Interaction mode entry points used internally. More...
 
virtual void StartUniformScale ()
 Interaction mode entry points used internally. More...
 
virtual void EndUniformScale ()
 Interaction mode entry points used internally. More...
 
virtual void StartTimer ()
 Interaction mode entry points used internally. More...
 
virtual void EndTimer ()
 Interaction mode entry points used internally. More...
 
virtual void StartTwoPointer ()
 Interaction mode entry points used internally. More...
 
virtual void EndTwoPointer ()
 Interaction mode entry points used internally. More...
 
virtual void HighlightProp (vtkProp *prop)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
 
virtual void HighlightActor2D (vtkActor2D *actor2D)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
 
virtual void HighlightProp3D (vtkProp3D *prop3D)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
 
virtual void SetPickColor (double, double, double)
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void SetPickColor (double[3])
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual doubleGetPickColor ()
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void GetPickColor (double data[3])
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void SetMouseWheelMotionFactor (double)
 Set/Get the mouse wheel motion factor. More...
 
virtual double GetMouseWheelMotionFactor ()
 Set/Get the mouse wheel motion factor. More...
 
virtual vtkTDxInteractorStyleGetTDxStyle ()
 3Dconnexion device interactor style. More...
 
virtual void SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
 3Dconnexion device interactor style. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor. More...
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkInteractorStyleNew ()
 This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. More...
 
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. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 Convenience methods for outside classes. More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInteractorStyle ()
 
 ~vtkInteractorStyle () override
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
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. More...
 
int RequestCursorShape (int requestedShape)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 Helper method for subclasses. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Main process event method. More...
 
- 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. More...
 

Protected Attributes

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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

provide event-driven interface to the rendering window (defines trackball mode)

vtkInteractorStyle is a base class implementing the majority of motion control routines and defines an event driven interface to support vtkRenderWindowInteractor. vtkRenderWindowInteractor implements platform dependent key/mouse routing and timer control, which forwards events in a neutral form to vtkInteractorStyle.

vtkInteractorStyle implements the "joystick" style of interaction. That is, holding down the mouse keys generates a stream of events that cause continuous actions (e.g., rotate, translate, pan, zoom). (The class vtkInteractorStyleTrackball implements a grab and move style.) The event bindings for this class include the following:

vtkInteractorStyle can be subclassed to provide new interaction styles and a facility to override any of the default mouse/key operations which currently handle trackball or joystick styles is provided. Note that this class will fire a variety of events that can be watched using an observer, such as LeftButtonPressEvent, LeftButtonReleaseEvent, MiddleButtonPressEvent, MiddleButtonReleaseEvent, RightButtonPressEvent, RightButtonReleaseEvent, EnterEvent, LeaveEvent, KeyPressEvent, KeyReleaseEvent, CharEvent, ExposeEvent, ConfigureEvent, TimerEvent, MouseMoveEvent,

See also
vtkInteractorStyleTrackball
Examples:
vtkInteractorStyle (Examples)
Tests:
vtkInteractorStyle (Tests)

Definition at line 141 of file vtkInteractorStyle.h.

Member Typedef Documentation

Definition at line 151 of file vtkInteractorStyle.h.

Constructor & Destructor Documentation

vtkInteractorStyle::vtkInteractorStyle ( )
protected
vtkInteractorStyle::~vtkInteractorStyle ( )
overrideprotected

Member Function Documentation

static vtkInteractorStyle* vtkInteractorStyle::New ( )
static

This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.

This class should not normally be instantiated by application programmers.

static vtkTypeBool vtkInteractorStyle::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkInteractorStyle::IsA ( const char *  name)
virtual
static vtkInteractorStyle* vtkInteractorStyle::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkInteractorStyle::NewInstanceInternal ( ) const
protectedvirtual
vtkInteractorStyle* vtkInteractorStyle::NewInstance ( ) const
void vtkInteractorStyle::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 vtkInteractorObserver.

Reimplemented in vtkInteractorStyle3D, vtkInteractorStyleTreeMapHover, vtkInteractorStyleAreaSelectHover, vtkOpenVRInteractorStyle, vtkContextInteractorStyle, and vtkInteractorStyleSwitchBase.

void vtkInteractorStyle::SetInteractor ( vtkRenderWindowInteractor interactor)
overridevirtual

Set/Get the Interactor wrapper being controlled by this object.

(Satisfy superclass API.)

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkOpenVRInteractorStyle, vtkInteractorStyleTreeMapHover, and vtkInteractorStyleAreaSelectHover.

void vtkInteractorStyle::SetEnabled ( int  )
overridevirtual

Turn on/off this interactor.

Interactor styles operate a little bit differently than other types of interactor observers. When the SetInteractor() method is invoked, the automatically enable themselves. This is a legacy requirement, and convenient for the user.

Reimplemented from vtkInteractorObserver.

virtual void vtkInteractorStyle::SetAutoAdjustCameraClippingRange ( vtkTypeBool  )
virtual

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

Clipping will still occur if objects in the scene are behind the camera or come very close. If AutoAdjustCameraClippingRange is off, no adjustment will be made per render, but the camera clipping range will still be reset when the camera is reset.

Reimplemented in vtkInteractorStyleSwitch.

virtual vtkTypeBool vtkInteractorStyle::GetAutoAdjustCameraClippingRange ( )
virtual

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

Clipping will still occur if objects in the scene are behind the camera or come very close. If AutoAdjustCameraClippingRange is off, no adjustment will be made per render, but the camera clipping range will still be reset when the camera is reset.

virtual void vtkInteractorStyle::AutoAdjustCameraClippingRangeOn ( )
virtual

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

Clipping will still occur if objects in the scene are behind the camera or come very close. If AutoAdjustCameraClippingRange is off, no adjustment will be made per render, but the camera clipping range will still be reset when the camera is reset.

virtual void vtkInteractorStyle::AutoAdjustCameraClippingRangeOff ( )
virtual

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

Clipping will still occur if objects in the scene are behind the camera or come very close. If AutoAdjustCameraClippingRange is off, no adjustment will be made per render, but the camera clipping range will still be reset when the camera is reset.

void vtkInteractorStyle::FindPokedRenderer ( int  ,
int   
)

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

virtual int vtkInteractorStyle::GetState ( )
virtual

Some useful information for interaction.

virtual vtkTypeBool vtkInteractorStyle::GetUseTimers ( )
virtual

Set/Get timer hint.

virtual void vtkInteractorStyle::SetUseTimers ( vtkTypeBool  )
virtual

Set/Get timer hint.

virtual void vtkInteractorStyle::UseTimersOn ( )
virtual

Set/Get timer hint.

virtual void vtkInteractorStyle::UseTimersOff ( )
virtual

Set/Get timer hint.

virtual void vtkInteractorStyle::SetTimerDuration ( unsigned  long)
virtual

If using timers, specify the default timer interval (in milliseconds).

Care must be taken when adjusting the timer interval from the default value of 10 milliseconds–it may adversely affect the interactors.

virtual unsigned long vtkInteractorStyle::GetTimerDuration ( )
virtual

If using timers, specify the default timer interval (in milliseconds).

Care must be taken when adjusting the timer interval from the default value of 10 milliseconds–it may adversely affect the interactors.

virtual void vtkInteractorStyle::SetHandleObservers ( vtkTypeBool  )
virtual

Does ProcessEvents handle observers on this class or not.

virtual vtkTypeBool vtkInteractorStyle::GetHandleObservers ( )
virtual

Does ProcessEvents handle observers on this class or not.

virtual void vtkInteractorStyle::HandleObserversOn ( )
virtual

Does ProcessEvents handle observers on this class or not.

virtual void vtkInteractorStyle::HandleObserversOff ( )
virtual

Does ProcessEvents handle observers on this class or not.

virtual void vtkInteractorStyle::OnMouseMove ( )
inlinevirtual
virtual void vtkInteractorStyle::OnLeftButtonDown ( )
inlinevirtual
virtual void vtkInteractorStyle::OnLeftButtonUp ( )
inlinevirtual
virtual void vtkInteractorStyle::OnMiddleButtonDown ( )
inlinevirtual
virtual void vtkInteractorStyle::OnMiddleButtonUp ( )
inlinevirtual
virtual void vtkInteractorStyle::OnRightButtonDown ( )
inlinevirtual
virtual void vtkInteractorStyle::OnRightButtonUp ( )
inlinevirtual
virtual void vtkInteractorStyle::OnMouseWheelForward ( )
inlinevirtual
virtual void vtkInteractorStyle::OnMouseWheelBackward ( )
inlinevirtual
virtual void vtkInteractorStyle::OnFourthButtonDown ( )
inlinevirtual

Definition at line 238 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnFourthButtonUp ( )
inlinevirtual

Definition at line 239 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnFifthButtonDown ( )
inlinevirtual

Definition at line 240 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnFifthButtonUp ( )
inlinevirtual

Definition at line 241 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnMove3D ( vtkEventData )
inlinevirtual

Generic 3D event bindings can be overridden in subclasses.

Reimplemented in vtkOpenVRInteractorStyle.

Definition at line 247 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnButton3D ( vtkEventData )
inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle.

Definition at line 248 of file vtkInteractorStyle.h.

void vtkInteractorStyle::OnChar ( )
overridevirtual

OnChar is triggered when an ASCII key is pressed.

Some basic key presses are handled here ('q' for Quit, 'p' for Pick, etc)

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkContextInteractorStyle.

virtual void vtkInteractorStyle::OnKeyDown ( )
inlinevirtual

Reimplemented in vtkInteractorStyleFlight.

Definition at line 259 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnKeyUp ( )
inlinevirtual

Reimplemented in vtkInteractorStyleFlight.

Definition at line 264 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnKeyPress ( )
inlinevirtual
virtual void vtkInteractorStyle::OnKeyRelease ( )
inlinevirtual

Reimplemented in vtkContextInteractorStyle, and vtkInteractorStyleUser.

Definition at line 274 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnExpose ( )
inlinevirtual

These are more esoteric events, but are useful in some cases.

Reimplemented in vtkInteractorStyleUser.

Definition at line 279 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnConfigure ( )
inlinevirtual

Reimplemented in vtkInteractorStyleUser.

Definition at line 280 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnEnter ( )
inlinevirtual

Reimplemented in vtkInteractorStyleUser.

Definition at line 281 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnLeave ( )
inlinevirtual

Reimplemented in vtkInteractorStyleUser, and vtkParallelCoordinatesInteractorStyle.

Definition at line 282 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnTimer ( )
virtual

OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses.

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, and vtkInteractorStyleUnicam.

virtual void vtkInteractorStyle::Rotate ( )
inlinevirtual

These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion.

Since they might be called from OnTimer, they do not have mouse coord parameters (use interactor's GetEventPosition and GetLastEventPosition)

Reimplemented in vtkInteractorStyleTerrain, vtkInteractorStyleTrackballCamera, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, and vtkInteractorStyleJoystickCamera.

Definition at line 296 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::Spin ( )
inlinevirtual
virtual void vtkInteractorStyle::Pan ( )
inlinevirtual
virtual void vtkInteractorStyle::Dolly ( )
inlinevirtual
virtual void vtkInteractorStyle::Zoom ( )
inlinevirtual
virtual void vtkInteractorStyle::UniformScale ( )
inlinevirtual
virtual void vtkInteractorStyle::OnPinch ( )
inlinevirtual

gesture based events

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 306 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnRotate ( )
inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 307 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnPan ( )
inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 308 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnTap ( )
inlinevirtual

Definition at line 309 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnLongTap ( )
inlinevirtual

Definition at line 310 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnSwipe ( )
inlinevirtual

Definition at line 311 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::StartState ( int  newstate)
virtual

utility routines used by state changes

virtual void vtkInteractorStyle::StopState ( )
virtual

utility routines used by state changes

virtual void vtkInteractorStyle::StartAnimate ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StopAnimate ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartRotate ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndRotate ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartZoom ( )
virtual

Interaction mode entry points used internally.

Reimplemented in vtkParallelCoordinatesInteractorStyle.

virtual void vtkInteractorStyle::EndZoom ( )
virtual

Interaction mode entry points used internally.

Reimplemented in vtkParallelCoordinatesInteractorStyle.

virtual void vtkInteractorStyle::StartPan ( )
virtual

Interaction mode entry points used internally.

Reimplemented in vtkParallelCoordinatesInteractorStyle.

virtual void vtkInteractorStyle::EndPan ( )
virtual

Interaction mode entry points used internally.

Reimplemented in vtkParallelCoordinatesInteractorStyle.

virtual void vtkInteractorStyle::StartSpin ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndSpin ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartDolly ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndDolly ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartUniformScale ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndUniformScale ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartTimer ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndTimer ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::StartTwoPointer ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::EndTwoPointer ( )
virtual

Interaction mode entry points used internally.

virtual void vtkInteractorStyle::HighlightProp ( vtkProp prop)
virtual

When picking successfully selects an actor, this method highlights the picked prop appropriately.

Currently this is done by placing a bounding box around a picked vtkProp3D, and using the PickColor to highlight a vtkProp2D.

virtual void vtkInteractorStyle::HighlightActor2D ( vtkActor2D actor2D)
virtual

When picking successfully selects an actor, this method highlights the picked prop appropriately.

Currently this is done by placing a bounding box around a picked vtkProp3D, and using the PickColor to highlight a vtkProp2D.

virtual void vtkInteractorStyle::HighlightProp3D ( vtkProp3D prop3D)
virtual

When picking successfully selects an actor, this method highlights the picked prop appropriately.

Currently this is done by placing a bounding box around a picked vtkProp3D, and using the PickColor to highlight a vtkProp2D.

virtual void vtkInteractorStyle::SetPickColor ( double  ,
double  ,
double   
)
virtual

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

The color is expressed as red/green/blue values between (0.0,1.0).

virtual void vtkInteractorStyle::SetPickColor ( double  [3])
virtual

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

The color is expressed as red/green/blue values between (0.0,1.0).

virtual double* vtkInteractorStyle::GetPickColor ( )
virtual

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

The color is expressed as red/green/blue values between (0.0,1.0).

virtual void vtkInteractorStyle::GetPickColor ( double  data[3])
virtual

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

The color is expressed as red/green/blue values between (0.0,1.0).

virtual void vtkInteractorStyle::SetMouseWheelMotionFactor ( double  )
virtual

Set/Get the mouse wheel motion factor.

Default to 1.0. Set it to a different value to emphasize or de-emphasize the action triggered by mouse wheel motion.

virtual double vtkInteractorStyle::GetMouseWheelMotionFactor ( )
virtual

Set/Get the mouse wheel motion factor.

Default to 1.0. Set it to a different value to emphasize or de-emphasize the action triggered by mouse wheel motion.

virtual vtkTDxInteractorStyle* vtkInteractorStyle::GetTDxStyle ( )
virtual

3Dconnexion device interactor style.

Initial value is a pointer to an object of class vtkTdxInteractorStyleCamera.

virtual void vtkInteractorStyle::SetTDxStyle ( vtkTDxInteractorStyle tdxStyle)
virtual

3Dconnexion device interactor style.

Initial value is a pointer to an object of class vtkTdxInteractorStyleCamera.

void vtkInteractorStyle::DelegateTDxEvent ( unsigned long  event,
void *  calldata 
)

Called by the callback to process 3DConnexion device events.

static void vtkInteractorStyle::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

Main process event method.

Member Data Documentation

int vtkInteractorStyle::State
protected

Definition at line 404 of file vtkInteractorStyle.h.

int vtkInteractorStyle::AnimState
protected

Definition at line 405 of file vtkInteractorStyle.h.

vtkTypeBool vtkInteractorStyle::HandleObservers
protected

Definition at line 408 of file vtkInteractorStyle.h.

vtkTypeBool vtkInteractorStyle::UseTimers
protected

Definition at line 409 of file vtkInteractorStyle.h.

int vtkInteractorStyle::TimerId
protected

Definition at line 410 of file vtkInteractorStyle.h.

vtkTypeBool vtkInteractorStyle::AutoAdjustCameraClippingRange
protected

Definition at line 412 of file vtkInteractorStyle.h.

vtkOutlineSource* vtkInteractorStyle::Outline
protected

Definition at line 415 of file vtkInteractorStyle.h.

vtkPolyDataMapper* vtkInteractorStyle::OutlineMapper
protected

Definition at line 416 of file vtkInteractorStyle.h.

vtkActor* vtkInteractorStyle::OutlineActor
protected

Definition at line 417 of file vtkInteractorStyle.h.

vtkRenderer* vtkInteractorStyle::PickedRenderer
protected

Definition at line 418 of file vtkInteractorStyle.h.

vtkProp* vtkInteractorStyle::CurrentProp
protected

Definition at line 419 of file vtkInteractorStyle.h.

vtkActor2D* vtkInteractorStyle::PickedActor2D
protected

Definition at line 420 of file vtkInteractorStyle.h.

int vtkInteractorStyle::PropPicked
protected

Definition at line 421 of file vtkInteractorStyle.h.

double vtkInteractorStyle::PickColor[3]
protected

Definition at line 422 of file vtkInteractorStyle.h.

double vtkInteractorStyle::MouseWheelMotionFactor
protected

Definition at line 423 of file vtkInteractorStyle.h.

unsigned long vtkInteractorStyle::TimerDuration
protected

Definition at line 426 of file vtkInteractorStyle.h.

vtkEventForwarderCommand* vtkInteractorStyle::EventForwarder
protected

Definition at line 429 of file vtkInteractorStyle.h.

vtkTDxInteractorStyle* vtkInteractorStyle::TDxStyle
protected

Definition at line 431 of file vtkInteractorStyle.h.


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