AF2Polygon3D.hpp

Go to the documentation of this file.

/*
 * AF2Polygon3D.hpp
 *
 * \brief An immutable not-necessarily flat polygon whose vertices are
 *   AF2Point3D points.
 *
 * Perhaps a better name would be a closed wire rather than a polygon,
 * for the way it is represented here, but the object is defined in
 * terms of its vertices and is intended to correspond to a
 * two-dimensional element of a mesh.  This is also a close analog
 * of the AF2Polygon2D, except that it has three-dimensional vertices.
 *
 * 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 AF2Polygon3D to ensure that pointers to vertices
 * remain valid as long as they may be referenced by an AF2Polygon3D instance.
 */
#ifndef AF2POLYGON3D_HPP
#define AF2POLYGON3D_HPP

// C++
#include <list>

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

class AF2Polygon3D
{
  private:

    unsigned int numVertices;
    const AF2Point3D** vertices;

  public:

    AF2Polygon3D(std::list<const AF2Point3D*> const & polygonVertices);

    ~AF2Polygon3D();

    AF2Polygon3D(const AF2Polygon3D & toCopy);

    AF2Polygon3D& operator=(const AF2Polygon3D & rhs);

    unsigned int getNumVertices() const;

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

#endif