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.
- 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
- Events:
- vtkCommand::KeyPressEvent vtkCommand::ConfigureEvent vtkCommand::EnableEvent vtkCommand::MouseWheelBackwardEvent vtkCommand::KeyReleaseEvent vtkCommand::MiddleButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::EnterEvent vtkCommand::RightButtonPressEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::CharEvent vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::MouseMoveEvent vtkCommand::MouseWheelForwardEvent vtkCommand::ExposeEvent vtkCommand::TimerEvent vtkCommand::LeftButtonPressEvent vtkCommand::LeaveEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeftButtonReleaseEvent
- Created by:
-
- CVS contributions (if > 5%):
- Martin, Ken (32%)
- Barre, Sebastien (32%)
- Schroeder, Will (11%)
- Hoffman, Bill (7%)
- King, Brad (5%)
- CVS logs (CVSweb):
/Rendering/vtkInteractorStyle.cxx)/Rendering/vtkInteractorStyle.h)
Definition at line 135 of file vtkInteractorStyle.h.
Member Typedef Documentation
|
|
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser.
Definition at line 143 of file vtkInteractorStyle.h. |
Constructor & Destructor Documentation
| vtkInteractorStyle::vtkInteractorStyle |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. This class should not normally be instantiated by application programmers.
Reimplemented from vtkObject.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
| virtual const char* vtkInteractorStyle::GetClassName |
( |
|
) |
[virtual] |
|
|
|
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
| int vtkInteractorStyle::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 vtkInteractorObserver.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
| virtual int vtkInteractorStyle::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 vtkInteractorObserver.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
|
|
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
| 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.
Reimplemented in vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleJoystickActor, vtkInteractorStyleJoystickCamera, vtkInteractorStyleRubberBandZoom, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleTrackball, vtkInteractorStyleTrackballActor, vtkInteractorStyleTrackballCamera, vtkInteractorStyleUnicam, and vtkInteractorStyleUser. |
| 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] |
|
| virtual void vtkInteractorStyle::SetUseTimers |
( |
int |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyle::UseTimersOn |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyle::UseTimersOff |
( |
|
) |
[virtual] |
|
| 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] |
|
| virtual void vtkInteractorStyle::OnLeftButtonDown |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnLeftButtonUp |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnMiddleButtonDown |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnMiddleButtonUp |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnRightButtonDown |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnRightButtonUp |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnMouseWheelForward |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnMouseWheelBackward |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnChar |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyle::OnKeyDown |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnKeyUp |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnKeyPress |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnKeyRelease |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnExpose |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnConfigure |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnEnter |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnLeave |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::OnTimer |
( |
|
) |
[virtual] |
|
| virtual void vtkInteractorStyle::Rotate |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::Spin |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::Pan |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkInteractorStyle::Dolly |
( |
|
) |
[inline, virtual] |
|
| 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 237 of file vtkInteractorStyle.h. |
| virtual void vtkInteractorStyle::UniformScale |
( |
|
) |
[inline, virtual] |
|
| 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] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StopAnimate |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartRotate |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndRotate |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartZoom |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndZoom |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartPan |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndPan |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartSpin |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndSpin |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartDolly |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndDolly |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartUniformScale |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndUniformScale |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::StartTimer |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| virtual void vtkInteractorStyle::EndTimer |
( |
|
) |
[virtual] |
|
|
|
Interaction mode entry points used internally. |
| 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. |
| virtual void vtkInteractorStyle::HighlightActor2D |
( |
vtkActor2D * |
actor2D |
) |
[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. |
| virtual void vtkInteractorStyle::HighlightProp3D |
( |
vtkProp3D * |
prop3D |
) |
[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. |
| 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). |
| virtual void vtkInteractorStyle::SetPickColor |
( |
double |
[3] |
) |
[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). |
| virtual double* vtkInteractorStyle::GetPickColor |
( |
|
) |
[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). |
| virtual void vtkInteractorStyle::GetPickColor |
( |
double |
data[3] |
) |
[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). |
| 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. |
| virtual double vtkInteractorStyle::GetMouseWheelMotionFactor |
( |
|
) |
[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. |
| void vtkInteractorStyle::ProcessEvents |
( |
vtkObject * |
object, |
|
|
unsigned long |
event, |
|
|
void * |
clientdata, |
|
|
void * |
calldata |
|
) |
[static, protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: