QGIS API Documentation  2.12.0-Lyon
Public Member Functions | List of all members
QgsCurveV2 Class Referenceabstract

Abstract base class for curved geometry type. More...

#include <qgscurvev2.h>

Inheritance diagram for QgsCurveV2:
Inheritance graph
[legend]

Public Member Functions

 QgsCurveV2 ()
 
virtual ~QgsCurveV2 ()
 
virtual void addToPainterPath (QPainterPath &path) const =0
 Adds a curve to a painter path. More...
 
virtual void coordinateSequence (QList< QList< QList< QgsPointV2 > > > &coord) const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
virtual QgsLineStringV2curveToLine () const =0
 Returns a new line string geometry corresponding to a segmentized approximation of the curve. More...
 
virtual void drawAsPolygon (QPainter &p) const =0
 Draws the curve as a polygon on the specified QPainter. More...
 
virtual QgsPointV2 endPoint () const =0
 Returns the end point of the curve. 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...
 
virtual int numPoints () const =0
 Returns the number of points in the curve. More...
 
virtual int partCount () const override
 
virtual bool pointAt (int i, QgsPointV2 &vertex, QgsVertexId::VertexType &type) const =0
 Returns the point and vertex id of a point within the curve. More...
 
virtual void points (QList< QgsPointV2 > &pt) const =0
 Returns a list of points within the curve. More...
 
virtual int ringCount (int=0) const override
 
QgsAbstractGeometryV2segmentize () const override
 Returns a version of the geometry without curves. More...
 
virtual QgsPointV2 startPoint () const =0
 Returns the starting point of the curve. More...
 
virtual void sumUpArea (double &sum) const =0
 Calculates the area of the curve. More...
 
virtual QgsPointV2 vertexAt (const QgsVertexId &id) const override
 Returns the point corresponding to a specified vertex id. More...
 
virtual int vertexCount (int=0, int=0) const override
 
- Public Member Functions inherited from QgsAbstractGeometryV2
 QgsAbstractGeometryV2 ()
 
 QgsAbstractGeometryV2 (const QgsAbstractGeometryV2 &geom)
 
virtual ~QgsAbstractGeometryV2 ()
 
virtual bool addMValue (double mValue=0)=0
 Adds a measure to the geometry, initialized to a preset value. More...
 
virtual bool addZValue (double zValue=0)=0
 Adds a z-dimension to the geometry, initialized to a preset value. More...
 
virtual double area () const
 Returns the area of the geometry. More...
 
virtual QDomElement asGML2 (QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
 Returns a GML2 representation of the geometry. More...
 
virtual QDomElement asGML3 (QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
 Returns a GML3 representation of the geometry. More...
 
virtual QString asJSON (int precision=17) const =0
 Returns a GeoJSON representation of the geometry. More...
 
virtual unsigned char * asWkb (int &binarySize) const =0
 Returns a WKB representation of the geometry. More...
 
virtual QString asWkt (int precision=17) const =0
 Returns a WKT representation of the geometry. More...
 
QgsRectangle boundingBox () const
 Returns the minimal bounding box for the geometry. More...
 
virtual QgsRectangle calculateBoundingBox () const
 Calculates the minimal bounding box for the geometry. More...
 
virtual QgsPointV2 centroid () const
 Returns the centroid of the geometry. More...
 
virtual void clear ()=0
 Clears the geometry, ie reset it to a null geometry. More...
 
virtual QgsAbstractGeometryV2clone () const =0
 Clones the geometry by performing a deep copy. More...
 
virtual double closestSegment (const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon) const =0
 Searches for the closest segment of the geometry to a given point. More...
 
virtual bool deleteVertex (const QgsVertexId &position)=0
 Deletes a vertex within the geometry. More...
 
virtual int dimension () const =0
 Returns the inherent dimension of the geometry. More...
 
virtual void draw (QPainter &p) const =0
 Draws the geometry using the specified QPainter. More...
 
virtual bool fromWkb (const unsigned char *wkb)=0
 Sets the geometry from a WKB string. More...
 
virtual bool fromWkt (const QString &wkt)=0
 Sets the geometry from a WKT string. More...
 
virtual QString geometryType () const =0
 Returns a unique string representing the geometry type. More...
 
virtual bool hasCurvedSegments () const
 Returns true if the geometry contains curved segments. More...
 
virtual bool insertVertex (const QgsVertexId &position, const QgsPointV2 &vertex)=0
 Inserts a vertex into 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...
 
virtual double length () const
 Returns the length of the geometry. More...
 
virtual bool moveVertex (const QgsVertexId &position, const QgsPointV2 &newPos)=0
 Moves a vertex within the geometry. More...
 
int nCoordinates () const
 Returns the number of nodes contained in the geometry. More...
 
virtual QgsAbstractGeometryV2operator= (const QgsAbstractGeometryV2 &geom)
 
virtual double perimeter () const
 Returns the perimeter of the geometry. More...
 
virtual void transform (const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform)=0
 Transforms the geometry using a coordinate transform. More...
 
virtual void transform (const QTransform &t)=0
 Transforms the geometry using a QTransform object. More...
 
virtual double vertexAngle (const QgsVertexId &vertex) const =0
 Returns approximate rotation angle for a vertex. More...
 
virtual int wkbSize () const =0
 Returns the size of the WKB representation of the geometry. 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

Abstract base class for curved geometry type.

Note
added in QGIS 2.10

Definition at line 32 of file qgscurvev2.h.

Constructor & Destructor Documentation

QgsCurveV2::QgsCurveV2 ( )

Definition at line 21 of file qgscurvev2.cpp.

QgsCurveV2::~QgsCurveV2 ( )
virtual

Definition at line 24 of file qgscurvev2.cpp.

Member Function Documentation

virtual void QgsCurveV2::addToPainterPath ( QPainterPath path) const
pure virtual

Adds a curve to a painter path.

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

void QgsCurveV2::coordinateSequence ( QList< QList< QList< QgsPointV2 > > > &  coord) const
overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Parameters
coorddestination for coordinate sequence.

Implements QgsAbstractGeometryV2.

Definition at line 45 of file qgscurvev2.cpp.

virtual QgsLineStringV2* QgsCurveV2::curveToLine ( ) const
pure virtual

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

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

virtual void QgsCurveV2::drawAsPolygon ( QPainter p) const
pure virtual

Draws the curve as a polygon on the specified QPainter.

Parameters
pdestination QPainter

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

virtual QgsPointV2 QgsCurveV2::endPoint ( ) const
pure virtual

Returns the end point of the curve.

See also
startPoint

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

bool QgsCurveV2::isClosed ( ) const
virtual

Returns true if the curve is closed.

Definition at line 27 of file qgscurvev2.cpp.

bool QgsCurveV2::isRing ( ) const
virtual

Returns true if the curve is a ring.

Definition at line 40 of file qgscurvev2.cpp.

bool QgsCurveV2::nextVertex ( QgsVertexId id,
QgsPointV2 vertex 
) const
overridevirtual

Returns next vertex id and coordinates.

Parameters
idinitial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertexcontainer for found node
Returns
false if at end

Implements QgsAbstractGeometryV2.

Definition at line 55 of file qgscurvev2.cpp.

virtual int QgsCurveV2::numPoints ( ) const
pure virtual

Returns the number of points in the curve.

Implemented in QgsCompoundCurveV2, QgsLineStringV2, and QgsCircularStringV2.

virtual int QgsCurveV2::partCount ( ) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 94 of file qgscurvev2.h.

virtual bool QgsCurveV2::pointAt ( int  i,
QgsPointV2 vertex,
QgsVertexId::VertexType type 
) const
pure virtual

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

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

virtual void QgsCurveV2::points ( QList< QgsPointV2 > &  pt) const
pure virtual

Returns a list of points within the curve.

Implemented in QgsCircularStringV2, QgsLineStringV2, and QgsCompoundCurveV2.

virtual int QgsCurveV2::ringCount ( int  = 0) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 93 of file qgscurvev2.h.

QgsAbstractGeometryV2 * QgsCurveV2::segmentize ( ) const
overridevirtual

Returns a version of the geometry without curves.

Caller takes ownership of the returned geometry.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 80 of file qgscurvev2.cpp.

virtual QgsPointV2 QgsCurveV2::startPoint ( ) const
pure virtual

Returns the starting point of the curve.

See also
endPoint

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

virtual void QgsCurveV2::sumUpArea ( double &  sum) const
pure virtual

Calculates the area of the curve.

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

Implemented in QgsCircularStringV2, QgsCompoundCurveV2, and QgsLineStringV2.

QgsPointV2 QgsCurveV2::vertexAt ( const QgsVertexId id) const
overridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometryV2.

Definition at line 85 of file qgscurvev2.cpp.

virtual int QgsCurveV2::vertexCount ( int  = 0,
int  = 0 
) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 92 of file qgscurvev2.h.


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