AF2Polygon2D.hpp

Go to the documentation of this file.

/*
 * AF2Polygon2D.hpp
 *
 * An immutable 2-dimensional polygon whose vertices are AF2Point2D points.
 *
 * The vertices are numbered 0 through n - 1, where n is the number of
 * polygon vertices.  As the numbers increase, the polygon is traversed
 * counterclockwise.  Thus the interior of the polygon is to the left
 * of the edge from vertex i to vertex i + 1 modulo n.
 *
 * This class holds on to its vertices with pointers, but it does not
 * manage the memory for its vertices.  It is the reponsibility of the
 * context that uses AF2Polygon2D to ensure that pointers to vertices
 * remain valid as long as they may be referenced by an AF2Polygon2D instance.
 */
#ifndef AF2POLYGON2D_HPP
#define AF2POLYGON2D_HPP

// C++
#include <list>

// MeshKit
#include "meshkit/AF2Point2D.hpp"

class AF2Polygon2D
{
  private:

    unsigned int numVertices;
    const AF2Point2D** vertices;

  public:

    AF2Polygon2D(std::list<const AF2Point2D*> const & polygonVertices);

    ~AF2Polygon2D();

    AF2Polygon2D(const AF2Polygon2D & toCopy);

    AF2Polygon2D& operator=(const AF2Polygon2D & rhs);

    unsigned int getNumVertices() const;

    const AF2Point2D* getVertex(unsigned int vtxNum) const;
};

#endif