#include <mitkEventStateMachine.h>

Inheritance diagram for mitk::EventStateMachine:

[legend]

Collaboration diagram for mitk::EventStateMachine:

[legend]

Public Types
typedef EventStateMachine	Self

typedef InteractionEventHandler	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef std::map< std::string, TActionFunctor * >	ActionFunctionsMapType

typedef itk::SmartPointer< StateMachineState >	StateMachineStateType

Public Types inherited from mitk::InteractionEventHandler
typedef InteractionEventHandler	Self

typedef itk::Object	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

bool	LoadStateMachine (const std::string &filename, const us::Module *module=nullptr)
	Loads XML resource. More...

bool	HandleEvent (InteractionEvent event, DataNode dataNode)

void	EnableUndo (bool enable)
	Enables or disabled Undo. More...

void	EnableInteraction (bool enable)
	Enables/disables the state machine. In un-enabled state it won't react to any events. More...

Public Member Functions inherited from mitk::InteractionEventHandler
bool	SetEventConfig (const std::string &filename, const us::Module *module=nullptr)
	Loads a configuration from an XML resource. More...

bool	SetEventConfig (const EventConfig &config)
	Loads a configuration from an EventConfig object. More...

EventConfig	GetEventConfig () const
	Returns the current configuration. More...

bool	AddEventConfig (const std::string &filename, const us::Module *module=nullptr)
	This method extends the configuration. More...

bool	AddEventConfig (const EventConfig &config)
	This method extends the configuration. The configuration from the EventConfig object is loaded and only the ones conflicting are replaced by the new one. This way several configurations can be combined. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Static Public Member Functions inherited from mitk::InteractionEventHandler
static const char *	GetStaticNameOfClass ()

Protected Types
typedef MessageAbstractDelegate2< StateMachineAction , InteractionEvent , void >	ActionFunctionDelegate

typedef MessageAbstractDelegate1< const InteractionEvent *, bool >	ConditionFunctionDelegate

Protected Member Functions
	EventStateMachine ()

	~EventStateMachine () override

void	AddActionFunction (const std::string &action, TActionFunctor *functor)

void	AddActionFunction (const std::string &action, const ActionFunctionDelegate &delegate)

void	AddConditionFunction (const std::string &condition, const ConditionFunctionDelegate &delegate)

StateMachineState *	GetCurrentState () const

void	ResetToStartState ()
	ResetToStartState Reset state machine to it initial starting state. More...

virtual void	ConnectActionsAndFunctions ()

virtual bool	CheckCondition (const StateMachineCondition &condition, const InteractionEvent *interactionEvent)

virtual void	ExecuteAction (StateMachineAction action, InteractionEvent interactionEvent)

virtual bool	FilterEvents (InteractionEvent interactionEvent, DataNode dataNode)

void	SetMouseCursor (const char *xpm[], int hotspotX, int hotspotY)
	Sets the specified mouse cursor. More...

void	ResetMouseCursor ()
	Resets the mouse cursor to its original state. More...

StateMachineTransition *	GetExecutableTransition (InteractionEvent *event)
	Returns the executable transition for the given event. More...

Protected Member Functions inherited from mitk::InteractionEventHandler
	InteractionEventHandler ()

	~InteractionEventHandler () override

PropertyList::Pointer	GetAttributes () const

std::string	MapToEventVariant (InteractionEvent *interactionEvent)

virtual void	ConfigurationChanged ()

Protected Attributes
bool	m_IsActive

UndoController *	m_UndoController

bool	m_UndoEnabled

Detailed Description

‍**

Super-class that provides the functionality of a StateMachine to DataInteractors.

A state machine is created by loading a state machine pattern. It consists of states, transitions and action. The state represent the current status of the interaction, transitions are means to switch between states. Each transition is triggered by an event and it is associated with actions that are to be executed when the state change is performed.

Definition at line 111 of file mitkEventStateMachine.h.

Member Typedef Documentation

◆ ActionFunctionDelegate

typedef MessageAbstractDelegate2<StateMachineAction *, InteractionEvent *, void> mitk::EventStateMachine::ActionFunctionDelegate

protected

Definition at line 156 of file mitkEventStateMachine.h.

◆ ActionFunctionsMapType

typedef std::map<std::string, TActionFunctor *> mitk::EventStateMachine::ActionFunctionsMapType

Definition at line 114 of file mitkEventStateMachine.h.

◆ ConditionFunctionDelegate

typedef MessageAbstractDelegate1<const InteractionEvent *, bool> mitk::EventStateMachine::ConditionFunctionDelegate

protected

Definition at line 157 of file mitkEventStateMachine.h.

◆ ConstPointer

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

Definition at line 114 of file mitkEventStateMachine.h.

◆ Pointer

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

Definition at line 114 of file mitkEventStateMachine.h.

◆ Self

typedef EventStateMachine mitk::EventStateMachine::Self

Definition at line 114 of file mitkEventStateMachine.h.

◆ StateMachineStateType

typedef itk::SmartPointer<StateMachineState> mitk::EventStateMachine::StateMachineStateType

Definition at line 118 of file mitkEventStateMachine.h.

◆ Superclass

typedef InteractionEventHandler mitk::EventStateMachine::Superclass

Definition at line 114 of file mitkEventStateMachine.h.

Constructor & Destructor Documentation

◆ EventStateMachine()

mitk::EventStateMachine::EventStateMachine ( )

protected

◆ ~EventStateMachine()

mitk::EventStateMachine::~EventStateMachine ( )

overrideprotected

Member Function Documentation

◆ AddActionFunction() [1/2]

void mitk::EventStateMachine::AddActionFunction	(	const std::string &	action,
		const ActionFunctionDelegate &	delegate
	)

protected

◆ AddActionFunction() [2/2]

void mitk::EventStateMachine::AddActionFunction	(	const std::string &	action,
		TActionFunctor *	functor
	)

protected

Connects action from StateMachine (String in XML file) with a function that is called when this action is to be executed.

◆ AddConditionFunction()

void mitk::EventStateMachine::AddConditionFunction	(	const std::string &	condition,
		const ConditionFunctionDelegate &	delegate
	)

protected

◆ CheckCondition()

virtual bool mitk::EventStateMachine::CheckCondition	(	const StateMachineCondition &	condition,
		const InteractionEvent *	interactionEvent
	)

protectedvirtual

◆ ConnectActionsAndFunctions()

virtual void mitk::EventStateMachine::ConnectActionsAndFunctions ( )

protectedvirtual

Is called after loading a statemachine. Overwrite this function in specific interactor implementations. Connect actions and functions using the CONNECT_FUNCTION macro within this function.

Reimplemented in mitk::Tool, mitk::MonaiLabelTool, mitk::SegmentAnythingTool, mitk::PointSetDataInteractor, mitk::DataInteractor, mitk::PlanarFigureInteractor, mitk::RegionGrowingTool, mitk::ContourTool, mitk::PickingTool, mitk::LiveWireTool2D, mitk::EditableContourTool, mitk::DisplayActionEventBroadcast, mitk::BoundingShapeInteractor, mitk::AffineBaseDataInteractor3D, mitk::LassoTool, mitk::PaintbrushTool, mitk::FillRegionBaseTool, mitk::MedSAMTool, mitk::ContourModelLiveWireInteractor, mitk::ContourModelInteractor, mitk::AffineImageCropperInteractor, mitk::ClippingPlaneInteractor3D, mitk::SurfaceDeformationDataInteractor3D, and mitk::ExampleInteractor.

◆ EnableInteraction()

void mitk::EventStateMachine::EnableInteraction ( bool enable )

inline

Enables/disables the state machine. In un-enabled state it won't react to any events.

Definition at line 151 of file mitkEventStateMachine.h.

◆ EnableUndo()

void mitk::EventStateMachine::EnableUndo ( bool enable )

inline

Enables or disabled Undo.

Definition at line 147 of file mitkEventStateMachine.h.

◆ ExecuteAction()

virtual void mitk::EventStateMachine::ExecuteAction	(	StateMachineAction *	action,
		InteractionEvent *	interactionEvent
	)

protectedvirtual

Looks up function that is associated with action and executes it. To implement your own execution scheme overwrite this in your DataInteractor.

◆ FilterEvents()

virtual bool mitk::EventStateMachine::FilterEvents	(	InteractionEvent *	interactionEvent,
		DataNode *	dataNode
	)

protectedvirtual

Implements filter scheme for events. Standard implementation accepts events from 2d and 3d windows, and rejects events if DataNode is not visible.

Returns: true if event is accepted, else false

Overwrite this function to adapt for your own needs, for example to filter out events from 3d windows like this:

bool mitk::EventStateMachine::FilterEvents(InteractionEvent* interactionEvent, DataNode*dataNode)
{
  return interactionEvent->GetSender()->GetMapperID() == BaseRenderer::Standard2D; // only 2D mappers
}

or to enforce that the interactor only reacts when the corresponding DataNode is selected in the DataManager view..

Reimplemented in mitk::SegTool2D, mitk::DisplayActionEventBroadcast, mitk::PlanarFigureInteractor, and mitk::Tool.

◆ GetClassHierarchy()

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

inlineoverridevirtual

Reimplemented from mitk::InteractionEventHandler.

Reimplemented in mitk::PointSetDataInteractor, mitk::DataInteractor, mitk::SinglePointDataInteractor, and mitk::DisplayActionEventBroadcast.

Definition at line 114 of file mitkEventStateMachine.h.

◆ GetClassName()

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

virtual

Reimplemented from mitk::InteractionEventHandler.

Reimplemented in mitk::PointSetDataInteractor, mitk::DataInteractor, mitk::SinglePointDataInteractor, and mitk::DisplayActionEventBroadcast.

◆ GetCurrentState()

StateMachineState* mitk::EventStateMachine::GetCurrentState ( ) const

protected

◆ GetExecutableTransition()

StateMachineTransition* mitk::EventStateMachine::GetExecutableTransition ( InteractionEvent * event )

protected

Returns the executable transition for the given event.

This method takes a list of transitions that correspond to the given event from the current state.

This method iterates through all transitions and checks all corresponding conditions. The results of each condition in stored in map, as other transitions may need the same condition again.

As soon as a transition is found for which all conditions are fulfilled, this instance is returned.

If a transition has no condition, it is automatically returned. If no executable transition is found, nullptr is returned.

◆ GetStaticNameOfClass()

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

inlinestatic

Definition at line 114 of file mitkEventStateMachine.h.

◆ HandleEvent()

bool mitk::EventStateMachine::HandleEvent	(	InteractionEvent *	event,
		DataNode *	dataNode
	)

Receives Event from Dispatcher. Event is mapped using the EventConfig Object to a variant, then it is checked if the StateMachine is listening for such an Event. If this is the case, the transition to the next state it performed and all actions associated with the transition executed, and true is returned to the caller. If the StateMachine can't handle this event false is returned. Attention: If a transition is associated with multiple actions - "true" is returned if one action returns true, and the event is treated as HANDLED even though some actions might not have been executed! So be sure that all actions that occur within one transitions have the same conditions.

◆ LoadStateMachine()

bool mitk::EventStateMachine::LoadStateMachine	(	const std::string &	filename,
		const us::Module *	module = `nullptr`
	)

Loads XML resource.

Loads a XML resource file from the given module. Default is the Mitk module (core). The files have to be placed in the Resources/Interaction folder of their respective module.

◆ ResetMouseCursor()

void mitk::EventStateMachine::ResetMouseCursor ( )

protected

Resets the mouse cursor to its original state.

Should be used by subclasses and from external application instead of using QmitkApplicationCursor directly to avoid conflicts.

◆ ResetToStartState()

void mitk::EventStateMachine::ResetToStartState ( )

protected

ResetToStartState Reset state machine to it initial starting state.

◆ SetMouseCursor()

void mitk::EventStateMachine::SetMouseCursor	(	const char *	xpm[],
		int	hotspotX,
		int	hotspotY
	)

protected

Sets the specified mouse cursor.

Use this in subclasses instead of using QmitkApplicationCursor directly.

Member Data Documentation

◆ m_IsActive

bool mitk::EventStateMachine::m_IsActive

protected

Definition at line 243 of file mitkEventStateMachine.h.

◆ m_UndoController

UndoController* mitk::EventStateMachine::m_UndoController

protected

Definition at line 245 of file mitkEventStateMachine.h.

◆ m_UndoEnabled

bool mitk::EventStateMachine::m_UndoEnabled

protected

Definition at line 246 of file mitkEventStateMachine.h.

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

mitkEventStateMachine.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ActionFunctionDelegate

◆ ActionFunctionsMapType

◆ ConditionFunctionDelegate

◆ ConstPointer

◆ Pointer

◆ Self

◆ StateMachineStateType

◆ Superclass

Constructor & Destructor Documentation

◆ EventStateMachine()

◆ ~EventStateMachine()

Member Function Documentation

◆ AddActionFunction() [1/2]

◆ AddActionFunction() [2/2]

◆ AddConditionFunction()

◆ CheckCondition()

◆ ConnectActionsAndFunctions()

◆ EnableInteraction()

◆ EnableUndo()

◆ ExecuteAction()

◆ FilterEvents()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetCurrentState()

◆ GetExecutableTransition()

◆ GetStaticNameOfClass()

◆ HandleEvent()

◆ LoadStateMachine()

◆ ResetMouseCursor()

◆ ResetToStartState()

◆ SetMouseCursor()

Member Data Documentation

◆ m_IsActive

◆ m_UndoController

◆ m_UndoEnabled