[][src]Struct euclid::TypedSize2D

#[repr(C)]
pub struct TypedSize2D<T, U> {
    pub width: T,
    pub height: T,
    // some fields omitted
}

A 2d size tagged with a unit.

Fields

width: Theight: T

Methods

impl<T, U> TypedSize2D<T, U>[src]

pub fn new(width: T, height: T) -> Self[src]

Constructor taking scalar values.

impl<T: Clone, U> TypedSize2D<T, U>[src]

pub fn from_lengths(width: Length<T, U>, height: Length<T, U>) -> Self[src]

Constructor taking scalar strongly typed lengths.

impl<T: Round, U> TypedSize2D<T, U>[src]

pub fn round(&self) -> Self[src]

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Ceil, U> TypedSize2D<T, U>[src]

pub fn ceil(&self) -> Self[src]

Rounds each component to the smallest integer equal or greater than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Floor, U> TypedSize2D<T, U>[src]

pub fn floor(&self) -> Self[src]

Rounds each component to the biggest integer equal or lower than the original value.

This behavior is preserved for negative values (unlike the basic cast).

impl<T: Copy + Clone + Mul<T>, U> TypedSize2D<T, U>[src]

pub fn area(&self) -> T::Output[src]

impl<T, U> TypedSize2D<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 
[src]

pub fn lerp(&self, other: Self, t: T) -> Self[src]

Linearly interpolate between this size and another size.

t is expected to be between zero and one.

impl<T: Zero + PartialOrd, U> TypedSize2D<T, U>[src]

pub fn is_empty_or_negative(&self) -> bool[src]

impl<T: Zero, U> TypedSize2D<T, U>[src]

pub fn zero() -> Self[src]

impl<T: Copy, U> TypedSize2D<T, U>[src]

pub fn width_typed(&self) -> Length<T, U>[src]

Returns self.width as a Length carrying the unit.

pub fn height_typed(&self) -> Length<T, U>[src]

Returns self.height as a Length carrying the unit.

pub fn to_array(&self) -> [T; 2][src]

pub fn to_tuple(&self) -> (T, T)[src]

pub fn to_vector(&self) -> TypedVector2D<T, U>[src]

pub fn to_untyped(&self) -> Size2D<T>[src]

Drop the units, preserving only the numeric value.

pub fn from_untyped(p: &Size2D<T>) -> Self[src]

Tag a unitless value with units.

impl<T: NumCast + Copy, Unit> TypedSize2D<T, Unit>[src]

pub fn cast<NewT: NumCast + Copy>(&self) -> TypedSize2D<NewT, Unit>[src]

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

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<TypedSize2D<NewT, Unit>>[src]

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

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn to_f32(&self) -> TypedSize2D<f32, Unit>[src]

Cast into an f32 size.

pub fn to_f64(&self) -> TypedSize2D<f64, Unit>[src]

Cast into an f64 size.

pub fn to_usize(&self) -> TypedSize2D<usize, Unit>[src]

Cast into an uint size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(&self) -> TypedSize2D<u32, Unit>[src]

Cast into an u32 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(&self) -> TypedSize2D<i32, Unit>[src]

Cast into an i32 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(&self) -> TypedSize2D<i64, Unit>[src]

Cast into an i64 size, truncating decimals if any.

When casting from floating point sizes, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

impl<T, U> TypedSize2D<T, U> where
    T: Signed
[src]

pub fn abs(&self) -> Self[src]

pub fn is_positive(&self) -> bool[src]

impl<T: PartialOrd, U> TypedSize2D<T, U>[src]

pub fn greater_than(&self, other: &Self) -> BoolVector2D[src]

pub fn lower_than(&self, other: &Self) -> BoolVector2D[src]

impl<T: PartialEq, U> TypedSize2D<T, U>[src]

pub fn equal(&self, other: &Self) -> BoolVector2D[src]

pub fn not_equal(&self, other: &Self) -> BoolVector2D[src]

impl<T: Float, U> TypedSize2D<T, U>[src]

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

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

pub fn clamp(&self, start: Self, end: Self) -> Self[src]

Trait Implementations

impl<T: Zero, U> Zero for TypedSize2D<T, U>[src]

impl<T, U> PartialEq<TypedSize2D<T, U>> for TypedSize2D<T, U> where
    T: PartialEq
[src]

#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl<T, U> Eq for TypedSize2D<T, U> where
    T: Eq
[src]

impl<T, U> Hash for TypedSize2D<T, U> where
    T: Hash
[src]

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

Feeds a slice of this type into the given [Hasher]. Read more

impl<T: Display, U> Display for TypedSize2D<T, U>[src]

impl<T: Debug, U> Debug for TypedSize2D<T, U>[src]

impl<T: Copy + Add<T, Output = T>, U> Add<TypedSize2D<T, U>> for TypedPoint2D<T, U>[src]

type Output = Self

The resulting type after applying the + operator.

impl<T: Copy + Add<T, Output = T>, U> Add<TypedSize2D<T, U>> for TypedSize2D<T, U>[src]

type Output = Self

The resulting type after applying the + operator.

impl<T: Copy + Sub<T, Output = T>, U> Sub<TypedSize2D<T, U>> for TypedSize2D<T, U>[src]

type Output = Self

The resulting type after applying the - operator.

impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedSize2D<T, U>[src]

type Output = Self

The resulting type after applying the * operator.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedSize2D<T, U1>[src]

type Output = TypedSize2D<T, U2>

The resulting type after applying the * operator.

impl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedSize2D<T, U>[src]

type Output = Self

The resulting type after applying the / operator.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<TypedScale<T, U1, U2>> for TypedSize2D<T, U2>[src]

type Output = TypedSize2D<T, U1>

The resulting type after applying the / operator.

impl<T, U> Copy for TypedSize2D<T, U> where
    T: Copy
[src]

impl<T: Copy, U> Into<[T; 2]> for TypedSize2D<T, U>[src]

impl<T: Copy, U> Into<(T, T)> for TypedSize2D<T, U>[src]

impl<T, U> From<TypedSize2D<T, U>> for TypedBox2D<T, U> where
    T: Copy + Zero + PartialOrd
[src]

impl<T, U> From<TypedSize2D<T, U>> for TypedRect<T, U> where
    T: Copy + Zero
[src]

impl<T: Copy, U> From<[T; 2]> for TypedSize2D<T, U>[src]

impl<T: Copy, U> From<(T, T)> for TypedSize2D<T, U>[src]

impl<T, U> Clone for TypedSize2D<T, U> where
    T: Clone
[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Default, U> Default for TypedSize2D<T, U>[src]

Auto Trait Implementations

impl<T, U> Unpin for TypedSize2D<T, U> where
    T: Unpin,
    U: Unpin

impl<T, U> Send for TypedSize2D<T, U> where
    T: Send,
    U: Send

impl<T, U> Sync for TypedSize2D<T, U> where
    T: Sync,
    U: Sync

impl<T, U> UnwindSafe for TypedSize2D<T, U> where
    T: UnwindSafe,
    U: UnwindSafe

impl<T, U> RefUnwindSafe for TypedSize2D<T, U> where
    T: RefUnwindSafe,
    U: RefUnwindSafe

Blanket Implementations

impl<T> Zero for T where
    T: Zero
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]