Base class from with interactors that handle DataNodes are to be derived. More...

#include <mitkDataInteractor.h>

Inheritance diagram for mitk::DataInteractor:

[legend]

Collaboration diagram for mitk::DataInteractor:

[legend]

Public Types
typedef DataInteractor	Self

typedef EventStateMachine	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::EventStateMachine
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

Pointer	Clone () const

DataNode *	GetDataNode () const

virtual void	SetDataNode (DataNode *dataNode)

int	GetLayer () const

ProcessEventMode	GetMode () const

Public Member Functions inherited from mitk::EventStateMachine
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 Pointer	New ()

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

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

Static Public Attributes
static const std::string	IntDeactivateMe

static const std::string	IntLeaveWidget

static const std::string	IntEnterWidget

Protected Member Functions
	DataInteractor ()

	~DataInteractor () override

void	ConnectActionsAndFunctions () override
	Overwrite this function to connect actions from StateMachine description with functions. More...

virtual void	DataNodeChanged ()
	Is called when a DataNode is initially set or changed To be implemented by sub-classes for initialization code which require a DataNode. More...

virtual void	NotifyStart ()
	Sends StartInteraction event via the mitk::DataNode. More...

virtual void	NotifyResultReady ()
	NotifyResultReady Sends ResultReady event via the mitk::DataNode. More...

Protected Member Functions inherited from mitk::EventStateMachine
	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 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 ()

Additional Inherited Members
Protected Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction , InteractionEvent , void >	ActionFunctionDelegate

typedef MessageAbstractDelegate1< const InteractionEvent *, bool >	ConditionFunctionDelegate

Protected Attributes inherited from mitk::EventStateMachine
bool	m_IsActive

UndoController *	m_UndoController

bool	m_UndoEnabled

Detailed Description

Base class from with interactors that handle DataNodes are to be derived.

Base class from with interactors that handle DataNodes are to be derived. Provides an interface that is relevant for the interactor to work together with the dispatcher. To implement a new interactor overwrite the ConnectActionsAndFunctions to connect the actions.

Definition at line 48 of file mitkDataInteractor.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 56 of file mitkDataInteractor.h.

◆ Pointer

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

Definition at line 56 of file mitkDataInteractor.h.

◆ Self

typedef DataInteractor mitk::DataInteractor::Self

Definition at line 56 of file mitkDataInteractor.h.

◆ Superclass

typedef EventStateMachine mitk::DataInteractor::Superclass

Definition at line 56 of file mitkDataInteractor.h.

Constructor & Destructor Documentation

◆ DataInteractor()

mitk::DataInteractor::DataInteractor ( )

protected

◆ ~DataInteractor()

mitk::DataInteractor::~DataInteractor ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::DataInteractor::Clone ( ) const

◆ ConnectActionsAndFunctions()

void mitk::DataInteractor::ConnectActionsAndFunctions ( )

overrideprotectedvirtual

Overwrite this function to connect actions from StateMachine description with functions.

Following example shows how to connect the 'addpoint' action from the StateMachine XML description using the CONNECT_FUNCTION macro with the AddPoint() function in the TestInteractor.

  void mitk::TestInteractor::ConnectActionsAndFunctions()
{
CONNECT_FUNCTION("addpoint", AddPoint);
}

Reimplemented from mitk::EventStateMachine.

Reimplemented in mitk::PointSetDataInteractor, mitk::PlanarFigureInteractor, mitk::AffineBaseDataInteractor3D, mitk::ContourModelLiveWireInteractor, mitk::ContourModelInteractor, mitk::AffineImageCropperInteractor, mitk::ClippingPlaneInteractor3D, and mitk::SurfaceDeformationDataInteractor3D.

◆ DataNodeChanged()

virtual void mitk::DataInteractor::DataNodeChanged ( )

protectedvirtual

Is called when a DataNode is initially set or changed To be implemented by sub-classes for initialization code which require a DataNode.

Note: New DataInteractors usually are expected to have the focus, but this only works if they have the highest Layer, since empty DataNodes have a layer of -1, the DataNode must be filled here in order to get a layer assigned.; Is also called when the DataNode is set to nullptr.

Reimplemented in mitk::PointSetDataInteractor, mitk::BoundingShapeInteractor, mitk::AffineBaseDataInteractor3D, mitk::SinglePointDataInteractor, mitk::AffineImageCropperInteractor, mitk::ClippingPlaneInteractor3D, and mitk::SurfaceDeformationDataInteractor3D.

◆ GetClassHierarchy()

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

inlineoverridevirtual

Reimplemented from mitk::EventStateMachine.

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

Definition at line 56 of file mitkDataInteractor.h.

◆ GetClassName()

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

virtual

Reimplemented from mitk::EventStateMachine.

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

◆ GetDataNode()

DataNode* mitk::DataInteractor::GetDataNode ( ) const

◆ GetLayer()

int mitk::DataInteractor::GetLayer ( ) const

◆ GetMode()

ProcessEventMode mitk::DataInteractor::GetMode ( ) const

◆ GetStaticNameOfClass()

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

inlinestatic

Definition at line 56 of file mitkDataInteractor.h.

◆ New()

static Pointer mitk::DataInteractor::New ( )

static

◆ NotifyResultReady()

virtual void mitk::DataInteractor::NotifyResultReady ( )

protectedvirtual

NotifyResultReady Sends ResultReady event via the mitk::DataNode.

Use to get notfied when the mitk::DataNode is in a ready state for further processing.

◆ NotifyStart()

virtual void mitk::DataInteractor::NotifyStart ( )

protectedvirtual

Sends StartInteraction event via the mitk::DataNode.

◆ SetDataNode()

virtual void mitk::DataInteractor::SetDataNode ( DataNode * dataNode )

virtual

Reimplemented in mitk::AffineBaseDataInteractor3D, and mitk::BoundingShapeInteractor.

Member Data Documentation

◆ IntDeactivateMe

const std::string mitk::DataInteractor::IntDeactivateMe

static

Definition at line 52 of file mitkDataInteractor.h.

◆ IntEnterWidget

const std::string mitk::DataInteractor::IntEnterWidget

static

Definition at line 54 of file mitkDataInteractor.h.

◆ IntLeaveWidget

const std::string mitk::DataInteractor::IntLeaveWidget

static

Definition at line 53 of file mitkDataInteractor.h.

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

mitkDataInteractor.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ DataInteractor()

◆ ~DataInteractor()

Member Function Documentation

◆ Clone()

◆ ConnectActionsAndFunctions()

◆ DataNodeChanged()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetDataNode()

◆ GetLayer()

◆ GetMode()

◆ GetStaticNameOfClass()

◆ New()

◆ NotifyResultReady()

◆ NotifyStart()

◆ SetDataNode()

Member Data Documentation

◆ IntDeactivateMe

◆ IntEnterWidget

◆ IntLeaveWidget