vtkInteractorStyle Class Reference

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

#include <vtkInteractorStyle.h>

Inheritance diagram for vtkInteractorStyle:

Collaboration diagram for vtkInteractorStyle:

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...
vtkInteractorStyle *	NewInstance () 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...
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 ()
virtual void	AutoAdjustCameraClippingRangeOn ()
virtual void	AutoAdjustCameraClippingRangeOff ()
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 int	GetState ()
	Some useful information for interaction. More...
virtual vtkTypeBool	GetUseTimers ()
	Set/Get timer hint. More...
virtual void	SetUseTimers (vtkTypeBool)
virtual void	UseTimersOn ()
virtual void	UseTimersOff ()
virtual void	SetTimerDuration (unsigned long)
	If using timers, specify the default timer interval (in milliseconds). More...
virtual unsigned long	GetTimerDuration ()
virtual void	SetHandleObservers (vtkTypeBool)
	Does ProcessEvents handle observers on this class or not. More...
virtual vtkTypeBool	GetHandleObservers ()
virtual void	HandleObserversOn ()
virtual void	HandleObserversOff ()
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	OnStartSwipe ()
	gesture based events More...
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	StartState (int newstate)
	utility routines used by state changes More...
virtual void	StopState ()
virtual void	StartAnimate ()
	Interaction mode entry points used internally. More...
virtual void	StopAnimate ()
virtual void	StartRotate ()
virtual void	EndRotate ()
virtual void	StartZoom ()
virtual void	EndZoom ()
virtual void	StartPan ()
virtual void	EndPan ()
virtual void	StartSpin ()
virtual void	EndSpin ()
virtual void	StartDolly ()
virtual void	EndDolly ()
virtual void	StartUniformScale ()
virtual void	EndUniformScale ()
virtual void	StartTimer ()
virtual void	EndTimer ()
virtual void	StartTwoPointer ()
virtual void	EndTwoPointer ()
virtual void	StartGesture ()
virtual void	EndGesture ()
virtual void	HighlightProp (vtkProp *prop)
	When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
virtual void	HighlightActor2D (vtkActor2D *actor2D)
virtual void	HighlightProp3D (vtkProp3D *prop3D)
virtual void	SetPickColor (double, double, double)
	Set/Get the pick color (used by default to color vtkActor2D's). More...
virtual void	SetPickColor (double[3])
virtual double *	GetPickColor ()
virtual void	GetPickColor (double data[3])
virtual void	SetMouseWheelMotionFactor (double)
	Set/Get the mouse wheel motion factor. More...
virtual double	GetMouseWheelMotionFactor ()
virtual vtkTDxInteractorStyle *	GetTDxStyle ()
	3Dconnexion device interactor style. More...
virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void	DelegateTDxEvent (unsigned long event, void *calldata)
	Called by the callback to process 3DConnexion device events. More...
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
	Set/Get the priority at which events are processed. More...
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool managed)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual vtkTypeBool	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
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 ()
virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...
virtual void	SetCurrentRenderer (vtkRenderer *)
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 ()
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...
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)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
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)
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)
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
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...

Static Public Member Functions
static vtkInteractorStyle *	New ()
	This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. More...
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes. More...
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 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 ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractorStyle ()
	~vtkInteractorStyle () override
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver () override
virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...
virtual void	EndInteraction ()
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])
virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...
void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...
vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong. More...
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
int	RequestCursorShape (int requestedShape)
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 ()
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
vtkOutlineSource *	Outline
vtkPolyDataMapper *	OutlineMapper
vtkActor *	OutlineActor
vtkRenderer *	PickedRenderer
vtkProp *	CurrentProp
vtkActor2D *	PickedActor2D
int	PropPicked
double	PickColor [3]
double	MouseWheelMotionFactor
unsigned long	TimerDuration
vtkEventForwarderCommand *	EventForwarder
vtkTDxInteractorStyle *	TDxStyle
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
vtkTypeBool	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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:

• Keypress j / Keypress t: toggle between joystick (position sensitive) and trackball (motion sensitive) styles. In joystick style, motion occurs continuously as long as a mouse button is pressed. In trackball style, motion occurs when the mouse button is pressed and the mouse pointer moves.
• Keypress c / Keypress a: toggle between camera and actor modes. In camera mode, mouse events affect the camera position and focal point. In actor mode, mouse events affect the actor that is under the mouse pointer.
• Button 1: rotate the camera around its focal point (if camera mode) or rotate the actor around its origin (if actor mode). The rotation is in the direction defined from the center of the renderer's viewport towards the mouse position. In joystick mode, the magnitude of the rotation is determined by the distance the mouse is from the center of the render window.
• Button 2: pan the camera (if camera mode) or translate the actor (if actor mode). In joystick mode, the direction of pan or translation is from the center of the viewport towards the mouse position. In trackball mode, the direction of motion is the direction the mouse moves. (Note: with 2-button mice, pan is defined as <Shift>-Button 1.)
• Button 3: zoom the camera (if camera mode) or scale the actor (if actor mode). Zoom in/increase scale if the mouse position is in the top half of the viewport; zoom out/decrease scale if the mouse position is in the bottom half. In joystick mode, the amount of zoom is controlled by the distance of the mouse pointer from the horizontal centerline of the window.
• Keypress 3: toggle the render window into and out of stereo mode. By default, red-blue stereo pairs are created. Some systems support Crystal Eyes LCD stereo glasses; you have to invoke SetStereoTypeToCrystalEyes() on the rendering window.
• Keypress e: exit the application.
• Keypress f: fly to the picked point
• Keypress p: perform a pick operation. The render window interactor has an internal instance of vtkCellPicker that it uses to pick.
• Keypress r: reset the camera view along the current view direction. Centers the actors and moves the camera so that all actors are visible.
• Keypress s: modify the representation of all actors so that they are surfaces.
• Keypress u: invoke the user-defined function. Typically, this keypress will bring up an interactor that you can type commands in. Typing u calls UserCallBack() on the vtkRenderWindowInteractor, which invokes a vtkCommand::UserEvent. In other words, to define a user-defined callback, just add an observer to the vtkCommand::UserEvent on the vtkRenderWindowInteractor object.
• Keypress w: modify the representation of all actors so that they are wireframe.

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

Definition at line 136 of file vtkInteractorStyle.h.

Member Typedef Documentation

Superclass

typedef vtkInteractorObserver vtkInteractorStyle::Superclass

Definition at line 146 of file vtkInteractorStyle.h.

Constructor & Destructor Documentation

vtkInteractorStyle()

vtkInteractorStyle::vtkInteractorStyle ( )

protected

~vtkInteractorStyle()

vtkInteractorStyle::~vtkInteractorStyle ( )

overrideprotected

Member Function Documentation

New()

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.

IsTypeOf()

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

static

IsA()

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

Reimplemented in vtkInteractorStyleUnicam, vtkInteractorStyleImage, vtkInteractorStyle3D, vtkInteractorStyleTerrain, vtkParallelCoordinatesInteractorStyle, vtkOSPRayTestInteractor, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleRubberBand2D, vtkInteractorStyleTreeMapHover, vtkInteractorStyleRubberBand3D, vtkInteractorStyleSwitch, vtkInteractorStyleFlight, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandPick, vtkInteractorStyleUser, vtkInteractorStyleTrackballCamera, vtkOpenVRInteractorStyle, vtkInteractorStyleMultiTouchCamera, vtkContextInteractorStyle, vtkInteractorStyleDrawPolygon, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleTrackball, and vtkInteractorStyleSwitchBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase* vtkInteractorStyle::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkInteractorStyleUnicam, vtkInteractorStyleImage, vtkInteractorStyle3D, vtkInteractorStyleTerrain, vtkParallelCoordinatesInteractorStyle, vtkOSPRayTestInteractor, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleRubberBand2D, vtkInteractorStyleTreeMapHover, vtkInteractorStyleRubberBand3D, vtkInteractorStyleSwitch, vtkInteractorStyleFlight, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandPick, vtkInteractorStyleUser, vtkInteractorStyleTrackballCamera, vtkOpenVRInteractorStyle, vtkInteractorStyleMultiTouchCamera, vtkContextInteractorStyle, vtkInteractorStyleDrawPolygon, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleTrackball, and vtkInteractorStyleSwitchBase.

NewInstance()

vtkInteractorStyle* vtkInteractorStyle::NewInstance

(

)

const

PrintSelf()

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, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleTreeMapHover, vtkOpenVRInteractorStyle, vtkContextInteractorStyle, and vtkInteractorStyleSwitchBase.

SetInteractor()

void vtkInteractorStyle::SetInteractor ( vtkRenderWindowInteractor *  interactor )

overridevirtual

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

(Satisfy superclass API.)

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkInteractorStyleTreeMapHover, vtkInteractorStyleAreaSelectHover, and vtkOpenVRInteractorStyle.

SetEnabled()

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.

SetAutoAdjustCameraClippingRange()

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.

GetAutoAdjustCameraClippingRange()

virtual vtkTypeBool vtkInteractorStyle::GetAutoAdjustCameraClippingRange ( )

virtual

AutoAdjustCameraClippingRangeOn()

virtual void vtkInteractorStyle::AutoAdjustCameraClippingRangeOn ( )

virtual

AutoAdjustCameraClippingRangeOff()

virtual void vtkInteractorStyle::AutoAdjustCameraClippingRangeOff ( )

virtual

FindPokedRenderer()

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.

GetState()

virtual int vtkInteractorStyle::GetState ( )

virtual

Some useful information for interaction.

GetUseTimers()

virtual vtkTypeBool vtkInteractorStyle::GetUseTimers ( )

virtual

Set/Get timer hint.

SetUseTimers()

virtual void vtkInteractorStyle::SetUseTimers ( vtkTypeBool  )

virtual

UseTimersOn()

virtual void vtkInteractorStyle::UseTimersOn ( )

virtual

UseTimersOff()

virtual void vtkInteractorStyle::UseTimersOff ( )

virtual

SetTimerDuration()

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.

GetTimerDuration()

virtual unsigned long vtkInteractorStyle::GetTimerDuration ( )

virtual

SetHandleObservers()

virtual void vtkInteractorStyle::SetHandleObservers ( vtkTypeBool  )

virtual

Does ProcessEvents handle observers on this class or not.

GetHandleObservers()

virtual vtkTypeBool vtkInteractorStyle::GetHandleObservers ( )

virtual

HandleObserversOn()

virtual void vtkInteractorStyle::HandleObserversOn ( )

virtual

HandleObserversOff()

virtual void vtkInteractorStyle::HandleObserversOff ( )

virtual

OnMouseMove()

virtual void vtkInteractorStyle::OnMouseMove ( )

inlinevirtual

Generic event bindings can be overridden in subclasses.

Reimplemented in vtkInteractorStyleUnicam, vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleTreeMapHover, vtkInteractorStyleTerrain, vtkContextInteractorStyle, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleRubberBandPick, vtkInteractorStyleJoystickCamera, vtkInteractorStyleTrackballCamera, and vtkInteractorStyleDrawPolygon.

Definition at line 224 of file vtkInteractorStyle.h.

OnLeftButtonDown()

virtual void vtkInteractorStyle::OnLeftButtonDown ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUnicam, vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleTerrain, vtkContextInteractorStyle, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleRubberBandPick, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, vtkInteractorStyleTrackballCamera, and vtkInteractorStyleDrawPolygon.

Definition at line 225 of file vtkInteractorStyle.h.

OnLeftButtonUp()

virtual void vtkInteractorStyle::OnLeftButtonUp ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUnicam, vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleTreeMapHover, vtkContextInteractorStyle, vtkInteractorStyleTerrain, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleRubberBandPick, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, vtkInteractorStyleTrackballCamera, and vtkInteractorStyleDrawPolygon.

Definition at line 226 of file vtkInteractorStyle.h.

OnMiddleButtonDown()

virtual void vtkInteractorStyle::OnMiddleButtonDown ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkContextInteractorStyle, vtkInteractorStyleTerrain, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 227 of file vtkInteractorStyle.h.

OnMiddleButtonUp()

virtual void vtkInteractorStyle::OnMiddleButtonUp ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkContextInteractorStyle, vtkInteractorStyleTerrain, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 228 of file vtkInteractorStyle.h.

OnRightButtonDown()

virtual void vtkInteractorStyle::OnRightButtonDown ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkParallelCoordinatesInteractorStyle, vtkContextInteractorStyle, vtkInteractorStyleTerrain, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 229 of file vtkInteractorStyle.h.

OnRightButtonUp()

virtual void vtkInteractorStyle::OnRightButtonUp ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, vtkInteractorStyleImage, vtkContextInteractorStyle, vtkParallelCoordinatesInteractorStyle, vtkInteractorStyleTerrain, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 230 of file vtkInteractorStyle.h.

OnMouseWheelForward()

virtual void vtkInteractorStyle::OnMouseWheelForward ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUser, vtkContextInteractorStyle, vtkInteractorStyleRubberBand2D, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 231 of file vtkInteractorStyle.h.

OnMouseWheelBackward()

virtual void vtkInteractorStyle::OnMouseWheelBackward ( )

inlinevirtual

Reimplemented in vtkContextInteractorStyle, vtkInteractorStyleUser, vtkInteractorStyleRubberBand2D, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 232 of file vtkInteractorStyle.h.

OnFourthButtonDown()

virtual void vtkInteractorStyle::OnFourthButtonDown ( )

inlinevirtual

Definition at line 233 of file vtkInteractorStyle.h.

OnFourthButtonUp()

virtual void vtkInteractorStyle::OnFourthButtonUp ( )

inlinevirtual

Definition at line 234 of file vtkInteractorStyle.h.

OnFifthButtonDown()

virtual void vtkInteractorStyle::OnFifthButtonDown ( )

inlinevirtual

Definition at line 235 of file vtkInteractorStyle.h.

OnFifthButtonUp()

virtual void vtkInteractorStyle::OnFifthButtonUp ( )

inlinevirtual

Definition at line 236 of file vtkInteractorStyle.h.

OnMove3D()

virtual void vtkInteractorStyle::OnMove3D ( vtkEventData *  )

inlinevirtual

Generic 3D event bindings can be overridden in subclasses.

Reimplemented in vtkOpenVRInteractorStyle.

Definition at line 241 of file vtkInteractorStyle.h.

OnButton3D()

virtual void vtkInteractorStyle::OnButton3D ( vtkEventData *  )

inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle.

Definition at line 242 of file vtkInteractorStyle.h.

OnChar()

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.

OnKeyDown()

virtual void vtkInteractorStyle::OnKeyDown ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight.

Definition at line 253 of file vtkInteractorStyle.h.

OnKeyUp()

virtual void vtkInteractorStyle::OnKeyUp ( )

inlinevirtual

Reimplemented in vtkInteractorStyleFlight.

Definition at line 258 of file vtkInteractorStyle.h.

OnKeyPress()

virtual void vtkInteractorStyle::OnKeyPress ( )

inlinevirtual

Reimplemented in vtkContextInteractorStyle, vtkInteractorStyleUser, and vtkOSPRayTestInteractor.

Definition at line 263 of file vtkInteractorStyle.h.

OnKeyRelease()

virtual void vtkInteractorStyle::OnKeyRelease ( )

inlinevirtual

Reimplemented in vtkContextInteractorStyle, and vtkInteractorStyleUser.

Definition at line 268 of file vtkInteractorStyle.h.

OnExpose()

virtual void vtkInteractorStyle::OnExpose ( )

inlinevirtual

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

Reimplemented in vtkInteractorStyleUser.

Definition at line 273 of file vtkInteractorStyle.h.

OnConfigure()

virtual void vtkInteractorStyle::OnConfigure ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUser.

Definition at line 274 of file vtkInteractorStyle.h.

OnEnter()

virtual void vtkInteractorStyle::OnEnter ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUser.

Definition at line 275 of file vtkInteractorStyle.h.

OnLeave()

virtual void vtkInteractorStyle::OnLeave ( )

inlinevirtual

Reimplemented in vtkInteractorStyleUser, and vtkParallelCoordinatesInteractorStyle.

Definition at line 276 of file vtkInteractorStyle.h.

OnTimer()

virtual void vtkInteractorStyle::OnTimer ( )

virtual

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

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUser, and vtkInteractorStyleUnicam.

Rotate()

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, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, and vtkInteractorStyleTrackballCamera.

Definition at line 290 of file vtkInteractorStyle.h.

Spin()

virtual void vtkInteractorStyle::Spin ( )

inlinevirtual

Reimplemented in vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleJoystickCamera, and vtkInteractorStyleTrackballCamera.

Definition at line 291 of file vtkInteractorStyle.h.

Pan()

virtual void vtkInteractorStyle::Pan ( )

inlinevirtual

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

Definition at line 292 of file vtkInteractorStyle.h.

Dolly()

virtual void vtkInteractorStyle::Dolly ( )

inlinevirtual

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

Definition at line 293 of file vtkInteractorStyle.h.

Zoom()

virtual void vtkInteractorStyle::Zoom ( )

inlinevirtual

Reimplemented in vtkParallelCoordinatesInteractorStyle, and vtkInteractorStyleRubberBandZoom.

Definition at line 294 of file vtkInteractorStyle.h.

UniformScale()

virtual void vtkInteractorStyle::UniformScale ( )

inlinevirtual

Reimplemented in vtkInteractorStyleJoystickActor, and vtkInteractorStyleTrackballActor.

Definition at line 295 of file vtkInteractorStyle.h.

OnStartSwipe()

virtual void vtkInteractorStyle::OnStartSwipe ( )

inlinevirtual

gesture based events

Definition at line 300 of file vtkInteractorStyle.h.

OnSwipe()

virtual void vtkInteractorStyle::OnSwipe ( )

inlinevirtual

Definition at line 301 of file vtkInteractorStyle.h.

OnEndSwipe()

virtual void vtkInteractorStyle::OnEndSwipe ( )

inlinevirtual

Definition at line 302 of file vtkInteractorStyle.h.

OnStartPinch()

virtual void vtkInteractorStyle::OnStartPinch ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 303 of file vtkInteractorStyle.h.

OnPinch()

virtual void vtkInteractorStyle::OnPinch ( )

inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 304 of file vtkInteractorStyle.h.

OnEndPinch()

virtual void vtkInteractorStyle::OnEndPinch ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 305 of file vtkInteractorStyle.h.

OnStartRotate()

virtual void vtkInteractorStyle::OnStartRotate ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 306 of file vtkInteractorStyle.h.

OnRotate()

virtual void vtkInteractorStyle::OnRotate ( )

inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 307 of file vtkInteractorStyle.h.

OnEndRotate()

virtual void vtkInteractorStyle::OnEndRotate ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 308 of file vtkInteractorStyle.h.

OnStartPan()

virtual void vtkInteractorStyle::OnStartPan ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 309 of file vtkInteractorStyle.h.

OnPan()

virtual void vtkInteractorStyle::OnPan ( )

inlinevirtual

Reimplemented in vtkOpenVRInteractorStyle, and vtkInteractorStyleMultiTouchCamera.

Definition at line 310 of file vtkInteractorStyle.h.

OnEndPan()

virtual void vtkInteractorStyle::OnEndPan ( )

inlinevirtual

Reimplemented in vtkInteractorStyleMultiTouchCamera.

Definition at line 311 of file vtkInteractorStyle.h.

OnTap()

virtual void vtkInteractorStyle::OnTap ( )

inlinevirtual

Definition at line 312 of file vtkInteractorStyle.h.

OnLongTap()

virtual void vtkInteractorStyle::OnLongTap ( )

inlinevirtual

Definition at line 313 of file vtkInteractorStyle.h.

StartState()

virtual void vtkInteractorStyle::StartState ( int  newstate )

virtual

utility routines used by state changes

StopState()

virtual void vtkInteractorStyle::StopState ( )

virtual

StartAnimate()

virtual void vtkInteractorStyle::StartAnimate ( )

virtual

Interaction mode entry points used internally.

StopAnimate()

virtual void vtkInteractorStyle::StopAnimate ( )

virtual

StartRotate()

virtual void vtkInteractorStyle::StartRotate ( )

virtual

EndRotate()

virtual void vtkInteractorStyle::EndRotate ( )

virtual

StartZoom()

virtual void vtkInteractorStyle::StartZoom ( )

virtual

Reimplemented in vtkParallelCoordinatesInteractorStyle.

EndZoom()

virtual void vtkInteractorStyle::EndZoom ( )

virtual

Reimplemented in vtkParallelCoordinatesInteractorStyle.

StartPan()

virtual void vtkInteractorStyle::StartPan ( )

virtual

Reimplemented in vtkParallelCoordinatesInteractorStyle.

EndPan()

virtual void vtkInteractorStyle::EndPan ( )

virtual

Reimplemented in vtkParallelCoordinatesInteractorStyle.

StartSpin()

virtual void vtkInteractorStyle::StartSpin ( )

virtual

EndSpin()

virtual void vtkInteractorStyle::EndSpin ( )

virtual

StartDolly()

virtual void vtkInteractorStyle::StartDolly ( )

virtual

EndDolly()

virtual void vtkInteractorStyle::EndDolly ( )

virtual

StartUniformScale()

virtual void vtkInteractorStyle::StartUniformScale ( )

virtual

EndUniformScale()

virtual void vtkInteractorStyle::EndUniformScale ( )

virtual

StartTimer()

virtual void vtkInteractorStyle::StartTimer ( )

virtual

EndTimer()

virtual void vtkInteractorStyle::EndTimer ( )

virtual

StartTwoPointer()

virtual void vtkInteractorStyle::StartTwoPointer ( )

virtual

EndTwoPointer()

virtual void vtkInteractorStyle::EndTwoPointer ( )

virtual

StartGesture()

virtual void vtkInteractorStyle::StartGesture ( )

virtual

EndGesture()

virtual void vtkInteractorStyle::EndGesture ( )

virtual

HighlightProp()

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.

HighlightActor2D()

virtual void vtkInteractorStyle::HighlightActor2D ( vtkActor2D *  actor2D )

virtual

HighlightProp3D()

virtual void vtkInteractorStyle::HighlightProp3D ( vtkProp3D *  prop3D )

virtual

SetPickColor() [1/2]

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

SetPickColor() [2/2]

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

virtual

GetPickColor() [1/2]

virtual double* vtkInteractorStyle::GetPickColor ( )

virtual

GetPickColor() [2/2]

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

virtual

SetMouseWheelMotionFactor()

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.

GetMouseWheelMotionFactor()

virtual double vtkInteractorStyle::GetMouseWheelMotionFactor ( )

virtual

GetTDxStyle()

virtual vtkTDxInteractorStyle* vtkInteractorStyle::GetTDxStyle ( )

virtual

3Dconnexion device interactor style.

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

SetTDxStyle()

virtual void vtkInteractorStyle::SetTDxStyle ( vtkTDxInteractorStyle *  tdxStyle )

virtual

DelegateTDxEvent()

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

Called by the callback to process 3DConnexion device events.

ProcessEvents()

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

staticprotected

Main process event method.

Member Data Documentation

State

int vtkInteractorStyle::State

protected

Definition at line 405 of file vtkInteractorStyle.h.

AnimState

int vtkInteractorStyle::AnimState

protected

Definition at line 406 of file vtkInteractorStyle.h.

HandleObservers

vtkTypeBool vtkInteractorStyle::HandleObservers

protected

Definition at line 409 of file vtkInteractorStyle.h.

UseTimers

vtkTypeBool vtkInteractorStyle::UseTimers

protected

Definition at line 410 of file vtkInteractorStyle.h.

TimerId

int vtkInteractorStyle::TimerId

protected

Definition at line 411 of file vtkInteractorStyle.h.

AutoAdjustCameraClippingRange

vtkTypeBool vtkInteractorStyle::AutoAdjustCameraClippingRange

protected

Definition at line 413 of file vtkInteractorStyle.h.

Outline

vtkOutlineSource* vtkInteractorStyle::Outline

protected

Definition at line 416 of file vtkInteractorStyle.h.

OutlineMapper

vtkPolyDataMapper* vtkInteractorStyle::OutlineMapper

protected

Definition at line 417 of file vtkInteractorStyle.h.

OutlineActor

vtkActor* vtkInteractorStyle::OutlineActor

protected

Definition at line 418 of file vtkInteractorStyle.h.

PickedRenderer

vtkRenderer* vtkInteractorStyle::PickedRenderer

protected

Definition at line 419 of file vtkInteractorStyle.h.

CurrentProp

vtkProp* vtkInteractorStyle::CurrentProp

protected

Definition at line 420 of file vtkInteractorStyle.h.

PickedActor2D

vtkActor2D* vtkInteractorStyle::PickedActor2D

protected

Definition at line 421 of file vtkInteractorStyle.h.

PropPicked

int vtkInteractorStyle::PropPicked

protected

Definition at line 422 of file vtkInteractorStyle.h.

PickColor

double vtkInteractorStyle::PickColor[3]

protected

Definition at line 423 of file vtkInteractorStyle.h.

MouseWheelMotionFactor

double vtkInteractorStyle::MouseWheelMotionFactor

protected

Definition at line 424 of file vtkInteractorStyle.h.

TimerDuration

unsigned long vtkInteractorStyle::TimerDuration

protected

Definition at line 427 of file vtkInteractorStyle.h.

EventForwarder

vtkEventForwarderCommand* vtkInteractorStyle::EventForwarder

protected

Definition at line 430 of file vtkInteractorStyle.h.

TDxStyle

vtkTDxInteractorStyle* vtkInteractorStyle::TDxStyle

protected

Definition at line 432 of file vtkInteractorStyle.h.

---

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

• dox/Rendering/Core/vtkInteractorStyle.h