Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkMRMLSliceViewInteractorStyle Class Reference

Provides customizable interaction routines. More...

#include <Libs/MRML/DisplayableManager/vtkMRMLSliceViewInteractorStyle.h>

Inheritance diagram for vtkMRMLSliceViewInteractorStyle:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLSliceViewInteractorStyle:
Collaboration graph
[legend]

Public Types

enum  {
  None = 0, Translate = 1, Zoom = 2, Rotate = 4,
  Blend = 8, AdjustWindowLevelBackground = 16, AdjustWindowLevelForeground = 32, BrowseSlice = 64,
  ShowSlice = 128, AdjustLightbox = 256, SelectVolume = 512, SetCursorPosition = 1024,
  SetCrosshairPosition = 2048, TranslateSliceIntersection = 4096, RotateSliceIntersection = 8192, AllActionsMask
}
 Internal state management for multi-event sequences (like click-drag-release) More...
 
typedef vtkMRMLViewInteractorStyle Superclass
 
- Public Types inherited from vtkMRMLViewInteractorStyle
typedef vtkInteractorStyle3D Superclass
 

Public Member Functions

virtual bool DelegateInteractionEventToDisplayableManagers (unsigned long event)
 
virtual bool DelegateInteractionEventToDisplayableManagers (vtkEventData *inputEventData)
 
bool DelegateInteractionEventToDisplayableManagers (vtkEventData *inputEventData) override
 
bool GetActionEnabled (int actionsMask)
 
virtual const char * GetClassName ()
 
vtkMRMLCrosshairDisplayableManagerGetCrosshairDisplayableManager ()
 
vtkMRMLScalarBarDisplayableManagerGetScalarBarDisplayableManager ()
 
virtual vtkMRMLSliceLogicGetSliceLogic ()
 
virtual int IsA (const char *type)
 
void OnLeave () override
 
void OnMouseMove () override
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetActionEnabled (int actionsMask, bool enable=true)
 
void SetSliceLogic (vtkMRMLSliceLogic *SliceLogic)
 
Get/Set the SliceLogic More...
 
- Public Member Functions inherited from vtkMRMLViewInteractorStyle
virtual bool DelegateInteractionEventDataToDisplayableManagers (vtkMRMLInteractionEventData *eventData)
 
virtual bool DelegateInteractionEventToDisplayableManagers (unsigned long event)
 
void OnButton3D (vtkEventData *eventData) override
 3D event bindings More...
 
void OnChar () override
 Keyboard functions. More...
 
void OnConfigure () override
 
void OnEnter () override
 
void OnExpose () override
 
void OnKeyPress () override
 
void OnKeyRelease () override
 
void OnLeave () override
 
void OnLeftButtonDown () override
 
void OnLeftButtonUp () override
 
void OnLongTap () override
 
void OnMiddleButtonDown () override
 
void OnMiddleButtonUp () override
 
void OnMouseMove () override
 
void OnMouseWheelBackward () override
 
void OnMouseWheelForward () override
 
void OnMove3D (vtkEventData *eventData) override
 
void OnPan () override
 
void OnPinch () override
 
void OnRightButtonDown () override
 
void OnRightButtonUp () override
 
void OnRotate () override
 
void OnTap () override
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetDisplayableManagers (vtkMRMLDisplayableManagerGroup *displayableManagers)
 
void SetInteractor (vtkRenderWindowInteractor *interactor) override
 
Reimplemented to set additional observers More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLSliceViewInteractorStyleNew ()
 
static vtkMRMLSliceViewInteractorStyleSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLViewInteractorStyle
static int IsTypeOf (const char *type)
 
static vtkMRMLViewInteractorStyleNew ()
 
static vtkMRMLViewInteractorStyleSafeDownCast (vtkObject *o)
 

Protected Member Functions

void SetMouseCursor (int cursor)
 
 vtkMRMLSliceViewInteractorStyle ()
 
 ~vtkMRMLSliceViewInteractorStyle () override
 
- Protected Member Functions inherited from vtkMRMLViewInteractorStyle
void SetMouseCursor (int cursor)
 
 vtkMRMLViewInteractorStyle ()
 
 ~vtkMRMLViewInteractorStyle () override
 

Static Protected Member Functions

static void SliceViewProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 
- Static Protected Member Functions inherited from vtkMRMLViewInteractorStyle
static void CustomProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

bool EnableCursorUpdate
 
vtkMRMLSliceLogicSliceLogic
 
- Protected Attributes inherited from vtkMRMLViewInteractorStyle
vtkSmartPointer< vtkTimerLog > ClickTimer
 Measures time elapsed since first button press. More...
 
vtkWeakPointer< vtkMRMLDisplayableManagerGroupDisplayableManagers
 
double DoubleClickIntervalTimeSec
 
vtkMRMLAbstractDisplayableManagerFocusedDisplayableManager
 
bool MouseMovedSinceButtonDown
 
int NumberOfClicks
 

Detailed Description

Provides customizable interaction routines.

Relies on vtkInteractorStyleUser, but with MouseWheelEvents. and mapping to control the slicer slice logic (manipulates the vtkMRMLSliceNode and vtkMRMLSliceCompositeNode. TODO:

Definition at line 42 of file vtkMRMLSliceViewInteractorStyle.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkMRMLSliceViewInteractorStyle.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Internal state management for multi-event sequences (like click-drag-release)

Action State values and management

Enumerator
None 
Translate 
Zoom 
Rotate 
Blend 
AdjustWindowLevelBackground 
AdjustWindowLevelForeground 
BrowseSlice 
ShowSlice 
AdjustLightbox 
SelectVolume 
SetCursorPosition 
SetCrosshairPosition 
TranslateSliceIntersection 
RotateSliceIntersection 
AllActionsMask 

Definition at line 66 of file vtkMRMLSliceViewInteractorStyle.h.

Constructor & Destructor Documentation

◆ vtkMRMLSliceViewInteractorStyle()

vtkMRMLSliceViewInteractorStyle::vtkMRMLSliceViewInteractorStyle ( )
protected

◆ ~vtkMRMLSliceViewInteractorStyle()

vtkMRMLSliceViewInteractorStyle::~vtkMRMLSliceViewInteractorStyle ( )
overrideprotected

Member Function Documentation

◆ DelegateInteractionEventToDisplayableManagers() [1/3]

virtual bool vtkMRMLViewInteractorStyle::DelegateInteractionEventToDisplayableManagers

Give a chance to displayable managers to process the event. Return true if the event is processed.

◆ DelegateInteractionEventToDisplayableManagers() [2/3]

virtual bool vtkMRMLViewInteractorStyle::DelegateInteractionEventToDisplayableManagers

Give a chance to displayable managers to process the event. Return true if the event is processed.

◆ DelegateInteractionEventToDisplayableManagers() [3/3]

bool vtkMRMLSliceViewInteractorStyle::DelegateInteractionEventToDisplayableManagers ( vtkEventData *  inputEventData)
overridevirtual

Give a chance to displayable managers to process the event. It just creates vtkMRMLInteractionEventData and calls DelegateInteractionEventDataToDisplayableManagers. Return true if the event is processed.

Reimplemented from vtkMRMLViewInteractorStyle.

◆ GetActionEnabled()

bool vtkMRMLSliceViewInteractorStyle::GetActionEnabled ( int  actionsMask)

Returns true if the specified action is allowed. If multiple actions are specified, the return value is true if all actions are enabled.

◆ GetClassName()

virtual const char* vtkMRMLSliceViewInteractorStyle::GetClassName ( )
virtual

Reimplemented from vtkMRMLViewInteractorStyle.

◆ GetCrosshairDisplayableManager()

vtkMRMLCrosshairDisplayableManager* vtkMRMLSliceViewInteractorStyle::GetCrosshairDisplayableManager ( )

◆ GetScalarBarDisplayableManager()

vtkMRMLScalarBarDisplayableManager* vtkMRMLSliceViewInteractorStyle::GetScalarBarDisplayableManager ( )

◆ GetSliceLogic()

virtual vtkMRMLSliceLogic* vtkMRMLSliceViewInteractorStyle::GetSliceLogic ( )
virtual

◆ IsA()

virtual int vtkMRMLSliceViewInteractorStyle::IsA ( const char *  type)
virtual

Reimplemented from vtkMRMLViewInteractorStyle.

◆ IsTypeOf()

static int vtkMRMLSliceViewInteractorStyle::IsTypeOf ( const char *  type)
static

◆ New()

static vtkMRMLSliceViewInteractorStyle* vtkMRMLSliceViewInteractorStyle::New ( )
static

◆ OnLeave()

void vtkMRMLSliceViewInteractorStyle::OnLeave ( )
override

◆ OnMouseMove()

void vtkMRMLSliceViewInteractorStyle::OnMouseMove ( )
override

Events are either handled here by changing the slice node and composite node (sometimes using the logic's methods) or they are passed to the vtkInteractorStyleUser, which conditionally passes them to observers if there are any.

◆ PrintSelf()

void vtkMRMLSliceViewInteractorStyle::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

static vtkMRMLSliceViewInteractorStyle* vtkMRMLSliceViewInteractorStyle::SafeDownCast ( vtkObject *  o)
static

◆ SetActionEnabled()

void vtkMRMLSliceViewInteractorStyle::SetActionEnabled ( int  actionsMask,
bool  enable = true 
)

Enable/disable the specified action (Translate, Zoom, Blend, etc.). Multiple actions can be specified by providing the sum of action ids. Set the value to AllActionsMask to enable/disable all actions. All actions are enabled by default.

◆ SetMouseCursor()

void vtkMRMLSliceViewInteractorStyle::SetMouseCursor ( int  cursor)
protected

◆ SetSliceLogic()

void vtkMRMLSliceViewInteractorStyle::SetSliceLogic ( vtkMRMLSliceLogic SliceLogic)


Get/Set the SliceLogic

◆ SliceViewProcessEvents()

static void vtkMRMLSliceViewInteractorStyle::SliceViewProcessEvents ( vtkObject *  object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

Member Data Documentation

◆ EnableCursorUpdate

bool vtkMRMLSliceViewInteractorStyle::EnableCursorUpdate
protected

Definition at line 121 of file vtkMRMLSliceViewInteractorStyle.h.

◆ SliceLogic

vtkMRMLSliceLogic* vtkMRMLSliceViewInteractorStyle::SliceLogic
protected

Definition at line 114 of file vtkMRMLSliceViewInteractorStyle.h.


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