Interaction event class representing a mouse button press. More...

#include <mitkMousePressEvent.h>

Inheritance diagram for mitk::MousePressEvent:

[legend]

Collaboration diagram for mitk::MousePressEvent:

[legend]

Public Member Functions
	mitkClassMacro (MousePressEvent, InteractionPositionEvent) mitkNewMacro5Param(Self

BaseRenderer const Point2D MouseButtons ModifierKeys	GetModifiers () const
	Get the active modifier keys (Shift, Ctrl, Alt, etc.). More...

MouseButtons	GetButtonStates () const
	Get the combined state of all mouse buttons at the time of the event. More...

void	SetModifiers (ModifierKeys modifiers)
	Set the active modifier keys. More...

void	SetButtonStates (MouseButtons buttons)
	Set the combined mouse button state. More...

MouseButtons	GetEventButton () const
	Get the specific mouse button that triggered this press event. More...

void	SetEventButton (MouseButtons buttons)
	Set the mouse button that triggered this press event. More...

bool	IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
	Check if the given event is an instance of this class or a subclass. More...

Public Member Functions inherited from mitk::InteractionPositionEvent
	mitkClassMacro (InteractionPositionEvent, InteractionEvent)

	mitkNewMacro2Param (Self, BaseRenderer *, const Point2D &)

Point2D	GetPointerPositionOnScreen () const
	Get the pointer position in display (screen) coordinates. More...

Point3D	GetPositionInWorld () const
	Get the pointer position converted to 3D world coordinates. More...

Public Member Functions inherited from mitk::InteractionEvent
	mitkClassMacroItkParent (InteractionEvent, itk::LightObject)

	mitkNewMacro1Param (Self, BaseRenderer *)

void	SetSender (BaseRenderer *sender)
	Set the BaseRenderer that sent this event. More...

BaseRenderer *	GetSender () const
	Get the BaseRenderer that sent this event. More...

Public Attributes
BaseRenderer const Point2D	MouseButtons

BaseRenderer const Point2D	ModifierKeys

Protected Member Functions
	MousePressEvent (BaseRenderer *, const Point2D &=Point2D(), MouseButtons buttonStates=NoButton, ModifierKeys modifiers=NoKey, MouseButtons eventButton=NoButton)

	~MousePressEvent () override

bool	IsEqual (const InteractionEvent &) const override
	Compare this event to another for equality. More...

Protected Member Functions inherited from mitk::InteractionPositionEvent
	InteractionPositionEvent (BaseRenderer *baseRenderer, const Point2D &mousePosition)

	~InteractionPositionEvent () override

Protected Member Functions inherited from mitk::InteractionEvent
	InteractionEvent (BaseRenderer *)

	~InteractionEvent () override

Additional Inherited Members
Public Types inherited from mitk::InteractionEvent
enum	MouseButtons { NoButton , LeftMouseButton , RightMouseButton , MiddleMouseButton }
	Enumeration of mouse button states. More...

enum	ModifierKeys { NoKey , ShiftKey , ControlKey , AltKey }
	Enumeration of keyboard modifier keys. More...

Static Public Attributes inherited from mitk::InteractionEvent
static const std::string	KeyEsc
	String constants for special keys used in key events and state machine patterns. More...

static const std::string	KeyEnter
	"Enter" key constant. More...

static const std::string	KeyReturn
	"Return" key constant. More...

static const std::string	KeyDelete
	"Delete" key constant. More...

static const std::string	KeyArrowUp
	"ArrowUp" key constant. More...

static const std::string	KeyArrowDown
	"ArrowDown" key constant. More...

static const std::string	KeyArrowLeft
	"ArrowLeft" key constant. More...

static const std::string	KeyArrowRight
	"ArrowRight" key constant. More...

static const std::string	KeyF1
	"F1" key constant. More...

static const std::string	KeyF2
	"F2" key constant. More...

static const std::string	KeyF3
	"F3" key constant. More...

static const std::string	KeyF4
	"F4" key constant. More...

static const std::string	KeyF5
	"F5" key constant. More...

static const std::string	KeyF6
	"F6" key constant. More...

static const std::string	KeyF7
	"F7" key constant. More...

static const std::string	KeyF8
	"F8" key constant. More...

static const std::string	KeyF9
	"F9" key constant. More...

static const std::string	KeyF10
	"F10" key constant. More...

static const std::string	KeyF11
	"F11" key constant. More...

static const std::string	KeyF12
	"F12" key constant. More...

static const std::string	KeyPos1
	"Pos1" (Home) key constant. More...

static const std::string	KeyEnd
	"End" key constant. More...

static const std::string	KeyInsert
	"Insert" key constant. More...

static const std::string	KeyPageUp
	"PageUp" key constant. More...

static const std::string	KeyPageDown
	"PageDown" key constant. More...

static const std::string	KeySpace
	"Space" key constant. More...

Detailed Description

Interaction event class representing a mouse button press.

Stores the mouse position, the button that was pressed, the combined state of all mouse buttons, and any active modifier keys.

See also: MouseReleaseEvent; MouseDoubleClickEvent; InteractionPositionEvent

Definition at line 39 of file mitkMousePressEvent.h.

Constructor & Destructor Documentation

◆ MousePressEvent()

mitk::MousePressEvent::MousePressEvent	(	BaseRenderer *	,
		const Point2D &	= `Point2D()`,
		MouseButtons	buttonStates = `NoButton`,
		ModifierKeys	modifiers = `NoKey`,
		MouseButtons	eventButton = `NoButton`
	)

protected

◆ ~MousePressEvent()

mitk::MousePressEvent::~MousePressEvent ( )

overrideprotected

Member Function Documentation

◆ GetButtonStates()

MouseButtons mitk::MousePressEvent::GetButtonStates ( ) const

Get the combined state of all mouse buttons at the time of the event.

◆ GetEventButton()

MouseButtons mitk::MousePressEvent::GetEventButton ( ) const

Get the specific mouse button that triggered this press event.

◆ GetModifiers()

BaseRenderer const Point2D MouseButtons ModifierKeys mitk::MousePressEvent::GetModifiers ( ) const

Get the active modifier keys (Shift, Ctrl, Alt, etc.).

◆ IsEqual()

bool mitk::MousePressEvent::IsEqual ( const InteractionEvent & ) const

overrideprotectedvirtual

Compare this event to another for equality.

Two MousePressEvent instances are equal if they share the same event button, modifier keys, button states, and position.

Reimplemented from mitk::InteractionPositionEvent.

◆ IsSuperClassOf()

bool mitk::MousePressEvent::IsSuperClassOf ( const InteractionEvent::Pointer & baseClass ) const

overridevirtual

Check if the given event is an instance of this class or a subclass.

Returns: true if baseClass is a MousePressEvent.

Reimplemented from mitk::InteractionPositionEvent.

◆ mitkClassMacro()

mitk::MousePressEvent::mitkClassMacro	(	MousePressEvent	,
		InteractionPositionEvent
	)

◆ SetButtonStates()

void mitk::MousePressEvent::SetButtonStates ( MouseButtons buttons )

Set the combined mouse button state.

◆ SetEventButton()

void mitk::MousePressEvent::SetEventButton ( MouseButtons buttons )

Set the mouse button that triggered this press event.

◆ SetModifiers()

void mitk::MousePressEvent::SetModifiers ( ModifierKeys modifiers )

Set the active modifier keys.

Member Data Documentation

◆ ModifierKeys

BaseRenderer const Point2D mitk::MousePressEvent::ModifierKeys

Definition at line 43 of file mitkMousePressEvent.h.

◆ MouseButtons

BaseRenderer const Point2D mitk::MousePressEvent::MouseButtons