-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsabstractgeometry.h
1257 lines (1083 loc) · 41 KB
/
qgsabstractgeometry.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgsabstractgeometry.h
-------------------------------------------------------------------
Date : 04 Sept 2014
Copyright : (C) 2014 by Marco Hugentobler
email : marco.hugentobler at sourcepole dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSABSTRACTGEOMETRYV2
#define QGSABSTRACTGEOMETRYV2
#include <functional>
#include <QString>
#include "qgis_core.h"
#include "qgscoordinatetransform.h"
#include "qgswkbtypes.h"
#include "qgswkbptr.h"
#ifndef SIP_RUN
#include "json_fwd.hpp"
using namespace nlohmann;
#endif
class QgsMapToPixel;
class QgsCurve;
class QgsMultiCurve;
class QgsMultiPoint;
struct QgsVertexId;
class QgsVertexIterator;
class QPainter;
class QDomDocument;
class QDomElement;
class QgsGeometryPartIterator;
class QgsGeometryConstPartIterator;
class QgsConstWkbPtr;
typedef QVector< QgsPoint > QgsPointSequence;
#ifndef SIP_RUN
typedef QVector< QgsPointSequence > QgsRingSequence;
typedef QVector< QgsRingSequence > QgsCoordinateSequence;
#else
typedef QVector< QVector< QgsPoint > > QgsRingSequence;
typedef QVector< QVector< QVector< QgsPoint > > > QgsCoordinateSequence;
#endif
/**
* \ingroup core
* \class QgsAbstractGeometry
* \brief Abstract base class for all geometries
*
* \note QgsAbstractGeometry objects are inherently Cartesian/planar geometries. They have no concept of geodesy, and none
* of the methods or properties exposed from the QgsAbstractGeometry API (or QgsGeometry API) utilize
* geodesic calculations. Accordingly, properties like length() and area() and spatial operations like centroid()
* are always calculated using strictly Cartesian mathematics. In contrast, the QgsDistanceArea class exposes
* methods for working with geodesic calculations and spatial operations on geometries,
* and should be used whenever calculations which account for the curvature of the Earth (or any other celestial body)
* are required.
*
* \since QGIS 2.10
*/
class CORE_EXPORT QgsAbstractGeometry
{
#ifdef SIP_RUN
SIP_CONVERT_TO_SUBCLASS_CODE
if ( qgsgeometry_cast<QgsPoint *>( sipCpp ) != nullptr )
sipType = sipType_QgsPoint;
else if ( qgsgeometry_cast<QgsLineString *>( sipCpp ) != nullptr )
sipType = sipType_QgsLineString;
else if ( qgsgeometry_cast<QgsCircularString *>( sipCpp ) != nullptr )
sipType = sipType_QgsCircularString;
else if ( qgsgeometry_cast<QgsCompoundCurve *>( sipCpp ) != nullptr )
sipType = sipType_QgsCompoundCurve;
else if ( qgsgeometry_cast<QgsTriangle *>( sipCpp ) != nullptr )
sipType = sipType_QgsTriangle;
else if ( qgsgeometry_cast<QgsPolygon *>( sipCpp ) != nullptr )
sipType = sipType_QgsPolygon;
else if ( qgsgeometry_cast<QgsCurvePolygon *>( sipCpp ) != nullptr )
sipType = sipType_QgsCurvePolygon;
else if ( qgsgeometry_cast<QgsMultiPoint *>( sipCpp ) != nullptr )
sipType = sipType_QgsMultiPoint;
else if ( qgsgeometry_cast<QgsMultiLineString *>( sipCpp ) != nullptr )
sipType = sipType_QgsMultiLineString;
else if ( qgsgeometry_cast<QgsMultiPolygon *>( sipCpp ) != nullptr )
sipType = sipType_QgsMultiPolygon;
else if ( qgsgeometry_cast<QgsMultiSurface *>( sipCpp ) != nullptr )
sipType = sipType_QgsMultiSurface;
else if ( qgsgeometry_cast<QgsMultiCurve *>( sipCpp ) != nullptr )
sipType = sipType_QgsMultiCurve;
else if ( qgsgeometry_cast<QgsGeometryCollection *>( sipCpp ) != nullptr )
sipType = sipType_QgsGeometryCollection;
else
sipType = 0;
SIP_END
#endif
Q_GADGET
public:
//! Segmentation tolerance as maximum angle or maximum difference between approximation and circle
enum SegmentationToleranceType
{
/**
* Maximum angle between generating radii (lines from arc center
* to output vertices) */
MaximumAngle = 0,
/**
* Maximum distance between an arbitrary point on the original
* curve and closest point on its approximation. */
MaximumDifference
};
Q_ENUM( SegmentationToleranceType )
//! Axis order for GML generation
enum AxisOrder
{
/**
* X comes before Y (or lon before lat)
*/
XY = 0,
/**
* Y comes before X (or lat before lon)
*/
YX
};
Q_ENUM( QgsAbstractGeometry::AxisOrder )
/**
* Constructor for QgsAbstractGeometry.
*/
QgsAbstractGeometry() = default;
virtual ~QgsAbstractGeometry() = default;
QgsAbstractGeometry( const QgsAbstractGeometry &geom );
QgsAbstractGeometry &operator=( const QgsAbstractGeometry &geom );
virtual bool operator==( const QgsAbstractGeometry &other ) const = 0;
virtual bool operator!=( const QgsAbstractGeometry &other ) const = 0;
/**
* Clones the geometry by performing a deep copy
*/
virtual QgsAbstractGeometry *clone() const = 0 SIP_FACTORY;
/**
* Clears the geometry, ie reset it to a null geometry
*/
virtual void clear() = 0;
/**
* Returns the minimal bounding box for the geometry
*/
virtual QgsRectangle boundingBox() const = 0;
//mm-sql interface
/**
* Returns the inherent dimension of the geometry. For example, this is 0 for a point geometry,
* 1 for a linestring and 2 for a polygon.
*/
virtual int dimension() const = 0;
/**
* Returns a unique string representing the geometry type.
* \see wkbType
* \see wktTypeStr
*/
virtual QString geometryType() const = 0;
/**
* Returns the WKB type of the geometry.
* \see geometryType
* \see wktTypeStr
*/
inline QgsWkbTypes::Type wkbType() const { return mWkbType; }
/**
* Returns the WKT type string of the geometry.
* \see geometryType
* \see wkbType
*/
QString wktTypeStr() const;
/**
* Returns TRUE if the geometry is 3D and contains a z-value.
* \see isMeasure
*/
bool is3D() const
{
return QgsWkbTypes::hasZ( mWkbType );
}
/**
* Returns TRUE if the geometry contains m values.
* \see is3D
*/
bool isMeasure() const
{
return QgsWkbTypes::hasM( mWkbType );
}
/**
* Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
* For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
* \returns boundary for geometry. May be NULLPTR for some geometry types.
* \since QGIS 3.0
*/
virtual QgsAbstractGeometry *boundary() const = 0 SIP_FACTORY;
//import
/**
* Sets the geometry from a WKB string.
* After successful read the wkb argument will be at the position where the reading has stopped.
* \see fromWkt
*/
virtual bool fromWkb( QgsConstWkbPtr &wkb ) = 0;
/**
* Sets the geometry from a WKT string.
* \see fromWkb
*/
virtual bool fromWkt( const QString &wkt ) = 0;
//export
/**
* WKB export flags.
* \since QGIS 3.14
*/
enum WkbFlag
{
FlagExportTrianglesAsPolygons = 1 << 0, //!< Triangles should be exported as polygon geometries
};
Q_DECLARE_FLAGS( WkbFlags, WkbFlag )
/**
* Returns a WKB representation of the geometry.
*
* The optional \a flags argument specifies flags controlling WKB export behavior (since QGIS 3.14).
*
* \see asWkt
* \see asGml2
* \see asGml3
* \see asJson()
* \since QGIS 3.0
*/
virtual QByteArray asWkb( WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const = 0;
/**
* Returns a WKT representation of the geometry.
* \param precision number of decimal places for coordinates
* \see asWkb()
* \see asGml2()
* \see asGml3()
* \see asJson()
*/
virtual QString asWkt( int precision = 17 ) const = 0;
/**
* Returns a GML2 representation of the geometry.
* \param doc DOM document
* \param precision number of decimal places for coordinates
* \param ns XML namespace
* \param axisOrder Axis order for generated GML
* \see asWkb()
* \see asWkt()
* \see asGml3()
* \see asJson()
*/
virtual QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const = 0;
/**
* Returns a GML3 representation of the geometry.
* \param doc DOM document
* \param precision number of decimal places for coordinates
* \param ns XML namespace
* \param axisOrder Axis order for generated GML
* \see asWkb()
* \see asWkt()
* \see asGml2()
* \see asJson()
*/
virtual QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const = 0;
/**
* Returns a GeoJSON representation of the geometry as a QString.
* \param precision number of decimal places for coordinates
* \see asWkb()
* \see asWkt()
* \see asGml2()
* \see asGml3()
* \see asJsonObject()
*/
QString asJson( int precision = 17 );
/**
* Returns a json object representation of the geometry.
* \see asWkb()
* \see asWkt()
* \see asGml2()
* \see asGml3()
* \see asJson()
* \note not available in Python bindings
* \since QGIS 3.10
*/
virtual json asJsonObject( int precision = 17 ) SIP_SKIP const;
/**
* Returns a KML representation of the geometry.
* \since QGIS 3.12
*/
virtual QString asKml( int precision = 17 ) const = 0;
//render pipeline
/**
* Transforms the geometry using a coordinate transform
* \param ct coordinate transform
* \param d transformation direction
* \param transformZ set to TRUE to also transform z coordinates. This requires that
* the z coordinates in the geometry represent height relative to the vertical datum
* of the source CRS (generally ellipsoidal heights) and are expressed in its vertical
* units (generally meters). If FALSE, then z coordinates will not be changed by the
* transform.
*/
virtual void transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform, bool transformZ = false ) SIP_THROW( QgsCsException ) = 0;
/**
* Transforms the x and y components of the geometry using a QTransform object \a t.
*
* Optionally, the geometry's z values can be scaled via \a zScale and translated via \a zTranslate.
* Similarly, m-values can be scaled via \a mScale and translated via \a mTranslate.
*/
virtual void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0,
double mTranslate = 0.0, double mScale = 1.0 ) = 0;
/**
* Draws the geometry using the specified QPainter.
* \param p destination QPainter
*/
virtual void draw( QPainter &p ) const = 0;
/**
* Returns the vertex number corresponding to a vertex \a id.
*
* The vertex numbers start at 0, so a return value of 0 corresponds
* to the first vertex.
*
* Returns -1 if a corresponding vertex could not be found.
*
* \since QGIS 3.0
*/
virtual int vertexNumberFromVertexId( QgsVertexId id ) const = 0;
/**
* Returns next vertex id and coordinates
* \param id initial value should be the starting vertex id. The next vertex id will be stored
* in this variable if found.
* \param vertex container for found node
* \returns FALSE if at end
*/
virtual bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const = 0;
/**
* Returns the vertices adjacent to a specified \a vertex within a geometry.
* \since QGIS 3.0
*/
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ) const = 0;
/**
* Retrieves the sequence of geometries, rings and nodes.
* \returns coordinate sequence
*/
virtual QgsCoordinateSequence coordinateSequence() const = 0;
/**
* Returns the number of nodes contained in the geometry
*/
virtual int nCoordinates() const;
/**
* Returns the point corresponding to a specified vertex id
*/
virtual QgsPoint vertexAt( QgsVertexId id ) const = 0;
/**
* Searches for the closest segment of the geometry to a given point.
* \param pt specifies the point to find closest segment to
* \param segmentPt storage for the closest point within the geometry
* \param vertexAfter storage for the ID of the vertex at the end of the closest segment
* \param leftOf indicates whether the point lies on the left side of the geometry (-1 if point is to the left
* of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not
* be determined, e.g. point exactly on a line)
* FALSE if point is to right of segment)
* \param epsilon epsilon for segment snapping
* \returns squared distance to closest segment or negative value on error
*/
virtual 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 = 0;
//low-level editing
/**
* Inserts a vertex into the geometry
* \param position vertex id for position of inserted vertex
* \param vertex vertex to insert
* \returns TRUE if insert was successful
* \see moveVertex
* \see deleteVertex
*/
virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) = 0;
/**
* Moves a vertex within the geometry
* \param position vertex id for vertex to move
* \param newPos new position of vertex
* \returns TRUE if move was successful
* \see insertVertex
* \see deleteVertex
*/
virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) = 0;
/**
* Deletes a vertex within the geometry
* \param position vertex id for vertex to delete
* \returns TRUE if delete was successful
* \see insertVertex
* \see moveVertex
*/
virtual bool deleteVertex( QgsVertexId position ) = 0;
/**
* Returns the planar, 2-dimensional length of the geometry.
*
* \warning QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the length
* returned by this method is calculated using strictly Cartesian mathematics. In contrast,
* the QgsDistanceArea class exposes methods for calculating the lengths of geometries using
* geodesic calculations which account for the curvature of the Earth (or any other
* celestial body).
*
* \see area()
* \see perimeter()
*/
virtual double length() const;
/**
* Returns the planar, 2-dimensional perimeter of the geometry.
*
* \warning QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the perimeter
* returned by this method is calculated using strictly Cartesian mathematics. In contrast,
* the QgsDistanceArea class exposes methods for calculating the perimeters of geometries using
* geodesic calculations which account for the curvature of the Earth (or any other
* celestial body).
*
* \see area()
* \see length()
*/
virtual double perimeter() const;
/**
* Returns the planar, 2-dimensional area of the geometry.
*
* \warning QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the area
* returned by this method is calculated using strictly Cartesian mathematics. In contrast,
* the QgsDistanceArea class exposes methods for calculating the areas of geometries using
* geodesic calculations which account for the curvature of the Earth (or any other
* celestial body).
*
* \see length()
* \see perimeter()
*/
virtual double area() const;
/**
* Returns the length of the segment of the geometry which begins at \a startVertex.
*
* \warning QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the lengths
* returned by this method are calculated using strictly Cartesian mathematics.
*
* \since QGIS 3.0
*/
virtual double segmentLength( QgsVertexId startVertex ) const = 0;
//! Returns the centroid of the geometry
virtual QgsPoint centroid() const;
/**
* Returns TRUE if the geometry is empty
*/
virtual bool isEmpty() const;
/**
* Returns TRUE if the geometry contains curved segments
*/
virtual bool hasCurvedSegments() const;
/**
* Returns a version of the geometry without curves. Caller takes ownership of
* the returned geometry.
* \param tolerance segmentation tolerance
* \param toleranceType maximum segmentation angle or maximum difference between approximation and curve
*/
virtual QgsAbstractGeometry *segmentize( double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY;
/**
* Returns the geometry converted to the more generic curve type.
* E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon,
* QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface
* \returns the converted geometry. Caller takes ownership
*/
virtual QgsAbstractGeometry *toCurveType() const = 0 SIP_FACTORY;
/**
* Makes a new geometry with all the points or vertices snapped to the closest point of the grid.
* Ownership is transferred to the caller.
*
* If the gridified geometry could not be calculated NULLPTR will be returned.
* It may generate an invalid geometry (in some corner cases).
* It can also be thought as rounding the edges and it may be useful for removing errors.
*
* ### Example
*
* \code{.cpp}
* geometry->snappedToGrid(1, 1);
* \endcode
*
* In this case we use a 2D grid of 1x1 to gridify.
* In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).
* \param hSpacing Horizontal spacing of the grid (x axis). 0 to disable.
* \param vSpacing Vertical spacing of the grid (y axis). 0 to disable.
* \param dSpacing Depth spacing of the grid (z axis). 0 (default) to disable.
* \param mSpacing Custom dimension spacing of the grid (m axis). 0 (default) to disable.
* \since 3.0
*/
virtual QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const = 0 SIP_FACTORY;
/**
* Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a
* degenerate geometry.
*
* The \a epsilon parameter specifies the tolerance for coordinates when determining that
* vertices are identical.
*
* By default, z values are not considered when detecting duplicate nodes. E.g. two nodes
* with the same x and y coordinate but different z values will still be considered
* duplicate and one will be removed. If \a useZValues is TRUE, then the z values are
* also tested and nodes with the same x and y but different z will be maintained.
*
* Note that duplicate nodes are not tested between different parts of a multipart geometry. E.g.
* a multipoint geometry with overlapping points will not be changed by this method.
*
* The function will return TRUE if nodes were removed, or FALSE if no duplicate nodes
* were found.
*
* \since QGIS 3.0
*/
virtual bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) = 0;
/**
* Returns approximate angle at a vertex. This is usually the average angle between adjacent
* segments, and can be pictured as the orientation of a line following the curvature of the
* geometry at the specified vertex.
* \param vertex the vertex id
* \returns rotation in radians, clockwise from north
*/
virtual double vertexAngle( QgsVertexId vertex ) const = 0;
/**
* Returns the number of vertices of which this geometry is built.
*/
virtual int vertexCount( int part = 0, int ring = 0 ) const = 0;
/**
* Returns the number of rings of which this geometry is built.
*/
virtual int ringCount( int part = 0 ) const = 0;
/**
* Returns count of parts contained in the geometry.
* \see vertexCount
* \see ringCount
*/
virtual int partCount() const = 0;
/**
* Adds a z-dimension to the geometry, initialized to a preset value.
* \param zValue initial z-value for all nodes
* \returns TRUE on success
* \see dropZValue()
* \see addMValue()
* \since QGIS 2.12
*/
virtual bool addZValue( double zValue = 0 ) = 0;
/**
* Adds a measure to the geometry, initialized to a preset value.
* \param mValue initial m-value for all nodes
* \returns TRUE on success
* \see dropMValue()
* \see addZValue()
* \since QGIS 2.12
*/
virtual bool addMValue( double mValue = 0 ) = 0;
/**
* Drops any z-dimensions which exist in the geometry.
* \returns TRUE if Z values were present and have been removed
* \see addZValue()
* \see dropMValue()
* \since QGIS 2.14
*/
virtual bool dropZValue() = 0;
/**
* Drops any measure values which exist in the geometry.
* \returns TRUE if m-values were present and have been removed
* \see addMValue()
* \see dropZValue()
* \since QGIS 2.14
*/
virtual bool dropMValue() = 0;
/**
* Swaps the x and y coordinates from the geometry. This can be used
* to repair geometries which have accidentally had their latitude and longitude
* coordinates reversed.
* \since QGIS 3.2
*/
virtual void swapXy() = 0;
/**
* Converts the geometry to a specified type.
* \returns TRUE if conversion was successful
* \since QGIS 2.14
*/
virtual bool convertTo( QgsWkbTypes::Type type );
/**
* Checks validity of the geometry, and returns TRUE if the geometry is valid.
*
* \param error will be set to the validity error message
* \param flags indicates optional flags which control the type of validity checking performed
* (corresponding to QgsGeometry::ValidityFlags).
*
* \returns TRUE if geometry is valid
*
* \since QGIS 3.8
*/
virtual bool isValid( QString &error SIP_OUT, int flags = 0 ) const = 0;
#ifndef SIP_RUN
/**
* Filters the vertices from the geometry in place, removing any which do not return TRUE for the \a filter function
* check. Has no meaning when called on a single point geometry.
*
* Depending on the \a filter used, this may result in an invalid geometry.
*
* \note Not available in Python bindings
* \since QGIS 3.2
*/
virtual void filterVertices( const std::function< bool( const QgsPoint & ) > &filter );
/**
* Transforms the vertices from the geometry in place, applying the \a transform function
* to every vertex.
*
* Depending on the \a transform used, this may result in an invalid geometry.
*
* Transform functions are not permitted to alter the dimensionality of vertices. If
* a transform which adds (or removes) z/m values is desired, first call the corresponding
* addZValue() or addMValue() function to change the geometry's dimensionality and then
* transform.
*
* \note Not available in Python bindings
* \since QGIS 3.4
*/
virtual void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform );
/**
* \ingroup core
* The part_iterator class provides STL-style iterator for geometry parts.
* \since QGIS 3.6
*/
class CORE_EXPORT part_iterator
{
private:
int mIndex = 0; //!< Current part in the geometry
QgsAbstractGeometry *mGeometry = nullptr;
public:
//! Create invalid iterator
part_iterator() = default;
//! Create part iterator for a geometry
part_iterator( QgsAbstractGeometry *g, int index );
/**
* The prefix ++ operator (++it) advances the iterator to the next part and returns an iterator to the new current part.
* Calling this function on iterator that is already past the last item leads to undefined results.
*/
part_iterator &operator++();
//! The postfix ++ operator (it++) advances the iterator to the next part and returns an iterator to the previously current part.
part_iterator operator++( int );
//! Returns the current item.
QgsAbstractGeometry *operator*() const;
//! Returns the part number of the current item.
int partNumber() const;
bool operator==( part_iterator other ) const;
bool operator!=( part_iterator other ) const { return !( *this == other ); }
};
/**
* Returns STL-style iterator pointing to the first part of the geometry.
*
* \see parts_end()
* \see parts()
*
* \since QGIS 3.6
*/
part_iterator parts_begin()
{
return part_iterator( this, 0 );
}
/**
* Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.
*
* \see parts_begin()
* \see parts()
*
* \since QGIS 3.6
*/
part_iterator parts_end();
/**
* Returns Java-style iterator for traversal of parts of the geometry. This iterator
* returns read-only references to parts and cannot be used to modify the parts.
*
* \note Not available in Python bindings
* \since QGIS 3.6
*/
QgsGeometryConstPartIterator parts() const;
/**
* \ingroup core
* The part_iterator class provides STL-style iterator for const references to geometry parts.
* \since QGIS 3.6
*/
class CORE_EXPORT const_part_iterator
{
private:
int mIndex = 0; //!< Current part in the geometry
const QgsAbstractGeometry *mGeometry = nullptr;
public:
//! Create invalid iterator
const_part_iterator() = default;
//! Create part iterator for a geometry
const_part_iterator( const QgsAbstractGeometry *g, int index );
/**
* The prefix ++ operator (++it) advances the iterator to the next part and returns an iterator to the new current part.
* Calling this function on iterator that is already past the last item leads to undefined results.
*/
const_part_iterator &operator++();
//! The postfix ++ operator (it++) advances the iterator to the next part and returns an iterator to the previously current part.
const_part_iterator operator++( int );
//! Returns the current item.
const QgsAbstractGeometry *operator*() const;
//! Returns the part number of the current item.
int partNumber() const;
bool operator==( const_part_iterator other ) const;
bool operator!=( const_part_iterator other ) const { return !( *this == other ); }
};
/**
* Returns STL-style iterator pointing to the const first part of the geometry.
*
* \see const_parts_end()
*
* \since QGIS 3.6
*/
const_part_iterator const_parts_begin() const
{
return const_part_iterator( this, 0 );
}
/**
* Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry.
*
* \see const_parts_begin()
*
* \since QGIS 3.6
*/
const_part_iterator const_parts_end() const;
/**
* \ingroup core
* The vertex_iterator class provides STL-style iterator for vertices.
* \since QGIS 3.0
*/
class CORE_EXPORT vertex_iterator
{
private:
/**
* A helper structure to keep track of vertex traversal within one level within a geometry.
* For example, linestring geometry will have just one level, while multi-polygon has three levels
* (part index, ring index, vertex index).
*/
struct Level
{
const QgsAbstractGeometry *g = nullptr; //!< Current geometry
int index = 0; //!< Ptr in the current geometry
};
Level levels[3]; //!< Stack of levels - three levels should be sufficient (e.g. part index, ring index, vertex index)
int depth = -1; //!< At what depth level are we right now
void digDown(); //!< Prepare the stack of levels so that it points to a leaf child geometry
public:
//! Create invalid iterator
vertex_iterator() = default;
//! Create vertex iterator for a geometry
vertex_iterator( const QgsAbstractGeometry *g, int index );
/**
* The prefix ++ operator (++it) advances the iterator to the next vertex and returns an iterator to the new current vertex.
* Calling this function on iterator that is already past the last item leads to undefined results.
*/
vertex_iterator &operator++();
//! The postfix ++ operator (it++) advances the iterator to the next vertex and returns an iterator to the previously current vertex.
vertex_iterator operator++( int );
//! Returns the current item.
QgsPoint operator*() const;
//! Returns vertex ID of the current item.
QgsVertexId vertexId() const;
bool operator==( const vertex_iterator &other ) const;
bool operator!=( const vertex_iterator &other ) const { return !( *this == other ); }
};
/**
* Returns STL-style iterator pointing to the first vertex of the geometry.
*
* \see vertices_end()
* \see vertices()
*
* \since QGIS 3.0
*/
vertex_iterator vertices_begin() const
{
return vertex_iterator( this, 0 );
}
/**
* Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry.
*
* \see vertices_begin()
* \see vertices()
*
* \since QGIS 3.0
*/
vertex_iterator vertices_end() const
{
return vertex_iterator( this, childCount() );
}
#endif
/**
* Returns Java-style iterator for traversal of parts of the geometry. This iterator
* can safely be used to modify parts of the geometry.
*
* ### Example
*
* \code{.py}
* # print the WKT representation of each part in a multi-point geometry
* geometry = QgsMultiPoint.fromWkt( 'MultiPoint( 0 0, 1 1, 2 2)' )
* for part in geometry.parts():
* print(part.asWkt())
*
* # single part geometries only have one part - this loop will iterate once only
* geometry = QgsLineString.fromWkt( 'LineString( 0 0, 10 10 )' )
* for part in geometry.parts():
* print(part.asWkt())
*
* # parts can be modified during the iteration
* geometry = QgsMultiPoint.fromWkt( 'MultiPoint( 0 0, 1 1, 2 2)' )
* for part in geometry.parts():
* part.transform(ct)
*
* # part iteration can also be combined with vertex iteration
* geometry = QgsMultiPolygon.fromWkt( 'MultiPolygon((( 0 0, 0 10, 10 10, 10 0, 0 0 ),( 5 5, 5 6, 6 6, 6 5, 5 5)),((20 2, 22 2, 22 4, 20 4, 20 2)))' )
* for part in geometry.parts():
* for v in part.vertices():
* print(v.x(), v.y())
*
* \endcode
*
* \see vertices()
* \since QGIS 3.6
*/
QgsGeometryPartIterator parts();
/**
* Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings.
*
* \warning The iterator returns a copy of individual vertices, and accordingly geometries cannot be
* modified using the iterator. See transformVertices() for a safe method to modify vertices "in-place".
*
* ### Example
*
* \code{.py}
* # print the x and y coordinate for each vertex in a LineString
* geometry = QgsLineString.fromWkt( 'LineString( 0 0, 1 1, 2 2)' )
* for v in geometry.vertices():
* print(v.x(), v.y())
*
* # vertex iteration includes all parts and rings
* geometry = QgsMultiPolygon.fromWkt( 'MultiPolygon((( 0 0, 0 10, 10 10, 10 0, 0 0 ),( 5 5, 5 6, 6 6, 6 5, 5 5)),((20 2, 22 2, 22 4, 20 4, 20 2)))' )
* for v in geometry.vertices():
* print(v.x(), v.y())
* \endcode
*
* \see parts()
* \since QGIS 3.0
*/
QgsVertexIterator vertices() const;
/**
* Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
* To create it, the geometry is default constructed and then the WKB is changed.
* \see clone()
* \since 3.0
*/
virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 SIP_FACTORY;
protected:
/**
* Returns whether the geometry has any child geometries (FALSE for point / curve, TRUE otherwise)
* \note used for vertex_iterator implementation
* \since QGIS 3.0
*/
virtual bool hasChildGeometries() const;
/**
* Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. curve / point)
* \note used for vertex_iterator implementation
* \since QGIS 3.0
*/
virtual int childCount() const { return 0; }
/**
* Returns pointer to child geometry (for geometries with child geometries - i.e. geom. collection / polygon)
* \note used for vertex_iterator implementation
* \since QGIS 3.0
*/
virtual QgsAbstractGeometry *childGeometry( int index ) const { Q_UNUSED( index ) return nullptr; }
/**
* Returns point at index (for geometries without child geometries - i.e. curve / point)
* \note used for vertex_iterator implementation
* \since QGIS 3.0