Medical Imaging Interaction Toolkit  2021.10.99-fd647480
Medical Imaging Interaction Toolkit
mitk::TubeGraphDataInteractor Class Reference

#include <mitkTubeGraphDataInteractor.h>

Inheritance diagram for mitk::TubeGraphDataInteractor:
Collaboration diagram for mitk::TubeGraphDataInteractor:

Public Types

enum  ActivationMode {
  None, Single, ToRoot, ToPeriphery,
  Points, Multiple
}
 
enum  ActionMode {
  AttributationMode, AnnotationMode, EditMode, RootMode,
  InformationMode
}
 
- Public Types inherited from mitk::DataInteractor
typedef DataInteractor 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
 

Public Member Functions

 mitkClassMacro (TubeGraphDataInteractor, DataInteractor)
 
void SetActivationMode (const ActivationMode &activationMode)
 
ActivationMode GetActivationMode ()
 
void SetActionMode (const ActionMode &actionMode)
 
ActionMode GetActionMode ()
 
void ResetPickedTubes ()
 
mitk::Point3D GetLastPickedPosition ()
 
- Public Member Functions inherited from mitk::DataInteractor
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
DataNodeGetDataNode () const
 
virtual void SetDataNode (DataNode *dataNode)
 
int GetLayer () const
 
ProcessEventMode GetMode () const
 
- 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...
 

Static Public Member Functions

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

 TubeGraphDataInteractor ()
 
 ~TubeGraphDataInteractor () override
 
void ConnectActionsAndFunctions () override
 
void DataNodeChanged () override
 
virtual bool CheckOverTube (const InteractionEvent *)
 
virtual void SelectTube (StateMachineAction *, InteractionEvent *)
 
virtual void DeselectTube (StateMachineAction *, InteractionEvent *)
 
void SelectTubesByActivationModus ()
 
void UpdateActivation ()
 
- Protected Member Functions inherited from mitk::DataInteractor
 DataInteractor ()
 
 ~DataInteractor () override
 
virtual void NotifyStart ()
 Sends StartInteraction event via the mitk::DataNode. More...
 
virtual void NotifyResultReady ()
 NotifyResultReady Sends ResultReady event via the mitk::DataNode. More...
 
- 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)
 
virtual bool FilterEvents (InteractionEvent *interactionEvent, DataNode *dataNode)
 
void SetMouseCursor (const char *xpm[], int hotspotX, int hotspotY)
 Sets the specified mouse cursor. More...
 
void ResetMouseCursor ()
 Resets the mouse cursor (if modified by the SlicesCoordinator) 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 ()
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::DataInteractor
static const std::string IntDeactivateMe
 
static const std::string IntLeaveWidget
 
static const std::string IntEnterWidget
 
- 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

Definition at line 35 of file mitkTubeGraphDataInteractor.h.

Member Enumeration Documentation

◆ ActionMode

Enumerator
AttributationMode 
AnnotationMode 
EditMode 
RootMode 
InformationMode 

Definition at line 62 of file mitkTubeGraphDataInteractor.h.

◆ ActivationMode

Describes, which activation modes are available based on the currently picked tube:

  • None means "no tube is active"
  • Single means "only the picked tube is active"
  • ToRoot means "all tubes from the picked on down to the root of the tube graph are active"
  • ToPeriphery means "all tubes included in the subgraph of the currently picked vessel are active"
  • Points means "shortes path between two picked tubes are active"
  • Multiple means "all picked tubes are active"
Enumerator
None 
Single 
ToRoot 
ToPeriphery 
Points 
Multiple 

Definition at line 52 of file mitkTubeGraphDataInteractor.h.

Constructor & Destructor Documentation

◆ TubeGraphDataInteractor()

mitk::TubeGraphDataInteractor::TubeGraphDataInteractor ( )
protected

◆ ~TubeGraphDataInteractor()

mitk::TubeGraphDataInteractor::~TubeGraphDataInteractor ( )
overrideprotected

Member Function Documentation

◆ CheckOverTube()

virtual bool mitk::TubeGraphDataInteractor::CheckOverTube ( const InteractionEvent )
protectedvirtual

Initializes the movement, stores starting position.

◆ ConnectActionsAndFunctions()

void mitk::TubeGraphDataInteractor::ConnectActionsAndFunctions ( )
overrideprotectedvirtual

Here actions strings from the loaded state machine pattern are mapped to functions of the DataInteractor. These functions are called when an action from the state machine pattern is executed.

Reimplemented from mitk::DataInteractor.

◆ DataNodeChanged()

void mitk::TubeGraphDataInteractor::DataNodeChanged ( )
overrideprotectedvirtual

This function is called when a DataNode has been set/changed.

Reimplemented from mitk::DataInteractor.

◆ DeselectTube()

virtual void mitk::TubeGraphDataInteractor::DeselectTube ( StateMachineAction ,
InteractionEvent  
)
protectedvirtual

◆ GetActionMode()

ActionMode mitk::TubeGraphDataInteractor::GetActionMode ( )

◆ GetActivationMode()

ActivationMode mitk::TubeGraphDataInteractor::GetActivationMode ( )

◆ GetLastPickedPosition()

mitk::Point3D mitk::TubeGraphDataInteractor::GetLastPickedPosition ( )

◆ mitkClassMacro()

mitk::TubeGraphDataInteractor::mitkClassMacro ( TubeGraphDataInteractor  ,
DataInteractor   
)

◆ New()

static Pointer mitk::TubeGraphDataInteractor::New ( )
static

◆ ResetPickedTubes()

void mitk::TubeGraphDataInteractor::ResetPickedTubes ( )

◆ SelectTube()

virtual void mitk::TubeGraphDataInteractor::SelectTube ( StateMachineAction ,
InteractionEvent  
)
protectedvirtual

◆ SelectTubesByActivationModus()

void mitk::TubeGraphDataInteractor::SelectTubesByActivationModus ( )
protected

◆ SetActionMode()

void mitk::TubeGraphDataInteractor::SetActionMode ( const ActionMode actionMode)

◆ SetActivationMode()

void mitk::TubeGraphDataInteractor::SetActivationMode ( const ActivationMode activationMode)

◆ UpdateActivation()

void mitk::TubeGraphDataInteractor::UpdateActivation ( )
protected

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