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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgslinesegment.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLineSegment2D
{
%Docstring(signature="appended")
Represents a single 2D line segment, consisting of a 2D start and end
vertex only.
.. versionadded:: 3.2
%End
%TypeHeaderCode
#include "qgslinesegment.h"
%End
public:
QgsLineSegment2D( const QgsPointXY &start, const QgsPointXY &end ) /HoldGIL/;
%Docstring
Constructor for a QgsLineSegment2D from the specified ``start`` point to
the ``end`` point.
%End
QgsLineSegment2D( double x1, double y1, double x2, double y2 ) /HoldGIL/;
%Docstring
Constructor for a QgsLineSegment2D from the point (``x1``, ``y2``) to
(``x2``, ``y2``).
%End
double length() const /HoldGIL/;
%Docstring
Returns the length of the segment.
.. seealso:: :py:func:`lengthSquared`
%End
double lengthSquared() const /HoldGIL/;
%Docstring
Returns the squared length of the segment.
.. seealso:: :py:func:`length`
%End
double startX() const /HoldGIL/;
%Docstring
Returns the segment's start x-coordinate.
.. seealso:: :py:func:`start`
.. seealso:: :py:func:`startY`
%End
double startY() const /HoldGIL/;
%Docstring
Returns the segment's start y-coordinate.
.. seealso:: :py:func:`start`
.. seealso:: :py:func:`startX`
%End
double endX() const /HoldGIL/;
%Docstring
Returns the segment's end x-coordinate.
.. seealso:: :py:func:`end`
.. seealso:: :py:func:`endY`
%End
double endY() const /HoldGIL/;
%Docstring
Returns the segment's end y-coordinate.
.. seealso:: :py:func:`end`
.. seealso:: :py:func:`endX`
%End
QgsPointXY start() const /HoldGIL/;
%Docstring
Returns the segment's start point.
.. seealso:: :py:func:`end`
.. seealso:: :py:func:`startX`
.. seealso:: :py:func:`startY`
%End
QgsPointXY end() const /HoldGIL/;
%Docstring
Returns the segment's end point.
.. seealso:: :py:func:`start`
.. seealso:: :py:func:`endX`
.. seealso:: :py:func:`endY`
%End
void setStartX( double x ) /HoldGIL/;
%Docstring
Sets the segment's start ``x`` coordinate.
.. seealso:: :py:func:`setEndX`
.. seealso:: :py:func:`setStart`
.. seealso:: :py:func:`setStartY`
%End
void setStartY( double y ) /HoldGIL/;
%Docstring
Sets the segment's start ``y`` coordinate.
.. seealso:: :py:func:`setEndY`
.. seealso:: :py:func:`setStart`
.. seealso:: :py:func:`setStartX`
%End
void setEndX( double x ) /HoldGIL/;
%Docstring
Sets the segment's end ``x`` coordinate.
.. seealso:: :py:func:`setStartX`
.. seealso:: :py:func:`setEnd`
.. seealso:: :py:func:`setEndY`
%End
void setEndY( double y ) /HoldGIL/;
%Docstring
Sets the segment's end ``y`` coordinate.
.. seealso:: :py:func:`setStartY`
.. seealso:: :py:func:`setEnd`
.. seealso:: :py:func:`setEndX`
%End
void setStart( const QgsPointXY &start ) /HoldGIL/;
%Docstring
Sets the segment's ``start`` point.
.. seealso:: :py:func:`setStartX`
.. seealso:: :py:func:`setStartY`
.. seealso:: :py:func:`setEnd`
%End
void setEnd( const QgsPointXY &end ) /HoldGIL/;
%Docstring
Sets the segment's ``end`` point.
.. seealso:: :py:func:`setEndX`
.. seealso:: :py:func:`setEndY`
.. seealso:: :py:func:`setStart`
%End
int pointLeftOfLine( const QgsPointXY &point ) const /HoldGIL/;
%Docstring
Tests if a ``point`` is to the left of the line segment.
Returns -1 if the point falls to the left of the line, or +1 if the
point is to the right.
If the return value is 0, then the test was unsuccessful (e.g. due to
testing a point exactly on the line, or exactly in line with the
segment) and the result is undefined.
.. seealso:: :py:func:`QgsGeometryUtils.leftOfLine`
%End
void reverse() /HoldGIL/;
%Docstring
Reverses the line segment, so that the start and end points are flipped.
%End
bool operator==( const QgsLineSegment2D &other ) const /HoldGIL/;
bool operator!=( const QgsLineSegment2D &other ) const /HoldGIL/;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/geometry/qgslinesegment.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
