vtkInteractorStyle Class Reference

#include <vtkInteractorStyle.h>

Inheritance diagram for vtkInteractorStyle:

[legend]

Collaboration diagram for vtkInteractorStyle:

[legend]

List of all members.

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

Examples:: vtkInteractorStyle (Examples)

Definition at line 129 of file vtkInteractorStyle.h.


Public Types
typedef vtkInteractorObserver	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void	SetEnabled (int)
void	FindPokedRenderer (int, int)
virtual void	OnTimer ()

virtual void	SetAutoAdjustCameraClippingRange (int)
virtual int	GetAutoAdjustCameraClippingRange ()
virtual void	AutoAdjustCameraClippingRangeOn ()
virtual void	AutoAdjustCameraClippingRangeOff ()

virtual int	GetState ()

virtual int	GetUseTimers ()
virtual void	SetUseTimers (int)
virtual void	UseTimersOn ()
virtual void	UseTimersOff ()

virtual void	SetTimerDuration (unsigned long)
virtual unsigned long	GetTimerDuration ()

virtual void	SetHandleObservers (int)
virtual int	GetHandleObservers ()
virtual void	HandleObserversOn ()
virtual void	HandleObserversOff ()

virtual void	OnMouseMove ()
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	OnChar ()
virtual void	OnKeyDown ()
virtual void	OnKeyUp ()
virtual void	OnKeyPress ()
virtual void	OnKeyRelease ()

virtual void	OnExpose ()
virtual void	OnConfigure ()
virtual void	OnEnter ()
virtual void	OnLeave ()

virtual void	Rotate ()
virtual void	Spin ()
virtual void	Pan ()
virtual void	Dolly ()
virtual void	Zoom ()
virtual void	UniformScale ()

virtual void	StartState (int newstate)
virtual void	StopState ()

virtual void	StartAnimate ()
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	HighlightProp (vtkProp *prop)
virtual void	HighlightActor2D (vtkActor2D *actor2D)
virtual void	HighlightProp3D (vtkProp3D *prop3D)

virtual void	SetPickColor (double, double, double)
virtual void	SetPickColor (double[3])
virtual double *	GetPickColor ()
virtual void	GetPickColor (double data[3])

virtual void	SetMouseWheelMotionFactor (double)
virtual double	GetMouseWheelMotionFactor ()
Static Public Member Functions
static vtkInteractorStyle *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyle *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkInteractorStyle ()
	~vtkInteractorStyle ()
Static Protected Member Functions

static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
Protected Attributes
int	State
int	AnimState
int	HandleObservers
int	UseTimers
int	TimerId
int	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

Member Typedef Documentation

Constructor & Destructor Documentation

vtkInteractorStyle::vtkInteractorStyle ( ) [protected]

vtkInteractorStyle::~vtkInteractorStyle ( ) [protected]

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.

Reimplemented from vtkObject.

virtual const char* vtkInteractorStyle::GetClassName ( ) [virtual]

Reimplemented from vtkInteractorObserver.

static int vtkInteractorStyle::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorObserver.

virtual int 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorObserver.

static vtkInteractorStyle* vtkInteractorStyle::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkInteractorObserver.

void vtkInteractorStyle::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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.

virtual void vtkInteractorStyle::SetInteractor ( vtkRenderWindowInteractor * interactor ) [virtual]

Set/Get the Interactor wrapper being controlled by this object. (Satisfy superclass API.)

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkInteractorStyleTreeMapHover, and vtkInteractorStyleSwitch.

virtual void vtkInteractorStyle::SetEnabled ( int ) [virtual]

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 ( int ) [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 int 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 int vtkInteractorStyle::GetUseTimers ( ) [virtual]

Set/Get timer hint

virtual void vtkInteractorStyle::SetUseTimers ( int ) [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 ( int ) [virtual]

Does ProcessEvents handle observers on this class or not

virtual int 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 ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 198 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnLeftButtonDown ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 199 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnLeftButtonUp ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 200 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnMiddleButtonDown ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 201 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnMiddleButtonUp ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 202 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnRightButtonDown ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 203 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnRightButtonUp ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

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

Definition at line 204 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnMouseWheelForward ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

Reimplemented in vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 205 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnMouseWheelBackward ( ) [inline, virtual]

Generic event bindings must be overridden in subclasses

Reimplemented in vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBand2D, vtkInteractorStyleRubberBand3D, and vtkInteractorStyleTrackballCamera.

Definition at line 206 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnChar ( ) [virtual]

OnChar implements keyboard functions, but subclasses can override this behavior

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleRubberBandPick, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, and vtkInteractorStyleUser.

virtual void vtkInteractorStyle::OnKeyDown ( ) [inline, virtual]

OnChar implements keyboard functions, but subclasses can override this behavior

Reimplemented in vtkInteractorStyleFlight.

Definition at line 213 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnKeyUp ( ) [inline, virtual]

OnChar implements keyboard functions, but subclasses can override this behavior

Reimplemented in vtkInteractorStyleFlight.

Definition at line 214 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnKeyPress ( ) [inline, virtual]

OnChar implements keyboard functions, but subclasses can override this behavior

Reimplemented in vtkInteractorStyleUser.

Definition at line 215 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnKeyRelease ( ) [inline, virtual]

OnChar implements keyboard functions, but subclasses can override this behavior

Reimplemented in vtkInteractorStyleUser.

Definition at line 216 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnExpose ( ) [inline, virtual]

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

Reimplemented in vtkInteractorStyleUser.

Definition at line 221 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnConfigure ( ) [inline, virtual]

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

Reimplemented in vtkInteractorStyleUser.

Definition at line 222 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnEnter ( ) [inline, virtual]

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

Reimplemented in vtkInteractorStyleUser.

Definition at line 223 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnLeave ( ) [inline, virtual]

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

Reimplemented in vtkInteractorStyleUser.

Definition at line 224 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::OnTimer ( ) [virtual]

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

Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleUnicam, and vtkInteractorStyleUser.

virtual void vtkInteractorStyle::Rotate ( ) [inline, virtual]

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

Definition at line 236 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::Spin ( ) [inline, virtual]

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

Definition at line 237 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::Pan ( ) [inline, virtual]

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

Definition at line 238 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::Dolly ( ) [inline, virtual]

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

Definition at line 239 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::Zoom ( ) [inline, virtual]

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

Definition at line 240 of file vtkInteractorStyle.h.

virtual void vtkInteractorStyle::UniformScale ( ) [inline, virtual]

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

Definition at line 241 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]