Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
mitk::InteractionEvent Class Reference

#include <mitkInteractionEvent.h>

Inheritance diagram for mitk::InteractionEvent:
Inheritance graph
[legend]
Collaboration diagram for mitk::InteractionEvent:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
void SetSender (BaseRenderer *sender)
 
BaseRenderer * GetSender () 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 *)
 
virtual ~InteractionEvent ()
 
virtual bool IsEqual (const InteractionEvent &other) const
 

Friends

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

Detailed Description

Definition at line 30 of file mitkInteractionEvent.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::InteractionEvent::ConstPointer

Definition at line 33 of file mitkInteractionEvent.h.

typedef itk::SmartPointer<Self> mitk::InteractionEvent::Pointer

Definition at line 33 of file mitkInteractionEvent.h.

typedef InteractionEvent mitk::InteractionEvent::Self

Definition at line 33 of file mitkInteractionEvent.h.

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

Definition at line 33 of file mitkInteractionEvent.h.

Member Enumeration Documentation

enum mitk::InteractionEvent::ModifierKeys
Enumerator
NoKey 
ShiftKey 
ControlKey 
AltKey 

Definition at line 55 of file mitkInteractionEvent.h.

enum mitk::InteractionEvent::MouseButtons

Mouse/keyboard state values

Enumerator
NoButton 
LeftMouseButton 
RightMouseButton 
MiddleMouseButton 

Definition at line 47 of file mitkInteractionEvent.h.

Constructor & Destructor Documentation

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

Definition at line 49 of file mitkInteractionEvent.cpp.

mitk::InteractionEvent::~InteractionEvent ( )
protectedvirtual

Definition at line 68 of file mitkInteractionEvent.cpp.

Member Function Documentation

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

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

Definition at line 33 of file mitkInteractionEvent.h.

virtual const char* mitk::InteractionEvent::GetClassName ( ) const
virtual

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

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

Definition at line 58 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::ClippingPlaneInteractor3D::CheckOverObject(), mitk::SurfaceDeformationDataInteractor3D::CheckOverObject(), mitk::AffineBaseDataInteractor3D::CheckOverObject(), mitk::DisplayInteractor::CheckRotationPossible(), mitk::PointSetDataInteractor::CheckSelection(), mitk::DisplayInteractor::CheckSwivelPossible(), mitk::SurfaceDeformationDataInteractor3D::DeformObject(), mitk::PlanarFigureInteractor::DeleteFigure(), mitk::AffineImageCropperInteractor::DeselectObject(), mitk::SurfaceDeformationDataInteractor3D::DeselectObject(), mitk::ClippingPlaneInteractor3D::DeselectObject(), mitk::AffineBaseDataInteractor3D::DeselectObject(), mitk::TubeGraphDataInteractor::DeselectTube(), mitk::PlanarFigureInteractor::EndHovering(), mitk::PlanarFigureInteractor::EndInteraction(), mitk::DisplayInteractor::FilterEvents(), mitk::SegTool2D::FilterEvents(), mitk::PlanarFigureInteractor::FilterEvents(), mitk::EventStateMachine::FilterEvents(), mitk::PlanarFigureInteractor::FinalizeFigure(), mitk::PointSetDataInteractor::FinishMove(), mitk::SegTool2D::GetAffectedImageSliceAs2DImage(), mitk::AffineBaseDataInteractor3D::GetUpdatedTimeGeometry(), mitk::PlanarFigureInteractor::HidePreviewPoint(), mitk::DisplayInteractor::Init(), 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::PaintbrushTool::MouseMoved(), mitk::DisplayInteractor::Move(), mitk::PlanarFigureInteractor::MoveCurrentPoint(), mitk::PointSetDataInteractor::MovePoint(), QmitkFreeSurferParcellationHandler::Notify(), mitk::LiveWireTool2D::OnAddPoint(), mitk::FastMarchingTool::OnAddPoint(), mitk::LiveWireTool2D::OnCheckPoint(), mitk::ContourModelInteractor::OnCheckPointClick(), mitk::ContourModelLiveWireInteractor::OnCheckPointClick(), mitk::ContourModelLiveWireInteractor::OnDeletePoint(), mitk::LiveWireTool2D::OnFinish(), mitk::ContourModelInteractor::OnFinishEditing(), mitk::ContourModelLiveWireInteractor::OnFinishEditing(), mitk::LiveWireTool2D::OnInitLiveWire(), mitk::LiveWireTool2D::OnLastSegmentDelete(), mitk::ContourTool::OnMouseMoved(), mitk::CorrectorTool2D::OnMouseMoved(), mitk::LiveWireTool2D::OnMouseMoved(), mitk::RegionGrowingTool::OnMouseMoved(), mitk::SetRegionTool::OnMousePressed(), mitk::ContourTool::OnMousePressed(), mitk::PaintbrushTool::OnMousePressed(), mitk::CorrectorTool2D::OnMousePressed(), mitk::RegionGrowingTool::OnMousePressed(), mitk::RegionGrowingTool::OnMousePressedOutside(), mitk::SetRegionTool::OnMouseReleased(), mitk::ContourTool::OnMouseReleased(), mitk::PaintbrushTool::OnMouseReleased(), mitk::CorrectorTool2D::OnMouseReleased(), mitk::RegionGrowingTool::OnMouseReleased(), mitk::ContourModelInteractor::OnMoveContour(), mitk::ContourModelInteractor::OnMovePoint(), mitk::ContourModelLiveWireInteractor::OnMovePoint(), mitk::Dispatcher::ProcessEvent(), mitk::PointSetDataInteractor::RemovePoint(), mitk::PlanarFigureInteractor::RemoveSelectedPoint(), mitk::ClippingPlaneInteractor3D::RotateObject(), mitk::AffineImageCropperInteractor::RotateObject(), mitk::AffineBaseDataInteractor3D::RotateObject(), mitk::SurfaceDeformationDataInteractor3D::ScaleRadius(), mitk::AffineImageCropperInteractor::ScaleRadius(), mitk::DisplayInteractor::Scroll(), mitk::DisplayInteractor::ScrollOneDown(), mitk::DisplayInteractor::ScrollOneUp(), mitk::AffineImageCropperInteractor::SelectObject(), mitk::SurfaceDeformationDataInteractor3D::SelectObject(), mitk::ClippingPlaneInteractor3D::SelectObject(), mitk::AffineBaseDataInteractor3D::SelectObject(), mitk::PlanarFigureInteractor::SelectPoint(), mitk::PointSetDataInteractor::SelectPoint(), mitk::TubeGraphDataInteractor::SelectTube(), mitk::DisplayInteractor::SetCrosshair(), mitk::PlanarFigureInteractor::SetPreviewPointPosition(), mitk::PlanarFigureInteractor::StartHovering(), mitk::ClippingPlaneInteractor3D::TranslateObject(), mitk::AffineImageCropperInteractor::TranslateObject(), mitk::AffineBaseDataInteractor3D::TranslateObject(), mitk::PointSetDataInteractor::UnSelectAll(), mitk::PointSetDataInteractor::UnSelectPointAtPosition(), mitk::DisplayInteractor::UpdateStatusbar(), mitk::SegTool2D::WriteBackSegmentationResult(), and mitk::DisplayInteractor::Zoom().

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

Definition at line 33 of file mitkInteractionEvent.h.

bool mitk::InteractionEvent::IsEqual ( const InteractionEvent &  other) const
protectedvirtual

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

Definition at line 63 of file mitkInteractionEvent.cpp.

Referenced by mitk::operator==().

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 72 of file mitkInteractionEvent.cpp.

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

Definition at line 33 of file mitkInteractionEvent.h.

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

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

Definition at line 53 of file mitkInteractionEvent.cpp.

Friends And Related Function Documentation

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

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

Definition at line 72 of file mitkInteractionEvent.h.

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

Definition at line 73 of file mitkInteractionEvent.h.

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

Definition at line 74 of file mitkInteractionEvent.h.

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

Definition at line 71 of file mitkInteractionEvent.h.

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

Definition at line 70 of file mitkInteractionEvent.h.

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

Definition at line 90 of file mitkInteractionEvent.h.

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

Definition at line 68 of file mitkInteractionEvent.h.

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

KeyConstants Constants for special keys

Definition at line 67 of file mitkInteractionEvent.h.

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

Definition at line 76 of file mitkInteractionEvent.h.

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

Definition at line 85 of file mitkInteractionEvent.h.

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

Definition at line 86 of file mitkInteractionEvent.h.

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

Definition at line 87 of file mitkInteractionEvent.h.

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

Definition at line 77 of file mitkInteractionEvent.h.

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

Definition at line 78 of file mitkInteractionEvent.h.

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

Definition at line 79 of file mitkInteractionEvent.h.

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

Definition at line 80 of file mitkInteractionEvent.h.

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

Definition at line 81 of file mitkInteractionEvent.h.

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

Definition at line 82 of file mitkInteractionEvent.h.

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

Definition at line 83 of file mitkInteractionEvent.h.

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

Definition at line 84 of file mitkInteractionEvent.h.

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

Definition at line 91 of file mitkInteractionEvent.h.

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

Definition at line 93 of file mitkInteractionEvent.h.

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

Definition at line 92 of file mitkInteractionEvent.h.

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

Definition at line 89 of file mitkInteractionEvent.h.

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

Definition at line 69 of file mitkInteractionEvent.h.

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

Definition at line 94 of file mitkInteractionEvent.h.

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