[][src]Struct euclid::size::Size2D

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

A 2d size tagged with a unit.

Fields

width: T

The extent of the element in the U units along the x axis (usually horizontal).

height: T

The extent of the element in the U units along the y axis (usually vertical).

Implementations

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

pub fn zero() -> Self where
    T: Zero
[src]

The same as Zero::zero() but available without importing trait.

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

Constructor taking scalar values.

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

Constructor taking scalar strongly typed lengths.

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

Tag a unitless value with units.

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

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

Return this size as an array of two elements (width, then height).

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

Return this size as a tuple of two elements (width, then height).

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

Return this size as a vector with width and height.

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

Drop the units, preserving only the numeric value.

pub fn cast_unit<V>(&self) -> Size2D<T, V>[src]

Cast the unit

#[must_use]pub fn round(&self) -> Self where
    T: Round
[src]

Rounds each component to the nearest integer value.

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

enum Mm {}

assert_eq!(size2::<_, Mm>(-0.1, -0.8).round(), size2::<_, Mm>(0.0, -1.0))

#[must_use]pub fn ceil(&self) -> Self where
    T: Ceil
[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).

enum Mm {}

assert_eq!(size2::<_, Mm>(-0.1, -0.8).ceil(), size2::<_, Mm>(0.0, 0.0))

#[must_use]pub fn floor(&self) -> Self where
    T: Floor
[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).

enum Mm {}

assert_eq!(size2::<_, Mm>(-0.1, -0.8).floor(), size2::<_, Mm>(-1.0, -1.0))

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

Returns result of multiplication of both components

pub fn lerp(&self, other: Self, t: T) -> Self where
    T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>, 
[src]

Linearly interpolate each component between this size and another size.

Example

use euclid::size2;
use euclid::default::Size2D;

let from: Size2D<_> = size2(0.0, 10.0);
let to:  Size2D<_> = size2(8.0, -4.0);

assert_eq!(from.lerp(to, -1.0), size2(-8.0,  24.0));
assert_eq!(from.lerp(to,  0.0), size2( 0.0,  10.0));
assert_eq!(from.lerp(to,  0.5), size2( 4.0,   3.0));
assert_eq!(from.lerp(to,  1.0), size2( 8.0,  -4.0));
assert_eq!(from.lerp(to,  2.0), size2(16.0, -18.0));

impl<T: NumCast + Copy, U> Size2D<T, U>[src]

pub fn cast<NewT: NumCast>(&self) -> Size2D<NewT, U>[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>(&self) -> Option<Size2D<NewT, U>>[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) -> Size2D<f32, U>[src]

Cast into an f32 size.

pub fn to_f64(&self) -> Size2D<f64, U>[src]

Cast into an f64 size.

pub fn to_usize(&self) -> Size2D<usize, U>[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) -> Size2D<u32, U>[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_u64(&self) -> Size2D<u64, U>[src]

Cast into an u64 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) -> Size2D<i32, U>[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) -> Size2D<i64, U>[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: Signed, U> Size2D<T, U>[src]

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

Computes the absolute value of each component.

For f32 and f64, NaN will be returned for component if the component is NaN.

For signed integers, ::MIN will be returned for component if the component is ::MIN.

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

Returns true if both components is positive and false any component is zero or negative.

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

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

Returns the size each component of which are minimum of this size and another.

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

Returns the size each component of which are maximum of this size and another.

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

Returns the size each component of which clamped by corresponding components of start and end.

Shortcut for self.max(start).min(end).

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

Returns vector with results of "greater then" operation on each component.

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

Returns vector with results of "lower then" operation on each component.

pub fn is_empty_or_negative(&self) -> bool where
    T: Zero
[src]

Returns true if any component of size is zero or negative.

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

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

Returns vector with results of "equal" operation on each component.

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

Returns vector with results of "not equal" operation on each component.

Trait Implementations

impl<T: Add, U> Add<Size2D<T, U>> for Point2D<T, U>[src]

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

The resulting type after applying the + operator.

impl<T: Add, U> Add<Size2D<T, U>> for Size2D<T, U>[src]

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

The resulting type after applying the + operator.

impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Point2D<T, U>[src]

impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Size2D<T, U>[src]

impl<T: Ceil, U> Ceil for Size2D<T, U>[src]

fn ceil(self) -> Self[src]

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

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

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

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

impl<'de, T, U> Deserialize<'de> for Size2D<T, U> where
    T: Deserialize<'de>, 
[src]

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 
[src]

Deserializes 2d size from tuple of width and height.

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

impl<T: Clone + Div, U1, U2> Div<Scale<T, U1, U2>> for Size2D<T, U2>[src]

type Output = Size2D<T::Output, U1>

The resulting type after applying the / operator.

impl<T: Clone + Div, U> Div<T> for Size2D<T, U>[src]

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

The resulting type after applying the / operator.

impl<T: Clone + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>[src]

impl<T: Clone + DivAssign, U> DivAssign<T> for Size2D<T, U>[src]

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

impl<T: Floor, U> Floor for Size2D<T, U>[src]

fn floor(self) -> Self[src]

impl<T, U> From<[T; 2]> for Size2D<T, U>[src]

impl<T, U> From<(T, T)> for Size2D<T, U>[src]

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

impl<T, U> From<Size2D<T, U>> for Rect<T, U> where
    T: Zero
[src]

impl<T, U> From<Size2D<T, U>> for Vector2D<T, U>[src]

impl<T, U> From<Vector2D<T, U>> for Size2D<T, U>[src]

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

impl<T, U> Into<[T; 2]> for Size2D<T, U>[src]

impl<T, U> Into<(T, T)> for Size2D<T, U>[src]

impl<T: Clone + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Size2D<T, U1>[src]

type Output = Size2D<T::Output, U2>

The resulting type after applying the * operator.

impl<T: Clone + Mul, U> Mul<T> for Size2D<T, U>[src]

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

The resulting type after applying the * operator.

impl<T: Clone + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>[src]

impl<T: Clone + MulAssign, U> MulAssign<T> for Size2D<T, U>[src]

impl<T: Neg, U> Neg for Size2D<T, U>[src]

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

The resulting type after applying the - operator.

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

impl<T: Round, U> Round for Size2D<T, U>[src]

fn round(self) -> Self[src]

impl<T, U> Serialize for Size2D<T, U> where
    T: Serialize
[src]

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer
[src]

Serializes 2d size to tuple of width and height.

impl<T: Sub, U> Sub<Size2D<T, U>> for Point2D<T, U>[src]

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

The resulting type after applying the - operator.

impl<T: Sub, U> Sub<Size2D<T, U>> for Size2D<T, U>[src]

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

The resulting type after applying the - operator.

impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Point2D<T, U>[src]

impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Size2D<T, U>[src]

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

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

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

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[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]

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> 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> Zero for T where
    T: Zero
[src]