Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::MouseWheelEvent Class Reference

#include <mitkMouseWheelEvent.h>

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

Public Types

typedef MouseWheelEvent Self
 
typedef InteractionPositionEvent Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
- Public Types inherited from mitk::InteractionPositionEvent
typedef InteractionPositionEvent Self
 
typedef InteractionEvent Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
- 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< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
ModifierKeys GetModifiers () const
 
MouseButtons GetButtonStates () const
 
void SetModifiers (ModifierKeys modifiers)
 
void SetButtonStates (MouseButtons buttons)
 
int GetWheelDelta () const
 
void SetWheelDelta (int delta)
 
bool IsSuperClassOf (const InteractionEvent::Pointer &baseClass) const override
 
- Public Member Functions inherited from mitk::InteractionPositionEvent
Point2D GetPointerPositionOnScreen () const
 
Point3D GetPositionInWorld () const
 
- Public Member Functions inherited from mitk::InteractionEvent
void SetSender (BaseRenderer *sender)
 
BaseRenderer * GetSender () const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New (BaseRenderer *_arga, const Point2D &_argb, MouseButtons _argc, ModifierKeys _argd, int _arge)
 
- Static Public Member Functions inherited from mitk::InteractionPositionEvent
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

 MouseWheelEvent (BaseRenderer *=nullptr, const Point2D &mousePosition=Point2D(), MouseButtons buttonStates=NoButton, ModifierKeys modifiers=NoKey, int wheelDelta=0)
 
 ~MouseWheelEvent () override
 
bool IsEqual (const InteractionEvent &) const override
 
- 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

- 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

Definition at line 32 of file mitkMouseWheelEvent.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 35 of file mitkMouseWheelEvent.h.

◆ Pointer

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

Definition at line 35 of file mitkMouseWheelEvent.h.

◆ Self

typedef MouseWheelEvent mitk::MouseWheelEvent::Self

Definition at line 35 of file mitkMouseWheelEvent.h.

◆ Superclass

typedef InteractionPositionEvent mitk::MouseWheelEvent::Superclass

Definition at line 35 of file mitkMouseWheelEvent.h.

Constructor & Destructor Documentation

◆ MouseWheelEvent()

mitk::MouseWheelEvent::MouseWheelEvent ( BaseRenderer *  baseRenderer = nullptr,
const Point2D &  mousePosition = Point2D(),
MouseButtons  buttonStates = NoButton,
ModifierKeys  modifiers = NoKey,
int  wheelDelta = 0 
)
protected

Definition at line 15 of file mitkMouseWheelEvent.cpp.

◆ ~MouseWheelEvent()

mitk::MouseWheelEvent::~MouseWheelEvent ( )
overrideprotected

Definition at line 57 of file mitkMouseWheelEvent.cpp.

Member Function Documentation

◆ GetButtonStates()

mitk::InteractionEvent::MouseButtons mitk::MouseWheelEvent::GetButtonStates ( ) const

Definition at line 42 of file mitkMouseWheelEvent.cpp.

Referenced by GetButtonState(), and IsEqual().

◆ GetClassHierarchy()

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

Reimplemented from mitk::InteractionPositionEvent.

Definition at line 35 of file mitkMouseWheelEvent.h.

◆ GetClassName()

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

Reimplemented from mitk::InteractionPositionEvent.

◆ GetModifiers()

mitk::InteractionEvent::ModifierKeys mitk::MouseWheelEvent::GetModifiers ( ) const

Definition at line 37 of file mitkMouseWheelEvent.cpp.

Referenced by GetModifierState(), and IsEqual().

◆ GetStaticNameOfClass()

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

Definition at line 35 of file mitkMouseWheelEvent.h.

◆ GetWheelDelta()

int mitk::MouseWheelEvent::GetWheelDelta ( ) const

Definition at line 27 of file mitkMouseWheelEvent.cpp.

Referenced by mitk::EventFactory::EventToXML(), and IsEqual().

◆ IsEqual()

bool mitk::MouseWheelEvent::IsEqual ( const InteractionEvent &  interactionEvent) const
overrideprotectedvirtual

Reimplemented from mitk::InteractionPositionEvent.

Definition at line 61 of file mitkMouseWheelEvent.cpp.

References GetButtonStates(), GetModifiers(), GetWheelDelta(), and mitk::InteractionPositionEvent::IsEqual().

◆ IsSuperClassOf()

bool mitk::MouseWheelEvent::IsSuperClassOf ( const InteractionEvent::Pointer &  baseClass) const
overridevirtual

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::InteractionPositionEvent.

Definition at line 71 of file mitkMouseWheelEvent.cpp.

◆ New()

static Pointer mitk::MouseWheelEvent::New ( BaseRenderer *  _arga,
const Point2D &  _argb,
MouseButtons  _argc,
ModifierKeys  _argd,
int  _arge 
)
inlinestatic

Definition at line 36 of file mitkMouseWheelEvent.h.

Referenced by mitk::VtkEventAdapter::AdaptMouseWheelEvent(), mitk::EventFactory::CreateEvent(), mitkEventConfigTest(), and QmitkRenderWindow::wheelEvent().

◆ SetButtonStates()

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

Definition at line 52 of file mitkMouseWheelEvent.cpp.

◆ SetModifiers()

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

Definition at line 47 of file mitkMouseWheelEvent.cpp.

◆ SetWheelDelta()

void mitk::MouseWheelEvent::SetWheelDelta ( int  delta)

Definition at line 32 of file mitkMouseWheelEvent.cpp.

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