vtkInteractorStyleUser Class Reference

#include <vtkInteractorStyleUser.h>

Inheritance diagram for vtkInteractorStyleUser:

[legend]

Collaboration diagram for vtkInteractorStyleUser:

[legend]

List of all members.

---

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::KeyPressEvent vtkCommand::ConfigureEvent vtkCommand::MiddleButtonPressEvent vtkCommand::KeyReleaseEvent vtkCommand::UserEvent vtkCommand::EnterEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::RightButtonPressEvent vtkCommand::CharEvent vtkCommand::MouseMoveEvent vtkCommand::ExposeEvent vtkCommand::TimerEvent vtkCommand::LeftButtonPressEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeaveEvent vtkCommand::LeftButtonReleaseEvent

Examples:

vtkInteractorStyleUser (Examples)

Definition at line 46 of file vtkInteractorStyleUser.h.

Public Types
typedef vtkInteractorStyle	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 ()
Static Public Member Functions
static vtkInteractorStyleUser *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleUser *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkInteractorStyleUser ()
	~vtkInteractorStyleUser ()
Protected Attributes
int	LastPos [2]
int	OldPos [2]
int	ShiftKey
int	CtrlKey
int	Char
char *	KeySym
int	Button

---

Member Typedef Documentation

typedef vtkInteractorStyle vtkInteractorStyleUser::Superclass

Reimplemented from vtkInteractorStyle.

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]

This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. This class should not normally be instantiated by application programmers.

Reimplemented from vtkInteractorStyle.

virtual const char* vtkInteractorStyleUser::GetClassName

(

)

[virtual]

Reimplemented from vtkInteractorStyle.

static int vtkInteractorStyleUser::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

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]

Reimplemented from vtkInteractorStyle.

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