VTK
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...
 
vtkInteractorStyleImageNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 ()
 
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 ()
 
vtkImagePropertyGetCurrentImageProperty ()
 Get the current image property, which is set when StartWindowLevel is called immediately before StartWindowLevelEvent is generated. More...
 
virtual intGetWindowLevelStartPosition ()
 Some useful information for handling window level. More...
 
virtual void GetWindowLevelStartPosition (int &, int &)
 Some useful information for handling window level. More...
 
virtual void GetWindowLevelStartPosition (int[2])
 Some useful information for handling window level. More...
 
virtual intGetWindowLevelCurrentPosition ()
 Some useful information for handling window level. More...
 
virtual void GetWindowLevelCurrentPosition (int &, int &)
 Some useful information for handling window level. More...
 
virtual void GetWindowLevelCurrentPosition (int[2])
 Some useful information for handling window level. More...
 
void OnMouseMove () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnLeftButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnLeftButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMiddleButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMiddleButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnRightButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnRightButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
virtual void SetInteractionMode (int)
 Set/Get current mode to 2D or 3D. More...
 
virtual int GetInteractionMode ()
 Set/Get current mode to 2D or 3D. More...
 
void SetInteractionModeToImage2D ()
 Set/Get current mode to 2D or 3D. More...
 
void SetInteractionModeToImage3D ()
 Set/Get current mode to 2D or 3D. More...
 
void SetInteractionModeToImageSlicing ()
 Set/Get current mode to 2D or 3D. More...
 
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])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetXViewRightVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetXViewRightVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetXViewRightVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetXViewUpVector (double, double, double)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetXViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetXViewUpVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetXViewUpVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetXViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetYViewRightVector (double, double, double)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetYViewRightVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetYViewRightVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetYViewRightVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetYViewRightVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetYViewUpVector (double, double, double)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetYViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetYViewUpVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetYViewUpVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetYViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetZViewRightVector (double, double, double)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetZViewRightVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetZViewRightVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetZViewRightVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetZViewRightVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetZViewUpVector (double, double, double)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void SetZViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual doubleGetZViewUpVector ()
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetZViewUpVector (double &, double &, double &)
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
virtual void GetZViewUpVector (double[3])
 Set the orientations that will be used when the X, Y, or Z keys are pressed. More...
 
- Public Member Functions inherited from vtkInteractorStyleTrackballCamera
vtkInteractorStyleTrackballCameraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 OnMouseMove () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnLeftButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnLeftButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMiddleButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMiddleButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnRightButtonDown () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnRightButtonUp () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMouseWheelForward () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
void OnMouseWheelBackward () override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
virtual void SetMotionFactor (double)
 Set the apparent sensitivity of the interactor style to mouse motion. More...
 
virtual double GetMotionFactor ()
 Set the apparent sensitivity of the interactor style to mouse motion. More...
 
- Public Member Functions inherited from vtkInteractorStyle
vtkInteractorStyleNewInstance () 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...
 
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 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 ()
 
void DelegateTDxEvent (unsigned long event, void *calldata)
 Called by the callback to process 3DConnexion device events. 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 ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual void AutoAdjustCameraClippingRangeOn ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual void AutoAdjustCameraClippingRangeOff ()
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
 
virtual int GetState ()
 Some useful information for interaction. More...
 
virtual vtkTypeBool GetUseTimers ()
 Set/Get timer hint. More...
 
virtual void SetUseTimers (vtkTypeBool)
 Set/Get timer hint. More...
 
virtual void UseTimersOn ()
 Set/Get timer hint. More...
 
virtual void UseTimersOff ()
 Set/Get timer hint. More...
 
virtual void SetTimerDuration (unsigned long)
 If using timers, specify the default timer interval (in milliseconds). More...
 
virtual unsigned long GetTimerDuration ()
 If using timers, specify the default timer interval (in milliseconds). More...
 
virtual void SetHandleObservers (vtkTypeBool)
 Does ProcessEvents handle observers on this class or not. More...
 
virtual vtkTypeBool GetHandleObservers ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void HandleObserversOn ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void HandleObserversOff ()
 Does ProcessEvents handle observers on this class or not. More...
 
virtual void StartState (int newstate)
 utility routines used by state changes More...
 
virtual void StopState ()
 utility routines used by state changes More...
 
virtual void StartAnimate ()
 Interaction mode entry points used internally. More...
 
virtual void StopAnimate ()
 Interaction mode entry points used internally. More...
 
virtual void StartRotate ()
 Interaction mode entry points used internally. More...
 
virtual void EndRotate ()
 Interaction mode entry points used internally. More...
 
virtual void StartZoom ()
 Interaction mode entry points used internally. More...
 
virtual void EndZoom ()
 Interaction mode entry points used internally. More...
 
virtual void StartPan ()
 Interaction mode entry points used internally. More...
 
virtual void EndPan ()
 Interaction mode entry points used internally. More...
 
virtual void StartSpin ()
 Interaction mode entry points used internally. More...
 
virtual void EndSpin ()
 Interaction mode entry points used internally. More...
 
virtual void StartDolly ()
 Interaction mode entry points used internally. More...
 
virtual void EndDolly ()
 Interaction mode entry points used internally. More...
 
virtual void StartUniformScale ()
 Interaction mode entry points used internally. More...
 
virtual void EndUniformScale ()
 Interaction mode entry points used internally. More...
 
virtual void StartTimer ()
 Interaction mode entry points used internally. More...
 
virtual void EndTimer ()
 Interaction mode entry points used internally. More...
 
virtual void StartTwoPointer ()
 Interaction mode entry points used internally. More...
 
virtual void EndTwoPointer ()
 Interaction mode entry points used internally. More...
 
virtual void StartGesture ()
 Interaction mode entry points used internally. More...
 
virtual void EndGesture ()
 Interaction mode entry points used internally. 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)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
 
virtual void HighlightProp3D (vtkProp3D *prop3D)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
 
virtual void SetPickColor (double, double, double)
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void SetPickColor (double[3])
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual doubleGetPickColor ()
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void GetPickColor (double data[3])
 Set/Get the pick color (used by default to color vtkActor2D's). More...
 
virtual void SetMouseWheelMotionFactor (double)
 Set/Get the mouse wheel motion factor. More...
 
virtual double GetMouseWheelMotionFactor ()
 Set/Get the mouse wheel motion factor. More...
 
virtual vtkTDxInteractorStyleGetTDxStyle ()
 3Dconnexion device interactor style. More...
 
virtual void SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
 3Dconnexion device interactor style. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor. More...
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
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 ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. More...
 
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 ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
- 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkInteractorStyleImageNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyleImageSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorStyleTrackballCamera
static vtkInteractorStyleTrackballCameraNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyleTrackballCameraSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyleNew ()
 This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorStyleSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (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])
 Convenience methods for outside classes. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
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])
 Helper method for subclasses. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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]
 
vtkImagePropertyCurrentImageProperty
 
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
 
vtkOutlineSourceOutline
 
vtkPolyDataMapperOutlineMapper
 
vtkActorOutlineActor
 
vtkRendererPickedRenderer
 
vtkPropCurrentProp
 
vtkActor2DPickedActor2D
 
int PropPicked
 
double PickColor [3]
 
double MouseWheelMotionFactor
 
unsigned long TimerDuration
 
vtkEventForwarderCommandEventForwarder
 
vtkTDxInteractorStyleTDxStyle
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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:

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

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

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

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

See also
vtkInteractorStyle vtkInteractorStyleTrackballActor vtkInteractorStyleJoystickCamera vtkInteractorStyleJoystickActor
Examples:
vtkInteractorStyleImage (Examples)
Tests:
vtkInteractorStyleImage (Tests)

Definition at line 84 of file vtkInteractorStyleImage.h.

Member Typedef Documentation

Definition at line 88 of file vtkInteractorStyleImage.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static vtkInteractorStyleImage* vtkInteractorStyleImage::New ( )
static
static vtkTypeBool vtkInteractorStyleImage::IsTypeOf ( const char *  type)
static
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.

static vtkInteractorStyleImage* vtkInteractorStyleImage::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkInteractorStyleImage::NewInstanceInternal ( ) const
protectedvirtual
vtkInteractorStyleImage* vtkInteractorStyleImage::NewInstance ( ) const
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 vtkObject.

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.

void vtkInteractorStyleImage::OnMouseMove ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

void vtkInteractorStyleImage::OnLeftButtonDown ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleImage::OnLeftButtonUp ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

Reimplemented in vtkInteractorStyleTreeMapHover.

void vtkInteractorStyleImage::OnMiddleButtonDown ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleImage::OnMiddleButtonUp ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleImage::OnRightButtonDown ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleImage::OnRightButtonUp ( )
overridevirtual

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

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleImage::OnChar ( )
overridevirtual

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

Reimplemented from vtkInteractorObserver.

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 143 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 145 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 147 of file vtkInteractorStyleImage.h.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetXViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetXViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetYViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetYViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetZViewRightVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

virtual double* vtkInteractorStyleImage::GetZViewUpVector ( )
virtual

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the orientations that will be used when the X, Y, or Z keys are pressed.

See SetImageOrientation for more information.

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

Set the view orientation, in terms of the horizontal and vertical directions of the computer screen.

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

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.

int vtkInteractorStyleImage::GetCurrentImageNumber ( )
inline

Definition at line 193 of file vtkInteractorStyleImage.h.

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

Member Data Documentation

int vtkInteractorStyleImage::WindowLevelStartPosition[2]
protected

Definition at line 208 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::WindowLevelCurrentPosition[2]
protected

Definition at line 209 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::WindowLevelInitial[2]
protected

Definition at line 210 of file vtkInteractorStyleImage.h.

vtkImageProperty* vtkInteractorStyleImage::CurrentImageProperty
protected

Definition at line 211 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::CurrentImageNumber
protected

Definition at line 212 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::InteractionMode
protected

Definition at line 214 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::XViewRightVector[3]
protected

Definition at line 215 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::XViewUpVector[3]
protected

Definition at line 216 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::YViewRightVector[3]
protected

Definition at line 217 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::YViewUpVector[3]
protected

Definition at line 218 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::ZViewRightVector[3]
protected

Definition at line 219 of file vtkInteractorStyleImage.h.

double vtkInteractorStyleImage::ZViewUpVector[3]
protected

Definition at line 220 of file vtkInteractorStyleImage.h.


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