-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgspoint.sip.in
441 lines (291 loc) · 12 KB
/
qgspoint.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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgspoint.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsPoint: QgsAbstractGeometry
{
%Docstring
Point geometry type, with support for z-dimension and m-values.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgspoint.h"
%End
public:
QgsPoint( double x = 0.0, double y = 0.0, SIP_PYOBJECT z = Py_None, SIP_PYOBJECT m = Py_None, QgsWkbTypes::Type wkbType = QgsWkbTypes::Unknown ) [( double x = 0.0, double y = 0.0, double z = 0.0, double m = 0.0, QgsWkbTypes::Type wkbType = QgsWkbTypes::Unknown )];
%Docstring
Construct a point with the provided initial coordinate values.
If ``wkbType`` is set to `QgsWkbTypes.Point`, `QgsWkbTypes.PointZ`, `QgsWkbTypes.PointM` or `QgsWkbTypes.PointZM`
the type will be set accordingly. If it is left to the default `QgsWkbTypes.Unknown`, the type will be set
based on the following rules:
- If only x and y are specified, the type will be a 2D point.
- If any or both of the Z and M are specified, the appropriate type will be created.
.. code-block:: python
pt = QgsPoint(43.4, 5.3)
pt.asWkt() # Point(43.4 5.3)
pt_z = QgsPoint(120, 343, 77)
pt.asWkt() # PointZ(120 343 77)
pt_m = QgsPoint(33, 88, m=5)
pt_m.m() # 5
pt_m.wkbType() # QgsWkbTypes.PointM
pt = QgsPoint(30, 40, wkbType=QgsWkbTypes.PointZ)
pt.z() # nan
pt.wkbType() # QgsWkbTypes.PointZ
%End
%MethodCode
double z;
double m;
if ( a2 == Py_None )
{
z = std::numeric_limits<double>::quiet_NaN();
}
else
{
z = PyFloat_AsDouble( a2 );
}
if ( a3 == Py_None )
{
m = std::numeric_limits<double>::quiet_NaN();
}
else
{
m = PyFloat_AsDouble( a3 );
}
sipCpp = new sipQgsPoint( a0, a1, z, m, a4 );
%End
explicit QgsPoint( const QgsPointXY &p );
%Docstring
Construct a QgsPoint from a QgsPointXY object
%End
explicit QgsPoint( QPointF p );
%Docstring
Construct a QgsPoint from a QPointF
%End
virtual bool operator==( const QgsAbstractGeometry &other ) const;
virtual bool operator!=( const QgsAbstractGeometry &other ) const;
double x() const;
%Docstring
Returns the point's x-coordinate.
.. seealso:: :py:func:`setX`
.. seealso:: :py:func:`rx`
%End
double y() const;
%Docstring
Returns the point's y-coordinate.
.. seealso:: :py:func:`setY`
.. seealso:: :py:func:`ry`
%End
double z() const;
%Docstring
Returns the point's z-coordinate.
.. seealso:: :py:func:`setZ`
.. seealso:: :py:func:`rz`
%End
double m() const;
%Docstring
Returns the point's m value.
.. seealso:: :py:func:`setM`
.. seealso:: :py:func:`rm`
%End
void setX( double x );
%Docstring
Sets the point's x-coordinate.
.. seealso:: x
.. seealso:: :py:func:`rx`
%End
void setY( double y );
%Docstring
Sets the point's y-coordinate.
.. seealso:: y
.. seealso:: :py:func:`ry`
%End
void setZ( double z );
%Docstring
Sets the point's z-coordinate.
.. note::
calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to
add a z value and force the point to have a z dimension.
.. seealso:: z
.. seealso:: :py:func:`rz`
%End
void setM( double m );
%Docstring
Sets the point's m-value.
.. note::
calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to
add a m value and force the point to have an m dimension.
.. seealso:: m
.. seealso:: :py:func:`rm`
%End
QPointF toQPointF() const;
%Docstring
Returns the point as a QPointF.
.. versionadded:: 2.14
%End
double distance( double x, double y ) const;
%Docstring
Returns the distance between this point and a specified x, y coordinate. In certain
cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
when comparing distances.
.. versionadded:: 3.0
.. seealso:: :py:func:`distanceSquared`
%End
double distance( const QgsPoint &other ) const;
%Docstring
Returns the 2D distance between this point and another point. In certain
cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
when comparing distances.
.. versionadded:: 3.0
%End
double distanceSquared( double x, double y ) const;
%Docstring
Returns the squared distance between this point a specified x, y coordinate. Calling
this is faster than calling distance(), and may be useful in use cases such as comparing
distances where the extra expense of calling distance() is not required.
.. seealso:: :py:func:`distance`
.. versionadded:: 3.0
%End
double distanceSquared( const QgsPoint &other ) const;
%Docstring
Returns the squared distance between this point another point. Calling
this is faster than calling distance(), and may be useful in use cases such as comparing
distances where the extra expense of calling distance() is not required.
.. seealso:: :py:func:`distance`
.. versionadded:: 3.0
%End
double distance3D( double x, double y, double z ) const;
%Docstring
Returns the 3D distance between this point and a specified x, y, z coordinate. In certain
cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
when comparing distances.
.. versionadded:: 3.0
.. seealso:: :py:func:`distanceSquared`
%End
double distance3D( const QgsPoint &other ) const;
%Docstring
Returns the 3D distance between this point and another point. In certain
cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
when comparing distances.
.. versionadded:: 3.0
%End
double distanceSquared3D( double x, double y, double z ) const;
%Docstring
Returns the 3D squared distance between this point a specified x, y, z coordinate. Calling
this is faster than calling distance(), and may be useful in use cases such as comparing
distances where the extra expense of calling distance() is not required.
.. seealso:: :py:func:`distance`
.. versionadded:: 3.0
%End
double distanceSquared3D( const QgsPoint &other ) const;
%Docstring
Returns the 3D squared distance between this point another point. Calling
this is faster than calling distance(), and may be useful in use cases such as comparing
distances where the extra expense of calling distance() is not required.
.. seealso:: :py:func:`distance`
.. versionadded:: 3.0
%End
double azimuth( const QgsPoint &other ) const;
%Docstring
Calculates azimuth between this point and other one (clockwise in degree, starting from north)
.. versionadded:: 3.0
%End
double inclination( const QgsPoint &other ) const;
%Docstring
Calculates inclination between this point and other one (starting from zenith = 0 to nadir = 180. Horizon = 90)
Returns 90.0 if the distance between this point and other one is equal to 0 (same point).
.. versionadded:: 3.0
%End
QgsPoint project( double distance, double azimuth, double inclination = 90.0 ) const;
%Docstring
Returns a new point which correspond to this point projected by a specified distance
with specified angles (azimuth and inclination).
M value is preserved.
:param distance: distance to project
:param azimuth: angle to project in X Y, clockwise in degrees starting from north
:param inclination: angle to project in Z (3D). If the point is 2D, the Z value is assumed to be 0.
:return: The point projected. If a 2D point is projected a 3D point will be returned except if
inclination is 90. A 3D point is always returned if a 3D point is projected.
Example:
.. code-block:: python
p = QgsPoint( 1, 2 ) # 2D point
pr = p.project ( 1, 0 )
# pr is a 2D point: 'Point (1 3)'
pr = p.project ( 1, 0, 90 )
# pr is a 2D point: 'Point (1 3)'
pr = p.project (1, 0, 0 )
# pr is a 3D point: 'PointZ (1 2 1)'
p = QgsPoint( QgsWkbTypes.PointZ, 1, 2, 2 ) # 3D point
pr = p.project ( 1, 0 )
# pr is a 3D point: 'PointZ (1 3 2)'
pr = p.project ( 1, 0, 90 )
# pr is a 3D point: 'PointZ (1 3 2)'
pr = p.project (1, 0, 0 )
# pr is a 3D point: 'PointZ (1 2 3)'
.. versionadded:: 3.0
%End
QgsVector operator-( const QgsPoint &p ) const;
QgsPoint &operator+=( QgsVector v );
QgsPoint &operator-=( QgsVector v );
QgsPoint operator+( QgsVector v ) const;
QgsPoint operator-( QgsVector v ) const;
virtual bool isEmpty() const;
virtual QgsRectangle boundingBox() const;
virtual QString geometryType() const;
virtual int dimension() const;
virtual QgsPoint *clone() const /Factory/;
virtual QgsPoint *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 void clear();
virtual bool fromWkb( QgsConstWkbPtr &wkb );
virtual bool fromWkt( const QString &wkt );
virtual QByteArray asWkb() const;
virtual QString asWkt( int precision = 17 ) const;
virtual QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJson( int precision = 17 ) const;
virtual void draw( QPainter &p ) const;
virtual void transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform,
bool transformZ = false );
virtual void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 );
virtual QgsCoordinateSequence coordinateSequence() const;
virtual int nCoordinates() const;
virtual int vertexNumberFromVertexId( QgsVertexId id ) const;
virtual QgsAbstractGeometry *boundary() const /Factory/;
virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos );
virtual bool deleteVertex( QgsVertexId position );
virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
virtual bool nextVertex( QgsVertexId &id, QgsPoint &vertex /Out/ ) const;
virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const;
virtual double vertexAngle( QgsVertexId vertex ) const;
%Docstring
Angle undefined. Always returns 0.0
:param vertex: the vertex id
:return: 0.0*
%End
virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const;
virtual int ringCount( int /*part*/ = 0 ) const;
virtual int partCount() const;
virtual QgsPoint vertexAt( QgsVertexId /*id*/ ) const;
virtual QgsPoint *toCurveType() const /Factory/;
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 bool convertTo( QgsWkbTypes::Type type );
virtual QgsPoint *createEmptyWithSameType() const /Factory/;
protected:
virtual int childCount() const;
virtual QgsPoint childPoint( int index ) const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgspoint.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/