Abstract base class for 2 dimensional objects like polygons or curve polygons. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRSurface:

Public Member Functions
virtual double	get_Area () const =0
	Get the area of the surface object. More...

virtual OGRErr	PointOnSurface (OGRPoint *poPoint) const =0
	This method relates to the SFCOM ISurface::get_PointOnSurface() method. More...

Public Member Functions inherited from OGRGeometry
	OGRGeometry (const OGRGeometry &other)
	Copy constructor. More...

OGRGeometry &	operator= (const OGRGeometry &other)
	Assignment operator. More...

virtual int	getDimension () const =0
	Get the dimension of this object. More...

virtual int	getCoordinateDimension () const
	Get the dimension of the coordinates in this object. More...

int	CoordinateDimension () const
	Get the dimension of the coordinates in this object. More...

virtual OGRBoolean	IsEmpty () const
	Returns TRUE (non-zero) if the object has no points. More...

virtual OGRBoolean	IsValid () const
	Test if the geometry is valid. More...

virtual OGRBoolean	IsSimple () const
	Test if the geometry is simple. More...

OGRBoolean	Is3D () const

OGRBoolean	IsMeasured () const

virtual OGRBoolean	IsRing () const
	Test if the geometry is a ring. More...

virtual void	empty ()=0
	Clear geometry information. More...

virtual OGRGeometry *	clone () const CPL_WARN_UNUSED_RESULT=0
	Make a copy of this object. More...

virtual void	getEnvelope (OGREnvelope *psEnvelope) const =0
	Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...

virtual void	getEnvelope (OGREnvelope3D *psEnvelope) const =0
	Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More...

virtual int	WkbSize () const =0
	Returns size of related binary representation. More...

virtual OGRErr	importFromWkb (unsigned char *, int=-1, OGRwkbVariant=wkbVariantOldOgc)=0
	Assign geometry from well known binary data. More...

virtual OGRErr	exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const =0
	Convert a geometry into well known binary format. More...

virtual OGRErr	importFromWkt (char **ppszInput)=0
	Assign geometry from well known text data. More...

virtual OGRErr	exportToWkt (char **ppszDstText, OGRwkbVariant=wkbVariantOldOgc) const =0
	Convert a geometry into well known text format. More...

virtual OGRwkbGeometryType	getGeometryType () const =0
	Fetch geometry type. More...

OGRwkbGeometryType	getIsoGeometryType () const
	Get the geometry type that conforms with ISO SQL/MM Part3. More...

virtual const char *	getGeometryName () const =0
	Fetch WKT name for geometry type. 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 void	flattenTo2D ()=0
	Convert geometry to strictly 2D. More...

virtual char *	exportToGML (const char const papszOptions=NULL) const
	Convert a geometry into GML format. More...

virtual char *	exportToKML () const
	Convert a geometry into KML format. More...

virtual char *	exportToJson () const
	Convert a geometry into GeoJSON format. More...

virtual GEOSGeom	exportToGEOS (GEOSContextHandle_t hGEOSCtxt) const CPL_WARN_UNUSED_RESULT

virtual OGRBoolean	hasCurveGeometry (int bLookForNonLinear=FALSE) const
	Returns if this geometry is or has curve geometry. More...

virtual OGRGeometry *	getCurveGeometry (const char const papszOptions=NULL) const CPL_WARN_UNUSED_RESULT
	Return curve version of this geometry. More...

virtual OGRGeometry *	getLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char const papszOptions=NULL) const CPL_WARN_UNUSED_RESULT
	Return, possibly approximate, non-curve version of this geometry. More...

virtual void	closeRings ()
	Force rings to be closed. More...

virtual void	setCoordinateDimension (int nDimension)
	Set the coordinate dimension. More...

virtual void	set3D (OGRBoolean bIs3D)
	Add or remove the Z coordinate dimension. More...

virtual void	setMeasured (OGRBoolean bIsMeasured)
	Add or remove the M coordinate dimension. More...

void	assignSpatialReference (OGRSpatialReference *poSR)
	Assign spatial reference to this object. More...

OGRSpatialReference *	getSpatialReference (void) const
	Returns spatial reference system for object. More...

virtual OGRErr	transform (OGRCoordinateTransformation *poCT)=0
	Apply arbitrary coordinate transformation to geometry. More...

OGRErr	transformTo (OGRSpatialReference *poSR)
	Transform geometry to new spatial reference system. More...

virtual void	segmentize (double dfMaxLength)
	Modify the geometry such it has no segment longer then the given distance. More...

virtual OGRBoolean	Intersects (const OGRGeometry *) const
	Do these features intersect? More...

virtual OGRBoolean	Equals (OGRGeometry *) const =0
	Returns TRUE if two geometries are equivalent. More...

virtual OGRBoolean	Disjoint (const OGRGeometry *) const
	Test for disjointness. More...

virtual OGRBoolean	Touches (const OGRGeometry *) const
	Test for touching. More...

virtual OGRBoolean	Crosses (const OGRGeometry *) const
	Test for crossing. More...

virtual OGRBoolean	Within (const OGRGeometry *) const
	Test for containment. More...

virtual OGRBoolean	Contains (const OGRGeometry *) const
	Test for containment. More...

virtual OGRBoolean	Overlaps (const OGRGeometry *) const
	Test for overlap. More...

virtual OGRGeometry *	Boundary () const CPL_WARN_UNUSED_RESULT
	Compute boundary. More...

virtual double	Distance (const OGRGeometry *) const
	Compute distance between two geometries. More...

virtual OGRGeometry *	ConvexHull () const CPL_WARN_UNUSED_RESULT
	Compute convex hull. More...

virtual OGRGeometry *	Buffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT
	Compute buffer of geometry. More...

virtual OGRGeometry *	Intersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
	Compute intersection. More...

virtual OGRGeometry *	Union (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
	Compute union. More...

virtual OGRGeometry *	UnionCascaded () const CPL_WARN_UNUSED_RESULT
	Compute union using cascading. More...

virtual OGRGeometry *	Difference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
	Compute difference. More...

virtual OGRGeometry *	SymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
	Compute symmetric difference. More...

virtual OGRErr	Centroid (OGRPoint *poPoint) const
	Compute the geometry centroid. More...

virtual OGRGeometry *	Simplify (double dTolerance) const CPL_WARN_UNUSED_RESULT
	Simplify the geometry. More...

OGRGeometry *	SimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT
	Simplify the geometry while preserving topology. More...

virtual OGRGeometry *	DelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT
	Return a Delaunay triangulation of the vertices of the geometry. More...

virtual OGRGeometry *	Polygonize () const CPL_WARN_UNUSED_RESULT
	Polygonizes a set of sparse edges. More...

OGRBoolean	Intersect (OGRGeometry *) const CPL_WARN_DEPRECATED("Non standard method. Use Intersects() instead")

OGRBoolean	Equal (OGRGeometry *) const CPL_WARN_DEPRECATED("Non standard method. Use Equals() instead")

OGRGeometry *	SymmetricDifference (const OGRGeometry *) const CPL_WARN_DEPRECATED("Non standard method. Use SymDifference() instead")
	Compute symmetric difference (deprecated) More...

OGRGeometry *	getBoundary () const CPL_WARN_DEPRECATED("Non standard method. Use Boundary() instead")
	Compute boundary (deprecated) More...

virtual void	swapXY ()
	Swap x and y coordinates. More...

Static Public Member Functions
static OGRPolygon *	CastToPolygon (OGRSurface *poSurface)
	Cast to polygon. More...

static OGRCurvePolygon *	CastToCurvePolygon (OGRSurface *poSurface)
	Cast to curve polygon. More...

Static Public Member Functions inherited from OGRGeometry
static GEOSContextHandle_t	createGEOSContext ()

static void	freeGEOSContext (GEOSContextHandle_t hGEOSCtxt)

static OGRGeometry *	CastToIdentity (OGRGeometry *poGeom)

static OGRGeometry *	CastToError (OGRGeometry *poGeom)

Protected Member Functions
virtual OGRSurfaceCasterToPolygon	GetCasterToPolygon () const =0

virtual OGRSurfaceCasterToCurvePolygon	GetCasterToCurvePolygon () const =0

Protected Member Functions inherited from OGRGeometry
OGRErr	importPreambuleFromWkt (char *ppszInput, int pbHasZ, int pbHasM, bool pbIsEmpty)

OGRErr	importCurveCollectionFromWkt (char *ppszInput, int bAllowEmptyComponent, int bAllowLineString, int bAllowCurve, int bAllowCompoundCurve, OGRErr(pfnAddCurveDirectly)(OGRGeometry poSelf, OGRCurve poCurve))

OGRErr	importPreambuleFromWkb (unsigned char *pabyData, int nSize, OGRwkbByteOrder &eByteOrder, OGRwkbVariant eWkbVariant)

OGRErr	importPreambuleOfCollectionFromWkb (unsigned char *pabyData, int &nSize, int &nDataOffset, OGRwkbByteOrder &eByteOrder, int nMinSubGeomSize, int &nGeomCount, OGRwkbVariant eWkbVariant)

OGRErr	PointOnSurfaceInternal (OGRPoint *poPoint) const

Additional Inherited Members
Static Public Attributes inherited from OGRGeometry
static const unsigned int	OGR_G_NOT_EMPTY_POINT = 0x1

static const unsigned int	OGR_G_3D = 0x2

static const unsigned int	OGR_G_MEASURED = 0x4

static int	bGenerate_DB2_V72_BYTE_ORDER = FALSE

Protected Attributes inherited from OGRGeometry
unsigned int	flags

Detailed Description

Abstract base class for 2 dimensional objects like polygons or curve polygons.

Member Function Documentation

◆ CastToCurvePolygon()

OGRCurvePolygon * OGRSurface::CastToCurvePolygon ( OGRSurface * poSurface )

static

Cast to curve polygon.

The passed in geometry is consumed and a new one returned (or NULL in case of failure)

Parameters

poSurface the input geometry - ownership is passed to the method.

Returns: new geometry.

◆ CastToPolygon()

OGRPolygon * OGRSurface::CastToPolygon ( OGRSurface * poSurface )

static

Cast to polygon.

The passed in geometry is consumed and a new one returned (or NULL in case of failure)

Parameters

poSurface the input geometry - ownership is passed to the method.

Returns: new geometry.

◆ get_Area()

double OGRSurface::get_Area ( ) const

pure virtual

Get the area of the surface object.

For polygons the area is computed as the area of the outer ring less the area of all internal rings.

This method relates to the SFCOM ISurface::get_Area() method.

Returns: the area of the feature in square units of the spatial reference system in use.

Implemented in OGRCurvePolygon.

◆ PointOnSurface()

OGRErr OGRSurface::PointOnSurface ( OGRPoint * poPoint ) const

pure virtual

This method relates to the SFCOM ISurface::get_PointOnSurface() method.

NOTE: Only implemented when GEOS included in build.

Parameters

poPoint point to be set with an internal point.

Returns: OGRERR_NONE if it succeeds or OGRERR_FAILURE otherwise.

Implemented in OGRPolygon, and OGRCurvePolygon.

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

ogr_geometry.h
ogrsurface.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CastToCurvePolygon()

◆ CastToPolygon()

◆ get_Area()

◆ PointOnSurface()