mitk::GizmoInteractor Class Reference
Data interactor for manipulating object geometry via a Gizmo widget. More...
#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) |
| Set the DataNode that holds the Gizmo for visual feedback. More... | |
| void | SetManipulatedObjectNode (DataNode *node) |
| Set the DataNode whose geometry shall be manipulated. More... | |
 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 () |
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 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, 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 for manipulating object geometry via a Gizmo widget.
Unlike other interactors, this class operates on two DataNodes:
- The "gizmo node" provides the visual feedback and serves as the picking target for user input.
- The "manipulated object node" owns the geometry that is actually modified by the user interaction.
During interaction, the interactor queries the appropriate mapper (2D: GizmoMapper2D, 3D: standard surface mapper) for VTK props, performs picking, and delegates handle identification to the Gizmo. Based on the picked handle, the interactor applies translation, rotation, or uniform scaling operations to the manipulated object's geometry.
All geometry modifications are recorded on the undo/redo stack, enabling full undo support.
The interactor's state machine is defined in Gizmo3DStates.xml and configured via Gizmo3DConfig.xml.
- See also
- Gizmo
- DataInteractor
Definition at line 61 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 | ) |
Set the DataNode that holds the Gizmo for visual feedback.
This node is used as the interactor's primary data node (calls DataInteractor::SetDataNode internally) and provides the picking target for user interaction.
- See also
- SetManipulatedObjectNode
◆ SetManipulatedObjectNode()
| void mitk::GizmoInteractor::SetManipulatedObjectNode | ( | DataNode * | node | ) |
Set the DataNode whose geometry shall be manipulated.
The geometry of this node's data object will be transformed (translated, rotated, or scaled) in response to user interaction with the gizmo.
- Parameters
-
[in] node The DataNode whose geometry is to be manipulated. Must hold a data object with a valid geometry.
- See also
- SetGizmoNode
The documentation for this class was generated from the following file:
