Medical Imaging Interaction Toolkit  2024.06.99-b3904305
Medical Imaging Interaction Toolkit
mitk::InteractionPositionEvent Class Reference

Super class for all position events. More...

#include <mitkInteractionPositionEvent.h>

Inheritance diagram for mitk::InteractionPositionEvent:
Collaboration diagram for mitk::InteractionPositionEvent:

Public Types

typedef InteractionPositionEvent Self
typedef InteractionEvent Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer
- Public Types inherited from mitk::InteractionEvent
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 override
virtual const char * GetClassName () const
Point2D GetPointerPositionOnScreen () const
Point3D GetPositionInWorld () const
bool IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
- Public Member Functions inherited from mitk::InteractionEvent
void SetSender (BaseRenderer *sender)
BaseRendererGetSender () const

Static Public Member Functions

static const char * GetStaticNameOfClass ()
static Pointer New (BaseRenderer *_arga, const Point2D &_argb)
- Static Public Member Functions inherited from mitk::InteractionEvent
static const char * GetStaticNameOfClass ()
static Pointer New (BaseRenderer *_arg)

Protected Member Functions

 InteractionPositionEvent (BaseRenderer *baseRenderer, const Point2D &mousePosition)
 ~InteractionPositionEvent () override
bool IsEqual (const InteractionEvent &) const override
- Protected Member Functions inherited from mitk::InteractionEvent
 InteractionEvent (BaseRenderer *)
 ~InteractionEvent () override

Additional Inherited Members

- Static Public Attributes inherited from mitk::InteractionEvent
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

Detailed Description

Super class for all position events.

This class is instantiated with a BaseRenderer and the 2D pointer position relative to the renderer, the object then queries the Renderer for 3D world coordinates and supplies them to deriving classes.

Definition at line 36 of file mitkInteractionPositionEvent.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ InteractionPositionEvent()

mitk::InteractionPositionEvent::InteractionPositionEvent ( BaseRenderer baseRenderer,
const Point2D mousePosition 

◆ ~InteractionPositionEvent()

mitk::InteractionPositionEvent::~InteractionPositionEvent ( )

Member Function Documentation

◆ GetClassHierarchy()

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

◆ GetClassName()

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

◆ GetPointerPositionOnScreen()

Point2D mitk::InteractionPositionEvent::GetPointerPositionOnScreen ( ) const

◆ GetPositionInWorld()

Point3D mitk::InteractionPositionEvent::GetPositionInWorld ( ) const

◆ GetStaticNameOfClass()

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

Definition at line 39 of file mitkInteractionPositionEvent.h.

◆ IsEqual()

bool mitk::InteractionPositionEvent::IsEqual ( const InteractionEvent ) const

◆ IsSuperClassOf()

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

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 from mitk::InteractionEvent.

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

◆ New()

static Pointer mitk::InteractionPositionEvent::New ( BaseRenderer _arga,
const Point2D _argb 

Definition at line 40 of file mitkInteractionPositionEvent.h.

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