GDAL

A collection of 1 or more geometry objects. More...
#include <ogr_geometry.h>
Public Member Functions  
OGRGeometryCollection ()  
Create an empty geometry collection.  
OGRGeometryCollection (const OGRGeometryCollection &other)  
Copy constructor. More...  
OGRGeometryCollection &  operator= (const OGRGeometryCollection &other) 
Assignment operator. More...  
virtual const char *  getGeometryName () const CPL_OVERRIDE 
Fetch WKT name for geometry type. More...  
virtual OGRwkbGeometryType  getGeometryType () const CPL_OVERRIDE 
Fetch geometry type. More...  
virtual OGRGeometry *  clone () const CPL_OVERRIDE 
Make a copy of this object. More...  
virtual void  empty () CPL_OVERRIDE 
Clear geometry information. More...  
virtual OGRErr  transform (OGRCoordinateTransformation *poCT) CPL_OVERRIDE 
Apply arbitrary coordinate transformation to geometry. More...  
virtual void  flattenTo2D () CPL_OVERRIDE 
Convert geometry to strictly 2D. More...  
virtual OGRBoolean  IsEmpty () const CPL_OVERRIDE 
Returns TRUE (nonzero) if the object has no points. More...  
virtual void  segmentize (double dfMaxLength) CPL_OVERRIDE 
Modify the geometry such it has no segment longer then the given distance. More...  
virtual OGRBoolean  hasCurveGeometry (int bLookForNonLinear=FALSE) const CPL_OVERRIDE 
Returns if this geometry is or has curve geometry. More...  
virtual OGRGeometry *  getCurveGeometry (const char *const *papszOptions=NULL) const CPL_OVERRIDE 
Return curve version of this geometry. More...  
virtual OGRGeometry *  getLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=NULL) const CPL_OVERRIDE 
Return, possibly approximate, noncurve version of this geometry. More...  
virtual int  WkbSize () const CPL_OVERRIDE 
Returns size of related binary representation. More...  
virtual OGRErr  importFromWkb (const unsigned char *, int, OGRwkbVariant, int &nBytesConsumedOut) CPL_OVERRIDE 
Assign geometry from well known binary data. More...  
virtual OGRErr  exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const CPL_OVERRIDE 
Convert a geometry into well known binary format. More...  
virtual OGRErr  importFromWkt (char **) CPL_OVERRIDE 
Assign geometry from well known text data. More...  
virtual OGRErr  exportToWkt (char **ppszDstText, OGRwkbVariant=wkbVariantOldOgc) const CPL_OVERRIDE 
Convert a geometry into well known text format. More...  
virtual double  get_Length () const 
Compute the length of a multicurve. More...  
virtual double  get_Area () const 
Compute area of geometry collection. More...  
virtual int  getDimension () const CPL_OVERRIDE 
Get the dimension of this object. More...  
virtual void  getEnvelope (OGREnvelope *psEnvelope) const CPL_OVERRIDE 
Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...  
virtual void  getEnvelope (OGREnvelope3D *psEnvelope) const CPL_OVERRIDE 
Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More...  
int  getNumGeometries () const 
Fetch number of geometries in container. More...  
OGRGeometry *  getGeometryRef (int) 
Fetch geometry from container. More...  
const OGRGeometry *  getGeometryRef (int) const 
Fetch geometry from container. More...  
virtual OGRBoolean  Equals (OGRGeometry *) const CPL_OVERRIDE 
Returns TRUE if two geometries are equivalent. More...  
virtual void  setCoordinateDimension (int nDimension) CPL_OVERRIDE 
Set the coordinate dimension. More...  
virtual void  set3D (OGRBoolean bIs3D) CPL_OVERRIDE 
Add or remove the Z coordinate dimension. More...  
virtual void  setMeasured (OGRBoolean bIsMeasured) CPL_OVERRIDE 
Add or remove the M coordinate dimension. More...  
virtual OGRErr  addGeometry (const OGRGeometry *) 
Add a geometry to the container. More...  
virtual OGRErr  addGeometryDirectly (OGRGeometry *) 
Add a geometry directly to the container. More...  
virtual OGRErr  removeGeometry (int iIndex, int bDelete=TRUE) 
Remove a geometry from the container. More...  
void  closeRings () CPL_OVERRIDE 
Force rings to be closed. More...  
virtual void  swapXY () CPL_OVERRIDE 
Swap x and y coordinates. More...  
Public Member Functions inherited from OGRGeometry  
OGRGeometry (const OGRGeometry &other)  
Copy constructor. More...  
OGRGeometry &  operator= (const OGRGeometry &other) 
Assignment operator. More...  
virtual int  getCoordinateDimension () const 
Get the dimension of the coordinates in this object. More...  
int  CoordinateDimension () const 
Get the dimension of the coordinates in this object. More...  
virtual OGRBoolean  IsValid () const 
Test if the geometry is valid. More...  
virtual OGRBoolean  IsSimple () const 
Test if the geometry is simple. More...  
OGRBoolean  Is3D () const 
OGRBoolean  IsMeasured () const 
virtual OGRBoolean  IsRing () const 
Test if the geometry is a ring. More...  
OGRErr  importFromWkb (unsigned char *, int=1, OGRwkbVariant=wkbVariantOldOgc) 
Assign geometry from well known binary data. More...  
OGRwkbGeometryType  getIsoGeometryType () const 
Get the geometry type that conforms with ISO SQL/MM Part3. More...  
virtual void  dumpReadable (FILE *, const char *=NULL, char **papszOptions=NULL) const 
Dump geometry in well known text format to indicated output file. More...  
virtual char *  exportToGML (const char *const *papszOptions=NULL) const 
Convert a geometry into GML format. More...  
virtual char *  exportToKML () const 
Convert a geometry into KML format. More...  
virtual char *  exportToJson () const 
Convert a geometry into GeoJSON format. More...  
virtual GEOSGeom  exportToGEOS (GEOSContextHandle_t hGEOSCtxt) const CPL_WARN_UNUSED_RESULT 
Returns a GEOSGeom object corresponding to the geometry. More...  
void  assignSpatialReference (OGRSpatialReference *poSR) 
Assign spatial reference to this object. More...  
OGRSpatialReference *  getSpatialReference (void) const 
Returns spatial reference system for object. More...  
OGRErr  transformTo (OGRSpatialReference *poSR) 
Transform geometry to new spatial reference system. More...  
virtual OGRBoolean  Intersects (const OGRGeometry *) const 
Do these features intersect? More...  
virtual OGRBoolean  Disjoint (const OGRGeometry *) const 
Test for disjointness. More...  
virtual OGRBoolean  Touches (const OGRGeometry *) const 
Test for touching. More...  
virtual OGRBoolean  Crosses (const OGRGeometry *) const 
Test for crossing. More...  
virtual OGRBoolean  Within (const OGRGeometry *) const 
Test for containment. More...  
virtual OGRBoolean  Contains (const OGRGeometry *) const 
Test for containment. More...  
virtual OGRBoolean  Overlaps (const OGRGeometry *) const 
Test for overlap. More...  
virtual OGRGeometry *  Boundary () const CPL_WARN_UNUSED_RESULT 
Compute boundary. More...  
virtual double  Distance (const OGRGeometry *) const 
Compute distance between two geometries. More...  
virtual OGRGeometry *  ConvexHull () const CPL_WARN_UNUSED_RESULT 
Compute convex hull. More...  
virtual OGRGeometry *  Buffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT 
Compute buffer of geometry. More...  
virtual OGRGeometry *  Intersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT 
Compute intersection. More...  
virtual OGRGeometry *  Union (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT 
Compute union. More...  
virtual OGRGeometry *  UnionCascaded () const CPL_WARN_UNUSED_RESULT 
Compute union using cascading. More...  
virtual OGRGeometry *  Difference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT 
Compute difference. More...  
virtual OGRGeometry *  SymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT 
Compute symmetric difference. More...  
virtual OGRErr  Centroid (OGRPoint *poPoint) const 
Compute the geometry centroid. More...  
virtual OGRGeometry *  Simplify (double dTolerance) const CPL_WARN_UNUSED_RESULT 
Simplify the geometry. More...  
OGRGeometry *  SimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT 
Simplify the geometry while preserving topology. More...  
virtual OGRGeometry *  DelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT 
Return a Delaunay triangulation of the vertices of the geometry. More...  
virtual OGRGeometry *  Polygonize () const CPL_WARN_UNUSED_RESULT 
Polygonizes a set of sparse edges. More...  
virtual double  Distance3D (const OGRGeometry *poOtherGeom) const 
Returns the 3D distance between two geometries. More...  
Static Public Member Functions  
static OGRGeometryCollection *  CastToGeometryCollection (OGRGeometryCollection *poSrc) 
Cast to geometry collection. More...  
Static Public Member Functions inherited from OGRGeometry  
static GEOSContextHandle_t  createGEOSContext () 
Create a new GEOS context. More...  
static void  freeGEOSContext (GEOSContextHandle_t hGEOSCtxt) 
Destroy a GEOS context. More...  
Protected Member Functions  
virtual OGRBoolean  isCompatibleSubType (OGRwkbGeometryType) const 
Returns whether a geometry of the specified geometry type can be a member of this collection. More...  
A collection of 1 or more geometry objects.
All geometries must share a common spatial reference system, and Subclasses may impose additional restrictions on the contents.
OGRGeometryCollection::OGRGeometryCollection  (  const OGRGeometryCollection &  other  ) 
Copy constructor.
Note: before GDAL 2.1, only the default implementation of the constructor existed, which could be unsafe to use.

virtual 
Add a geometry to the container.
Some subclasses of OGRGeometryCollection restrict the types of geometry that can be added, and may return an error. The passed geometry is cloned to make an internal copy.
There is no SFCOM analog to this method.
This method is the same as the C function OGR_G_AddGeometry().
poNewGeom  geometry to add to the container. 

virtual 
Add a geometry directly to the container.
Some subclasses of OGRGeometryCollection restrict the types of geometry that can be added, and may return an error. Ownership of the passed geometry is taken by the container rather than cloning as addGeometry() does.
This method is the same as the C function OGR_G_AddGeometryDirectly().
There is no SFCOM analog to this method.
poNewGeom  geometry to add to the container. 

static 
Cast to geometry collection.
This methods cast a derived class of geometry collection to a plain geometry collection.
The passed in geometry is consumed and a new one returned (or NULL in case of failure).
poSrc  the input geometry  ownership is passed to the method. 

virtual 
Make a copy of this object.
This method relates to the SFCOM IGeometry::clone() method.
This method is the same as the C function OGR_G_Clone().
Implements OGRGeometry.

virtual 
Force rings to be closed.
If this geometry, or any contained geometries has polygon rings that are not closed, they will be closed by adding the starting point at the end.
Reimplemented from OGRGeometry.

virtual 
Clear geometry information.
This restores the geometry to it's initial state after construction, and before assignment of actual geometry.
This method relates to the SFCOM IGeometry::Empty() method.
This method is the same as the C function OGR_G_Empty().
Implements OGRGeometry.

virtual 
Returns TRUE if two geometries are equivalent.
This operation implements the SQL/MM ST_OrderingEquals() operation.
The comparison is done in a structural way, that is to say that the geometry types must be identical, as well as the number and ordering of subgeometries and vertices. Or equivalently, two geometries are considered equal by this method if their WKT/WKB representation is equal. Note: this must be distinguished for equality in a spatial way (which is the purpose of the ST_Equals() operation).
This method is the same as the C function OGR_G_Equals().
Implements OGRGeometry.

virtual 
Convert a geometry into well known binary format.
This method relates to the SFCOM IWks::ExportToWKB() method.
This method is the same as the C function OGR_G_ExportToWkb() or OGR_G_ExportToIsoWkb(), depending on the value of eWkbVariant.
eByteOrder  One of wkbXDR or wkbNDR indicating MSB or LSB byte order respectively. 
pabyData  a buffer into which the binary representation is written. This buffer must be at least OGRGeometry::WkbSize() byte in size. 
eWkbVariant  What standard to use when exporting geometries with three dimensions (or more). The default wkbVariantOldOgc is the historical OGR variant. wkbVariantIso is the variant defined in ISO SQL/MM and adopted by OGC for SFSQL 1.2. 
Implements OGRGeometry.

virtual 
Convert a geometry into well known text format.
This method relates to the SFCOM IWks::ExportToWKT() method.
This method is the same as the C function OGR_G_ExportToWkt().
ppszDstText  a text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with CPLFree(). 
eWkbVariant  the specification that must be conformed too :

Implements OGRGeometry.
Reimplemented in OGRMultiLineString, OGRMultiCurve, OGRMultiPoint, OGRMultiPolygon, and OGRMultiSurface.

virtual 
Convert geometry to strictly 2D.
In a sense this converts all Z coordinates to 0.0.
This method is the same as the C function OGR_G_FlattenTo2D().
Implements OGRGeometry.

virtual 
Compute area of geometry collection.
The area is computed as the sum of the areas of all members in this collection.

virtual 
Compute the length of a multicurve.
The length is computed as the sum of the length of all members in this collection.

virtual 
Return curve version of this geometry.
Returns a geometry that has possibly CIRCULARSTRING, COMPOUNDCURVE, CURVEPOLYGON, MULTICURVE or MULTISURFACE in it, by deapproximating curve geometries.
If the geometry has no curve portion, the returned geometry will be a clone of it.
The ownership of the returned geometry belongs to the caller.
The reverse method is OGRGeometry::getLinearGeometry().
This function is the same as C function OGR_G_GetCurveGeometry().
papszOptions  options as a nullterminated list of strings. Unused for now. Must be set to NULL. 
Reimplemented from OGRGeometry.

virtual 
Get the dimension of this object.
This method corresponds to the SFCOM IGeometry::GetDimension() method. It indicates the dimension of the object, but does not indicate the dimension of the underlying space (as indicated by OGRGeometry::getCoordinateDimension()).
This method is the same as the C function OGR_G_GetDimension().
Implements OGRGeometry.
Reimplemented in OGRMultiCurve, OGRMultiPoint, and OGRMultiSurface.

virtual 
Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure.
This method is the same as the C function OGR_G_GetEnvelope().
psEnvelope  the structure in which to place the results. 
Implements OGRGeometry.

virtual 
Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure.
This method is the same as the C function OGR_G_GetEnvelope3D().
psEnvelope  the structure in which to place the results. 
Implements OGRGeometry.

virtual 
Fetch WKT name for geometry type.
There is no SFCOM analog to this method.
This method is the same as the C function OGR_G_GetGeometryName().
Implements OGRGeometry.
Reimplemented in OGRMultiLineString, OGRMultiCurve, OGRMultiPoint, OGRMultiPolygon, and OGRMultiSurface.
OGRGeometry * OGRGeometryCollection::getGeometryRef  (  int  i  ) 
Fetch geometry from container.
This method returns a pointer to a geometry within the container. The returned geometry remains owned by the container, and should not be modified. The pointer is only valid until the next change to the geometry container. Use IGeometry::clone() to make a copy.
This method relates to the SFCOM IGeometryCollection::get_Geometry() method.
i  the index of the geometry to fetch, between 0 and getNumGeometries()  1. 
const OGRGeometry * OGRGeometryCollection::getGeometryRef  (  int  i  )  const 
Fetch geometry from container.
This method returns a pointer to a geometry within the container. The returned geometry remains owned by the container, and should not be modified. The pointer is only valid until the next change to the geometry container. Use IGeometry::clone() to make a copy.
This method relates to the SFCOM IGeometryCollection::get_Geometry() method.
i  the index of the geometry to fetch, between 0 and getNumGeometries()  1. 

virtual 
Fetch geometry type.
Note that the geometry type may include the 2.5D flag. To get a 2D flattened version of the geometry type apply the wkbFlatten() macro to the return result.
This method is the same as the C function OGR_G_GetGeometryType().
Implements OGRGeometry.
Reimplemented in OGRMultiLineString, OGRMultiCurve, OGRMultiPoint, OGRMultiPolygon, and OGRMultiSurface.

virtual 
Return, possibly approximate, noncurve version of this geometry.
Returns a geometry that has no CIRCULARSTRING, COMPOUNDCURVE, CURVEPOLYGON, MULTICURVE or MULTISURFACE in it, by approximating curve geometries.
The ownership of the returned geometry belongs to the caller.
The reverse method is OGRGeometry::getCurveGeometry().
This method is the same as the C function OGR_G_GetLinearGeometry().
dfMaxAngleStepSizeDegrees  the largest step in degrees along the arc, zero to use the default setting. 
papszOptions  options as a nullterminated list of strings. See OGRGeometryFactory::curveToLineString() for valid options. 
Reimplemented from OGRGeometry.
int OGRGeometryCollection::getNumGeometries  (  )  const 
Fetch number of geometries in container.
This method relates to the SFCOM IGeometryCollect::get_NumGeometries() method.

virtual 
Returns if this geometry is or has curve geometry.
Returns if a geometry is, contains or may contain a CIRCULARSTRING, COMPOUNDCURVE, CURVEPOLYGON, MULTICURVE or MULTISURFACE.
If bLookForNonLinear is set to TRUE, it will be actually looked if the geometry or its subgeometries are or contain a nonlinear geometry in them. In which case, if the method returns TRUE, it means that getLinearGeometry() would return an approximate version of the geometry. Otherwise, getLinearGeometry() would do a conversion, but with just converting container type, like COMPOUNDCURVE > LINESTRING, MULTICURVE > MULTILINESTRING or MULTISURFACE > MULTIPOLYGON, resulting in a "lossless" conversion.
This method is the same as the C function OGR_G_HasCurveGeometry().
bLookForNonLinear  set it to TRUE to check if the geometry is or contains a CIRCULARSTRING. 
Reimplemented from OGRGeometry.
Reimplemented in OGRMultiLineString, OGRMultiCurve, OGRMultiPoint, OGRMultiPolygon, and OGRMultiSurface.

virtual 
Assign geometry from well known binary data.
The object must have already been instantiated as the correct derived type of geometry object to match the binaries type. This method is used by the OGRGeometryFactory class, but not normally called by application code.
This method relates to the SFCOM IWks::ImportFromWKB() method.
This method is the same as the C function OGR_G_ImportFromWkb().
pabyData  the binary input data. 
nSize  the size of pabyData in bytes, or 1 if not known. 
eWkbVariant  if wkbVariantPostGIS1, special interpretation is done for curve geometries code 
nBytesConsumedOut  output parameter. Number of bytes consumed. 
Implements OGRGeometry.

virtual 
Assign geometry from well known text data.
The object must have already been instantiated as the correct derived type of geometry object to match the text type. This method is used by the OGRGeometryFactory class, but not normally called by application code.
This method relates to the SFCOM IWks::ImportFromWKT() method.
This method is the same as the C function OGR_G_ImportFromWkt().
ppszInput  pointer to a pointer to the source text. The pointer is updated to pointer after the consumed text. 
Implements OGRGeometry.
Reimplemented in OGRMultiCurve, OGRMultiPoint, and OGRMultiSurface.

protectedvirtual 
Returns whether a geometry of the specified geometry type can be a member of this collection.
eSubType  type of the potential member 
Reimplemented in OGRMultiLineString, OGRMultiCurve, OGRMultiPoint, OGRMultiPolygon, and OGRMultiSurface.

virtual 
Returns TRUE (nonzero) if the object has no points.
Normally this returns FALSE except between when an object is instantiated and points have been assigned.
This method relates to the SFCOM IGeometry::IsEmpty() method.
Implements OGRGeometry.
OGRGeometryCollection & OGRGeometryCollection::operator=  (  const OGRGeometryCollection &  other  ) 
Assignment operator.
Note: before GDAL 2.1, only the default implementation of the operator existed, which could be unsafe to use.

virtual 
Remove a geometry from the container.
Removing a geometry will cause the geometry count to drop by one, and all "higher" geometries will shuffle down one in index.
There is no SFCOM analog to this method.
This method is the same as the C function OGR_G_RemoveGeometry().
iGeom  the index of the geometry to delete. A value of 1 is a special flag meaning that all geometries should be removed. 
bDelete  if TRUE the geometry will be deallocated, otherwise it will not. The default is TRUE as the container is considered to own the geometries in it. 

virtual 
Modify the geometry such it has no segment longer then the given distance.
Add intermediate vertices to a geometry.
Interpolated points will have Z and M values (if needed) set to 0. Distance computation is performed in 2d only
This function is the same as the C function OGR_G_Segmentize()
dfMaxLength  the maximum distance between 2 points after segmentization 
This method modifies the geometry to add intermediate vertices if necessary so that the maximum length between 2 consecutive vertices is lower than dfMaxLength.
dfMaxLength  maximum length between 2 consecutive vertices. 
Reimplemented from OGRGeometry.

virtual 
Add or remove the Z coordinate dimension.
This method adds or removes the explicit Z coordinate dimension. Removing the Z coordinate dimension of a geometry will remove any existing Z values. Adding the Z dimension to a geometry collection, a compound curve, a polygon, etc. will affect the children geometries.
bIs3D  Should the geometry have a Z dimension, either TRUE or FALSE. 
Reimplemented from OGRGeometry.

virtual 
Set the coordinate dimension.
This method sets the explicit coordinate dimension. Setting the coordinate dimension of a geometry to 2 should zero out any existing Z values. Setting the dimension of a geometry collection, a compound curve, a polygon, etc. will affect the children geometries. This will also remove the M dimension if present before this call.
nNewDimension  New coordinate dimension value, either 2 or 3. 
Reimplemented from OGRGeometry.

virtual 
Add or remove the M coordinate dimension.
This method adds or removes the explicit M coordinate dimension. Removing the M coordinate dimension of a geometry will remove any existing M values. Adding the M dimension to a geometry collection, a compound curve, a polygon, etc. will affect the children geometries.
bIsMeasured  Should the geometry have a M dimension, either TRUE or FALSE. 
Reimplemented from OGRGeometry.

virtual 

virtual 
Apply arbitrary coordinate transformation to geometry.
This method will transform the coordinates of a geometry from their current spatial reference system to a new target spatial reference system. Normally this means reprojecting the vectors, but it could include datum shifts, and changes of units.
Note that this method does not require that the geometry already have a spatial reference system. It will be assumed that they can be treated as having the source spatial reference system of the OGRCoordinateTransformation object, and the actual SRS of the geometry will be ignored. On successful completion the output OGRSpatialReference of the OGRCoordinateTransformation will be assigned to the geometry.
This method is the same as the C function OGR_G_Transform().
poCT  the transformation to apply. 
Implements OGRGeometry.

virtual 
Returns size of related binary representation.
This method returns the exact number of bytes required to hold the well known binary representation of this geometry object. Its computation may be slightly expensive for complex geometries.
This method relates to the SFCOM IWks::WkbSize() method.
This method is the same as the C function OGR_G_WkbSize().
Implements OGRGeometry.