Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::ClippingPlaneInteractor3D Class Reference

Specialized interactor for translating and rotating clipping planes in 3D. More...

#include <mitkClippingPlaneInteractor3D.h>

Inheritance diagram for mitk::ClippingPlaneInteractor3D:
Collaboration diagram for mitk::ClippingPlaneInteractor3D:

Public Member Functions

 mitkClassMacro (ClippingPlaneInteractor3D, 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

 ClippingPlaneInteractor3D ()
 
 ~ClippingPlaneInteractor3D () override
 
void ConnectActionsAndFunctions () override
 
void DataNodeChanged () override
 
virtual bool CheckOverObject (const InteractionEvent *)
 
virtual void SelectObject (StateMachineAction *, InteractionEvent *)
 
virtual void DeselectObject (StateMachineAction *, InteractionEvent *)
 
virtual void InitTranslate (StateMachineAction *, InteractionEvent *)
 
virtual void InitRotate (StateMachineAction *, InteractionEvent *)
 
virtual void TranslateObject (StateMachineAction *, InteractionEvent *)
 
virtual void RotateObject (StateMachineAction *, InteractionEvent *)
 
- 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, 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 ()
 

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

Specialized interactor for translating and rotating clipping planes in 3D.

Provides mouse-driven translation and rotation of clipping plane surfaces in 3D render windows. Uses a state machine pattern for interaction and colorizes the surface based on selection state.

See also
DataInteractor, AffineBaseDataInteractor3D

Definition at line 33 of file mitkClippingPlaneInteractor3D.h.

Constructor & Destructor Documentation

◆ ClippingPlaneInteractor3D()

mitk::ClippingPlaneInteractor3D::ClippingPlaneInteractor3D ( )
protected

◆ ~ClippingPlaneInteractor3D()

mitk::ClippingPlaneInteractor3D::~ClippingPlaneInteractor3D ( )
overrideprotected

Member Function Documentation

◆ CheckOverObject()

virtual bool mitk::ClippingPlaneInteractor3D::CheckOverObject ( const InteractionEvent *  )
protectedvirtual

Initializes the movement, stores starting position.

◆ Clone()

Pointer mitk::ClippingPlaneInteractor3D::Clone ( ) const

◆ ConnectActionsAndFunctions()

void mitk::ClippingPlaneInteractor3D::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::ClippingPlaneInteractor3D::DataNodeChanged ( )
overrideprotectedvirtual

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

Reimplemented from mitk::DataInteractor.

◆ DeselectObject()

virtual void mitk::ClippingPlaneInteractor3D::DeselectObject ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

◆ InitRotate()

virtual void mitk::ClippingPlaneInteractor3D::InitRotate ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

◆ InitTranslate()

virtual void mitk::ClippingPlaneInteractor3D::InitTranslate ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

◆ mitkClassMacro()

mitk::ClippingPlaneInteractor3D::mitkClassMacro ( ClippingPlaneInteractor3D  ,
DataInteractor   
)

◆ New()

static Pointer mitk::ClippingPlaneInteractor3D::New ( )
static

◆ RotateObject()

virtual void mitk::ClippingPlaneInteractor3D::RotateObject ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

◆ SelectObject()

virtual void mitk::ClippingPlaneInteractor3D::SelectObject ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

◆ TranslateObject()

virtual void mitk::ClippingPlaneInteractor3D::TranslateObject ( StateMachineAction *  ,
InteractionEvent *   
)
protectedvirtual

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