mitkEditableContourTool.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 mitkEditableContourTool_h
#define mitkEditableContourTool_h
 
#include <mitkFeedbackContourTool.h>
 
namespace mitk
{
  class MITKSEGMENTATION_EXPORT EditableContourTool : public FeedbackContourTool
  {
  public:
    mitkClassMacro(EditableContourTool, FeedbackContourTool);
 
    virtual void ConfirmSegmentation(bool resetStatMachine = true);
 
    virtual void ClearContour();
 
    itkBooleanMacro(AutoConfirm);
    itkSetMacro(AutoConfirm, bool);
    itkGetMacro(AutoConfirm, bool);
 
    itkBooleanMacro(AddMode);
    itkSetMacro(AddMode, bool);
    itkGetMacro(AddMode, bool);
 
    /* Indicated if a contour is drawn, but not confirmed yet. This tool is in interactor mode
     to allow users to edit the contour. This state can be reached if AutoConfirm is false, after the finalizing double
     click before the contour is confirmed.*/
    bool IsEditingContour() const;
    /* Indicate if a contour is currently drawn by the user (state between the initializing double click and
     the finalizing double click).*/
    bool IsDrawingContour() const;
 
  protected:
    EditableContourTool();
    ~EditableContourTool() override;
 
    void ConnectActionsAndFunctions() override;
 
    void Activated() override;
    void Deactivated() override;
   
    virtual Point3D PrepareInitContour(const Point3D& clickedPoint);
    virtual void FinalizePreviewContour(const Point3D& clickedPoint);
    virtual void InitializePreviewContour(const Point3D& clickedPoint);
    virtual void UpdatePreviewContour(const Point3D& clickedPoint);
 
    virtual void OnInitContour(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual void OnAddPoint(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual void OnDrawing(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual void OnEndDrawing(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual void OnMouseMoved(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual void OnFinish(StateMachineAction *, InteractionEvent *interactionEvent);
 
    virtual bool OnCheckPlane(const InteractionEvent* interactionEvent);
 
    virtual bool OnCheckDistanceToControlPoint(const InteractionEvent* interactionEvent);
 
    virtual void FinishTool() = 0;
 
    void EnableContourInteraction(bool on);
 
    void ReleaseInteractors();
 
    virtual void ReleaseHelperObjects(bool includeWorkingContour = true);
 
    virtual void RemoveHelperObjectsFromDataStorage(bool includeWorkingContour = true);
 
    ContourModel::Pointer CreateNewContour() const;
 
    virtual void UpdateClosureContour(mitk::Point3D endpoint);
 
    mitk::ContourModel* GetContour();
    const mitk::ContourModel* GetContour() const;
    mitk::DataNode::Pointer m_ContourNode;
 
    mitk::ContourModel::Pointer m_PreviewContour;
    mitk::DataNode::Pointer m_PreviewContourNode;
 
    mitk::ContourModel::Pointer m_ClosureContour;
    mitk::DataNode::Pointer m_ClosureContourNode;
 
    mitk::ContourModel::Pointer m_CurrentRestrictedArea;
 
    mitk::Image::Pointer m_ReferenceDataSlice;
 
    PlaneGeometry::ConstPointer m_PlaneGeometry;
 
    mitk::DataInteractor::Pointer m_ContourInteractor;
 
    bool m_AutoConfirm;
    bool m_AddMode;
  };
}
 
#endif