OGR
Public Member Functions | List of all members
OGRMultiPolygon Class Reference

#include <ogr_geometry.h>

Inheritance diagram for OGRMultiPolygon:
OGRGeometryCollection OGRGeometry

Public Member Functions

virtual const char * getGeometryName () const
 Fetch WKT name for geometry type. More...
 
virtual OGRwkbGeometryType getGeometryType () const
 Fetch geometry type. More...
 
virtual OGRGeometryclone () const
 Make a copy of this object. More...
 
virtual OGRErr importFromWkt (char **)
 Assign geometry from well known text data. More...
 
virtual OGRErr exportToWkt (char **) const
 Convert a geometry into well known text format. More...
 
virtual int getDimension () const
 Get the dimension of this object. More...
 
virtual OGRErr addGeometryDirectly (OGRGeometry *)
 Add a geometry directly to the container. More...
 
virtual double get_Area () const
 
- Public Member Functions inherited from OGRGeometryCollection
 OGRGeometryCollection ()
 Create an empty geometry collection.
 
virtual void empty ()
 Clear geometry information. This restores the geometry to it's initial state after construction, and before assignment of actual geometry. More...
 
virtual OGRErr transform (OGRCoordinateTransformation *poCT)
 Apply arbitrary coordinate transformation to geometry. More...
 
virtual void flattenTo2D ()
 Convert geometry to strictly 2D. In a sense this converts all Z coordinates to 0.0. More...
 
virtual OGRBoolean IsEmpty () const
 Returns TRUE (non-zero) if the object has no points. More...
 
virtual void segmentize (double dfMaxLength)
 Modify the geometry such it has no segment longer then the given distance. More...
 
virtual int WkbSize () const
 Returns size of related binary representation. More...
 
virtual OGRErr importFromWkb (unsigned char *, int=-1)
 Assign geometry from well known binary data. More...
 
virtual OGRErr exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOgc) const
 Convert a geometry into well known binary format. More...
 
virtual double get_Length () const
 Compute the length of a multicurve. More...
 
virtual void getEnvelope (OGREnvelope *psEnvelope) const
 Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...
 
virtual void getEnvelope (OGREnvelope3D *psEnvelope) const
 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...
 
OGRGeometrygetGeometryRef (int)
 Fetch geometry from container. More...
 
virtual OGRBoolean Equals (OGRGeometry *) const
 Returns TRUE if two geometries are equivalent. More...
 
virtual void setCoordinateDimension (int nDimension)
 Set the coordinate dimension. More...
 
virtual OGRErr addGeometry (const OGRGeometry *)
 Add a geometry to the container. More...
 
virtual OGRErr removeGeometry (int iIndex, int bDelete=TRUE)
 Remove a geometry from the container. More...
 
void closeRings ()
 Force rings to be closed. More...
 
virtual void swapXY ()
 Swap x and y coordinates. More...
 
- Public Member Functions inherited from OGRGeometry
virtual int getCoordinateDimension () 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...
 
virtual OGRBoolean IsRing () const
 Test if the geometry is a ring. 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...
 
void assignSpatialReference (OGRSpatialReference *poSR)
 Assign spatial reference to this object. More...
 
OGRSpatialReferencegetSpatialReference (void) const
 Returns spatial reference system for object. More...
 
OGRErr transformTo (OGRSpatialReference *poSR)
 Transform geometry to new spatial reference system. More...
 
virtual OGRBoolean Intersects (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 OGRGeometryBoundary () const
 Compute boundary. More...
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries. More...
 
virtual OGRGeometryConvexHull () const
 Compute convex hull. More...
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const
 Compute buffer of geometry. More...
 
virtual OGRGeometryIntersection (const OGRGeometry *) const
 Compute intersection. More...
 
virtual OGRGeometryUnion (const OGRGeometry *) const
 Compute union. More...
 
virtual OGRGeometryUnionCascaded () const
 Compute union using cascading. More...
 
virtual OGRGeometryDifference (const OGRGeometry *) const
 Compute difference. More...
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const
 Compute symmetric difference. More...
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid. More...
 
virtual OGRGeometrySimplify (double dTolerance) const
 Simplify the geometry. More...
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const
 Simplify the geometry while preserving topology. More...
 
virtual OGRGeometryPolygonize () const
 Polygonizes a set of sparse edges. More...
 
virtual OGRGeometrySymmetricDifference (const OGRGeometry *) const CPL_WARN_DEPRECATED("Non standard method. Use SymDifference() instead")
 Compute symmetric difference (deprecated) More...
 
virtual OGRGeometrygetBoundary () const CPL_WARN_DEPRECATED("Non standard method. Use Boundary() instead")
 Compute boundary (deprecated) More...
 

Detailed Description

A collection of non-overlapping OGRPolygons.

Note that the IMultiSurface class hasn't been modelled, nor have any of it's methods.

Member Function Documentation

OGRErr OGRMultiPolygon::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.

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.

Reimplemented from OGRGeometryCollection.

References OGRGeometryCollection::addGeometryDirectly(), OGRGeometry::getGeometryType(), wkbPolygon, and wkbPolygon25D.

Referenced by OGRGeometryFactory::forceToMultiPolygon(), importFromWkt(), and OGRGeometryFactory::organizePolygons().

OGRGeometry * OGRMultiPolygon::clone ( ) const
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().

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

Reimplemented from OGRGeometryCollection.

References OGRGeometryCollection::addGeometry(), OGRGeometry::assignSpatialReference(), OGRGeometryCollection::getGeometryRef(), OGRGeometryCollection::getNumGeometries(), and OGRGeometry::getSpatialReference().

OGRErr OGRMultiPolygon::exportToWkt ( char **  ppszDstText) const
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().

Parameters
ppszDstTexta text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with OGRFree().
Returns
Currently OGRERR_NONE is always returned.

Reimplemented from OGRGeometryCollection.

References CPLCalloc(), CPLDebug(), CPLStrdup(), OGRGeometry::exportToWkt(), OGRGeometryCollection::getGeometryRef(), and OGRGeometryCollection::getNumGeometries().

double OGRMultiPolygon::get_Area ( ) const
virtual

Compute area of multipolygon.

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

Returns
computed area.

Reimplemented from OGRGeometryCollection.

References OGRPolygon::get_Area(), OGRGeometryCollection::getGeometryRef(), and OGRGeometryCollection::getNumGeometries().

int OGRMultiPolygon::getDimension ( ) const
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().

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

Reimplemented from OGRGeometryCollection.

const char * OGRMultiPolygon::getGeometryName ( ) const
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().

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.

Reimplemented from OGRGeometryCollection.

Referenced by importFromWkt().

OGRwkbGeometryType OGRMultiPolygon::getGeometryType ( ) const
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().

Returns
the geometry type code.

Reimplemented from OGRGeometryCollection.

References OGRGeometry::getCoordinateDimension(), wkbMultiPolygon, and wkbMultiPolygon25D.

OGRErr OGRMultiPolygon::importFromWkt ( 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.

Reimplemented from OGRGeometryCollection.

References addGeometryDirectly(), OGRPolygon::addRingDirectly(), OGRGeometryCollection::empty(), getGeometryName(), and OGRLineString::setPoints().


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

Generated for GDAL by doxygen 1.8.11.