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

#include <ogr_geometry.h>

Inheritance diagram for OGRLineString:
OGRCurve OGRGeometry OGRLinearRing

Public Member Functions

 OGRLineString ()
 Create an empty line string.
 
virtual int WkbSize () const
 Returns size of related binary representation. More...
 
virtual OGRErr importFromWkb (unsigned char *, int=-1)
 Assign geometry from well known binary data. More...
 
virtual OGRErr exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOgc) const
 Convert a geometry into well known binary format. More...
 
virtual OGRErr importFromWkt (char **)
 Assign geometry from well known text data. More...
 
virtual OGRErr exportToWkt (char **ppszDstText) const
 Convert a geometry into well known text format. More...
 
virtual int getDimension () const
 Get the dimension of this object. More...
 
virtual OGRGeometryclone () const
 Make a copy of this object. More...
 
virtual void empty ()
 Clear geometry information. This restores the geometry to it's initial state after construction, and before assignment of actual geometry. More...
 
virtual void getEnvelope (OGREnvelope *psEnvelope) const
 Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...
 
virtual void getEnvelope (OGREnvelope3D *psEnvelope) const
 Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More...
 
virtual OGRBoolean IsEmpty () const
 Returns TRUE (non-zero) if the object has no points. More...
 
virtual double get_Length () const
 Returns the length of the curve. More...
 
virtual void StartPoint (OGRPoint *) const
 Return the curve start point. More...
 
virtual void EndPoint (OGRPoint *) const
 Return the curve end point. More...
 
virtual void Value (double, OGRPoint *) const
 Fetch point at given distance along curve. More...
 
virtual double Project (const OGRPoint *) const
 Project point on linestring. More...
 
virtual OGRLineStringgetSubLine (double, double, int) const
 Get the portion of linestring. More...
 
int getNumPoints () const
 Fetch vertex count. More...
 
void getPoint (int, OGRPoint *) const
 Fetch a point in line string. More...
 
double getX (int i) const
 Get X at vertex. More...
 
double getY (int i) const
 Get Y at vertex. More...
 
double getZ (int i) const
 Get Z at vertex. More...
 
virtual OGRBoolean Equals (OGRGeometry *) const
 Returns TRUE if two geometries are equivalent. More...
 
virtual void setCoordinateDimension (int nDimension)
 Set the coordinate dimension. More...
 
void setNumPoints (int nNewPointCount, int bZeroizeNewContent=TRUE)
 Set number of points in geometry. More...
 
void setPoint (int, OGRPoint *)
 Set the location of a vertex in line string. More...
 
void setPoint (int, double, double, double)
 Set the location of a vertex in line string. More...
 
void setPoints (int, OGRRawPoint *, double *=NULL)
 Assign all points in a line string. More...
 
void setPoints (int, double *padfX, double *padfY, double *padfZ=NULL)
 Assign all points in a line string. More...
 
void addPoint (OGRPoint *)
 Add a point to a line string. More...
 
void addPoint (double, double, double)
 Add a point to a line string. More...
 
void getPoints (OGRRawPoint *, double *=NULL) const
 Returns all points of line string. More...
 
void getPoints (void *pabyX, int nXStride, void *pabyY, int nYStride, void *pabyZ=NULL, int nZStride=0) const
 Returns all points of line string. More...
 
void addSubLineString (const OGRLineString *, int nStartVertex=0, int nEndVertex=-1)
 Add a segment of another linestring to this one. More...
 
void reversePoints (void)
 Reverse point order. More...
 
virtual OGRwkbGeometryType getGeometryType () const
 Fetch geometry type. More...
 
virtual const char * getGeometryName () const
 Fetch WKT name for geometry type. More...
 
virtual OGRErr transform (OGRCoordinateTransformation *poCT)
 Apply arbitrary coordinate transformation to geometry. More...
 
virtual void flattenTo2D ()
 Convert geometry to strictly 2D. In a sense this converts all Z coordinates to 0.0. More...
 
virtual void segmentize (double dfMaxLength)
 Modify the geometry such it has no segment longer then the given distance. More...
 
virtual void swapXY ()
 Swap x and y coordinates. More...
 
- Public Member Functions inherited from OGRCurve
virtual int get_IsClosed () const
 Return TRUE if curve is closed. More...
 
- Public Member Functions inherited from OGRGeometry
virtual int getCoordinateDimension () 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...
 
virtual OGRBoolean IsRing () const
 Test if the geometry is a ring. 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 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 void closeRings ()
 Force rings to be closed. More...
 
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 OGRBoolean Intersects (OGRGeometry *) const
 Do these features intersect? 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 OGRGeometryBoundary () const
 Compute boundary. More...
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries. More...
 
virtual OGRGeometryConvexHull () const
 Compute convex hull. More...
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const
 Compute buffer of geometry. More...
 
virtual OGRGeometryIntersection (const OGRGeometry *) const
 Compute intersection. More...
 
virtual OGRGeometryUnion (const OGRGeometry *) const
 Compute union. More...
 
virtual OGRGeometryUnionCascaded () const
 Compute union using cascading. More...
 
virtual OGRGeometryDifference (const OGRGeometry *) const
 Compute difference. More...
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const
 Compute symmetric difference. More...
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid. More...
 
virtual OGRGeometrySimplify (double dTolerance) const
 Simplify the geometry. More...
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const
 Simplify the geometry while preserving topology. More...
 
virtual OGRGeometryPolygonize () const
 Polygonizes a set of sparse edges. More...
 
virtual OGRGeometrySymmetricDifference (const OGRGeometry *) const CPL_WARN_DEPRECATED("Non standard method. Use SymDifference() instead")
 Compute symmetric difference (deprecated) More...
 
virtual OGRGeometrygetBoundary () const CPL_WARN_DEPRECATED("Non standard method. Use Boundary() instead")
 Compute boundary (deprecated) More...
 

Detailed Description

Concrete representation of a multi-vertex line.

Member Function Documentation

void OGRLineString::addPoint ( OGRPoint poPoint)

Add a point to a line string.

The vertex count of the line string is increased by one, and assigned from the passed location value.

There is no SFCOM analog to this method.

Parameters
poPointthe point to assign to the new vertex.

References OGRGeometry::getCoordinateDimension(), OGRPoint::getX(), OGRPoint::getY(), OGRPoint::getZ(), and setPoint().

Referenced by addPoint(), OGRLinearRing::closeRings(), OGRGeometryFactory::createFromFgf(), getSubLine(), OGRBuildPolygonFromEdges(), and OGRLayer::SetSpatialFilterRect().

void OGRLineString::addPoint ( double  x,
double  y,
double  z 
)

Add a point to a line string.

The vertex count of the line string is increased by one, and assigned from the passed location value.

There is no SFCOM analog to this method.

Parameters
xthe X coordinate to assign to the new point.
ythe Y coordinate to assign to the new point.
zthe Z coordinate to assign to the new point (defaults to zero).

References addPoint(), and setPoint().

void OGRLineString::addSubLineString ( const OGRLineString poOtherLine,
int  nStartVertex = 0,
int  nEndVertex = -1 
)

Add a segment of another linestring to this one.

Adds the request range of vertices to the end of this line string in an efficient manner. If the nStartVertex is larger than the nEndVertex then the vertices will be reversed as they are copied.

Parameters
poOtherLinethe other OGRLineString.
nStartVertexthe first vertex to copy, defaults to 0 to start with the first vertex in the other linestring.
nEndVertexthe last vertex to copy, defaults to -1 indicating the last vertex of the other line string.

References getNumPoints(), and setNumPoints().

Referenced by OGRGeometryFactory::forceToLineString(), and OGRGeometryFactory::forceToMultiLineString().

OGRGeometry * OGRLineString::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().

Returns
a new object instance with the same geometry, and spatial reference system as the original.

Implements OGRGeometry.

Reimplemented in OGRLinearRing.

References OGRGeometry::assignSpatialReference(), OGRGeometry::getCoordinateDimension(), OGRGeometry::getSpatialReference(), OGRLineString(), setCoordinateDimension(), and setPoints().

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

References setNumPoints().

Referenced by importFromWkt().

void OGRLineString::EndPoint ( OGRPoint poPoint) const
virtual

Return the curve end point.

This method relates to the SF COM ICurve::get_EndPoint() method.

Parameters
poPointthe point to be assigned the end location.

Implements OGRCurve.

References getPoint().

Referenced by OGRGeometryFactory::forceToLineString(), and Value().

OGRBoolean OGRLineString::Equals ( OGRGeometry poOtherGeom) const
virtual

Returns TRUE if two geometries are equivalent.

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(), getNumPoints(), getX(), getY(), getZ(), OGRGeometry::IsEmpty(), and IsEmpty().

Referenced by OGRPolygon::Equals().

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

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 wkbVariantOgc 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.

Implements OGRGeometry.

Reimplemented in OGRLinearRing.

References OGRGeometry::getCoordinateDimension(), getGeometryType(), and wkbVariantIso.

OGRErr OGRLineString::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().

Parameters
ppszDstTexta text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with OGRFree().
Returns
Currently OGRERR_NONE is always returned.

Implements OGRGeometry.

References CPLDebug(), CPLStrdup(), OGRGeometry::getCoordinateDimension(), getGeometryName(), and IsEmpty().

Referenced by OGRPolygon::exportToWkt().

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

double OGRLineString::get_Length ( ) const
virtual

Returns the length of the curve.

This method relates to the SFCOM ICurve::get_Length() method.

Returns
the length of the curve, zero if the curve hasn't been initialized.

Implements OGRCurve.

Referenced by getSubLine().

int OGRLineString::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().

Returns
0 for points, 1 for lines and 2 for surfaces.

Implements OGRGeometry.

void OGRLineString::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().

Parameters
psEnvelopethe structure in which to place the results.

Implements OGRGeometry.

References IsEmpty().

Referenced by OGRLinearRing::get_Area(), getEnvelope(), and OGRPolygon::getEnvelope().

void OGRLineString::getEnvelope ( OGREnvelope3D psEnvelope) const
virtual

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 getEnvelope(), and IsEmpty().

const char * OGRLineString::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().

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.

Reimplemented in OGRLinearRing.

Referenced by exportToWkt(), and importFromWkt().

OGRwkbGeometryType OGRLineString::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().

Returns
the geometry type code.

Implements OGRGeometry.

References wkbLineString, and wkbLineString25D.

Referenced by Equals(), and exportToWkb().

int OGRLineString::getNumPoints ( ) const
inline
void OGRLineString::getPoint ( int  i,
OGRPoint poPoint 
) const

Fetch a point in line string.

This method relates to the SFCOM ILineString::get_Point() method.

Parameters
ithe vertex to fetch, from 0 to getNumPoints()-1.
poPointa point to initialize with the fetched point.

References OGRGeometry::getCoordinateDimension(), OGRPoint::setX(), OGRPoint::setY(), and OGRPoint::setZ().

Referenced by OGRLinearRing::closeRings(), EndPoint(), OGRLinearRing::isClockwise(), OGRGeometryFactory::organizePolygons(), and StartPoint().

void OGRLineString::getPoints ( OGRRawPoint paoPointsOut,
double *  padfZ = NULL 
) const

Returns all points of line string.

This method copies all points into user list. This list must be at least sizeof(OGRRawPoint) * OGRGeometry::getNumPoints() byte in size. It also copies all Z coordinates.

There is no SFCOM analog to this method.

Parameters
paoPointsOuta buffer into which the points is written.
padfZthe Z values that go with the points (optional, may be NULL).

Referenced by getPoints(), and OGR_G_GetPoints().

void OGRLineString::getPoints ( void *  pabyX,
int  nXStride,
void *  pabyY,
int  nYStride,
void *  pabyZ = NULL,
int  nZStride = 0 
) const

Returns all points of line string.

This method copies all points into user arrays. The user provides the stride between 2 consecutives elements of the array.

On some CPU architectures, care must be taken so that the arrays are properly aligned.

There is no SFCOM analog to this method.

Parameters
pabyXa buffer of at least (sizeof(double) * nXStride * nPointCount) bytes, may be NULL.
nXStridethe number of bytes between 2 elements of pabyX.
pabyYa buffer of at least (sizeof(double) * nYStride * nPointCount) bytes, may be NULL.
nYStridethe number of bytes between 2 elements of pabyY.
pabyZa buffer of at last size (sizeof(double) * nZStride * nPointCount) bytes, may be NULL.
nZStridethe number of bytes between 2 elements of pabyZ.
Since
OGR 1.9.0

References getPoints().

OGRLineString * OGRLineString::getSubLine ( double  dfDistanceFrom,
double  dfDistanceTo,
int  bAsRatio 
) const
virtual

Get the portion of linestring.

The portion of the linestring extracted to new one. The input distances (maybe present as ratio of length of linestring) set begin and end of extracted portion.

Parameters
dfDistanceFromThe distance from the origin of linestring, where the subline should begins
dfDistanceToThe distance from the origin of linestring, where the subline should ends
bAsRatioThe flag indicating that distances are the ratio of the linestring length.
Returns
a newly allocated linestring now owned by the caller, or NULL on failure.
Since
OGR 1.11.0

References addPoint(), OGRGeometry::assignSpatialReference(), CPLError(), get_Length(), OGRGeometry::getCoordinateDimension(), getNumPoints(), OGRGeometry::getSpatialReference(), OGRLineString(), and setCoordinateDimension().

double OGRLineString::getX ( int  iVertex) const
inline

Get X at vertex.

Returns the X value at the indicated vertex. If iVertex is out of range a crash may occur, no internal range checking is performed.

Parameters
iVertexthe vertex to return, between 0 and getNumPoints()-1.
Returns
X value.

Referenced by OGRLinearRing::closeRings(), OGRGeometryFactory::createFromFgf(), Equals(), OGRLinearRing::get_Area(), OGR_G_GetPoint(), OGR_G_GetX(), OGR_L_SetSpatialFilterRectEx(), and OGRBuildPolygonFromEdges().

double OGRLineString::getY ( int  iVertex) const
inline

Get Y at vertex.

Returns the Y value at the indicated vertex. If iVertex is out of range a crash may occur, no internal range checking is performed.

Parameters
iVertexthe vertex to return, between 0 and getNumPoints()-1.
Returns
X value.

Referenced by OGRLinearRing::closeRings(), OGRGeometryFactory::createFromFgf(), Equals(), OGRLinearRing::get_Area(), OGR_G_GetPoint(), OGR_G_GetY(), OGR_L_SetSpatialFilterRectEx(), and OGRBuildPolygonFromEdges().

double OGRLineString::getZ ( int  iVertex) const

Get Z at vertex.

Returns the Z (elevation) value at the indicated vertex. If no Z value is available, 0.0 is returned. If iVertex is out of range a crash may occur, no internal range checking is performed.

Parameters
iVertexthe vertex to return, between 0 and getNumPoints()-1.
Returns
Z value.

Referenced by OGRLinearRing::closeRings(), OGRGeometryFactory::createFromFgf(), Equals(), OGR_G_GetPoint(), OGR_G_GetZ(), and OGRBuildPolygonFromEdges().

OGRErr OGRLineString::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
pabyDatathe binary input data.
nSizethe 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.

Reimplemented in OGRLinearRing.

References CPLError(), setNumPoints(), and wkbLineString.

OGRErr OGRLineString::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
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.

Implements OGRGeometry.

References empty(), and getGeometryName().

OGRBoolean OGRLineString::IsEmpty ( ) const
virtual

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(), exportToWkt(), and getEnvelope().

double OGRLineString::Project ( const OGRPoint poPoint) const
virtual

Project point on linestring.

The input point projeted on linestring. This is the shortest distance from point to the linestring. The distance from begin of linestring to the point projection returned.

This method is built on the GEOS library (GEOS >= 3.2.0), check it for the definition of the geometry operation. If OGR is built without the GEOS library, this method will always return -1, issuing a CPLE_NotSupported error.

Returns
a distance from the begin of the linestring to the projected point.
Since
OGR 1.11.0

References CPLError().

void OGRLineString::reversePoints ( void  )

Reverse point order.

This method updates the points in this line string in place reversing the point ordering (first for last, etc).

Referenced by OGRGeometryFactory::forceToLineString().

void OGRLineString::segmentize ( double  dfMaxLength)
virtual

Modify the geometry such it has no segment longer then the given distance.

Interpolated points will have Z and M values (if needed) set to 0. Distance computation is performed in 2d only

This function is the same as the C function OGR_G_Segmentize()

Parameters
dfMaxLengththe maximum distance between 2 points after segmentization

Reimplemented from OGRGeometry.

References CPLError(), and OGRGeometry::getCoordinateDimension().

void OGRLineString::setCoordinateDimension ( int  nNewDimension)
virtual

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 will not necessarily affect the children geometries.

Parameters
nNewDimensionNew coordinate dimension value, either 2 or 3.

Reimplemented from OGRGeometry.

Referenced by clone(), OGRPolygon::exportToWkt(), and getSubLine().

void OGRLineString::setNumPoints ( int  nNewPointCount,
int  bZeroizeNewContent = TRUE 
)

Set number of points in geometry.

This method primary exists to preset the number of points in a linestring geometry before setPoint() is used to assign them to avoid reallocating the array larger with each call to addPoint().

This method has no SFCOM analog.

Parameters
nNewPointCountthe new number of points for geometry.

References CPLError(), and OGRGeometry::getCoordinateDimension().

Referenced by addSubLineString(), OGRGeometryFactory::createFromFgf(), empty(), OGRLinearRing::exportToWkb(), importFromWkb(), OGR_G_SetPointCount(), OGR_G_SetPoints(), setPoint(), and setPoints().

void OGRLineString::setPoint ( int  iPoint,
OGRPoint poPoint 
)

Set the location of a vertex in line string.

If iPoint is larger than the number of necessary the number of existing points in the line string, the point count will be increased to accommodate the request.

There is no SFCOM analog to this method.

Parameters
iPointthe index of the vertex to assign (zero based).
poPointthe value to assign to the vertex.

References OGRGeometry::getCoordinateDimension(), OGRPoint::getX(), OGRPoint::getY(), and OGRPoint::getZ().

Referenced by addPoint(), OGRGeometryFactory::approximateArcAngles(), OGRGeometryFactory::createFromFgf(), OGRLinearRing::isClockwise(), OGR_G_SetPoints(), and setPoint().

void OGRLineString::setPoint ( int  iPoint,
double  xIn,
double  yIn,
double  zIn 
)

Set the location of a vertex in line string.

If iPoint is larger than the number of necessary the number of existing points in the line string, the point count will be increased to accommodate the request.

There is no SFCOM analog to this method.

Parameters
iPointthe index of the vertex to assign (zero based).
xIninput X coordinate to assign.
yIninput Y coordinate to assign.
zIninput Z coordinate to assign (defaults to zero).

References OGRGeometry::getCoordinateDimension(), setNumPoints(), and setPoint().

void OGRLineString::setPoints ( int  nPointsIn,
OGRRawPoint paoPointsIn,
double *  padfZ = NULL 
)

Assign all points in a line string.

This method clears any existing points assigned to this line string, and assigns a whole new set. It is the most efficient way of assigning the value of a line string.

There is no SFCOM analog to this method.

Parameters
nPointsInnumber of points being passed in paoPointsIn
paoPointsInlist of points being assigned.
padfZthe Z values that go with the points (optional, may be NULL).

References OGRGeometry::getCoordinateDimension(), and setNumPoints().

Referenced by clone(), OGRLinearRing::clone(), OGRPolygon::importFromWkt(), OGRMultiPolygon::importFromWkt(), OGRMultiLineString::importFromWkt(), OGR_G_SetPoints(), and transform().

void OGRLineString::setPoints ( int  nPointsIn,
double *  padfX,
double *  padfY,
double *  padfZ = NULL 
)

Assign all points in a line string.

This method clear any existing points assigned to this line string, and assigns a whole new set.

There is no SFCOM analog to this method.

Parameters
nPointsInnumber of points being passed in padfX and padfY.
padfXlist of X coordinates of points being assigned.
padfYlist of Y coordinates of points being assigned.
padfZlist of Z coordinates of points being assigned (defaults to NULL for 2D objects).

References setNumPoints().

void OGRLineString::StartPoint ( OGRPoint poPoint) const
virtual

Return the curve start point.

This method relates to the SF COM ICurve::get_StartPoint() method.

Parameters
poPointthe point to be assigned the start location.

Implements OGRCurve.

References getPoint().

Referenced by OGRGeometryFactory::forceToLineString(), and Value().

void OGRLineString::swapXY ( )
virtual

Swap x and y coordinates.

Since
OGR 1.8.0

Reimplemented from OGRGeometry.

OGRErr OGRLineString::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
poCTthe transformation to apply.
Returns
OGRERR_NONE on success or an error code.

Implements OGRGeometry.

References OGRGeometry::assignSpatialReference(), CPLError(), CPLGetConfigOption(), CSLTestBoolean(), OGRCoordinateTransformation::GetTargetCS(), setPoints(), and OGRCoordinateTransformation::TransformEx().

Referenced by OGRPolygon::transform().

void OGRLineString::Value ( double  dfDistance,
OGRPoint poPoint 
) const
virtual

Fetch point at given distance along curve.

This method relates to the SF COM ICurve::get_Value() method.

Parameters
dfDistancedistance along the curve at which to sample position. This distance should be between zero and get_Length() for this curve.
poPointthe point to be assigned the curve position.

Implements OGRCurve.

References EndPoint(), OGRGeometry::getCoordinateDimension(), OGRPoint::setX(), OGRPoint::setY(), OGRPoint::setZ(), and StartPoint().

int OGRLineString::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().

Returns
size of binary representation in bytes.

Implements OGRGeometry.

Reimplemented in OGRLinearRing.

References OGRGeometry::getCoordinateDimension().


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

Generated for GDAL by doxygen 1.8.11.