Class: QgsLineSegment2D¶

Represents a single 2D line segment, consisting of a 2D start and end vertex only.

Added in version 3.2.

Methods

`end`	Returns the segment's end point.
`endX`	Returns the segment's end x-coordinate.
`endY`	Returns the segment's end y-coordinate.
`length`	Returns the length of the segment.
`lengthSquared`	Returns the squared length of the segment.
`pointLeftOfLine`	Tests if a point is to the left of the line segment.
`reverse`	Reverses the line segment, so that the start and end points are flipped.
`setEnd`	Sets the segment's end point.
`setEndX`	Sets the segment's end x coordinate.
`setEndY`	Sets the segment's end y coordinate.
`setStart`	Sets the segment's start point.
`setStartX`	Sets the segment's start x coordinate.
`setStartY`	Sets the segment's start y coordinate.
`start`	Returns the segment's start point.
`startX`	Returns the segment's start x-coordinate.
`startY`	Returns the segment's start y-coordinate.

class qgis.core.QgsLineSegment2D[source]¶

Bases: object

__init__(start: QgsPointXY, end: QgsPointXY)

Constructor for a QgsLineSegment2D from the specified start point to the end point.

Parameters:

start (QgsPointXY)
end (QgsPointXY)

__init__(x1: float, y1: float, x2: float, y2: float)

Constructor for a QgsLineSegment2D from the point (x1, y2) to (x2, y2).

Parameters:

x1 (float)
y1 (float)
x2 (float)
y2 (float)

__init__(a0: QgsLineSegment2D)

Parameters:: a0 (QgsLineSegment2D)

end(self) → QgsPointXY[source]¶

Returns the segment’s end point.

See also

start()

See also

endX()

See also

endY()

Return type:: QgsPointXY

endX(self) → float[source]¶

Returns the segment’s end x-coordinate.

See also

end()

See also

endY()

Return type:: float

endY(self) → float[source]¶

Returns the segment’s end y-coordinate.

See also

end()

See also

endX()

Return type:: float

length(self) → float[source]¶

Returns the length of the segment.

See also

lengthSquared()

Return type:: float

lengthSquared(self) → float[source]¶

Returns the squared length of the segment.

See also

length()

Return type:: float

pointLeftOfLine(self, point: QgsPointXY) → int[source]¶

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.

See also

QgsGeometryUtils.leftOfLine()