mitkContourElement.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 mitkContourElement_h
#define mitkContourElement_h
 
#include "mitkCommon.h"
#include <MitkContourModelExports.h>
#include <mitkNumericTypes.h>
 
#include <deque>
 
namespace mitk
{
  class MITKCONTOURMODEL_EXPORT ContourElement : public itk::LightObject
  {
  public:
    mitkClassMacroItkParent(ContourElement, itk::LightObject);
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self);
 
    struct MITKCONTOURMODEL_EXPORT ContourModelVertex
    {
      ContourModelVertex(const mitk::Point3D& point, bool active = false) : IsControlPoint(active), Coordinates(point) {};
      ContourModelVertex(const ContourModelVertex& other)
        : IsControlPoint(other.IsControlPoint), Coordinates(other.Coordinates)
      {
      };
 
      bool IsControlPoint;
 
      mitk::Point3D Coordinates;
 
      bool operator ==(const ContourModelVertex& other) const;
    };
 
    using VertexType = ContourModelVertex;
    using VertexListType = std::deque<VertexType*>;
    using VertexIterator = VertexListType::iterator;
    using ConstVertexIterator = VertexListType::const_iterator;
    using VertexSizeType = VertexListType::size_type;
 
    static const VertexSizeType NPOS = -1;
 
    ConstVertexIterator ConstIteratorBegin() const;
    ConstVertexIterator ConstIteratorEnd() const;
    VertexIterator IteratorBegin();
    VertexIterator IteratorEnd();
 
    ConstVertexIterator begin() const;
    ConstVertexIterator end() const;
    VertexIterator begin();
    VertexIterator end();
 
    VertexSizeType GetSize() const;
 
    void AddVertex(const mitk::Point3D &point, bool isControlPoint);
 
    void AddVertexAtFront(const mitk::Point3D &point, bool isControlPoint);
 
    void InsertVertexAtIndex(const mitk::Point3D &point, bool isControlPoint, VertexSizeType index);
 
    void SetVertexAt(VertexSizeType pointId, const mitk::Point3D &point);
 
    void SetVertexAt(VertexSizeType pointId, const VertexType* vertex);
 
    VertexType* GetVertexAt(VertexSizeType index);
    const VertexType* GetVertexAt(VertexSizeType index) const;
 
    VertexType *GetVertexAt(const mitk::Point3D &point, float eps);
 
    VertexType *GetNextControlVertexAt(const mitk::Point3D &point, float eps);
 
    VertexType *GetPreviousControlVertexAt(const mitk::Point3D &point, float eps);
 
    VertexType *GetControlVertexAt(const mitk::Point3D &point, float eps);
 
    VertexSizeType GetIndex(const VertexType *vertex) const;
 
    const VertexListType *GetVertexList() const;
 
    bool IsEmpty() const;
 
    bool IsClosed() const;
 
    bool IsNearContour(const mitk::Point3D &point, float eps) const;
 
    bool GetLineSegmentForPoint(const mitk::Point3D &point,
                            float eps,
                            mitk::ContourElement::VertexType *previousVertex,
                            mitk::ContourElement::VertexType *nextVertex) const;
    bool GetLineSegmentForPoint(const mitk::Point3D& point,
      float eps, VertexSizeType& segmentStartIndex, VertexSizeType& segmentEndIndex, mitk::Point3D& closestContourPoint, bool findClosest = true) const;
 
    void Close();
 
    void Open();
 
    void SetClosed(bool isClosed);
 
    void Concatenate(const mitk::ContourElement *other, bool check);
 
    bool RemoveVertex(const VertexType *vertex);
 
    bool RemoveVertexAt(VertexSizeType index);
 
    bool RemoveVertexAt(const mitk::Point3D &point, double eps);
 
    void Clear();
 
    VertexType *BruteForceGetVertexAt(const mitk::Point3D &point, double eps, bool isControlPoint = false, int offset = 0);
 
    int BruteForceGetVertexIndexAt(const mitk::Point3D &point,
                                                      double eps,
                                                      VertexListType verticesList);
 
    VertexListType GetControlVertices() const;
 
    void RedistributeControlVertices(const VertexType *vertex, int period);
 
  protected:
    mitkCloneMacro(Self);
 
    ContourElement() = default;
    ContourElement(const mitk::ContourElement &other);
    ~ContourElement();
 
    ContourElement& operator = (const ContourElement & other);
 
    bool RemoveVertexByIterator(VertexListType::iterator& iter);
 
    VertexListType m_Vertices; // double ended queue with vertices
    bool m_IsClosed = false;
  };
} // namespace mitk
 
#endif