Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
mitk::ExampleInteractor Class Reference
#include <Step10.h>
Inheritance diagram for mitk::ExampleInteractor:
Collaboration diagram for mitk::ExampleInteractor:
Public Member Functions | |
| mitkClassMacro (ExampleInteractor, DataInteractor) | |
| Pointer | Clone () const |
 Public Member Functions inherited from mitk::DataInteractor | |
| mitkClassMacro (DataInteractor, EventStateMachine) | |
| Pointer | Clone () const |
| DataNode * | GetDataNode () const |
| Get the DataNode associated with this interactor. More... | |
| virtual void | SetDataNode (DataNode *dataNode) |
| Set the DataNode that this interactor operates on. More... | |
| int | GetLayer () const |
| Get the rendering layer of the associated DataNode. More... | |
| ProcessEventMode | GetMode () const |
| Get the current event processing mode from the state machine's current state. More... | |
| Public Member Functions inherited from mitk::EventStateMachine | |
| mitkClassMacro (EventStateMachine, InteractionEventHandler) | |
| bool | LoadStateMachine (const std::string &filename, const us::Module *module=nullptr) |
| Load a state machine pattern from an XML resource file. More... | |
| bool | HandleEvent (InteractionEvent *event, DataNode *dataNode) |
| Process an incoming interaction event. More... | |
| void | EnableUndo (bool enable) |
| Enable or disable the undo mechanism for this state machine. More... | |
| void | EnableInteraction (bool enable) |
| Enable or disable the state machine. More... | |
| Public Member Functions inherited from mitk::InteractionEventHandler | |
| mitkClassMacroItkParent (InteractionEventHandler, itk::Object) | |
| 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 Pointer | New () |
Protected Member Functions | |
| ExampleInteractor () | |
| virtual | ~ExampleInteractor () |
| virtual void | ConnectActionsAndFunctions () |
| virtual void | ConfigurationChanged () |
| Protected Member Functions inherited from mitk::DataInteractor | |
| DataInteractor () | |
| ~DataInteractor () override | |
| void | ConnectActionsAndFunctions () override |
| Overwrite this function to connect actions from StateMachine description with functions. More... | |
| virtual void | DataNodeChanged () |
| Is called when a DataNode is initially set or changed To be implemented by sub-classes for initialization code which require a DataNode. More... | |
| 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, 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) |
| 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 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) |
Additional Inherited Members | |
| Public Types inherited from mitk::EventStateMachine | |
| typedef itk::SmartPointer< StateMachineState > | StateMachineStateType |
| Static Public Attributes inherited from mitk::DataInteractor | |
| static const std::string | IntDeactivateMe |
| Internal signal name to request deactivation of this interactor. More... | |
| static const std::string | IntLeaveWidget |
| Internal signal name indicating the pointer left the widget area. More... | |
| static const std::string | IntEnterWidget |
| Internal signal name indicating the pointer entered the widget area. More... | |
| 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 |
| UndoController * | m_UndoController |
| bool | m_UndoEnabled |
Detailed Description
Constructor & Destructor Documentation
◆ ExampleInteractor()
|
protected |
◆ ~ExampleInteractor()
|
protectedvirtual |
Member Function Documentation
◆ Clone()
| Pointer mitk::ExampleInteractor::Clone | ( | ) | const |
◆ ConfigurationChanged()
|
protectedvirtual |
Derived function. Is executed when config object is set / changed. Here it is used to read out the parameters set in the configuration file, and set the member variables accordingly.
Reimplemented from mitk::InteractionEventHandler.
◆ ConnectActionsAndFunctions()
|
protectedvirtual |
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.
◆ mitkClassMacro()
| mitk::ExampleInteractor::mitkClassMacro | ( | ExampleInteractor | , |
| DataInteractor | |||
| ) |
◆ New()
|
static |
The documentation for this class was generated from the following file:
