#include <ogr_geometry.h>
Inheritance diagram for OGRPoint:
Public Member Functions | |
OGRPoint () | |
virtual int | WkbSize () const |
virtual OGRErr | importFromWkb (unsigned char *, int=-1) |
virtual OGRErr | exportToWkb (OGRwkbByteOrder, unsigned char *) const |
virtual OGRErr | importFromWkt (char **) |
virtual OGRErr | exportToWkt (char **ppszDstText) const |
virtual int | getDimension () const |
virtual OGRGeometry * | clone () const |
virtual void | empty () |
virtual void | getEnvelope (OGREnvelope *psEnvelope) const |
double | getX () const |
double | getY () const |
double | getZ () const |
void | setX (double xIn) |
void | setY (double yIn) |
void | setZ (double zIn) |
virtual OGRBoolean | Equals (OGRGeometry *) const |
virtual const char * | getGeometryName () const |
virtual OGRwkbGeometryType | getGeometryType () const |
virtual OGRErr | transform (OGRCoordinateTransformation *poCT) |
virtual void | flattenTo2D () |
Implements SFCOM IPoint methods.
OGRPoint::OGRPoint | ( | ) |
Create a (0,0) point.
int OGRPoint::WkbSize | ( | ) | const [virtual] |
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.
OGRErr OGRPoint::importFromWkb | ( | unsigned char * | pabyData, | |
int | nSize = -1 | |||
) | [virtual] |
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 zero if not known. |
Implements OGRGeometry.
OGRErr OGRPoint::exportToWkb | ( | OGRwkbByteOrder | eByteOrder, | |
unsigned char * | pabyData | |||
) | const [virtual] |
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().
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. |
Implements OGRGeometry.
OGRErr OGRPoint::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().
ppszInput | pointer to a pointer to the source text. The pointer is updated to pointer after the consumed text. |
Implements OGRGeometry.
OGRErr OGRPoint::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().
ppszDstText | a text buffer is allocated by the program, and assigned to the passed pointer. |
Implements OGRGeometry.
int OGRPoint::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().
Implements OGRGeometry.
OGRGeometry * OGRPoint::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().
Implements OGRGeometry.
void OGRPoint::empty | ( | ) | [virtual] |
Clear geometry information. This restores the geometry to it's 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.
void OGRPoint::getEnvelope | ( | OGREnvelope * | psEnvelope | ) | const [virtual] |
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.
double OGRPoint::getX | ( | ) | const [inline] |
Fetch X coordinate.
Relates to the SFCOM IPoint::get_X() method.
double OGRPoint::getY | ( | ) | const [inline] |
Fetch Y coordinate.
Relates to the SFCOM IPoint::get_Y() method.
double OGRPoint::getZ | ( | ) | const [inline] |
Fetch Z coordinate.
Relates to the SFCOM IPoint::get_Z() method.
void OGRPoint::setX | ( | double | xIn | ) | [inline] |
Assign point X coordinate.
There is no corresponding SFCOM method.
void OGRPoint::setY | ( | double | yIn | ) | [inline] |
Assign point Y coordinate.
There is no corresponding SFCOM method.
void OGRPoint::setZ | ( | double | zIn | ) | [inline] |
Assign point Z coordinate. Setting a zero zIn value will make the point 2D, and setting a non-zero value will make the point 3D (wkbPoint|wkbZ).
There is no corresponding SFCOM method.
OGRBoolean OGRPoint::Equals | ( | OGRGeometry * | poOther | ) | const [virtual] |
Returns two if two geometries are equivalent.
This method is the same as the C function OGR_G_Equal().
Implements OGRGeometry.
const char * OGRPoint::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().
Implements OGRGeometry.
OGRwkbGeometryType OGRPoint::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().
Implements OGRGeometry.
OGRErr OGRPoint::transform | ( | OGRCoordinateTransformation * | poCT | ) | [virtual] |
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.
void OGRPoint::flattenTo2D | ( | ) | [virtual] |
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.