-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslinestring.sip.in
665 lines (476 loc) · 19.7 KB
/
qgslinestring.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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgslinestring.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLineString: QgsCurve
{
%Docstring(signature="appended")
Line string geometry type, with support for z-dimension and m-values.
.. versionadded:: 2.10
%End
%TypeHeaderCode
#include "qgslinestring.h"
%End
public:
QgsLineString() /HoldGIL/;
%Docstring
Constructor for an empty linestring geometry.
%End
QgsLineString( const QVector<QgsPoint> &points ) /HoldGIL/;
%Docstring
Construct a linestring from a vector of points.
Z and M type will be set based on the type of the first point
in the vector.
.. versionadded:: 3.0
%End
QgsLineString( const QVector<double> &x, const QVector<double> &y,
const QVector<double> &z = QVector<double>(),
const QVector<double> &m = QVector<double>(), bool is25DType = false ) /HoldGIL/;
%Docstring
Construct a linestring from arrays of coordinates. If the z or m
arrays are non-empty then the resultant linestring will have
z and m types accordingly.
This constructor is more efficient then calling :py:func:`~QgsLineString.setPoints`
or repeatedly calling :py:func:`~QgsLineString.addVertex`
If the ``z`` vector is filled, then the geometry type will either
be a LineStringZ(M) or LineString25D depending on the ``is25DType``
argument. If ``is25DType`` is ``True`` (and the ``m`` vector is unfilled) then
the created Linestring will be a LineString25D type. Otherwise, the
LineString will be LineStringZ (or LineStringZM) type.
If the sizes of ``x`` and ``y`` are non-equal then the resultant linestring
will be created using the minimum size of these arrays.
.. versionadded:: 3.0
%End
QgsLineString( const QgsPoint &p1, const QgsPoint &p2 ) /HoldGIL/;
%Docstring
Constructs a linestring with a single segment from ``p1`` to ``p2``.
.. versionadded:: 3.2
%End
QgsLineString( const QVector<QgsPointXY> &points ) /HoldGIL/;
%Docstring
Construct a linestring from list of points.
This constructor is more efficient then calling :py:func:`~QgsLineString.setPoints`
or repeatedly calling :py:func:`~QgsLineString.addVertex`
.. versionadded:: 3.0
%End
explicit QgsLineString( const QgsLineSegment2D &segment ) /HoldGIL/;
%Docstring
Construct a linestring from a single 2d line segment.
.. versionadded:: 3.2
%End
static QgsLineString *fromBezierCurve( const QgsPoint &start, const QgsPoint &controlPoint1, const QgsPoint &controlPoint2, const QgsPoint &end, int segments = 30 ) /Factory/;
%Docstring
Returns a new linestring created by segmentizing the bezier curve between ``start`` and ``end``, with
the specified control points.
The ``segments`` parameter controls how many line segments will be present in the returned linestring.
Any z or m values present in the input coordinates will be interpolated along with the x and y values.
.. versionadded:: 3.10
%End
static QgsLineString *fromQPolygonF( const QPolygonF &polygon ) /Factory/;
%Docstring
Returns a new linestring from a QPolygonF ``polygon`` input.
.. versionadded:: 3.10
%End
virtual bool equals( const QgsCurve &other ) const;
SIP_PYOBJECT pointN( int i ) const /TypeHint="QgsPoint"/;
%Docstring
Returns the point at the specified index. An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
std::unique_ptr< QgsPoint > p;
if ( a0 >= 0 )
p = std::make_unique< QgsPoint >( sipCpp->pointN( a0 ) );
else // negative index, count backwards from end
p = std::make_unique< QgsPoint >( sipCpp->pointN( count + a0 ) );
sipRes = sipConvertFromType( p.release(), sipType_QgsPoint, Py_None );
}
%End
virtual double xAt( int index ) const;
%Docstring
Returns the x-coordinate of the specified node in the line string.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
return PyFloat_FromDouble( sipCpp->xAt( a0 ) );
else
return PyFloat_FromDouble( sipCpp->xAt( count + a0 ) );
}
%End
virtual double yAt( int index ) const;
%Docstring
Returns the y-coordinate of the specified node in the line string.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
return PyFloat_FromDouble( sipCpp->yAt( a0 ) );
else
return PyFloat_FromDouble( sipCpp->yAt( count + a0 ) );
}
%End
double zAt( int index ) const;
%Docstring
Returns the z-coordinate of the specified node in the line string.
An IndexError will be raised if no point with the specified index exists.
If the LineString does not have a z-dimension then ``nan`` will be returned.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
return PyFloat_FromDouble( sipCpp->zAt( a0 ) );
else
return PyFloat_FromDouble( sipCpp->zAt( count + a0 ) );
}
%End
double mAt( int index ) const;
%Docstring
Returns the m-coordinate of the specified node in the line string.
An IndexError will be raised if no point with the specified index exists.
If the LineString does not have a m-dimension then ``nan`` will be returned.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
return PyFloat_FromDouble( sipCpp->mAt( a0 ) );
else
return PyFloat_FromDouble( sipCpp->mAt( count + a0 ) );
}
%End
void setXAt( int index, double x );
%Docstring
Sets the x-coordinate of the specified node in the line string.
The corresponding node must already exist in line string.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. seealso:: :py:func:`xAt`
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
sipCpp->setXAt( a0, a1 );
else
sipCpp->setXAt( count + a0, a1 );
}
%End
void setYAt( int index, double y );
%Docstring
Sets the y-coordinate of the specified node in the line string.
The corresponding node must already exist in line string.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. seealso:: :py:func:`yAt`
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
sipCpp->setYAt( a0, a1 );
else
sipCpp->setYAt( count + a0, a1 );
}
%End
void setZAt( int index, double z );
%Docstring
Sets the z-coordinate of the specified node in the line string.
The corresponding node must already exist in line string and the line string must have z-dimension.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. seealso:: :py:func:`zAt`
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
sipCpp->setZAt( a0, a1 );
else
sipCpp->setZAt( count + a0, a1 );
}
%End
void setMAt( int index, double m );
%Docstring
Sets the m-coordinate of the specified node in the line string.
The corresponding node must already exist in line string and the line string must have m-dimension.
An IndexError will be raised if no point with the specified index exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. seealso:: :py:func:`mAt`
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 >= 0 )
sipCpp->setMAt( a0, a1 );
else
sipCpp->setMAt( count + a0, a1 );
}
%End
void setPoints( const QgsPointSequence &points );
%Docstring
Resets the line string to match the specified list of points. The line string will
inherit the dimensionality of the first point in the list.
:param points: new points for line string. If empty, line string will be cleared.
%End
void append( const QgsLineString *line );
%Docstring
Appends the contents of another line string to the end of this line string.
:param line: line to append. Ownership is not transferred.
%End
void addVertex( const QgsPoint &pt );
%Docstring
Adds a new vertex to the end of the line string.
:param pt: vertex to add
%End
void close();
%Docstring
Closes the line string by appending the first point to the end of the line, if it is not already closed.
%End
virtual QgsCompoundCurve *toCurveType() const /Factory/;
%Docstring
Returns the geometry converted to the more generic curve type :py:class:`QgsCompoundCurve`
:return: the converted geometry. Caller takes ownership
%End
void extend( double startDistance, double endDistance );
%Docstring
Extends the line geometry by extrapolating out the start or end of the line
by a specified distance. Lines are extended using the bearing of the first or last
segment in the line.
.. versionadded:: 3.0
%End
virtual QString geometryType() const /HoldGIL/;
virtual int dimension() const /HoldGIL/;
virtual QgsLineString *clone() const /Factory/;
virtual void clear();
virtual bool isEmpty() const /HoldGIL/;
int indexOf( const QgsPoint &point ) const final;
virtual bool isValid( QString &error /Out/, int flags = 0 ) const;
virtual QgsLineString *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
virtual bool removeDuplicateNodes( double epsilon = 4 * DBL_EPSILON, bool useZValues = false );
virtual bool isClosed() const /HoldGIL/;
virtual bool boundingBoxIntersects( const QgsRectangle &rectangle ) const /HoldGIL/;
QVector< QgsVertexId > collectDuplicateNodes( double epsilon = 4 * DBL_EPSILON, bool useZValues = false ) const;
%Docstring
Returns a list of any duplicate nodes contained in the geometry, within the specified tolerance.
If ``useZValues`` is ``True`` then z values will also be considered when testing for duplicates.
.. versionadded:: 3.16
%End
virtual QPolygonF asQPolygonF() const;
virtual bool fromWkb( QgsConstWkbPtr &wkb );
virtual bool fromWkt( const QString &wkt );
virtual int wkbSize( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const;
virtual QByteArray asWkb( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const;
virtual QString asWkt( int precision = 17 ) const;
virtual QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const;
virtual QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const;
virtual QString asKml( int precision = 17 ) const;
virtual double length() const /HoldGIL/;
double length3D() const /HoldGIL/;
%Docstring
Returns the length in 3D world of the line string.
If it is not a 3D line string, return its 2D length.
.. seealso:: :py:func:`length`
.. versionadded:: 3.10
%End
virtual QgsPoint startPoint() const /HoldGIL/;
virtual QgsPoint endPoint() const /HoldGIL/;
virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
%Docstring
Returns a new line string geometry corresponding to a segmentized approximation
of the curve.
:param tolerance: segmentation tolerance
:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
%End
virtual int numPoints() const /HoldGIL/;
virtual int nCoordinates() const /HoldGIL/;
virtual void points( QgsPointSequence &pt /Out/ ) const;
virtual void draw( QPainter &p ) const;
virtual void transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform, bool transformZ = false ) throw( QgsCsException );
virtual void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 );
virtual void addToPainterPath( QPainterPath &path ) const;
virtual void drawAsPolygon( QPainter &p ) const;
virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos );
virtual bool deleteVertex( QgsVertexId position );
virtual QgsLineString *reversed() const /Factory/;
virtual QgsPoint *interpolatePoint( double distance ) const /Factory/;
virtual QgsLineString *curveSubstring( double startDistance, double endDistance ) const /Factory/;
virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
virtual bool pointAt( int node, QgsPoint &point, QgsVertexId::VertexType &type ) const;
virtual QgsPoint centroid() const;
virtual void sumUpArea( double &sum /Out/ ) const;
virtual double vertexAngle( QgsVertexId vertex ) const;
virtual double segmentLength( QgsVertexId startVertex ) const;
virtual bool addZValue( double zValue = 0 );
virtual bool addMValue( double mValue = 0 );
virtual bool dropZValue();
virtual bool dropMValue();
virtual void swapXy();
virtual bool convertTo( QgsWkbTypes::Type type );
virtual bool transform( QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback = 0 );
virtual QgsLineString *createEmptyWithSameType() const /Factory/;
SIP_PYOBJECT __repr__();
%MethodCode
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsLineString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
SIP_PYOBJECT __getitem__( int index ) /TypeHint="QgsPoint"/;
%Docstring
Returns the point at the specified ``index``. An IndexError will be raised if no point with the specified ``index`` exists.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. versionadded:: 3.6
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
std::unique_ptr< QgsPoint > p;
if ( a0 >= 0 )
p = std::make_unique< QgsPoint >( sipCpp->pointN( a0 ) );
else
p = std::make_unique< QgsPoint >( sipCpp->pointN( count + a0 ) );
sipRes = sipConvertFromType( p.release(), sipType_QgsPoint, Py_None );
}
%End
void __setitem__( int index, const QgsPoint &point );
%Docstring
Sets the point at the specified ``index``. A point at the ``index`` must already exist or an IndexError will be raised.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. versionadded:: 3.6
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 < -count || a0 >= count )
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
else
{
if ( a0 < 0 )
a0 = count + a0;
sipCpp->setXAt( a0, a1->x() );
sipCpp->setYAt( a0, a1->y() );
if ( sipCpp->isMeasure() )
sipCpp->setMAt( a0, a1->m() );
if ( sipCpp->is3D() )
sipCpp->setZAt( a0, a1->z() );
}
%End
void __delitem__( int index );
%Docstring
Deletes the vertex at the specified ``index``. A point at the ``index`` must already exist or an IndexError will be raised.
Indexes can be less than 0, in which case they correspond to positions from the end of the line. E.g. an index of -1
corresponds to the last point in the line.
.. versionadded:: 3.6
%End
%MethodCode
const int count = sipCpp->numPoints();
if ( a0 >= 0 && a0 < count )
sipCpp->deleteVertex( QgsVertexId( -1, -1, a0 ) );
else if ( a0 < 0 && a0 >= -count )
sipCpp->deleteVertex( QgsVertexId( -1, -1, count + a0 ) );
else
{
PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
sipIsErr = 1;
}
%End
protected:
virtual QgsRectangle calculateBoundingBox() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgslinestring.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/