ConvexPolygon.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/V2D.h"
#include <iosfwd>
#include <vector>
 
namespace Mantid {
namespace Geometry {
//---------------------------------------------------------------------------
// Forward declarations
//---------------------------------------------------------------------------
class PolygonEdge;
 
class MANTID_GEOMETRY_DLL ConvexPolygon {
 
public:
  using Vertices = std::vector<Kernel::V2D>;
 
  //-----------------------------------------------------------------
  // Forward directional iterator inner class
  //-----------------------------------------------------------------
  class MANTID_GEOMETRY_DLL Iterator {
  public:
    Iterator(const ConvexPolygon &polygon);
 
    const Kernel::V2D &operator*() const;
    void operator++();
    PolygonEdge edge() const;
 
  private:
    size_t nextIndex() const;
 
    const ConvexPolygon &m_polygon;
    size_t m_index;
  };
 
  //-----------------------------------------------------------------
  // ConvexPolygon class
  //-----------------------------------------------------------------
 
  ConvexPolygon();
  ConvexPolygon(Vertices vertices);
  virtual ~ConvexPolygon() = default;
  ConvexPolygon(ConvexPolygon &&) = default;
  ConvexPolygon &operator=(ConvexPolygon &&) = default;
  ConvexPolygon(const ConvexPolygon &) = default;
  ConvexPolygon &operator=(const ConvexPolygon &) = default;
 
  bool isValid() const;
  void clear();
  void insert(const Kernel::V2D &pt);
  void insert(double x, double y);
  virtual const Kernel::V2D &operator[](const size_t index) const;
  virtual const Kernel::V2D &at(const size_t index) const;
  virtual size_t npoints() const;
  virtual bool contains(const Kernel::V2D &point) const;
  virtual bool contains(const ConvexPolygon &poly) const;
  virtual double area() const;
  virtual double determinant() const;
  virtual double minX() const;
  virtual double maxX() const;
  virtual double minY() const;
  virtual double maxY() const;
  virtual ConvexPolygon toPoly() const;
 
private:
  void setup();
  double triangleArea(const Kernel::V2D &a, const Kernel::V2D &b, const Kernel::V2D &c) const;
  double m_minX;
  double m_maxX;
  double m_minY;
  double m_maxY;
  // Points of the polygon
  Vertices m_vertices;
};
 
MANTID_GEOMETRY_DLL std::ostream &operator<<(std::ostream &os, const ConvexPolygon &polygon);
 
} // namespace Geometry
} // namespace Mantid