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

provides customizable interaction routines More...

#include <vtkInteractorStyleUser.h>

Inheritance diagram for vtkInteractorStyleUser:
[legend]
Collaboration diagram for vtkInteractorStyleUser:
[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. More...
 
vtkInteractorStyleUserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void OnTimer () override
 OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses. More...
 
virtual intGetLastPos ()
 Get the most recent mouse position during mouse motion. More...
 
virtual void GetLastPos (int &, int &)
 Get the most recent mouse position during mouse motion. More...
 
virtual void GetLastPos (int[2])
 Get the most recent mouse position during mouse motion. More...
 
virtual intGetOldPos ()
 Get the previous mouse position during mouse motion, or after a key press. More...
 
virtual void GetOldPos (int &, int &)
 Get the previous mouse position during mouse motion, or after a key press. More...
 
virtual void GetOldPos (int[2])
 Get the previous mouse position during mouse motion, or after a key press. More...
 
virtual int GetShiftKey ()
 Test whether modifiers were held down when mouse button or key was pressed. More...
 
virtual int GetCtrlKey ()
 Test whether modifiers were held down when mouse button or key was pressed. More...
 
virtual int GetChar ()
 Get the character for a Char event. More...
 
virtual char * GetKeySym ()
 Get the KeySym (in the same format as vtkRenderWindowInteractor KeySyms) for a KeyPress or KeyRelease method. More...
 
virtual int GetButton ()
 Get the mouse button that was last pressed inside the window (returns zero when the button is released). More...
 
void OnMouseMove () override
 Generic event bindings. More...
 
void OnLeftButtonDown () override
 Generic event bindings. More...
 
void OnLeftButtonUp () override
 Generic event bindings. More...
 
void OnMiddleButtonDown () override
 Generic event bindings. More...
 
void OnMiddleButtonUp () override
 Generic event bindings. More...
 
void OnRightButtonDown () override
 Generic event bindings. More...
 
void OnRightButtonUp () override
 Generic event bindings. More...
 
void OnMouseWheelForward () override
 Generic event bindings. More...
 
void OnMouseWheelBackward () override
 Generic event bindings. More...
 
void OnChar () override
 Keyboard functions. More...
 
void OnKeyPress () override
 Keyboard functions. More...
 
void OnKeyRelease () override
 Keyboard functions. More...
 
void OnExpose () override
 These are more esoteric events, but are useful in some cases. More...
 
void OnConfigure () override
 These are more esoteric events, but are useful in some cases. More...
 
void OnEnter () override
 These are more esoteric events, but are useful in some cases. More...
 
void OnLeave () override
 These are more esoteric events, but are useful in some cases. More...
 
- Public Member Functions inherited from vtkInteractorStyle
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 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 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 vtkInteractorStyleUserNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyleUserSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorStyle
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
 
 vtkInteractorStyleUser ()
 
 ~vtkInteractorStyleUser () override
 
- Protected Member Functions inherited from vtkInteractorStyle
 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 &)
 

Protected Attributes

int LastPos [2]
 
int OldPos [2]
 
int ShiftKey
 
int CtrlKey
 
int Char
 
char * KeySym
 
int Button
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Detailed Description

provides customizable interaction routines

The most common way to customize user interaction is to write a subclass of vtkInteractorStyle: vtkInteractorStyleUser allows you to customize the interaction to without subclassing vtkInteractorStyle. This is particularly useful for setting up custom interaction modes in scripting languages such as Python. This class allows you to hook into the MouseMove, ButtonPress/Release, KeyPress/Release, etc. events. If you want to hook into just a single mouse button, but leave the interaction modes for the others unchanged, you must use e.g. SetMiddleButtonPressMethod() instead of the more general SetButtonPressMethod().

Examples:
vtkInteractorStyleUser (Examples)
Tests:
vtkInteractorStyleUser (Tests)

Definition at line 48 of file vtkInteractorStyleUser.h.

Member Typedef Documentation

Definition at line 52 of file vtkInteractorStyleUser.h.

Constructor & Destructor Documentation

vtkInteractorStyleUser::vtkInteractorStyleUser ( )
protected
vtkInteractorStyleUser::~vtkInteractorStyleUser ( )
overrideprotected

Member Function Documentation

static vtkInteractorStyleUser* vtkInteractorStyleUser::New ( )
static
static vtkTypeBool vtkInteractorStyleUser::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkInteractorStyleUser::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.

static vtkInteractorStyleUser* vtkInteractorStyleUser::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkInteractorStyleUser::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInteractorStyle.

vtkInteractorStyleUser* vtkInteractorStyleUser::NewInstance ( ) const
void vtkInteractorStyleUser::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

virtual int* vtkInteractorStyleUser::GetLastPos ( )
virtual

Get the most recent mouse position during mouse motion.

In your user interaction method, you must use this to track the mouse movement. Do not use GetEventPosition(), which records the last position where a mouse button was pressed.

virtual void vtkInteractorStyleUser::GetLastPos ( int ,
int  
)
virtual

Get the most recent mouse position during mouse motion.

In your user interaction method, you must use this to track the mouse movement. Do not use GetEventPosition(), which records the last position where a mouse button was pressed.

virtual void vtkInteractorStyleUser::GetLastPos ( int  [2])
virtual

Get the most recent mouse position during mouse motion.

In your user interaction method, you must use this to track the mouse movement. Do not use GetEventPosition(), which records the last position where a mouse button was pressed.

virtual int* vtkInteractorStyleUser::GetOldPos ( )
virtual

Get the previous mouse position during mouse motion, or after a key press.

This can be used to calculate the relative displacement of the mouse.

virtual void vtkInteractorStyleUser::GetOldPos ( int ,
int  
)
virtual

Get the previous mouse position during mouse motion, or after a key press.

This can be used to calculate the relative displacement of the mouse.

virtual void vtkInteractorStyleUser::GetOldPos ( int  [2])
virtual

Get the previous mouse position during mouse motion, or after a key press.

This can be used to calculate the relative displacement of the mouse.

virtual int vtkInteractorStyleUser::GetShiftKey ( )
virtual

Test whether modifiers were held down when mouse button or key was pressed.

virtual int vtkInteractorStyleUser::GetCtrlKey ( )
virtual

Test whether modifiers were held down when mouse button or key was pressed.

virtual int vtkInteractorStyleUser::GetChar ( )
virtual

Get the character for a Char event.

virtual char* vtkInteractorStyleUser::GetKeySym ( )
virtual

Get the KeySym (in the same format as vtkRenderWindowInteractor KeySyms) for a KeyPress or KeyRelease method.

virtual int vtkInteractorStyleUser::GetButton ( )
virtual

Get the mouse button that was last pressed inside the window (returns zero when the button is released).

void vtkInteractorStyleUser::OnMouseMove ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnLeftButtonDown ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnLeftButtonUp ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnMiddleButtonDown ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnMiddleButtonUp ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnRightButtonDown ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnRightButtonUp ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnMouseWheelForward ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnMouseWheelBackward ( )
overridevirtual

Generic event bindings.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnChar ( )
overridevirtual

Keyboard functions.

Reimplemented from vtkInteractorObserver.

void vtkInteractorStyleUser::OnKeyPress ( )
overridevirtual

Keyboard functions.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnKeyRelease ( )
overridevirtual

Keyboard functions.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnExpose ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnConfigure ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnEnter ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnLeave ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleUser::OnTimer ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

Member Data Documentation

int vtkInteractorStyleUser::LastPos[2]
protected

Definition at line 147 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::OldPos[2]
protected

Definition at line 148 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::ShiftKey
protected

Definition at line 150 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::CtrlKey
protected

Definition at line 151 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::Char
protected

Definition at line 152 of file vtkInteractorStyleUser.h.

char* vtkInteractorStyleUser::KeySym
protected

Definition at line 153 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::Button
protected

Definition at line 154 of file vtkInteractorStyleUser.h.


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