Struct Line2 

pub struct Line2 { /* private fields */ }

An infinite 2D line represented by two sample points.

Implementations

impl Line2

pub const fn new(a: Point2, b: Point2) -> Self

Creates a line from two sample points.

pub fn try_new(a: Point2, b: Point2) -> Result<Self, GeometryError>

Creates a validated line from two distinct sample points with finite coordinates.

Errors

Returns GeometryError::NonFiniteComponent when either input point contains a non-finite coordinate.

Returns GeometryError::IdenticalPoints when a == b.

pub fn try_from_points(a: Point2, b: Point2) -> Result<Self, GeometryError>

Creates a validated line from two distinct finite sample points.

Errors

Returns GeometryError::NonFiniteComponent when either input point contains a non-finite coordinate.

Returns GeometryError::IdenticalPoints when a == b.

pub fn try_from_point_direction( point: Point2, direction: Vector2, ) -> Result<Self, GeometryError>

Creates a validated line from a point and non-zero direction vector.

Errors

Returns GeometryError::NonFiniteComponent when point or direction contains a non-finite value.

Returns GeometryError::ZeroDirectionVector when direction is zero.

pub const fn a(self) -> Point2

Returns the first sample point on the line.

pub const fn b(self) -> Point2

Returns the second sample point on the line.

pub const fn point(self) -> Point2

Returns one sample point on the line.

pub fn direction(self) -> Vector2

Returns the line direction from a to b.

pub fn contains_point(self, point: Point2) -> bool

Returns true when point lies on the infinite line.

pub fn contains_point_with_tolerance( self, point: Point2, tolerance: f64, ) -> Result<bool, GeometryError>

Returns true when point lies within tolerance of the line.

Errors

Returns GeometryError::NonFiniteTolerance when tolerance is NaN or infinite.

Returns GeometryError::NegativeTolerance when tolerance is negative.

pub fn slope(self) -> Option<f64>

Returns the slope, or None for a vertical line.

pub fn try_slope(self) -> Result<Option<f64>, GeometryError>

Returns the slope when both line points contain only finite coordinates.

Errors

Returns GeometryError::NonFiniteComponent when either point contains a non-finite coordinate.

Trait Implementations

impl Clone for Line2

fn clone(&self) -> Line2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Line2

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

Formats the value using the given formatter.

impl PartialEq for Line2

fn eq(&self, other: &Line2) -> 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 Line2

impl StructuralPartialEq for Line2