Math.Geometry


Line2D Module

Functions and values

Function or value Description

areParallel first second

Full Usage: areParallel first second

Parameters:
    first : Line2D<'Units, 'Coordinates>
    second : Line2D<'Units, 'Coordinates>

Returns: bool
first : Line2D<'Units, 'Coordinates>
second : Line2D<'Units, 'Coordinates>
Returns: bool

arePerpendicular first second

Full Usage: arePerpendicular first second

Parameters:
    first : Line2D<'Units, 'Coordinates>
    second : Line2D<'Units, 'Coordinates>

Returns: bool
first : Line2D<'Units, 'Coordinates>
second : Line2D<'Units, 'Coordinates>
Returns: bool

atPointInDirection point direction

Full Usage: atPointInDirection point direction

Parameters:
    point : Point2D<'Units, 'Coordinates>
    direction : Vector2D<'Units, 'Coordinates>

Returns: Line2D<'Units, 'Coordinates>
point : Point2D<'Units, 'Coordinates>
direction : Vector2D<'Units, 'Coordinates>
Returns: Line2D<'Units, 'Coordinates>

axis line

Full Usage: axis line

Parameters:
    line : Line2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates> option
line : Line2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates> option

direction line

Full Usage: direction line

Parameters:
    line : Line2D<'Units, 'Coordinates>

Returns: Direction2D<'Coordinates> option
line : Line2D<'Units, 'Coordinates>
Returns: Direction2D<'Coordinates> option

distanceToPoint point line

Full Usage: distanceToPoint point line

Parameters:
    point : Point2D<'Units, 'Coordinates>
    line : Line2D<'Units, 'Coordinates>

Returns: Quantity<'Units>
point : Point2D<'Units, 'Coordinates>
line : Line2D<'Units, 'Coordinates>
Returns: Quantity<'Units>

fromPointAndVector start direction

Full Usage: fromPointAndVector start direction

Parameters:
    start : Point2D<'Units, 'Coordinates>
    direction : Vector2D<'Units, 'Coordinates>

Returns: Line2D<'Units, 'Coordinates>

Create a line Starting at point in a particular direction and length

start : Point2D<'Units, 'Coordinates>
direction : Vector2D<'Units, 'Coordinates>
Returns: Line2D<'Units, 'Coordinates>

intersect first second

Full Usage: intersect first second

Parameters:
    first : Line2D<'Units, 'Coordinates>
    second : Line2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates> option
first : Line2D<'Units, 'Coordinates>
second : Line2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates> option

isPointOnLine point line

Full Usage: isPointOnLine point line

Parameters:
    point : Point2D<'Units, 'Coordinates>
    line : Line2D<'Units, 'Coordinates>

Returns: bool
point : Point2D<'Units, 'Coordinates>
line : Line2D<'Units, 'Coordinates>
Returns: bool

length line

Full Usage: length line

Parameters:
    line : Line2D<'Units, 'Coordinates>

Returns: Quantity<'Units>
line : Line2D<'Units, 'Coordinates>
Returns: Quantity<'Units>

pointClosestTo point line

Full Usage: pointClosestTo point line

Parameters:
    point : Point2D<'Units, 'Coordinates>
    line : Line2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates>
point : Point2D<'Units, 'Coordinates>
line : Line2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

round l

Full Usage: round l

Parameters:
    l : Line2D<'Units, 'Coordinates>

Returns: Line2D<'Units, 'a>
l : Line2D<'Units, 'Coordinates>
Returns: Line2D<'Units, 'a>

through start finish

Full Usage: through start finish

Parameters:
    start : Point2D<'Units, 'Coordinates>
    finish : Point2D<'Units, 'Coordinates>

Returns: Line2D<'Units, 'Coordinates>
start : Point2D<'Units, 'Coordinates>
finish : Point2D<'Units, 'Coordinates>
Returns: Line2D<'Units, 'Coordinates>