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

#include <ogr_geometry.h>

Inheritance diagram for OGRPoint:
OGRGeometry

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...
 
OGRPointoperator= (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
 
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 OGRGeometryclone () const override
 Make a copy of this object. More...
 
virtual void empty () override
 Clear geometry information. This restores the geometry to its initial state after construction, and before assignment of actual geometry. 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
 Fetch X coordinate. More...
 
double getY () const
 Fetch Y coordinate. More...
 
double getZ () const
 Fetch Z coordinate. More...
 
double getM () const
 
virtual void setCoordinateDimension (int nDimension) override
 Set the coordinate dimension. More...
 
void setX (double xIn)
 Assign point X coordinate. More...
 
void setY (double yIn)
 Assign point Y coordinate. More...
 
void setZ (double zIn)
 Assign point Z coordinate. Calling this method will force the geometry coordinate dimension to 3D (wkbPoint|wkbZ). More...
 
void setM (double mIn)
 
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. In a sense this converts all Z coordinates to 0.0. More...
 
virtual void accept (IOGRGeometryVisitor *visitor) override
 
virtual void accept (IOGRConstGeometryVisitor *visitor) const override
 
virtual void swapXY () override
 Swap x and y coordinates. More...
 
virtual OGRErr importFromWkt (const char **ppszInput)=0
 Assign geometry from well known text data. More...
 
OGRErr importFromWkt (char **ppszInput) CPL_WARN_DEPRECATED("Use importFromWkt( const char**) instead")
 
- Public Member Functions inherited from OGRGeometry
 OGRGeometry (const OGRGeometry &other)
 Copy constructor. More...
 
OGRGeometryoperator= (const OGRGeometry &other)
 Assignment operator. More...
 
bool operator== (const OGRGeometry &other) const
 
bool operator!= (const OGRGeometry &other) const
 
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")
 
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
 
virtual OGRBoolean hasCurveGeometry (int bLookForNonLinear=FALSE) const
 Returns if this geometry is or has curve geometry. More...
 
virtual OGRGeometrygetCurveGeometry (const char *const *papszOptions=nullptr) const CPL_WARN_UNUSED_RESULT
 Return curve version of this geometry. More...
 
virtual OGRGeometrygetLinearGeometry (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...
 
OGRSpatialReferencegetSpatialReference (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 OGRGeometryBoundary () const CPL_WARN_UNUSED_RESULT
 Compute boundary. More...
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries. More...
 
virtual OGRGeometryConvexHull () const CPL_WARN_UNUSED_RESULT
 Compute convex hull. More...
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT
 Compute buffer of geometry. More...
 
virtual OGRGeometryIntersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute intersection. More...
 
virtual OGRGeometryUnion (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute union. More...
 
virtual OGRGeometryUnionCascaded () const CPL_WARN_UNUSED_RESULT
 Compute union using cascading. More...
 
virtual OGRGeometryDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute difference. More...
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute symmetric difference. More...
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid. More...
 
virtual OGRGeometrySimplify (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry. More...
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry while preserving topology. More...
 
virtual OGRGeometryDelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT
 Return a Delaunay triangulation of the vertices of the geometry. More...
 
virtual OGRGeometryPolygonize () 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...
 
OGRPointtoPoint ()
 
const OGRPointtoPoint () const
 
OGRCurvetoCurve ()
 
const OGRCurvetoCurve () const
 
OGRSimpleCurvetoSimpleCurve ()
 
const OGRSimpleCurvetoSimpleCurve () const
 
OGRLineStringtoLineString ()
 
const OGRLineStringtoLineString () const
 
OGRLinearRingtoLinearRing ()
 
const OGRLinearRingtoLinearRing () const
 
OGRCircularStringtoCircularString ()
 
const OGRCircularStringtoCircularString () const
 
OGRCompoundCurvetoCompoundCurve ()
 
const OGRCompoundCurvetoCompoundCurve () const
 
OGRSurfacetoSurface ()
 
const OGRSurfacetoSurface () const
 
OGRPolygontoPolygon ()
 
const OGRPolygontoPolygon () const
 
OGRTriangletoTriangle ()
 
const OGRTriangletoTriangle () const
 
OGRCurvePolygontoCurvePolygon ()
 
const OGRCurvePolygontoCurvePolygon () const
 
OGRGeometryCollectiontoGeometryCollection ()
 
const OGRGeometryCollectiontoGeometryCollection () const
 
OGRMultiPointtoMultiPoint ()
 
const OGRMultiPointtoMultiPoint () const
 
OGRMultiLineStringtoMultiLineString ()
 
const OGRMultiLineStringtoMultiLineString () const
 
OGRMultiPolygontoMultiPolygon ()
 
const OGRMultiPolygontoMultiPolygon () const
 
OGRMultiCurvetoMultiCurve ()
 
const OGRMultiCurvetoMultiCurve () const
 
OGRMultiSurfacetoMultiSurface ()
 
const OGRMultiSurfacetoMultiSurface () const
 
OGRPolyhedralSurfacetoPolyhedralSurface ()
 
const OGRPolyhedralSurfacetoPolyhedralSurface () const
 
OGRTriangulatedSurfacetoTriangulatedSurface ()
 
const OGRTriangulatedSurfacetoTriangulatedSurface () const
 

Additional Inherited Members

- Static Public Member Functions inherited from OGRGeometry
static GEOSContextHandle_t createGEOSContext ()
 
static void freeGEOSContext (GEOSContextHandle_t hGEOSCtxt)
 
static OGRGeometryH ToHandle (OGRGeometry *poGeom)
 
static OGRGeometryFromHandle (OGRGeometryH hGeom)
 

Detailed Description

Point class.

Implements SFCOM IPoint methods.

Constructor & Destructor Documentation

◆ OGRPoint() [1/4]

OGRPoint::OGRPoint ( double  xIn,
double  yIn 
)

Create a point.

Parameters
xInx
yIny

◆ OGRPoint() [2/4]

OGRPoint::OGRPoint ( double  xIn,
double  yIn,
double  zIn 
)

Create a point.

Parameters
xInx
yIny
zInz

◆ OGRPoint() [3/4]

OGRPoint::OGRPoint ( double  xIn,
double  yIn,
double  zIn,
double  mIn 
)

Create a point.

Parameters
xInx
yIny
zInz
mInm

◆ OGRPoint() [4/4]

OGRPoint::OGRPoint ( const OGRPoint 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 OGRPoint::accept ( IOGRConstGeometryVisitor visitor) const
inlineoverridevirtual

Accept a visitor.

Implements OGRGeometry.

References IOGRConstGeometryVisitor::visit().

◆ accept() [2/2]

virtual void OGRPoint::accept ( IOGRGeometryVisitor visitor)
inlineoverridevirtual

Accept a visitor.

Implements OGRGeometry.

References IOGRGeometryVisitor::visit().

◆ clone()

OGRGeometry * OGRPoint::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.

References OGRGeometry::assignSpatialReference(), OGRGeometry::getSpatialReference(), and OGRPoint().

◆ empty()

void OGRPoint::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 OGRPoint::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.

References OGRGeometry::getGeometryType(), getGeometryType(), getX(), getY(), getZ(), IsEmpty(), and OGRGeometry::toPoint().

Referenced by OGRGeometryFactory::forceToLineString().

◆ exportToWkb()

OGRErr OGRPoint::exportToWkb ( OGRwkbByteOrder  eByteOrder,
unsigned char *  pabyData,
OGRwkbVariant  eWkbVariant = wkbVariantOldOgc 
) const
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.

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.

< Success

Implements OGRGeometry.

References CPL_LSBPTR32, CPL_MSBPTR32, CPL_SWAPDOUBLE, getGeometryType(), OGRGeometry::getIsoGeometryType(), OGRGeometry::Is3D(), IsEmpty(), OGRGeometry::IsMeasured(), OGRERR_NONE, wkbFlatten, wkbNDR, wkbVariantIso, and wkbVariantPostGIS1.

◆ exportToWkt()

OGRErr OGRPoint::exportToWkt ( char **  ppszDstText,
OGRwkbVariant  eWkbVariant = wkbVariantOldOgc 
) const
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().

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

< Success

Implements OGRGeometry.

References CPLStrdup(), OGRGeometry::Is3D(), IsEmpty(), OGRGeometry::IsMeasured(), OGRERR_NONE, and wkbVariantIso.

◆ flattenTo2D()

void OGRPoint::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.

References OGRGeometry::setMeasured().

Referenced by setCoordinateDimension().

◆ getDimension()

int OGRPoint::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.

◆ getEnvelope() [1/2]

void OGRPoint::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.

References getX(), and getY().

◆ getEnvelope() [2/2]

void OGRPoint::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.

References getX(), getY(), and getZ().

◆ getGeometryName()

const char * OGRPoint::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.

◆ getGeometryType()

OGRwkbGeometryType OGRPoint::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.

References wkbPoint, wkbPoint25D, wkbPointM, and wkbPointZM.

Referenced by Equals(), and exportToWkb().

◆ getM()

double OGRPoint::getM ( ) const
inline

◆ getX()

double OGRPoint::getX ( ) const
inline

◆ getY()

double OGRPoint::getY ( ) const
inline

◆ getZ()

double OGRPoint::getZ ( ) const
inline

Fetch Z coordinate.

Return z

Relates to the SFCOM IPoint::get_Z() method.

Returns
the Z coordinate of this point, or zero if it is a 2D point.

Referenced by OGRSimpleCurve::addPoint(), Equals(), OGRCurve::get_IsClosed(), getEnvelope(), OGR_G_GetPoint(), OGR_G_GetPoints(), OGR_G_GetPointsZM(), OGR_G_GetPointZM(), OGR_G_GetZ(), and OGRSimpleCurve::setPoint().

◆ importFromWkb()

OGRErr OGRPoint::importFromWkb ( const unsigned char *  pabyData,
int  nSize,
OGRwkbVariant  eWkbVariant,
int &  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

< Success

< Not enough data to deserialize

< Not enough data to deserialize

< Not enough data to deserialize

< Success

Implements OGRGeometry.

References CPL_SWAPDOUBLE, OGRERR_NONE, OGRERR_NOT_ENOUGH_DATA, and wkbNDR.

◆ importFromWkt() [1/3]

OGRErr OGRGeometry::importFromWkt
inline

Deprecated.

Deprecated:
in GDAL 2.3

◆ importFromWkt() [2/3]

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

deprecated

< Success

< Success

< Corrupt data

< Success

Implements OGRGeometry.

References CPLFree, OGRERR_CORRUPT_DATA, OGRERR_NONE, OGRRawPoint::x, and OGRRawPoint::y.

◆ importFromWkt() [3/3]

OGRErr OGRGeometry::importFromWkt

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.

◆ Intersects()

OGRBoolean OGRPoint::Intersects ( const OGRGeometry poOtherGeom) const
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().

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

Reimplemented from OGRGeometry.

References OGRGeometry::getGeometryType(), OGRGeometry::Intersects(), OGRCurvePolygon::Intersects(), IsEmpty(), OGRGeometry::toCurvePolygon(), wkbCurvePolygon, and wkbFlatten.

◆ IsEmpty()

virtual OGRBoolean OGRPoint::IsEmpty ( ) const
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.

Returns
TRUE if object is empty, otherwise FALSE.

Implements OGRGeometry.

Referenced by Equals(), exportToWkb(), exportToWkt(), Intersects(), OGRLinearRing::isPointInRing(), and Within().

◆ operator=()

OGRPoint & OGRPoint::operator= ( const OGRPoint 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

References OGRGeometry::operator=().

◆ setCoordinateDimension()

void OGRPoint::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.

Reimplemented from OGRGeometry.

References flattenTo2D(), and OGRGeometry::setMeasured().

◆ setM()

void OGRPoint::setM ( double  mIn)
inline

◆ setX()

void OGRPoint::setX ( double  xIn)
inline

◆ setY()

void OGRPoint::setY ( double  yIn)
inline

◆ setZ()

void OGRPoint::setZ ( double  zIn)
inline

Assign point Z coordinate. Calling this method will force the geometry coordinate dimension to 3D (wkbPoint|wkbZ).

Set z

Parameters
zInz

There is no corresponding SFCOM method.

Referenced by OGRSimpleCurve::getPoint(), OGRMultiPoint::importFromWkt(), OGR_G_AddPoint(), OGR_G_AddPointZM(), OGR_G_SetPoint(), OGR_G_SetPointZM(), OGRSimpleCurve::Value(), and OGRCircularString::Value().

◆ swapXY()

void OGRPoint::swapXY ( )
overridevirtual

Swap x and y coordinates.

Since
OGR 1.8.0

Reimplemented from OGRGeometry.

◆ transform()

OGRErr OGRPoint::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 is the same as the C function OGR_G_Transform().

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

< Success

< Failure

Implements OGRGeometry.

References OGRGeometry::assignSpatialReference(), OGRCoordinateTransformation::GetTargetCS(), OGRERR_FAILURE, OGRERR_NONE, and OGRCoordinateTransformation::Transform().

◆ Within()

OGRBoolean OGRPoint::Within ( const OGRGeometry ) const
overridevirtual

Test for containment.

Tests if actual geometry object is within the passed geometry.

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 from OGRGeometry.

References OGRCurvePolygon::Contains(), OGRGeometry::getGeometryType(), IsEmpty(), OGRGeometry::toCurvePolygon(), OGRGeometry::Within(), wkbCurvePolygon, and wkbFlatten.

◆ WkbSize()

int OGRPoint::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:

Generated for GDAL by doxygen 1.8.17.