Struct LineSegment

pub struct LineSegment<T, const D: usize> {
    pub start: Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>,
    pub end: Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>,
}

Line segment in any number of dimensions

Fields

start: Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

One end of the line segment, the point returned when interpolating at t = 0.0

end: Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

One end of the line segment, the point returned when interpolating at t = 1.0

Implementations

impl<T, const D: usize> LineSegment<T, D>

where T: Zero + One + Scalar + RealField,

pub fn new( start: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, end: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, ) -> LineSegment<T, D>

Create a new line segment with the given points.

pub fn swapped(&self) -> LineSegment<T, D>

Creates a reversed line segment by swapping start and end.

pub fn is_degenerate(&self) -> bool

The two end-points of the line segment are equal.

pub fn interpolate( &self, t: T, ) -> Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

Create a point somewhere between start and end. When t = 0.0, start is returned. When t = 1.0, end is returned. The result is (1.0 - t) * start + t * end, which may produce points off the line segment, if t < 0.0 or t > 1.0.

pub fn interpolate_clamped( &self, t: T, ) -> Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

Create a point somewhere between start and end. This is just like LineSegment::interpolate except that t is clamped to between 0.0 and 1.0, so points off the line segment can never be returned.

pub fn vector(&self) -> Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

The vector from start to end

pub fn length(&self) -> T

The distance between start and end

pub fn length_squared(&self) -> T

The square of the distance between start and end

pub fn nearest_t( &self, point: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, ) -> T

The interpolation parameter of the point on this segment that is closest to the given point.

Stack Exchange question: Find a point on a line segment which is the closest to other point not on the line segment

pub fn nearest_point( &self, point: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, ) -> Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>

The point on this segment that is closest to the given point.

pub fn distance_squared( &self, point: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, ) -> T

The squared distance between the given point and the nearest point on this line segment.

pub fn distance( &self, point: &Matrix<T, Const<D>, Const<1>, ArrayStorage<T, D, 1>>, ) -> T

The distance between the given point and the nearest point on this line segment.

impl<T> LineSegment<T, 2>

where T: Zero + One + Scalar + RealField,

pub fn bounds(&self) -> Rect<T>

where T: Number,

AABB for a 2D line segment

pub fn collinearity( &self, point: &Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>, ) -> T

Test whether a point is collinear with this segment.

• 0.0 means collinear. Near to 0.0 means near to collinear.
• Negative means that the point is to the counter-clockwise of end as viewed from start.
• Positive means that the point is to the clockwise of end as viewed from start.

pub fn intersects(&self, other: &LineSegment<T, 2>) -> bool

True if this segment intersects the given segment based on collinearity.

Trait Implementations

impl<T, const D: usize> Clone for LineSegment<T, D>

where T: Clone,

fn clone(&self) -> LineSegment<T, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, const D: usize> Debug for LineSegment<T, D>

where T: Debug,

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

Formats the value using the given formatter.