Struct Line

pub struct Line {
    pub from: V2,
    pub to: V2,
}

A line defined by two points. Can represent both finite line segments and infinite lines.

Fields

from: V2

to: V2

Implementations

impl Line

pub fn new(from: V2, to: V2) -> Self

pub fn vector(&self) -> V2

Returns the vector from from to to.

pub fn mid(&self) -> V2

Returns the midpoint of the line.

pub fn angle(&self) -> Angle

Returns the angle of the line (from from to to).

pub fn offset_right(&self, distance: f32) -> Self

Returns a new line offset to the right by the given distance.

“Right” is determined by the orthogonal vector to the right of the line’s direction.

pub fn project(&self, point: &V2) -> V2

Projects a point onto the infinite line defined by this line segment.

pub fn point_relation(&self, point: &V2) -> PointLineRelation

Determines the position of a point relative to this line.

pub fn intersection(&self, other: &Line) -> LineIntersection

Checks for an intersection between this line segment and another.

For infinite lines, see Self::intersection_as_inf_lines.

pub fn intersection_as_inf_lines(&self, other: &Line) -> LineIntersection

Checks for an intersection between this line and another, treating both as infinite lines.

For line segments, see Self::intersection.

pub fn closest_point_on_infinite_line(&self, point: &V2) -> V2

Returns the closest point on the infinite line to the given point.

For line segments, see Self::closest_point.

pub fn closest_point(&self, point: &V2) -> V2

Returns the closest point on the line segment to the given point.

For infinite lines, see Self::closest_point_on_infinite_line.

pub fn intersect_multiple_sorted_by_dist( &self, line_segments: &[Line], ) -> Vec<V2>

Returns all intersections of this line with the given line segments, sorted by distance from self.from.

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Line

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Line

fn eq(&self, other: &Line) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Line

impl StructuralPartialEq for Line