QGIS API Documentation  3.10.0-A CoruĂ±a (6c816b4204)
qgsgeometrycollection.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometrycollection.h
3  -------------------------------------------------------------------
4 Date : 28 Oct 2014
5 Copyright : (C) 2014 by Marco Hugentobler
6 email : marco.hugentobler at sourcepole dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15
16 #ifndef QGSGEOMETRYCOLLECTION_H
17 #define QGSGEOMETRYCOLLECTION_H
18
19 #include <QVector>
20
21
22 #include "qgis_core.h"
23 #include "qgis_sip.h"
24 #include "qgsabstractgeometry.h"
25
26 class QgsPoint;
27
28
35 class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry
36 {
37  public:
41  ~QgsGeometryCollection() override;
42
43  bool operator==( const QgsAbstractGeometry &other ) const override;
44  bool operator!=( const QgsAbstractGeometry &other ) const override;
45
46  QgsGeometryCollection *clone() const override SIP_FACTORY;
47
51  int numGeometries() const
52  {
53  return mGeometries.size();
54  }
55
56 #ifdef SIP_RUN
57
61  int __len__() const;
62  % MethodCode
63  sipRes = sipCpp->numGeometries();
64  % End
65
67  int __bool__() const;
68  % MethodCode
69  sipRes = true;
70  % End
71 #endif
72
73
79  const QgsAbstractGeometry *geometryN( int n ) const SIP_SKIP
80  {
81  return mGeometries.value( n );
82  }
83
84 #ifndef SIP_RUN
85
90  QgsAbstractGeometry *geometryN( int n );
91 #else
92
97  SIP_PYOBJECT geometryN( int n ) SIP_TYPEHINT( QgsAbstractGeometry );
98  % MethodCode
99  if ( a0 < 0 || a0 >= sipCpp->numGeometries() )
100  {
101  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
102  sipIsErr = 1;
103  }
104  else
105  {
106  return sipConvertFromType( sipCpp->geometryN( a0 ), sipType_QgsAbstractGeometry, NULL );
107  }
108  % End
109 #endif
110
111
112  //methods inherited from QgsAbstractGeometry
113  bool isEmpty() const override;
114  int dimension() const override;
115  QString geometryType() const override;
116  void clear() override;
117  QgsGeometryCollection *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
118  bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) override;
119  QgsAbstractGeometry *boundary() const override SIP_FACTORY;
120  void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const override;
121  int vertexNumberFromVertexId( QgsVertexId id ) const override;
122
131  void reserve( int size );
132
134  virtual bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER );
135
141  virtual bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index );
142
143 #ifndef SIP_RUN
144
150  virtual bool removeGeometry( int nr );
151 #else
152
160  virtual bool removeGeometry( int nr );
161  % MethodCode
162  const int count = sipCpp->numGeometries();
163  if ( a0 < 0 || a0 >= count )
164  {
165  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
166  sipIsErr = 1;
167  }
168  else
169  {
170  return PyBool_FromLong( sipCpp->removeGeometry( a0 ) );
171  }
172  % End
173 #endif
174
176  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
177
178  void draw( QPainter &p ) const override;
179
180  bool fromWkb( QgsConstWkbPtr &wkb ) override;
181  bool fromWkt( const QString &wkt ) override;
182  QByteArray asWkb() const override;
183  QString asWkt( int precision = 17 ) const override;
184  QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
185  QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
186  json asJsonObject( int precision = 17 ) const override SIP_SKIP;
187
188  QgsRectangle boundingBox() const override;
189
190  QgsCoordinateSequence coordinateSequence() const override;
191  int nCoordinates() const override;
192
193  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;
194  bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override;
195
196  //low-level editing
197  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
198  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
199  bool deleteVertex( QgsVertexId position ) override;
200
201  double length() const override;
202  double area() const override;
203  double perimeter() const override;
204
205  bool hasCurvedSegments() const override;
206
211  QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
212
213  double vertexAngle( QgsVertexId vertex ) const override;
214  double segmentLength( QgsVertexId startVertex ) const override;
215  int vertexCount( int part = 0, int ring = 0 ) const override;
216  int ringCount( int part = 0 ) const override;
217  int partCount() const override;
218  QgsPoint vertexAt( QgsVertexId id ) const override;
219  bool isValid( QString &error SIP_OUT, int flags = 0 ) const override;
220
221  bool addZValue( double zValue = 0 ) override;
222  bool addMValue( double mValue = 0 ) override;
223  bool dropZValue() override;
224  bool dropMValue() override;
225  void swapXy() override;
227
228 #ifndef SIP_RUN
229  void filterVertices( const std::function< bool( const QgsPoint & ) > &filter ) override;
230  void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform ) override;
231
239  inline const QgsGeometryCollection *cast( const QgsAbstractGeometry *geom ) const
240  {
241  if ( geom && QgsWkbTypes::isMultiType( geom->wkbType() ) )
242  return static_cast<const QgsGeometryCollection *>( geom );
243  return nullptr;
244  }
245 #endif
246
247
248 #ifdef SIP_RUN
249
258  SIP_PYOBJECT __getitem__( int index ) SIP_TYPEHINT( QgsAbstractGeometry );
259  % MethodCode
260  const int count = sipCpp->numGeometries();
261  if ( a0 < -count || a0 >= count )
262  {
263  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
264  sipIsErr = 1;
265  }
266  else if ( a0 >= 0 )
267  {
268  return sipConvertFromType( sipCpp->geometryN( a0 ), sipType_QgsAbstractGeometry, NULL );
269  }
270  else
271  {
272  return sipConvertFromType( sipCpp->geometryN( count + a0 ), sipType_QgsAbstractGeometry, NULL );
273  }
274  % End
275
284  void __delitem__( int index );
285  % MethodCode
286  const int count = sipCpp->numGeometries();
287  if ( a0 >= 0 && a0 < count )
288  sipCpp->removeGeometry( a0 );
289  else if ( a0 < 0 && a0 >= -count )
290  sipCpp->removeGeometry( count + a0 );
291  else
292  {
293  PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
294  sipIsErr = 1;
295  }
296  % End
297
303  SIP_PYOBJECT __iter__() SIP_TYPEHINT( QgsGeometryPartIterator );
304  % MethodCode
305  sipRes = sipConvertFromNewType( new QgsGeometryPartIterator( sipCpp ), sipType_QgsGeometryPartIterator, Py_None );
306  % End
307 #endif
308
310
311  protected:
312  int childCount() const override;
313  QgsAbstractGeometry *childGeometry( int index ) const override;
314
315  protected:
316  QVector< QgsAbstractGeometry * > mGeometries;
317
322  virtual bool wktOmitChildType() const;
323
327  bool fromCollectionWkt( const QString &wkt, const QVector<QgsAbstractGeometry *> &subtypes, const QString &defaultChildWkbType = QString() );
328
329  QgsRectangle calculateBoundingBox() const override;
330  void clearCache() const override;
331
332  private:
333
334  mutable QgsRectangle mBoundingBox;
335  mutable bool mHasCachedValidity = false;
336  mutable QString mValidityFailureReason;
337 };
338
339 // clazy:excludeall=qstring-allocations
340
341 #endif // QGSGEOMETRYCOLLECTION_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...
Java-style iterator for traversal of parts of a geometry.
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...
virtual bool deleteVertex(QgsVertexId position)=0
Deletes a vertex within the geometry.
virtual bool isValid(QString &error, int flags=0) const =0
Checks validity of the geometry, and returns true if the geometry is valid.
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.
virtual QByteArray asWkb() const =0
Returns a WKB representation of the geometry.
QgsAbstractGeometry & operator=(const QgsAbstractGeometry &geom)
static bool isMultiType(Type type)
Returns true if the WKB type is a multi type.
Definition: qgswkbtypes.h:706
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.
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 QgsRectangle boundingBox() const =0
Returns the minimal bounding box for the geometry.
virtual QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:213
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
virtual double length() const
Returns the planar, 2-dimensional length of the geometry.
virtual bool operator!=(const QgsAbstractGeometry &other) const =0
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 void clearCache() const
Clears any cached parameters associated with the geometry, e.g., bounding boxes.
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.
Geometry collection.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
const QgsGeometryCollection * cast(const QgsAbstractGeometry *geom) const
Cast the geom to a QgsGeometryCollection.
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.
#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.
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
AxisOrder
Axis order for GML generation.
int numGeometries() const
Returns the number of geometries within the collection.
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.
QVector< QgsAbstractGeometry *> mGeometries
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
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.
const QgsAbstractGeometry * geometryN(int n) const
Returns a const reference to a geometry from within the collection.
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
Class for doing transforms between two map coordinate systems.
#define SIP_THROW(name)
Definition: qgis_sip.h:184
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.
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.
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 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;. 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 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.