Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkMRMLViewInteractorStyle Class Reference

Common base class for processing interaction events in MRML views. More...

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

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual bool DelegateInteractionEventDataToDisplayableManagers (vtkMRMLInteractionEventData *eventData)
 
virtual bool DelegateInteractionEventToDisplayableManagers (unsigned long event)
 
virtual bool DelegateInteractionEventToDisplayableManagers (vtkEventData *inputEventData)
 
virtual const char * GetClassName ()
 
virtual vtkRenderWindowInteractor * GetInteractor ()
 
virtual int IsA (const char *type)
 
virtual void OnButton3D (vtkEventData *eventData)
 3D event bindings
 
virtual void OnChar ()
 Keyboard functions.
 
virtual void OnConfigure ()
 
virtual void OnEndPan ()
 
virtual void OnEndPinch ()
 
virtual void OnEndRotate ()
 
virtual void OnEnter ()
 
virtual void OnExpose ()
 
virtual void OnKeyPress ()
 
virtual void OnKeyRelease ()
 
virtual void OnLeave ()
 
virtual void OnLeftButtonDoubleClick ()
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnLongTap ()
 
virtual void OnMiddleButtonDoubleClick ()
 
virtual void OnMiddleButtonDown ()
 
virtual void OnMiddleButtonUp ()
 
virtual void OnMouseMove ()
 Mouse functions.
 
virtual void OnMouseWheelBackward ()
 
virtual void OnMouseWheelForward ()
 
virtual void OnMove3D (vtkEventData *eventData)
 
virtual void OnPan ()
 
virtual void OnPinch ()
 
virtual void OnRightButtonDoubleClick ()
 
virtual void OnRightButtonDown ()
 
virtual void OnRightButtonUp ()
 
virtual void OnRotate ()
 
virtual void OnStartPan ()
 
virtual void OnStartPinch ()
 
virtual void OnStartRotate ()
 
virtual void OnTap ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetDisplayableManagers (vtkMRMLDisplayableManagerGroup *displayableManagers)
 
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLViewInteractorStyle * New ()
 
static vtkMRMLViewInteractorStyle * SafeDownCast (vtkObject *o)
 

Protected Member Functions

vtkInteractorStyle * GetInteractorStyle ()
 
virtual void ProcessDisplayableManagerEvents (vtkMRMLAbstractDisplayableManager *displayableManager, unsigned long event, void *callData)
 
void SetMouseCursor (int cursor)
 
 vtkMRMLViewInteractorStyle ()
 
 ~vtkMRMLViewInteractorStyle () override
 

Static Protected Member Functions

static void CustomProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 
static void DisplayableManagerCallback (vtkObject *object, unsigned long event, void *clientData, void *callData)
 
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Process events not already delegated to displayable managers by CustomProcessEvents().
 

Protected Attributes

vtkCallbackCommand * DisplayableManagerCallbackCommand
 
vtkWeakPointer< vtkMRMLDisplayableManagerGroup > DisplayableManagers
 
vtkCallbackCommand * EventCallbackCommand
 
vtkMRMLAbstractDisplayableManager * FocusedDisplayableManager
 
vtkRenderWindowInteractor * Interactor { nullptr }
 
bool MouseMovedSinceButtonDown
 

Detailed Description

Common base class for processing interaction events in MRML views.

Events are converted to new-style VTK interaction events and forwarded to displayable managers for processing. Some additional high-level events (such as click and double-click) are generated here.

Definition at line 42 of file vtkMRMLViewInteractorStyle.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkMRMLViewInteractorStyle::Superclass

Definition at line 46 of file vtkMRMLViewInteractorStyle.h.

Constructor & Destructor Documentation

◆ vtkMRMLViewInteractorStyle()

vtkMRMLViewInteractorStyle::vtkMRMLViewInteractorStyle ( )
protected

◆ ~vtkMRMLViewInteractorStyle()

vtkMRMLViewInteractorStyle::~vtkMRMLViewInteractorStyle ( )
overrideprotected

Member Function Documentation

◆ CustomProcessEvents()

static void vtkMRMLViewInteractorStyle::CustomProcessEvents ( vtkObject * object,
unsigned long event,
void * clientdata,
void * calldata )
staticprotected

Main process event method.

Set MouseMovedSinceButtonDown variable based on the mouse events.

Then, if calling DelegateInteractionEventToDisplayableManagers() returns false or if the current motion flag returned by vtkInteractorStyle::GetState() is VTKIS_NONE, call ProcessEvents().

◆ DelegateInteractionEventDataToDisplayableManagers()

virtual bool vtkMRMLViewInteractorStyle::DelegateInteractionEventDataToDisplayableManagers ( vtkMRMLInteractionEventData * eventData)
virtual

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

◆ DelegateInteractionEventToDisplayableManagers() [1/2]

virtual bool vtkMRMLViewInteractorStyle::DelegateInteractionEventToDisplayableManagers ( unsigned long event)
virtual

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 in vtkMRMLSliceViewInteractorStyle, and vtkMRMLThreeDViewInteractorStyle.

◆ DelegateInteractionEventToDisplayableManagers() [2/2]

virtual bool vtkMRMLViewInteractorStyle::DelegateInteractionEventToDisplayableManagers ( vtkEventData * inputEventData)
virtual

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 in vtkMRMLSliceViewInteractorStyle, and vtkMRMLThreeDViewInteractorStyle.

◆ DisplayableManagerCallback()

static void vtkMRMLViewInteractorStyle::DisplayableManagerCallback ( vtkObject * object,
unsigned long event,
void * clientData,
void * callData )
staticprotected

◆ GetClassName()

virtual const char * vtkMRMLViewInteractorStyle::GetClassName ( )
virtual

Reimplemented in vtkMRMLSliceViewInteractorStyle, and vtkMRMLThreeDViewInteractorStyle.

◆ GetInteractor()

virtual vtkRenderWindowInteractor * vtkMRMLViewInteractorStyle::GetInteractor ( )
virtual

◆ GetInteractorStyle()

vtkInteractorStyle * vtkMRMLViewInteractorStyle::GetInteractorStyle ( )
protected

◆ IsA()

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

Reimplemented in vtkMRMLSliceViewInteractorStyle, and vtkMRMLThreeDViewInteractorStyle.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLViewInteractorStyle * vtkMRMLViewInteractorStyle::New ( )
static

◆ OnButton3D()

virtual void vtkMRMLViewInteractorStyle::OnButton3D ( vtkEventData * eventData)
virtual

3D event bindings

◆ OnChar()

virtual void vtkMRMLViewInteractorStyle::OnChar ( )
virtual

Keyboard functions.

◆ OnConfigure()

virtual void vtkMRMLViewInteractorStyle::OnConfigure ( )
virtual

◆ OnEndPan()

virtual void vtkMRMLViewInteractorStyle::OnEndPan ( )
virtual

◆ OnEndPinch()

virtual void vtkMRMLViewInteractorStyle::OnEndPinch ( )
virtual

◆ OnEndRotate()

virtual void vtkMRMLViewInteractorStyle::OnEndRotate ( )
virtual

◆ OnEnter()

virtual void vtkMRMLViewInteractorStyle::OnEnter ( )
virtual

◆ OnExpose()

virtual void vtkMRMLViewInteractorStyle::OnExpose ( )
virtual

◆ OnKeyPress()

virtual void vtkMRMLViewInteractorStyle::OnKeyPress ( )
virtual

◆ OnKeyRelease()

virtual void vtkMRMLViewInteractorStyle::OnKeyRelease ( )
virtual

◆ OnLeave()

virtual void vtkMRMLViewInteractorStyle::OnLeave ( )
virtual

Reimplemented in vtkMRMLThreeDViewInteractorStyle.

◆ OnLeftButtonDoubleClick()

virtual void vtkMRMLViewInteractorStyle::OnLeftButtonDoubleClick ( )
virtual

◆ OnLeftButtonDown()

virtual void vtkMRMLViewInteractorStyle::OnLeftButtonDown ( )
virtual

◆ OnLeftButtonUp()

virtual void vtkMRMLViewInteractorStyle::OnLeftButtonUp ( )
virtual

◆ OnLongTap()

virtual void vtkMRMLViewInteractorStyle::OnLongTap ( )
virtual

◆ OnMiddleButtonDoubleClick()

virtual void vtkMRMLViewInteractorStyle::OnMiddleButtonDoubleClick ( )
virtual

◆ OnMiddleButtonDown()

virtual void vtkMRMLViewInteractorStyle::OnMiddleButtonDown ( )
virtual

◆ OnMiddleButtonUp()

virtual void vtkMRMLViewInteractorStyle::OnMiddleButtonUp ( )
virtual

◆ OnMouseMove()

virtual void vtkMRMLViewInteractorStyle::OnMouseMove ( )
virtual

Mouse functions.

◆ OnMouseWheelBackward()

virtual void vtkMRMLViewInteractorStyle::OnMouseWheelBackward ( )
virtual

◆ OnMouseWheelForward()

virtual void vtkMRMLViewInteractorStyle::OnMouseWheelForward ( )
virtual

◆ OnMove3D()

virtual void vtkMRMLViewInteractorStyle::OnMove3D ( vtkEventData * eventData)
virtual

◆ OnPan()

virtual void vtkMRMLViewInteractorStyle::OnPan ( )
virtual

◆ OnPinch()

virtual void vtkMRMLViewInteractorStyle::OnPinch ( )
virtual

◆ OnRightButtonDoubleClick()

virtual void vtkMRMLViewInteractorStyle::OnRightButtonDoubleClick ( )
virtual

◆ OnRightButtonDown()

virtual void vtkMRMLViewInteractorStyle::OnRightButtonDown ( )
virtual

◆ OnRightButtonUp()

virtual void vtkMRMLViewInteractorStyle::OnRightButtonUp ( )
virtual

◆ OnRotate()

virtual void vtkMRMLViewInteractorStyle::OnRotate ( )
virtual

◆ OnStartPan()

virtual void vtkMRMLViewInteractorStyle::OnStartPan ( )
virtual

◆ OnStartPinch()

virtual void vtkMRMLViewInteractorStyle::OnStartPinch ( )
virtual

◆ OnStartRotate()

virtual void vtkMRMLViewInteractorStyle::OnStartRotate ( )
virtual

◆ OnTap()

virtual void vtkMRMLViewInteractorStyle::OnTap ( )
virtual

◆ PrintSelf()

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

◆ ProcessDisplayableManagerEvents()

virtual void vtkMRMLViewInteractorStyle::ProcessDisplayableManagerEvents ( vtkMRMLAbstractDisplayableManager * displayableManager,
unsigned long event,
void * callData )
protectedvirtual

Reimplemented in vtkMRMLThreeDViewInteractorStyle.

◆ ProcessEvents()

static void vtkMRMLViewInteractorStyle::ProcessEvents ( vtkObject * object,
unsigned long event,
void * clientdata,
void * calldata )
staticprotected

Process events not already delegated to displayable managers by CustomProcessEvents().

◆ SafeDownCast()

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

◆ SetDisplayableManagers()

virtual void vtkMRMLViewInteractorStyle::SetDisplayableManagers ( vtkMRMLDisplayableManagerGroup * displayableManagers)
virtual

Reimplemented in vtkMRMLThreeDViewInteractorStyle.

◆ SetInteractor()

virtual void vtkMRMLViewInteractorStyle::SetInteractor ( vtkRenderWindowInteractor * interactor)
virtual

Reimplemented in vtkMRMLThreeDViewInteractorStyle.

◆ SetMouseCursor()

void vtkMRMLViewInteractorStyle::SetMouseCursor ( int cursor)
protected

Member Data Documentation

◆ DisplayableManagerCallbackCommand

vtkCallbackCommand* vtkMRMLViewInteractorStyle::DisplayableManagerCallbackCommand
protected

Definition at line 131 of file vtkMRMLViewInteractorStyle.h.

◆ DisplayableManagers

vtkWeakPointer<vtkMRMLDisplayableManagerGroup> vtkMRMLViewInteractorStyle::DisplayableManagers
protected

Definition at line 139 of file vtkMRMLViewInteractorStyle.h.

◆ EventCallbackCommand

vtkCallbackCommand* vtkMRMLViewInteractorStyle::EventCallbackCommand
protected

Definition at line 118 of file vtkMRMLViewInteractorStyle.h.

◆ FocusedDisplayableManager

vtkMRMLAbstractDisplayableManager* vtkMRMLViewInteractorStyle::FocusedDisplayableManager
protected

Definition at line 140 of file vtkMRMLViewInteractorStyle.h.

◆ Interactor

vtkRenderWindowInteractor* vtkMRMLViewInteractorStyle::Interactor { nullptr }
protected

Definition at line 115 of file vtkMRMLViewInteractorStyle.h.

◆ MouseMovedSinceButtonDown

bool vtkMRMLViewInteractorStyle::MouseMovedSinceButtonDown
protected

Definition at line 137 of file vtkMRMLViewInteractorStyle.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 5 2025 09:04:38 for Slicer by doxygen 1.13.0