Medical Imaging Interaction Toolkit
2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
|
Base class of all tools used by mitk::ToolManager. More...
#include <mitkTool.h>
Public Types | |
typedef mitk::Label::PixelType | DefaultSegmentationDataType |
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 | |
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 *) |
ToolManager * | GetToolManager () const |
mitk::DataStorage * | GetDataStorage () 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) |
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) |
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 | |
std::string | m_EventConfig |
Let subclasses change their event configuration. More... | |
Protected Attributes inherited from mitk::EventStateMachine | |
bool | m_IsActive |
UndoController * | m_UndoController |
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 |
Base class of all tools used by mitk::ToolManager.
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.
$Author$
Definition at line 83 of file mitkTool.h.
Definition at line 86 of file mitkTool.h.
|
protected |
|
overrideprotected |
|
protectedvirtual |
Called when the tool gets activated.
Derived tools should call their parents implementation at the beginning of the overriding function.
Reimplemented in mitk::SegTool2D, mitk::MonaiLabelTool, mitk::FeedbackContourTool, mitk::nnUNetTool, mitk::RegionGrowingTool, mitk::EditableContourTool, mitk::PaintbrushTool, mitk::ContourTool, mitk::PickingTool, mitk::SegmentAnythingTool, mitk::TotalSegmentatorTool, mitk::MedSAMTool, mitk::MonaiLabel2DTool, mitk::SegmentationsProcessingTool, mitk::SegWithPreviewTool, mitk::GrowCutTool, mitk::MonaiLabel3DTool, and mitk::OtsuTool3D.
|
virtual |
Function used to check if a tool can handle the referenceData and (if specified) the working data.
referenceData | Pointer to the data that should be checked as valid reference for the tool. |
workingData | Pointer 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.
|
virtual |
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.
|
overrideprotectedvirtual |
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.
DataNode::Pointer mitk::Tool::CreateEmptySegmentationNode | ( | const Image * | original, |
const std::string & | organName, | ||
const mitk::Color & | color | ||
) | const |
DataNode::Pointer mitk::Tool::CreateSegmentationNode | ( | Image * | image, |
const std::string & | organName, | ||
const mitk::Color & | color | ||
) | const |
|
protectedvirtual |
Called when the tool gets deactivated.
Derived tools should call their parents implementation at the end of the overriding function.
Reimplemented in mitk::SegTool2D, mitk::MonaiLabelTool, mitk::FeedbackContourTool, mitk::RegionGrowingTool, mitk::EditableContourTool, mitk::PaintbrushTool, mitk::ContourTool, mitk::PickingTool, mitk::SegmentAnythingTool, mitk::MedSAMTool, mitk::SegmentationsProcessingTool, mitk::SegWithPreviewTool, and mitk::GrowCutTool.
|
overrideprotectedvirtual |
Implements filter scheme for events. Standard implementation accepts events from 2d and 3d windows, and rejects events if DataNode is not visible.
Overwrite this function to adapt for your own needs, for example to filter out events from 3d windows like this:
or to enforce that the interactor only reacts when the corresponding DataNode is selected in the DataManager view..
Reimplemented from mitk::EventStateMachine.
|
virtual |
Returns the path of a cursor icon.
Reimplemented in mitk::RegionGrowingTool, mitk::SubtractContourTool, mitk::AddContourTool, mitk::DrawPaintbrushTool, mitk::ErasePaintbrushTool, mitk::LiveWireTool2D, mitk::CloseRegionTool, mitk::FillRegionTool, mitk::EraseRegionTool, and mitk::LassoTool.
|
protected |
Returns the data storage provided by the toolmanager. May be null (e.g. if ToolManager is not set).
|
virtual |
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.
|
virtual |
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:
|
inlinevirtual |
Returns the path of an icon.
This icon is preferred to the XPM icon.
Definition at line 128 of file mitkTool.h.
|
virtual |
Returns the tool button icon of the tool wrapped by a usModuleResource.
Reimplemented in mitk::nnUNetTool, ExampleSegTool2D, mitk::RegionGrowingTool, mitk::SubtractContourTool, mitk::AddContourTool, mitk::DrawPaintbrushTool, mitk::ErasePaintbrushTool, mitk::LiveWireTool2D, mitk::CloseRegionTool, mitk::FillRegionTool, mitk::PickingTool, mitk::EraseRegionTool, mitk::SegmentAnythingTool, mitk::LassoTool, mitk::TotalSegmentatorTool, mitk::BinaryThresholdTool, mitk::BinaryThresholdULTool, mitk::MonaiLabel2DTool, mitk::MonaiLabel3DTool, mitk::GrowCutTool, and mitk::OtsuTool3D.
|
pure virtual |
Returns the name of this tool. Make it short!
This name has to fit into some kind of button in most applications, so take some time to think of a good name!
Implemented in mitk::nnUNetTool, ExampleSegTool2D, mitk::RegionGrowingTool, mitk::SubtractContourTool, mitk::AddContourTool, mitk::DrawPaintbrushTool, mitk::ErasePaintbrushTool, mitk::LiveWireTool2D, mitk::CloseRegionTool, mitk::FillRegionTool, mitk::EraseRegionTool, mitk::LassoTool, mitk::PickingTool, mitk::SegmentAnythingTool, mitk::BinaryThresholdTool, mitk::BinaryThresholdULTool, mitk::MedSAMTool, mitk::TotalSegmentatorTool, mitk::GrowCutTool, mitk::MonaiLabel2DTool, mitk::MonaiLabel3DTool, mitk::AutoCropTool, and mitk::OtsuTool3D.
|
virtual |
|
protected |
Returns the pointer to the tool manager of the tool. May be null.
|
virtual |
|
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.
|
virtual |
mitk::Tool::mitkClassMacro | ( | Tool | , |
EventStateMachine | |||
) |
|
overrideprotectedvirtual |
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.
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.
|
protectedvirtual |
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.
Message1<std::string> mitk::Tool::ErrorMessage |
To send error messages (to be shown by some GUI)
Definition at line 96 of file mitkTool.h.
Message1<std::string> mitk::Tool::GeneralMessage |
To send general messages (to be shown by some GUI)
Definition at line 106 of file mitkTool.h.
Message mitk::Tool::GUIProcessEventsMessage |
To let GUI process new events (e.g. qApp->processEvents() )
Definition at line 91 of file mitkTool.h.
|
protected |
Let subclasses change their event configuration.
Definition at line 234 of file mitkTool.h.