polygon2D.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: polygon2D.h,v $ $Revision: 1.6 $ $State: Exp $
******************************************************************************/
#ifndef polygon2D_H_
#define polygon2D_H_

//
// \file polygon2D.h
// \brief This file contains all the classes related to the 2 dimensional 
// geometric polygon class.  
//

#include "geometry/geometryDefines.h"
#include "geometry/point.h"
#include "geometry/extent.h"
#include <vlutil/vlConfig.h>
#include <vector>

// The DtPolygon2D class represents a 2 dimensional polygon
class DT_DLL_geometry DtPolygon2D
{
public:

   typedef std::vector<DtPoint> DtVertexContainer;
   typedef std::vector<DtPoint>::iterator DtVertexIter;
   typedef std::vector<DtPoint>::const_iterator DtVertexConstIter;
   
   typedef DtChord DtEdge;


   DtPolygon2D(const DtVertexContainer& polygonVertices);
   DtPolygon2D(const DtExtent& extent);

   virtual ~DtPolygon2D();

private:
   // Copy constructor and Assignment operator not implemented
   DtPolygon2D(const DtPolygon2D& original);
   const DtPolygon2D& operator=(const DtPolygon2D& original);
   
public:

   unsigned int numberOfVertices() const;

   bool getVertex(DtPoint& vertex, unsigned int vertexIndex) const;
   DtPoint vertex(unsigned int vertexIndex) const;

   bool setVertex(unsigned int vertexIndex, const DtPoint& newVertex);

   DtVertexConstIter verticesBegin() const;
   DtVertexConstIter verticesEnd() const;

   DtPoint verticesFront() const;
   DtPoint verticesBack() const;

   unsigned int numberOfEdges() const;

   DtEdge edge(unsigned int edgeIndex) const;
   bool getEdge(unsigned int edgeIndex, DtEdge& edgeToGet) const;

   DtExtent extent() const;

   const DtVertexContainer& vertices() const;

protected:
   bool testInvariant() const;
   
   bool isValidVertexIndex(unsigned int vertexIndex) const;

   bool isValidEdgeIndex(unsigned int edgeIndex) const;

private:
   DtVertexContainer myVertices;
};


#endif