-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsgeometry.h
2499 lines (2258 loc) · 102 KB
/
qgsgeometry.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
/***************************************************************************
qgsgeometry.h - Geometry (stored as Open Geospatial Consortium WKB)
-------------------------------------------------------------------
Date : 02 May 2005
Copyright : (C) 2005 by Brendan Morley
email : morb at ozemail dot com dot au
***************************************************************************
* *
* 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 QGSGEOMETRY_H
#define QGSGEOMETRY_H
#include <functional>
#include <QDomDocument>
#include <QJsonObject>
#include <QSet>
#include <QString>
#include <QVector>
#include <climits>
#include <limits>
#include <memory>
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractgeometry.h"
#include "qgspointxy.h"
#include "qgspoint.h"
#include "qgsfeatureid.h"
#ifndef SIP_RUN
#include "json_fwd.hpp"
using namespace nlohmann;
#endif
class QgsGeometryEngine;
class QgsVectorLayer;
class QgsMapToPixel;
class QPainter;
class QgsPolygon;
class QgsLineString;
class QgsFeedback;
/**
* Polyline as represented as a vector of two-dimensional points.
*
* This type has no support for Z/M dimensions and use of QgsPolyline is encouraged instead.
*
* \note In QGIS 2.x this type was available as QgsPolyline.
*
* \since QGIS 3.0
*/
typedef QVector<QgsPointXY> QgsPolylineXY;
/**
* Polyline as represented as a vector of points.
*
* This type has full support for Z/M dimensions.
*
* \since QGIS 3.0
*/
typedef QgsPointSequence QgsPolyline;
//! Polygon: first item of the list is outer ring, inner rings (if any) start from second item
#ifndef SIP_RUN
typedef QVector<QgsPolylineXY> QgsPolygonXY;
#else
typedef QVector<QVector<QgsPointXY>> QgsPolygonXY;
#endif
//! A collection of QgsPoints that share a common collection of attributes
typedef QVector<QgsPointXY> QgsMultiPointXY;
//! A collection of QgsPolylines that share a common collection of attributes
#ifndef SIP_RUN
typedef QVector<QgsPolylineXY> QgsMultiPolylineXY;
#else
typedef QVector<QVector<QgsPointXY>> QgsMultiPolylineXY;
#endif
//! A collection of QgsPolygons that share a common collection of attributes
#ifndef SIP_RUN
typedef QVector<QgsPolygonXY> QgsMultiPolygonXY;
#else
typedef QVector<QVector<QVector<QgsPointXY>>> QgsMultiPolygonXY;
#endif
class QgsRectangle;
class QgsConstWkbPtr;
struct QgsGeometryPrivate;
/**
* \ingroup core
* A geometry is the spatial representation of a feature.
*
* QgsGeometry acts as a generic container for geometry objects. QgsGeometry objects are implicitly shared,
* so making copies of geometries is inexpensive. The geometry container class can also be stored inside
* a QVariant object.
*
* The actual geometry representation is stored as a QgsAbstractGeometry within the container, and
* can be accessed via the get() method or set using the set() method. This gives access to the underlying
* raw geometry primitive, such as the point, line, polygon, curve or other geometry subclasses.
*
* \note QgsGeometry objects are inherently Cartesian/planar geometries. They have no concept of geodesy, and none
* of the methods or properties exposed from the QgsGeometry API (or QgsAbstractGeometry subclasses) utilize
* geodesic calculations. Accordingly, properties like length() and area() or spatial operations like buffer()
* 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.
*/
class CORE_EXPORT QgsGeometry
{
Q_GADGET
Q_PROPERTY( bool isNull READ isNull )
Q_PROPERTY( QgsWkbTypes::GeometryType type READ type )
public:
/**
* Success or failure of a geometry operation.
* This gives details about cause of failure.
*/
enum OperationResult
{
Success = 0, //!< Operation succeeded
NothingHappened = 1000, //!< Nothing happened, without any error
InvalidBaseGeometry, //!< The base geometry on which the operation is done is invalid or empty
InvalidInputGeometryType, //!< The input geometry (ring, part, split line, etc.) has not the correct geometry type
SelectionIsEmpty, //!< No features were selected
SelectionIsGreaterThanOne, //!< More than one features were selected
GeometryEngineError, //!< Geometry engine misses a method implemented or an error occurred in the geometry engine
LayerNotEditable, //!< Cannot edit layer
/* Add part issues */
AddPartSelectedGeometryNotFound, //!< The selected geometry cannot be found
AddPartNotMultiGeometry, //!< The source geometry is not multi
/* Add ring issues*/
AddRingNotClosed, //!< The input ring is not closed
AddRingNotValid, //!< The input ring is not valid
AddRingCrossesExistingRings, //!< The input ring crosses existing rings (it is not disjoint)
AddRingNotInExistingFeature, //!< The input ring doesn't have any existing ring to fit into
/* Split features */
SplitCannotSplitPoint, //!< Cannot split points
};
Q_ENUM( OperationResult )
//! Constructor
QgsGeometry();
//! Copy constructor will prompt a deep copy of the object
QgsGeometry( const QgsGeometry & );
/**
* Creates a deep copy of the object
* \note not available in Python bindings
*/
QgsGeometry &operator=( QgsGeometry const &rhs ) SIP_SKIP;
/**
* Creates a geometry from an abstract geometry object. Ownership of
* geom is transferred.
* \since QGIS 2.10
*/
explicit QgsGeometry( QgsAbstractGeometry *geom SIP_TRANSFER );
/**
* Creates a geometry from an abstract geometry object. Ownership of
* geom is transferred.
* \note Not available in Python bindings
*/
explicit QgsGeometry( std::unique_ptr< QgsAbstractGeometry > geom ) SIP_SKIP;
virtual ~QgsGeometry();
/**
* Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
*
* This is much faster then calling the non-const get() method.
*
* \note In QGIS 2.x this method was named geometry().
*
* \see set()
* \see get()
* \since QGIS 3.0
*/
const QgsAbstractGeometry *constGet() const;
/**
* Returns a modifiable (non-const) reference to the underlying abstract geometry primitive.
*
* This method can be slow to call, as it may trigger a detachment of the geometry
* and a deep copy. Where possible, use constGet() instead.
*
* \note In QGIS 2.x this method was named geometry().
*
* \see constGet()
* \see set()
* \since QGIS 3.0
*/
QgsAbstractGeometry *get();
/**
* Sets the underlying geometry store. Ownership of geometry is transferred.
*
* \note In QGIS 2.x this method was named setGeometry().
* \note This method is deprecated for usage in Python and will be removed from Python bindings with QGIS 4.
* Using this method will confuse Python's memory management and type information system.
* Better create a new QgsGeometry object instead.
*
* \see get()
* \see constGet()
* \since QGIS 3.0
*/
void set( QgsAbstractGeometry *geometry SIP_TRANSFER ) SIP_DEPRECATED;
/**
* Returns TRUE if the geometry is null (ie, contains no underlying geometry
* accessible via geometry() ).
* \see get
* \see isEmpty()
* \since QGIS 2.10
*/
bool isNull() const;
//! Creates a new geometry from a WKT string
static QgsGeometry fromWkt( const QString &wkt );
//! Creates a new geometry from a QgsPointXY object
static QgsGeometry fromPointXY( const QgsPointXY &point );
//! Creates a new geometry from a QgsMultiPointXY object
static QgsGeometry fromMultiPointXY( const QgsMultiPointXY &multipoint );
/**
* Creates a new LineString geometry from a list of QgsPointXY points.
*
* Using fromPolyline() is preferred, as fromPolyline() is more efficient
* and will respect any Z or M dimensions present in the input points.
*
* \note In QGIS 2.x this method was available as fromPolyline().
*
* \see fromPolyline()
* \since QGIS 3.0
*/
static QgsGeometry fromPolylineXY( const QgsPolylineXY &polyline );
/**
* Creates a new LineString geometry from a list of QgsPoint points.
*
* This method will respect any Z or M dimensions present in the input points.
* E.g. if input points are PointZ type, the resultant linestring will be
* a LineStringZ type.
*
* \since QGIS 3.0
*/
static QgsGeometry fromPolyline( const QgsPolyline &polyline );
//! Creates a new geometry from a QgsMultiPolylineXY object
static QgsGeometry fromMultiPolylineXY( const QgsMultiPolylineXY &multiline );
//! Creates a new geometry from a QgsPolygon
static QgsGeometry fromPolygonXY( const QgsPolygonXY &polygon );
//! Creates a new geometry from a QgsMultiPolygon
static QgsGeometry fromMultiPolygonXY( const QgsMultiPolygonXY &multipoly );
//! Creates a new geometry from a QgsRectangle
static QgsGeometry fromRect( const QgsRectangle &rect );
//! Creates a new multipart geometry from a list of QgsGeometry objects
static QgsGeometry collectGeometry( const QVector<QgsGeometry> &geometries );
/**
* Creates a wedge shaped buffer from a \a center point.
*
* The \a azimuth gives the angle (in degrees) for the middle of the wedge to point.
* The buffer width (in degrees) is specified by the \a angularWidth parameter. Note that the
* wedge will extend to half of the \a angularWidth either side of the \a azimuth direction.
*
* The outer radius of the buffer is specified via \a outerRadius, and optionally an
* \a innerRadius can also be specified.
*
* The returned geometry will be a CurvePolygon geometry containing circular strings. It may
* need to be segmentized to convert to a standard Polygon geometry.
*
* \since QGIS 3.2
*/
static QgsGeometry createWedgeBuffer( const QgsPoint ¢er, double azimuth, double angularWidth,
double outerRadius, double innerRadius = 0 );
/**
* Set the geometry, feeding in the buffer containing OGC Well-Known Binary and the buffer's length.
* This class will take ownership of the buffer.
* \note not available in Python bindings
*/
void fromWkb( unsigned char *wkb, int length ) SIP_SKIP;
/**
* Set the geometry, feeding in the buffer containing OGC Well-Known Binary
* \since QGIS 3.0
*/
void fromWkb( const QByteArray &wkb );
/**
* Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
* \see type
*/
QgsWkbTypes::Type wkbType() const;
/**
* Returns type of the geometry as a QgsWkbTypes::GeometryType
* \see wkbType
*/
QgsWkbTypes::GeometryType type() const;
/**
* Returns TRUE if the geometry is empty (eg a linestring with no vertices,
* or a collection with no geometries). A null geometry will always
* return TRUE for isEmpty().
* \see isNull()
*/
bool isEmpty() const;
//! Returns TRUE if WKB of the geometry is of WKBMulti* type
bool isMultipart() const;
/**
* Test if this geometry is exactly equal to another \a geometry.
*
* This is a strict equality check, where the underlying geometries must
* have exactly the same type, component vertices and vertex order.
*
* Calling this method is dramatically faster than the topological
* equality test performed by isGeosEqual().
*
* \note Comparing two null geometries will return FALSE.
*
* \see isGeosEqual()
* \since QGIS 1.5
*/
bool equals( const QgsGeometry &geometry ) const;
/**
* Compares the geometry with another geometry using GEOS.
*
* This method performs a slow, topological check, where geometries
* are considered equal if all of the their component edges overlap. E.g.
* lines with the same vertex locations but opposite direction will be
* considered equal by this method.
*
* Consider using the much faster, stricter equality test performed
* by equals() instead.
*
* \note Comparing two null geometries will return FALSE.
*
* \see equals()
* \since QGIS 1.5
*/
bool isGeosEqual( const QgsGeometry & ) const;
//! Validity check flags
enum ValidityFlag
{
FlagAllowSelfTouchingHoles = 1 << 0, //!< Indicates that self-touching holes are permitted. OGC validity states that self-touching holes are NOT permitted, whilst other vendor validity checks (e.g. ESRI) permit self-touching holes.
};
Q_DECLARE_FLAGS( ValidityFlags, ValidityFlag )
/**
* Checks validity of the geometry using GEOS.
*
* The \a flags parameter indicates optional flags which control the type of validity checking performed.
*
* \since QGIS 1.5
*/
bool isGeosValid( QgsGeometry::ValidityFlags flags = QgsGeometry::ValidityFlags() ) const;
/**
* Determines whether the geometry is simple (according to OGC definition),
* i.e. it has no anomalous geometric points, such as self-intersection or self-tangency.
* Uses GEOS library for the test.
* \note This is useful mainly for linestrings and linear rings. Polygons are simple by definition,
* for checking anomalies in polygon geometries one can use isGeosValid().
* \since QGIS 3.0
*/
bool isSimple() const;
/**
* Returns the planar, 2-dimensional area of the geometry.
*
* \warning QgsGeometry 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()
* \since QGIS 1.5
*/
double area() const;
/**
* Returns the planar, 2-dimensional length of geometry.
*
* \warning QgsGeometry 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()
* \since QGIS 1.5
*/
double length() const;
/**
* Returns the minimum distance between this geometry and another geometry.
* Will return a negative value if either geometry is empty or null.
*
* \warning QgsGeometry objects are inherently Cartesian/planar geometries, and the distance
* returned by this method is calculated using strictly Cartesian mathematics.
*/
double distance( const QgsGeometry &geom ) const;
#ifndef SIP_RUN
// TODO QGIS 4: consider renaming vertices_begin, vertices_end, parts_begin, parts_end, etc
// to camelCase
/**
* Returns STL-style iterator pointing to the first vertex of the geometry
* \since QGIS 3.0
*/
QgsAbstractGeometry::vertex_iterator vertices_begin() const;
/**
* Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry
* \since QGIS 3.0
*/
QgsAbstractGeometry::vertex_iterator vertices_end() const;
#endif
/**
* 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 = QgsGeometry.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 = QgsGeometry.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;
#ifndef SIP_RUN
/**
* Returns STL-style iterator pointing to the first part of the geometry.
*
* This method forces a detach. Use const_parts_begin() to avoid the detach
* if the parts are not going to be modified.
*
* \since QGIS 3.6
*/
QgsAbstractGeometry::part_iterator parts_begin();
/**
* Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.
*
* This method forces a detach. Use const_parts_begin() to avoid the detach
* if the parts are not going to be modified.
*
* \since QGIS 3.6
*/
QgsAbstractGeometry::part_iterator parts_end();
/**
* Returns STL-style const iterator pointing to the first part of the geometry.
*
* This method avoids a detach and is more efficient then parts_begin() for read
* only iteration.
*
* \since QGIS 3.6
*/
QgsAbstractGeometry::const_part_iterator const_parts_begin() const;
/**
* Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.
*
* This method avoids a detach and is more efficient then parts_end() for read
* only iteration.
*
* \since QGIS 3.6
*/
QgsAbstractGeometry::const_part_iterator const_parts_end() const;
#endif
/**
* Returns Java-style iterator for traversal of parts of the geometry. This iterator
* can safely be used to modify parts of the geometry.
*
* This method forces a detach. Use constParts() to avoid the detach
* if the parts are not going to be modified.
*
* ### Example
*
* \code{.py}
* # print the WKT representation of each part in a multi-point geometry
* geometry = QgsGeometry.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 = QgsGeometry.fromWkt( 'LineString( 0 0, 10 10 )' )
* for part in geometry.parts():
* print(part.asWkt())
*
* # parts can be modified during the iteration
* geometry = QgsGeometry.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 = QgsGeometry.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 constParts()
* \see vertices()
* \since QGIS 3.6
*/
QgsGeometryPartIterator parts();
/**
* 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.
*
* Unlike parts(), this method does not force a detach and is more efficient if read-only
* iteration only is required.
*
* ### Example
*
* \code{.py}
* # print the WKT representation of each part in a multi-point geometry
* geometry = QgsGeometry.fromWkt( 'MultiPoint( 0 0, 1 1, 2 2)' )
* for part in geometry.constParts():
* print(part.asWkt())
*
* # single part geometries only have one part - this loop will iterate once only
* geometry = QgsGeometry.fromWkt( 'LineString( 0 0, 10 10 )' )
* for part in geometry.constParts():
* print(part.asWkt())
*
* # part iteration can also be combined with vertex iteration
* geometry = QgsGeometry.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.constParts():
* for v in part.vertices():
* print(v.x(), v.y())
*
* \endcode
*
* \see parts()
* \see vertices()
* \since QGIS 3.6
*/
QgsGeometryConstPartIterator constParts() const;
/**
* Returns the Hausdorff distance between this geometry and \a geom. This is basically a measure of how similar or dissimilar 2 geometries are.
*
* This algorithm is an approximation to the standard Hausdorff distance. This approximation is exact or close enough for a large
* subset of useful cases. Examples of these are:
*
* - computing distance between Linestrings that are roughly parallel to each other,
* and roughly equal in length. This occurs in matching linear networks.
* - Testing similarity of geometries.
*
* If the default approximate provided by this method is insufficient, use hausdorffDistanceDensify() instead.
*
* In case of error -1 will be returned.
*
* \see hausdorffDistanceDensify()
* \since QGIS 3.0
*/
double hausdorffDistance( const QgsGeometry &geom ) const;
/**
* Returns the Hausdorff distance between this geometry and \a geom. This is basically a measure of how similar or dissimilar 2 geometries are.
*
* This function accepts a \a densifyFraction argument. The function performs a segment
* densification before computing the discrete Hausdorff distance. The \a densifyFraction parameter
* sets the fraction by which to densify each segment. Each segment will be split into a
* number of equal-length subsegments, whose fraction of the total length is
* closest to the given fraction.
*
* This method can be used when the default approximation provided by hausdorffDistance()
* is not sufficient. Decreasing the \a densifyFraction parameter will make the
* distance returned approach the true Hausdorff distance for the geometries.
*
* In case of error -1 will be returned.
*
* \see hausdorffDistance()
* \since QGIS 3.0
*/
double hausdorffDistanceDensify( const QgsGeometry &geom, double densifyFraction ) const;
//TODO QGIS 4.0 - rename beforeVertex to previousVertex, afterVertex to nextVertex
/**
* Returns the vertex closest to the given point, the corresponding vertex index, squared distance snap point / target point
* and the indices of the vertices before and after the closest vertex.
* \param point point to search for
* \param atVertex will be set to the vertex index of the closest found vertex
* \param beforeVertex will be set to the vertex index of the previous vertex from the closest one. Will be set to -1 if
* not present.
* \param afterVertex will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if
* not present.
* \param sqrDist will be set to the square distance between the closest vertex and the specified point
* \returns closest point in geometry. If not found (empty geometry), returns null point and sqrDist is negative.
*/
QgsPointXY closestVertex( const QgsPointXY &point, int &atVertex SIP_OUT, int &beforeVertex SIP_OUT, int &afterVertex SIP_OUT, double &sqrDist SIP_OUT ) const;
/**
* Returns the distance along this geometry from its first vertex to the specified vertex.
* \param vertex vertex index to calculate distance to
* \returns distance to vertex (following geometry), or -1 for invalid vertex numbers
* \warning QgsGeometry objects are inherently Cartesian/planar geometries, and the distance
* returned by this method is calculated using strictly Cartesian mathematics.
* \since QGIS 2.16
*/
double distanceToVertex( int vertex ) const;
/**
* Returns the bisector angle for this geometry at the specified vertex.
* \param vertex vertex index to calculate bisector angle at
* \returns bisector angle, in radians clockwise from north
* \see interpolateAngle()
* \since QGIS 3.0
*/
double angleAtVertex( int vertex ) const;
/**
* Returns the indexes of the vertices before and after the given vertex index.
*
* This function takes into account the following factors:
*
* # If the given vertex index is at the end of a linestring,
* the adjacent index will be -1 (for "no adjacent vertex")
* # If the given vertex index is at the end of a linear ring
* (such as in a polygon), the adjacent index will take into
* account the first vertex is equal to the last vertex (and will
* skip equal vertex positions).
*/
void adjacentVertices( int atVertex, int &beforeVertex SIP_OUT, int &afterVertex SIP_OUT ) const;
/**
* Insert a new vertex before the given vertex index,
* ring and item (first number is index 0)
* If the requested vertex number (beforeVertex.back()) is greater
* than the last actual vertex on the requested ring and item,
* it is assumed that the vertex is to be appended instead of inserted.
* Returns FALSE if atVertex does not correspond to a valid vertex
* on this geometry (including if this geometry is a Point).
* It is up to the caller to distinguish between
* these error conditions. (Or maybe we add another method to this
* object to help make the distinction?)
*/
bool insertVertex( double x, double y, int beforeVertex );
/**
* Insert a new vertex before the given vertex index,
* ring and item (first number is index 0)
* If the requested vertex number (beforeVertex.back()) is greater
* than the last actual vertex on the requested ring and item,
* it is assumed that the vertex is to be appended instead of inserted.
* Returns FALSE if atVertex does not correspond to a valid vertex
* on this geometry (including if this geometry is a Point).
* It is up to the caller to distinguish between
* these error conditions. (Or maybe we add another method to this
* object to help make the distinction?)
*/
bool insertVertex( const QgsPoint &point, int beforeVertex );
/**
* Moves the vertex at the given position number
* and item (first number is index 0)
* to the given coordinates.
* Returns FALSE if atVertex does not correspond to a valid vertex
* on this geometry
*/
bool moveVertex( double x, double y, int atVertex );
/**
* Moves the vertex at the given position number
* and item (first number is index 0)
* to the given coordinates.
* Returns FALSE if atVertex does not correspond to a valid vertex
* on this geometry
*/
bool moveVertex( const QgsPoint &p, int atVertex );
/**
* Deletes the vertex at the given position number and item
* (first number is index 0)
* \returns FALSE if atVertex does not correspond to a valid vertex
* on this geometry (including if this geometry is a Point),
* or if the number of remaining vertices in the linestring
* would be less than two.
* It is up to the caller to distinguish between
* these error conditions. (Or maybe we add another method to this
* object to help make the distinction?)
*/
bool deleteVertex( int atVertex );
/**
* Returns coordinates of a vertex.
* \param atVertex index of the vertex
* \returns Coordinates of the vertex or empty QgsPoint() on error
*/
QgsPoint vertexAt( int atVertex ) const;
/**
* Returns the squared Cartesian distance between the given point
* to the given vertex index (vertex at the given position number,
* ring and item (first number is index 0))
*/
double sqrDistToVertexAt( QgsPointXY &point SIP_IN, int atVertex ) const;
/**
* Returns the nearest point on this geometry to another geometry.
* \see shortestLine()
* \since QGIS 2.14
*/
QgsGeometry nearestPoint( const QgsGeometry &other ) const;
/**
* Returns the shortest line joining this geometry to another geometry.
* \see nearestPoint()
*
* \warning QgsGeometry objects are inherently Cartesian/planar geometries, and the line
* returned by this method is calculated using strictly Cartesian mathematics. See QgsDistanceArea
* for similar methods which account for the curvature of an ellipsoidal body such as the Earth.
*
* \since QGIS 2.14
*/
QgsGeometry shortestLine( const QgsGeometry &other ) const;
/**
* Searches for the closest vertex in this geometry to the given point.
* \param point Specifiest the point for search
* \param atVertex Receives index of the closest vertex
* \returns The squared Cartesian distance is also returned in sqrDist, negative number on error
*/
double closestVertexWithContext( const QgsPointXY &point, int &atVertex SIP_OUT ) const;
/**
* Searches for the closest segment of geometry to the given point
* \param point Specifies the point for search
* \param minDistPoint Receives the nearest point on the segment
* \param afterVertex Receives index of the vertex after the closest segment. The vertex
* before the closest segment is always afterVertex - 1
* \param leftOf Out: Returns if the point lies on the left of left side of the geometry ( < 0 means left, > 0 means right, 0 indicates
* that the test was unsuccessful, e.g. for a point exactly on the line)
* \param epsilon epsilon for segment snapping
* \returns The squared Cartesian distance is also returned in sqrDist, negative number on error
*/
double closestSegmentWithContext( const QgsPointXY &point, QgsPointXY &minDistPoint SIP_OUT, int &afterVertex SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
/**
* Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
* \param ring The ring to be added
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult addRing( const QVector<QgsPointXY> &ring );
/**
* Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
* \param ring The ring to be added
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult addRing( QgsCurve *ring SIP_TRANSFER );
/**
* Adds a new part to a the geometry.
* \param points points describing part to add
* \param geomType default geometry type to create if no existing geometry
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult addPart( const QVector<QgsPointXY> &points, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry ) SIP_PYNAME( addPointsXY );
/**
* Adds a new part to a the geometry.
* \param points points describing part to add
* \param geomType default geometry type to create if no existing geometry
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult addPart( const QgsPointSequence &points, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry ) SIP_PYNAME( addPoints );
/**
* Adds a new part to this geometry.
* \param part part to add (ownership is transferred)
* \param geomType default geometry type to create if no existing geometry
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult addPart( QgsAbstractGeometry *part SIP_TRANSFER, QgsWkbTypes::GeometryType geomType = QgsWkbTypes::UnknownGeometry );
/**
* Adds a new island polygon to a multipolygon feature
* \returns OperationResult a result code: success or reason of failure
* \note available in python bindings as addPartGeometry
*/
OperationResult addPart( const QgsGeometry &newPart ) SIP_PYNAME( addPartGeometry );
/**
* Removes the interior rings from a (multi)polygon geometry. If the minimumAllowedArea
* parameter is specified then only rings smaller than this minimum
* area will be removed.
* \since QGIS 3.0
*/
QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const;
/**
* Translates this geometry by dx, dy, dz and dm.
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult translate( double dx, double dy, double dz = 0.0, double dm = 0.0 );
/**
* Transforms this geometry as described by the coordinate transform \a ct.
*
* The transformation defaults to a forward transform, but the direction can be swapped
* by setting the \a direction argument.
*
* By default, z-coordinates are not transformed, even if the coordinate transform
* includes a vertical datum transformation. To transform z-coordinates, set
* \a transformZ to TRUE. 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).
*
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection direction = QgsCoordinateTransform::ForwardTransform, bool transformZ = false ) SIP_THROW( QgsCsException );
/**
* 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.
*
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 );
/**
* Rotate this geometry around the Z axis
* \param rotation clockwise rotation in degrees
* \param center rotation center
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult rotate( double rotation, const QgsPointXY ¢er );
/**
* Splits this geometry according to a given line.
* \param splitLine the line that splits the geometry
* \param[out] newGeometries list of new geometries that have been created with the split
* \param topological TRUE if topological editing is enabled
* \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
* \param splitFeature Set to True if you want to split a feature, otherwise set to False to split parts
* \returns OperationResult a result code: success or reason of failure
* \deprecated since QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.
*/
Q_DECL_DEPRECATED OperationResult splitGeometry( const QVector<QgsPointXY> &splitLine, QVector<QgsGeometry> &newGeometries SIP_OUT, bool topological, QVector<QgsPointXY> &topologyTestPoints SIP_OUT, bool splitFeature = true ) SIP_DEPRECATED;
/**
* Splits this geometry according to a given line.
* \param splitLine the line that splits the geometry
* \param[out] newGeometries list of new geometries that have been created with the ``splitLine``. If the geometry is 3D, a linear interpolation of the z value is performed on the geometry at split points, see example.
* \param topological TRUE if topological editing is enabled
* \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
* \param splitFeature Set to True if you want to split a feature, otherwise set to False to split parts
* fix this bug?
* \returns OperationResult a result code: success or reason of failure
*
* Example:
* \code{.py}
* geometry = QgsGeometry.fromWkt('CompoundCurveZ ((2749546.2003820720128715 1262904.45356595050543547 100, 2749557.82053794478997588 1262920.05570670193992555 200))')
* split_line = [QgsPoint(2749544.19, 1262914.79), QgsPoint(2749557.64, 1262897.30)]
* result, new_geometries, point_xy = geometry.splitGeometry(split_line, False)
* print(geometry.asWkt(2))
* > LineStringZ (2749549.12 1262908.38 125.14, 2749557.82 1262920.06 200)
* \endcode
*/
OperationResult splitGeometry( const QgsPointSequence &splitLine, QVector<QgsGeometry> &newGeometries SIP_OUT, bool topological, QgsPointSequence &topologyTestPoints SIP_OUT, bool splitFeature = true );
/**
* Replaces a part of this geometry with another line
* \returns OperationResult a result code: success or reason of failure
*/
OperationResult reshapeGeometry( const QgsLineString &reshapeLineString );
/**
* Changes this geometry such that it does not intersect the other geometry
* \param other geometry that should not be intersect
* \note Not available in Python
*/
int makeDifferenceInPlace( const QgsGeometry &other ) SIP_SKIP;
/**
* Returns the geometry formed by modifying this geometry such that it does not
* intersect the other geometry.
* \param other geometry that should not be intersect
* \returns difference geometry, or empty geometry if difference could not be calculated
* \since QGIS 3.0
*/
QgsGeometry makeDifference( const QgsGeometry &other ) const;
/**
* Returns the bounding box of the geometry.
* \see orientedMinimumBoundingBox()
*/
QgsRectangle boundingBox() const;
/**
* Returns the oriented minimum bounding box for the geometry, which is the smallest (by area)
* rotated rectangle which fully encompasses the geometry. The area, angle (clockwise in degrees from North),
* width and height of the rotated bounding box will also be returned.
* \see boundingBox()
* \since QGIS 3.0
*/
QgsGeometry orientedMinimumBoundingBox( double &area SIP_OUT, double &angle SIP_OUT, double &width SIP_OUT, double &height SIP_OUT ) const;
/**
* Returns the oriented minimum bounding box for the geometry, which is the smallest (by area)
* rotated rectangle which fully encompasses the geometry.
* \since QGIS 3.0
*/
QgsGeometry orientedMinimumBoundingBox() const SIP_SKIP;
/**
* Returns the minimal enclosing circle for the geometry.
* \param center Center of the minimal enclosing circle returneds
* \param radius Radius of the minimal enclosing circle returned
* \param segments Number of segments used to segment geometry. \see QgsEllipse::toPolygon()
* \returns the minimal enclosing circle as a QGIS geometry
* \since QGIS 3.0
*/
QgsGeometry minimalEnclosingCircle( QgsPointXY ¢er SIP_OUT, double &radius SIP_OUT, unsigned int segments = 36 ) const;
/**
* Returns the minimal enclosing circle for the geometry.
* \param segments Number of segments used to segment geometry. \see QgsEllipse::toPolygon()
* \since QGIS 3.0
*/
QgsGeometry minimalEnclosingCircle( unsigned int segments = 36 ) const SIP_SKIP;
/**
* Attempts to orthogonalize a line or polygon geometry by shifting vertices to make the geometries
* angles either right angles or flat lines. This is an iterative algorithm which will loop until
* either the vertices are within a specified tolerance of right angles or a set number of maximum
* iterations is reached. The angle threshold parameter specifies how close to a right angle or
* straight line an angle must be before it is attempted to be straightened.
* \since QGIS 3.0
*/
QgsGeometry orthogonalize( double tolerance = 1.0E-8, int maxIterations = 1000, double angleThreshold = 15.0 ) const;
/**
* Returns a new geometry with all points or vertices snapped to the closest point of the grid.
*
* If the gridified geometry could not be calculated (or was totally collapsed) an empty geometry will be returned.
* Note that snapping to grid 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.
* \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
*/
QgsGeometry snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const;
/**
* Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a