Struct truck_geometry::specifieds::Line

pub struct Line<P>(pub P, pub P);

line

Example

use truck_geometry::prelude::*;
let line = Line(Point2::new(0.0, 0.0), Point2::new(1.0, 1.0));
assert_near!(line.subs(0.5), Point2::new(0.5, 0.5));

Tuple Fields

0: P

1: P

Implementations

impl<P: Copy> Line<P>

pub fn from_origin_direction<V>(origin: P, direction: V) -> Self

where P: Add<V, Output = P>,

initialize line from vector

pub fn to_bspline(self) -> BSplineCurve<P>

to a bspline curve

impl<P> Line<P>

where P: EuclideanSpace<Scalar = f64>, P::Diff: InnerSpace<Scalar = f64>,

pub fn projection(self, point: P) -> P

Returns the projected point to the line.

Examples

use truck_geometry::prelude::*;
let line = Line(Point2::new(0.0, 0.0), Point2::new(1.0, 2.0));
let pt = Point2::new(0.0, 1.0);
assert_near!(line.projection(pt), Point2::new(0.4, 0.8));

pub fn distance_to_point(self, point: P) -> f64

Returns the distance between the line and the point point.

Examples

use truck_geometry::prelude::*;
let line = Line(Point2::new(0.0, 0.0), Point2::new(3.0, 4.0));

// The foot of the perpendicular line is on a line segment
let pt = Point2::new(3.0, 0.0);
assert_near!(line.distance_to_point(pt), 2.4);

// The foot of the perpendicular line is not on a line segment
let pt = Point2::new(0.0, -4.0);
assert_near!(line.distance_to_point(pt), 2.4);

pub fn distance_to_point_as_segment(self, point: P) -> f64

Returns the distance between the sengment and the point point.

Examples

use truck_geometry::prelude::*;
let line = Line(Point2::new(0.0, 0.0), Point2::new(3.0, 4.0));

// The foot of the perpendicular line is on a line segment
let pt = Point2::new(3.0, 0.0);
assert_near!(line.distance_to_point_as_segment(pt), 2.4);

// The foot of the perpendicular line is not on a line segment
let pt = Point2::new(0.0, -4.0);
assert_near!(line.distance_to_point_as_segment(pt), 4.0);

impl Line<Point2>

pub fn intersection(self, other: Line<Point2>) -> Option<(f64, f64, Point2)>

Returns the intersection of two lines and its parameters.

Examples

use truck_geometry::prelude::*;
let line0 = Line(Point2::new(0.0, 0.0), Point2::new(9.0, 3.0));
let line1 = Line(Point2::new(0.0, 6.0), Point2::new(9.0, 0.0));
let (s, t, p) = line0.intersection(line1).unwrap();
assert_near!(line0.subs(s), Point2::new(6.0, 2.0));
assert_near!(line1.subs(t), Point2::new(6.0, 2.0));
assert_near!(p, Point2::new(6.0, 2.0));

Failures

Returns None if two lines are parallel.

use truck_geometry::prelude::*;
let line0 = Line(Point2::new(0.0, 0.0), Point2::new(9.0, 3.0));
let line1 = Line(Point2::new(-1.0, 0.0), Point2::new(8.0, 3.0));
assert!(line0.intersection(line1).is_none());

Trait Implementations

impl<P: ControlPoint<f64>> BoundedCurve for Line<P>

fn range_tuple(&self) -> (f64, f64)

Return the ends of parameter_range by tuple.

fn front(&self) -> Self::Point

The front end point of the curve.

fn back(&self) -> Self::Point

The back end point of the curve.

impl<P: Clone> Clone for Line<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: ControlPoint<f64>> Cut for Line<P>

fn cut(&mut self, t: f64) -> Self

Cuts one curve into two curves. Assigns the former curve to self and returns the later curve.

impl<P: Debug> Debug for Line<P>

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for Line<P>

where P: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: Copy> Invertible for Line<P>

fn invert(&mut self)

Inverts self

fn inverse(&self) -> Self

Returns the inverse.

impl<P: ControlPoint<f64>> ParameterDivision1D for Line<P>

type Point = P

The curve is in the space of Self::Point.

fn parameter_division(&self, range: (f64, f64), _: f64) -> (Vec<f64>, Vec<P>)

Creates the curve division (parameters, corresponding points).

impl<P: ControlPoint<f64>> ParametricCurve for Line<P>

fn parameter_range(&self) -> ParameterRange

Return 0.0..=1.0 i.e. we regard it as a segment

type Point = P

The curve is in the space of Self::Point.

type Vector = <P as ControlPoint<f64>>::Diff

The derivation vector of the curve.

fn subs(&self, t: f64) -> Self::Point

Substitutes the parameter t.

fn der(&self, _: f64) -> Self::Vector

Returns the derivation.

fn der2(&self, _: f64) -> Self::Vector

Returns the 2nd-order derivation.

fn try_range_tuple(&self) -> Option<(f64, f64)>

Return the ends of parameter_range by tuple. If the range is unbounded, return `None``.

fn period(&self) -> Option<f64>

None in default implementation; Some(period) if periodic.

impl<P: PartialEq> PartialEq for Line<P>

fn eq(&self, other: &Line<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> SearchNearestParameter<D1> for Line<P>

where P: ControlPoint<f64>, P::Diff: InnerSpace<Scalar = f64>,

type Point = P

point

fn search_nearest_parameter<H: Into<SPHint1D>>( &self, pt: P, _: H, _: usize, ) -> Option<f64>

Search nearest parameter t such that self.subs(t) is nearest point.
Returns None if could not find such parameter.

impl<P> SearchParameter<D1> for Line<P>

where P: ControlPoint<f64> + Tolerance, P::Diff: InnerSpace<Scalar = f64>,

type Point = P

point

fn search_parameter<H: Into<SPHint1D>>( &self, pt: P, _: H, _: usize, ) -> Option<f64>

Search parameter t such that self.subs(t) is near point.
Returns None if could not find such parameter.

impl<P> Serialize for Line<P>

where P: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: EuclideanSpace, M: Transform<P>> Transformed<M> for Line<P>

fn transform_by(&mut self, trans: M)

transform by trans.

fn transformed(&self, trans: M) -> Self

transformed geometry by trans.

impl<P: Copy> Copy for Line<P>

impl<P: Eq> Eq for Line<P>

impl<P> StructuralPartialEq for Line<P>