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

#include <vtkInteractorStyleImage.h>

Inheritance diagram for vtkInteractorStyleImage:

Collaboration diagram for vtkInteractorStyleImage:

Public Types
typedef vtkInteractorStyleTrackballCamera	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInteractorStyleImage *	NewInstance () 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 ()
Static Public Member Functions
static vtkInteractorStyleImage *	New ()
static int	IsTypeOf (const char *type)
static vtkInteractorStyleImage *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractorStyleImage ()
	~vtkInteractorStyleImage ()
void	SetCurrentImageToNthImage (int i)
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]

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:

Left Mouse button triggers window level events
CTRL Left Mouse spins the camera around its view plane normal
SHIFT Left Mouse pans the camera
CTRL SHIFT Left Mouse dollys (a positional zoom) the camera
Middle mouse button pans the camera
Right mouse button dollys the camera.
SHIFT Right Mouse triggers pick events

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

CTRL Left Mouse slices through the image
SHIFT Middle Mouse slices through the image
CTRL Right Mouse spins the camera

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

SHIFT Left Mouse rotates the camera for oblique slicing
SHIFT Middle Mouse slices through the image
CTRL Right Mouse also slices through the image

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

R Reset the Window/Level
X Reset to a sagittal view
Y Reset to a coronal view
Z Reset to an axial view

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

See also:: vtkInteractorStyle vtkInteractorStyleTrackballActor vtkInteractorStyleJoystickCamera vtkInteractorStyleJoystickActor

Events:: vtkCommand::PickEvent vtkCommand::InteractionEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent vtkCommand::StartWindowLevelEvent vtkCommand::WindowLevelEvent vtkCommand::EndWindowLevelEvent vtkCommand::ResetWindowLevelEvent

Examples:: vtkInteractorStyleImage (Examples)

Tests:: vtkInteractorStyleImage (Tests)

Definition at line 87 of file vtkInteractorStyleImage.h.

Member Typedef Documentation

typedef vtkInteractorStyleTrackballCamera vtkInteractorStyleImage::Superclass

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

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]

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

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

static int vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual int vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

static vtkInteractorStyleImage* vtkInteractorStyleImage::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual vtkObjectBase* vtkInteractorStyleImage::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

vtkInteractorStyleImage* vtkInteractorStyleImage::NewInstance ( ) const

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

void vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

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.

Reimplemented from vtkInteractorStyle.

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]`