mitkDataInteractor.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkDataInteractor_h
#define mitkDataInteractor_h
 
#include <MitkCoreExports.h>
#include <mitkCommon.h>
#include <mitkEventStateMachine.h>
#include <mitkWeakPointer.h>
#include <string>
 
namespace mitk
{
  class DataNode;
 
  itkEventMacroDeclaration(DataInteractorEvent, itk::AnyEvent);
 
  itkEventMacroDeclaration(StartInteraction, DataInteractorEvent);
 
  itkEventMacroDeclaration(ResultReady, DataInteractorEvent);
 
    enum ProcessEventMode {
      REGULAR = 0,
      GRABINPUT = 1,
      PREFERINPUT = 2,
      CONNECTEDMOUSEACTION = 3
    };
 
  class MITKCORE_EXPORT DataInteractor : public EventStateMachine
  {
  public:
    // Predefined internal events/signals
    static const std::string IntDeactivateMe;
    static const std::string IntLeaveWidget;
    static const std::string IntEnterWidget;
 
    mitkClassMacro(DataInteractor, EventStateMachine);
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self);
 
      DataNode *GetDataNode() const;
    virtual void SetDataNode(DataNode *dataNode); // TODO: Remove virtual, use DataNodeChanged instead in subclasses
 
    int GetLayer() const;
 
    ProcessEventMode GetMode() const;
 
  protected:
    DataInteractor();
    ~DataInteractor() override;
 
    void ConnectActionsAndFunctions() override;
 
    virtual void DataNodeChanged();
 
    void virtual NotifyStart();
 
    void virtual NotifyResultReady();
 
  private:
    WeakPointer<DataNode> m_DataNode;
  };
}
#endif