QGIS API Documentation  3.27.0-Master (aef1b1ec20)
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 
77  double roundness() const;
78 
79  //curve polygon interface
80 
87  {
88  return mInteriorRings.size();
89  }
90 
97  {
98  return mExteriorRing.get();
99  }
100 
110  {
111  return mExteriorRing.get();
112  }
113 
114 #ifndef SIP_RUN
115 
122  const QgsCurve *interiorRing( int i ) const SIP_HOLDGIL
123  {
124  if ( i < 0 || i >= mInteriorRings.size() )
125  {
126  return nullptr;
127  }
128  return mInteriorRings.at( i );
129  }
130 
140  {
141  if ( i < 0 || i >= mInteriorRings.size() )
142  {
143  return nullptr;
144  }
145  return mInteriorRings.at( i );
146  }
147 #else
148 
157  SIP_PYOBJECT interiorRing( int i ) SIP_HOLDGIL SIP_TYPEHINT( QgsCurve );
158  % MethodCode
159  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
160  {
161  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
162  sipIsErr = 1;
163  }
164  else
165  {
166  return sipConvertFromType( const_cast< QgsCurve * >( sipCpp->interiorRing( a0 ) ), sipType_QgsCurve, NULL );
167  }
168  % End
169 #endif
170 
177  virtual QgsPolygon *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY;
178 
187  virtual void setExteriorRing( QgsCurve *ring SIP_TRANSFER );
188 
190  void setInteriorRings( const QVector<QgsCurve *> &rings SIP_TRANSFER );
192  virtual void addInteriorRing( QgsCurve *ring SIP_TRANSFER );
193 
194 #ifndef SIP_RUN
195 
202  bool removeInteriorRing( int ringIndex );
203 #else
204 
214  bool removeInteriorRing( int i );
215  % MethodCode
216  if ( a0 < 0 || a0 >= sipCpp->numInteriorRings() )
217  {
218  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
219  sipIsErr = 1;
220  }
221  else
222  {
223  return PyBool_FromLong( sipCpp->removeInteriorRing( a0 ) );
224  }
225  % End
226 #endif
227 
235  void removeInteriorRings( double minimumAllowedArea = -1 );
236 
244  void removeInvalidRings();
245 
259  void forceRHR();
260 
269  void forceClockwise();
270 
279  void forceCounterClockwise();
280 
281  QPainterPath asQPainterPath() const override;
282  void draw( QPainter &p ) const override;
283  void transform( const QgsCoordinateTransform &ct, Qgis::TransformDirection d = Qgis::TransformDirection::Forward, bool transformZ = false ) override SIP_THROW( QgsCsException );
284  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
285 
286  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
287  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
288  bool deleteVertex( QgsVertexId position ) override;
289 
290  QgsCoordinateSequence coordinateSequence() const override;
291  int nCoordinates() const override;
292  int vertexNumberFromVertexId( QgsVertexId id ) const override;
293  bool isEmpty() const override SIP_HOLDGIL;
294  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;
295 
296  bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
297  void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
298  bool hasCurvedSegments() const override;
299 
305  QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
306 
312  double vertexAngle( QgsVertexId vertex ) const override;
313 
314  int vertexCount( int part = 0, int ring = 0 ) const override;
315  int ringCount( int part = 0 ) const override SIP_HOLDGIL;
316  int partCount() const override SIP_HOLDGIL;
317  QgsPoint vertexAt( QgsVertexId id ) const override;
318  double segmentLength( QgsVertexId startVertex ) const override;
319 
320  bool addZValue( double zValue = 0 ) override;
321  bool addMValue( double mValue = 0 ) override;
322  bool dropZValue() override;
323  bool dropMValue() override;
324  void swapXy() override;
325 
326  QgsCurvePolygon *toCurveType() const override SIP_FACTORY;
327 
328  bool transform( QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback = nullptr ) override;
329 
330 #ifndef SIP_RUN
331  void filterVertices( const std::function< bool( const QgsPoint & ) > &filter ) override;
332  void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform ) override;
333 
341  inline static const QgsCurvePolygon *cast( const QgsAbstractGeometry *geom )
342  {
343  if ( !geom )
344  return nullptr;
345 
346  const QgsWkbTypes::Type flatType = QgsWkbTypes::flatType( geom->wkbType() );
347  if ( flatType == QgsWkbTypes::CurvePolygon
348  || flatType == QgsWkbTypes::Polygon
349  || flatType == QgsWkbTypes::Triangle )
350  return static_cast<const QgsCurvePolygon *>( geom );
351  return nullptr;
352  }
353 #endif
354 
356 
357 #ifdef SIP_RUN
358  SIP_PYOBJECT __repr__();
359  % MethodCode
360  QString wkt = sipCpp->asWkt();
361  if ( wkt.length() > 1000 )
362  wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
363  QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( wkt );
364  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
365  % End
366 #endif
367 
368  protected:
369 
370  int childCount() const override;
371  QgsAbstractGeometry *childGeometry( int index ) const override;
372  int compareToSameClass( const QgsAbstractGeometry *other ) const final;
373 
374  protected:
375 
376  std::unique_ptr< QgsCurve > mExteriorRing;
377  QVector<QgsCurve *> mInteriorRings;
378 
379  QgsRectangle calculateBoundingBox() const override;
380 };
381 
382 // clazy:excludeall=qstring-allocations
383 
384 #endif // QGSCURVEPOLYGON_H
TransformDirection
Flags for raster layer temporal capabilities.
Definition: qgis.h:1255
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:732
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:198
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:227
#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:166
#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:69
int precision
Utility class for identifying a unique vertex within a geometry.
Definition: qgsvertexid.h:31