UM.Math.LineSegment.LineSegment Class Reference

Represents a line segment in 2D. More...

Public Member Functions
def	__init__ (self, Vector2 endpoint_a, Vector2 endpoint_b)
	Creates a new line segment with the specified endpoints. More...
Vector2	getEnd (self)
	Gets the second endpoint (B) of the line segment. More...
Vector2	getStart (self)
	Gets the first endpoint (A) of the line segment. More...
Optional[Vector2]	intersection (self, "LineSegment" other)
	Returns the point of intersection of this line segment with another line segment, if any. More...
bool	intersectsWithLine (self, Vector2 a, Vector2 b)
	Returns whether the line segment intersects the specified (infinite) line. More...

Detailed Description

Represents a line segment in 2D.

The line segment is represented by two endpoints.

Constructor & Destructor Documentation

__init__()

def UM.Math.LineSegment.LineSegment.__init__	(		self,
		Vector2	endpoint_a,
		Vector2	endpoint_b
	)

Creates a new line segment with the specified endpoints.

Parameters

endpoint_a	An endpoint of the line segment.
endpoint_b	An endpoint of the line segment.

Member Function Documentation

getEnd()

Vector2 UM.Math.LineSegment.LineSegment.getEnd

(

self

)

Gets the second endpoint (B) of the line segment.

Returns

The second endpoint of the line segment.

getStart()

Vector2 UM.Math.LineSegment.LineSegment.getStart

(

self

)

Gets the first endpoint (A) of the line segment.

Returns

The first endpoint of the line segment.

intersection()

Optional[Vector2] UM.Math.LineSegment.LineSegment.intersection	(		self,
		"LineSegment"	other
	)

Returns the point of intersection of this line segment with another line segment, if any.

Parameters

other

The line segment to check intersection with.

Returns

The intersection point if they intersect, or None otherwise.

intersectsWithLine()

bool UM.Math.LineSegment.LineSegment.intersectsWithLine	(		self,
		Vector2	a,
		Vector2	b
	)

Returns whether the line segment intersects the specified (infinite) line.

If the line segment touches the line with one or both endpoints, that counts as an intersection too.

Parameters

a	A point on the line to intersect with.
b	A different point on the line to intersect with.

Returns

True if the line segment intersects with the line, or False otherwise.

---

The documentation for this class was generated from the following file:

• UM/Math/LineSegment.py