VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInteractorStyleImage Class Reference

interactive manipulation of the camera specialized for images More...

#include <vtkInteractorStyleImage.h>

Inheritance diagram for vtkInteractorStyleImage:
[legend]
Collaboration diagram for vtkInteractorStyleImage:
[legend]

Public Types

typedef
vtkInteractorStyleTrackballCamera 
Superclass
 
- Public Types inherited from vtkInteractorStyleTrackballCamera
typedef vtkInteractorStyle Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkInteractorStyleImageNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void OnChar ()
 
virtual void WindowLevel ()
 
virtual void Pick ()
 
virtual void Slice ()
 
virtual void StartWindowLevel ()
 
virtual void EndWindowLevel ()
 
virtual void StartPick ()
 
virtual void EndPick ()
 
virtual void StartSlice ()
 
virtual void EndSlice ()
 
virtual int * GetWindowLevelStartPosition ()
 
virtual void GetWindowLevelStartPosition (int &, int &)
 
virtual void GetWindowLevelStartPosition (int[2])
 
virtual int * GetWindowLevelCurrentPosition ()
 
virtual void GetWindowLevelCurrentPosition (int &, int &)
 
virtual void GetWindowLevelCurrentPosition (int[2])
 
virtual void OnMouseMove ()
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnMiddleButtonDown ()
 
virtual void OnMiddleButtonUp ()
 
virtual void OnRightButtonDown ()
 
virtual void OnRightButtonUp ()
 
virtual void SetInteractionMode (int)
 
virtual int GetInteractionMode ()
 
void SetInteractionModeToImage2D ()
 
void SetInteractionModeToImage3D ()
 
void SetInteractionModeToImageSlicing ()
 
virtual void SetXViewRightVector (double, double, double)
 
virtual void SetXViewRightVector (double[3])
 
virtual double * GetXViewRightVector ()
 
virtual void GetXViewRightVector (double &, double &, double &)
 
virtual void GetXViewRightVector (double[3])
 
virtual void SetXViewUpVector (double, double, double)
 
virtual void SetXViewUpVector (double[3])
 
virtual double * GetXViewUpVector ()
 
virtual void GetXViewUpVector (double &, double &, double &)
 
virtual void GetXViewUpVector (double[3])
 
virtual void SetYViewRightVector (double, double, double)
 
virtual void SetYViewRightVector (double[3])
 
virtual double * GetYViewRightVector ()
 
virtual void GetYViewRightVector (double &, double &, double &)
 
virtual void GetYViewRightVector (double[3])
 
virtual void SetYViewUpVector (double, double, double)
 
virtual void SetYViewUpVector (double[3])
 
virtual double * GetYViewUpVector ()
 
virtual void GetYViewUpVector (double &, double &, double &)
 
virtual void GetYViewUpVector (double[3])
 
virtual void SetZViewRightVector (double, double, double)
 
virtual void SetZViewRightVector (double[3])
 
virtual double * GetZViewRightVector ()
 
virtual void GetZViewRightVector (double &, double &, double &)
 
virtual void GetZViewRightVector (double[3])
 
virtual void SetZViewUpVector (double, double, double)
 
virtual void SetZViewUpVector (double[3])
 
virtual double * GetZViewUpVector ()
 
virtual void GetZViewUpVector (double &, double &, double &)
 
virtual void GetZViewUpVector (double[3])
 
void SetImageOrientation (const double leftToRight[3], const double bottomToTop[3])
 
vtkImageProperty * GetCurrentImageProperty ()
 
- Public Member Functions inherited from vtkInteractorStyleTrackballCamera
vtkInteractorStyleTrackballCameraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Rotate ()
 
virtual void Spin ()
 
virtual void Pan ()
 
virtual void Dolly ()
 
virtual void OnMouseWheelForward ()
 
virtual void OnMouseWheelBackward ()
 
virtual void SetMotionFactor (double)
 
virtual double GetMotionFactor ()
 

Static Public Member Functions

static vtkInteractorStyleImageNew ()
 
static int IsTypeOf (const char *type)
 
static vtkInteractorStyleImageSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorStyleTrackballCamera
static
vtkInteractorStyleTrackballCamera
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkInteractorStyleTrackballCamera
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkInteractorStyleImage ()
 
 ~vtkInteractorStyleImage ()
 
void SetCurrentImageToNthImage (int i)
 
- Protected Member Functions inherited from vtkInteractorStyleTrackballCamera
 vtkInteractorStyleTrackballCamera ()
 
 ~vtkInteractorStyleTrackballCamera ()
 
virtual void Dolly (double factor)
 

Protected Attributes

int WindowLevelStartPosition [2]
 
int WindowLevelCurrentPosition [2]
 
double WindowLevelInitial [2]
 
vtkImageProperty * CurrentImageProperty
 
int InteractionMode
 
double XViewRightVector [3]
 
double XViewUpVector [3]
 
double YViewRightVector [3]
 
double YViewUpVector [3]
 
double ZViewRightVector [3]
 
double ZViewUpVector [3]
 
- Protected Attributes inherited from vtkInteractorStyleTrackballCamera
double MotionFactor
 

Detailed Description

interactive manipulation of the camera specialized for images

vtkInteractorStyleImage allows the user to interactively manipulate (rotate, pan, zoom etc.) the camera. vtkInteractorStyleImage is specially designed to work with images that are being rendered with vtkImageActor. Several events are overloaded from its superclass vtkInteractorStyle, hence the mouse bindings are different. (The bindings keep the camera's view plane normal perpendicular to the x-y plane.) In summary the mouse events for 2D image interaction are as follows:

If SetInteractionModeToImageSlicing() is called, then some of the mouse events are changed as follows:

If SetInteractionModeToImage3D() is called, then some of the mouse events are changed as follows:

In all modes, the following key bindings are in effect:

Note that the renderer's actors are not moved; instead the camera is moved.

See Also
vtkInteractorStyle vtkInteractorStyleTrackballActor vtkInteractorStyleJoystickCamera vtkInteractorStyleJoystickActor
Events:
vtkCommand::PickEvent vtkCommand::StartPickEvent vtkCommand::WindowLevelEvent vtkCommand::EndPickEvent vtkCommand::StartWindowLevelEvent vtkCommand::ResetWindowLevelEvent vtkCommand::InteractionEvent vtkCommand::EndWindowLevelEvent
Examples:
vtkInteractorStyleImage (Examples)
Tests:
vtkInteractorStyleImage (Tests)

Definition at line 87 of file vtkInteractorStyleImage.h.

Member Typedef Documentation

Definition at line 91 of file vtkInteractorStyleImage.h.

Constructor & Destructor Documentation

vtkInteractorStyleImage::vtkInteractorStyleImage ( )
protected
vtkInteractorStyleImage::~vtkInteractorStyleImage ( )
protected

Member Function Documentation

static vtkInteractorStyleImage* vtkInteractorStyleImage::New ( )
static
static int vtkInteractorStyleImage::IsTypeOf ( const char *  type)
static
virtual int vtkInteractorStyleImage::IsA ( const char *  type)
virtual
static vtkInteractorStyleImage* vtkInteractorStyleImage::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkInteractorStyleImage::NewInstanceInternal ( ) const
protectedvirtual
vtkInteractorStyleImage* vtkInteractorStyleImage::NewInstance ( ) const
void vtkInteractorStyleImage::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int* vtkInteractorStyleImage::GetWindowLevelStartPosition ( )
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelStartPosition ( int &  ,
int &   
)
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelStartPosition ( int  [2])
virtual

Some useful information for handling window level

virtual int* vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( )
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( int &  ,
int &   
)
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( int  [2])
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::OnMouseMove ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual void vtkInteractorStyleImage::OnLeftButtonDown ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnLeftButtonUp ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual void vtkInteractorStyleImage::OnMiddleButtonDown ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnMiddleButtonUp ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnRightButtonDown ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnRightButtonUp ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnChar ( )
virtual

Override the "fly-to" (f keypress) for images.

virtual void vtkInteractorStyleImage::WindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::Pick ( )
virtual
virtual void vtkInteractorStyleImage::Slice ( )
virtual
virtual void vtkInteractorStyleImage::StartWindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::EndWindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::StartPick ( )
virtual
virtual void vtkInteractorStyleImage::EndPick ( )
virtual
virtual void vtkInteractorStyleImage::StartSlice ( )
virtual
virtual void vtkInteractorStyleImage::EndSlice ( )
virtual
virtual void vtkInteractorStyleImage::SetInteractionMode ( int  )
virtual

Set/Get current mode to 2D or 3D. The default is 2D. In 3D mode, it is possible to rotate the camera to view oblique slices. In Slicing mode, it is possible to slice through the data, but not to generate oblique views by rotating the camera.

virtual int vtkInteractorStyleImage::GetInteractionMode ( )
virtual

Set/Get current mode to 2D or 3D. The default is 2D. In 3D mode, it is possible to rotate the camera to view oblique slices. In Slicing mode, it is possible to slice through the data, but not to generate oblique views by rotating the camera.

void vtkInteractorStyleImage::SetInteractionModeToImage2D ( )
inline

Set/Get current mode to 2D or 3D. The default is 2D. In 3D mode, it is possible to rotate the camera to view oblique slices. In Slicing mode, it is possible to slice through the data, but not to generate oblique views by rotating the camera.

Definition at line 138 of file vtkInteractorStyleImage.h.

void vtkInteractorStyleImage::SetInteractionModeToImage3D ( )
inline

Set/Get current mode to 2D or 3D. The default is 2D. In 3D mode, it is possible to rotate the camera to view oblique slices. In Slicing mode, it is possible to slice through the data, but not to generate oblique views by rotating the camera.

Definition at line 140 of file vtkInteractorStyleImage.h.

void vtkInteractorStyleImage::SetInteractionModeToImageSlicing ( )
inline

Set/Get current mode to 2D or 3D. The default is 2D. In 3D mode, it is possible to rotate the camera to view oblique slices. In Slicing mode, it is possible to slice through the data, but not to generate oblique views by rotating the camera.

Definition at line 142 of file vtkInteractorStyleImage.h.

virtual void vtkInteractorStyleImage::SetXViewRightVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetXViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetXViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetXViewRightVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetXViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetXViewUpVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetXViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetXViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetXViewUpVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetXViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetYViewRightVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetYViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetYViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetYViewRightVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetYViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetYViewUpVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetYViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetYViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetYViewUpVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetYViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetZViewRightVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetZViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetZViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetZViewRightVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetZViewRightVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetZViewUpVector ( double  ,
double  ,
double   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::SetZViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetZViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetZViewUpVector ( double &  ,
double &  ,
double &   
)
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

virtual void vtkInteractorStyleImage::GetZViewUpVector ( double  [3])
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed. See SetImageOrientation for more information.

void vtkInteractorStyleImage::SetImageOrientation ( const double  leftToRight[3],
const double  bottomToTop[3] 
)

Set the view orientation, in terms of the horizontal and vertical directions of the computer screen. The first vector gives the direction that will correspond to moving horizontally left-to-right across the screen, and the second vector gives the direction that will correspond to moving bottom-to-top up the screen. This method changes the position of the camera to provide the desired view.

vtkImageProperty* vtkInteractorStyleImage::GetCurrentImageProperty ( )
inline

Get the current image property, which is set when StartWindowLevel is called immediately before StartWindowLevelEvent is generated. This is the image property of the topmost vtkImageSlice in the renderer or NULL if no image actors are present.

Definition at line 179 of file vtkInteractorStyleImage.h.

void vtkInteractorStyleImage::SetCurrentImageToNthImage ( int  i)
protected

Member Data Documentation

int vtkInteractorStyleImage::WindowLevelStartPosition[2]
protected

Definition at line 189 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::WindowLevelCurrentPosition[2]
protected

Definition at line 190 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::WindowLevelInitial[2]
protected

Definition at line 191 of file vtkInteractorStyleImage.h.

vtkImageProperty* vtkInteractorStyleImage::CurrentImageProperty
protected

Definition at line 192 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::InteractionMode
protected

Definition at line 194 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::XViewRightVector[3]
protected

Definition at line 195 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::XViewUpVector[3]
protected

Definition at line 196 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::YViewRightVector[3]
protected

Definition at line 197 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::YViewUpVector[3]
protected

Definition at line 198 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::ZViewRightVector[3]
protected

Definition at line 199 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::ZViewUpVector[3]
protected

Definition at line 200 of file vtkInteractorStyleImage.h.


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