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 Types inherited from vtkInteractorStyleTrackballCamera
typedef vtkInteractorStyle	Superclass

Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorStyleImage *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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

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 ()

void	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.

virtual void	SetCurrentImageNumber (int i)
	Set the image to use for WindowLevel interaction.

int	GetCurrentImageNumber ()

vtkImageProperty *	GetCurrentImageProperty ()
	Get the current image property, which is set when StartWindowLevel is called immediately before StartWindowLevelEvent is generated.


virtual int *	GetWindowLevelStartPosition ()
	Some useful information for handling window level.

virtual void	GetWindowLevelStartPosition (int &, int &)
	Some useful information for handling window level.

virtual void	GetWindowLevelStartPosition (int[2])
	Some useful information for handling window level.

virtual int *	GetWindowLevelCurrentPosition ()
	Some useful information for handling window level.

virtual void	GetWindowLevelCurrentPosition (int &, int &)
	Some useful information for handling window level.

virtual void	GetWindowLevelCurrentPosition (int[2])
	Some useful information for handling window level.


void	OnMouseMove () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnLeftButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnLeftButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMiddleButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMiddleButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnRightButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnRightButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.


virtual void	SetInteractionMode (int)
	Set/Get current mode to 2D or 3D.

virtual int	GetInteractionMode ()
	Set/Get current mode to 2D or 3D.

void	SetInteractionModeToImage2D ()
	Set/Get current mode to 2D or 3D.

void	SetInteractionModeToImage3D ()
	Set/Get current mode to 2D or 3D.

void	SetInteractionModeToImageSlicing ()
	Set/Get current mode to 2D or 3D.


virtual void	SetXViewRightVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetXViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetXViewRightVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetXViewRightVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetXViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetXViewUpVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetXViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetXViewUpVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetXViewUpVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetXViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetYViewRightVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetYViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetYViewRightVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetYViewRightVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetYViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetYViewUpVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetYViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetYViewUpVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetYViewUpVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetYViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetZViewRightVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetZViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetZViewRightVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetZViewRightVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetZViewRightVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetZViewUpVector (double, double, double)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	SetZViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual double *	GetZViewUpVector ()
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetZViewUpVector (double &, double &, double &)
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

virtual void	GetZViewUpVector (double[3])
	Set the orientations that will be used when the X, Y, or Z keys are pressed.

Public Member Functions inherited from vtkInteractorStyleTrackballCamera
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorStyleTrackballCamera *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Rotate () override
	These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion.

void	Spin () override

void	Pan () override

void	Dolly () override

void	EnvironmentRotate () override

void	OnMouseMove () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnLeftButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnLeftButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMiddleButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMiddleButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnRightButtonDown () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnRightButtonUp () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMouseWheelForward () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

void	OnMouseWheelBackward () override
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

virtual void	SetMotionFactor (double)
	Set the apparent sensitivity of the interactor style to mouse motion.

virtual double	GetMotionFactor ()
	Set the apparent sensitivity of the interactor style to mouse motion.

Public Member Functions inherited from vtkInteractorStyle
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorStyle *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	Set/Get the Interactor wrapper being controlled by this object.

void	SetEnabled (int) override
	Turn on/off this interactor.

void	FindPokedRenderer (int, int)
	When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers.

virtual void	OnMouseMove ()
	Generic event bindings can be overridden in subclasses.

virtual void	OnLeftButtonDown ()

virtual void	OnLeftButtonUp ()

virtual void	OnMiddleButtonDown ()

virtual void	OnMiddleButtonUp ()

virtual void	OnRightButtonDown ()

virtual void	OnRightButtonUp ()

virtual void	OnLeftButtonDoubleClick ()

virtual void	OnMiddleButtonDoubleClick ()

virtual void	OnRightButtonDoubleClick ()

virtual void	OnMouseWheelForward ()

virtual void	OnMouseWheelBackward ()

virtual void	OnMouseWheelLeft ()

virtual void	OnMouseWheelRight ()

virtual void	OnFourthButtonDown ()

virtual void	OnFourthButtonUp ()

virtual void	OnFifthButtonDown ()

virtual void	OnFifthButtonUp ()

virtual void	OnMove3D (vtkEventData *)
	Generic 3D event bindings can be overridden in subclasses.

virtual void	OnButton3D (vtkEventData *)

virtual void	OnPick3D (vtkEventData *)

virtual void	OnClip3D (vtkEventData *)

virtual void	OnSelect3D (vtkEventData *)

virtual void	OnMenu3D (vtkEventData *)

virtual void	OnNextPose3D (vtkEventData *)

virtual void	OnPositionProp3D (vtkEventData *)

virtual void	OnViewerMovement3D (vtkEventData *)

virtual void	OnElevation3D (vtkEventData *)

void	OnChar () override
	OnChar is triggered when an ASCII key is pressed.

virtual void	OnKeyDown ()

virtual void	OnKeyUp ()

virtual void	OnKeyPress ()

virtual void	OnKeyRelease ()

virtual void	OnExpose ()
	These are more esoteric events, but are useful in some cases.

virtual void	OnConfigure ()

virtual void	OnEnter ()

virtual void	OnLeave ()

virtual void	OnTimer ()
	OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses.

virtual void	Rotate ()
	These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion.

virtual void	Spin ()

virtual void	Pan ()

virtual void	Dolly ()

virtual void	Zoom ()

virtual void	UniformScale ()

virtual void	EnvironmentRotate ()

virtual void	OnStartSwipe ()
	gesture based events

virtual void	OnSwipe ()

virtual void	OnEndSwipe ()

virtual void	OnStartPinch ()

virtual void	OnPinch ()

virtual void	OnEndPinch ()

virtual void	OnStartRotate ()

virtual void	OnRotate ()

virtual void	OnEndRotate ()

virtual void	OnStartPan ()

virtual void	OnPan ()

virtual void	OnEndPan ()

virtual void	OnTap ()

virtual void	OnLongTap ()

virtual void	OnDropLocation (double *vtkNotUsed(position))
	When the mouse location is updated while dragging files.

virtual void	OnDropFiles (vtkStringArray *vtkNotUsed(filePaths))
	When files are dropped on the render window.

void	DelegateTDxEvent (unsigned long event, void *calldata)
	Called by the callback to process 3DConnexion device events.

virtual void	SetAutoAdjustCameraClippingRange (vtkTypeBool)
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual vtkTypeBool	GetAutoAdjustCameraClippingRange ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOn ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOff ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual int	GetState ()
	Some useful information for interaction.

virtual vtkTypeBool	GetUseTimers ()
	Set/Get timer hint.

virtual void	SetUseTimers (vtkTypeBool)
	Set/Get timer hint.

virtual void	UseTimersOn ()
	Set/Get timer hint.

virtual void	UseTimersOff ()
	Set/Get timer hint.

virtual void	SetTimerDuration (unsigned long)
	If using timers, specify the default timer interval (in milliseconds).

virtual unsigned long	GetTimerDuration ()
	If using timers, specify the default timer interval (in milliseconds).

virtual void	SetHandleObservers (vtkTypeBool)
	Does ProcessEvents handle observers on this class or not.

virtual vtkTypeBool	GetHandleObservers ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOn ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOff ()
	Does ProcessEvents handle observers on this class or not.

virtual void	StartState (int newstate)
	utility routines used by state changes

virtual void	StopState ()
	utility routines used by state changes

virtual void	StartAnimate ()
	Interaction mode entry points used internally.

virtual void	StopAnimate ()
	Interaction mode entry points used internally.

virtual void	StartRotate ()
	Interaction mode entry points used internally.

virtual void	EndRotate ()
	Interaction mode entry points used internally.

virtual void	StartZoom ()
	Interaction mode entry points used internally.

virtual void	EndZoom ()
	Interaction mode entry points used internally.

virtual void	StartPan ()
	Interaction mode entry points used internally.

virtual void	EndPan ()
	Interaction mode entry points used internally.

virtual void	StartSpin ()
	Interaction mode entry points used internally.

virtual void	EndSpin ()
	Interaction mode entry points used internally.

virtual void	StartDolly ()
	Interaction mode entry points used internally.

virtual void	EndDolly ()
	Interaction mode entry points used internally.

virtual void	StartUniformScale ()
	Interaction mode entry points used internally.

virtual void	EndUniformScale ()
	Interaction mode entry points used internally.

virtual void	StartTimer ()
	Interaction mode entry points used internally.

virtual void	EndTimer ()
	Interaction mode entry points used internally.

virtual void	StartTwoPointer ()
	Interaction mode entry points used internally.

virtual void	EndTwoPointer ()
	Interaction mode entry points used internally.

virtual void	StartGesture ()
	Interaction mode entry points used internally.

virtual void	EndGesture ()
	Interaction mode entry points used internally.

virtual void	StartEnvRotate ()
	Interaction mode entry points used internally.

virtual void	EndEnvRotate ()
	Interaction mode entry points used internally.

virtual void	HighlightProp (vtkProp *prop)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightActor2D (vtkActor2D *actor2D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightProp3D (vtkProp3D *prop3D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	SetPickColor (double, double, double)
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetPickColor (double[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual double *	GetPickColor ()
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	GetPickColor (double data[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetMouseWheelMotionFactor (double)
	Set/Get the mouse wheel motion factor.

virtual double	GetMouseWheelMotionFactor ()
	Set/Get the mouse wheel motion factor.

virtual vtkTDxInteractorStyle *	GetTDxStyle ()
	3Dconnexion device interactor style.

virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
	3Dconnexion device interactor style.

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkInteractorStyleImage *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyleImage *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyleTrackballCamera
static vtkInteractorStyleTrackballCamera *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyleTrackballCamera *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()
	This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyleImage ()

	~vtkInteractorStyleImage () override

Protected Member Functions inherited from vtkInteractorStyleTrackballCamera
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyleTrackballCamera ()

	~vtkInteractorStyleTrackballCamera () override

virtual void	Dolly (double factor)

Protected Member Functions inherited from vtkInteractorStyle
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyle ()

	~vtkInteractorStyle () override

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	WindowLevelStartPosition [2]

int	WindowLevelCurrentPosition [2]

double	WindowLevelInitial [2]

vtkImageProperty *	CurrentImageProperty

int	CurrentImageNumber

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

Protected Attributes inherited from vtkInteractorStyle
int	State

int	AnimState

vtkTypeBool	HandleObservers

vtkTypeBool	UseTimers

int	TimerId

vtkTypeBool	AutoAdjustCameraClippingRange

vtkOutlineSource *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

vtkRenderer *	PickedRenderer

vtkProp *	CurrentProp

vtkActor2D *	PickedActor2D

int	PropPicked

double	PickColor [3]

double	MouseWheelMotionFactor

unsigned long	TimerDuration

vtkEventForwarderCommand *	EventForwarder

vtkTDxInteractorStyle *	TDxStyle

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkInteractorStyle
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Main process event method.

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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::EndPickEvent vtkCommand::EndWindowLevelEvent vtkCommand::InteractionEvent vtkCommand::PickEvent vtkCommand::ResetWindowLevelEvent vtkCommand::StartPickEvent vtkCommand::StartWindowLevelEvent vtkCommand::WindowLevelEvent

Examples:: vtkInteractorStyleImage (Examples)

Online Examples:

Tests:: vtkInteractorStyleImage (Tests)

Definition at line 186 of file vtkInteractorStyleImage.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorStyleTrackballCamera vtkInteractorStyleImage::Superclass

Definition at line 191 of file vtkInteractorStyleImage.h.

Constructor & Destructor Documentation

◆ vtkInteractorStyleImage()

vtkInteractorStyleImage::vtkInteractorStyleImage ( )

protected

◆ ~vtkInteractorStyleImage()

vtkInteractorStyleImage::~vtkInteractorStyleImage ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkInteractorStyleImage * vtkInteractorStyleImage::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkInteractorStyleImage::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInteractorStyleImage::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

◆ NewInstance()

vtkInteractorStyleImage * vtkInteractorStyleImage::NewInstance ( ) const

◆ PrintSelf()

void vtkInteractorStyleImage::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

Reimplemented in vtkInteractorStyleTreeMapHover.

◆ GetWindowLevelStartPosition() [1/3]

virtual int * vtkInteractorStyleImage::GetWindowLevelStartPosition ( )

virtual

Some useful information for handling window level.

◆ GetWindowLevelStartPosition() [2/3]

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

virtual

Some useful information for handling window level.

◆ GetWindowLevelStartPosition() [3/3]

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

virtual

Some useful information for handling window level.

◆ GetWindowLevelCurrentPosition() [1/3]

virtual int * vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( )

virtual

Some useful information for handling window level.

◆ GetWindowLevelCurrentPosition() [2/3]

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

virtual

Some useful information for handling window level.

◆ GetWindowLevelCurrentPosition() [3/3]

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

virtual

Some useful information for handling window level.

◆ OnMouseMove()

void vtkInteractorStyleImage::OnMouseMove ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

◆ OnLeftButtonDown()

void vtkInteractorStyleImage::OnLeftButtonDown ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonUp()

void vtkInteractorStyleImage::OnLeftButtonUp ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

◆ OnMiddleButtonDown()

void vtkInteractorStyleImage::OnMiddleButtonDown ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ OnMiddleButtonUp()

void vtkInteractorStyleImage::OnMiddleButtonUp ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ OnRightButtonDown()

void vtkInteractorStyleImage::OnRightButtonDown ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ OnRightButtonUp()

void vtkInteractorStyleImage::OnRightButtonUp ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ OnChar()

void vtkInteractorStyleImage::OnChar ( )

overridevirtual

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

Reimplemented from vtkInteractorStyle.

◆ WindowLevel()

virtual void vtkInteractorStyleImage::WindowLevel ( )

virtual

◆ Pick()

virtual void vtkInteractorStyleImage::Pick ( )

virtual

◆ Slice()

virtual void vtkInteractorStyleImage::Slice ( )

virtual

◆ StartWindowLevel()

virtual void vtkInteractorStyleImage::StartWindowLevel ( )

virtual

◆ EndWindowLevel()

virtual void vtkInteractorStyleImage::EndWindowLevel ( )

virtual

◆ StartPick()

virtual void vtkInteractorStyleImage::StartPick ( )

virtual

◆ EndPick()

virtual void vtkInteractorStyleImage::EndPick ( )

virtual

◆ StartSlice()

virtual void vtkInteractorStyleImage::StartSlice ( )

virtual

◆ EndSlice()

virtual void vtkInteractorStyleImage::EndSlice ( )

virtual

◆ SetInteractionMode()

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.

◆ GetInteractionMode()

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.

◆ SetInteractionModeToImage2D()

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 246 of file vtkInteractorStyleImage.h.

◆ SetInteractionModeToImage3D()

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 247 of file vtkInteractorStyleImage.h.

◆ SetInteractionModeToImageSlicing()

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 248 of file vtkInteractorStyleImage.h.