QGIS API Documentation  3.0.2-Girona (307d082)
qgscurvepolygon.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscurvepolygon.h
3  -------------------
4  begin : September 2014
5  copyright : (C) 2014 by Marco Hugentobler
6  email : marco at sourcepole dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSCURVEPOLYGONV2_H
19 #define QGSCURVEPOLYGONV2_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
23 #include "qgssurface.h"
24 #include <memory>
25 
26 class QgsPolygon;
27 
34 class CORE_EXPORT QgsCurvePolygon: public QgsSurface
35 {
36  public:
38  QgsCurvePolygon( const QgsCurvePolygon &p );
40 
41  bool operator==( const QgsAbstractGeometry &other ) const override;
42  bool operator!=( const QgsAbstractGeometry &other ) const override;
43 
44  ~QgsCurvePolygon() override;
45 
46  QString geometryType() const override;
47  int dimension() const override;
48  QgsCurvePolygon *clone() const override SIP_FACTORY;
49  void clear() override;
50 
51  bool fromWkb( QgsConstWkbPtr &wkb ) override;
52  bool fromWkt( const QString &wkt ) override;
53 
54  QByteArray asWkb() const override;
55  QString asWkt( int precision = 17 ) const override;
56  QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const override;
57  QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const override;
58  QString asJson( int precision = 17 ) const override;
59 
60  //surface interface
61  double area() const override;
62  double perimeter() const override;
63  QgsPolygon *surfaceToPolygon() const override SIP_FACTORY;
64  QgsAbstractGeometry *boundary() const override SIP_FACTORY;
65  QgsCurvePolygon *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
66  bool removeDuplicateNodes( double epsilon = 4 * DBL_EPSILON, bool useZValues = false ) override;
67 
68  //curve polygon interface
69  int numInteriorRings() const;
70  const QgsCurve *exteriorRing() const;
71  const QgsCurve *interiorRing( int i ) const;
72 
78  virtual QgsPolygon *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY;
79 
88  virtual void setExteriorRing( QgsCurve *ring SIP_TRANSFER );
89 
91  void setInteriorRings( const QVector<QgsCurve *> &rings SIP_TRANSFER );
93  virtual void addInteriorRing( QgsCurve *ring SIP_TRANSFER );
94 
101  bool removeInteriorRing( int ringIndex );
102 
110  void removeInteriorRings( double minimumAllowedArea = -1 );
111 
112  void draw( QPainter &p ) const override;
114  bool transformZ = false ) override;
115  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
116 
117  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
118  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
119  bool deleteVertex( QgsVertexId position ) override;
120 
121  QgsCoordinateSequence coordinateSequence() const override;
122  int nCoordinates() const override;
123  int vertexNumberFromVertexId( QgsVertexId id ) const override;
124  bool isEmpty() const override;
125  double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * DBL_EPSILON ) const override;
126 
127  bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
128  void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
129  bool hasCurvedSegments() const override;
130 
135  QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
136 
142  double vertexAngle( QgsVertexId vertex ) const override;
143 
144  int vertexCount( int part = 0, int ring = 0 ) const override;
145  int ringCount( int part = 0 ) const override;
146  int partCount() const override;
147  QgsPoint vertexAt( QgsVertexId id ) const override;
148  double segmentLength( QgsVertexId startVertex ) const override;
149 
150  bool addZValue( double zValue = 0 ) override;
151  bool addMValue( double mValue = 0 ) override;
152  bool dropZValue() override;
153  bool dropMValue() override;
154 
155  QgsCurvePolygon *toCurveType() const override SIP_FACTORY;
156 #ifndef SIP_RUN
157 
165  inline const QgsCurvePolygon *cast( const QgsAbstractGeometry *geom ) const
166  {
167  if ( !geom )
168  return nullptr;
169 
170  QgsWkbTypes::Type flatType = QgsWkbTypes::flatType( geom->wkbType() );
171  if ( flatType == QgsWkbTypes::CurvePolygon
172  || flatType == QgsWkbTypes::Polygon
173  || flatType == QgsWkbTypes::Triangle )
174  return static_cast<const QgsCurvePolygon *>( geom );
175  return nullptr;
176  }
177 #endif
178 
180 
181  protected:
182 
183  int childCount() const override;
184  QgsAbstractGeometry *childGeometry( int index ) const override;
185 
186  protected:
187 
188  std::unique_ptr< QgsCurve > mExteriorRing;
189  QVector<QgsCurve *> mInteriorRings;
190 
191  QgsRectangle calculateBoundingBox() const override;
192 };
193 
194 // clazy:excludeall=qstring-allocations
195 
196 #endif // QGSCURVEPOLYGONV2_H
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
A rectangle specified with double values.
Definition: qgsrectangle.h:39
virtual QgsAbstractGeometry * snappedToGrid(double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const =0
Makes a new geometry with all the points or vertices snapped to the closest point of the grid...
virtual int vertexNumberFromVertexId(QgsVertexId id) const =0
Returns the vertex number corresponding to a vertex id.
virtual int childCount() const
Returns number of child geometries (for geometries with child geometries) or child points (for geomet...
virtual bool isEmpty() const
Returns true if the geometry is empty.
virtual bool removeDuplicateNodes(double epsilon=4 *DBL_EPSILON, bool useZValues=false)=0
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerat...
virtual bool deleteVertex(QgsVertexId position)=0
Deletes a vertex within the geometry.
virtual QgsAbstractGeometry * toCurveType() const =0
Returns the geometry converted to the more generic curve type.
virtual QByteArray asWkb() const =0
Returns a WKB representation of the geometry.
QgsAbstractGeometry & operator=(const QgsAbstractGeometry &geom)
virtual bool insertVertex(QgsVertexId position, const QgsPoint &vertex)=0
Inserts a vertex into the geometry.
QVector< QgsRingSequence > QgsCoordinateSequence
virtual bool operator==(const QgsAbstractGeometry &other) const =0
TransformDirection
Enum used to indicate the direction (forward or inverse) of the transform.
virtual double vertexAngle(QgsVertexId vertex) const =0
Returns approximate angle at a vertex.
Curve polygon geometry type.
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
virtual QgsAbstractGeometry * createEmptyWithSameType() const =0
Creates a new geometry with the same class and same WKB type as the original and transfers ownership...
virtual QString asJson(int precision=17) const =0
Returns a GeoJSON representation of the geometry.
virtual QgsAbstractGeometry * childGeometry(int index) const
Returns pointer to child geometry (for geometries with child geometries - i.e.
virtual double closestSegment(const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *DBL_EPSILON) const =0
Searches for the closest segment of the geometry to a given point.
virtual QgsAbstractGeometry * boundary() const =0
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the...
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle...
virtual bool nextVertex(QgsVertexId &id, QgsPoint &vertex) const =0
Returns next vertex id and coordinates.
virtual void transform(const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false)=0
Transforms the geometry using a coordinate transform.
virtual QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
QVector< QgsCurve * > mInteriorRings
virtual QgsPolygon * surfaceToPolygon() const =0
Get a polygon representation of this surface.
virtual bool operator!=(const QgsAbstractGeometry &other) const =0
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:67
virtual double segmentLength(QgsVertexId startVertex) const =0
Returns the length of the segment of the geometry which begins at startVertex.
Utility class for identifying a unique vertex within a geometry.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
virtual double area() const
Returns the area of the geometry.
virtual int ringCount(int part=0) const =0
Returns the number of rings of which this geometry is built.
Abstract base class for curved geometry type.
Definition: qgscurve.h:35
#define SIP_FACTORY
Definition: qgis_sip.h:69
Abstract base class for all geometries.
virtual int dimension() const =0
Returns the inherent dimension of the geometry.
QgsWkbTypes::Type wkbType() const
Returns the WKB type of the geometry.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
virtual QgsCoordinateSequence coordinateSequence() const =0
Retrieves the sequence of geometries, rings and nodes.
virtual void adjacentVertices(QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const =0
Returns the vertices adjacent to a specified vertex within a geometry.
virtual void clear()=0
Clears the geometry, ie reset it to a null geometry.
virtual QDomElement asGml2(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML2 representation of the geometry.
virtual bool moveVertex(QgsVertexId position, const QgsPoint &newPos)=0
Moves a vertex within the geometry.
virtual void draw(QPainter &p) const =0
Draws the geometry using the specified QPainter.
#define SIP_OUT
Definition: qgis_sip.h:51
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
virtual double perimeter() const
Returns the perimeter of the geometry.
virtual int vertexCount(int part=0, int ring=0) const =0
Returns the number of vertices of which this geometry is built.
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
Class for doing transforms between two map coordinate systems.
virtual QDomElement asGml3(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML3 representation of the geometry.
Transform from source to destination CRS.
const QgsCurvePolygon * cast(const QgsAbstractGeometry *geom) const
Cast the geom to a QgsCurvePolygon.
virtual bool dropMValue()=0
Drops any measure values which exist in the geometry.
virtual bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
Polygon geometry type.
Definition: qgspolygon.h:31
virtual QgsPoint vertexAt(QgsVertexId id) const =0
Returns the point corresponding to a specified vertex id.
virtual int nCoordinates() const
Returns the number of nodes contained in the geometry.
std::unique_ptr< QgsCurve > mExteriorRing
static Type flatType(Type type)
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:427
virtual bool hasCurvedSegments() const
Returns true if the geometry contains curved segments.
virtual QgsAbstractGeometry * segmentize(double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const
Returns a version of the geometry without curves.
double ANALYSIS_EXPORT leftOf(const QgsPoint &thepoint, const QgsPoint *p1, const QgsPoint *p2)
Returns whether &#39;thepoint&#39; is left or right of the line from &#39;p1&#39; to &#39;p2&#39;. Negativ values mean left a...
Definition: MathUtils.cpp:292
virtual bool dropZValue()=0
Drops any z-dimensions which exist in the geometry.
virtual int partCount() const =0
Returns count of parts contained in the geometry.
virtual QString geometryType() const =0
Returns a unique string representing the geometry type.
virtual bool fromWkb(QgsConstWkbPtr &wkb)=0
Sets the geometry from a WKB string.