vtkInteractorStyleUser Class Reference

provides customizable interaction routines More...

#include <vtkInteractorStyleUser.h>

Inheritance diagram for vtkInteractorStyleUser:

Collaboration diagram for vtkInteractorStyleUser:

Public Types
typedef vtkInteractorStyle	Superclass
Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnTimer ()
virtual int *	GetLastPos ()
virtual void	GetLastPos (int &, int &)
virtual void	GetLastPos (int[2])
virtual int *	GetOldPos ()
virtual void	GetOldPos (int &, int &)
virtual void	GetOldPos (int[2])
virtual int	GetShiftKey ()
virtual int	GetCtrlKey ()
virtual int	GetChar ()
virtual char *	GetKeySym ()
virtual int	GetButton ()
virtual void	OnMouseMove ()
virtual void	OnLeftButtonDown ()
virtual void	OnLeftButtonUp ()
virtual void	OnMiddleButtonDown ()
virtual void	OnMiddleButtonUp ()
virtual void	OnRightButtonDown ()
virtual void	OnRightButtonUp ()
virtual void	OnChar ()
virtual void	OnKeyPress ()
virtual void	OnKeyRelease ()
virtual void	OnExpose ()
virtual void	OnConfigure ()
virtual void	OnEnter ()
virtual void	OnLeave ()
Public Member Functions inherited from vtkInteractorStyle
virtual void	SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void	SetEnabled (int)
void	FindPokedRenderer (int, int)
virtual void	OnKeyDown ()
virtual void	OnKeyUp ()
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	OnMouseWheelForward ()
virtual void	OnMouseWheelBackward ()
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 ()
virtual vtkTDxInteractorStyle *	GetTDxStyle ()
virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void	DelegateTDxEvent (unsigned long event, void *calldata)
Public Member Functions inherited from vtkInteractorObserver
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkInteractorStyleUser *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleUser *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyle *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObject *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObject *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
	vtkInteractorStyleUser ()
	~vtkInteractorStyleUser ()
Protected Member Functions inherited from vtkInteractorStyle
	vtkInteractorStyle ()
	~vtkInteractorStyle ()
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
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
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
vtkTDxInteractorStyle *	TDxStyle
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	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)
Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

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 Tcl and 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().

Events:

vtkCommand::KeyReleaseEvent vtkCommand::UserEvent vtkCommand::LeaveEvent vtkCommand::RightButtonPressEvent vtkCommand::MiddleButtonPressEvent vtkCommand::LeftButtonPressEvent vtkCommand::ConfigureEvent vtkCommand::TimerEvent vtkCommand::CharEvent vtkCommand::EnterEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::ExposeEvent vtkCommand::MouseMoveEvent vtkCommand::KeyPressEvent vtkCommand::RightButtonReleaseEvent

Examples:

vtkInteractorStyleUser (Examples)

Definition at line 46 of file vtkInteractorStyleUser.h.

Member Typedef Documentation

typedef vtkInteractorStyle vtkInteractorStyleUser::Superclass

Definition at line 50 of file vtkInteractorStyleUser.h.

Constructor & Destructor Documentation

vtkInteractorStyleUser::vtkInteractorStyleUser ( )

protected

vtkInteractorStyleUser::~vtkInteractorStyleUser ( )

protected

Member Function Documentation

static vtkInteractorStyleUser* vtkInteractorStyleUser::New ( )

static

virtual const char* vtkInteractorStyleUser::GetClassName ( )

virtual

Reimplemented from vtkInteractorStyle.

static int vtkInteractorStyleUser::IsTypeOf ( const char *  type )

static

virtual int 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 ( vtkObject *  o )

static

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

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

virtual void vtkInteractorStyleUser::OnMouseMove ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnLeftButtonDown ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnLeftButtonUp ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnMiddleButtonDown ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnMiddleButtonUp ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnRightButtonDown ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnRightButtonUp ( )

virtual

Generic event bindings

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnChar ( )

virtual

Keyboard functions

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnKeyPress ( )

virtual

Keyboard functions

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnKeyRelease ( )

virtual

Keyboard functions

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnExpose ( )

virtual

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

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnConfigure ( )

virtual

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

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnEnter ( )

virtual

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

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnLeave ( )

virtual

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

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleUser::OnTimer ( )

virtual

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 125 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::OldPos[2]

protected

Definition at line 126 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::ShiftKey

protected

Definition at line 128 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::CtrlKey

protected

Definition at line 129 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::Char

protected

Definition at line 130 of file vtkInteractorStyleUser.h.

char* vtkInteractorStyleUser::KeySym

protected

Definition at line 131 of file vtkInteractorStyleUser.h.

int vtkInteractorStyleUser::Button

protected

Definition at line 132 of file vtkInteractorStyleUser.h.

---

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

• dox/Rendering/vtkInteractorStyleUser.h