Medical Imaging Interaction Toolkit  2024.06.99-5f7b36e7
Medical Imaging Interaction Toolkit

Base class of all tools used by mitk::ToolManager. More...

#include <mitkTool.h>

Inheritance diagram for mitk::Tool:
Collaboration diagram for mitk::Tool:

Public Types

typedef mitk::Label::PixelType DefaultSegmentationDataType
- Public Types inherited from mitk::EventStateMachine
typedef EventStateMachine Self
typedef InteractionEventHandler Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer
typedef std::map< std::string, TActionFunctor * > ActionFunctionsMapType
typedef itk::SmartPointer< StateMachineStateStateMachineStateType
- Public Types inherited from mitk::InteractionEventHandler
typedef InteractionEventHandler Self
typedef itk::Object Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer

Public Member Functions

 mitkClassMacro (Tool, EventStateMachine)
virtual const char ** GetXPM () const =0
 Returns an icon in the XPM format. More...
virtual std::string GetIconPath () const
 Returns the path of an icon. More...
virtual us::ModuleResource GetCursorIconResource () const
 Returns the path of a cursor icon. More...
virtual us::ModuleResource GetIconResource () const
 Returns the tool button icon of the tool wrapped by a usModuleResource. More...
virtual const char * GetName () const =0
 Returns the name of this tool. Make it short! More...
virtual const char * GetGroup () const
 Name of a group. More...
virtual void InitializeStateMachine ()
virtual itk::Object::Pointer GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix)
 Interface for GUI creation. More...
virtual NodePredicateBase::ConstPointer GetReferenceDataPreference () const
virtual NodePredicateBase::ConstPointer GetWorkingDataPreference () const
DataNode::Pointer CreateEmptySegmentationNode (const Image *original, const std::string &organName, const mitk::Color &color) const
DataNode::Pointer CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color) const
virtual bool CanHandle (const BaseData *referenceData, const BaseData *workingData) const
virtual bool ConfirmBeforeDeactivation ()
 Method call to invoke a dialog box just before exiting. The method can be reimplemented in the respective tool class with business logic on when there should be a confirmation dialog from the user before the tool exits. More...
- Public Member Functions inherited from mitk::EventStateMachine
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...
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
virtual ~InteractionEventObserver ()
void Disable ()
void Enable ()
bool IsEnabled () const

Public Attributes

Message GUIProcessEventsMessage
 To let GUI process new events (e.g. qApp->processEvents() ) More...
Message1< std::string > ErrorMessage
 To send error messages (to be shown by some GUI) More...
Message1< bool > CurrentlyBusy
 To send whether the tool is busy (to be shown by some GUI) More...
Message1< std::string > GeneralMessage
 To send general messages (to be shown by some GUI) More...

Protected Member Functions

virtual void SetToolManager (ToolManager *)
ToolManagerGetToolManager () const
mitk::DataStorageGetDataStorage () const
void ConnectActionsAndFunctions () override
virtual void Activated ()
 Called when the tool gets activated. More...
virtual void Deactivated ()
 Called when the tool gets deactivated. More...
 Tool (const char *, const us::Module *interactorModule=nullptr)
 ~Tool () override
void Notify (InteractionEvent *interactionEvent, bool isHandled) override
bool FilterEvents (InteractionEvent *, DataNode *) override
- 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)
StateMachineStateGetCurrentState () 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)
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...
StateMachineTransitionGetExecutableTransition (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

std::string m_EventConfig
 Let subclasses change their event configuration. More...
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
bool m_UndoEnabled

Additional Inherited Members

- Static Public Member Functions inherited from mitk::EventStateMachine
static const char * GetStaticNameOfClass ()
- Static Public Member Functions inherited from mitk::InteractionEventHandler
static const char * GetStaticNameOfClass ()
- Protected Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate

Detailed Description

Base class of all tools used by mitk::ToolManager.

See also

Every tool is a mitk::EventStateMachine, which can follow any transition pattern that it likes. Every derived tool should always call SuperClass::Deactivated() at the end of its own implementation of Deactivated, because mitk::Tool resets the interaction configuration in this method. Only if you are very sure that you covered all possible things that might happen to your own tool, you should consider not to reset the configuration.

To learn about the MITK implementation of state machines in general, have a look at Interaction and Undo/Redo Concepts.

To derive a non-abstract tool, you inherit from mitk::Tool (or some other base class further down the inheritance tree), and in your own parameterless constructor (that is called from the itkFactorylessNewMacro that you use) you pass a state machine name (interactor type). Names and .xml-files for valid state machines can be found in different "Interaction" directories (which might be enhanced by you).

You have to implement at least GetXPM() and GetName() to provide some identification.

Each Tool knows its ToolManager, which can provide the data that the tool should work on.

Only to be instantiated by mitk::ToolManager (because SetToolManager has to be called). All other uses are unsupported.


Definition at line 83 of file mitkTool.h.

Member Typedef Documentation

◆ DefaultSegmentationDataType

Constructor & Destructor Documentation

◆ Tool()

mitk::Tool::Tool ( const char *  ,
const us::Module interactorModule = nullptr 

◆ ~Tool()

mitk::Tool::~Tool ( )

Member Function Documentation

◆ Activated()

◆ CanHandle()

virtual bool mitk::Tool::CanHandle ( const BaseData referenceData,
const BaseData workingData 
) const

Function used to check if a tool can handle the referenceData and (if specified) the working data.

referenceData must be a valid pointer
referenceDataPointer to the data that should be checked as valid reference for the tool.
workingDataPointer to the data that should be checked as valid working data for this tool. This parameter can be null if no working data is specified so far.

Reimplemented in mitk::SegWithPreviewTool.

◆ ConfirmBeforeDeactivation()

virtual bool mitk::Tool::ConfirmBeforeDeactivation ( )

Method call to invoke a dialog box just before exiting. The method can be reimplemented in the respective tool class with business logic on when there should be a confirmation dialog from the user before the tool exits.

Reimplemented in mitk::SegWithPreviewTool.

◆ ConnectActionsAndFunctions()

void mitk::Tool::ConnectActionsAndFunctions ( )

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 from mitk::EventStateMachine.

◆ CreateEmptySegmentationNode()

DataNode::Pointer mitk::Tool::CreateEmptySegmentationNode ( const Image original,
const std::string &  organName,
const mitk::Color color 
) const

◆ CreateSegmentationNode()

DataNode::Pointer mitk::Tool::CreateSegmentationNode ( Image image,
const std::string &  organName,
const mitk::Color color 
) const

◆ Deactivated()

virtual void mitk::Tool::Deactivated ( )

◆ FilterEvents()

bool mitk::Tool::FilterEvents ( InteractionEvent interactionEvent,
DataNode dataNode 

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

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 from mitk::EventStateMachine.

◆ GetCursorIconResource()

◆ GetDataStorage()

mitk::DataStorage* mitk::Tool::GetDataStorage ( ) const

Returns the data storage provided by the toolmanager. May be null (e.g. if ToolManager is not set).

◆ GetGroup()

virtual const char* mitk::Tool::GetGroup ( ) const

Name of a group.

You can group several tools by assigning a group name. Graphical tool selectors might use this information to group tools. (What other reason could there be?)

Reimplemented in mitk::SegWithPreviewTool, and mitk::SegmentationsProcessingTool.

◆ GetGUI()

virtual itk::Object::Pointer mitk::Tool::GetGUI ( const std::string &  toolkitPrefix,
const std::string &  toolkitPostfix 

Interface for GUI creation.

This is the basic interface for creation of a GUI object belonging to one tool.

Tools that support a GUI (e.g. for display/editing of parameters) should follow some rules:

  • A Tool and its GUI are two separate classes
  • There may be several instances of a GUI at the same time.
  • mitk::Tool is toolkit (Qt, wxWidgets, etc.) independent, the GUI part is of course dependent
  • The GUI part inherits both from itk::Object and some GUI toolkit class
  • The GUI class name HAS to be constructed like "toolkitPrefix" tool->GetClassName() + "toolkitPostfix", e.g. MyTool -> wxMyToolGUI
  • For each supported toolkit there is a base class for tool GUIs, which contains some convenience methods
  • Tools notify the GUI about changes using ITK events. The GUI must observe interesting events.
  • The GUI base class may convert all ITK events to the GUI toolkit's favoured messaging system (Qt -> signals)
  • Calling methods of a tool by its GUI is done directly. In some cases GUIs don't want to be notified by the tool when they cause a change in a tool. There is a macro CALL_WITHOUT_NOTICE(method()), which will temporarily disable all notifications during a method call.

◆ GetIconPath()

virtual std::string mitk::Tool::GetIconPath ( ) const

Returns the path of an icon.

This icon is preferred to the XPM icon.

Definition at line 128 of file mitkTool.h.

◆ GetIconResource()

◆ GetName()

◆ GetReferenceDataPreference()

virtual NodePredicateBase::ConstPointer mitk::Tool::GetReferenceDataPreference ( ) const

◆ GetToolManager()

ToolManager* mitk::Tool::GetToolManager ( ) const

Returns the pointer to the tool manager of the tool. May be null.

◆ GetWorkingDataPreference()

virtual NodePredicateBase::ConstPointer mitk::Tool::GetWorkingDataPreference ( ) const

◆ GetXPM()

virtual const char** mitk::Tool::GetXPM ( ) const
pure virtual

Returns an icon in the XPM format.

This icon has to fit into some kind of button in most applications, so make it smaller than 25x25 pixels.

XPM is e.g. supported by The Gimp. But if you open any XPM file in your text editor, you will see that you could also "draw" it with an editor.

Implemented in mitk::nnUNetTool, ExampleSegTool2D, mitk::RegionGrowingTool, mitk::LiveWireTool2D, mitk::SubtractContourTool, mitk::AddContourTool, mitk::DrawPaintbrushTool, mitk::ErasePaintbrushTool, mitk::LassoTool, mitk::CloseRegionTool, mitk::FillRegionTool, mitk::PickingTool, mitk::EraseRegionTool, mitk::SegmentAnythingTool, mitk::TotalSegmentatorTool, mitk::BinaryThresholdTool, mitk::BinaryThresholdULTool, mitk::MonaiLabel2DTool, mitk::MonaiLabel3DTool, mitk::GrowCutTool, mitk::AutoCropTool, and mitk::OtsuTool3D.

◆ InitializeStateMachine()

virtual void mitk::Tool::InitializeStateMachine ( )

◆ mitkClassMacro()

mitk::Tool::mitkClassMacro ( Tool  ,

◆ Notify()

void mitk::Tool::Notify ( InteractionEvent interactionEvent,
bool  isHandled 

By this method all registered EventObersers are notified about every InteractionEvent, the isHandled flag indicates if a DataInteractor has already handled that event. InteractionEventObserver that trigger an action when observing an event may consider this in order to not confuse the user by, triggering several independent action with one single user event (such as a mouse click)

If you want to use the InteractionEventObserver as a state machine give the event to the state machine by implementing, e.g.

if (!isHandled) {
this->HandleEvent(interactionEvent, nullptr);

This overwrites the FilterEvents function of the EventStateMachine to ignore the DataNode, since InteractionEventObservers are not associated with one. virtual bool FilterEvents(InteractionEvent* interactionEvent, DataNode* dataNode);

Implements mitk::InteractionEventObserver.

◆ SetToolManager()

virtual void mitk::Tool::SetToolManager ( ToolManager )

Member Data Documentation

◆ CurrentlyBusy

Message1<bool> mitk::Tool::CurrentlyBusy

To send whether the tool is busy (to be shown by some GUI)

Definition at line 101 of file mitkTool.h.

◆ ErrorMessage

Message1<std::string> mitk::Tool::ErrorMessage

To send error messages (to be shown by some GUI)

Definition at line 96 of file mitkTool.h.

◆ GeneralMessage

Message1<std::string> mitk::Tool::GeneralMessage

To send general messages (to be shown by some GUI)

Definition at line 106 of file mitkTool.h.

◆ GUIProcessEventsMessage

Message mitk::Tool::GUIProcessEventsMessage

To let GUI process new events (e.g. qApp->processEvents() )

Definition at line 91 of file mitkTool.h.

◆ m_EventConfig

std::string mitk::Tool::m_EventConfig

Let subclasses change their event configuration.

Definition at line 234 of file mitkTool.h.

The documentation for this class was generated from the following file:
itk::SmartPointer< Self > Pointer
Definition: mitkInteractionEvent.h:29
virtual void Notify(InteractionEvent *interactionEvent, bool isHandled)=0
@ Standard2D
Definition: mitkBaseRenderer.h:68
bool HandleEvent(InteractionEvent *event, DataNode *dataNode)
virtual bool FilterEvents(InteractionEvent *interactionEvent, DataNode *dataNode)