Uranium
Application Framework
UM.Math.LineSegment.LineSegment Class Reference

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

Inherits object.

Public Member Functions

def __init__ (self, endpoint_a, endpoint_b)
 Creates a new line segment with the specified endpoints. More...
 
def getEnd (self)
 Gets the second endpoint (B) of the line segment. More...
 
def getStart (self)
 Gets the first endpoint (A) of the line segment. More...
 
def intersection (self, other)
 Returns the point of intersection of this line segment with another line segment, if any. More...
 
def intersectsWithLine (self, a, 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,
  endpoint_a,
  endpoint_b 
)

Creates a new line segment with the specified endpoints.

Parameters
endpoint_aAn endpoint of the line segment.
endpoint_bAn endpoint of the line segment.

Member Function Documentation

◆ getEnd()

def UM.Math.LineSegment.LineSegment.getEnd (   self)

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

Returns
The second endpoint of the line segment.

◆ getStart()

def UM.Math.LineSegment.LineSegment.getStart (   self)

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

Returns
The first endpoint of the line segment.

◆ intersection()

def UM.Math.LineSegment.LineSegment.intersection (   self,
  other 
)

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

Parameters
otherThe line segment to check intersection with.
Returns
The intersection point if they intersect, or None otherwise.

◆ intersectsWithLine()

def UM.Math.LineSegment.LineSegment.intersectsWithLine (   self,
  a,
  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
aA point on the line to intersect with.
bA 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: