GDAL
|
Point class. More...
#include <ogr_geometry.h>
Public Member Functions | |
OGRPoint () | |
Create an empty point. | |
OGRPoint (double x, double y) | |
Create a point. More... | |
OGRPoint (double x, double y, double z) | |
Create a point. More... | |
OGRPoint (double x, double y, double z, double m) | |
Create a point. More... | |
OGRPoint (const OGRPoint &other) | |
Copy constructor. More... | |
OGRPoint & | operator= (const OGRPoint &other) |
Assignment operator. More... | |
int | WkbSize () const override |
Returns size of related binary representation. More... | |
OGRErr | importFromWkb (const unsigned char *, int, OGRwkbVariant, int &nBytesConsumedOut) override |
Assign geometry from well known binary data. More... | |
OGRErr | exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const override |
Convert a geometry into well known binary format. More... | |
OGRErr | importFromWkt (const char **) override |
deprecated | |
OGRErr | exportToWkt (char **ppszDstText, OGRwkbVariant=wkbVariantOldOgc) const override |
Convert a geometry into well known text format. More... | |
virtual int | getDimension () const override |
Get the dimension of this object. More... | |
virtual OGRGeometry * | clone () const override |
Make a copy of this object. More... | |
virtual void | empty () override |
Clear geometry information. More... | |
virtual void | getEnvelope (OGREnvelope *psEnvelope) const override |
Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More... | |
virtual void | getEnvelope (OGREnvelope3D *psEnvelope) const override |
Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More... | |
virtual OGRBoolean | IsEmpty () const override |
Returns TRUE (non-zero) if the object has no points. More... | |
double | getX () const |
Return x. More... | |
double | getY () const |
Return y. More... | |
double | getZ () const |
Return z. More... | |
double | getM () const |
Return m. | |
virtual void | setCoordinateDimension (int nDimension) override |
Set the coordinate dimension. More... | |
void | setX (double xIn) |
Set x. More... | |
void | setY (double yIn) |
Set y. More... | |
void | setZ (double zIn) |
Set z. More... | |
void | setM (double mIn) |
Set m. More... | |
virtual OGRBoolean | Equals (const OGRGeometry *) const override |
Returns TRUE if two geometries are equivalent. More... | |
virtual OGRBoolean | Intersects (const OGRGeometry *) const override |
Do these features intersect? More... | |
virtual OGRBoolean | Within (const OGRGeometry *) const override |
Test for containment. More... | |
virtual const char * | getGeometryName () const override |
Fetch WKT name for geometry type. More... | |
virtual OGRwkbGeometryType | getGeometryType () const override |
Fetch geometry type. More... | |
virtual OGRErr | transform (OGRCoordinateTransformation *poCT) override |
Apply arbitrary coordinate transformation to geometry. More... | |
virtual void | flattenTo2D () override |
Convert geometry to strictly 2D. More... | |
virtual void | accept (IOGRGeometryVisitor *visitor) override |
Accept a visitor. More... | |
virtual void | accept (IOGRConstGeometryVisitor *visitor) const override |
Accept a visitor. More... | |
virtual void | swapXY () override |
Swap x and y coordinates. More... | |
Public Member Functions inherited from OGRGeometry | |
OGRGeometry (const OGRGeometry &other) | |
Copy constructor. More... | |
OGRGeometry & | operator= (const OGRGeometry &other) |
Assignment operator. More... | |
bool | operator== (const OGRGeometry &other) const |
Returns if two geometries are equal. More... | |
bool | operator!= (const OGRGeometry &other) const |
Returns if two geometries are different. More... | |
virtual int | getCoordinateDimension () const |
Get the dimension of the coordinates in this object. More... | |
int | CoordinateDimension () const |
Get the dimension of the coordinates in this object. More... | |
virtual OGRBoolean | IsValid () const |
Test if the geometry is valid. More... | |
virtual OGRBoolean | IsSimple () const |
Test if the geometry is simple. More... | |
OGRBoolean | Is3D () const |
OGRBoolean | IsMeasured () const |
virtual OGRBoolean | IsRing () const |
Test if the geometry is a ring. More... | |
OGRErr | importFromWkb (const GByte *, int=-1, OGRwkbVariant=wkbVariantOldOgc) |
Assign geometry from well known binary data. More... | |
OGRErr | importFromWkt (char **ppszInput) CPL_WARN_DEPRECATED("Use importFromWkt( const char**) instead") |
Deprecated. More... | |
OGRwkbGeometryType | getIsoGeometryType () const |
Get the geometry type that conforms with ISO SQL/MM Part3. More... | |
virtual void | dumpReadable (FILE *, const char *=nullptr, char **papszOptions=nullptr) const |
Dump geometry in well known text format to indicated output file. More... | |
virtual char * | exportToGML (const char *const *papszOptions=nullptr) const |
Convert a geometry into GML format. More... | |
virtual char * | exportToKML () const |
Convert a geometry into KML format. More... | |
virtual char * | exportToJson () const |
Convert a geometry into GeoJSON format. More... | |
virtual GEOSGeom | exportToGEOS (GEOSContextHandle_t hGEOSCtxt) const CPL_WARN_UNUSED_RESULT |
Returns a GEOSGeom object corresponding to the geometry. More... | |
virtual OGRBoolean | hasCurveGeometry (int bLookForNonLinear=FALSE) const |
Returns if this geometry is or has curve geometry. More... | |
virtual OGRGeometry * | getCurveGeometry (const char *const *papszOptions=nullptr) const CPL_WARN_UNUSED_RESULT |
Return curve version of this geometry. More... | |
virtual OGRGeometry * | getLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=nullptr) 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 | set3D (OGRBoolean bIs3D) |
Add or remove the Z coordinate dimension. More... | |
virtual void | setMeasured (OGRBoolean bIsMeasured) |
Add or remove the M coordinate dimension. More... | |
virtual void | assignSpatialReference (OGRSpatialReference *poSR) |
Assign spatial reference to this object. More... | |
OGRSpatialReference * | getSpatialReference (void) const |
Returns spatial reference system for object. More... | |
OGRErr | transformTo (OGRSpatialReference *poSR) |
Transform geometry to new spatial reference system. More... | |
virtual void | segmentize (double dfMaxLength) |
Modify the geometry such it has no segment longer then the given distance. 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 | Contains (const OGRGeometry *) const |
Test for containment. More... | |
virtual OGRBoolean | Overlaps (const OGRGeometry *) const |
Test for overlap. More... | |
virtual OGRGeometry * | Boundary () const CPL_WARN_UNUSED_RESULT |
Compute boundary. More... | |
virtual double | Distance (const OGRGeometry *) const |
Compute distance between two geometries. More... | |
virtual OGRGeometry * | ConvexHull () const CPL_WARN_UNUSED_RESULT |
Compute convex hull. More... | |
virtual OGRGeometry * | Buffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT |
Compute buffer of geometry. More... | |
virtual OGRGeometry * | Intersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT |
Compute intersection. More... | |
virtual OGRGeometry * | Union (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT |
Compute union. More... | |
virtual OGRGeometry * | UnionCascaded () const CPL_WARN_UNUSED_RESULT |
Compute union using cascading. More... | |
virtual OGRGeometry * | Difference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT |
Compute difference. More... | |
virtual OGRGeometry * | SymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT |
Compute symmetric difference. More... | |
virtual OGRErr | Centroid (OGRPoint *poPoint) const |
Compute the geometry centroid. More... | |
virtual OGRGeometry * | Simplify (double dTolerance) const CPL_WARN_UNUSED_RESULT |
Simplify the geometry. More... | |
OGRGeometry * | SimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT |
Simplify the geometry while preserving topology. More... | |
virtual OGRGeometry * | DelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT |
Return a Delaunay triangulation of the vertices of the geometry. More... | |
virtual OGRGeometry * | Polygonize () const CPL_WARN_UNUSED_RESULT |
Polygonizes a set of sparse edges. More... | |
virtual double | Distance3D (const OGRGeometry *poOtherGeom) const |
Returns the 3D distance between two geometries. More... | |
OGRPoint * | toPoint () |
Down-cast to OGRPoint*. More... | |
const OGRPoint * | toPoint () const |
Down-cast to OGRPoint*. More... | |
OGRCurve * | toCurve () |
Down-cast to OGRCurve*. More... | |
const OGRCurve * | toCurve () const |
Down-cast to OGRCurve*. More... | |
OGRSimpleCurve * | toSimpleCurve () |
Down-cast to OGRSimpleCurve*. More... | |
const OGRSimpleCurve * | toSimpleCurve () const |
Down-cast to OGRSimpleCurve*. More... | |
OGRLineString * | toLineString () |
Down-cast to OGRLineString*. More... | |
const OGRLineString * | toLineString () const |
Down-cast to OGRLineString*. More... | |
OGRLinearRing * | toLinearRing () |
Down-cast to OGRLinearRing*. More... | |
const OGRLinearRing * | toLinearRing () const |
Down-cast to OGRLinearRing*. More... | |
OGRCircularString * | toCircularString () |
Down-cast to OGRCircularString*. More... | |
const OGRCircularString * | toCircularString () const |
Down-cast to OGRCircularString*. More... | |
OGRCompoundCurve * | toCompoundCurve () |
Down-cast to OGRCompoundCurve*. More... | |
const OGRCompoundCurve * | toCompoundCurve () const |
Down-cast to OGRCompoundCurve*. More... | |
OGRSurface * | toSurface () |
Down-cast to OGRSurface*. More... | |
const OGRSurface * | toSurface () const |
Down-cast to OGRSurface*. More... | |
OGRPolygon * | toPolygon () |
Down-cast to OGRPolygon*. More... | |
const OGRPolygon * | toPolygon () const |
Down-cast to OGRPolygon*. More... | |
OGRTriangle * | toTriangle () |
Down-cast to OGRTriangle*. More... | |
const OGRTriangle * | toTriangle () const |
Down-cast to OGRTriangle*. More... | |
OGRCurvePolygon * | toCurvePolygon () |
Down-cast to OGRCurvePolygon*. More... | |
const OGRCurvePolygon * | toCurvePolygon () const |
Down-cast to OGRCurvePolygon*. More... | |
OGRGeometryCollection * | toGeometryCollection () |
Down-cast to OGRGeometryCollection*. More... | |
const OGRGeometryCollection * | toGeometryCollection () const |
Down-cast to OGRGeometryCollection*. More... | |
OGRMultiPoint * | toMultiPoint () |
Down-cast to OGRMultiPoint*. More... | |
const OGRMultiPoint * | toMultiPoint () const |
Down-cast to OGRMultiPoint*. More... | |
OGRMultiLineString * | toMultiLineString () |
Down-cast to OGRMultiLineString*. More... | |
const OGRMultiLineString * | toMultiLineString () const |
Down-cast to OGRMultiLineString*. More... | |
OGRMultiPolygon * | toMultiPolygon () |
Down-cast to OGRMultiPolygon*. More... | |
const OGRMultiPolygon * | toMultiPolygon () const |
Down-cast to OGRMultiPolygon*. More... | |
OGRMultiCurve * | toMultiCurve () |
Down-cast to OGRMultiCurve*. More... | |
const OGRMultiCurve * | toMultiCurve () const |
Down-cast to OGRMultiCurve*. More... | |
OGRMultiSurface * | toMultiSurface () |
Down-cast to OGRMultiSurface*. More... | |
const OGRMultiSurface * | toMultiSurface () const |
Down-cast to OGRMultiSurface*. More... | |
OGRPolyhedralSurface * | toPolyhedralSurface () |
Down-cast to OGRPolyhedralSurface*. More... | |
const OGRPolyhedralSurface * | toPolyhedralSurface () const |
Down-cast to OGRPolyhedralSurface*. More... | |
OGRTriangulatedSurface * | toTriangulatedSurface () |
Down-cast to OGRTriangulatedSurface*. More... | |
const OGRTriangulatedSurface * | toTriangulatedSurface () const |
Down-cast to OGRTriangulatedSurface*. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from OGRGeometry | |
static GEOSContextHandle_t | createGEOSContext () |
Create a new GEOS context. More... | |
static void | freeGEOSContext (GEOSContextHandle_t hGEOSCtxt) |
Destroy a GEOS context. More... | |
static OGRGeometryH | ToHandle (OGRGeometry *poGeom) |
Convert a OGRGeometry* to a OGRGeometryH. More... | |
static OGRGeometry * | FromHandle (OGRGeometryH hGeom) |
Convert a OGRGeometryH to a OGRGeometry*. More... | |
Point class.
Implements SFCOM IPoint methods.
OGRPoint::OGRPoint | ( | double | xIn, |
double | yIn | ||
) |
Create a point.
xIn | x |
yIn | y |
OGRPoint::OGRPoint | ( | double | xIn, |
double | yIn, | ||
double | zIn | ||
) |
Create a point.
xIn | x |
yIn | y |
zIn | z |
OGRPoint::OGRPoint | ( | double | xIn, |
double | yIn, | ||
double | zIn, | ||
double | mIn | ||
) |
Create a point.
xIn | x |
yIn | y |
zIn | z |
mIn | m |
|
default |
Copy constructor.
Note: before GDAL 2.1, only the default implementation of the constructor existed, which could be unsafe to use.
|
inlineoverridevirtual |
Accept a visitor.
Implements OGRGeometry.
|
inlineoverridevirtual |
Accept a visitor.
Implements OGRGeometry.
|
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().
Implements OGRGeometry.
|
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.
|
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().
Implements OGRGeometry.
|
overridevirtual |
Convert a geometry into well known binary format.
This method relates to the SFCOM IWks::ExportToWKB() method.
This method is the same as the C function OGR_G_ExportToWkb() or OGR_G_ExportToIsoWkb(), depending on the value of eWkbVariant.
eByteOrder | One of wkbXDR or wkbNDR indicating MSB or LSB byte order respectively. |
pabyData | a buffer into which the binary representation is written. This buffer must be at least OGRGeometry::WkbSize() byte in size. |
eWkbVariant | What standard to use when exporting geometries with three dimensions (or more). The default wkbVariantOldOgc is the historical OGR variant. wkbVariantIso is the variant defined in ISO SQL/MM and adopted by OGC for SFSQL 1.2. |
Implements OGRGeometry.
|
overridevirtual |
Convert a geometry into well known text format.
This method relates to the SFCOM IWks::ExportToWKT() method.
This method is the same as the C function OGR_G_ExportToWkt().
ppszDstText | a text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with CPLFree(). |
eWkbVariant | the specification that must be conformed too :
|
Implements OGRGeometry.
|
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.
|
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().
Implements OGRGeometry.
|
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().
psEnvelope | the structure in which to place the results. |
Implements OGRGeometry.
|
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().
psEnvelope | the structure in which to place the results. |
Implements OGRGeometry.
|
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().
Implements OGRGeometry.
|
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().
Implements OGRGeometry.
|
inline |
Return x.
Fetch X coordinate.
Relates to the SFCOM IPoint::get_X() method.
|
inline |
Return y.
Fetch Y coordinate.
Relates to the SFCOM IPoint::get_Y() method.
|
inline |
Return z.
Fetch Z coordinate.
Relates to the SFCOM IPoint::get_Z() method.
|
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().
pabyData | the binary input data. |
nSize | the size of pabyData in bytes, or -1 if not known. |
eWkbVariant | if wkbVariantPostGIS1, special interpretation is done for curve geometries code |
nBytesConsumedOut | output parameter. Number of bytes consumed. |
Implements OGRGeometry.
|
overridevirtual |
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().
poOtherGeom | the other geometry to test against. |
Reimplemented from OGRGeometry.
|
inlineoverridevirtual |
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.
Implements OGRGeometry.
Assignment operator.
Note: before GDAL 2.1, only the default implementation of the operator existed, which could be unsafe to use.
|
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.
nNewDimension | New coordinate dimension value, either 2 or 3. |
Reimplemented from OGRGeometry.
|
inline |
Set m.
mIn | m |
|
inline |
Set x.
Assign point X coordinate.
xIn | x |
There is no corresponding SFCOM method.
|
inline |
Set y.
Assign point Y coordinate.
yIn | y |
There is no corresponding SFCOM method.
|
inline |
Set z.
Assign point Z coordinate.
zIn | z |
Calling this method will force the geometry coordinate dimension to 3D (wkbPoint|wkbZ).
There is no corresponding SFCOM method.
|
overridevirtual |
|
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 is the same as the C function OGR_G_Transform().
poCT | the transformation to apply. |
Implements OGRGeometry.
|
overridevirtual |
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.
poOtherGeom | the geometry to compare to this geometry. |
Reimplemented from OGRGeometry.
|
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().
Implements OGRGeometry.