Medical Imaging Interaction Toolkit  2022.10.99-122321bb
Medical Imaging Interaction Toolkit
mitk::SegmentationInteractor Class Reference

Observer that adds interaction with a multi-label segmentation session to the default display interaction. More...

#include <mitkSegmentationInteractor.h>

Inheritance diagram for mitk::SegmentationInteractor:
Collaboration diagram for mitk::SegmentationInteractor:

Public Member Functions

 mitkClassMacro (SegmentationInteractor, DisplayActionEventBroadcast)
 
- Public Member Functions inherited from mitk::DisplayActionEventBroadcast
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
void Notify (InteractionEvent *interactionEvent, bool isHandled) override
 
- 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...
 
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
 
virtual ~InteractionEventObserver ()
 
void Disable ()
 
void Enable ()
 
bool IsEnabled () const
 

Static Public Member Functions

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

Protected Member Functions

 SegmentationInteractor ()
 
 ~SegmentationInteractor () override
 
void ConnectActionsAndFunctions () override
 
- Protected Member Functions inherited from mitk::DisplayActionEventBroadcast
 DisplayActionEventBroadcast ()
 
 ~DisplayActionEventBroadcast () override
 
void ConfigurationChanged () override
 This function is executed when a config object is set / changed (via 'SetEventConfig' or 'AddEventConfig' in 'InteractionEventObserver'). It is used to read out the parameters set in the configuration file and to set the member variables accordingly. More...
 
bool FilterEvents (InteractionEvent *interactionEvent, DataNode *dataNode) override
 Filters the event resp. the sender of the event. More...
 
bool CheckPositionEvent (const InteractionEvent *interactionEvent)
 Check if the given interaction event is actually an 'InteractionPositionEvent'. More...
 
bool CheckRotationPossible (const InteractionEvent *interactionEvent)
 
bool CheckSwivelPossible (const InteractionEvent *interactionEvent)
 
void Init (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void Move (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void SetCrosshair (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void Zoom (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void Scroll (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void ScrollOneUp (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void ScrollOneDown (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void AdjustLevelWindow (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void StartRotation (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void EndRotation (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void Rotate (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void Swivel (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void IncreaseTimeStep (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
void DecreaseTimeStep (StateMachineAction *stateMachineAction, InteractionEvent *interactionEvent)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from mitk::DisplayActionEventBroadcast
typedef DisplayActionEventBroadcast Self
 
typedef EventStateMachine Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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
 
- 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
 
UndoControllerm_UndoController
 
bool m_UndoEnabled
 

Detailed Description

Observer that adds interaction with a multi-label segmentation session to the default display interaction.

At the moment, this includes changing the active label.

Definition at line 30 of file mitkSegmentationInteractor.h.

Constructor & Destructor Documentation

◆ SegmentationInteractor()

mitk::SegmentationInteractor::SegmentationInteractor ( )
protected

◆ ~SegmentationInteractor()

mitk::SegmentationInteractor::~SegmentationInteractor ( )
overrideprotected

Member Function Documentation

◆ ConnectActionsAndFunctions()

void mitk::SegmentationInteractor::ConnectActionsAndFunctions ( )
overrideprotectedvirtual

Derived function. Connects the action names used in the state machine pattern with functions implemented within this InteractionEventObserver. This is only necessary here because the events are processed by the state machine.

Reimplemented from mitk::DisplayActionEventBroadcast.

◆ mitkClassMacro()

mitk::SegmentationInteractor::mitkClassMacro ( SegmentationInteractor  ,
DisplayActionEventBroadcast   
)

◆ New()

static Pointer mitk::SegmentationInteractor::New ( )
static

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