QGIS API Documentation  2.10.1-Pisa
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsCircularStringV2 Class Reference

Circular string geometry type. More...

#include <qgscircularstringv2.h>

Inheritance diagram for QgsCircularStringV2:
Inheritance graph
[legend]

Public Member Functions

 QgsCircularStringV2 ()
 
 ~QgsCircularStringV2 ()
 
void addToPainterPath (QPainterPath &path) const override
 Adds a curve to a painter path. More...
 
QDomElement asGML2 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override
 Returns a GML2 representation of the geometry. More...
 
QDomElement asGML3 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override
 Returns a GML3 representation of the geometry. More...
 
QString asJSON (int precision=17) const override
 Returns a GeoJSON representation of the geometry. More...
 
unsigned char * asWkb (int &binarySize) const override
 Returns a WKB representation of the geometry. More...
 
QString asWkt (int precision=17) const override
 Returns a WKT representation of the geometry. More...
 
virtual QgsRectangle calculateBoundingBox () const override
 Calculates the minimal bounding box for the geometry. More...
 
virtual void clear () override
 Clears the geometry, ie reset it to a null geometry. More...
 
virtual QgsAbstractGeometryV2clone () const override
 Clones the geometry by performing a deep copy. More...
 
double closestSegment (const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon) const override
 Searches for the closest segment of the geometry to a given point. More...
 
virtual QgsLineStringV2curveToLine () const override
 Returns a new line string geometry corresponding to a segmentized approximation of the curve. More...
 
virtual bool deleteVertex (const QgsVertexId &position) override
 Deletes a vertex within the geometry. More...
 
virtual int dimension () const override
 Returns the inherent dimension of the geometry. More...
 
void draw (QPainter &p) const override
 Draws the geometry using the specified QPainter. More...
 
void drawAsPolygon (QPainter &p) const override
 Draws the curve as a polygon on the specified QPainter. More...
 
virtual QgsPointV2 endPoint () const override
 Returns the end point of the curve. More...
 
virtual bool fromWkb (const unsigned char *wkb) override
 Sets the geometry from a WKB string. More...
 
virtual bool fromWkt (const QString &wkt) override
 Sets the geometry from a WKT string. More...
 
virtual QString geometryType () const override
 Returns a unique string representing the geometry type. More...
 
bool hasCurvedSegments () const override
 Returns true if the geometry contains curved segments. More...
 
virtual bool insertVertex (const QgsVertexId &position, const QgsPointV2 &vertex) override
 Inserts a vertex into the geometry. More...
 
virtual double length () const override
 Returns the length (or perimeter for area geometries) of the geometry. More...
 
virtual bool moveVertex (const QgsVertexId &position, const QgsPointV2 &newPos) override
 Moves a vertex within the geometry. More...
 
int numPoints () const override
 Returns the number of points in the curve. More...
 
bool pointAt (int i, QgsPointV2 &vertex, QgsVertexId::VertexType &type) const override
 Returns the point and vertex id of a point within the curve. More...
 
QgsPointV2 pointN (int i) const
 Returns the point at index i within the circular string. More...
 
void points (QList< QgsPointV2 > &pts) const override
 Returns a list of points within the curve. More...
 
void setPoints (const QList< QgsPointV2 > &points)
 Sets the circular string's points. More...
 
virtual QgsPointV2 startPoint () const override
 Returns the starting point of the curve. More...
 
void sumUpArea (double &sum) const override
 Calculates the area of the curve. More...
 
void transform (const QgsCoordinateTransform &ct) override
 Transforms the geometry using a coordinate transform. More...
 
void transform (const QTransform &t) override
 Transforms the geometry using a QTransform object. More...
 
int wkbSize () const override
 Returns the size of the WKB representation of the geometry. More...
 
- Public Member Functions inherited from QgsCurveV2
 QgsCurveV2 ()
 
virtual ~QgsCurveV2 ()
 
virtual double area () const override
 Returns the area of the geometry. More...
 
virtual void coordinateSequence (QList< QList< QList< QgsPointV2 > > > &coord) const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
virtual bool isClosed () const
 Returns true if the curve is closed. More...
 
virtual bool isRing () const
 Returns true if the curve is a ring. More...
 
virtual bool nextVertex (QgsVertexId &id, QgsPointV2 &vertex) const override
 Returns next vertex id and coordinates. More...
 
QgsAbstractGeometryV2segmentize () const override
 Returns a version of the geometry without curves. More...
 
- Public Member Functions inherited from QgsAbstractGeometryV2
 QgsAbstractGeometryV2 ()
 
 QgsAbstractGeometryV2 (const QgsAbstractGeometryV2 &geom)
 
virtual ~QgsAbstractGeometryV2 ()
 
QgsRectangle boundingBox () const
 Returns the minimal bounding box for the geometry. More...
 
bool is3D () const
 Returns true if the geometry is 3D and contains a z-value. More...
 
bool isEmpty () const
 Returns true if the geometry is empty. More...
 
bool isMeasure () const
 Returns true if the geometry contains m values. More...
 
int nCoordinates () const
 Returns the number of nodes contained in the geometry. More...
 
virtual QgsAbstractGeometryV2operator= (const QgsAbstractGeometryV2 &geom)
 
QgsPointV2 vertexAt (const QgsVertexId &id) const
 Returns the point corresponding to a specified vertex id. More...
 
QgsWKBTypes::Type wkbType () const
 Returns the WKB type of the geometry. More...
 
QString wktTypeStr () const
 Returns the WKT type string of the geometry. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsAbstractGeometryV2
void setZMTypeFromSubGeometry (const QgsAbstractGeometryV2 *subggeom, QgsWKBTypes::Type baseGeomType)
 Updates the geometry type based on whether sub geometries contain z or m values. More...
 
- Static Protected Member Functions inherited from QgsAbstractGeometryV2
static bool readWkbHeader (QgsConstWkbPtr &wkbPtr, QgsWKBTypes::Type &wkbType, bool &endianSwap, QgsWKBTypes::Type expectedType)
 Reads a WKB header and tests its validity. More...
 
- Protected Attributes inherited from QgsAbstractGeometryV2
QgsRectangle mBoundingBox
 
QgsWKBTypes::Type mWkbType
 

Detailed Description

Circular string geometry type.

Note
added in QGIS 2.10
this API is not considered stable and may change for 2.12

Definition at line 30 of file qgscircularstringv2.h.

Constructor & Destructor Documentation

QgsCircularStringV2::QgsCircularStringV2 ( )

Definition at line 29 of file qgscircularstringv2.cpp.

QgsCircularStringV2::~QgsCircularStringV2 ( )

Definition at line 34 of file qgscircularstringv2.cpp.

Member Function Documentation

void QgsCircularStringV2::addToPainterPath ( QPainterPath path) const
overridevirtual

Adds a curve to a painter path.

Implements QgsCurveV2.

Definition at line 623 of file qgscircularstringv2.cpp.

QDomElement QgsCircularStringV2::asGML2 ( QDomDocument doc,
int  precision = 17,
const QString ns = "gml" 
) const
overridevirtual

Returns a GML2 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
See Also
asWkb
asWkt
asGML3
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 270 of file qgscircularstringv2.cpp.

QDomElement QgsCircularStringV2::asGML3 ( QDomDocument doc,
int  precision = 17,
const QString ns = "gml" 
) const
overridevirtual

Returns a GML3 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
See Also
asWkb
asWkt
asGML2
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 279 of file qgscircularstringv2.cpp.

QString QgsCircularStringV2::asJSON ( int  precision = 17) const
overridevirtual

Returns a GeoJSON representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See Also
asWkb
asWkt
asGML2
asGML3

Implements QgsAbstractGeometryV2.

Definition at line 293 of file qgscircularstringv2.cpp.

unsigned char * QgsCircularStringV2::asWkb ( int &  binarySize) const
overridevirtual

Returns a WKB representation of the geometry.

Parameters
binarySizewill be set to the size of the returned WKB string
See Also
wkbSize
asWkt
asGML2
asGML3
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 248 of file qgscircularstringv2.cpp.

QString QgsCircularStringV2::asWkt ( int  precision = 17) const
overridevirtual

Returns a WKT representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See Also
asWkb
asGML2
asGML3
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 261 of file qgscircularstringv2.cpp.

QgsRectangle QgsCircularStringV2::calculateBoundingBox ( ) const
overridevirtual

Calculates the minimal bounding box for the geometry.

Derived classes should override this method to return the correct bounding box.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 53 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::clear ( )
overridevirtual

Clears the geometry, ie reset it to a null geometry.

Implements QgsAbstractGeometryV2.

Definition at line 44 of file qgscircularstringv2.cpp.

QgsAbstractGeometryV2 * QgsCircularStringV2::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometryV2.

Definition at line 39 of file qgscircularstringv2.cpp.

double QgsCircularStringV2::closestSegment ( const QgsPointV2 pt,
QgsPointV2 segmentPt,
QgsVertexId vertexAfter,
bool *  leftOf,
double  epsilon 
) const
overridevirtual

Searches for the closest segment of the geometry to a given point.

Parameters
ptSpecifies the point for search
segmentPtstorage for the closest point within the geometry
vertexAfterstorage for the id of the vertex after the closest segment
leftOfreturns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
epsilonepsilon for segment snapping
Returns
squared distance to closest segment

Implements QgsAbstractGeometryV2.

Definition at line 758 of file qgscircularstringv2.cpp.

QgsLineStringV2 * QgsCircularStringV2::curveToLine ( ) const
overridevirtual

Returns a new line string geometry corresponding to a segmentized approximation of the curve.

Implements QgsCurveV2.

Definition at line 332 of file qgscircularstringv2.cpp.

bool QgsCircularStringV2::deleteVertex ( const QgsVertexId position)
overridevirtual

Deletes a vertex within the geometry.

Parameters
positionvertex id for vertex to delete
Returns
true if delete was successful
See Also
insertVertex
moveVertex

Implements QgsAbstractGeometryV2.

Definition at line 717 of file qgscircularstringv2.cpp.

virtual int QgsCircularStringV2::dimension ( ) const
inlineoverridevirtual

Returns the inherent dimension of the geometry.

For example, this is 0 for a point geometry, 1 for a linestring and 2 for a polygon.

Implements QgsAbstractGeometryV2.

Definition at line 37 of file qgscircularstringv2.h.

void QgsCircularStringV2::draw ( QPainter p) const
overridevirtual

Draws the geometry using the specified QPainter.

Parameters
pdestination QPainter

Implements QgsAbstractGeometryV2.

Definition at line 573 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::drawAsPolygon ( QPainter p) const
overridevirtual

Draws the curve as a polygon on the specified QPainter.

Parameters
pdestination QPainter

Implements QgsCurveV2.

Definition at line 661 of file qgscircularstringv2.cpp.

QgsPointV2 QgsCircularStringV2::endPoint ( ) const
overridevirtual

Returns the end point of the curve.

See Also
startPoint

Implements QgsCurveV2.

Definition at line 323 of file qgscircularstringv2.cpp.

bool QgsCircularStringV2::fromWkb ( const unsigned char *  wkb)
overridevirtual

Sets the geometry from a WKB string.

See Also
fromWkt

Implements QgsAbstractGeometryV2.

Definition at line 186 of file qgscircularstringv2.cpp.

bool QgsCircularStringV2::fromWkt ( const QString wkt)
overridevirtual

Sets the geometry from a WKT string.

See Also
fromWkb

Implements QgsAbstractGeometryV2.

Definition at line 227 of file qgscircularstringv2.cpp.

virtual QString QgsCircularStringV2::geometryType ( ) const
inlineoverridevirtual

Returns a unique string representing the geometry type.

See Also
wkbType
wktTypeStr

Implements QgsAbstractGeometryV2.

Definition at line 36 of file qgscircularstringv2.h.

bool QgsCircularStringV2::hasCurvedSegments ( ) const
inlineoverridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 88 of file qgscircularstringv2.h.

bool QgsCircularStringV2::insertVertex ( const QgsVertexId position,
const QgsPointV2 vertex 
)
overridevirtual

Inserts a vertex into the geometry.

Parameters
positionvertex id for position of inserted vertex
vertexvertex to insert
Returns
true if insert was successful
See Also
moveVertex
deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 666 of file qgscircularstringv2.cpp.

double QgsCircularStringV2::length ( ) const
overridevirtual

Returns the length (or perimeter for area geometries) of the geometry.

See Also
area

Reimplemented from QgsAbstractGeometryV2.

Definition at line 303 of file qgscircularstringv2.cpp.

bool QgsCircularStringV2::moveVertex ( const QgsVertexId position,
const QgsPointV2 newPos 
)
overridevirtual

Moves a vertex within the geometry.

Parameters
positionvertex id for vertex to move
newPosnew position of vertex
Returns
true if move was successful
See Also
insertVertex
deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 696 of file qgscircularstringv2.cpp.

int QgsCircularStringV2::numPoints ( ) const
overridevirtual

Returns the number of points in the curve.

Implements QgsCurveV2.

Definition at line 347 of file qgscircularstringv2.cpp.

bool QgsCircularStringV2::pointAt ( int  i,
QgsPointV2 vertex,
QgsVertexId::VertexType type 
) const
overridevirtual

Returns the point and vertex id of a point within the curve.

Implements QgsCurveV2.

Definition at line 794 of file qgscircularstringv2.cpp.

QgsPointV2 QgsCircularStringV2::pointN ( int  i) const

Returns the point at index i within the circular string.

Definition at line 352 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::points ( QList< QgsPointV2 > &  pt) const
overridevirtual

Returns a list of points within the curve.

Implements QgsCurveV2.

Definition at line 389 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::setPoints ( const QList< QgsPointV2 > &  points)

Sets the circular string's points.

Definition at line 399 of file qgscircularstringv2.cpp.

QgsPointV2 QgsCircularStringV2::startPoint ( ) const
overridevirtual

Returns the starting point of the curve.

See Also
endPoint

Implements QgsCurveV2.

Definition at line 314 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::sumUpArea ( double &  sum) const
overridevirtual

Calculates the area of the curve.

Derived classes should override this to return the correct area of the curve.

Implements QgsCurveV2.

Definition at line 805 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::transform ( const QgsCoordinateTransform ct)
overridevirtual

Transforms the geometry using a coordinate transform.

Parameters
ctcoordinate transform

Implements QgsAbstractGeometryV2.

Definition at line 580 of file qgscircularstringv2.cpp.

void QgsCircularStringV2::transform ( const QTransform t)
overridevirtual

Transforms the geometry using a QTransform object.

Parameters
tQTransform transformation

Implements QgsAbstractGeometryV2.

Definition at line 601 of file qgscircularstringv2.cpp.

int QgsCircularStringV2::wkbSize ( ) const
overridevirtual

Returns the size of the WKB representation of the geometry.

See Also
asWkb

Implements QgsAbstractGeometryV2.

Definition at line 241 of file qgscircularstringv2.cpp.


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