OGRPoint Class Reference

#include <ogr_geometry.h>

Inheritance diagram for OGRPoint:

OGRGeometry List of all members.

Public Member Functions

 OGRPoint ()
virtual OGRErr importFromWkb (unsigned char *, int=-1)
virtual OGRErr importFromWkt (char **)
virtual void empty ()
void setX (double xIn)
void setY (double yIn)
void setZ (double zIn)
virtual OGRBoolean Equals (OGRGeometry *) const
virtual OGRErr transform (OGRCoordinateTransformation *poCT)
virtual void flattenTo2D ()

Detailed Description

Point class.

Implements SFCOM IPoint methods.


Constructor & Destructor Documentation

OGRPoint::OGRPoint  ) 
 

Create a (0,0) point.


Member Function Documentation

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.

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().

Returns:
TRUE if equivalent or FALSE otherwise.

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.

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().

Parameters:
pabyData the binary input data.
nSize the size of pabyData in bytes, or zero if not known.
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.

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().

Parameters:
ppszInput pointer 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.

Implements OGRGeometry.

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.

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().

Parameters:
poCT the transformation to apply.
Returns:
OGRERR_NONE on success or an error code.

Implements OGRGeometry.


The documentation for this class was generated from the following files:
Generated on Mon Jan 9 18:03:32 2006 for OGR by  doxygen 1.4.6