Struct LineSegment 

pub struct LineSegment<P> { /* private fields */ }

LineSegment defined by a start and an endpoint, evaluable anywhere inbetween using interpolation parameter t: [0, 1] in eval().

A LineSegment is equal to a linear Bezier curve, which is why there is no specialized type for that case.

Methods that need component access or norms add PointIndex/PointNorm bounds as required.

Implementations

impl<P> LineSegment<P>

where P: Point,

pub fn new(start: P, end: P) -> Self

Create a new line segment from start to end.

pub fn start(&self) -> P

Return the start point of the segment.

pub fn end(&self) -> P

Return the end point of the segment.

pub fn reverse(&self) -> Self

Return a segment with reversed direction.

pub fn eval(&self, t: P::Scalar) -> P

Evaluate a point along the segment for t in [0, 1].

pub fn split(&self, t: P::Scalar) -> (Self, Self)

Split the segment at t into two sub-segments.

pub fn distance_to_point(&self, p: P) -> P::Scalar

where P: PointNorm,

Return the distance from the LineSegment to Point p by calculating the projection

pub fn derivative(&self) -> P

Return the derivative vector of the segment.

pub fn tangent(&self, _t: P::Scalar) -> P

where P: PointNorm,

Return the unit tangent direction at t.

pub fn curvature(&self, _t: P::Scalar) -> P::Scalar

where P: PointNorm,

Return the curvature magnitude at t.

Lines have zero curvature, so this always returns 0.

pub fn normal(&self, _t: P::Scalar) -> Option<P>

where P: PointNorm,

Return the principal normal direction at t.

Lines have zero curvature, so this always returns None.

pub fn t_at_length_approx(&self, s: P::Scalar, _nsteps: usize) -> P::Scalar

where P: PointNorm,

Approximate parameter t at arc length s.

pub fn t_at_length(&self, s: P::Scalar) -> P::Scalar

where P: PointNorm,

Approximate parameter t at arc length s using a default resolution.

pub fn point_at_length_approx(&self, s: P::Scalar, nsteps: usize) -> P

where P: PointNorm,

Evaluate the point at arc length s.

pub fn point_at_length(&self, s: P::Scalar) -> P

where P: PointNorm,

Evaluate the point at arc length s using a default resolution.

pub fn bounding_box(&self) -> [(P::Scalar, P::Scalar); P::DIM]

where P: PointIndex,

Return the bounding box of the line as an array of (min, max) tuples for each dimension (its index)

Trait Implementations

impl<P: Clone> Clone for LineSegment<P>

fn clone(&self) -> LineSegment<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for LineSegment<P>

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

Formats the value using the given formatter.

impl<P> From<LineSegment<P>> for BezierSegment<P>

where P: Point,

fn from(s: LineSegment<P>) -> Self

Converts to this type from the input type.

impl<P: PartialEq> PartialEq for LineSegment<P>

fn eq(&self, other: &LineSegment<P>) -> 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<P: Copy> Copy for LineSegment<P>

impl<P> StructuralPartialEq for LineSegment<P>