QGIS API Documentation  3.21.0-Master (56b4176581)
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  void normalize() final SIP_HOLDGIL;
62 
63  //surface interface
64  double area() const override SIP_HOLDGIL;
65  double perimeter() const override SIP_HOLDGIL;
66  QgsPolygon *surfaceToPolygon() const override SIP_FACTORY;
67  QgsAbstractGeometry *boundary() const override SIP_FACTORY;
68  QgsCurvePolygon *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
69  bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) override;
70  bool boundingBoxIntersects( const QgsRectangle &rectangle ) const override SIP_HOLDGIL;
71 
72  //curve polygon interface
73 
80  {
81  return mInteriorRings.size();
82  }
83 
90  {
91  return mExteriorRing.get();
92  }
93 
103  {
104  return mExteriorRing.get();
105  }
106 
107 #ifndef SIP_RUN
108 
115  const QgsCurve *interiorRing( int i ) const SIP_HOLDGIL
116  {
117  if ( i < 0 || i >= mInteriorRings.size() )
118  {
119  return nullptr;
120  }
121  return mInteriorRings.at( i );
122  }
123 
133  {
134  if ( i < 0 || i >= mInteriorRings.size() )
135  {
136  return nullptr;
137  }
138  return mInteriorRings.at( i );
139  }
140 #else
141 
150  SIP_PYOBJECT interiorRing( int i ) SIP_HOLDGIL SIP_TYPEHINT( QgsCurve );
151  % MethodCode
152  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
153  {
154  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
155  sipIsErr = 1;
156  }
157  else
158  {
159  return sipConvertFromType( const_cast< QgsCurve * >( sipCpp->interiorRing( a0 ) ), sipType_QgsCurve, NULL );
160  }
161  % End
162 #endif
163 
170  virtual QgsPolygon *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY;
171 
180  virtual void setExteriorRing( QgsCurve *ring SIP_TRANSFER );
181 
183  void setInteriorRings( const QVector<QgsCurve *> &rings SIP_TRANSFER );
185  virtual void addInteriorRing( QgsCurve *ring SIP_TRANSFER );
186 
187 #ifndef SIP_RUN
188 
195  bool removeInteriorRing( int ringIndex );
196 #else
197 
207  bool removeInteriorRing( int i );
208  % MethodCode
209  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
210  {
211  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
212  sipIsErr = 1;
213  }
214  else
215  {
216  return PyBool_FromLong( sipCpp->removeInteriorRing( a0 ) );
217  }
218  % End
219 #endif
220 
228  void removeInteriorRings( double minimumAllowedArea = -1 );
229 
237  void removeInvalidRings();
238 
247  void forceRHR();
248 
249  QPainterPath asQPainterPath() const override;
250  void draw( QPainter &p ) const override;
251  void transform( const QgsCoordinateTransform &ct, Qgis::TransformDirection d = Qgis::TransformDirection::Forward, bool transformZ = false ) override SIP_THROW( QgsCsException );
252  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
253 
254  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
255  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
256  bool deleteVertex( QgsVertexId position ) override;
257 
258  QgsCoordinateSequence coordinateSequence() const override;
259  int nCoordinates() const override;
260  int vertexNumberFromVertexId( QgsVertexId id ) const override;
261  bool isEmpty() const override SIP_HOLDGIL;
262  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;
263 
264  bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
265  void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
266  bool hasCurvedSegments() const override;
267 
273  QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
274 
280  double vertexAngle( QgsVertexId vertex ) const override;
281 
282  int vertexCount( int part = 0, int ring = 0 ) const override;
283  int ringCount( int part = 0 ) const override SIP_HOLDGIL;
284  int partCount() const override SIP_HOLDGIL;
285  QgsPoint vertexAt( QgsVertexId id ) const override;
286  double segmentLength( QgsVertexId startVertex ) const override;
287 
288  bool addZValue( double zValue = 0 ) override;
289  bool addMValue( double mValue = 0 ) override;
290  bool dropZValue() override;
291  bool dropMValue() override;
292  void swapXy() override;
293 
294  QgsCurvePolygon *toCurveType() const override SIP_FACTORY;
295 
296  bool transform( QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback = nullptr ) override;
297 
298 #ifndef SIP_RUN
299  void filterVertices( const std::function< bool( const QgsPoint & ) > &filter ) override;
300  void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform ) override;
301 
309  inline static const QgsCurvePolygon *cast( const QgsAbstractGeometry *geom )
310  {
311  if ( !geom )
312  return nullptr;
313 
314  const QgsWkbTypes::Type flatType = QgsWkbTypes::flatType( geom->wkbType() );
315  if ( flatType == QgsWkbTypes::CurvePolygon
316  || flatType == QgsWkbTypes::Polygon
317  || flatType == QgsWkbTypes::Triangle )
318  return static_cast<const QgsCurvePolygon *>( geom );
319  return nullptr;
320  }
321 #endif
322 
324 
325 #ifdef SIP_RUN
326  SIP_PYOBJECT __repr__();
327  % MethodCode
328  QString wkt = sipCpp->asWkt();
329  if ( wkt.length() > 1000 )
330  wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
331  QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( wkt );
332  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
333  % End
334 #endif
335 
336  protected:
337 
338  int childCount() const override;
339  QgsAbstractGeometry *childGeometry( int index ) const override;
340  int compareToSameClass( const QgsAbstractGeometry *other ) const final;
341 
342  protected:
343 
344  std::unique_ptr< QgsCurve > mExteriorRing;
345  QVector<QgsCurve *> mInteriorRings;
346 
347  QgsRectangle calculateBoundingBox() const override;
348 };
349 
350 // clazy:excludeall=qstring-allocations
351 
352 #endif // QGSCURVEPOLYGON_H
TransformDirection
Indicates the direction (forward or inverse) of a transform.
Definition: qgis.h:880
An abstract base class for classes which transform geometries by transforming input points to output ...
Abstract base class for all geometries.
virtual bool fromWkb(QgsConstWkbPtr &wkb)=0
Sets the geometry from a WKB string.
virtual QgsAbstractGeometry * boundary() const =0
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the...
virtual void draw(QPainter &p) const =0
Draws the geometry using the specified QPainter.
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
virtual int childCount() const
Returns number of child geometries (for geometries with child geometries) or child points (for geomet...
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.
virtual bool boundingBoxIntersects(const QgsRectangle &rectangle) const SIP_HOLDGIL
Returns true if the bounding box of this geometry intersects with a rectangle.
AxisOrder
Axis order for GML generation.
virtual QString geometryType() const =0
Returns a unique string representing the geometry type.
virtual QgsAbstractGeometry * createEmptyWithSameType() const =0
Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
virtual double perimeter() const
Returns the planar, 2-dimensional perimeter of the geometry.
virtual QByteArray asWkb(WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns a WKB representation of the geometry.
virtual QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
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.
QgsAbstractGeometry & operator=(const QgsAbstractGeometry &geom)
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 void transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) SIP_THROW(QgsCsException)=0
Transforms the geometry using a coordinate transform.
virtual bool operator!=(const QgsAbstractGeometry &other) const =0
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
virtual json asJsonObject(int precision=17) const
Returns a json object representation of 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 bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
virtual QPainterPath asQPainterPath() const =0
Returns the geometry represented as a QPainterPath.
virtual void normalize()=0
Reorganizes the geometry into a normalized form (or "canonical" form).
virtual QgsAbstractGeometry * childGeometry(int index) const
Returns pointer to child geometry (for geometries with child geometries - i.e.
virtual void clear()=0
Clears the geometry, ie reset it to a null geometry.
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...
QgsWkbTypes::Type wkbType() const SIP_HOLDGIL
Returns the WKB type of the geometry.
virtual int dimension() const =0
Returns the inherent dimension of the geometry.
virtual bool operator==(const QgsAbstractGeometry &other) const =0
virtual QString asKml(int precision=17) const =0
Returns a KML representation of the geometry.
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...
virtual int wkbSize(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns the length of the QByteArray returned by asWkb()
virtual double area() const
Returns the planar, 2-dimensional area of the geometry.
virtual int compareToSameClass(const QgsAbstractGeometry *other) const =0
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometr...
A const WKB pointer.
Definition: qgswkbptr.h:138
Class for doing transforms between two map coordinate systems.
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
Curve polygon geometry type.
QgsCurve * interiorRing(int i)
Retrieves an interior ring from the curve polygon.
QgsCurve * exteriorRing()
Returns a non-const pointer to the curve polygon's exterior ring.
static const QgsCurvePolygon * cast(const QgsAbstractGeometry *geom)
Cast the geom to a QgsCurvePolygon.
QVector< QgsCurve * > mInteriorRings
const QgsCurve * interiorRing(int i) const SIP_HOLDGIL
Retrieves an interior ring from the curve polygon.
const QgsCurve * exteriorRing() const SIP_HOLDGIL
Returns the curve polygon's exterior ring.
int numInteriorRings() const SIP_HOLDGIL
Returns the number of interior rings contained with the curve polygon.
std::unique_ptr< QgsCurve > mExteriorRing
Abstract base class for curved geometry type.
Definition: qgscurve.h:36
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
Polygon geometry type.
Definition: qgspolygon.h:34
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Surface geometry type.
Definition: qgssurface.h:34
virtual QgsPolygon * surfaceToPolygon() const =0
Gets a polygon representation of this surface.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
static Type flatType(Type type) SIP_HOLDGIL
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:702
double ANALYSIS_EXPORT leftOf(const QgsPoint &thepoint, const QgsPoint *p1, const QgsPoint *p2)
Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negative values mean left ...
Definition: MathUtils.cpp:292
CORE_EXPORT std::unique_ptr< QgsPolygon > toPolygon(const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
Returns face as polygon geometry, caller is responsible for delete.
#define str(x)
Definition: qgis.cpp:37
#define SIP_THROW(name)
Definition: qgis_sip.h:189
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:218
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_OUT
Definition: qgis_sip.h:58
#define SIP_HOLDGIL
Definition: qgis_sip.h:157
#define SIP_FACTORY
Definition: qgis_sip.h:76
QVector< QgsRingSequence > QgsCoordinateSequence
double closestSegment(const QgsPolylineXY &pl, const QgsPointXY &pt, int &vertexAfter, double epsilon)
Definition: qgstracer.cpp:68
int precision
Utility class for identifying a unique vertex within a geometry.