Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::ClippingPlaneInteractor3D Class Reference

Specialized interactor for clipping planes. 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
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

 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, 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

- 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
 
- 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

Specialized interactor for clipping planes.

Definition at line 29 of file mitkClippingPlaneInteractor3D.h.

Constructor & Destructor Documentation

◆ ClippingPlaneInteractor3D()

mitk::ClippingPlaneInteractor3D::ClippingPlaneInteractor3D ( )
protected

Definition at line 27 of file mitkClippingPlaneInteractor3D.cpp.

References mitk::Geometry3D::New().

◆ ~ClippingPlaneInteractor3D()

mitk::ClippingPlaneInteractor3D::~ClippingPlaneInteractor3D ( )
overrideprotected

Definition at line 37 of file mitkClippingPlaneInteractor3D.cpp.

Member Function Documentation

◆ CheckOverObject()

bool mitk::ClippingPlaneInteractor3D::CheckOverObject ( const InteractionEvent interactionEvent)
protectedvirtual

Initializes the movement, stores starting position.

Definition at line 60 of file mitkClippingPlaneInteractor3D.cpp.

References mitk::DataInteractor::GetDataNode(), mitk::InteractionEvent::GetSender(), and mitk::BaseRenderer::PickObject().

Referenced by ConnectActionsAndFunctions().

◆ 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.

Definition at line 41 of file mitkClippingPlaneInteractor3D.cpp.

References CheckOverObject(), CONNECT_CONDITION, CONNECT_FUNCTION, DeselectObject(), InitRotate(), InitTranslate(), RotateObject(), SelectObject(), and TranslateObject().

◆ DataNodeChanged()

void mitk::ClippingPlaneInteractor3D::DataNodeChanged ( )
overrideprotectedvirtual

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

Reimplemented from mitk::DataInteractor.

Definition at line 56 of file mitkClippingPlaneInteractor3D.cpp.

◆ DeselectObject()

void mitk::ClippingPlaneInteractor3D::DeselectObject ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

◆ InitRotate()

◆ InitTranslate()

◆ mitkClassMacro()

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

◆ New()

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

◆ RotateObject()

◆ SelectObject()

void mitk::ClippingPlaneInteractor3D::SelectObject ( StateMachineAction ,
InteractionEvent interactionEvent 
)
protectedvirtual

◆ TranslateObject()


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