Medical Imaging Interaction Toolkit  2018.4.99-b7f3afaa
Medical Imaging Interaction Toolkit
mitk::InteractionEvent Class Reference

#include <mitkInteractionEvent.h>

Inheritance diagram for mitk::InteractionEvent:
Collaboration diagram for mitk::InteractionEvent:

Public Types

enum  MouseButtons { NoButton, LeftMouseButton, RightMouseButton, MiddleMouseButton }
 
enum  ModifierKeys { NoKey, ShiftKey, ControlKey, AltKey }
 
typedef InteractionEvent Self
 
typedef itk::LightObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
void SetSender (BaseRenderer *sender)
 
BaseRendererGetSender () const
 
virtual bool IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New (BaseRenderer *_arg)
 

Static Public Attributes

static const std::string KeyEsc
 
static const std::string KeyEnter
 
static const std::string KeyReturn
 
static const std::string KeyDelete
 
static const std::string KeyArrowUp
 
static const std::string KeyArrowDown
 
static const std::string KeyArrowLeft
 
static const std::string KeyArrowRight
 
static const std::string KeyF1
 
static const std::string KeyF2
 
static const std::string KeyF3
 
static const std::string KeyF4
 
static const std::string KeyF5
 
static const std::string KeyF6
 
static const std::string KeyF7
 
static const std::string KeyF8
 
static const std::string KeyF9
 
static const std::string KeyF10
 
static const std::string KeyF11
 
static const std::string KeyF12
 
static const std::string KeyPos1
 
static const std::string KeyEnd
 
static const std::string KeyInsert
 
static const std::string KeyPageUp
 
static const std::string KeyPageDown
 
static const std::string KeySpace
 

Protected Member Functions

 InteractionEvent (BaseRenderer *)
 
 ~InteractionEvent () override
 
virtual bool IsEqual (const InteractionEvent &other) const
 

Friends

MITKCORE_EXPORT bool operator== (const InteractionEvent &, const InteractionEvent &)
 

Detailed Description

Definition at line 26 of file mitkInteractionEvent.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

typedef itk::LightObject mitk::InteractionEvent::Superclass

Definition at line 29 of file mitkInteractionEvent.h.

Member Enumeration Documentation

◆ ModifierKeys

Enumerator
NoKey 
ShiftKey 
ControlKey 
AltKey 

Definition at line 52 of file mitkInteractionEvent.h.

◆ MouseButtons

Mouse/keyboard state values

Enumerator
NoButton 
LeftMouseButton 
RightMouseButton 
MiddleMouseButton 

Definition at line 44 of file mitkInteractionEvent.h.

Constructor & Destructor Documentation

◆ InteractionEvent()

mitk::InteractionEvent::InteractionEvent ( BaseRenderer baseRenderer)
protected

Definition at line 45 of file mitkInteractionEvent.cpp.

◆ ~InteractionEvent()

mitk::InteractionEvent::~InteractionEvent ( )
overrideprotected

Definition at line 64 of file mitkInteractionEvent.cpp.

Member Function Documentation

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::InteractionEvent::GetClassHierarchy ( ) const
inlinevirtual

◆ GetClassName()

◆ GetSender()

mitk::BaseRenderer * mitk::InteractionEvent::GetSender ( ) const

Definition at line 54 of file mitkInteractionEvent.cpp.

Referenced by mitk::PointSetDataInteractor::Abort(), mitk::PlanarFigureInteractor::AddInitialPoint(), mitk::SinglePointDataInteractor::AddPoint(), mitk::PlanarFigureInteractor::AddPoint(), mitk::PointSetDataInteractor::AddPoint(), mitk::DisplayInteractor::AdjustLevelWindow(), mitk::SegmentationInteractor::ChangeActiveLabel(), mitk::PlanarFigureInteractor::CheckControlPointHovering(), mitk::PlanarFigureInteractor::CheckFigureHovering(), mitk::PaintbrushTool::CheckIfCurrentSliceHasChanged(), mitk::BoundingShapeInteractor::CheckOverHandles(), mitk::SurfaceDeformationDataInteractor3D::CheckOverObject(), mitk::ClippingPlaneInteractor3D::CheckOverObject(), mitk::AffineBaseDataInteractor3D::CheckOverObject(), mitk::BoundingShapeInteractor::CheckOverObject(), mitk::PointSetDataInteractor::CheckSelection(), mitk::DisplayInteractor::CheckSwivelPossible(), mitk::LiveWireTool2D::ClearSegmentation(), mitk::ExampleInteractor::ConnectActionsAndFunctions(), mitk::SurfaceDeformationDataInteractor3D::DeformObject(), mitk::PlanarFigureInteractor::DeleteFigure(), mitk::SurfaceDeformationDataInteractor3D::DeselectObject(), mitk::ClippingPlaneInteractor3D::DeselectObject(), mitk::DisplayActionEventBroadcast::FilterEvents(), mitk::DisplayInteractor::FilterEvents(), mitk::SegTool2D::FilterEvents(), mitk::PlanarFigureInteractor::FilterEvents(), mitk::EventStateMachine::FilterEvents(), mitk::PointSetDataInteractor::FinishMove(), mitk::SegTool2D::GetAffectedImageSliceAs2DImage(), mitk::InteractionPositionEvent::GetPositionInWorld(), mitk::AffineBaseDataInteractor3D::GetUpdatedTimeGeometry(), mitk::BoundingShapeInteractor::HandlePositionChanged(), mitk::SurfaceDeformationDataInteractor3D::InitDeformation(), mitk::AffineBaseDataInteractor3D::InitMembers(), mitk::ClippingPlaneInteractor3D::InitRotate(), mitk::ClippingPlaneInteractor3D::InitTranslate(), mitk::PointSetDataInteractor::IsClosedContour(), mitk::ContourModelInteractor::IsHovering(), mitk::ContourModelLiveWireInteractor::IsHovering(), mitk::PlanarFigureInteractor::IsMousePositionAcceptableAsNewControlPoint(), mitk::PlanarFigureInteractor::IsPositionOverFigure(), mitk::DisplayInteractor::Move(), mitk::DisplayActionEventBroadcast::Move(), mitk::PointSetDataInteractor::MovePoint(), mitk::ContourModelInteractor::OnCheckPointClick(), mitk::ContourModelLiveWireInteractor::OnCheckPointClick(), mitk::ContourModelLiveWireInteractor::OnDeletePoint(), mitk::ContourModelInteractor::OnFinishEditing(), mitk::ContourModelLiveWireInteractor::OnFinishEditing(), mitk::ContourTool::OnMouseMoved(), mitk::CorrectorTool2D::OnMouseMoved(), mitk::ContourModelInteractor::OnMoveContour(), mitk::ContourModelLiveWireInteractor::OnMovePoint(), mitk::Dispatcher::ProcessEvent(), mitk::PointSetDataInteractor::RemovePoint(), mitk::PlanarFigureInteractor::RemoveSelectedPoint(), mitk::ClippingPlaneInteractor3D::RotateObject(), mitk::AffineImageCropperInteractor::RotateObject(), mitk::AffineBaseDataInteractor3D::RotateObject(), mitk::BoundingShapeInteractor::ScaleObject(), mitk::SurfaceDeformationDataInteractor3D::ScaleRadius(), mitk::DisplayInteractor::Scroll(), mitk::DisplayInteractor::ScrollOneDown(), mitk::DisplayInteractor::ScrollOneUp(), mitk::ClippingPlaneInteractor3D::SelectObject(), mitk::SurfaceDeformationDataInteractor3D::SelectObject(), mitk::PlanarFigureInteractor::SelectPoint(), mitk::PointSetDataInteractor::SelectPoint(), mitk::DisplayInteractor::SetCrosshair(), mitk::GizmoInteractor::SetManipulatedObjectNode(), mitk::PlanarFigureInteractor::SetPreviewPointPosition(), mitk::ClippingPlaneInteractor3D::TranslateObject(), mitk::AffineBaseDataInteractor3D::TranslateObject(), mitk::BoundingShapeInteractor::TranslateObject(), mitk::PointSetDataInteractor::UnSelectAll(), mitk::PointSetDataInteractor::UnSelectPointAtPosition(), mitk::SegTool2D::WriteBackSegmentationResult(), and mitk::DisplayInteractor::Zoom().

◆ GetStaticNameOfClass()

static const char* mitk::InteractionEvent::GetStaticNameOfClass ( )
inlinestatic

Definition at line 29 of file mitkInteractionEvent.h.

◆ IsEqual()

◆ IsSuperClassOf()

bool mitk::InteractionEvent::IsSuperClassOf ( const InteractionEvent::Pointer baseClass) const
virtual

This class implements an up cast to check if the provided baseClass object is derived from this class. This function is used to support polymorphism on state machine pattern (XML) level.

Reimplemented in mitk::InteractionKeyEvent, mitk::InteractionPositionEvent, mitk::MouseWheelEvent, mitk::InternalEvent, mitk::MouseDoubleClickEvent, mitk::MousePressEvent, mitk::MouseReleaseEvent, and mitk::MouseMoveEvent.

Definition at line 68 of file mitkInteractionEvent.cpp.

◆ New()

static Pointer mitk::InteractionEvent::New ( BaseRenderer _arg)
inlinestatic

Definition at line 30 of file mitkInteractionEvent.h.

Referenced by mitk::EventFactory::CreateEvent().

◆ SetSender()

void mitk::InteractionEvent::SetSender ( mitk::BaseRenderer sender)

Definition at line 49 of file mitkInteractionEvent.cpp.

Friends And Related Function Documentation

◆ operator==

MITKCORE_EXPORT bool operator== ( const InteractionEvent ,
const InteractionEvent  
)
friend

Implementation of equality for event classes. Equality does not mean an exact copy or pointer equality.

A match is determined by agreement in all attributes that are necessary to describe the event for a state machine transition. E.g. for a mouse event press event, it is important which modifiers are used, which mouse button was used to triggered the event, but the mouse position is irrelevant.

Member Data Documentation

◆ KeyArrowDown

const std::string mitk::InteractionEvent::KeyArrowDown
static

◆ KeyArrowLeft

const std::string mitk::InteractionEvent::KeyArrowLeft
static

◆ KeyArrowRight

const std::string mitk::InteractionEvent::KeyArrowRight
static

◆ KeyArrowUp

const std::string mitk::InteractionEvent::KeyArrowUp
static

◆ KeyDelete

const std::string mitk::InteractionEvent::KeyDelete
static

◆ KeyEnd

const std::string mitk::InteractionEvent::KeyEnd
static

◆ KeyEnter

const std::string mitk::InteractionEvent::KeyEnter
static

◆ KeyEsc

const std::string mitk::InteractionEvent::KeyEsc
static

KeyConstants Constants for special keys

Definition at line 64 of file mitkInteractionEvent.h.

Referenced by QmitkRenderWindow::AdjustRenderWindowMenuVisibility().

◆ KeyF1

const std::string mitk::InteractionEvent::KeyF1
static

◆ KeyF10

const std::string mitk::InteractionEvent::KeyF10
static

◆ KeyF11

const std::string mitk::InteractionEvent::KeyF11
static

◆ KeyF12

const std::string mitk::InteractionEvent::KeyF12
static

◆ KeyF2

const std::string mitk::InteractionEvent::KeyF2
static

◆ KeyF3

const std::string mitk::InteractionEvent::KeyF3
static

◆ KeyF4

const std::string mitk::InteractionEvent::KeyF4
static

◆ KeyF5

const std::string mitk::InteractionEvent::KeyF5
static

◆ KeyF6

const std::string mitk::InteractionEvent::KeyF6
static

◆ KeyF7

const std::string mitk::InteractionEvent::KeyF7
static

◆ KeyF8

const std::string mitk::InteractionEvent::KeyF8
static

◆ KeyF9

const std::string mitk::InteractionEvent::KeyF9
static

◆ KeyInsert

const std::string mitk::InteractionEvent::KeyInsert
static

◆ KeyPageDown

const std::string mitk::InteractionEvent::KeyPageDown
static

◆ KeyPageUp

const std::string mitk::InteractionEvent::KeyPageUp
static

◆ KeyPos1

const std::string mitk::InteractionEvent::KeyPos1
static

◆ KeyReturn

const std::string mitk::InteractionEvent::KeyReturn
static

◆ KeySpace

const std::string mitk::InteractionEvent::KeySpace
static

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