| 
    QGIS API Documentation
    2.18.21-Las Palmas (9fba24a)
    
   | 
 
Curve polygon geometry type. More...
#include <qgscurvepolygonv2.h>

Public Member Functions | |
| QgsCurvePolygonV2 () | |
| QgsCurvePolygonV2 (const QgsCurvePolygonV2 &p) | |
| ~QgsCurvePolygonV2 () | |
| virtual void | addInteriorRing (QgsCurveV2 *ring) | 
| Adds an interior ring to the geometry (takes ownership)  More... | |
| virtual bool | addMValue (double mValue=0) override | 
| Adds a measure to the geometry, initialized to a preset value.  More... | |
| virtual bool | addZValue (double zValue=0) override | 
| Adds a z-dimension to the geometry, initialized to a preset value.  More... | |
| virtual double | area () const override | 
| Returns the area of the geometry.  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 QgsAbstractGeometryV2 * | boundary () const override | 
| Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).  More... | |
| void | clear () override | 
| Clears the geometry, ie reset it to a null geometry.  More... | |
| virtual QgsCurvePolygonV2 * | clone () 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 QgsCoordinateSequenceV2 | coordinateSequence () const override | 
| Retrieves the sequence of geometries, rings and nodes.  More... | |
| virtual bool | deleteVertex (QgsVertexId position) override | 
| Deletes a vertex within the geometry.  More... | |
| virtual int | dimension () const override | 
| Returns the inherent dimension of the geometry.  More... | |
| virtual void | draw (QPainter &p) const override | 
| Draws the geometry using the specified QPainter.  More... | |
| virtual bool | dropMValue () override | 
| Drops any measure values which exist in the geometry.  More... | |
| virtual bool | dropZValue () override | 
| Drops any z-dimensions which exist in the geometry.  More... | |
| const QgsCurveV2 * | exteriorRing () const | 
| virtual bool | fromWkb (QgsConstWkbPtr 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 (QgsVertexId position, const QgsPointV2 &vertex) override | 
| Inserts a vertex into the geometry.  More... | |
| const QgsCurveV2 * | interiorRing (int i) const | 
| virtual bool | moveVertex (QgsVertexId position, const QgsPointV2 &newPos) override | 
| Moves a vertex within the geometry.  More... | |
| virtual int | nCoordinates () const override | 
| Returns the number of nodes contained in the geometry.  More... | |
| bool | nextVertex (QgsVertexId &id, QgsPointV2 &vertex) const override | 
| Returns next vertex id and coordinates.  More... | |
| int | numInteriorRings () const | 
| QgsCurvePolygonV2 & | operator= (const QgsCurvePolygonV2 &p) | 
| virtual int | partCount () const override | 
| Returns count of parts contained in the geometry.  More... | |
| virtual double | perimeter () const override | 
| Returns the perimeter of the geometry.  More... | |
| bool | removeInteriorRing (int nr) | 
| Removes ring.  More... | |
| virtual int | ringCount (int=0) const override | 
| QgsAbstractGeometryV2 * | segmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override | 
| Returns a geometry without curves.  More... | |
| virtual void | setExteriorRing (QgsCurveV2 *ring) | 
| Sets the exterior ring of the polygon.  More... | |
| void | setInteriorRings (const QList< QgsCurveV2 *> &rings) | 
| Sets all interior rings (takes ownership)  More... | |
| QgsPolygonV2 * | surfaceToPolygon () const override | 
| virtual QgsPolygonV2 * | toPolygon (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const | 
| Returns a new polygon geometry corresponding to a segmentized approximation of the curve.  More... | |
| void | transform (const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false) override | 
| Transforms the geometry using a coordinate transform.  More... | |
| void | transform (const QTransform &t) override | 
| Transforms the geometry using a QTransform object.  More... | |
| double | vertexAngle (QgsVertexId vertex) const override | 
| Returns approximate rotation angle for a vertex.  More... | |
| virtual QgsPointV2 | vertexAt (QgsVertexId id) const override | 
| Returns the point corresponding to a specified vertex id.  More... | |
| virtual int | vertexCount (int=0, int ring=0) const override | 
| int | wkbSize () const override | 
| Returns the size of the WKB representation of the geometry.  More... | |
  Public Member Functions inherited from QgsSurfaceV2 | |
| virtual QgsRectangle | boundingBox () const override | 
| Returns the minimal bounding box for the geometry.  More... | |
  Public Member Functions inherited from QgsAbstractGeometryV2 | |
| QgsAbstractGeometryV2 () | |
| QgsAbstractGeometryV2 (const QgsAbstractGeometryV2 &geom) | |
| virtual | ~QgsAbstractGeometryV2 () | 
| virtual QgsPointV2 | centroid () const | 
| Returns the centroid of the geometry.  More... | |
| virtual bool | convertTo (QgsWKBTypes::Type type) | 
| Converts the geometry to a specified type.  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 QgsAbstractGeometryV2 & | operator= (const QgsAbstractGeometryV2 &geom) | 
| virtual QgsAbstractGeometryV2 * | toCurveType () const | 
| Returns the geometry converted to the more generic curve type.  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... | |
Protected Member Functions | |
| virtual QgsRectangle | calculateBoundingBox () const override | 
| Default calculator for the minimal bounding box for the geometry.  More... | |
  Protected Member Functions inherited from QgsSurfaceV2 | |
| virtual void | clearCache () const override | 
| Clears any cached parameters associated with the geometry, eg bounding boxes.  More... | |
  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... | |
Protected Attributes | |
| QgsCurveV2 * | mExteriorRing | 
| QList< QgsCurveV2 * > | mInteriorRings | 
  Protected Attributes inherited from QgsSurfaceV2 | |
| QgsRectangle | mBoundingBox | 
| QgsCoordinateSequenceV2 | mCoordinateSequence | 
  Protected Attributes inherited from QgsAbstractGeometryV2 | |
| QgsWKBTypes::Type | mWkbType | 
Additional Inherited Members | |
  Public Types inherited from QgsAbstractGeometryV2 | |
| enum | SegmentationToleranceType { MaximumAngle = 0, MaximumDifference } | 
| Segmentation tolerance as maximum angle or maximum difference between approximation and circle.  More... | |
Curve polygon geometry type.
Definition at line 31 of file qgscurvepolygonv2.h.
| QgsCurvePolygonV2::QgsCurvePolygonV2 | ( | ) | 
Definition at line 30 of file qgscurvepolygonv2.cpp.
| QgsCurvePolygonV2::QgsCurvePolygonV2 | ( | const QgsCurvePolygonV2 & | p | ) | 
Definition at line 40 of file qgscurvepolygonv2.cpp.
| QgsCurvePolygonV2::~QgsCurvePolygonV2 | ( | ) | 
Definition at line 35 of file qgscurvepolygonv2.cpp.
      
  | 
  virtual | 
Adds an interior ring to the geometry (takes ownership)
Reimplemented in QgsPolygonV2.
Definition at line 537 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Adds a measure to the geometry, initialized to a preset value.
| mValue | initial m-value for all nodes | 
Implements QgsAbstractGeometryV2.
Definition at line 865 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Adds a z-dimension to the geometry, initialized to a preset value.
| zValue | initial z-value for all nodes | 
Implements QgsAbstractGeometryV2.
Definition at line 848 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns the area of the geometry.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 372 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns a GML2 representation of the geometry.
| doc | DOM document | 
| precision | number of decimal places for coordinates | 
| ns | XML namespace | 
Implements QgsAbstractGeometryV2.
Definition at line 295 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns a GML3 representation of the geometry.
| doc | DOM document | 
| precision | number of decimal places for coordinates | 
| ns | XML namespace | 
Implements QgsAbstractGeometryV2.
Definition at line 319 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns a GeoJSON representation of the geometry.
| precision | number of decimal places for coordinates | 
Implements QgsAbstractGeometryV2.
Definition at line 345 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns a WKB representation of the geometry.
| binarySize | will be set to the size of the returned WKB string | 
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 239 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns a WKT representation of the geometry.
| precision | number of decimal places for coordinates | 
Implements QgsAbstractGeometryV2.
Definition at line 264 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 431 of file qgscurvepolygonv2.cpp.
      
  | 
  overrideprotectedvirtual | 
Default calculator for the minimal bounding box for the geometry.
Derived classes should override this method if a more efficient bounding box calculation is available.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 216 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Clears the geometry, ie reset it to a null geometry.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 80 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Clones the geometry by performing a deep copy.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 75 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Searches for the closest segment of the geometry to a given point.
| pt | specifies the point to find closest segment to | 
| segmentPt | storage for the closest point within the geometry | 
| vertexAfter | storage for the ID of the vertex at the end of the closest segment | 
| leftOf | returns whether the point lies on the left side of the nearest segment (true if point is to left of segment, false if point is to right of segment) | 
| epsilon | epsilon for segment snapping | 
Implements QgsAbstractGeometryV2.
Definition at line 663 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Retrieves the sequence of geometries, rings and nodes.
Implements QgsAbstractGeometryV2.
Definition at line 619 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Deletes a vertex within the geometry.
| position | vertex id for vertex to delete | 
Implements QgsAbstractGeometryV2.
Definition at line 759 of file qgscurvepolygonv2.cpp.
      
  | 
  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 40 of file qgscurvepolygonv2.h.
      
  | 
  overridevirtual | 
Draws the geometry using the specified QPainter.
| p | destination QPainter | 
Implements QgsAbstractGeometryV2.
Definition at line 568 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Drops any measure values which exist in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 898 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Drops any z-dimensions which exist in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 882 of file qgscurvepolygonv2.cpp.
| const QgsCurveV2 * QgsCurvePolygonV2::exteriorRing | ( | ) | const | 
Definition at line 475 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Sets the geometry from a WKB string.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 91 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Sets the geometry from a WKT string.
Implements QgsAbstractGeometryV2.
Definition at line 147 of file qgscurvepolygonv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns a unique string representing the geometry type.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 39 of file qgscurvepolygonv2.h.
      
  | 
  overridevirtual | 
Returns true if the geometry contains curved segments.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 803 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Inserts a vertex into the geometry.
| position | vertex id for position of inserted vertex | 
| vertex | vertex to insert | 
Implements QgsAbstractGeometryV2.
Definition at line 711 of file qgscurvepolygonv2.cpp.
| const QgsCurveV2 * QgsCurvePolygonV2::interiorRing | ( | int | i | ) | const | 
Definition at line 480 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Moves a vertex within the geometry.
| position | vertex id for vertex to move | 
| newPos | new position of vertex | 
Implements QgsAbstractGeometryV2.
Definition at line 737 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns the number of nodes contained in the geometry.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 642 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns next vertex id and coordinates.
| id | initial value should be the starting vertex id. The next vertex id will be stored in this variable if found. | 
| vertex | container for found node | 
Implements QgsAbstractGeometryV2.
Definition at line 675 of file qgscurvepolygonv2.cpp.
| int QgsCurvePolygonV2::numInteriorRings | ( | ) | const | 
Definition at line 470 of file qgscurvepolygonv2.cpp.
| QgsCurvePolygonV2 & QgsCurvePolygonV2::operator= | ( | const QgsCurvePolygonV2 & | p | ) | 
Definition at line 56 of file qgscurvepolygonv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns count of parts contained in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 114 of file qgscurvepolygonv2.h.
      
  | 
  overridevirtual | 
Returns the perimeter of the geometry.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 401 of file qgscurvepolygonv2.cpp.
| bool QgsCurvePolygonV2::removeInteriorRing | ( | int | nr | ) | 
Removes ring.
Exterior ring is 0, first interior ring 1, ...
Definition at line 557 of file qgscurvepolygonv2.cpp.
      
  | 
  inlineoverridevirtual | 
Implements QgsAbstractGeometryV2.
Definition at line 113 of file qgscurvepolygonv2.h.
      
  | 
  overridevirtual | 
Returns a geometry without curves.
Caller takes ownership
| tolerance | segmentation tolerance | 
| toleranceType | maximum segmentation angle or maximum difference between approximation and curve | 
Reimplemented from QgsAbstractGeometryV2.
Definition at line 821 of file qgscurvepolygonv2.cpp.
      
  | 
  virtual | 
Sets the exterior ring of the polygon.
The CurvePolygon type will be updated to match the dimensionality of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension from the CurvePolygon and all interior rings.
| ring | new exterior ring. Ownership is transferred to the CurvePolygon. | 
Reimplemented in QgsPolygonV2.
Definition at line 489 of file qgscurvepolygonv2.cpp.
| void QgsCurvePolygonV2::setInteriorRings | ( | const QList< QgsCurveV2 *> & | rings | ) | 
Sets all interior rings (takes ownership)
Definition at line 524 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Implements QgsSurfaceV2.
Reimplemented in QgsPolygonV2.
Definition at line 416 of file qgscurvepolygonv2.cpp.
      
  | 
  virtual | 
Returns a new polygon geometry corresponding to a segmentized approximation of the curve.
| tolerance | segmentation tolerance | 
| toleranceType | maximum segmentation angle or maximum difference between approximation and curve | 
Definition at line 450 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Transforms the geometry using a coordinate transform.
| ct | coordinate transform | 
| d | transformation direction | 
| transformZ | set to true to also transform z coordinates. This requires that the z coordinates in the geometry represent height relative to the vertical datum of the source CRS (generally ellipsoidal heights) and are expressed in its vertical units (generally meters). If false, then z coordinates will not be changed by the transform. | 
Implements QgsAbstractGeometryV2.
Definition at line 591 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Transforms the geometry using a QTransform object.
| t | QTransform transformation | 
Implements QgsAbstractGeometryV2.
Definition at line 605 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns approximate rotation angle for a vertex.
Usually average angle between adjacent segments.
| vertex | the vertex id | 
Implements QgsAbstractGeometryV2.
Definition at line 826 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns the point corresponding to a specified vertex id.
Implements QgsAbstractGeometryV2.
Definition at line 843 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Implements QgsAbstractGeometryV2.
Definition at line 838 of file qgscurvepolygonv2.cpp.
      
  | 
  overridevirtual | 
Returns the size of the WKB representation of the geometry.
Implements QgsAbstractGeometryV2.
Reimplemented in QgsPolygonV2.
Definition at line 225 of file qgscurvepolygonv2.cpp.
      
  | 
  protected | 
Definition at line 124 of file qgscurvepolygonv2.h.
      
  | 
  protected | 
Definition at line 125 of file qgscurvepolygonv2.h.
 1.8.13