mitkDataInteractor.h

Go to the documentation of this file.

/*===================================================================

 The Medical Imaging Interaction Toolkit (MITK)

 Copyright (c) German Cancer Research Center,
 Division of Medical and Biological Informatics.
 All rights reserved.

 This software is distributed WITHOUT ANY WARRANTY; without
 even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.

 See LICENSE.txt or http://www.mitk.org for details.

 ===================================================================*/

#ifndef MITKDATAINTERACTOR_H_
#define MITKDATAINTERACTOR_H_

#include <MitkCoreExports.h>
#include <mitkCommon.h>
#include <mitkEventStateMachine.h>
#include <mitkWeakPointer.h>
#include <string>

namespace mitk
{
  class DataNode;

  itkEventMacro(DataInteractorEvent, itk::AnyEvent)

    
    itkEventMacro(StartInteraction, DataInteractorEvent)

    itkEventMacro(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();
    virtual ~DataInteractor();

    virtual void ConnectActionsAndFunctions() override;

    virtual void DataNodeChanged();

    void virtual NotifyStart();

    void virtual NotifyResultReady();

  private:
    WeakPointer<DataNode> m_DataNode;
  };
}
#endif