mitk::GizmoInteractor Class Reference
#include <mitkGizmoInteractor.h>
Inheritance diagram for mitk::GizmoInteractor:
Collaboration diagram for mitk::GizmoInteractor:
Public Member Functions | |
| mitkClassMacro (GizmoInteractor, DataInteractor) | |
| Pointer | Clone () const |
| void | SetGizmoNode (DataNode *node) |
| void | SetManipulatedObjectNode (DataNode *node) |
 Public Member Functions inherited from mitk::DataInteractor | |
| virtual std::vector< std::string > | GetClassHierarchy () const override |
| virtual const char * | GetClassName () const |
| Pointer | Clone () const |
| DataNode * | GetDataNode () 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 () |
Additional Inherited Members | |
| Public Types inherited from mitk::DataInteractor | |
| typedef DataInteractor | Self |
| typedef EventStateMachine | Superclass |
| typedef itk::SmartPointer< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
| 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 |
| 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 Member Functions inherited from mitk::DataInteractor | |
| DataInteractor () | |
| ~DataInteractor () override | |
| 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, 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) |
| 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) |
| virtual void | ConfigurationChanged () |
| Protected Attributes inherited from mitk::EventStateMachine | |
| bool | m_IsActive |
| UndoController * | m_UndoController |
| bool | m_UndoEnabled |
Detailed Description
Data interactor to manipulate the geometry of an object via interaction with a mitk::Gizmo visualization.
Unlike other interactors, this class needs two DataNodes to work on:
- the "manipulated object" is the one whose geometry is modified by user input
- the "gizmo node" represents the manipulated object's primary axes and is used to take user input (most importantly: to have a picking target)
To determine what parts of the object are clicked during interaction, the mappers (2D: custom mapper, 3D: regular surface mapper) are asked for their VTK objects, picking is performed, and the picked point is forwarded to the gizmo object for interpretation.
The interactor fills the undo/redo stack with operations on the modified geometry.
- See also
- Gizmo
Definition at line 52 of file mitkGizmoInteractor.h.
Member Function Documentation
◆ Clone()
| Pointer mitk::GizmoInteractor::Clone | ( | ) | const |
◆ mitkClassMacro()
| mitk::GizmoInteractor::mitkClassMacro | ( | GizmoInteractor | , |
| DataInteractor | |||
| ) |
◆ New()
|
static |
◆ SetGizmoNode()
| void mitk::GizmoInteractor::SetGizmoNode | ( | DataNode * | node | ) |
The node holding the gizmo for visual feedback. This is the node that the interactor is primarily working on (calls DataInteractor::SetDataNode).
◆ SetManipulatedObjectNode()
| void mitk::GizmoInteractor::SetManipulatedObjectNode | ( | DataNode * | node | ) |
The node that shall be manipulated in function of the user interaction on the gizmo.
The documentation for this class was generated from the following file:
