mitk::DisplayActionEvent Class Reference

Base class for display action events broadcast by DisplayActionEventBroadcast. More...

#include <mitkDisplayActionEvents.h>

Inheritance diagram for mitk::DisplayActionEvent:

Collaboration diagram for mitk::DisplayActionEvent:

Public Types
typedef DisplayActionEvent	Self
typedef itk::AnyEvent	Superclass

Public Member Functions
	DisplayActionEvent ()
	Default constructor with no interaction event. More...
	DisplayActionEvent (InteractionEvent *interactionEvent)
	Construct with the originating interaction event. More...
	~DisplayActionEvent () override
const char *	GetEventName () const override
bool	CheckEvent (const itk::EventObject *e) const override
itk::EventObject *	MakeObject () const override
InteractionEvent *	GetInteractionEvent () const
	Get the originating interaction event. More...
BaseRenderer *	GetSender () const
	Get the BaseRenderer that sent the interaction event. More...
	DisplayActionEvent (const Self &s)
	Copy constructor. More...

Detailed Description

Base class for display action events broadcast by DisplayActionEventBroadcast.

Wraps an InteractionEvent and provides access to the sender BaseRenderer. Subclasses carry additional data specific to each action (move vector, zoom factor, etc.).

See also

DisplayActionEventBroadcast DisplayActionEventHandler

Definition at line 39 of file mitkDisplayActionEvents.h.

Member Typedef Documentation

Self

typedef DisplayActionEvent mitk::DisplayActionEvent::Self

Definition at line 42 of file mitkDisplayActionEvents.h.

Superclass

typedef itk::AnyEvent mitk::DisplayActionEvent::Superclass

Definition at line 43 of file mitkDisplayActionEvents.h.

Constructor & Destructor Documentation

DisplayActionEvent() [1/3]

mitk::DisplayActionEvent::DisplayActionEvent ( )

inline

Default constructor with no interaction event.

Definition at line 46 of file mitkDisplayActionEvents.h.

DisplayActionEvent() [2/3]

mitk::DisplayActionEvent::DisplayActionEvent ( InteractionEvent *  interactionEvent )

inline

Construct with the originating interaction event.

Parameters

interactionEvent

The interaction event that triggered this display action.

Definition at line 52 of file mitkDisplayActionEvents.h.

~DisplayActionEvent()

mitk::DisplayActionEvent::~DisplayActionEvent ( )

inlineoverride

Definition at line 53 of file mitkDisplayActionEvents.h.

DisplayActionEvent() [3/3]

mitk::DisplayActionEvent::DisplayActionEvent ( const Self &  s )

inline

Copy constructor.

Definition at line 74 of file mitkDisplayActionEvents.h.

Member Function Documentation

CheckEvent()

bool mitk::DisplayActionEvent::CheckEvent ( const itk::EventObject *  e ) const

inlineoverride

Definition at line 55 of file mitkDisplayActionEvents.h.

GetEventName()

const char* mitk::DisplayActionEvent::GetEventName ( ) const

inlineoverride

Definition at line 54 of file mitkDisplayActionEvents.h.

GetInteractionEvent()

InteractionEvent* mitk::DisplayActionEvent::GetInteractionEvent ( ) const

inline

Get the originating interaction event.

Returns

The InteractionEvent, or nullptr if not set.

Definition at line 62 of file mitkDisplayActionEvents.h.

GetSender()

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

inline

Get the BaseRenderer that sent the interaction event.

Returns

The sender renderer, or nullptr if no interaction event is set.

Definition at line 68 of file mitkDisplayActionEvents.h.

MakeObject()

itk::EventObject* mitk::DisplayActionEvent::MakeObject ( ) const

inlineoverride

Definition at line 56 of file mitkDisplayActionEvents.h.

---

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

• mitkDisplayActionEvents.h