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< 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 *)
	~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

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

Definition at line 29 of file mitkInteractionEvent.h.

Pointer

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

Definition at line 29 of file mitkInteractionEvent.h.

Self

typedef InteractionEvent mitk::InteractionEvent::Self

Definition at line 29 of file mitkInteractionEvent.h.

Superclass

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

Definition at line 29 of file mitkInteractionEvent.h.

Member Enumeration Documentation

ModifierKeys

enum mitk::InteractionEvent::ModifierKeys

Enumerator
NoKey
ShiftKey
ControlKey
AltKey

Definition at line 52 of file mitkInteractionEvent.h.

MouseButtons

enum mitk::InteractionEvent::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 *  )

protected

~InteractionEvent()

mitk::InteractionEvent::~InteractionEvent ( )

overrideprotected

Member Function Documentation

GetClassHierarchy()

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 29 of file mitkInteractionEvent.h.

GetClassName()

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.

GetSender()

BaseRenderer* mitk::InteractionEvent::GetSender

(

)

const

GetStaticNameOfClass()

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

inlinestatic

Definition at line 29 of file mitkInteractionEvent.h.

IsEqual()

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

IsSuperClassOf()

virtual 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::InteractionPositionEvent, mitk::MouseWheelEvent, mitk::InternalEvent, mitk::InteractionKeyEvent, mitk::MouseDoubleClickEvent, mitk::MousePressEvent, mitk::MouseReleaseEvent, and mitk::MouseMoveEvent.

New()

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

inlinestatic

Definition at line 30 of file mitkInteractionEvent.h.

SetSender()

void mitk::InteractionEvent::SetSender

(

BaseRenderer *

sender

)

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

Definition at line 69 of file mitkInteractionEvent.h.

KeyArrowLeft

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

static

Definition at line 70 of file mitkInteractionEvent.h.

KeyArrowRight

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

static

Definition at line 71 of file mitkInteractionEvent.h.

KeyArrowUp

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

static

Definition at line 68 of file mitkInteractionEvent.h.

KeyDelete

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

static

Definition at line 67 of file mitkInteractionEvent.h.

KeyEnd

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

static

Definition at line 87 of file mitkInteractionEvent.h.

KeyEnter

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

static

Definition at line 65 of file mitkInteractionEvent.h.

KeyEsc

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

static

KeyConstants Constants for special keys

Definition at line 64 of file mitkInteractionEvent.h.

KeyF1

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

static

Definition at line 73 of file mitkInteractionEvent.h.

KeyF10

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

static

Definition at line 82 of file mitkInteractionEvent.h.

KeyF11

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

static

Definition at line 83 of file mitkInteractionEvent.h.

KeyF12

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

static

Definition at line 84 of file mitkInteractionEvent.h.

KeyF2

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

static

Definition at line 74 of file mitkInteractionEvent.h.

KeyF3

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

static

Definition at line 75 of file mitkInteractionEvent.h.

KeyF4

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

static

Definition at line 76 of file mitkInteractionEvent.h.

KeyF5

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

static

Definition at line 77 of file mitkInteractionEvent.h.

KeyF6

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

static

Definition at line 78 of file mitkInteractionEvent.h.

KeyF7

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

static

Definition at line 79 of file mitkInteractionEvent.h.

KeyF8

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

static

Definition at line 80 of file mitkInteractionEvent.h.

KeyF9

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

static

Definition at line 81 of file mitkInteractionEvent.h.

KeyInsert

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

static

Definition at line 88 of file mitkInteractionEvent.h.

KeyPageDown

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

static

Definition at line 90 of file mitkInteractionEvent.h.

KeyPageUp

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

static

Definition at line 89 of file mitkInteractionEvent.h.

KeyPos1

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

static

Definition at line 86 of file mitkInteractionEvent.h.

KeyReturn

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

static

Definition at line 66 of file mitkInteractionEvent.h.

KeySpace

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

static

Definition at line 91 of file mitkInteractionEvent.h.

---

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

• mitkInteractionEvent.h