mitk::InteractionEventHandler Class Reference

#include <mitkInteractionEventHandler.h>

Inheritance diagram for mitk::InteractionEventHandler:

Collaboration diagram for mitk::InteractionEventHandler:

Public Types
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
virtual const char *	GetClassName () const
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 ()

Protected Member Functions
	InteractionEventHandler ()
	~InteractionEventHandler () override
PropertyList::Pointer	GetAttributes () const
std::string	MapToEventVariant (InteractionEvent *interactionEvent)
virtual void	ConfigurationChanged ()

Detailed Description

Definition at line 40 of file mitkInteractionEventHandler.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 43 of file mitkInteractionEventHandler.h.

Pointer

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

Definition at line 43 of file mitkInteractionEventHandler.h.

Self

typedef InteractionEventHandler mitk::InteractionEventHandler::Self

Definition at line 43 of file mitkInteractionEventHandler.h.

Superclass

typedef itk::Object mitk::InteractionEventHandler::Superclass

Definition at line 43 of file mitkInteractionEventHandler.h.

Constructor & Destructor Documentation

InteractionEventHandler()

mitk::InteractionEventHandler::InteractionEventHandler ( )

protected

~InteractionEventHandler()

mitk::InteractionEventHandler::~InteractionEventHandler ( )

overrideprotected

Member Function Documentation

AddEventConfig() [1/2]

bool mitk::InteractionEventHandler::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.

See also

AddEventConfig(const std::string&, const Module*)

Parameters

config

The EventConfig object whose configuration should be added.

Returns

true if the configuration was successfully added, false otherwise.

AddEventConfig() [2/2]

bool mitk::InteractionEventHandler::AddEventConfig	(	const std::string &	filename,
		const us::Module *	module = nullptr
	)

This method extends the configuration.

The configuration from the resource provided is loaded and only the ones conflicting are replaced by the new one. This way several configuration files can be combined.

See also

AddEventConfig(const EventConfig&)

Parameters

filename	The resource name relative to the Interactions resource folder.
module	The module containing the resource. Defaults to the Mitk module.

Returns

true if the configuration was successfully added, false otherwise.

ConfigurationChanged()

virtual void mitk::InteractionEventHandler::ConfigurationChanged ( )

protectedvirtual

Is called whenever a new config object is set. Overwrite this method e.g. to initialize EventHandler with parameters in configuration file.

Reimplemented in mitk::PlanarFigureInteractor, mitk::DisplayActionEventBroadcast, and mitk::ExampleInteractor.

GetAttributes()

PropertyList::Pointer mitk::InteractionEventHandler::GetAttributes ( ) const

protected

Returns a PropertyList in which the parameters defined in the config file are listed.

GetClassHierarchy()

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

inlinevirtual

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

Definition at line 43 of file mitkInteractionEventHandler.h.

GetClassName()

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

virtual

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

GetEventConfig()

EventConfig mitk::InteractionEventHandler::GetEventConfig

(

)

const

Returns the current configuration.

Returns

A EventConfig object representing the current event configuration.

GetStaticNameOfClass()

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

inlinestatic

Definition at line 43 of file mitkInteractionEventHandler.h.

MapToEventVariant()

std::string mitk::InteractionEventHandler::MapToEventVariant ( InteractionEvent *  interactionEvent )

protected

SetEventConfig() [1/2]

bool mitk::InteractionEventHandler::SetEventConfig

(

const EventConfig &

config

)

Loads a configuration from an EventConfig object.

Loads an event configuration from the given EventConfig object. This method will remove all existing configuration and replaces it with the new one.

See also

SetEventConfig(const std::string&, const Module*)

Parameters

config

The EventConfig object containing the new configuration.

Returns

true if the configuration was successfully loaded, false otherwise.

SetEventConfig() [2/2]

bool mitk::InteractionEventHandler::SetEventConfig	(	const std::string &	filename,
		const us::Module *	module = nullptr
	)

Loads a configuration from an XML resource.

Loads an event configuration from an XML resource file contained in the given module. Default is the Mitk module (core). The files have to be placed in the Resources/Interactions folder of their respective module. This method will remove all existing configuration and replaces it with the new one.

See also

SetEventConfig(const EventConfig&)

Parameters

filename	The resource name relative to the Interactions resource folder.
module	The module containing the resource. Defaults to the Mitk module.

Returns

true if the resource was successfully loaded, false otherwise.

---

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

• mitkInteractionEventHandler.h