Medical Imaging Interaction Toolkit  2018.4.99-b20efe7f
Medical Imaging Interaction Toolkit
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

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

◆ Pointer

◆ Self

◆ Superclass

Definition at line 43 of file mitkInteractionEventHandler.h.

Constructor & Destructor Documentation

◆ InteractionEventHandler()

mitk::InteractionEventHandler::InteractionEventHandler ( )
protected

Definition at line 16 of file mitkInteractionEventHandler.cpp.

◆ ~InteractionEventHandler()

mitk::InteractionEventHandler::~InteractionEventHandler ( )
overrideprotected

Definition at line 20 of file mitkInteractionEventHandler.cpp.

Member Function Documentation

◆ AddEventConfig() [1/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
filenameThe resource name relative to the Interactions resource folder.
moduleThe module containing the resource. Defaults to the Mitk module.
Returns
true if the configuration was successfully added, false otherwise.

Definition at line 55 of file mitkInteractionEventHandler.cpp.

References mitk::EventConfig::AddConfig(), ConfigurationChanged(), mitk::EventConfig::IsValid(), and MITK_ERROR.

Referenced by mitk::InteractionSchemeSwitcher::SetInteractionScheme().

◆ AddEventConfig() [2/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
configThe EventConfig object whose configuration should be added.
Returns
true if the configuration was successfully added, false otherwise.

Definition at line 71 of file mitkInteractionEventHandler.cpp.

References mitk::EventConfig::AddConfig(), ConfigurationChanged(), mitk::EventConfig::IsValid(), and MITK_ERROR.

◆ ConfigurationChanged()

void mitk::InteractionEventHandler::ConfigurationChanged ( )
protectedvirtual

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

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

Definition at line 112 of file mitkInteractionEventHandler.cpp.

Referenced by AddEventConfig(), and SetEventConfig().

◆ GetAttributes()

◆ GetClassHierarchy()

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

◆ GetClassName()

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

◆ GetEventConfig()

mitk::EventConfig mitk::InteractionEventHandler::GetEventConfig ( ) const

Returns the current configuration.

Returns
A EventConfig object representing the current event configuration.

Definition at line 50 of file mitkInteractionEventHandler.cpp.

◆ 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 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
filenameThe resource name relative to the Interactions resource folder.
moduleThe module containing the resource. Defaults to the Mitk module.
Returns
true if the resource was successfully loaded, false otherwise.

Definition at line 24 of file mitkInteractionEventHandler.cpp.

References ConfigurationChanged(), mitk::EventConfig::IsValid(), and MITK_ERROR.

Referenced by mitk::Tool::Deactivated(), mitk::Tool::InitializeStateMachine(), mitk::BoundingShapeInteractor::RestoreNodeProperties(), and mitk::InteractionSchemeSwitcher::SetInteractionScheme().

◆ SetEventConfig() [2/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
configThe EventConfig object containing the new configuration.
Returns
true if the configuration was successfully loaded, false otherwise.

Definition at line 38 of file mitkInteractionEventHandler.cpp.

References ConfigurationChanged(), and mitk::EventConfig::IsValid().


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