[−][src]Struct euclid::Length
A one-dimensional distance, with value represented by T
and unit of measurement Unit
.
T
can be any numeric type, for example a primitive type like u64
or f32
.
Unit
is not used in the representation of a Length
value. It is used only at compile time
to ensure that a Length
stored with one unit is converted explicitly before being used in an
expression that requires a different unit. It may be a type without values, such as an empty
enum.
You can multiply a Length
by a scale::Scale
to convert it from one unit to
another. See the Scale
docs for an example.
Implementations
impl<T, U> Length<T, U>
[src]
impl<T: Clone, U> Length<T, U>
[src]
pub fn get(&self) -> T
[src]
Unpack the underlying value from the wrapper, cloning it.
pub fn cast_unit<V>(&self) -> Length<T, V>
[src]
Cast the unit
pub fn lerp(&self, other: Self, t: T) -> Self where
T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,
[src]
T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,
Linearly interpolate between this length and another length.
Example
use euclid::default::Length; let from = Length::new(0.0); let to = Length::new(8.0); assert_eq!(from.lerp(to, -1.0), Length::new(-8.0)); assert_eq!(from.lerp(to, 0.0), Length::new( 0.0)); assert_eq!(from.lerp(to, 0.5), Length::new( 4.0)); assert_eq!(from.lerp(to, 1.0), Length::new( 8.0)); assert_eq!(from.lerp(to, 2.0), Length::new(16.0));
impl<T: NumCast + Clone, U> Length<T, U>
[src]
pub fn cast<NewT: NumCast>(&self) -> Length<NewT, U>
[src]
Cast from one numeric representation to another, preserving the units.
pub fn try_cast<NewT: NumCast>(&self) -> Option<Length<NewT, U>>
[src]
Fallible cast from one numeric representation to another, preserving the units.
Trait Implementations
impl<T: Add, U> Add<Length<T, U>> for Length<T, U>
[src]
type Output = Length<T::Output, U>
The resulting type after applying the +
operator.
fn add(self, other: Self) -> Self::Output
[src]
impl<T: AddAssign, U> AddAssign<Length<T, U>> for Length<T, U>
[src]
fn add_assign(&mut self, other: Self)
[src]
impl<U, T: ApproxEq<T>> ApproxEq<T> for Length<T, U>
[src]
fn approx_epsilon() -> T
[src]
fn approx_eq_eps(&self, other: &Length<T, U>, approx_epsilon: &T) -> bool
[src]
fn approx_eq(&self, other: &Self) -> bool
[src]
impl<T: Clone, U> Clone for Length<T, U>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Copy, U> Copy for Length<T, U>
[src]
impl<T: Debug, U> Debug for Length<T, U>
[src]
impl<T: Default, U> Default for Length<T, U>
[src]
impl<T: Display, U> Display for Length<T, U>
[src]
impl<Src, Dst, T: Div> Div<Length<T, Src>> for Length<T, Dst>
[src]
type Output = Scale<T::Output, Src, Dst>
The resulting type after applying the /
operator.
fn div(self, other: Length<T, Src>) -> Self::Output
[src]
impl<Src, Dst, T: Div> Div<Scale<T, Src, Dst>> for Length<T, Dst>
[src]
type Output = Length<T::Output, Src>
The resulting type after applying the /
operator.
fn div(self, scale: Scale<T, Src, Dst>) -> Self::Output
[src]
impl<T: Div, U> Div<T> for Length<T, U>
[src]
type Output = Length<T::Output, U>
The resulting type after applying the /
operator.
fn div(self, scale: T) -> Self::Output
[src]
impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Length<T, U>
[src]
fn div_assign(&mut self, scale: T)
[src]
impl<T: Eq, U> Eq for Length<T, U>
[src]
impl<T: Hash, U> Hash for Length<T, U>
[src]
fn hash<H: Hasher>(&self, h: &mut H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<Src, Dst, T: Mul> Mul<Scale<T, Src, Dst>> for Length<T, Src>
[src]
type Output = Length<T::Output, Dst>
The resulting type after applying the *
operator.
fn mul(self, scale: Scale<T, Src, Dst>) -> Self::Output
[src]
impl<T: Mul, U> Mul<T> for Length<T, U>
[src]
type Output = Length<T::Output, U>
The resulting type after applying the *
operator.
fn mul(self, scale: T) -> Self::Output
[src]
impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Length<T, U>
[src]
fn mul_assign(&mut self, scale: T)
[src]
impl<U, T: Neg> Neg for Length<T, U>
[src]
type Output = Length<T::Output, U>
The resulting type after applying the -
operator.
fn neg(self) -> Self::Output
[src]
impl<T: Ord, U> Ord for Length<T, U>
[src]
fn cmp(&self, other: &Self) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T: PartialEq, U> PartialEq<Length<T, U>> for Length<T, U>
[src]
impl<T: PartialOrd, U> PartialOrd<Length<T, U>> for Length<T, U>
[src]
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T: Saturating, U> Saturating for Length<T, U>
[src]
fn saturating_add(self, other: Self) -> Self
[src]
fn saturating_sub(self, other: Self) -> Self
[src]
impl<T: Sub, U> Sub<Length<T, U>> for Length<T, U>
[src]
type Output = Length<T::Output, U>
The resulting type after applying the -
operator.
fn sub(self, other: Length<T, U>) -> Self::Output
[src]
impl<T: SubAssign, U> SubAssign<Length<T, U>> for Length<T, U>
[src]
fn sub_assign(&mut self, other: Self)
[src]
impl<T: Zero, U> Zero for Length<T, U>
[src]
Auto Trait Implementations
impl<T, Unit> RefUnwindSafe for Length<T, Unit> where
T: RefUnwindSafe,
Unit: RefUnwindSafe,
T: RefUnwindSafe,
Unit: RefUnwindSafe,
impl<T, Unit> Send for Length<T, Unit> where
T: Send,
Unit: Send,
T: Send,
Unit: Send,
impl<T, Unit> Sync for Length<T, Unit> where
T: Sync,
Unit: Sync,
T: Sync,
Unit: Sync,
impl<T, Unit> Unpin for Length<T, Unit> where
T: Unpin,
Unit: Unpin,
T: Unpin,
Unit: Unpin,
impl<T, Unit> UnwindSafe for Length<T, Unit> where
T: UnwindSafe,
Unit: UnwindSafe,
T: UnwindSafe,
Unit: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Zero for T where
T: Zero,
[src]
T: Zero,