mitkTool.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 mitkTool_h
#define mitkTool_h
 
#include "itkObjectFactoryBase.h"
#include "itkVersion.h"
#include "mitkCommon.h"
#include "mitkDataNode.h"
#include "mitkEventStateMachine.h"
#include "mitkInteractionEventObserver.h"
#include "mitkLabelSetImage.h"
#include "mitkMessage.h"
#include "mitkNodePredicateBase.h"
#include "mitkToolEvents.h"
#include "mitkToolFactoryMacro.h"
#include <MitkSegmentationExports.h>
#include <mitkLabel.h>
 
#include <iostream>
#include <map>
#include <string>
 
#include <itkObject.h>
 
#include "usServiceRegistration.h"
 
namespace us
{
  class ModuleResource;
}
 
namespace mitk
{
  class ToolManager;
 
  class MITKSEGMENTATION_EXPORT Tool : public EventStateMachine, public InteractionEventObserver
  {
  public:
    typedef mitk::Label::PixelType DefaultSegmentationDataType;
 
    Message<> GUIProcessEventsMessage;
 
    Message1<std::string> ErrorMessage;
 
    Message1<bool> CurrentlyBusy;
 
    Message1<std::string> GeneralMessage;
 
    mitkClassMacro(Tool, EventStateMachine);
 
    // no New(), there should only be subclasses
 
    //[[deprecated]]
    DEPRECATED(virtual const char **GetXPM() const) = 0;
 
    virtual std::string GetIconPath() const { return ""; }
    virtual us::ModuleResource GetCursorIconResource() const;
 
    virtual us::ModuleResource GetIconResource() const;
 
    virtual const char *GetName() const = 0;
 
    virtual const char *GetGroup() const;
 
    virtual bool IsEligibleForAutoInit() const;
 
    virtual void InitializeStateMachine();
 
    virtual itk::Object::Pointer GetGUI(const std::string &toolkitPrefix, const std::string &toolkitPostfix);
 
    virtual NodePredicateBase::ConstPointer GetReferenceDataPreference() const;
    virtual NodePredicateBase::ConstPointer GetWorkingDataPreference() const;
 
    virtual bool CanHandle(const BaseData *referenceData, const BaseData *workingData) const;
 
    virtual bool ConfirmBeforeDeactivation();
 
  protected:
    friend class ToolManager;
 
    virtual void SetToolManager(ToolManager *);
    ToolManager* GetToolManager() const;
 
    mitk::DataStorage* GetDataStorage() const;
 
    void ConnectActionsAndFunctions() override;
 
    virtual void Activated();
 
    virtual void Deactivated();
 
    std::string m_EventConfig;
 
    Tool(const char *, const us::Module *interactorModule = nullptr); // purposely hidden
    ~Tool() override;
 
    void Notify(InteractionEvent *interactionEvent, bool isHandled) override;
 
    bool FilterEvents(InteractionEvent *, DataNode *) override;
 
  private:
    ToolManager* m_ToolManager;
 
    std::string m_InteractorType;
 
    std::map<us::ServiceReferenceU, EventConfig> m_DisplayInteractionConfigs;
 
    const us::Module *m_InteractorModule;
  };
 
} // namespace
 
#endif