mi32/region2d.h

Go to the documentation of this file.

/**
 * \file region2d.h <mi32/region2d.h>
 * \brief Functions and structure for regions
 *
 * \if NODOC
 * $Id: region2d.h_v 1.59 2007/04/13 15:12:43 scowan Exp $
 *
 * $Log: region2d.h_v $
 * Revision 1.59  2007/04/13 15:12:43  scowan
 * Added setDimension method.
 *
 * Revision 1.58  2006/09/20 17:39:24  scowan
 * Make polylinelist a class that gets exported.
 *
 * Revision 1.57  2006/01/25 14:42:49  mju
 * Don't pragma warning 4251 as disabled in stddefns.
 *
 * Revision 1.56  2005/12/22 15:05:44  scowan
 * Made cad a friend.
 *
 * Revision 1.55  2005/11/11 16:27:49  dfriberg
 * GetNumIslands returns 0 if no polylines in subregion2d
 *
 * Revision 1.54  2005/09/29 20:17:02  scowan
 * Added method to generate a point inside a subregion.
 *
 * Revision 1.53  2005/06/06 17:40:08  scowan
 * Added testRegion method that takes a region2d.
 *
 * Revision 1.52  2005/06/02 20:54:00  scowan
 * Added method to sub region to add valid polyline list.
 *
 * Revision 1.51  2005/03/10 21:56:50  mju
 * Add copyfilter and copyTo methods for subregion and region.
 *
 * Revision 1.50  2005/03/09 15:44:47  mju
 * Make binarytoregion2d a friend.
 *
 * Revision 1.49  2005/03/03 22:16:03  scowan
 * Added remove islands method.
 *
 * Revision 1.48  2004/12/29 17:02:17  scowan
 * Added method to append subregion to region for cad drawing.
 *
 * Revision 1.47  2004/11/16 17:15:04  dwilliss
 * Added ConvertToLongTruncate
 *
 * Revision 1.46  2004/09/21 17:31:30  mju
 * Add clearCoordRefSys.
 *
 * Revision 1.45  2004/08/30 17:01:42  scowan
 * Added reverse method.
 *
 * Revision 1.44  2004/08/17 21:30:43  mju
 * Add updateExtentsRect for subregion and region.
 *
 * Revision 1.43  2004/08/09 23:54:01  scowan
 * Added set orientation methods.
 *
 * Revision 1.42  2004/07/27 15:22:34  scowan
 * Added private method.
 *
 * Revision 1.41  2004/07/20 16:02:18  scowan
 * Removed legacy region methods.
 *
 * Revision 1.40  2004/07/16 17:31:13  scowan
 * Added some friends.
 *
 * Revision 1.39  2004/07/09 22:26:17  scowan
 * Updated docs to the changes in the region code.
 *
 * Revision 1.38  2004/07/08 13:21:19  mju
 * Add region2d ctor/op= from subregion2d.
 *
 * Revision 1.37  2004/06/29 20:58:05  scowan
 * Added mem func preventors.
 *
 * Revision 1.36  2004/06/29 17:03:59  scowan
 * Change docs.
 *
 * Revision 1.35  2004/06/29 16:37:50  scowan
 * Added comments about conversion.
 *
 * Revision 1.34  2004/06/28 20:29:43  scowan
 * *** empty log message ***
 *
 * Revision 1.33  2004/06/28 20:29:02  scowan
 * Added convert to method.
 *
 * Revision 1.32  2004/06/25 21:31:47  mju
 * Make serializer a friend.
 *
 * Revision 1.31  2004/06/25 15:10:12  scowan
 * Added deprecated method to get legacy region.
 *
 * Revision 1.30  2004/06/24 20:18:22  dwilliss
 * forward declare COORDOP
 *
 * Revision 1.29  2004/06/24 16:00:16  scowan
 * Added method to set the z range.
 *
 * Revision 1.28  2004/06/24 14:55:31  scowan
 * Added convert methods for coord op.
 *
 * Revision 1.27  2004/06/23 22:53:39  scowan
 * Added coord ref sys to region2d.
 *
 * Revision 1.26  2004/03/30 22:02:13  scowan
 * Added get numislands method.
 *
 * Revision 1.25  2004/03/02 15:23:10  scowan
 * Something.
 *
 * Revision 1.24  2004/03/02 15:11:46  scowan
 * Removed defines when done.
 *
 * Revision 1.23  2004/03/02 00:24:47  scowan
 * Export from geom the class.
 *
 * Revision 1.22  2003/11/28 16:52:25  scowan
 * Added threshold to is equiv to method.
 *
 * Revision 1.21  2003/11/25 00:30:28  scowan
 * Added is equivalent to methods.
 *
 * Revision 1.20  2003/09/26 21:52:25  scowan
 * Added flag to convert legacy region dest to new region.
 *
 * Revision 1.19  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.18  2003/09/09 17:56:39  scowan
 * Added another convert to long method.
 *
 * Revision 1.17  2003/08/27 21:31:04  scowan
 * Removed map proj param from assign method.
 *
 * Revision 1.16  2003/06/12 19:45:15  scowan
 * More const.
 *
 * Revision 1.15  2003/06/11 16:03:36  scowan
 * nc.
 *
 * Revision 1.14  2003/06/06 21:34:56  scowan
 * Added methods.
 *
 * Revision 1.13  2003/05/08 22:27:01  scowan
 * Chagned to use a 3d rect.
 *
 * Revision 1.12  2003/05/07 15:26:22  scowan
 * *** empty log message ***
 *
 * Revision 1.11  2003/05/07 15:24:56  scowan
 * Added test and assignment methods.
 *
 * Revision 1.10  2003/04/23 21:59:00  scowan
 * Added methods.
 *
 * Revision 1.9  2002/12/10 18:16:21  scowan
 * Added more friends.
 *
 * Revision 1.8  2002/11/26 21:30:17  dwilliss
 * never mind...
 *
 * Revision 1.7  2002/11/21 18:59:48  dwilliss
 * Added constructor taking POLYLINELIST&
 *
 * Revision 1.6  2002/11/13 18:22:28  scowan
 * Added begin and end iterators for both classes.
 *
 * Revision 1.5  2002/10/23 16:27:58  scowan
 * Code completed, not tested.
 *
 * Revision 1.4  2002/10/22 22:24:29  scowan
 * Added parameters.
 *
 * Revision 1.3  2002/10/11 21:47:06  scowan
 * Added intersect code.
 *
 * Revision 1.2  2002/10/11 17:07:41  scowan
 * Allowed vector interface class as a friend.
 *
 * Revision 1.1  2002/10/09 22:32:03  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_REGION2D_H
#define  INC_MI32_REGION2D_H

#ifndef  INC_MI32_POLYLINE_H
   #include <mi32/polyline.h>
#endif

#ifndef  INC_MI32_RECT_H
   #include <mi32/rect.h>
#endif

#ifndef  INC_MI32_MILIST_H
   #include <mi32/milist.h>
#endif

#ifndef  INC_MI32_SPATREF_H
   #include <mi32/spatref.h>
#endif

#ifdef GEOMDLL
   #define GEOMLIBEXPORT MI_DLLEXPORT
   #define GEOMLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define GEOMLIBEXPORT MI_DLLIMPORT
   #define GEOMLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class TRANS2D_AFFINE;      //!< Forward declarations
class TRANS2D_MAPGEN;
class REGION2D;
class SERIALIZER;
class BINARYTOREGION2D;
namespace RVC {
   class CAD;
   class VECTOR;
   class REGION;
   class REGIONHANDLE;
   }
namespace SPATREF {
   class COORDOP;
   }
#endif //!< GENERATING_DOXYGEN_OUTPUT

//! SUBREGION2D class - Definitions and methods to support a generic 2D sub-region object in memory.
//! The sub-region can be represented by either a single rectangle or as a polygon and a list of zero
//! or more islands.  All POLYLINE's stored in the SUBREGION are closed.

class GEOMLIBCLASSEXPORT SUBREGION2D {
   public:
   
      typedef POLYLINELIST::CONST_ITERATOR CONST_ITERATOR;

      //! Filter for copying subregion.
      class GEOMLIBCLASSEXPORT COPYFILTER {
         public:
            //! Constructor.
            COPYFILTER ();
            //! Destructor.
            virtual ~COPYFILTER () = 0;
            //! Determine if island should be included.
            bool IsIslandIncluded (
               const POLYLINE& island
               ) { return (v_IsIslandIncluded(island)); }
         private:
            //! Override to determine if island should be included.
            //! Default implementation always returns true.
            virtual bool v_IsIslandIncluded (
               const POLYLINE& island
               );
         };
   
      //! Default Constructor
      SUBREGION2D (
         );
         
      //! Copy Constructor
      SUBREGION2D (
         const SUBREGION2D& rhs
         );
         
      //! Constructor from DRECT2D
      SUBREGION2D (
         const DRECT2D& rect
         );
         
      //! Destructor
      ~SUBREGION2D (
         );
         
      //! Assignment operator
      SUBREGION2D& operator= (
         const SUBREGION2D& rhs
         );

      //! Assignment operator from rectangle
      SUBREGION2D& operator= (
         const DRECT2D& rhs
         );

      //! Assigns the sub-region to the passed in polygon
      //! This will clear any existing information in 'this'
      ERRVALUE Assign (
         const POLYLINE& Polygon
         );

      //! Assigns the sub-region to the passed in polygon.
      //! A validated polygon is a polygon that does not intersect itself.
      //! This will clear any existing information in 'this'
      void AssignValidated (
         const POLYLINE& Polygon
         );
         
      //! Assigns the sub-region to the passed in polygon list.  
      //! Assumes that the first polygon is the shell and the rest are islands.
      //! A validated polygon is a polygon that does not intersect itself.
      //! This will clear any existing information in 'this'
      void AssignValidated (
         const POLYLINELIST& PolygonList
         );
         
      //! Get the beginning of the list of POLYLINE's.
      //! The first item is the shell polygon, the rest following are islands.
      //! @return Iterator to the beginning of the POLYLINE list
      CONST_ITERATOR Begin (
         ) const { return (m_ItemList.Begin()); }

      //! Clear the sub-region
      void Clear (
         );
         
      //! Clip a polyline to a sub-region, call the ClipTarget for each segment
      //! @return TRUE if part of the line is clipped, FALSE if not, < 0 error
      int ClipLine (
         POLYLINE& PolyLine,
         POLYLINE::CLIP& ClipTarget,
         CLIPMODE ClipMode = CLIPMODE_Inside
         ) const;
         
      //! Compute the sub-region area in sub-region units
      double ComputeArea (
         ) const;
   
      //! Compute the sub-region area in sub-region units but do not exclude islands in the calculation
      double ComputeAreaNoIslands (
         ) const;
   
      //! Compute the sub-region perimeter in sub-region units
      double ComputePerimeter (
         ) const;
   
      //! Compute the sub-region perimeter in sub-region units but do not include islands in the calculation
      double ComputePerimeterNoIslands (
         ) const;
   
      //! Translate the sub-region using an affine transformation
      void ConvertForward (
         const TRANS2D_AFFINE& taf
         );
   
      //! Translate the sub-region using a mapgen transformation
      ERRVALUE ConvertForward (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the subregion using a coordinate operation (SPATREF::COORDOP) transformation
      ERRVALUE ConvertForward (
         const SPATREF::COORDOP& Op
         );
   
      //! Translate the sub-region using a mapgen transformation with densification
      //! If the sub-region is the extents only, this will convert it to a polygon sub-region
      //! before doing the transformation
      ERRVALUE ConvertForwardDense (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the region using a coordinate operation (SPATREF::COORDOP) transformation with densification
      //! If the region is the extents only, this will convert it to a proper sub-region
      //! before doing the transformation
      ERRVALUE ConvertForwardDense (
         const SPATREF::COORDOP& Op,
         double tolerance
         );

      //! Translate the sub-region using an affine transformation
      void ConvertInverse (
         const TRANS2D_AFFINE& taf
         );
   
      //! Translate the sub-region using a mapgen transformation
      ERRVALUE ConvertInverse (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the sub-region using a mapgen transformation with densification
      //! If the sub-region is the extents only, this will convert it to a polygon sub-region
      //! before doing the transformation
      ERRVALUE ConvertInverseDense (
         const TRANS2D_MAPGEN& tmg
         );
         
      //! Translate the subregion using a coordinate operation (SPATREF::COORDOP) transformation
      ERRVALUE ConvertReverse (
         const SPATREF::COORDOP& Op
         );
   
      //! Translate the subregion using a coordinate operation (SPATREF::COORDOP) transformation with densification
      //! If the subregion is the extents only, this will convert it to a proper sub-region
      //! before doing the transformation
      ERRVALUE ConvertReverseDense (
         const SPATREF::COORDOP& Op,
         double tolerance
         );
   
      //! Convert subregion from double's to INT32's with rounding, removes duplicate points
      ERRVALUE ConvertToLongRound (
         SIMPLE_ARRAY<LPOLYGON>& PolygonArray,
         SIMPLE_ARRAY<LPOINT2D>& PointArray
         ) const;
   
      //! Convert subregion from double's to INT32's, truncating towards 0, removes duplicate points
      ERRVALUE ConvertToLongTruncate (
         SIMPLE_ARRAY<LPOLYGON>& PolygonArray,
         SIMPLE_ARRAY<LPOINT2D>& PointArray
         ) const;

      //! Copy subregion to specified target with filter.
      ERRVALUE CopyTo (
         SUBREGION2D& target,                      //!< Target subregion
         COPYFILTER& filter                        //!< Filter to determine which islands to copy
         ) const;
   
      //! Get the end of the list of POLYLINE's
      //! @return End of POLYLINE list, see Begin() for details
      CONST_ITERATOR End (
         ) const { return (m_ItemList.End()); }

      //! Generate a point inside of the subregion
      //! This does deal with the islands of the subregion, the point will not be in an island.
      ERRVALUE GeneratePointInside (
         DPOINT2D& PointInside
         ) const;
         
      //! Get sub-region extents
      //! @return Extents of the sub-region
      const DRECT3D& GetExtents (
         ) const { return (m_Extents); }
   
      //! Get sub-region extents
      //! @return Extents of the sub-region
      const DRECT2D& GetExtents2D (
         ) const { return (m_Extents); }
   
      //! Get number of islands in the sub-region
      //! @return Number of islands in the sub-region
      INT32 GetNumIslands (
         ) const { return (IsEmpty() ? 0 : m_ItemList.GetNumItems()-1); }
   
      //! Intersect an specified rectangle area with the sub-region
      //! If the rectangle does not intersect with the sub-region area, 'this' will be set to empty
      ERRVALUE Intersect (
         const DRECT2D& Rect,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Intersect an specified area against the sub-region
      //! If the polygon does not intersect the sub-region area, 'this' will be set to empty
      //! If the "PolyLine" passed in is invalid, this method will only use one of the 
      //! valid polygons it finds, otherwise the results will be in error.
      ERRVALUE Intersect (
         const POLYLINE& PolyLine,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Intersect an specified area against the sub-region
      //! If the "SubRegion" does not intersect with the sub-region area, 'this' will be set to empty
      ERRVALUE Intersect (
         const SUBREGION2D& SubRegion,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Intersect an specified area from the sub-region known to be valid
      //! A validated polygon is a polygon that does not intersect itself.
      //! If the polygon does not intersect the sub-region area, 'this' will be set to empty
      ERRVALUE IntersectValidated (
         const POLYLINE& PolyLine,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );
         
      //! Determine if the two subregions are equivalent 
      //! This method uses "Fuzzy" vertex comparisons and the direction and order of the elements are not relevant
      //! Specify a different threshold to allow greater distances
      //! @return 'True' if they are, 'False' if not
      bool IsEquivalentTo (
         const SUBREGION2D& rhs,
         double threshold = 0.0        //!< Default threshold is max absolute value of rectangle coordinate * 1.0E-13
         ) const;
   
      //! Determine if the point falls inside the sub-region
      //! @return 'True' if point is inside the sub-region, 'false' if not
      bool IsPointInside (
         const DPOINT2D& point
         ) const;
   
      //! Is the sub-region an empty sub-region
      bool IsEmpty (
         ) const { return (!m_Extents.IsValid()); }

      //! Is the sub-region a simple rectangle region?         
      bool IsRectangle (
         ) const { return (m_IsRectangle); }

      //! Remove all of the islands from the subregion
      void RemoveIslands (
         );
         
      //! Reverse the orientation of the polygons and islands in the subregion
      void Reverse (
         );

      //! Set the dimension of the points stored in 'this' as 2D or 3D vertices.
      void SetDimension (
         DIMENSION dim
         );

      //! Set subregion orientation
      //! Outer shell polygon is set to the orientation specified in respect to itself. 
      //! Islands are set in the opposite orientation in respect to themselves
      void SetOrientation (
         ORIENTATION Orientation
         );
         
      //! Remove an specified area from the sub-region
      //! If the island removes the entire sub-region area, 'this' will be set to empty
      //! If the "Island" passed in is invalid, this method will only use one of the 
      //! valid polygons it finds, otherwise the results will be in error.
      ERRVALUE Subtract (
         const POLYLINE& Island,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Remove an specified area from the sub-region
      //! If the "SubRegion" removes the entire sub-region area, 'this' will be set to empty
      ERRVALUE Subtract (
         const SUBREGION2D& SubRegion,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Remove an specified rectangle area from the sub-region
      //! If the island removes the entire sub-region area, 'this' will be set to empty
      ERRVALUE Subtract (
         const DRECT2D& IslandRect,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Remove an specified area from the sub-region known to be valid
      //! A validated polygon is a polygon that does not intersect itself.
      //! If the island removes the entire sub-region area, 'this' will be set to empty
      ERRVALUE SubtractValidated (
         const POLYLINE& Island,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );
         
      //! Test the line given the test criteria against the sub-region
      //! @return "True" if the line meets the criteria, "false" if not
      bool TestLine (
         const POLYLINE& PolyLine,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the line against the sub-region
      //! @return POLYLINE::COMPRESULT
      POLYLINE::COMPRESULT TestLine (
         const POLYLINE& PolyLine
         ) const;

      //! Test the point given the test criteria against the sub-region
      //! @return "True" if the point meets the criteria, "false" if not
      bool TestPoint (
         const DPOINT2D& Point,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the polygon given the test criteria against the sub-region
      //! @return "True" if the polygon meets the criteria, "false" if not
      bool TestPolygon (
         const POLYLINE& PolyLine,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the polygon against the sub-region
      //! @return POLYLINE::COMPRESULT
      POLYLINE::COMPRESULT TestPolygon (
         const POLYLINE& PolyLine
         ) const;

      //! Test the subregion given the test criteria against 'this'
      //! @return "True" if the subregion meets the criteria, "false" if not
      bool TestSubRegion (
         const SUBREGION2D& SubRegion,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the subregion against 'this'
      //! @return POLYLINE::COMPRESULT
      POLYLINE::COMPRESULT TestSubRegion (
         const SUBREGION2D& SubRegion
         ) const;

      //! Union (ADD) a rectangle to the sub-region
      ERRVALUE Union (
         const DRECT2D& Rect,
         MILIST<SUBREGION2D>& SubRegionList,       //!< Filled in if operation creates more than one sub-region
         POLYLINE::COMBINERESULT& CombineResult
         );

      //! Union (ADD) a Polygon to the sub-region
      ERRVALUE Union (
         const POLYLINE& PolyLine,
         MILIST<SUBREGION2D>& SubRegionList        //!< Filled in if operation creates more than one sub-region
         );

      //! Union (ADD) a sub-region to the sub-region
      ERRVALUE Union (
         const SUBREGION2D& SubRegion,
         MILIST<SUBREGION2D>& SubRegionList,       //!< Filled in if operation creates more than one sub-region
         POLYLINE::COMBINERESULT& CombineResult
         );

      //! Union (ADD) a polygon to the sub-region
      ERRVALUE UnionValidated (
         const POLYLINE& PolyLine,
         MILIST<SUBREGION2D>& SubRegionList,       //!< Filled in if operation creates more than one sub-region
         POLYLINE::COMBINERESULT& CombineResult
         );
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
   
      POLYLINELIST m_ItemList;
      DRECT3D m_Extents;
      bool m_IsRectangle;
      
      void UpdateExtentsRect ();
      ERRVALUE UpdateFromShells (POLYLINELIST& PolyLineList, MILIST<SUBREGION2D>& SubRegionList);
   
      friend class RVC::VECTOR;        //!< For RVC::VECTOR::ReadSubRegion() and RVC::VECTOR::ReadRegion()
      friend class RVC::REGION;        //!< For RVC::REGION::GetRegion() and RVC::REGION::SetRegion()
      friend class REGION2D;           //!< For RVC::REGION::Assign()
      friend class RVC::REGIONHANDLE;
      friend class BINARYTOREGION2D;
      friend class SERIALIZER;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
         

//! REGION2D class - Definitions and methods to support a generic 2D region object in memory.  
//! The region can be represented by either a single rectangle or as a list of sub-regions.
class GEOMLIBCLASSEXPORT REGION2D {
   public:

      typedef MILIST<SUBREGION2D>::CONST_ITERATOR CONST_ITERATOR;
      
      //! Filter for copying region.
      class GEOMLIBCLASSEXPORT COPYFILTER : public SUBREGION2D::COPYFILTER {
         public:
            //! Constructor.
            COPYFILTER ();
            //! Destructor.
            virtual ~COPYFILTER () = 0;
            //! Determine if subregion should be included.
            bool IsSubRegionIncluded (
               const SUBREGION2D& subregion
               ) { return (v_IsSubRegionIncluded(subregion)); }
         private:
            //! Override to determine if subregion should be included.
            //! Default implementation always returns true.
            virtual bool v_IsSubRegionIncluded (
               const SUBREGION2D& subregion
               );
         };
   
      //! Default constructor, initializes to an invalid region      
      REGION2D (
         );
   
      //! Copy constructor
      REGION2D (
         const REGION2D& rhs
         );
   
      //! Constructor from DRECT2D
      REGION2D (
         const DRECT2D& rhs
         );

      //! Constructor from SUBREGION2D.
      REGION2D (
         const SUBREGION2D& SubRegion
         );
   
      //! Constructor from a list of polylines
      REGION2D (
         const POLYLINELIST&
         );
   
      //! Destructor
      ~REGION2D (
         );
         
      //! Assignment
      REGION2D& operator= (
         const REGION2D& rhs
         );
         
      //! Assignment from DRECT2D.
      REGION2D& operator= (
         const DRECT2D& rhs
         );

      //! Assignment from SUBREGION2D.
      REGION2D& operator= (
         const SUBREGION2D& SubRegion
         );
         
      //! Add a sub-region to the list without validating it.  Used for CAD rendering.
      void AddSubRegion (
         const SUBREGION2D& SubRegion
         );
   
      //! Assign from a POLYLINE and an index array defining how the polyline is formatted
      ERRVALUE Assign (
         const POLYLINE& PolyLine,
         const SIMPLE_ARRAY<INT32>& Index       //!< Each entry is the number of points >0 is shell <0 is island
         );
         
      //! Get the beginning of the list of SUBREGION's.
      //! @return Iterator to the beginning of the subregion list
      CONST_ITERATOR Begin (
         ) const { return (m_SubList.Begin()); }

      //! Clear the region
      void Clear (
         );
         
      //! Clear coordinate reference system.
      void ClearCoordRefSys (
         );
         
      //! Clip a polyline to a region, call the ClipTarget for each segment
      //! @return TRUE if part of the line is clipped, FALSE if not, < 0 error
      int ClipLine (
         POLYLINE& PolyLine,
         POLYLINE::CLIP& ClipTarget,
         CLIPMODE ClipMode = CLIPMODE_Inside
         ) const;
         
      //! Compute the region area in region units
      double ComputeArea (
         ) const;
   
      //! Compute the region area in region units but do not exclude islands in the calculation
      double ComputeAreaNoIslands (
         ) const;
   
      //! Compute the region perimeter in region units
      double ComputePerimeter (
         ) const;
   
      //! Compute the region perimeter in region units but do not include sub-region islands in the calculation
      double ComputePerimeterNoIslands (
         ) const;
   
      //! Translate the region using an affine transformation
      //! If the COORDREFSYS of 'this' is set, it will be changed to "Undefined"
      void ConvertForward (
         const TRANS2D_AFFINE& taf
         );
   
      //! Translate the region using a mapgen transformation
      //! An error will occur if the COORDREFSYS of 'this' is not local and the TRANS2D_MAPGEN's input transformation is not identity or
      //! the COORDREFSYS of 'this' does not match the TRANS2D_MAPGEN's input COORDREFSYS.
      //! If the TRANS2D_MAPGEN's output transformation is identity, 'this' COORDREFSYS will be set to the TRANS2D_MAPGEN's output COORDREFSYS.
      //! otherwise it will be set to "Undefined".
      ERRVALUE ConvertForward (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the region using a coordinate operation (SPATREF::COORDOP) transformation
      //! Region coordinate reference system "GetCoordRefSys()' must equate to the Op.GetSourceCRS().
      //! The Op.GetTargetCRS() is assigned as the region's COORDREFSYS after the transformation.
      ERRVALUE ConvertForward (
         const SPATREF::COORDOP& Op
         );
   
      //! Translate the region using a mapgen transformation with densification
      //! An error will occur if the COORDREFSYS of 'this' is not local and the TRANS2D_MAPGEN's input transformation is not identity or
      //! the COORDREFSYS of 'this' does not match the TRANS2D_MAPGEN's input COORDREFSYS.
      //! If the TRANS2D_MAPGEN's output transformation is identity, 'this' COORDREFSYS will be set to the TRANS2D_MAPGEN's output COORDREFSYS.
      //! otherwise it will be set to "Undefined".
      ERRVALUE ConvertForwardDense (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the region using a coordinate operation (SPATREF::COORDOP) transformation with densification
      //! Region coordinate reference system "GetCoordRefSys()' must equate to the Op.GetSourceCRS().
      //! The Op.GetTargetCRS() is assigned as the region's COORDREFSYS after the transformation.
      ERRVALUE ConvertForwardDense (
         const SPATREF::COORDOP& Op,
         double tolerance
         );
   
      //! Translate the region using an affine transformation
      //! If the COORDREFSYS of 'this' is set, it will be changed to "Undefined"
      void ConvertInverse (
         const TRANS2D_AFFINE& taf
         );
   
      //! Translate the region using a mapgen transformation
      //! An error will occur if the COORDREFSYS of 'this' is not local and the TRANS2D_MAPGEN's output transformation is not identity or
      //! the COORDREFSYS of 'this' does not match the TRANS2D_MAPGEN's output COORDREFSYS.
      //! If the TRANS2D_MAPGEN's input transformation is identity, 'this' COORDREFSYS will be set to the TRANS2D_MAPGEN's input COORDREFSYS
      //! otherwise it will be set to "Undefined".
      ERRVALUE ConvertInverse (
         const TRANS2D_MAPGEN& tmg
         );
   
      //! Translate the region using a mapgen transformation with densification
      //! An error will occur if the COORDREFSYS of 'this' is not local and the TRANS2D_MAPGEN's output transformation is not identity or
      //! the COORDREFSYS of 'this' does not match the TRANS2D_MAPGEN's output COORDREFSYS.
      //! If the TRANS2D_MAPGEN's input transformation is identity, 'this' COORDREFSYS will be set to the TRANS2D_MAPGEN's input COORDREFSYS.
      //! otherwise it will be set to "Undefined".
      ERRVALUE ConvertInverseDense (
         const TRANS2D_MAPGEN& tmg
         );
         
      //! Translate the region using a coordinate operation (SPATREF::COORDOP) transformation
      //! Region coordinate reference system "GetCoordRefSys()' must equate to the Op.GetTargetCRS().
      //! The Op.GetSourceCRS() is assigned as the region's COORDREFSYS after the transformation.
      ERRVALUE ConvertReverse (
         const SPATREF::COORDOP& Op
         );
   
      //! Translate the region using a coordinate operation (SPATREF::COORDOP) transformation with densification
      //! Region coordinate reference system "GetCoordRefSys()' must equate to the Op.GetTargetCRS().
      //! The Op.GetSourceCRS() is assigned as the region's COORDREFSYS after the transformation.
      ERRVALUE ConvertReverseDense (
         const SPATREF::COORDOP& Op,
         double tolerance
         );

      //! Convert 'this' to a different COORDREFSYS.
      ERRVALUE ConvertTo (
         const SPATREF::COORDREFSYS& DestCoordRefSys,
         double tolerance = 0.0
         );
   
      //! Copy region to specified target with filter.
      ERRVALUE CopyTo (
         REGION2D& target,                         //!< Target subregion
         COPYFILTER& filter                        //!< Filter to determine which subregions and islands to copy
         ) const;
   
      //! Get the end of the list of SUBREGION's
      //! @return End of SUBREGION list, see Begin() for details
      CONST_ITERATOR End (
         ) const { return (m_SubList.End()); }

      //! Exclusive Union (XOR) RegionB with 'this'
      ERRVALUE ExclusiveUnion (
         const REGION2D& RegionB
         );
         
      //! Exclusive Union (XOR) RegionB with RegionA and place in 'this'
      //! Will convert 'this' to RegionA's SPATREF::COORDREFSYS
      ERRVALUE ExclusiveUnion (
         const REGION2D& RegionA,
         const REGION2D& RegionB
         );
         
      //! Get the region's coordinate reference system
      //! @return SPATREF::COORDREFSYS of the region
      const SPATREF::COORDREFSYS& GetCoordRefSys (
         ) const { return (m_CoordRefSys); }
         
      //! Get region extents
      //! @return Extents of the entire region
      const DRECT3D& GetExtents (
         ) const { return (m_Extents); }
   
      //! Get region extents
      //! @return Extents of the entire region
      const DRECT2D& GetExtents2D (
         ) const { return (m_Extents); }
   
      //! Get number of sub-regions
      //! @return Number of sub-regions
      INT32 GetNumSubRegions (
         ) const;
         
      //! Intersect rectangle with 'this'
      ERRVALUE Intersect (
         const DRECT2D& Rect
         );
         
      //! Intersect a polygon with 'this'
      ERRVALUE Intersect (
         const POLYLINE& PolyLine
         );
         
      //! Intersect a sub-region with 'this'
      ERRVALUE Intersect (
         const SUBREGION2D& SubRegion
         );
         
      //! Intersect RegionB with 'this'
      ERRVALUE Intersect (
         const REGION2D& RegionB
         );
         
      //! Intersect RegionB with RegionA and place in 'this'
      //! Will convert 'this' to RegionA's SPATREF::COORDREFSYS
      ERRVALUE Intersect (
         const REGION2D& RegionA,
         const REGION2D& RegionB
         );
         
      //! Intersect a validated polygon with 'this'
      ERRVALUE IntersectValidated (
         const POLYLINE& PolyLine
         );
         
      //! Is the region an empty region
      bool IsEmpty (
         ) const { return (!m_Extents.IsValid()); }

      //! Determine if the two regions are equivalent 
      //! This method uses "Fuzzy" vertex comparisons and the direction and order of the elements are not relevant
      //! Specify a different threshold to allow greater distances
      //! @return 'True' if they are, 'False' if not
      bool IsEquivalentTo (
         const REGION2D& rhs,
         double threshold = 0.0        //!< Default threshold is max absolute value of rectangle coordinate * 1.0E-13
         ) const;
   
      //! Determine if the point falls inside the region
      //! @return 'True' if point is inside region, 'false' if not
      bool IsPointInside (
         const DPOINT2D& point
         ) const;
         
      //! Is the region a simple rectangle region?
      bool IsRectangle (
         ) const { return (m_IsRectangle); }
         
      //! Remove all of the islands from the region
      void RemoveIslands (
         );
         
      //! Reverse the orientation of the subregions in the region
      void Reverse (
         );

      //! Set the region's coordinate reference system
      //! Does not do any transformations of the region, 
      //! assumes that the region is in the system specified
      void SetCoordRefSys (
         const SPATREF::COORDREFSYS& CoordSysRef
         ) { m_CoordRefSys = CoordSysRef; }

      //! Set the dimension of the points stored in 'this' as 2D or 3D vertices.
      void SetDimension (
         DIMENSION dim
         );

      //! Set region orientation
      //! Each subregion is set using SUBREGION2D::SetOrientation()
      void SetOrientation (
         ORIENTATION Orientation
         );
         
      //! Set the Z init and Z last fields of the extents box        
      void SetZRange (
         const DOUBLE_RANGE& range
         );
         
      //! Subtract rectangle from 'this'
      ERRVALUE Subtract (
         const DRECT2D& Rect
         );
         
      //! Subtract a polygon from 'this'
      ERRVALUE Subtract (
         const POLYLINE& PolyLine
         );
         
      //! Subtract a sub-region from 'this'
      ERRVALUE Subtract (
         const SUBREGION2D& SubRegion
         );
         
      //! Subtract RegionB from 'this'
      ERRVALUE Subtract (
         const REGION2D& RegionB
         );
         
      //! Subtract RegionB from RegionA and place in 'this'
      //! Will convert 'this' to RegionA's SPATREF::COORDREFSYS
      ERRVALUE Subtract (
         const REGION2D& RegionA,
         const REGION2D& RegionB
         );
         
      //! Subtract a validated polygon from 'this'
      ERRVALUE SubtractValidated (
         const POLYLINE& PolyLine
         );
         
      //! Test the line given the test criteria against the region
      //! @return "True" if the line meets the criteria, "false" if not
      bool TestLine (
         const POLYLINE& PolyLine,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the point given the test criteria against the sub-region
      //! @return "True" if the point meets the criteria, "false" if not
      bool TestPoint (
         const DPOINT2D& Point,
         TESTCRITERIA TestCriteria
         ) const;

      //! Test the polygon given the test criteria against the region
      //! @return "True" if the polygon meets the criteria, "false" if not
      bool TestPolygon (
         const POLYLINE& PolyLine,
         TESTCRITERIA TestCriteria
         ) const;