GDAL
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OGRGeometryCollection Class Reference

A collection of 1 or more geometry objects. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRGeometryCollection:
OGRGeometry OGRMultiCurve OGRMultiPoint OGRMultiSurface OGRMultiLineString OGRMultiPolygon

Public Types

typedef OGRGeometry ChildType
 Type of child elements.
 

Public Member Functions

 OGRGeometryCollection ()=default
 Create an empty geometry collection.
 
 OGRGeometryCollection (const OGRGeometryCollection &other)
 Copy constructor.
 
OGRGeometryCollectionoperator= (const OGRGeometryCollection &other)
 Assignment operator.
 
ChildType ** begin ()
 Return begin of sub-geometry iterator.
 
ChildType ** end ()
 Return end of sub-geometry iterator.
 
const ChildType *const * begin () const
 Return begin of sub-geometry iterator.
 
const ChildType *const * end () const
 Return end of sub-geometry iterator.
 
virtual const char * getGeometryName () const override
 Fetch WKT name for geometry type.
 
virtual OGRwkbGeometryType getGeometryType () const override
 Fetch geometry type.
 
virtual OGRGeometryCollectionclone () const override
 Make a copy of this object.
 
virtual void empty () override
 Clear geometry information.
 
virtual OGRErr transform (OGRCoordinateTransformation *poCT) override
 Apply arbitrary coordinate transformation to geometry.
 
virtual void flattenTo2D () override
 Convert geometry to strictly 2D.
 
virtual OGRBoolean IsEmpty () const override
 Returns TRUE (non-zero) if the object has no points.
 
virtual bool segmentize (double dfMaxLength) override
 Modify the geometry such it has no segment longer then the given distance.
 
virtual OGRBoolean hasCurveGeometry (int bLookForNonLinear=FALSE) const override
 Returns if this geometry is or has curve geometry.
 
virtual OGRGeometrygetCurveGeometry (const char *const *papszOptions=nullptr) const override
 Return curve version of this geometry.
 
virtual OGRGeometrygetLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=nullptr) const override
 Return, possibly approximate, non-curve version of this geometry.
 
virtual double get_GeodesicArea (const OGRSpatialReference *poSRSOverride=nullptr) const
 Compute area of geometry collection, considered as a surface on the underlying ellipsoid of the SRS attached to the geometry.
 
virtual double get_GeodesicLength (const OGRSpatialReference *poSRSOverride=nullptr) const
 Get the length of the collection,where curve edges are geodesic lines on the underlying ellipsoid of the SRS attached to the geometry.
 
virtual size_t WkbSize () const override
 Returns size of related binary representation.
 
virtual OGRErr importFromWkb (const unsigned char *, size_t, OGRwkbVariant, size_t &nBytesConsumedOut) override
 Assign geometry from well known binary data.
 
OGRErr exportToWkb (unsigned char *, const OGRwkbExportOptions *=nullptr) const override
 Convert a geometry into well known binary format.
 
OGRErr importFromWkt (const char **) override
 deprecated
 
virtual std::string exportToWkt (const OGRWktOptions &opts=OGRWktOptions(), OGRErr *err=nullptr) const override
 Export a geometry collection to WKT.
 
virtual double get_Length () const
 Compute the length of a multicurve.
 
virtual double get_Area () const
 Compute area of geometry collection.
 
virtual int getDimension () const override
 Get the dimension of this object.
 
virtual void getEnvelope (OGREnvelope *psEnvelope) const override
 Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure.
 
virtual void getEnvelope (OGREnvelope3D *psEnvelope) const override
 Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure.
 
int getNumGeometries () const
 Fetch number of geometries in container.
 
OGRGeometrygetGeometryRef (int)
 Fetch geometry from container.
 
const OGRGeometrygetGeometryRef (int) const
 Fetch geometry from container.
 
virtual OGRBoolean Equals (const OGRGeometry *) const override
 Returns TRUE if two geometries are equivalent.
 
virtual bool setCoordinateDimension (int nDimension) override
 Set the coordinate dimension.
 
virtual bool set3D (OGRBoolean bIs3D) override
 Add or remove the Z coordinate dimension.
 
virtual bool setMeasured (OGRBoolean bIsMeasured) override
 Add or remove the M coordinate dimension.
 
virtual OGRErr addGeometry (const OGRGeometry *)
 Add a geometry to the container.
 
virtual OGRErr addGeometryDirectly (OGRGeometry *)
 Add a geometry directly to the container.
 
OGRErr addGeometry (std::unique_ptr< OGRGeometry > geom)
 Add a geometry directly to the container.
 
virtual OGRErr removeGeometry (int iIndex, int bDelete=TRUE)
 Remove a geometry from the container.
 
std::unique_ptr< OGRGeometrystealGeometry (int iIndex)
 Remove a geometry from the container and return it to the caller.
 
bool hasEmptyParts () const override
 Returns whether a geometry has empty parts/rings.
 
void removeEmptyParts () override
 Remove empty parts/rings from this geometry.
 
virtual void assignSpatialReference (const OGRSpatialReference *poSR) override
 Assign spatial reference to this object.
 
void closeRings () override
 Force rings to be closed.
 
virtual void swapXY () override
 Swap x and y coordinates.
 
virtual void accept (IOGRGeometryVisitor *visitor) override
 Accept a visitor.
 
virtual void accept (IOGRConstGeometryVisitor *visitor) const override
 Accept a visitor.
 
virtual OGRErr importFromWkt (const char **ppszInput)=0
 Assign geometry from well known text data.
 
OGRErr importFromWkt (char **ppszInput)
 Deprecated.
 
OGRErr exportToWkt (char **ppszDstText, OGRwkbVariant=wkbVariantOldOgc) const
 Convert a geometry into well known text format.
 
virtual std::string exportToWkt (const OGRWktOptions &opts=OGRWktOptions(), OGRErr *err=nullptr) const=0
 Export a WKT geometry.
 
bool operator== (const OGRGeometry &other) const
 Returns if two geometries are equal.
 
bool operator!= (const OGRGeometry &other) const
 Returns if two geometries are different.
 
virtual int getCoordinateDimension () const
 Get the dimension of the coordinates in this object.
 
int CoordinateDimension () const
 Get the dimension of the coordinates in this object.
 
virtual OGRBoolean IsValid () const
 Test if the geometry is valid.
 
virtual OGRGeometryMakeValid (CSLConstList papszOptions=nullptr) const
 Attempts to make an invalid geometry valid without losing vertices.
 
virtual OGRGeometryNormalize () const
 Attempts to bring geometry into normalized/canonical form.
 
virtual OGRBoolean IsSimple () const
 Test if the geometry is simple.
 
OGRBoolean Is3D () const
 
OGRBoolean IsMeasured () const
 
virtual OGRBoolean IsRing () const
 Test if the geometry is a ring.
 
OGRErr importFromWkb (const GByte *, size_t=static_cast< size_t >(-1), OGRwkbVariant=wkbVariantOldOgc)
 Assign geometry from well known binary data.
 
OGRErr exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const
 Convert a geometry into well known binary format.
 
OGRwkbGeometryType getIsoGeometryType () const
 Get the geometry type that conforms with ISO SQL/MM Part3.
 
void dumpReadable (FILE *, const char *=nullptr, CSLConstList papszOptions=nullptr) const
 Dump geometry in well known text format to indicated output file.
 
std::string dumpReadable (const char *=nullptr, CSLConstList papszOptions=nullptr) const
 Dump geometry in well known text format to indicated output file.
 
virtual char * exportToGML (const char *const *papszOptions=nullptr) const
 Convert a geometry into GML format.
 
virtual char * exportToKML () const
 Convert a geometry into KML format.
 
virtual char * exportToJson (CSLConstList papszOptions=nullptr) const
 Convert a geometry into GeoJSON format.
 
GEOSGeom exportToGEOS (GEOSContextHandle_t hGEOSCtxt, bool bRemoveEmptyParts=false) const
 Returns a GEOSGeom object corresponding to the geometry.
 
void roundCoordinates (const OGRGeomCoordinatePrecision &sPrecision)
 Round coordinates of the geometry to the specified precision.
 
void roundCoordinatesIEEE754 (const OGRGeomCoordinateBinaryPrecision &options)
 Round coordinates of a geometry, exploiting characteristics of the IEEE-754 double-precision binary representation.
 
const OGRSpatialReferencegetSpatialReference (void) const
 Returns spatial reference system for object.
 
OGRErr transformTo (const OGRSpatialReference *poSR)
 Transform geometry to new spatial reference system.
 
virtual OGRBoolean Intersects (const OGRGeometry *) const
 Do these features intersect?
 
virtual OGRBoolean Disjoint (const OGRGeometry *) const
 Test for disjointness.
 
virtual OGRBoolean Touches (const OGRGeometry *) const
 Test for touching.
 
virtual OGRBoolean Crosses (const OGRGeometry *) const
 Test for crossing.
 
virtual OGRBoolean Within (const OGRGeometry *) const
 Test for containment.
 
virtual OGRBoolean Contains (const OGRGeometry *) const
 Test for containment.
 
virtual OGRBoolean Overlaps (const OGRGeometry *) const
 Test for overlap.
 
virtual OGRGeometryBoundary () const
 Compute boundary.
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries.
 
virtual OGRGeometryConvexHull () const
 Compute convex hull.
 
virtual OGRGeometryConcaveHull (double dfRatio, bool bAllowHoles) const
 Compute "concave hull" of a geometry.
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const
 Compute buffer of geometry.
 
virtual OGRGeometryBufferEx (double dfDistance, CSLConstList papszOptions) const
 Compute buffer of geometry.
 
virtual OGRGeometryIntersection (const OGRGeometry *) const
 Compute intersection.
 
virtual OGRGeometryUnion (const OGRGeometry *) const
 Compute union.
 
virtual OGRGeometryUnionCascaded () const
 Compute union using cascading.
 
OGRGeometryUnaryUnion () const
 Returns the union of all components of a single geometry.
 
virtual OGRGeometryDifference (const OGRGeometry *) const
 Compute difference.
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const
 Compute symmetric difference.
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid.
 
virtual OGRGeometrySimplify (double dTolerance) const
 Simplify the geometry.
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const
 Simplify the geometry while preserving topology.
 
virtual OGRGeometryDelaunayTriangulation (double dfTolerance, int bOnlyEdges) const
 Return a Delaunay triangulation of the vertices of the geometry.
 
virtual OGRGeometryPolygonize () const
 Polygonizes a set of sparse edges.
 
virtual double Distance3D (const OGRGeometry *poOtherGeom) const
 Returns the 3D distance between two geometries.
 
OGRGeometrySetPrecision (double dfGridSize, int nFlags) const
 Set the geometry's precision, rounding all its coordinates to the precision grid, and making sure the geometry is still valid.
 
bool IsRectangle () const
 Returns whether the geometry is a polygon with 4 corners forming a rectangle.
 
OGRPointtoPoint ()
 Down-cast to OGRPoint*.
 
const OGRPointtoPoint () const
 Down-cast to OGRPoint*.
 
OGRCurvetoCurve ()
 Down-cast to OGRCurve*.
 
const OGRCurvetoCurve () const
 Down-cast to OGRCurve*.
 
OGRSimpleCurvetoSimpleCurve ()
 Down-cast to OGRSimpleCurve*.
 
const OGRSimpleCurvetoSimpleCurve () const
 Down-cast to OGRSimpleCurve*.
 
OGRLineStringtoLineString ()
 Down-cast to OGRLineString*.
 
const OGRLineStringtoLineString () const
 Down-cast to OGRLineString*.
 
OGRLinearRingtoLinearRing ()
 Down-cast to OGRLinearRing*.
 
const OGRLinearRingtoLinearRing () const
 Down-cast to OGRLinearRing*.
 
OGRCircularStringtoCircularString ()
 Down-cast to OGRCircularString*.
 
const OGRCircularStringtoCircularString () const
 Down-cast to OGRCircularString*.
 
OGRCompoundCurvetoCompoundCurve ()
 Down-cast to OGRCompoundCurve*.
 
const OGRCompoundCurvetoCompoundCurve () const
 Down-cast to OGRCompoundCurve*.
 
OGRSurfacetoSurface ()
 Down-cast to OGRSurface*.
 
const OGRSurfacetoSurface () const
 Down-cast to OGRSurface*.
 
OGRPolygontoPolygon ()
 Down-cast to OGRPolygon*.
 
const OGRPolygontoPolygon () const
 Down-cast to OGRPolygon*.
 
OGRTriangletoTriangle ()
 Down-cast to OGRTriangle*.
 
const OGRTriangletoTriangle () const
 Down-cast to OGRTriangle*.
 
OGRCurvePolygontoCurvePolygon ()
 Down-cast to OGRCurvePolygon*.
 
const OGRCurvePolygontoCurvePolygon () const
 Down-cast to OGRCurvePolygon*.
 
OGRGeometryCollectiontoGeometryCollection ()
 Down-cast to OGRGeometryCollection*.
 
const OGRGeometryCollectiontoGeometryCollection () const
 Down-cast to OGRGeometryCollection*.
 
OGRMultiPointtoMultiPoint ()
 Down-cast to OGRMultiPoint*.
 
const OGRMultiPointtoMultiPoint () const
 Down-cast to OGRMultiPoint*.
 
OGRMultiLineStringtoMultiLineString ()
 Down-cast to OGRMultiLineString*.
 
const OGRMultiLineStringtoMultiLineString () const
 Down-cast to OGRMultiLineString*.
 
OGRMultiPolygontoMultiPolygon ()
 Down-cast to OGRMultiPolygon*.
 
const OGRMultiPolygontoMultiPolygon () const
 Down-cast to OGRMultiPolygon*.
 
OGRMultiCurvetoMultiCurve ()
 Down-cast to OGRMultiCurve*.
 
const OGRMultiCurvetoMultiCurve () const
 Down-cast to OGRMultiCurve*.
 
OGRMultiSurfacetoMultiSurface ()
 Down-cast to OGRMultiSurface*.
 
const OGRMultiSurfacetoMultiSurface () const
 Down-cast to OGRMultiSurface*.
 
OGRPolyhedralSurfacetoPolyhedralSurface ()
 Down-cast to OGRPolyhedralSurface*.
 
const OGRPolyhedralSurfacetoPolyhedralSurface () const
 Down-cast to OGRPolyhedralSurface*.
 
OGRTriangulatedSurfacetoTriangulatedSurface ()
 Down-cast to OGRTriangulatedSurface*.
 
const OGRTriangulatedSurfacetoTriangulatedSurface () const
 Down-cast to OGRTriangulatedSurface*.
 

Static Public Member Functions

static OGRGeometryCollectionCastToGeometryCollection (OGRGeometryCollection *poSrc)
 Cast to geometry collection.
 
static GEOSContextHandle_t createGEOSContext ()
 Create a new GEOS context.
 
static void freeGEOSContext (GEOSContextHandle_t hGEOSCtxt)
 Destroy a GEOS context.
 
static OGRGeometryH ToHandle (OGRGeometry *poGeom)
 Convert a OGRGeometry* to a OGRGeometryH.
 
static OGRGeometryFromHandle (OGRGeometryH hGeom)
 Convert a OGRGeometryH to a OGRGeometry*.
 

Protected Member Functions

virtual OGRBoolean isCompatibleSubType (OGRwkbGeometryType) const
 Returns whether a geometry of the specified geometry type can be a member of this collection.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ OGRGeometryCollection()

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.

Since
GDAL 2.1

Member Function Documentation

◆ accept() [1/2]

virtual void OGRGeometryCollection::accept ( IOGRConstGeometryVisitor visitor) const
inlineoverridevirtual

Accept a visitor.

Implements OGRGeometry.

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

◆ accept() [2/2]

virtual void OGRGeometryCollection::accept ( IOGRGeometryVisitor visitor)
inlineoverridevirtual

Accept a visitor.

Implements OGRGeometry.

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

◆ addGeometry() [1/2]

OGRErr OGRGeometryCollection::addGeometry ( const OGRGeometry poNewGeom)
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().

Parameters
poNewGeomgeometry to add to the container.
Returns
OGRERR_NONE if successful, or OGRERR_UNSUPPORTED_GEOMETRY_TYPE if the geometry type is illegal for the type of geometry container.

◆ addGeometry() [2/2]

OGRErr OGRGeometryCollection::addGeometry ( std::unique_ptr< OGRGeometry geom)

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.

There is no SFCOM analog to this method.

Parameters
geomgeometry to add to the container.
Returns
OGRERR_NONE if successful, or OGRERR_UNSUPPORTED_GEOMETRY_TYPE if the geometry type is illegal for the type of geometry container.

◆ addGeometryDirectly()

OGRErr OGRGeometryCollection::addGeometryDirectly ( OGRGeometry poNewGeom)
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, but only if the method is successful. If the method fails, ownership still belongs to the caller.

This method is the same as the C function OGR_G_AddGeometryDirectly().

There is no SFCOM analog to this method.

Parameters
poNewGeomgeometry to add to the container.
Returns
OGRERR_NONE if successful, or OGRERR_UNSUPPORTED_GEOMETRY_TYPE if the geometry type is illegal for the type of geometry container.

◆ assignSpatialReference()

void OGRGeometryCollection::assignSpatialReference ( const OGRSpatialReference poSR)
overridevirtual

Assign spatial reference to this object.

Any existing spatial reference is replaced, but under no circumstances does this result in the object being reprojected. It is just changing the interpretation of the existing geometry. Note that assigning a spatial reference increments the reference count on the OGRSpatialReference, but does not copy it.

Starting with GDAL 2.3, this will also assign the spatial reference to potential sub-geometries of the geometry (OGRGeometryCollection, OGRCurvePolygon/OGRPolygon, OGRCompoundCurve, OGRPolyhedralSurface and their derived classes).

This is similar to the SFCOM IGeometry::put_SpatialReference() method.

This method is the same as the C function OGR_G_AssignSpatialReference().

Parameters
poSRnew spatial reference system to apply.

Reimplemented from OGRGeometry.

◆ begin() [1/2]

ChildType ** OGRGeometryCollection::begin ( )
inline

Return begin of sub-geometry iterator.

Since
GDAL 2.3

◆ begin() [2/2]

const ChildType *const * OGRGeometryCollection::begin ( ) const
inline

Return begin of sub-geometry iterator.

Since
GDAL 2.3

◆ Boundary()

OGRGeometry * OGRGeometry::Boundary ( ) const
virtualinherited

Compute boundary.

A new geometry object is created and returned containing the boundary of the geometry on which the method is invoked.

This method is the same as the C function OGR_G_Boundary().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 1.8.0

◆ Buffer()

OGRGeometry * OGRGeometry::Buffer ( double  dfDist,
int  nQuadSegs = 30 
) const
virtualinherited

Compute buffer of geometry.

Builds a new geometry containing the buffer region around the geometry on which it is invoked. The buffer is a polygon containing the region within the buffer distance of the original geometry.

Some buffer sections are properly described as curves, but are converted to approximate polygons. The nQuadSegs parameter can be used to control how many segments should be used to define a 90 degree curve - a quadrant of a circle. A value of 30 is a reasonable default. Large values result in large numbers of vertices in the resulting buffer geometry while small numbers reduce the accuracy of the result.

This method is the same as the C function OGR_G_Buffer().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
dfDistthe buffer distance to be applied. Should be expressed into the same unit as the coordinates of the geometry.
nQuadSegsthe number of segments used to approximate a 90 degree (quadrant) of curvature.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.

◆ BufferEx()

OGRGeometry * OGRGeometry::BufferEx ( double  dfDist,
CSLConstList  papszOptions 
) const
virtualinherited

Compute buffer of geometry.

Builds a new geometry containing the buffer region around the geometry on which it is invoked. The buffer is a polygon containing the region within the buffer distance of the original geometry.

This function is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

The following options are supported. See the GEOS library for more detailed descriptions.

  • ENDCAP_STYLE=ROUND/FLAT/SQUARE
  • JOIN_STYLE=ROUND/MITRE/BEVEL
  • MITRE_LIMIT=double
  • QUADRANT_SEGMENTS=double
  • SINGLE_SIDED=YES/NO

This function is the same as the C function OGR_G_BufferEx().

Parameters
dfDistthe buffer distance to be applied. Should be expressed into the same unit as the coordinates of the geometry.
papszOptionsNULL terminated list of options (may be NULL)
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.10

◆ CastToGeometryCollection()

OGRGeometryCollection * OGRGeometryCollection::CastToGeometryCollection ( OGRGeometryCollection poSrc)
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).

Parameters
poSrcthe input geometry - ownership is passed to the method.
Returns
new geometry.
Since
GDAL 2.2

◆ Centroid()

OGRErr OGRGeometry::Centroid ( OGRPoint poPoint) const
virtualinherited

Compute the geometry centroid.

The centroid location is applied to the passed in OGRPoint object. The centroid is not necessarily within the geometry.

This method relates to the SFCOM ISurface::get_Centroid() method however the current implementation based on GEOS can operate on other geometry types such as multipoint, linestring, geometrycollection such as multipolygons. OGC SF SQL 1.1 defines the operation for surfaces (polygons). SQL/MM-Part 3 defines the operation for surfaces and multisurfaces (multipolygons).

This function is the same as the C function OGR_G_Centroid().

This function is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Returns
OGRERR_NONE on success or OGRERR_FAILURE on error.
Since
OGR 1.8.0 as a OGRGeometry method (previously was restricted to OGRPolygon)

◆ clone()

OGRGeometryCollection * OGRGeometryCollection::clone ( ) const
overridevirtual

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().

Returns
a new object instance with the same geometry, and spatial reference system as the original.

Implements OGRGeometry.

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

◆ closeRings()

void OGRGeometryCollection::closeRings ( )
overridevirtual

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.

◆ ConcaveHull()

OGRGeometry * OGRGeometry::ConcaveHull ( double  dfRatio,
bool  bAllowHoles 
) const
virtualinherited

Compute "concave hull" of a geometry.

The concave hull is fully contained within the convex hull and also contains all the points of the input, but in a smaller area. The area ratio is the ratio of the area of the convex hull and the concave hull. Frequently used to convert a multi-point into a polygonal area. that contains all the points in the input Geometry.

A new geometry object is created and returned containing the concave hull of the geometry on which the method is invoked.

This method is the same as the C function OGR_G_ConcaveHull().

This method is built on the GEOS >= 3.11 library If OGR is built without the GEOS >= 3.11 librray, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
dfRatioRatio of the area of the convex hull and the concave hull.
bAllowHolesWhether holes are allowed.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.6

◆ Contains()

OGRBoolean OGRGeometry::Contains ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for containment.

Tests if actual geometry object contains the passed geometry.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Contains().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if poOtherGeom contains this geometry, otherwise FALSE.

Reimplemented in OGRCurvePolygon.

◆ ConvexHull()

OGRGeometry * OGRGeometry::ConvexHull ( ) const
virtualinherited

Compute convex hull.

A new geometry object is created and returned containing the convex hull of the geometry on which the method is invoked.

This method is the same as the C function OGR_G_ConvexHull().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.

◆ CoordinateDimension()

int OGRGeometry::CoordinateDimension ( ) const
inherited

Get the dimension of the coordinates in this object.

This method is the same as the C function OGR_G_CoordinateDimension().

Returns
this will return 2 for XY, 3 for XYZ and XYM, and 4 for XYZM data.
Since
GDAL 2.1

◆ createGEOSContext()

GEOSContextHandle_t OGRGeometry::createGEOSContext ( )
staticinherited

Create a new GEOS context.

Returns
a new GEOS context (to be freed with freeGEOSContext())

◆ Crosses()

OGRBoolean OGRGeometry::Crosses ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for crossing.

Tests if this geometry and the other passed into the method are crossing.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Crosses().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if they are crossing, otherwise FALSE.

◆ DelaunayTriangulation()

OGRGeometry * OGRGeometry::DelaunayTriangulation ( double  dfTolerance,
int  bOnlyEdges 
) const
virtualinherited

Return a Delaunay triangulation of the vertices of the geometry.

This function is the same as the C function OGR_G_DelaunayTriangulation().

This function is built on the GEOS library, v3.4 or above. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Parameters
dfToleranceoptional snapping tolerance to use for improved robustness
bOnlyEdgesif TRUE, will return a MULTILINESTRING, otherwise it will return a GEOMETRYCOLLECTION containing triangular POLYGONs.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 2.1

◆ Difference()

OGRGeometry * OGRGeometry::Difference ( const OGRGeometry poOtherGeom) const
virtualinherited

Compute difference.

Generates a new geometry which is the region of this geometry with the region of the second geometry removed.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Difference().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe other geometry removed from "this" geometry.
Returns
a new geometry to be freed by the caller, or NULL if the difference is empty or if an error occurs.

◆ Disjoint()

OGRBoolean OGRGeometry::Disjoint ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for disjointness.

Tests if this geometry and the other passed into the method are disjoint.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Disjoint().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if they are disjoint, otherwise FALSE.

◆ Distance()

double OGRGeometry::Distance ( const OGRGeometry poOtherGeom) const
virtualinherited

Compute distance between two geometries.

Returns the shortest distance between the two geometries. The distance is expressed into the same unit as the coordinates of the geometries.

This method is the same as the C function OGR_G_Distance().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe other geometry to compare against.
Returns
the distance between the geometries or -1 if an error occurs.

◆ Distance3D()

double OGRGeometry::Distance3D ( const OGRGeometry poOtherGeom) const
virtualinherited

Returns the 3D distance between two geometries.

The distance is expressed into the same unit as the coordinates of the geometries.

This method is built on the SFCGAL library, check it for the definition of the geometry operation. If OGR is built without the SFCGAL library, this method will always return -1.0

This function is the same as the C function OGR_G_Distance3D().

Returns
distance between the two geometries
Since
GDAL 2.2

◆ dumpReadable() [1/2]

std::string OGRGeometry::dumpReadable ( const char *  pszPrefix = nullptr,
CSLConstList  papszOptions = nullptr 
) const
inherited

Dump geometry in well known text format to indicated output file.

A few options can be defined to change the default dump :

  • DISPLAY_GEOMETRY=NO : to hide the dump of the geometry
  • DISPLAY_GEOMETRY=WKT or YES (default) : dump the geometry as a WKT
  • DISPLAY_GEOMETRY=SUMMARY : to get only a summary of the geometry
  • XY_COORD_PRECISION=integer: number of decimal figures for X,Y coordinates in WKT (added in GDAL 3.9)
  • Z_COORD_PRECISION=integer: number of decimal figures for Z coordinates in WKT (added in GDAL 3.9)
Parameters
pszPrefixthe prefix to put on each line of output.
papszOptionsNULL terminated list of options (may be NULL)
Returns
a string with the geometry representation.
Since
GDAL 3.7

◆ dumpReadable() [2/2]

void OGRGeometry::dumpReadable ( FILE *  fp,
const char *  pszPrefix = nullptr,
CSLConstList  papszOptions = nullptr 
) const
inherited

Dump geometry in well known text format to indicated output file.

A few options can be defined to change the default dump :

  • DISPLAY_GEOMETRY=NO : to hide the dump of the geometry
  • DISPLAY_GEOMETRY=WKT or YES (default) : dump the geometry as a WKT
  • DISPLAY_GEOMETRY=SUMMARY : to get only a summary of the geometry

This method is the same as the C function OGR_G_DumpReadable().

Parameters
fpthe text file to write the geometry to.
pszPrefixthe prefix to put on each line of output.
papszOptionsNULL terminated list of options (may be NULL)

◆ empty()

void OGRGeometryCollection::empty ( )
overridevirtual

Clear geometry information.

This restores the geometry to its 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.

◆ Equals()

OGRBoolean OGRGeometryCollection::Equals ( const OGRGeometry ) const
overridevirtual

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 sub-geometries 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().

Returns
TRUE if equivalent or FALSE otherwise.

Implements OGRGeometry.

◆ exportToGEOS()

GEOSGeom OGRGeometry::exportToGEOS ( GEOSContextHandle_t  hGEOSCtxt,
bool  bRemoveEmptyParts = false 
) const
inherited

Returns a GEOSGeom object corresponding to the geometry.

Parameters
hGEOSCtxtGEOS context
bRemoveEmptyPartsWhether empty parts of the geometry should be removed before exporting to GEOS (GDAL >= 3.10)
Returns
a GEOSGeom object corresponding to the geometry (to be freed with GEOSGeom_destroy_r()), or NULL in case of error

◆ exportToGML()

char * OGRGeometry::exportToGML ( const char *const *  papszOptions = nullptr) const
virtualinherited

Convert a geometry into GML format.

The GML geometry is expressed directly in terms of GML basic data types assuming the this is available in the gml namespace. The returned string should be freed with CPLFree() when no longer required.

The supported options are :

  • FORMAT=GML2/GML3/GML32 (GML2 or GML32 added in GDAL 2.1). If not set, it will default to GML 2.1.2 output.
  • GML3_LINESTRING_ELEMENT=curve. (Only valid for FORMAT=GML3) To use gml:Curve element for linestrings. Otherwise gml:LineString will be used .
  • GML3_LONGSRS=YES/NO. (Only valid for FORMAT=GML3, deprecated by SRSNAME_FORMAT in GDAL >=2.2). Defaults to YES. If YES, SRS with EPSG authority will be written with the "urn:ogc:def:crs:EPSG::" prefix. In the case the SRS should be treated as lat/long or northing/easting, then the function will take care of coordinate order swapping if the data axis to CRS axis mapping indicates it. If set to NO, SRS with EPSG authority will be written with the "EPSG:" prefix, even if they are in lat/long order.
  • SRSNAME_FORMAT=SHORT/OGC_URN/OGC_URL (Only valid for FORMAT=GML3, added in GDAL 2.2). Defaults to OGC_URN. If SHORT, then srsName will be in the form AUTHORITY_NAME:AUTHORITY_CODE. If OGC_URN, then srsName will be in the form urn:ogc:def:crs:AUTHORITY_NAME::AUTHORITY_CODE. If OGC_URL, then srsName will be in the form http://www.opengis.net/def/crs/AUTHORITY_NAME/0/AUTHORITY_CODE. For OGC_URN and OGC_URL, in the case the SRS should be treated as lat/long or northing/easting, then the function will take care of coordinate order swapping if the data axis to CRS axis mapping indicates it.
  • GMLID=astring. If specified, a gml:id attribute will be written in the top-level geometry element with the provided value. Required for GML 3.2 compatibility.
  • SRSDIMENSION_LOC=POSLIST/GEOMETRY/GEOMETRY,POSLIST. (Only valid for FORMAT=GML3/GML32, GDAL >= 2.0) Default to POSLIST. For 2.5D geometries, define the location where to attach the srsDimension attribute. There are diverging implementations. Some put in on the <gml:posList> element, other on the top geometry element.
  • NAMESPACE_DECL=YES/NO. If set to YES, xmlns:gml="http://www.opengis.net/gml" will be added to the root node for GML < 3.2 or xmlns:gml="http://www.opengis.net/gml/3.2" for GML 3.2
  • XY_COORD_RESOLUTION=double (added in GDAL 3.9): Resolution for the coordinate precision of the X and Y coordinates. Expressed in the units of the X and Y axis of the SRS. eg 1e-5 for up to 5 decimal digits. 0 for the default behavior.
  • Z_COORD_RESOLUTION=double (added in GDAL 3.9): Resolution for the coordinate precision of the Z coordinates. Expressed in the units of the Z axis of the SRS. 0 for the default behavior.

This method is the same as the C function OGR_G_ExportToGMLEx().

Parameters
papszOptionsNULL-terminated list of options.
Returns
A GML fragment to be freed with CPLFree() or NULL in case of error.

◆ exportToJson()

char * OGRGeometry::exportToJson ( CSLConstList  papszOptions = nullptr) const
virtualinherited

Convert a geometry into GeoJSON format.

The returned string should be freed with CPLFree() when no longer required.

The following options are supported :

  • XY_COORD_PRECISION=integer: number of decimal figures for X,Y coordinates (added in GDAL 3.9)
  • Z_COORD_PRECISION=integer: number of decimal figures for Z coordinates (added in GDAL 3.9)

This method is the same as the C function OGR_G_ExportToJson().

Parameters
papszOptionsNull terminated list of options, or null (added in 3.9)
Returns
A GeoJSON fragment to be freed with CPLFree() or NULL in case of error.

◆ exportToKML()

char * OGRGeometry::exportToKML ( ) const
virtualinherited

Convert a geometry into KML format.

The returned string should be freed with CPLFree() when no longer required.

This method is the same as the C function OGR_G_ExportToKML().

Returns
A KML fragment to be freed with CPLFree() or NULL in case of error.

◆ exportToWkb() [1/2]

OGRErr OGRGeometry::exportToWkb ( OGRwkbByteOrder  eByteOrder,
unsigned char *  pabyData,
OGRwkbVariant  eWkbVariant = wkbVariantOldOgc 
) const
inherited

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.

Parameters
eByteOrderOne of wkbXDR or wkbNDR indicating MSB or LSB byte order respectively.
pabyDataa buffer into which the binary representation is written. This buffer must be at least OGRGeometry::WkbSize() byte in size.
eWkbVariantWhat 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.
Returns
Currently OGRERR_NONE is always returned.

◆ exportToWkb() [2/2]

OGRErr OGRGeometryCollection::exportToWkb ( unsigned char *  pabyDstBuffer,
const OGRwkbExportOptions psOptions = nullptr 
) const
overridevirtual

Convert a geometry into well known binary format.

This function relates to the SFCOM IWks::ExportToWKB() method.

This function is the same as the C function OGR_G_ExportToWkbEx().

Parameters
pabyDstBuffera buffer into which the binary representation is written. This buffer must be at least OGR_G_WkbSize() byte in size.
psOptionsWKB export options.
Returns
Currently OGRERR_NONE is always returned.
Since
GDAL 3.9

Implements OGRGeometry.

◆ exportToWkt() [1/3]

OGRErr OGRGeometry::exportToWkt ( char **  ppszDstText,
OGRwkbVariant  variant = wkbVariantOldOgc 
) const

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().

Parameters
ppszDstTexta text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with CPLFree().
variantthe specification that must be conformed too :
  • wkbVariantOgc for old-style 99-402 extended dimension (Z) WKB types
  • wkbVariantIso for SFSQL 1.2 and ISO SQL/MM Part 3
Returns
Currently OGRERR_NONE is always returned.

◆ exportToWkt() [2/3]

std::string OGRGeometryCollection::exportToWkt ( const OGRWktOptions opts = OGRWktOptions(),
OGRErr err = nullptr 
) const
overridevirtual

Export a geometry collection to WKT.

Parameters
optsOutput options.
errPointer to error code, if desired.
Returns
WKT representation of the geometry collection.

Implements OGRGeometry.

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

◆ exportToWkt() [3/3]

virtual std::string OGRGeometry::exportToWkt ( const OGRWktOptions opts = OGRWktOptions(),
OGRErr err = nullptr 
) const
virtual

Export a WKT geometry.

Parameters
optsOutput options.
errPointer to error code, if desired.
Returns
WKT string representing this geometry.

Implements OGRGeometry.

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

◆ flattenTo2D()

void OGRGeometryCollection::flattenTo2D ( )
overridevirtual

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.

◆ freeGEOSContext()

void OGRGeometry::freeGEOSContext ( GEOSContextHandle_t  hGEOSCtxt)
staticinherited

Destroy a GEOS context.

Parameters
hGEOSCtxtGEOS context

◆ FromHandle()

static OGRGeometry * OGRGeometry::FromHandle ( OGRGeometryH  hGeom)
inlinestaticinherited

Convert a OGRGeometryH to a OGRGeometry*.

Since
GDAL 2.3

◆ get_Area()

double OGRGeometryCollection::get_Area ( ) const
virtual

Compute area of geometry collection.

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

Note
No warning will be issued if a member of the collection does not support the get_Area method.
Returns
computed area.

◆ get_GeodesicArea()

double OGRGeometryCollection::get_GeodesicArea ( const OGRSpatialReference poSRSOverride = nullptr) const
virtual

Compute area of geometry collection, considered as a surface on the underlying ellipsoid of the SRS attached to the geometry.

The returned area will always be in square meters, and assumes that polygon edges describe geodesic lines on the ellipsoid.

Geodesics follow the shortest route on the surface of the ellipsoid.

If the geometry' SRS is not a geographic one, geometries are reprojected to the underlying geographic SRS of the geometry' SRS. OGRSpatialReference::GetDataAxisToSRSAxisMapping() is honored.

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

Note
No warning will be issued if a member of the collection does not support the get_GeodesicArea method.
Parameters
poSRSOverrideIf not null, overrides OGRGeometry::getSpatialReference()
Returns
the area of the geometry in square meters, or a negative value in case of error.
See also
get_Area() for an alternative method returning areas computed in 2D Cartesian space.
Since
GDAL 3.9

◆ get_GeodesicLength()

double OGRGeometryCollection::get_GeodesicLength ( const OGRSpatialReference poSRSOverride = nullptr) const
virtual

Get the length of the collection,where curve edges are geodesic lines on the underlying ellipsoid of the SRS attached to the geometry.

The returned length will always be in meters.

Geodesics follow the shortest route on the surface of the ellipsoid.

If the geometry' SRS is not a geographic one, geometries are reprojected to the underlying geographic SRS of the geometry' SRS. OGRSpatialReference::GetDataAxisToSRSAxisMapping() is honored.

Note that geometries with circular arcs will be linearized in their original coordinate space first, so the resulting geodesic length will be an approximation.

The length is computed as the sum of the lengths of all members in this collection.

Note
No warning will be issued if a member of the collection does not support the get_GeodesicLength method.
Parameters
poSRSOverrideIf not null, overrides OGRGeometry::getSpatialReference()
Returns
the length of the geometry in meters, or a negative value in case of error.
See also
get_Length() for an alternative method returning areas computed in 2D Cartesian space.
Since
GDAL 3.10

◆ get_Length()

double OGRGeometryCollection::get_Length ( ) const
virtual

Compute the length of a multicurve.

The length is computed as the sum of the length of all members in this collection.

Note
No warning will be issued if a member of the collection does not support the get_Length method.
Returns
computed length.

◆ getCoordinateDimension()

int OGRGeometry::getCoordinateDimension ( ) const
virtualinherited

Get the dimension of the coordinates in this object.

This method is the same as the C function OGR_G_GetCoordinateDimension().

Deprecated:
use CoordinateDimension().
Returns
this will return 2 or 3.

◆ getCurveGeometry()

OGRGeometry * OGRGeometryCollection::getCurveGeometry ( const char *const *  papszOptions = nullptr) const
overridevirtual

Return curve version of this geometry.

Returns a geometry that has possibly CIRCULARSTRING, COMPOUNDCURVE, CURVEPOLYGON, MULTICURVE or MULTISURFACE in it, by de-approximating 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().

Parameters
papszOptionsoptions as a null-terminated list of strings. Unused for now. Must be set to NULL.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 2.0

Reimplemented from OGRGeometry.

◆ getDimension()

int OGRGeometryCollection::getDimension ( ) const
overridevirtual

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().

Returns
0 for points, 1 for lines and 2 for surfaces.

Implements OGRGeometry.

Reimplemented in OGRMultiSurface, OGRMultiPoint, and OGRMultiCurve.

◆ getEnvelope() [1/2]

void OGRGeometryCollection::getEnvelope ( OGREnvelope psEnvelope) const
overridevirtual

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().

Parameters
psEnvelopethe structure in which to place the results.

Implements OGRGeometry.

◆ getEnvelope() [2/2]

void OGRGeometryCollection::getEnvelope ( OGREnvelope3D psEnvelope) const
overridevirtual

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().

Parameters
psEnvelopethe structure in which to place the results.
Since
OGR 1.9.0

Implements OGRGeometry.

◆ getGeometryName()

const char * OGRGeometryCollection::getGeometryName ( ) const
overridevirtual

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().

Returns
name used for this geometry type in well known text format. The returned pointer is to a static internal string and should not be modified or freed.

Implements OGRGeometry.

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

◆ getGeometryRef() [1/2]

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.

Parameters
ithe index of the geometry to fetch, between 0 and getNumGeometries() - 1.
Returns
pointer to requested geometry.

◆ getGeometryRef() [2/2]

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.

Parameters
ithe index of the geometry to fetch, between 0 and getNumGeometries() - 1.
Returns
pointer to requested geometry.

◆ getGeometryType()

OGRwkbGeometryType OGRGeometryCollection::getGeometryType ( ) const
overridevirtual

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().

Returns
the geometry type code.

Implements OGRGeometry.

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

◆ getIsoGeometryType()

OGRwkbGeometryType OGRGeometry::getIsoGeometryType ( ) const
inherited

Get the geometry type that conforms with ISO SQL/MM Part3.

Returns
the geometry type that conforms with ISO SQL/MM Part3

◆ getLinearGeometry()

OGRGeometry * OGRGeometryCollection::getLinearGeometry ( double  dfMaxAngleStepSizeDegrees = 0,
const char *const *  papszOptions = nullptr 
) const
overridevirtual

Return, possibly approximate, non-curve 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().

Parameters
dfMaxAngleStepSizeDegreesthe largest step in degrees along the arc, zero to use the default setting.
papszOptionsoptions as a null-terminated list of strings. See OGRGeometryFactory::curveToLineString() for valid options.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 2.0

Reimplemented from OGRGeometry.

◆ getNumGeometries()

int OGRGeometryCollection::getNumGeometries ( ) const

Fetch number of geometries in container.

This method relates to the SFCOM IGeometryCollect::get_NumGeometries() method.

Returns
count of children geometries. May be zero.

◆ getSpatialReference()

OGRSpatialReference * OGRGeometry::getSpatialReference ( void  ) const
inlineinherited

Returns spatial reference system for object.

This method relates to the SFCOM IGeometry::get_SpatialReference() method.

This method is the same as the C function OGR_G_GetSpatialReference().

Returns
a reference to the spatial reference object. The object may be shared with many geometry objects, and should not be modified.

◆ hasCurveGeometry()

OGRBoolean OGRGeometryCollection::hasCurveGeometry ( int  bLookForNonLinear = FALSE) const
overridevirtual

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 non-linear 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 "loss-less" conversion.

This method is the same as the C function OGR_G_HasCurveGeometry().

Parameters
bLookForNonLinearset it to TRUE to check if the geometry is or contains a CIRCULARSTRING.
Returns
TRUE if this geometry is or has curve geometry.
Since
GDAL 2.0

Reimplemented from OGRGeometry.

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

◆ hasEmptyParts()

bool OGRGeometryCollection::hasEmptyParts ( ) const
overridevirtual

Returns whether a geometry has empty parts/rings.

Returns true if removeEmptyParts() will modify the geometry.

This is different from IsEmpty().

Since
GDAL 3.10

Reimplemented from OGRGeometry.

◆ importFromWkb() [1/2]

OGRErr OGRGeometry::importFromWkb ( const GByte pabyData,
size_t  nSize = static_cast<size_t>(-1),
OGRwkbVariant  eWkbVariant = wkbVariantOldOgc 
)
inherited

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().

Parameters
pabyDatathe binary input data.
nSizethe size of pabyData in bytes, or -1 if not known.
eWkbVariantif wkbVariantPostGIS1, special interpretation is done for curve geometries code
Returns
OGRERR_NONE if all goes well, otherwise any of OGRERR_NOT_ENOUGH_DATA, OGRERR_UNSUPPORTED_GEOMETRY_TYPE, or OGRERR_CORRUPT_DATA may be returned.

◆ importFromWkb() [2/2]

OGRErr OGRGeometryCollection::importFromWkb ( const unsigned char *  pabyData,
size_t  nSize,
OGRwkbVariant  eWkbVariant,
size_t &  nBytesConsumedOut 
)
overridevirtual

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().

Parameters
pabyDatathe binary input data.
nSizethe size of pabyData in bytes, or -1 if not known.
eWkbVariantif wkbVariantPostGIS1, special interpretation is done for curve geometries code
nBytesConsumedOutoutput parameter. Number of bytes consumed.
Returns
OGRERR_NONE if all goes well, otherwise any of OGRERR_NOT_ENOUGH_DATA, OGRERR_UNSUPPORTED_GEOMETRY_TYPE, or OGRERR_CORRUPT_DATA may be returned.
Since
GDAL 2.3

Implements OGRGeometry.

Reimplemented in OGRMultiPolygon, and OGRMultiLineString.

◆ importFromWkt() [1/3]

OGRErr OGRGeometry::importFromWkt ( char **  ppszInput)
inline

Deprecated.

Deprecated:
in GDAL 2.3

◆ importFromWkt() [2/3]

OGRErr OGRGeometryCollection::importFromWkt ( const char **  ppszInput)
overridevirtual

◆ importFromWkt() [3/3]

OGRErr OGRGeometry::importFromWkt ( const char **  ppszInput)
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().

Parameters
ppszInputpointer to a pointer to the source text. The pointer is updated to pointer after the consumed text.
Returns
OGRERR_NONE if all goes well, otherwise any of OGRERR_NOT_ENOUGH_DATA, OGRERR_UNSUPPORTED_GEOMETRY_TYPE, or OGRERR_CORRUPT_DATA may be returned.

Implements OGRGeometry.

Reimplemented in OGRMultiSurface, OGRMultiPoint, OGRMultiCurve, OGRMultiSurface, OGRMultiPoint, and OGRMultiCurve.

◆ Intersection()

OGRGeometry * OGRGeometry::Intersection ( const OGRGeometry poOtherGeom) const
virtualinherited

Compute intersection.

Generates a new geometry which is the region of intersection of the two geometries operated on. The Intersects() method can be used to test if two geometries intersect.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Intersection().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe other geometry intersected with "this" geometry.
Returns
a new geometry to be freed by the caller, or NULL if there is no intersection or if an error occurs.

◆ Intersects()

OGRBoolean OGRGeometry::Intersects ( const OGRGeometry poOtherGeom) const
virtualinherited

Do these features intersect?

Determines whether two geometries intersect. If GEOS is enabled, then this is done in rigorous fashion otherwise TRUE is returned if the envelopes (bounding boxes) of the two geometries overlap.

The poOtherGeom argument may be safely NULL, but in this case the method will always return TRUE. That is, a NULL geometry is treated as being everywhere.

This method is the same as the C function OGR_G_Intersects().

Parameters
poOtherGeomthe other geometry to test against.
Returns
TRUE if the geometries intersect, otherwise FALSE.

Reimplemented in OGRPoint, and OGRCurvePolygon.

◆ Is3D()

OGRBoolean OGRGeometry::Is3D ( ) const
inlineinherited

Returns whether the geometry has a Z component.

◆ isCompatibleSubType()

OGRBoolean OGRGeometryCollection::isCompatibleSubType ( OGRwkbGeometryType  eSubType) const
protectedvirtual

Returns whether a geometry of the specified geometry type can be a member of this collection.

Parameters
eSubTypetype of the potential member
Returns
TRUE or FALSE

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

◆ IsEmpty()

OGRBoolean OGRGeometryCollection::IsEmpty ( ) const
overridevirtual

Returns TRUE (non-zero) 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.

Returns
TRUE if object is empty, otherwise FALSE.

Implements OGRGeometry.

◆ IsMeasured()

OGRBoolean OGRGeometry::IsMeasured ( ) const
inlineinherited

Returns whether the geometry has a M component.

◆ IsRectangle()

bool OGRGeometry::IsRectangle ( ) const
inherited

Returns whether the geometry is a polygon with 4 corners forming a rectangle.

Since
GDAL 3.10

◆ IsRing()

OGRBoolean OGRGeometry::IsRing ( ) const
virtualinherited

Test if the geometry is a ring.

This method is the same as the C function OGR_G_IsRing().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always return FALSE.

Returns
TRUE if the geometry has no points, otherwise FALSE.

◆ IsSimple()

OGRBoolean OGRGeometry::IsSimple ( ) const
virtualinherited

Test if the geometry is simple.

This method is the same as the C function OGR_G_IsSimple().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always return FALSE.

Returns
TRUE if the geometry has no points, otherwise FALSE.

◆ IsValid()

OGRBoolean OGRGeometry::IsValid ( ) const
virtualinherited

Test if the geometry is valid.

This method is the same as the C function OGR_G_IsValid().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always return FALSE.

Returns
TRUE if the geometry has no points, otherwise FALSE.

Reimplemented in OGRCircularString.

◆ MakeValid()

OGRGeometry * OGRGeometry::MakeValid ( CSLConstList  papszOptions = nullptr) const
virtualinherited

Attempts to make an invalid geometry valid without losing vertices.

Already-valid geometries are cloned without further intervention for default MODE=LINEWORK. Already-valid geometries with MODE=STRUCTURE may be subject to non-significant transformations, such as duplicated point removal, change in ring winding order, etc. (before GDAL 3.10, single-part geometry collections could be returned a single geometry. GDAL 3.10 returns the same type of geometry).

Running OGRGeometryFactory::removeLowerDimensionSubGeoms() as a post-processing step is often desired.

This method is the same as the C function OGR_G_MakeValid().

This function is built on the GEOS >= 3.8 library, check it for the definition of the geometry operation. If OGR is built without the GEOS >= 3.8 library, this function will return a clone of the input geometry if it is valid, or NULL if it is invalid

Parameters
papszOptionsNULL terminated list of options, or NULL. The following options are available:
  • METHOD=LINEWORK/STRUCTURE. LINEWORK is the default method, which combines all rings into a set of noded lines and then extracts valid polygons from that linework. The STRUCTURE method (requires GEOS >= 3.10 and GDAL >= 3.4) first makes all rings valid, then merges shells and subtracts holes from shells to generate valid result. Assumes that holes and shells are correctly categorized.
  • KEEP_COLLAPSED=YES/NO. Only for METHOD=STRUCTURE. NO (default): collapses are converted to empty geometries YES: collapses are converted to a valid geometry of lower dimension.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.0

◆ Normalize()

OGRGeometry * OGRGeometry::Normalize ( ) const
virtualinherited

Attempts to bring geometry into normalized/canonical form.

This method is the same as the C function OGR_G_Normalize().

This function is built on the GEOS library; check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.3

◆ operator=()

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.

Since
GDAL 2.1

◆ Overlaps()

OGRBoolean OGRGeometry::Overlaps ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for overlap.

Tests if this geometry and the other passed into the method overlap, that is their intersection has a non-zero area.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Overlaps().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if they are overlapping, otherwise FALSE.

◆ Polygonize()

OGRGeometry * OGRGeometry::Polygonize ( ) const
virtualinherited

Polygonizes a set of sparse edges.

A new geometry object is created and returned containing a collection of reassembled Polygons: NULL will be returned if the input collection doesn't corresponds to a MultiLinestring, or when reassembling Edges into Polygons is impossible due to topological inconsistencies.

This method is the same as the C function OGR_G_Polygonize().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 1.9.0

◆ removeEmptyParts()

void OGRGeometryCollection::removeEmptyParts ( )
overridevirtual

Remove empty parts/rings from this geometry.

Since
GDAL 3.10

Reimplemented from OGRGeometry.

◆ removeGeometry()

OGRErr OGRGeometryCollection::removeGeometry ( int  iGeom,
int  bDelete = TRUE 
)
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().

Parameters
iGeomthe index of the geometry to delete. A value of -1 is a special flag meaning that all geometries should be removed.
bDeleteif 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. Note: using stealGeometry() might be a better alternative to using bDelete = false.
Returns
OGRERR_NONE if successful, or OGRERR_FAILURE if the index is out of range.

◆ roundCoordinates()

void OGRGeometry::roundCoordinates ( const OGRGeomCoordinatePrecision sPrecision)
inherited

Round coordinates of the geometry to the specified precision.

Note that this is not the same as OGRGeometry::SetPrecision(). The later will return valid geometries, whereas roundCoordinates() does not make such guarantee and may return geometries with invalidities, if they are not compatible of the specified precision. roundCoordinates() supports curve geometries, whereas SetPrecision() does not currently.

One use case for roundCoordinates() is to undo the effect of quantizeCoordinates().

Parameters
sPrecisionContains the precision requirements.
Since
GDAL 3.9

◆ roundCoordinatesIEEE754()

void OGRGeometry::roundCoordinatesIEEE754 ( const OGRGeomCoordinateBinaryPrecision options)
inherited

Round coordinates of a geometry, exploiting characteristics of the IEEE-754 double-precision binary representation.

Determines the number of bits (N) required to represent a coordinate value with a specified number of digits after the decimal point, and then sets all but the N most significant bits to zero. The resulting coordinate value will still round to the original value (e.g. after roundCoordinates()), but will have improved compressiblity.

Parameters
optionsContains the precision requirements.
Since
GDAL 3.9

◆ segmentize()

bool OGRGeometryCollection::segmentize ( double  dfMaxLength)
overridevirtual

Modify the geometry such it has no segment longer then the given distance.

This method modifies the geometry to add intermediate vertices if necessary so that the maximum length between 2 consecutive vertices is lower than dfMaxLength.

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()

Parameters
dfMaxLengththe maximum distance between 2 points after segmentization
Returns
(since 3.10) true in case of success, false in case of error.

Reimplemented from OGRGeometry.

◆ set3D()

bool OGRGeometryCollection::set3D ( OGRBoolean  bIs3D)
overridevirtual

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.

Parameters
bIs3DShould the geometry have a Z dimension, either TRUE or FALSE.
Returns
(since 3.10) true in case of success, false in case of memory allocation error
Since
GDAL 2.1

Reimplemented from OGRGeometry.

◆ setCoordinateDimension()

bool OGRGeometryCollection::setCoordinateDimension ( int  nNewDimension)
overridevirtual

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.

Deprecated:
use set3D() or setMeasured().
Parameters
nNewDimensionNew coordinate dimension value, either 2 or 3.
Returns
(since 3.10) true in case of success, false in case of memory allocation error

Reimplemented from OGRGeometry.

◆ setMeasured()

bool OGRGeometryCollection::setMeasured ( OGRBoolean  bIsMeasured)
overridevirtual

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.

Parameters
bIsMeasuredShould the geometry have a M dimension, either TRUE or FALSE.
Returns
(since 3.10) true in case of success, false in case of memory allocation error
Since
GDAL 2.1

Reimplemented from OGRGeometry.

◆ SetPrecision()

OGRGeometry * OGRGeometry::SetPrecision ( double  dfGridSize,
int  nFlags 
) const
inherited

Set the geometry's precision, rounding all its coordinates to the precision grid, and making sure the geometry is still valid.

This is a stronger version of roundCoordinates().

Note that at time of writing GEOS does no supported curve geometries. So currently if this function is called on such a geometry, OGR will first call getLinearGeometry() on the input and getCurveGeometry() on the output, but that it is unlikely to yield to the expected result.

This function is the same as the C function OGR_G_SetPrecision().

This function is built on the GEOSGeom_setPrecision_r() function of the GEOS library. Check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Parameters
dfGridSizesize of the precision grid, or 0 for FLOATING precision.
nFlagsThe bitwise OR of zero, one or several of OGR_GEOS_PREC_NO_TOPO and OGR_GEOS_PREC_KEEP_COLLAPSED
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.9

◆ Simplify()

OGRGeometry * OGRGeometry::Simplify ( double  dTolerance) const
virtualinherited

Simplify the geometry.

This function is the same as the C function OGR_G_Simplify().

This function is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Parameters
dTolerancethe distance tolerance for the simplification.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 1.8.0

◆ SimplifyPreserveTopology()

OGRGeometry * OGRGeometry::SimplifyPreserveTopology ( double  dTolerance) const
inherited

Simplify the geometry while preserving topology.

This function is the same as the C function OGR_G_SimplifyPreserveTopology().

This function is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error.

Parameters
dTolerancethe distance tolerance for the simplification.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 1.9.0

◆ stealGeometry()

std::unique_ptr< OGRGeometry > OGRGeometryCollection::stealGeometry ( int  iGeom)

Remove a geometry from the container and return it to the caller.

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.

Parameters
iGeomthe index of the geometry to delete.
Returns
the sub-geometry, or nullptr in case of error.
Since
3.10

◆ swapXY()

void OGRGeometryCollection::swapXY ( )
overridevirtual

Swap x and y coordinates.

Since
OGR 1.8.0

Reimplemented from OGRGeometry.

◆ SymDifference()

OGRGeometry * OGRGeometry::SymDifference ( const OGRGeometry poOtherGeom) const
virtualinherited

Compute symmetric difference.

Generates a new geometry which is the symmetric difference of this geometry and the second geometry passed into the method.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_SymDifference().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe other geometry.
Returns
a new geometry to be freed by the caller, or NULL if the difference is empty or if an error occurs.
Since
OGR 1.8.0

◆ toCircularString() [1/2]

OGRCircularString * OGRGeometry::toCircularString ( )
inlineinherited

Down-cast to OGRCircularString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCircularString.

Since
GDAL 2.3

◆ toCircularString() [2/2]

const OGRCircularString * OGRGeometry::toCircularString ( ) const
inlineinherited

Down-cast to OGRCircularString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCircularString.

Since
GDAL 2.3

◆ toCompoundCurve() [1/2]

OGRCompoundCurve * OGRGeometry::toCompoundCurve ( )
inlineinherited

Down-cast to OGRCompoundCurve*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCompoundCurve.

Since
GDAL 2.3

◆ toCompoundCurve() [2/2]

const OGRCompoundCurve * OGRGeometry::toCompoundCurve ( ) const
inlineinherited

Down-cast to OGRCompoundCurve*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCompoundCurve.

Since
GDAL 2.3

◆ toCurve() [1/2]

OGRCurve * OGRGeometry::toCurve ( )
inlineinherited

Down-cast to OGRCurve*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbCurve).

Since
GDAL 2.3

◆ toCurve() [2/2]

const OGRCurve * OGRGeometry::toCurve ( ) const
inlineinherited

Down-cast to OGRCurve*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbCurve).

Since
GDAL 2.3

◆ toCurvePolygon() [1/2]

OGRCurvePolygon * OGRGeometry::toCurvePolygon ( )
inlineinherited

Down-cast to OGRCurvePolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCurvePolygon or wkbPolygon or wkbTriangle.

Since
GDAL 2.3

◆ toCurvePolygon() [2/2]

const OGRCurvePolygon * OGRGeometry::toCurvePolygon ( ) const
inlineinherited

Down-cast to OGRCurvePolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbCurvePolygon or wkbPolygon or wkbTriangle.

Since
GDAL 2.3

◆ toGeometryCollection() [1/2]

OGRGeometryCollection * OGRGeometry::toGeometryCollection ( )
inlineinherited

Down-cast to OGRGeometryCollection*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbGeometryCollection).

Since
GDAL 2.3

◆ toGeometryCollection() [2/2]

const OGRGeometryCollection * OGRGeometry::toGeometryCollection ( ) const
inlineinherited

Down-cast to OGRGeometryCollection*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbGeometryCollection).

Since
GDAL 2.3

◆ ToHandle()

static OGRGeometryH OGRGeometry::ToHandle ( OGRGeometry poGeom)
inlinestaticinherited

Convert a OGRGeometry* to a OGRGeometryH.

Since
GDAL 2.3

◆ toLinearRing() [1/2]

OGRLinearRing * OGRGeometry::toLinearRing ( )
inlineinherited

Down-cast to OGRLinearRing*.

Implies prior checking that EQUAL(getGeometryName(), "LINEARRING").

Since
GDAL 2.3

◆ toLinearRing() [2/2]

const OGRLinearRing * OGRGeometry::toLinearRing ( ) const
inlineinherited

Down-cast to OGRLinearRing*.

Implies prior checking that EQUAL(getGeometryName(), "LINEARRING").

Since
GDAL 2.3

◆ toLineString() [1/2]

OGRLineString * OGRGeometry::toLineString ( )
inlineinherited

Down-cast to OGRLineString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbLineString.

Since
GDAL 2.3

◆ toLineString() [2/2]

const OGRLineString * OGRGeometry::toLineString ( ) const
inlineinherited

Down-cast to OGRLineString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbLineString.

Since
GDAL 2.3

◆ toMultiCurve() [1/2]

OGRMultiCurve * OGRGeometry::toMultiCurve ( )
inlineinherited

Down-cast to OGRMultiCurve*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiCurve and derived types.

Since
GDAL 2.3

◆ toMultiCurve() [2/2]

const OGRMultiCurve * OGRGeometry::toMultiCurve ( ) const
inlineinherited

Down-cast to OGRMultiCurve*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiCurve and derived types.

Since
GDAL 2.3

◆ toMultiLineString() [1/2]

OGRMultiLineString * OGRGeometry::toMultiLineString ( )
inlineinherited

Down-cast to OGRMultiLineString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiLineString.

Since
GDAL 2.3

◆ toMultiLineString() [2/2]

const OGRMultiLineString * OGRGeometry::toMultiLineString ( ) const
inlineinherited

Down-cast to OGRMultiLineString*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiLineString.

Since
GDAL 2.3

◆ toMultiPoint() [1/2]

OGRMultiPoint * OGRGeometry::toMultiPoint ( )
inlineinherited

Down-cast to OGRMultiPoint*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiPoint.

Since
GDAL 2.3

◆ toMultiPoint() [2/2]

const OGRMultiPoint * OGRGeometry::toMultiPoint ( ) const
inlineinherited

Down-cast to OGRMultiPoint*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiPoint.

Since
GDAL 2.3

◆ toMultiPolygon() [1/2]

OGRMultiPolygon * OGRGeometry::toMultiPolygon ( )
inlineinherited

Down-cast to OGRMultiPolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiPolygon.

Since
GDAL 2.3

◆ toMultiPolygon() [2/2]

const OGRMultiPolygon * OGRGeometry::toMultiPolygon ( ) const
inlineinherited

Down-cast to OGRMultiPolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiPolygon.

Since
GDAL 2.3

◆ toMultiSurface() [1/2]

OGRMultiSurface * OGRGeometry::toMultiSurface ( )
inlineinherited

Down-cast to OGRMultiSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiSurface and derived types.

Since
GDAL 2.3

◆ toMultiSurface() [2/2]

const OGRMultiSurface * OGRGeometry::toMultiSurface ( ) const
inlineinherited

Down-cast to OGRMultiSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbMultiSurface and derived types.

Since
GDAL 2.3

◆ toPoint() [1/2]

OGRPoint * OGRGeometry::toPoint ( )
inlineinherited

Down-cast to OGRPoint*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPoint.

Since
GDAL 2.3

◆ toPoint() [2/2]

const OGRPoint * OGRGeometry::toPoint ( ) const
inlineinherited

Down-cast to OGRPoint*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPoint.

Since
GDAL 2.3

◆ toPolygon() [1/2]

OGRPolygon * OGRGeometry::toPolygon ( )
inlineinherited

Down-cast to OGRPolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPolygon or wkbTriangle.

Since
GDAL 2.3

◆ toPolygon() [2/2]

const OGRPolygon * OGRGeometry::toPolygon ( ) const
inlineinherited

Down-cast to OGRPolygon*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPolygon or wkbTriangle.

Since
GDAL 2.3

◆ toPolyhedralSurface() [1/2]

OGRPolyhedralSurface * OGRGeometry::toPolyhedralSurface ( )
inlineinherited

Down-cast to OGRPolyhedralSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPolyhedralSurface or wkbTIN.

Since
GDAL 2.3

◆ toPolyhedralSurface() [2/2]

const OGRPolyhedralSurface * OGRGeometry::toPolyhedralSurface ( ) const
inlineinherited

Down-cast to OGRPolyhedralSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbPolyhedralSurface or wkbTIN.

Since
GDAL 2.3

◆ toSimpleCurve() [1/2]

OGRSimpleCurve * OGRGeometry::toSimpleCurve ( )
inlineinherited

Down-cast to OGRSimpleCurve*.

Implies prior checking that getGeometryType() is wkbLineString, wkbCircularString or a derived type.

Since
GDAL 2.3

◆ toSimpleCurve() [2/2]

const OGRSimpleCurve * OGRGeometry::toSimpleCurve ( ) const
inlineinherited

Down-cast to OGRSimpleCurve*.

Implies prior checking that getGeometryType() is wkbLineString, wkbCircularString or a derived type.

Since
GDAL 2.3

◆ toSurface() [1/2]

OGRSurface * OGRGeometry::toSurface ( )
inlineinherited

Down-cast to OGRSurface*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbSurface).

Since
GDAL 2.3

◆ toSurface() [2/2]

const OGRSurface * OGRGeometry::toSurface ( ) const
inlineinherited

Down-cast to OGRSurface*.

Implies prior checking that OGR_GT_IsSubClass(getGeometryType(), wkbSurface).

Since
GDAL 2.3

◆ toTriangle() [1/2]

OGRTriangle * OGRGeometry::toTriangle ( )
inlineinherited

Down-cast to OGRTriangle*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbTriangle.

Since
GDAL 2.3

◆ toTriangle() [2/2]

const OGRTriangle * OGRGeometry::toTriangle ( ) const
inlineinherited

Down-cast to OGRTriangle*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbTriangle.

Since
GDAL 2.3

◆ toTriangulatedSurface() [1/2]

OGRTriangulatedSurface * OGRGeometry::toTriangulatedSurface ( )
inlineinherited

Down-cast to OGRTriangulatedSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbTIN.

Since
GDAL 2.3

◆ toTriangulatedSurface() [2/2]

const OGRTriangulatedSurface * OGRGeometry::toTriangulatedSurface ( ) const
inlineinherited

Down-cast to OGRTriangulatedSurface*.

Implies prior checking that wkbFlatten(getGeometryType()) == wkbTIN.

Since
GDAL 2.3

◆ Touches()

OGRBoolean OGRGeometry::Touches ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for touching.

Tests if this geometry and the other passed into the method are touching.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Touches().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if they are touching, otherwise FALSE.

◆ transform()

OGRErr OGRGeometryCollection::transform ( OGRCoordinateTransformation poCT)
overridevirtual

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 only does reprojection on a point-by-point basis. It does not include advanced logic to deal with discontinuities at poles or antimeridian. For that, use the OGRGeometryFactory::transformWithOptions() method.

This method is the same as the C function OGR_G_Transform().

Parameters
poCTthe transformation to apply.
Returns
OGRERR_NONE on success or an error code.

Implements OGRGeometry.

◆ transformTo()

OGRErr OGRGeometry::transformTo ( const OGRSpatialReference poSR)
inherited

Transform geometry to new spatial reference system.

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.

This method will only work if the geometry already has an assigned spatial reference system, and if it is transformable to the target coordinate system.

Because this method requires internal creation and initialization of an OGRCoordinateTransformation object it is significantly more expensive to use this method to transform many geometries than it is to create the OGRCoordinateTransformation in advance, and call transform() with that transformation. This method exists primarily for convenience when only transforming a single geometry.

This method is the same as the C function OGR_G_TransformTo().

Parameters
poSRspatial reference system to transform to.
Returns
OGRERR_NONE on success, or an error code.

◆ UnaryUnion()

OGRGeometry * OGRGeometry::UnaryUnion ( ) const
inherited

Returns the union of all components of a single geometry.

Usually used to convert a collection into the smallest set of polygons that cover the same area.

See https://postgis.net/docs/ST_UnaryUnion.html for more details.

This method is the same as the C function OGR_G_UnaryUnion().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
GDAL 3.7

◆ Union()

OGRGeometry * OGRGeometry::Union ( const OGRGeometry poOtherGeom) const
virtualinherited

Compute union.

Generates a new geometry which is the region of union of the two geometries operated on.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Union().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe other geometry unioned with "this" geometry.
Returns
a new geometry to be freed by the caller, or NULL if an error occurs.

◆ UnionCascaded()

OGRGeometry * OGRGeometry::UnionCascaded ( ) const
virtualinherited

Compute union using cascading.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

The input geometry must be a MultiPolygon.

This method is the same as the C function OGR_G_UnionCascaded().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Returns
a new geometry to be freed by the caller, or NULL if an error occurs.
Since
OGR 1.8.0
Deprecated:
Use UnaryUnion() instead

◆ Within()

OGRBoolean OGRGeometry::Within ( const OGRGeometry poOtherGeom) const
virtualinherited

Test for containment.

Tests if actual geometry object is within the passed geometry.

Geometry validity is not checked. In case you are unsure of the validity of the input geometries, call IsValid() before, otherwise the result might be wrong.

This method is the same as the C function OGR_G_Within().

This method is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always fail, issuing a CPLE_NotSupported error.

Parameters
poOtherGeomthe geometry to compare to this geometry.
Returns
TRUE if poOtherGeom is within this geometry, otherwise FALSE.

Reimplemented in OGRPoint.

◆ WkbSize()

size_t OGRGeometryCollection::WkbSize ( ) const
overridevirtual

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().

Returns
size of binary representation in bytes.

Implements OGRGeometry.


The documentation for this class was generated from the following files: