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
- Created by:
-
- CVS contributions (if > 5%):
- Gobbi, David (51%)
- King, Brad (17%)
- Martin, Ken (17%)
- Barre, Sebastien (12%)
- CVS logs (CVSweb):
/Rendering/vtkInteractorStyleUser.h)/Rendering/vtkInteractorStyleUser.cxx)
- Examples:
- vtkInteractorStyleUser (Examples)
Definition at line 59 of file vtkInteractorStyleUser.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkInteractorStyleUser::vtkInteractorStyleUser |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkInteractorStyleUser::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkInteractorStyleUser::IsTypeOf |
( |
const char * |
type |
) |
[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 vtkInteractorStyle. |
| virtual int vtkInteractorStyleUser::IsA |
( |
const char * |
type |
) |
[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 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] |
|
| virtual void vtkInteractorStyleUser::OnLeftButtonDown |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnLeftButtonUp |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnMiddleButtonDown |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnMiddleButtonUp |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnRightButtonDown |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnRightButtonUp |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnChar |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnKeyPress |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyleUser::OnKeyRelease |
( |
|
) |
[virtual] |
|
| 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
The documentation for this class was generated from the following file: