QGIS API Documentation  3.17.0-Master (8af46bc54f)
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 QGSCURVEPOLYGON_H
19 #define QGSCURVEPOLYGON_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.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 SIP_HOLDGIL;
47  int dimension() const override SIP_HOLDGIL;
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  int wkbSize( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
55  QByteArray asWkb( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
56  QString asWkt( int precision = 17 ) const override;
57  QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
58  QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
59  json asJsonObject( int precision = 17 ) const override SIP_SKIP;
60  QString asKml( int precision = 17 ) const override;
61 
62  //surface interface
63  double area() const override SIP_HOLDGIL;
64  double perimeter() const override SIP_HOLDGIL;
65  QgsPolygon *surfaceToPolygon() const override SIP_FACTORY;
66  QgsAbstractGeometry *boundary() const override SIP_FACTORY;
67  QgsCurvePolygon *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
68  bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) override;
69 
70  //curve polygon interface
71 
77  int numInteriorRings() const SIP_HOLDGIL
78  {
79  return mInteriorRings.size();
80  }
81 
87  const QgsCurve *exteriorRing() const SIP_HOLDGIL
88  {
89  return mExteriorRing.get();
90  }
91 
92 #ifndef SIP_RUN
93 
100  const QgsCurve *interiorRing( int i ) const SIP_HOLDGIL
101  {
102  if ( i < 0 || i >= mInteriorRings.size() )
103  {
104  return nullptr;
105  }
106  return mInteriorRings.at( i );
107  }
108 #else
109 
118  SIP_PYOBJECT interiorRing( int i ) SIP_HOLDGIL SIP_TYPEHINT( QgsCurve );
119  % MethodCode
120  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
121  {
122  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
123  sipIsErr = 1;
124  }
125  else
126  {
127  return sipConvertFromType( const_cast< QgsCurve * >( sipCpp->interiorRing( a0 ) ), sipType_QgsCurve, NULL );
128  }
129  % End
130 #endif
131 
138  virtual QgsPolygon *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY;
139 
148  virtual void setExteriorRing( QgsCurve *ring SIP_TRANSFER );
149 
151  void setInteriorRings( const QVector<QgsCurve *> &rings SIP_TRANSFER );
153  virtual void addInteriorRing( QgsCurve *ring SIP_TRANSFER );
154 
155 #ifndef SIP_RUN
156 
163  bool removeInteriorRing( int ringIndex );
164 #else
165 
175  bool removeInteriorRing( int i );
176  % MethodCode
177  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
178  {
179  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
180  sipIsErr = 1;
181  }
182  else
183  {
184  return PyBool_FromLong( sipCpp->removeInteriorRing( a0 ) );
185  }
186  % End
187 #endif
188 
196  void removeInteriorRings( double minimumAllowedArea = -1 );
197 
205  void removeInvalidRings();
206 
215  void forceRHR();
216 
217  QPainterPath asQPainterPath() const override;
218  void draw( QPainter &p ) const override;
220  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
221 
222  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
223  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
224  bool deleteVertex( QgsVertexId position ) override;
225 
226  QgsCoordinateSequence coordinateSequence() const override;
227  int nCoordinates() const override;
228  int vertexNumberFromVertexId( QgsVertexId id ) const override;
229  bool isEmpty() const override SIP_HOLDGIL;
230  double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const override;
231 
232  bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
233  void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
234  bool hasCurvedSegments() const override;
235 
241  QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
242 
248  double vertexAngle( QgsVertexId vertex ) const override;
249 
250  int vertexCount( int part = 0, int ring = 0 ) const override;
251  int ringCount( int part = 0 ) const override SIP_HOLDGIL;
252  int partCount() const override SIP_HOLDGIL;
253  QgsPoint vertexAt( QgsVertexId id ) const override;
254  double segmentLength( QgsVertexId startVertex ) const override;
255 
256  bool addZValue( double zValue = 0 ) override;
257  bool addMValue( double mValue = 0 ) override;
258  bool dropZValue() override;
259  bool dropMValue() override;
260  void swapXy() override;
261 
262  QgsCurvePolygon *toCurveType() const override SIP_FACTORY;
263 
264 #ifndef SIP_RUN
265  void filterVertices( const std::function< bool( const QgsPoint & ) > &filter ) override;
266  void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform ) override;
267 
275  inline static const QgsCurvePolygon *cast( const QgsAbstractGeometry *geom )
276  {
277  if ( !geom )
278  return nullptr;
279 
280  QgsWkbTypes::Type flatType = QgsWkbTypes::flatType( geom->wkbType() );
281  if ( flatType == QgsWkbTypes::CurvePolygon
282  || flatType == QgsWkbTypes::Polygon
283  || flatType == QgsWkbTypes::Triangle )
284  return static_cast<const QgsCurvePolygon *>( geom );
285  return nullptr;
286  }
287 #endif
288 
290 
291 #ifdef SIP_RUN
292  SIP_PYOBJECT __repr__();
293  % MethodCode
294  QString wkt = sipCpp->asWkt();
295  if ( wkt.length() > 1000 )
296  wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
297  QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( wkt );
298  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
299  % End
300 #endif
301 
302  protected:
303 
304  int childCount() const override;
305  QgsAbstractGeometry *childGeometry( int index ) const override;
306 
307  protected:
308 
309  std::unique_ptr< QgsCurve > mExteriorRing;
310  QVector<QgsCurve *> mInteriorRings;
311 
312  QgsRectangle calculateBoundingBox() const override;
313 };
314 
315 // clazy:excludeall=qstring-allocations
316 
317 #endif // QGSCURVEPOLYGON_H
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
int precision
A rectangle specified with double values.
Definition: qgsrectangle.h:41
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 void transformVertices(const std::function< QgsPoint(const QgsPoint &) > &transform)
Transforms the vertices from the geometry in place, applying the transform function to every vertex...
int numInteriorRings() const SIP_HOLDGIL
Returns the number of interior rings contained with the curve polygon.
virtual bool deleteVertex(QgsVertexId position)=0
Deletes a vertex within the geometry.
virtual void transform(const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false) SIP_THROW(QgsCsException)=0
Transforms the geometry using a coordinate transform.
virtual QgsAbstractGeometry * toCurveType() const =0
Returns the geometry converted to the more generic curve type.
QgsAbstractGeometry & operator=(const QgsAbstractGeometry &geom)
virtual bool insertVertex(QgsVertexId position, const QgsPoint &vertex)=0
Inserts a vertex into the geometry.
QVector< QgsRingSequence > QgsCoordinateSequence
static const QgsCurvePolygon * cast(const QgsAbstractGeometry *geom)
Cast the geom to a QgsCurvePolygon.
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.
static Type flatType(Type type) SIP_HOLDGIL
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:702
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 QgsAbstractGeometry * childGeometry(int index) const
Returns pointer to child geometry (for geometries with child geometries - i.e.
virtual QDomElement asGml2(QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
Returns a GML2 representation of the geometry.
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 QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:218
QVector< QgsCurve * > mInteriorRings
virtual QgsPolygon * surfaceToPolygon() const =0
Gets 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:69
virtual double closestSegment(const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const =0
Searches for the closest segment of the geometry to a given point.
virtual double segmentLength(QgsVertexId startVertex) const =0
Returns the length of the segment of the geometry which begins at startVertex.
virtual void filterVertices(const std::function< bool(const QgsPoint &) > &filter)
Filters the vertices from the geometry in place, removing any which do not return true for the filter...
Utility class for identifying a unique vertex within a geometry.
#define SIP_HOLDGIL
Definition: qgis_sip.h:157
#define SIP_SKIP
Definition: qgis_sip.h:126
const QgsCurve * exteriorRing() const SIP_HOLDGIL
Returns the curve polygon&#39;s exterior ring.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
virtual QString asKml(int precision=17) const =0
Returns a KML representation of the geometry.
CORE_EXPORT std::unique_ptr< QgsPolygon > toPolygon(const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
Returns face as polygon geometry, caller is responsible for delete.
virtual double area() const
Returns the planar, 2-dimensional 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:76
Abstract base class for all geometries.
virtual int dimension() const =0
Returns the inherent dimension of the geometry.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
AxisOrder
Axis order for GML generation.
virtual int wkbSize(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns the length of the QByteArray returned by asWkb()
virtual QByteArray asWkb(WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns a WKB representation of the geometry.
const QgsCurve * interiorRing(int i) const SIP_HOLDGIL
Retrieves an interior ring from the curve polygon.
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 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:58
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 planar, 2-dimensional 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.
QgsWkbTypes::Type wkbType() const SIP_HOLDGIL
Returns the WKB type of the geometry.
#define SIP_THROW(name)
Definition: qgis_sip.h:189
Transform from source to destination CRS.
virtual bool removeDuplicateNodes(double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false)=0
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerat...
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:65
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:33
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
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.
virtual void swapXy()=0
Swaps the x and y coordinates from the geometry.
virtual QPainterPath asQPainterPath() const =0
Returns the geometry represented as a QPainterPath.
virtual json asJsonObject(int precision=17) const
Returns a json object representation of the geometry.
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;. Negative values mean left ...
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 QDomElement asGml3(QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
Returns a GML3 representation of 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.