Struct theon::query::Line

source · [−]

pub struct Line<S> where
    S: EuclideanSpace,  {
    pub origin: S,
    pub direction: Unit<Vector<S>>,
}

Expand description

Line.

Describes a line containing an origin point and a direction. Lines extend infinitely from their origin along their direction $\hat{u}$. Unlike Ray, the direction component of Line extends in both the positive and negative.

This representation is typically known as the vector form $P_0 + t\hat{u}$ where $t$ is some non-zero time of impact.

Fields

origin: S

The origin or contained point of the line.

direction: Unit<Vector<S>>

The unit direction(s) in which the line extends from its origin.

Implementations

source

pub fn y_intercept(&self) -> Option<Scalar<S>>

Trait Implementations

source

impl<S: Clone> Clone for Line<S> where
S: EuclideanSpace,

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<S> Debug for Line<S> where
S: Debug + EuclideanSpace,
Vector<S>: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<S> Default for Line<S> where
S: EuclideanSpace,

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<S> Intersection<Line<S>> for Line<S> where
S: EuclideanSpace + FiniteDimensional<N = U2>,

Intersection of lines in two dimensions.

type Output = LineLine<S>

source

fn intersection(&self, other: &Line<S>) -> Option<Self::Output>

source

impl<S> Intersection<Line<S>> for Plane<S> where
S: EuclideanSpace,
Line<S>: Intersection<Plane<S>>,

Symmetrical intersection.

type Output = <Line<S> as Intersection<Plane<S>>>::Output

source

fn intersection(&self, other: &Line<S>) -> Option<Self::Output>

source

impl<S> Intersection<Plane<S>> for Line<S> where
S: EuclideanSpace + FiniteDimensional,
<S as FiniteDimensional>::N: Cmp<U2, Output = Greater>,

Intersection of a line and a plane.

type Output = LinePlane<S>

The time of impact of a point intersection or the line if it lies within the plane.

The time of impact $t$ describes the distance from the line’s origin point at which the intersection occurs.

source

fn intersection(&self, plane: &Plane<S>) -> Option<Self::Output>

Determines if a line intersects a plane at a point or lies within the plane. Computes the time of impact of a Line for a point intersection.

Given a line formed from an origin $P_0$ and a unit direction $\hat{u}$, the point of intersection with the plane is $P_0 + t\hat{u}$.

source

impl<S: PartialEq> PartialEq<Line<S>> for Line<S> where
S: EuclideanSpace,

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Line<S>) -> bool

This method tests for !=.

source

impl<S: Copy> Copy for Line<S> where
S: EuclideanSpace,

source

impl<S> StructuralPartialEq for Line<S> where
S: EuclideanSpace,

Auto Trait Implementations

impl<S> RefUnwindSafe for Line<S> where
S: RefUnwindSafe,
<S as EuclideanSpace>::CoordinateSpace: RefUnwindSafe,

impl<S> Send for Line<S> where
S: Send,
<S as EuclideanSpace>::CoordinateSpace: Send,

impl<S> Sync for Line<S> where
S: Sync,
<S as EuclideanSpace>::CoordinateSpace: Sync,

impl<S> Unpin for Line<S> where
S: Unpin,
<S as EuclideanSpace>::CoordinateSpace: Unpin,

impl<S> UnwindSafe for Line<S> where
S: UnwindSafe,
<S as EuclideanSpace>::CoordinateSpace: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

source

fn inlined_clone(&self) -> T

Performance hack: Clone doesn’t get inlined for Copy types in debug mode, so make it inline anyway.

source

fn is<T>() -> bool where
T: Scalar,

Tests if Self the same as the type T Read more

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct theon::query::Line

Fields

Implementations

impl<S> Line<S> where S: EuclideanSpace,

pub fn x() -> Self where S: FiniteDimensional, S::N: Cmp<U0, Output = Greater>,

pub fn y() -> Self where S: FiniteDimensional, S::N: Cmp<U1, Output = Greater>,

pub fn z() -> Self where S: FiniteDimensional, S::N: Cmp<U2, Output = Greater>,

pub fn into_ray(self) -> Ray<S>

impl<S> Line<S> where S: EuclideanSpace + FiniteDimensional<N = U2>,

pub fn slope(&self) -> Option<Scalar<S>>

pub fn x_intercept(&self) -> Option<Scalar<S>>

pub fn y_intercept(&self) -> Option<Scalar<S>>

Trait Implementations

impl<S: Clone> Clone for Line<S> where S: EuclideanSpace,

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

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

impl<S> Debug for Line<S> where S: Debug + EuclideanSpace, Vector<S>: Debug,

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

impl<S> Default for Line<S> where S: EuclideanSpace,

fn default() -> Self

impl<S> Intersection<Line<S>> for Line<S> where S: EuclideanSpace + FiniteDimensional<N = U2>,

type Output = LineLine<S>

fn intersection(&self, other: &Line<S>) -> Option<Self::Output>

impl<S> Intersection<Line<S>> for Plane<S> where S: EuclideanSpace, Line<S>: Intersection<Plane<S>>,

type Output = <Line<S> as Intersection<Plane<S>>>::Output

fn intersection(&self, other: &Line<S>) -> Option<Self::Output>

impl<S> Intersection<Plane<S>> for Line<S> where S: EuclideanSpace + FiniteDimensional, <S as FiniteDimensional>::N: Cmp<U2, Output = Greater>,

type Output = LinePlane<S>

fn intersection(&self, plane: &Plane<S>) -> Option<Self::Output>

impl<S: PartialEq> PartialEq<Line<S>> for Line<S> where S: EuclideanSpace,

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

fn ne(&self, other: &Line<S>) -> bool

impl<S: Copy> Copy for Line<S> where S: EuclideanSpace,

impl<S> StructuralPartialEq for Line<S> where S: EuclideanSpace,

Auto Trait Implementations

impl<S> RefUnwindSafe for Line<S> where S: RefUnwindSafe, <S as EuclideanSpace>::CoordinateSpace: RefUnwindSafe,

impl<S> Send for Line<S> where S: Send, <S as EuclideanSpace>::CoordinateSpace: Send,

impl<S> Sync for Line<S> where S: Sync, <S as EuclideanSpace>::CoordinateSpace: Sync,

impl<S> Unpin for Line<S> where S: Unpin, <S as EuclideanSpace>::CoordinateSpace: Unpin,

impl<S> UnwindSafe for Line<S> where S: UnwindSafe, <S as EuclideanSpace>::CoordinateSpace: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> Scalar for T where T: Copy + PartialEq<T> + Debug + Any,

fn inlined_clone(&self) -> T

fn is<T>() -> bool where T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<S> Line<S> where
S: EuclideanSpace,

pub fn x() -> Self where
S: FiniteDimensional,
S::N: Cmp<U0, Output = Greater>,

pub fn y() -> Self where
S: FiniteDimensional,
S::N: Cmp<U1, Output = Greater>,

pub fn z() -> Self where
S: FiniteDimensional,
S::N: Cmp<U2, Output = Greater>,

impl<S> Line<S> where
S: EuclideanSpace + FiniteDimensional<N = U2>,

impl<S: Clone> Clone for Line<S> where
S: EuclideanSpace,

impl<S> Debug for Line<S> where
S: Debug + EuclideanSpace,
Vector<S>: Debug,

impl<S> Default for Line<S> where
S: EuclideanSpace,

impl<S> Intersection<Line<S>> for Line<S> where
S: EuclideanSpace + FiniteDimensional<N = U2>,

impl<S> Intersection<Line<S>> for Plane<S> where
S: EuclideanSpace,
Line<S>: Intersection<Plane<S>>,

impl<S> Intersection<Plane<S>> for Line<S> where
S: EuclideanSpace + FiniteDimensional,
<S as FiniteDimensional>::N: Cmp<U2, Output = Greater>,

impl<S: PartialEq> PartialEq<Line<S>> for Line<S> where
S: EuclideanSpace,

impl<S: Copy> Copy for Line<S> where
S: EuclideanSpace,

impl<S> StructuralPartialEq for Line<S> where
S: EuclideanSpace,

impl<S> RefUnwindSafe for Line<S> where
S: RefUnwindSafe,
<S as EuclideanSpace>::CoordinateSpace: RefUnwindSafe,

impl<S> Send for Line<S> where
S: Send,
<S as EuclideanSpace>::CoordinateSpace: Send,

impl<S> Sync for Line<S> where
S: Sync,
<S as EuclideanSpace>::CoordinateSpace: Sync,

impl<S> Unpin for Line<S> where
S: Unpin,
<S as EuclideanSpace>::CoordinateSpace: Unpin,

impl<S> UnwindSafe for Line<S> where
S: UnwindSafe,
<S as EuclideanSpace>::CoordinateSpace: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

fn is<T>() -> bool where
T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,