/
qgsabstractgeometry.sip.in
927 lines (669 loc) · 25.4 KB
/
qgsabstractgeometry.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgsabstractgeometry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
typedef QVector< QgsPoint > QgsPointSequence;
typedef QVector< QVector< QgsPoint > > QgsRingSequence;
typedef QVector< QVector< QVector< QgsPoint > > > QgsCoordinateSequence;
class QgsAbstractGeometry
{
%Docstring
Abstract base class for all geometries
.. versionadded:: 2.10
%End
%TypeHeaderCode
#include "qgsabstractgeometry.h"
%End
%ConvertToSubClassCode
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;
%End
public:
static const QMetaObject staticMetaObject;
public:
enum SegmentationToleranceType
{
MaximumAngle,
MaximumDifference
};
enum AxisOrder
{
XY,
YX
};
QgsAbstractGeometry();
%Docstring
Constructor for QgsAbstractGeometry.
%End
virtual ~QgsAbstractGeometry();
QgsAbstractGeometry( const QgsAbstractGeometry &geom );
virtual bool operator==( const QgsAbstractGeometry &other ) const = 0;
virtual bool operator!=( const QgsAbstractGeometry &other ) const = 0;
virtual QgsAbstractGeometry *clone() const = 0 /Factory/;
%Docstring
Clones the geometry by performing a deep copy
%End
virtual void clear() = 0;
%Docstring
Clears the geometry, ie reset it to a null geometry
%End
virtual QgsRectangle boundingBox() const = 0;
%Docstring
Returns the minimal bounding box for the geometry
%End
virtual int dimension() const = 0;
%Docstring
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.
%End
virtual QString geometryType() const = 0;
%Docstring
Returns a unique string representing the geometry type.
.. seealso:: :py:func:`wkbType`
.. seealso:: :py:func:`wktTypeStr`
%End
QgsWkbTypes::Type wkbType() const;
%Docstring
Returns the WKB type of the geometry.
.. seealso:: :py:func:`geometryType`
.. seealso:: :py:func:`wktTypeStr`
%End
QString wktTypeStr() const;
%Docstring
Returns the WKT type string of the geometry.
.. seealso:: :py:func:`geometryType`
.. seealso:: :py:func:`wkbType`
%End
bool is3D() const;
%Docstring
Returns true if the geometry is 3D and contains a z-value.
.. seealso:: :py:func:`isMeasure`
%End
bool isMeasure() const;
%Docstring
Returns true if the geometry contains m values.
.. seealso:: :py:func:`is3D`
%End
virtual QgsAbstractGeometry *boundary() const = 0 /Factory/;
%Docstring
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.
:return: boundary for geometry. May be null for some geometry types.
.. versionadded:: 3.0
%End
virtual bool fromWkb( QgsConstWkbPtr &wkb ) = 0;
%Docstring
Sets the geometry from a WKB string.
After successful read the wkb argument will be at the position where the reading has stopped.
.. seealso:: :py:func:`fromWkt`
%End
virtual bool fromWkt( const QString &wkt ) = 0;
%Docstring
Sets the geometry from a WKT string.
.. seealso:: :py:func:`fromWkb`
%End
virtual QByteArray asWkb() const = 0;
%Docstring
Returns a WKB representation of the geometry.
.. seealso:: :py:func:`asWkt`
.. seealso:: :py:func:`asGml2`
.. seealso:: :py:func:`asGml3`
.. seealso:: :py:func:`asJson`
.. versionadded:: 3.0
%End
virtual QString asWkt( int precision = 17 ) const = 0;
%Docstring
Returns a WKT representation of the geometry.
:param precision: number of decimal places for coordinates
.. seealso:: :py:func:`asWkb`
.. seealso:: :py:func:`asGml2`
.. seealso:: :py:func:`asGml3`
.. seealso:: :py:func:`asJson`
%End
virtual QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const = 0;
%Docstring
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
.. seealso:: :py:func:`asWkb`
.. seealso:: :py:func:`asWkt`
.. seealso:: :py:func:`asGml3`
.. seealso:: :py:func:`asJson`
%End
virtual QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const = 0;
%Docstring
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
.. seealso:: :py:func:`asWkb`
.. seealso:: :py:func:`asWkt`
.. seealso:: :py:func:`asGml2`
.. seealso:: :py:func:`asJson`
%End
virtual QString asJson( int precision = 17 ) const = 0;
%Docstring
Returns a GeoJSON representation of the geometry.
:param precision: number of decimal places for coordinates
.. seealso:: :py:func:`asWkb`
.. seealso:: :py:func:`asWkt`
.. seealso:: :py:func:`asGml2`
.. seealso:: :py:func:`asGml3`
%End
virtual void transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform, bool transformZ = false ) throw( QgsCsException ) = 0;
%Docstring
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.
%End
virtual void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0,
double mTranslate = 0.0, double mScale = 1.0 ) = 0;
%Docstring
Transforms the x and y components of the geometry using a QTransform object ``t``.
Optionally, the geometry's z values can be scaled via ``zScale`` and translated via ``zTranslate``.
Similarly, m-values can be scaled via ``mScale`` and translated via ``mTranslate``.
%End
virtual void draw( QPainter &p ) const = 0;
%Docstring
Draws the geometry using the specified QPainter.
:param p: destination QPainter
%End
virtual int vertexNumberFromVertexId( QgsVertexId id ) const = 0;
%Docstring
Returns the vertex number corresponding to a vertex ``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.
.. versionadded:: 3.0
%End
virtual bool nextVertex( QgsVertexId &id, QgsPoint &vertex /Out/ ) const = 0;
%Docstring
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.
:return: - false if at end
- vertex: container for found node
%End
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const = 0;
%Docstring
Returns the vertices adjacent to a specified ``vertex`` within a geometry.
.. versionadded:: 3.0
%End
virtual QgsCoordinateSequence coordinateSequence() const = 0;
%Docstring
Retrieves the sequence of geometries, rings and nodes.
:return: coordinate sequence
%End
virtual int nCoordinates() const;
%Docstring
Returns the number of nodes contained in the geometry
%End
virtual QgsPoint vertexAt( QgsVertexId id ) const = 0;
%Docstring
Returns the point corresponding to a specified vertex id
%End
virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/,
QgsVertexId &vertexAfter /Out/,
int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const = 0;
%Docstring
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 epsilon: epsilon for segment snapping
:return: - squared distance to closest segment or negative value on error
- 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)
%End
virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) = 0;
%Docstring
Inserts a vertex into the geometry
:param position: vertex id for position of inserted vertex
:param vertex: vertex to insert
:return: true if insert was successful
.. seealso:: :py:func:`moveVertex`
.. seealso:: :py:func:`deleteVertex`
%End
virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) = 0;
%Docstring
Moves a vertex within the geometry
:param position: vertex id for vertex to move
:param newPos: new position of vertex
:return: true if move was successful
.. seealso:: :py:func:`insertVertex`
.. seealso:: :py:func:`deleteVertex`
%End
virtual bool deleteVertex( QgsVertexId position ) = 0;
%Docstring
Deletes a vertex within the geometry
:param position: vertex id for vertex to delete
:return: true if delete was successful
.. seealso:: :py:func:`insertVertex`
.. seealso:: :py:func:`moveVertex`
%End
virtual double length() const;
%Docstring
Returns the length of the geometry.
.. seealso:: :py:func:`area`
.. seealso:: :py:func:`perimeter`
%End
virtual double perimeter() const;
%Docstring
Returns the perimeter of the geometry.
.. seealso:: :py:func:`area`
.. seealso:: :py:func:`length`
%End
virtual double area() const;
%Docstring
Returns the area of the geometry.
.. seealso:: :py:func:`length`
.. seealso:: :py:func:`perimeter`
%End
virtual double segmentLength( QgsVertexId startVertex ) const = 0;
%Docstring
Returns the length of the segment of the geometry which begins at ``startVertex``.
.. versionadded:: 3.0
%End
virtual QgsPoint centroid() const;
%Docstring
Returns the centroid of the geometry
%End
virtual bool isEmpty() const;
%Docstring
Returns true if the geometry is empty
%End
virtual bool hasCurvedSegments() const;
%Docstring
Returns true if the geometry contains curved segments
%End
virtual QgsAbstractGeometry *segmentize( double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
%Docstring
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
%End
virtual QgsAbstractGeometry *toCurveType() const = 0 /Factory/;
%Docstring
Returns the geometry converted to the more generic curve type.
E.g. :py:class:`QgsLineString` -> :py:class:`QgsCompoundCurve`, :py:class:`QgsPolygon` -> QgsCurvePolygon,
:py:class:`QgsMultiLineString` -> :py:class:`QgsMultiCurve`, :py:class:`QgsMultiPolygon` -> :py:class:`QgsMultiSurface`
:return: the converted geometry. Caller takes ownership
%End
virtual QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const = 0 /Factory/;
%Docstring
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 a None 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:
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.
.. versionadded:: 3.0
%End
virtual bool removeDuplicateNodes( double epsilon = 4 * DBL_EPSILON, bool useZValues = false ) = 0;
%Docstring
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a
degenerate geometry.
The ``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 ``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.
.. versionadded:: 3.0
%End
virtual double vertexAngle( QgsVertexId vertex ) const = 0;
%Docstring
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
:return: rotation in radians, clockwise from north
%End
virtual int vertexCount( int part = 0, int ring = 0 ) const = 0;
%Docstring
Returns the number of vertices of which this geometry is built.
%End
virtual int ringCount( int part = 0 ) const = 0;
%Docstring
Returns the number of rings of which this geometry is built.
%End
virtual int partCount() const = 0;
%Docstring
Returns count of parts contained in the geometry.
.. seealso:: :py:func:`vertexCount`
.. seealso:: :py:func:`ringCount`
%End
virtual bool addZValue( double zValue = 0 ) = 0;
%Docstring
Adds a z-dimension to the geometry, initialized to a preset value.
:param zValue: initial z-value for all nodes
:return: true on success
.. seealso:: :py:func:`dropZValue`
.. seealso:: :py:func:`addMValue`
.. versionadded:: 2.12
%End
virtual bool addMValue( double mValue = 0 ) = 0;
%Docstring
Adds a measure to the geometry, initialized to a preset value.
:param mValue: initial m-value for all nodes
:return: true on success
.. seealso:: :py:func:`dropMValue`
.. seealso:: :py:func:`addZValue`
.. versionadded:: 2.12
%End
virtual bool dropZValue() = 0;
%Docstring
Drops any z-dimensions which exist in the geometry.
:return: true if Z values were present and have been removed
.. seealso:: :py:func:`addZValue`
.. seealso:: :py:func:`dropMValue`
.. versionadded:: 2.14
%End
virtual bool dropMValue() = 0;
%Docstring
Drops any measure values which exist in the geometry.
:return: true if m-values were present and have been removed
.. seealso:: :py:func:`addMValue`
.. seealso:: :py:func:`dropZValue`
.. versionadded:: 2.14
%End
virtual void swapXy() = 0;
%Docstring
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.
.. versionadded:: 3.2
%End
virtual bool convertTo( QgsWkbTypes::Type type );
%Docstring
Converts the geometry to a specified type.
:return: true if conversion was successful
.. versionadded:: 2.14
%End
QgsGeometryPartIterator parts();
%Docstring
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-block:: python
# 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())
.. seealso:: :py:func:`vertices`
.. versionadded:: 3.6
%End
QgsVertexIterator vertices() const;
%Docstring
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-block:: python
# 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())
.. seealso:: :py:func:`parts`
.. versionadded:: 3.0
%End
virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 /Factory/;
%Docstring
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.
.. seealso:: :py:func:`clone`
.. versionadded:: 3.0
%End
protected:
virtual bool hasChildGeometries() const;
%Docstring
Returns whether the geometry has any child geometries (false for point / curve, true otherwise)
.. note::
used for vertex_iterator implementation
.. versionadded:: 3.0
%End
virtual int childCount() const;
%Docstring
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
.. versionadded:: 3.0
%End
virtual QgsAbstractGeometry *childGeometry( int index ) const;
%Docstring
Returns pointer to child geometry (for geometries with child geometries - i.e. geom. collection / polygon)
.. note::
used for vertex_iterator implementation
.. versionadded:: 3.0
%End
virtual QgsPoint childPoint( int index ) const;
%Docstring
Returns point at index (for geometries without child geometries - i.e. curve / point)
.. note::
used for vertex_iterator implementation
.. versionadded:: 3.0
%End
protected:
void setZMTypeFromSubGeometry( const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType );
%Docstring
Updates the geometry type based on whether sub geometries contain z or m values.
%End
virtual QgsRectangle calculateBoundingBox() const;
%Docstring
Default calculator for the minimal bounding box for the geometry. Derived classes should override this method
if a more efficient bounding box calculation is available.
%End
virtual void clearCache() const;
%Docstring
Clears any cached parameters associated with the geometry, e.g., bounding boxes
%End
};
struct QgsVertexId
{
enum VertexType
{
SegmentVertex,
CurveVertex
};
explicit QgsVertexId( int _part = -1, int _ring = -1, int _vertex = -1, VertexType _type = SegmentVertex );
bool isValid() const;
%Docstring
Returns true if the vertex id is valid
%End
bool operator==( QgsVertexId other ) const;
bool operator!=( QgsVertexId other ) const;
bool partEqual( QgsVertexId o ) const;
bool ringEqual( QgsVertexId o ) const;
bool vertexEqual( QgsVertexId o ) const;
bool isValid( const QgsAbstractGeometry *geom ) const;
int part;
int ring;
int vertex;
VertexType type;
};
class QgsVertexIterator
{
%Docstring
Java-style iterator for traversal of vertices of a geometry
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsabstractgeometry.h"
%End
public:
QgsVertexIterator();
%Docstring
Constructor for QgsVertexIterator
%End
QgsVertexIterator( const QgsAbstractGeometry *geometry );
%Docstring
Constructs iterator for the given geometry
%End
bool hasNext() const;
%Docstring
Find out whether there are more vertices
%End
QgsPoint next();
%Docstring
Returns next vertex of the geometry (undefined behavior if hasNext() returns false before calling next())
%End
QgsVertexIterator *__iter__();
%MethodCode
sipRes = sipCpp;
%End
SIP_PYOBJECT __next__() /TypeHint="QgsPoint"/;
%MethodCode
if ( sipCpp->hasNext() )
sipRes = sipConvertFromType( new QgsPoint( sipCpp->next() ), sipType_QgsPoint, Py_None );
else
PyErr_SetString( PyExc_StopIteration, "" );
%End
};
class QgsGeometryPartIterator
{
%Docstring
Java-style iterator for traversal of parts of a geometry
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsabstractgeometry.h"
%End
public:
QgsGeometryPartIterator();
%Docstring
Constructor for QgsGeometryPartIterator
%End
QgsGeometryPartIterator( QgsAbstractGeometry *geometry );
%Docstring
Constructs iterator for the given geometry
%End
bool hasNext() const;
%Docstring
Find out whether there are more parts
%End
QgsAbstractGeometry *next();
%Docstring
Returns next part of the geometry (undefined behavior if hasNext() returns false before calling next())
%End
QgsGeometryPartIterator *__iter__();
%MethodCode
sipRes = sipCpp;
%End
SIP_PYOBJECT __next__() /TypeHint="QgsAbstractGeometry"/;
%MethodCode
if ( sipCpp->hasNext() )
sipRes = sipConvertFromType( sipCpp->next(), sipType_QgsAbstractGeometry, NULL );
else
PyErr_SetString( PyExc_StopIteration, "" );
%End
};
class QgsGeometryConstPartIterator
{
%Docstring
Java-style iterator for const traversal of parts of a geometry
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsabstractgeometry.h"
%End
public:
QgsGeometryConstPartIterator();
%Docstring
Constructor for QgsGeometryConstPartIterator
%End
QgsGeometryConstPartIterator( const QgsAbstractGeometry *geometry );
%Docstring
Constructs iterator for the given geometry
%End
bool hasNext() const;
%Docstring
Find out whether there are more parts
%End
const QgsAbstractGeometry *next();
%Docstring
Returns next part of the geometry (undefined behavior if hasNext() returns false before calling next())
%End
QgsGeometryConstPartIterator *__iter__();
%MethodCode
sipRes = sipCpp;
%End
SIP_PYOBJECT __next__() /TypeHint="QgsAbstractGeometry"/;
%MethodCode
if ( sipCpp->hasNext() )
sipRes = sipConvertFromType( const_cast< QgsAbstractGeometry * >( sipCpp->next() ), sipType_QgsAbstractGeometry, NULL );
else
PyErr_SetString( PyExc_StopIteration, "" );
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgsabstractgeometry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/