Struct euclid::Size2D

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

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

where T: Zero,

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

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

Constructor taking scalar values.

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

Constructor taking scalar strongly typed lengths.

pub fn splat(v: T) -> Self

where T: Clone,

Constructor setting all components to the same value.

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

Tag a unitless value with units.

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

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

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

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

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::Output

where T: Mul,

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

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>

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

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

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.

pub fn to_f64(self) -> Size2D<f64, U>

Cast into an f64 size.

pub fn to_usize(self) -> Size2D<usize, U>

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>

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>

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>

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>

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: Float, U> Size2D<T, U>

pub fn is_finite(self) -> bool

Returns true if all members are finite.

impl<T: Signed, U> Size2D<T, U>

pub fn abs(self) -> Self

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

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

impl<T: PartialOrd, U> Size2D<T, U>

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

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

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

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,

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

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

pub fn contains(self, other: Self) -> bool

pub fn greater_than(self, other: Self) -> BoolVector2D

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

pub fn lower_than(self, other: Self) -> BoolVector2D

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

pub fn is_empty(self) -> bool

where T: Zero,

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

impl<T: PartialEq, U> Size2D<T, U>

pub fn equal(self, other: Self) -> BoolVector2D

Returns vector with results of “equal” operation on each component.

pub fn not_equal(self, other: Self) -> BoolVector2D

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

Trait Implementations

impl<T: Copy + Add<T, Output = T>, U> Add<&Size2D<T, U>> for Size2D<T, U>

type Output = Size2D<T, U>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add, U> Add<Size2D<T, U>> for Point2D<T, U>

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

The resulting type after applying the + operator.

fn add(self, other: Size2D<T, U>) -> Self::Output

Performs the + operation.

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

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

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Point2D<T, U>

fn add_assign(&mut self, other: Size2D<T, U>)

Performs the += operation.

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

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Ceil, U> Ceil for Size2D<T, U>

fn ceil(self) -> Self

See Size2D::ceil.

impl<T: Clone, U> Clone for Size2D<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 Size2D<T, U>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + Div, U1, U2> Div<Scale<T, U1, U2>> for Size2D<T, U2>

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

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the / operation.

impl<T: Copy + Div, U> Div<T> for Size2D<T, U>

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

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>

fn div_assign(&mut self, other: Scale<T, U, U>)

Performs the /= operation.

impl<T: Copy + DivAssign, U> DivAssign<T> for Size2D<T, U>

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T: Floor, U> Floor for Size2D<T, U>

fn floor(self) -> Self

See Size2D::floor.

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

fn from([w, h]: [T; 2]) -> Self

Converts to this type from the input type.

impl<T, U> From<(T, T)> for Size2D<T, U>

fn from(tuple: (T, T)) -> Self

Converts to this type from the input type.

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

fn from(s: Size2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size2D<T, U>> for (T, T)

fn from(s: Size2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size2D<T, U>> for Box2D<T, U>

where T: Copy + Zero + PartialOrd,

fn from(b: Size2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size2D<T, U>> for Rect<T, U>

where T: Zero,

fn from(size: Size2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> From<Size2D<T, U>> for Vector2D<T, U>

fn from(s: Size2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> From<Vector2D<T, U>> for Size2D<T, U>

fn from(v: Vector2D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> Hash for Size2D<T, U>

where T: Hash,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Copy + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Size2D<T, U1>

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

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the * operation.

impl<T: Copy + Mul, U> Mul<T> for Size2D<T, U>

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>

fn mul_assign(&mut self, other: Scale<T, U, U>)

Performs the *= operation.

impl<T: Copy + MulAssign, U> MulAssign<T> for Size2D<T, U>

fn mul_assign(&mut self, other: T)

Performs the *= operation.

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

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

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T, U> PartialEq for Size2D<T, U>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Round, U> Round for Size2D<T, U>

fn round(self) -> Self

See Size2D::round.

impl<T: Sub, U> Sub<Size2D<T, U>> for Point2D<T, U>

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

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Point2D<T, U>

fn sub_assign(&mut self, other: Size2D<T, U>)

Performs the -= operation.

impl<T: SubAssign, U> SubAssign for Size2D<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 Size2D<T, U>> for Size2D<T, U>

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

Takes an iterator and generates Self from the elements by “summing up” the items.

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

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

Takes an iterator and generates Self from the elements by “summing up” the items.

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

fn zero() -> Self

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

impl<T, U> Eq for Size2D<T, U>

where T: Eq,