Slicer  5.0
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
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 vtkInteractorStyle3D 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 int IsA (const char *type)
 
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 vtkMRMLViewInteractorStyleNew ()
 
static vtkMRMLViewInteractorStyleSafeDownCast (vtkObject *o)
 

Protected Member Functions

void SetMouseCursor (int cursor)
 
 vtkMRMLViewInteractorStyle ()
 
 ~vtkMRMLViewInteractorStyle () override
 

Static Protected Member Functions

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

Protected Attributes

vtkSmartPointer< vtkTimerLog > ClickTimer
 Measures time elapsed since first button press. More...
 
vtkWeakPointer< vtkMRMLDisplayableManagerGroupDisplayableManagers
 
double DoubleClickIntervalTimeSec
 
vtkMRMLAbstractDisplayableManagerFocusedDisplayableManager
 
bool MouseMovedSinceButtonDown
 
int NumberOfClicks
 

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 40 of file vtkMRMLViewInteractorStyle.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorStyle3D vtkMRMLViewInteractorStyle::Superclass

Definition at line 45 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

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

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

◆ GetClassName()

virtual const char* vtkMRMLViewInteractorStyle::GetClassName ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLViewInteractorStyle* vtkMRMLViewInteractorStyle::New ( )
static

◆ OnButton3D()

void vtkMRMLViewInteractorStyle::OnButton3D ( vtkEventData *  eventData)
override

3D event bindings

◆ OnChar()

void vtkMRMLViewInteractorStyle::OnChar ( )
override

Keyboard functions.

◆ OnConfigure()

void vtkMRMLViewInteractorStyle::OnConfigure ( )
override

◆ OnEnter()

void vtkMRMLViewInteractorStyle::OnEnter ( )
override

◆ OnExpose()

void vtkMRMLViewInteractorStyle::OnExpose ( )
override

◆ OnKeyPress()

void vtkMRMLViewInteractorStyle::OnKeyPress ( )
override

◆ OnKeyRelease()

void vtkMRMLViewInteractorStyle::OnKeyRelease ( )
override

◆ OnLeave()

void vtkMRMLViewInteractorStyle::OnLeave ( )
override

◆ OnLeftButtonDown()

void vtkMRMLViewInteractorStyle::OnLeftButtonDown ( )
override

◆ OnLeftButtonUp()

void vtkMRMLViewInteractorStyle::OnLeftButtonUp ( )
override

◆ OnLongTap()

void vtkMRMLViewInteractorStyle::OnLongTap ( )
override

◆ OnMiddleButtonDown()

void vtkMRMLViewInteractorStyle::OnMiddleButtonDown ( )
override

◆ OnMiddleButtonUp()

void vtkMRMLViewInteractorStyle::OnMiddleButtonUp ( )
override

◆ OnMouseMove()

void vtkMRMLViewInteractorStyle::OnMouseMove ( )
override

◆ OnMouseWheelBackward()

void vtkMRMLViewInteractorStyle::OnMouseWheelBackward ( )
override

◆ OnMouseWheelForward()

void vtkMRMLViewInteractorStyle::OnMouseWheelForward ( )
override

◆ OnMove3D()

void vtkMRMLViewInteractorStyle::OnMove3D ( vtkEventData *  eventData)
override

◆ OnPan()

void vtkMRMLViewInteractorStyle::OnPan ( )
override

◆ OnPinch()

void vtkMRMLViewInteractorStyle::OnPinch ( )
override

◆ OnRightButtonDown()

void vtkMRMLViewInteractorStyle::OnRightButtonDown ( )
override

◆ OnRightButtonUp()

void vtkMRMLViewInteractorStyle::OnRightButtonUp ( )
override

◆ OnRotate()

void vtkMRMLViewInteractorStyle::OnRotate ( )
override

◆ OnTap()

void vtkMRMLViewInteractorStyle::OnTap ( )
override

◆ PrintSelf()

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

◆ SafeDownCast()

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

◆ SetDisplayableManagers()

void vtkMRMLViewInteractorStyle::SetDisplayableManagers ( vtkMRMLDisplayableManagerGroup displayableManagers)

◆ SetInteractor()

void vtkMRMLViewInteractorStyle::SetInteractor ( vtkRenderWindowInteractor *  interactor)
override


Reimplemented to set additional observers

◆ SetMouseCursor()

void vtkMRMLViewInteractorStyle::SetMouseCursor ( int  cursor)
protected

Member Data Documentation

◆ ClickTimer

vtkSmartPointer<vtkTimerLog> vtkMRMLViewInteractorStyle::ClickTimer
protected

Measures time elapsed since first button press.

Definition at line 112 of file vtkMRMLViewInteractorStyle.h.

◆ DisplayableManagers

vtkWeakPointer<vtkMRMLDisplayableManagerGroup> vtkMRMLViewInteractorStyle::DisplayableManagers
protected

Definition at line 116 of file vtkMRMLViewInteractorStyle.h.

◆ DoubleClickIntervalTimeSec

double vtkMRMLViewInteractorStyle::DoubleClickIntervalTimeSec
protected

Definition at line 114 of file vtkMRMLViewInteractorStyle.h.

◆ FocusedDisplayableManager

vtkMRMLAbstractDisplayableManager* vtkMRMLViewInteractorStyle::FocusedDisplayableManager
protected

Definition at line 117 of file vtkMRMLViewInteractorStyle.h.

◆ MouseMovedSinceButtonDown

bool vtkMRMLViewInteractorStyle::MouseMovedSinceButtonDown
protected

Definition at line 109 of file vtkMRMLViewInteractorStyle.h.

◆ NumberOfClicks

int vtkMRMLViewInteractorStyle::NumberOfClicks
protected

Definition at line 113 of file vtkMRMLViewInteractorStyle.h.


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