Struct euclid::Length

#[repr(C)]
pub struct Length<T, Unit>(pub T, _);

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.

Tuple Fields

0: T

Implementations

impl<T, U> Length<T, U>

pub const fn new(x: T) -> Self

Associate a value with a unit of measure.

impl<T: Clone, U> Length<T, U>

pub fn get(self) -> T

Unpack the underlying value from the wrapper.

pub fn cast_unit<V>(self) -> Length<T, V>

Cast the unit

pub fn lerp(self, other: Self, t: T) -> Self where
    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: PartialOrd, U> Length<T, U>

pub fn min(self, other: Self) -> Self

Returns minimum between this length and another length.

pub fn max(self, other: Self) -> Self

Returns maximum between this length and another length.

impl<T: NumCast + Clone, U> Length<T, U>

pub fn cast<NewT: NumCast>(self) -> Length<NewT, U>

Cast from one numeric representation to another, preserving the units.

pub fn try_cast<NewT: NumCast>(self) -> Option<Length<NewT, U>>

Fallible cast from one numeric representation to another, preserving the units.

Trait Implementations

impl<T: Add + Copy, U> Add<&'_ Length<T, U>> for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the + operator.

fn add(self, other: &Self) -> Self::Output

Performs the + operation.

impl<T: Add, U> Add<Length<T, U>> for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<T: AddAssign, U> AddAssign<Length<T, U>> for Length<T, U>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<U, T: ApproxEq<T>> ApproxEq<T> for Length<T, U>

fn approx_epsilon() -> T

Default epsilon value

fn approx_eq_eps(&self, other: &Length<T, U>, approx_epsilon: &T) -> bool

Returns true is this object is approximately equal to the other one, using a provided epsilon value.

fn approx_eq(&self, other: &Self) -> bool

Returns true is this object is approximately equal to the other one, using the approx_epsilon() epsilon value.

impl<T: Clone, U> Clone for Length<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, U> Debug for Length<T, U>

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

Formats the value using the given formatter.

impl<T: Default, U> Default for Length<T, U>

fn default() -> Self

Returns the “default value” for a type.

impl<Src, Dst, T: Div> Div<Length<T, Src>> for Length<T, Dst>

type Output = Scale<T::Output, Src, Dst>

The resulting type after applying the / operator.

fn div(self, other: Length<T, Src>) -> Self::Output

Performs the / operation.

impl<Src, Dst, T: Div> Div<Scale<T, Src, Dst>> for Length<T, Dst>

type Output = Length<T::Output, Src>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, Src, Dst>) -> Self::Output

Performs the / operation.

impl<T: Div, U> Div<T> for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self::Output

Performs the / operation.

impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Length<T, U>

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T: Hash, U> Hash for Length<T, U>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Src, Dst, T: Mul> Mul<Scale<T, Src, Dst>> for Length<T, Src>

type Output = Length<T::Output, Dst>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, Src, Dst>) -> Self::Output

Performs the * operation.

impl<T: Mul, U> Mul<T> for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self::Output

Performs the * operation.

impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Length<T, U>

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<U, T: Neg> Neg for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Ord, U> Ord for Length<T, U>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq, U> PartialEq<Length<T, U>> for Length<T, U>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd, U> PartialOrd<Length<T, U>> for Length<T, U>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Saturating, U> Saturating for Length<T, U>

fn saturating_add(self, other: Self) -> Self

Saturating addition operator. Returns a+b, saturating at the numeric bounds instead of overflowing.

fn saturating_sub(self, other: Self) -> Self

Saturating subtraction operator. Returns a-b, saturating at the numeric bounds instead of overflowing.

impl<T: Sub, U> Sub<Length<T, U>> for Length<T, U>

type Output = Length<T::Output, U>

The resulting type after applying the - operator.

fn sub(self, other: Length<T, U>) -> Self::Output

Performs the - operation.

impl<T: SubAssign, U> SubAssign<Length<T, U>> for Length<T, U>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, T: 'a + Add<Output = T> + Copy + Zero, U: 'a> Sum<&'a Length<T, U>> for Length<T, U>

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: Add<Output = T> + Zero, U> Sum<Length<T, U>> for Length<T, U>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: Zero, U> Zero for Length<T, U>

fn zero() -> Self

impl<T: Copy, U> Copy for Length<T, U>

impl<T: Eq, U> Eq for Length<T, U>