| VTK 9.0.1

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 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. More...
vtkInteractorStyleImage * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
virtual int * | GetWindowLevelStartPosition ()
| Some useful information for handling window level. More...
virtual void | GetWindowLevelStartPosition (int &, int &)
virtual void | GetWindowLevelStartPosition (int[2])
virtual int * | GetWindowLevelCurrentPosition ()
virtual void | GetWindowLevelCurrentPosition (int &, int &)
virtual void | GetWindowLevelCurrentPosition (int[2])
void | OnMouseMove () override
| Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
void | OnLeftButtonDown () override
void | OnLeftButtonUp () override
void | OnMiddleButtonDown () override
void | OnMiddleButtonUp () override
void | OnRightButtonDown () override
void | OnRightButtonUp () override
void | OnChar () override
| Override the "fly-to" (f keypress) for images. More...
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 void | SetInteractionMode (int)
| Set/Get current mode to 2D or 3D. More...
virtual int | GetInteractionMode ()
void | SetInteractionModeToImage2D ()
void | SetInteractionModeToImage3D ()
void | SetInteractionModeToImageSlicing ()
virtual void | SetXViewRightVector (double, double, double)
| Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
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])
| Set the view orientation, in terms of the horizontal and vertical directions of the computer screen. More...
virtual void | SetCurrentImageNumber (int i)
| Set the image to use for WindowLevel interaction. More...
int | GetCurrentImageNumber ()
vtkImageProperty * | GetCurrentImageProperty ()
| Get the current image property, which is set when StartWindowLevel is called immediately before StartWindowLevelEvent is generated. More...
Public Member Functions inherited from vtkInteractorStyleTrackballCamera
vtkInteractorStyleTrackballCamera * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
void | OnMouseMove () override
| Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
void | OnLeftButtonDown () override
void | OnLeftButtonUp () override
void | OnMiddleButtonDown () override
void | OnMiddleButtonUp () override
void | OnRightButtonDown () override
void | OnRightButtonUp () override
void | OnMouseWheelForward () override
void | OnMouseWheelBackward () override
void | Rotate () override
| These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion. More...
void | Spin () override
void | Pan () override
void | Dolly () override
void | EnvironmentRotate () override
virtual void | SetMotionFactor (double)
| Set the apparent sensitivity of the interactor style to mouse motion. More...
virtual double | GetMotionFactor ()
Public Member Functions inherited from vtkInteractorStyle
vtkInteractorStyle * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
void | SetInteractor (vtkRenderWindowInteractor *interactor) override
| Set/Get the Interactor wrapper being controlled by this object. More...
void | SetEnabled (int) override
| Turn on/off this interactor. More...
virtual void | SetAutoAdjustCameraClippingRange (vtkTypeBool)
| If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
virtual vtkTypeBool | GetAutoAdjustCameraClippingRange ()
virtual void | AutoAdjustCameraClippingRangeOn ()
virtual void | AutoAdjustCameraClippingRangeOff ()
void | FindPokedRenderer (int, int)
| When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. More...
virtual int | GetState ()
| Some useful information for interaction. More...
virtual vtkTypeBool | GetUseTimers ()
| Set/Get timer hint. More...
virtual void | SetUseTimers (vtkTypeBool)
virtual void | UseTimersOn ()
virtual void | UseTimersOff ()
virtual void | SetTimerDuration (unsigned long)
| If using timers, specify the default timer interval (in milliseconds). More...
virtual unsigned long | GetTimerDuration ()
virtual void | SetHandleObservers (vtkTypeBool)
| Does ProcessEvents handle observers on this class or not. More...
virtual vtkTypeBool | GetHandleObservers ()
virtual void | HandleObserversOn ()
virtual void | HandleObserversOff ()
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. More...
virtual void | OnButton3D (vtkEventData *)
void | OnChar () override
| OnChar is triggered when an ASCII key is pressed. More...
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. More...
virtual void | OnConfigure ()
virtual void | OnEnter ()
virtual void | OnLeave ()
virtual void | OnTimer ()
| OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses. More...
virtual void | Zoom ()
virtual void | UniformScale ()
virtual void | OnStartSwipe ()
| gesture based events More...
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 | StartState (int newstate)
| utility routines used by state changes More...
virtual void | StopState ()
virtual void | StartAnimate ()
| Interaction mode entry points used internally. More...
virtual void | StopAnimate ()
virtual void | StartRotate ()
virtual void | EndRotate ()
virtual void | StartZoom ()
virtual void | EndZoom ()
virtual void | StartPan ()
virtual void | EndPan ()
virtual void | StartSpin ()
virtual void | EndSpin ()
virtual void | StartDolly ()
virtual void | EndDolly ()
virtual void | StartUniformScale ()
virtual void | EndUniformScale ()
virtual void | StartTimer ()
virtual void | EndTimer ()
virtual void | StartTwoPointer ()
virtual void | EndTwoPointer ()
virtual void | StartGesture ()
virtual void | EndGesture ()
virtual void | StartEnvRotate ()
virtual void | EndEnvRotate ()
virtual void | OnDropLocation (double *vtkNotUsed(position))
| When the mouse location is updated while dragging files. More...
virtual void | OnDropFiles (vtkStringArray *vtkNotUsed(filePaths))
| When files are dropped on the render window. More...
virtual void | HighlightProp (vtkProp *prop)
| When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
virtual void | HighlightActor2D (vtkActor2D *actor2D)
virtual void | HighlightProp3D (vtkProp3D *prop3D)
virtual void | SetPickColor (double, double, double)
| Set/Get the pick color (used by default to color vtkActor2D's). More...
virtual void | SetPickColor (double[3])
virtual double * | GetPickColor ()
virtual void | GetPickColor (double data[3])
virtual void | SetMouseWheelMotionFactor (double)
| Set/Get the mouse wheel motion factor. More...
virtual double | GetMouseWheelMotionFactor ()
virtual vtkTDxInteractorStyle * | GetTDxStyle ()
| 3Dconnexion device interactor style. More...
virtual void | SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void | DelegateTDxEvent (unsigned long event, void *calldata)
| Called by the callback to process 3DConnexion device events. More...
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver * | NewInstance () const
int | GetEnabled ()
void | EnabledOn ()
void | EnabledOff ()
void | On ()
void | Off ()
virtual vtkRenderWindowInteractor * | GetInteractor ()
virtual void | SetPriority (float)
| Set/Get the priority at which events are processed. More...
virtual float | GetPriority ()
virtual void | PickingManagedOn ()
| Enable/Disable the use of a manager to process the picking. More...
virtual void | PickingManagedOff ()
virtual void | SetPickingManaged (bool managed)
virtual bool | GetPickingManaged ()
virtual void | SetKeyPressActivation (vtkTypeBool)
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual vtkTypeBool | GetKeyPressActivation ()
virtual void | KeyPressActivationOn ()
virtual void | KeyPressActivationOff ()
virtual void | SetKeyPressActivationValue (char)
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
virtual char | GetKeyPressActivationValue ()
virtual vtkRenderer * | GetDefaultRenderer ()
| Set/Get the default renderer to use when activating the interactor observer. More...
virtual void | SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer * | GetCurrentRenderer ()
| Set/Get the current renderer. More...
virtual void | SetCurrentRenderer (vtkRenderer *)
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
void | ReleaseFocus ()
Public Member Functions inherited from vtkObject
| vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void | DebugOn ()
| Turn debugging output on. More...
virtual void | DebugOff ()
| Turn debugging output off. More...
bool | GetDebug ()
| Get the value of the debug flag. More...
void | SetDebug (bool debugFlag)
| Set the value of the debug flag. More...
virtual void | Modified ()
| Update the modification time for this object. More...
virtual vtkMTimeType | GetMTime ()
| Return this object's modified time. More...
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand * | GetCommand (unsigned long tag)
void | RemoveObserver (vtkCommand *)
void | RemoveObservers (unsigned long event, vtkCommand *)
void | RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool | HasObserver (const char *event, vtkCommand *)
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)
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. More...
template<class U , class T >
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
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. More...
int | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
int | InvokeEvent (const char *event, void *callData)
int | InvokeEvent (unsigned long event)
int | InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char * | GetClassName () const
| Return the class name as a string. More...
virtual vtkIdType | GetNumberOfGenerationsFromBase (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). More...
virtual void | Delete ()
| Delete a VTK object. More...
virtual void | FastDelete ()
| Delete a reference to this object. More...
void | InitializeObjectBase ()
void | Print (ostream &os)
| Print an object to an ostream. More...
virtual void | PrintHeader (ostream &os, vtkIndent indent)
virtual void | PrintTrailer (ostream &os, vtkIndent indent)
virtual void | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
int | GetReferenceCount ()
| Return the current reference count of this object. More...
void | SetReferenceCount (int)
| Sets the reference count. More...
void | PrintRevisions (ostream &)
| Legacy. More...

## 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. More...
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. More...
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
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. More...
static void | BreakOnError ()
| This method is called when vtkErrorMacro executes. More...
static void | SetGlobalWarningDisplay (int val)
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOn ()
static void | GlobalWarningDisplayOff ()
static int | GetGlobalWarningDisplay ()
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. More...
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). More...
static vtkObjectBase * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

## Protected Member Functions
virtual vtkObjectBase * | NewInstanceInternal () const
| vtkInteractorStyleImage ()
| ~vtkInteractorStyleImage () override
Protected Member Functions inherited from vtkInteractorStyleTrackballCamera
| vtkInteractorStyleTrackballCamera ()
| ~vtkInteractorStyleTrackballCamera () override
virtual void | Dolly (double factor)
Protected Member Functions inherited from vtkInteractorStyle
| vtkInteractorStyle ()
| ~vtkInteractorStyle () override
Protected Member Functions inherited from vtkInteractorObserver
| vtkInteractorObserver ()
| ~vtkInteractorObserver () override
virtual void | StartInteraction ()
| Utility routines used to start and end interaction. More...
virtual void | EndInteraction ()
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
| Helper method for subclasses. More...
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
virtual void | RegisterPickers ()
| Register internal Pickers in the Picking Manager. More...
void | UnRegisterPickers ()
| Unregister internal pickers from the Picking Manager. More...
vtkPickingManager * | GetPickingManager ()
| Return the picking manager associated on the context on which the observer currently belong. More...
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. More...
int | RequestCursorShape (int requestedShape)
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. More...
void | InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
| vtkObjectBase ()
virtual | ~vtkObjectBase ()
virtual void | CollectRevisions (ostream &)
virtual void | ReportReferences (vtkGarbageCollector *)
| 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
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. More...
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. More...

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

Tests:
  vtkInteractorStyleImage (Tests)

Definition at line 87 of file vtkInteractorStyleImage.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkInteractorStyleTrackballCamera vtkInteractorStyleImage::Superclass

Definition at line 91 of file vtkInteractorStyleImage.h.

## Constructor & Destructor Documentation

## ◆ vtkInteractorStyleImage()

vtkInteractorStyleImage::vtkInteractorStyleImage | ( |  | ) |
| protected

## ◆ ~vtkInteractorStyleImage()

vtkInteractorStyleImage::~vtkInteractorStyleImage | ( |  | ) |
| override protected

## 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
| protected virtual

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

## ◆ NewInstance()

vtkInteractorStyleImage* vtkInteractorStyleImage::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkInteractorStyleImage::PrintSelf | ( | ostream & | os,
|  | vtkIndent | indent
| ) |  |
| override 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 vtkObject.

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

## ◆ GetWindowLevelStartPosition() [3/3]

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

## ◆ GetWindowLevelCurrentPosition() [1/3]

virtual int* vtkInteractorStyleImage::GetWindowLevelCurrentPosition | ( |  | ) |
| virtual

## ◆ GetWindowLevelCurrentPosition() [2/3]

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

## ◆ GetWindowLevelCurrentPosition() [3/3]

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

## ◆ OnMouseMove()

void vtkInteractorStyleImage::OnMouseMove | ( |  | ) |
| override virtual

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

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

## ◆ OnLeftButtonDown()

void vtkInteractorStyleImage::OnLeftButtonDown | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

## ◆ OnLeftButtonUp()

void vtkInteractorStyleImage::OnLeftButtonUp | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

## ◆ OnMiddleButtonDown()

void vtkInteractorStyleImage::OnMiddleButtonDown | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

## ◆ OnMiddleButtonUp()

void vtkInteractorStyleImage::OnMiddleButtonUp | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

## ◆ OnRightButtonDown()

void vtkInteractorStyleImage::OnRightButtonDown | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

## ◆ OnRightButtonUp()

void vtkInteractorStyleImage::OnRightButtonUp | ( |  | ) |
| override virtual

Reimplemented from vtkInteractorStyle.

## ◆ OnChar()

void vtkInteractorStyleImage::OnChar | ( |  | ) |
| override virtual

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

Reimplemented from vtkInteractorObserver.

## ◆ 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

## ◆ SetInteractionModeToImage2D()

void vtkInteractorStyleImage::SetInteractionModeToImage2D | ( |  | ) |
| inline

Definition at line 146 of file vtkInteractorStyleImage.h.

## ◆ SetInteractionModeToImage3D()

void vtkInteractorStyleImage::SetInteractionModeToImage3D | ( |  | ) |
| inline

Definition at line 147 of file vtkInteractorStyleImage.h.

## ◆ SetInteractionModeToImageSlicing()

void vtkInteractorStyleImage::SetInteractionModeToImageSlicing | ( |  | ) |
| inline

Definition at line 148 of file vtkInteractorStyleImage.h.

## ◆ SetXViewRightVector() [1/2]

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.

## ◆ SetXViewRightVector() [2/2]

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

## ◆ GetXViewRightVector() [1/3]

virtual double* vtkInteractorStyleImage::GetXViewRightVector | ( |  | ) |
| virtual

## ◆ GetXViewRightVector() [2/3]

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

## ◆ GetXViewRightVector() [3/3]

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

## ◆ SetXViewUpVector() [1/2]

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

## ◆ SetXViewUpVector() [2/2]

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

## ◆ GetXViewUpVector() [1/3]

virtual double* vtkInteractorStyleImage::GetXViewUpVector | ( |  | ) |
| virtual

## ◆ GetXViewUpVector() [2/3]

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

## ◆ GetXViewUpVector() [3/3]

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

## ◆ SetYViewRightVector() [1/2]

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

## ◆ SetYViewRightVector() [2/2]

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

## ◆ GetYViewRightVector() [1/3]

virtual double* vtkInteractorStyleImage::GetYViewRightVector | ( |  | ) |
| virtual

## ◆ GetYViewRightVector() [2/3]

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

## ◆ GetYViewRightVector() [3/3]

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

## ◆ SetYViewUpVector() [1/2]

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

## ◆ SetYViewUpVector() [2/2]

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

## ◆ GetYViewUpVector() [1/3]

virtual double* vtkInteractorStyleImage::GetYViewUpVector | ( |  | ) |
| virtual

## ◆ GetYViewUpVector() [2/3]

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

## ◆ GetYViewUpVector() [3/3]

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

## ◆ SetZViewRightVector() [1/2]

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

## ◆ SetZViewRightVector() [2/2]

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

## ◆ GetZViewRightVector() [1/3]

virtual double* vtkInteractorStyleImage::GetZViewRightVector | ( |  | ) |
| virtual

## ◆ GetZViewRightVector() [2/3]

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

## ◆ GetZViewRightVector() [3/3]

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

## ◆ SetZViewUpVector() [1/2]

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

## ◆ SetZViewUpVector() [2/2]

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

## ◆ GetZViewUpVector() [1/3]

virtual double* vtkInteractorStyleImage::GetZViewUpVector | ( |  | ) |
| virtual

## ◆ GetZViewUpVector() [2/3]

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

## ◆ GetZViewUpVector() [3/3]

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

## ◆ SetImageOrientation()

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.

## ◆ SetCurrentImageNumber()

virtual void vtkInteractorStyleImage::SetCurrentImageNumber | ( | int | i | ) |
| virtual

Set the image to use for WindowLevel interaction.

Any images for which the Pickable flag is off are ignored. Images are counted back-to-front, so 0 is the rearmost image. Negative values can be used to count front-to-back, so -1 is the frontmost image, -2 is the image behind that one, etc. The default is to use the frontmost image for interaction. If the specified image does not exist, then no WindowLevel interaction will take place.

## ◆ GetCurrentImageNumber()

int vtkInteractorStyleImage::GetCurrentImageNumber | ( |  | ) |
| inline

Definition at line 192 of file vtkInteractorStyleImage.h.

## ◆ GetCurrentImageProperty()

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 nullptr if no image actors are present.

Definition at line 200 of file vtkInteractorStyleImage.h.

## Member Data Documentation

## ◆ WindowLevelStartPosition

int vtkInteractorStyleImage::WindowLevelStartPosition[2]
| protected

Definition at line 206 of file vtkInteractorStyleImage.h.

## ◆ WindowLevelCurrentPosition

int vtkInteractorStyleImage::WindowLevelCurrentPosition[2]
| protected

Definition at line 207 of file vtkInteractorStyleImage.h.

## ◆ WindowLevelInitial

double vtkInteractorStyleImage::WindowLevelInitial[2]
| protected

Definition at line 208 of file vtkInteractorStyleImage.h.

## ◆ CurrentImageProperty

vtkImageProperty* vtkInteractorStyleImage::CurrentImageProperty
| protected

Definition at line 209 of file vtkInteractorStyleImage.h.

## ◆ CurrentImageNumber

int vtkInteractorStyleImage::CurrentImageNumber
| protected

Definition at line 210 of file vtkInteractorStyleImage.h.

## ◆ InteractionMode

int vtkInteractorStyleImage::InteractionMode
| protected

Definition at line 212 of file vtkInteractorStyleImage.h.

## ◆ XViewRightVector

double vtkInteractorStyleImage::XViewRightVector[3]
| protected

Definition at line 213 of file vtkInteractorStyleImage.h.

## ◆ XViewUpVector

double vtkInteractorStyleImage::XViewUpVector[3]
| protected

Definition at line 214 of file vtkInteractorStyleImage.h.

## ◆ YViewRightVector

double vtkInteractorStyleImage::YViewRightVector[3]
| protected

Definition at line 215 of file vtkInteractorStyleImage.h.

## ◆ YViewUpVector

double vtkInteractorStyleImage::YViewUpVector[3]
| protected

Definition at line 216 of file vtkInteractorStyleImage.h.

## ◆ ZViewRightVector

double vtkInteractorStyleImage::ZViewRightVector[3]
| protected

Definition at line 217 of file vtkInteractorStyleImage.h.

## ◆ ZViewUpVector

double vtkInteractorStyleImage::ZViewUpVector[3]
| protected

Definition at line 218 of file vtkInteractorStyleImage.h.

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

- Interaction/Style/vtkInteractorStyleImage.h