Struct Size2D

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

Expand description

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>

pub fn zero() -> Size2D<T, U>
where T: Zero,

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

pub const fn new(width: T, height: T) -> Size2D<T, U>

Constructor taking scalar values.

pub fn from_lengths(width: Length<T, U>, height: Length<T, U>) -> Size2D<T, U>

Constructor taking scalar strongly typed lengths.

pub fn splat(v: T) -> Size2D<T, U>
where T: Clone,

Constructor setting all components to the same value.

pub fn from_untyped(p: Size2D<T, UnknownUnit>) -> Size2D<T, U>

Tag a unitless value with units.

§

impl<T, U> Size2D<T, U>
where T: Copy,

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

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

pub fn to_tuple(self) -> (T, T)

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

pub fn to_vector(self) -> Vector2D<T, U>

Return this size as a vector with width and height.

pub fn to_untyped(self) -> Size2D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

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

Cast the unit

pub fn round(self) -> Size2D<T, U>
where T: Round,

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))

pub fn ceil(self) -> Size2D<T, U>
where T: Ceil,

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))

pub fn floor(self) -> Size2D<T, U>
where T: Floor,

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 as Mul>::Output
where T: Mul,

Returns result of multiplication of both components

pub fn lerp(self, other: Size2D<T, U>, t: T) -> Size2D<T, U>
where T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,

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, U> Size2D<T, U>
where T: NumCast + Copy,

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

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>(self) -> Option<Size2D<NewT, U>>
where NewT: NumCast,

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>

Cast into an f32 size.