#[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§
Source§impl<T, U> Size2D<T, U>
impl<T, U> Size2D<T, U>
Sourcepub fn zero() -> Selfwhere
T: Zero,
pub fn zero() -> Selfwhere
T: Zero,
The same as Zero::zero()
but available without importing trait.
Sourcepub fn from_lengths(width: Length<T, U>, height: Length<T, U>) -> Self
pub fn from_lengths(width: Length<T, U>, height: Length<T, U>) -> Self
Constructor taking scalar strongly typed lengths.
Sourcepub fn from_untyped(p: Size2D<T, UnknownUnit>) -> Self
pub fn from_untyped(p: Size2D<T, UnknownUnit>) -> Self
Tag a unitless value with units.
Source§impl<T: Copy, U> Size2D<T, U>
impl<T: Copy, U> Size2D<T, U>
Sourcepub fn to_array(self) -> [T; 2]
pub fn to_array(self) -> [T; 2]
Return this size as an array of two elements (width, then height).
Sourcepub fn to_tuple(self) -> (T, T)
pub fn to_tuple(self) -> (T, T)
Return this size as a tuple of two elements (width, then height).
Sourcepub fn to_untyped(self) -> Size2D<T, UnknownUnit>
pub fn to_untyped(self) -> Size2D<T, UnknownUnit>
Drop the units, preserving only the numeric value.
Sourcepub fn round(self) -> Selfwhere
T: Round,
pub fn round(self) -> Selfwhere
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))
Sourcepub fn ceil(self) -> Selfwhere
T: Ceil,
pub fn ceil(self) -> Selfwhere
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))
Sourcepub fn floor(self) -> Selfwhere
T: Floor,
pub fn floor(self) -> Selfwhere
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))
Sourcepub fn area(self) -> T::Outputwhere
T: Mul,
pub fn area(self) -> T::Outputwhere
T: Mul,
Returns result of multiplication of both components
Sourcepub fn lerp(self, other: Self, t: T) -> Self
pub fn lerp(self, other: Self, t: T) -> Self
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));
Source§impl<T: NumCast + Copy, U> Size2D<T, U>
impl<T: NumCast + Copy, U> Size2D<T, U>
Sourcepub fn cast<NewT: NumCast>(self) -> Size2D<NewT, 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.
Sourcepub fn try_cast<NewT: NumCast>(self) -> Option<Size2D<NewT, U>>
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.
Sourcepub fn to_usize(self) -> Size2D<usize, U>
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.
Sourcepub fn to_u32(self) -> Size2D<u32, U>
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.
Sourcepub fn to_u64(self) -> Size2D<u64, U>
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.
Source§impl<T: Signed, U> Size2D<T, U>
impl<T: Signed, U> Size2D<T, U>
Sourcepub fn abs(self) -> Self
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
.
Sourcepub fn is_positive(self) -> bool
pub fn is_positive(self) -> bool
Returns true
if both components is positive and false
any component is zero or negative.
Source§impl<T: PartialOrd, U> Size2D<T, U>
impl<T: PartialOrd, U> Size2D<T, U>
Sourcepub fn min(self, other: Self) -> Self
pub fn min(self, other: Self) -> Self
Returns the size each component of which are minimum of this size and another.
Sourcepub fn max(self, other: Self) -> Self
pub fn max(self, other: Self) -> Self
Returns the size each component of which are maximum of this size and another.
Sourcepub fn clamp(self, start: Self, end: Self) -> Selfwhere
T: Copy,
pub fn clamp(self, start: Self, end: Self) -> Selfwhere
T: Copy,
Returns the size each component of which clamped by corresponding
components of start
and end
.
Shortcut for self.max(start).min(end)
.
Sourcepub fn greater_than(self, other: Self) -> BoolVector2D
pub fn greater_than(self, other: Self) -> BoolVector2D
Returns vector with results of “greater then” operation on each component.
Sourcepub fn lower_than(self, other: Self) -> BoolVector2D
pub fn lower_than(self, other: Self) -> BoolVector2D
Returns vector with results of “lower then” operation on each component.
Source§impl<T: PartialEq, U> Size2D<T, U>
impl<T: PartialEq, U> Size2D<T, U>
Sourcepub fn equal(self, other: Self) -> BoolVector2D
pub fn equal(self, other: Self) -> BoolVector2D
Returns vector with results of “equal” operation on each component.
Sourcepub fn not_equal(self, other: Self) -> BoolVector2D
pub fn not_equal(self, other: Self) -> BoolVector2D
Returns vector with results of “not equal” operation on each component.
Trait Implementations§
Source§impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Point2D<T, U>
impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Point2D<T, U>
Source§fn add_assign(&mut self, other: Size2D<T, U>)
fn add_assign(&mut self, other: Size2D<T, U>)
+=
operation. Read moreSource§impl<T: AddAssign, U> AddAssign for Size2D<T, U>
impl<T: AddAssign, U> AddAssign for Size2D<T, U>
Source§fn add_assign(&mut self, other: Self)
fn add_assign(&mut self, other: Self)
+=
operation. Read moreSource§impl<'de, T, U> Deserialize<'de> for Size2D<T, U>where
T: Deserialize<'de>,
impl<'de, T, U> Deserialize<'de> for Size2D<T, U>where
T: Deserialize<'de>,
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Deserializes 2d size from tuple of width and height.
Source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
Source§fn div_assign(&mut self, other: Scale<T, U, U>)
fn div_assign(&mut self, other: Scale<T, U, U>)
/=
operation. Read moreSource§impl<T: Copy + DivAssign, U> DivAssign<T> for Size2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<T> for Size2D<T, U>
Source§fn div_assign(&mut self, other: T)
fn div_assign(&mut self, other: T)
/=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
Source§fn mul_assign(&mut self, other: Scale<T, U, U>)
fn mul_assign(&mut self, other: Scale<T, U, U>)
*=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<T> for Size2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<T> for Size2D<T, U>
Source§fn mul_assign(&mut self, other: T)
fn mul_assign(&mut self, other: T)
*=
operation. Read moreSource§impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Point2D<T, U>
impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Point2D<T, U>
Source§fn sub_assign(&mut self, other: Size2D<T, U>)
fn sub_assign(&mut self, other: Size2D<T, U>)
-=
operation. Read moreSource§impl<T: SubAssign, U> SubAssign for Size2D<T, U>
impl<T: SubAssign, U> SubAssign for Size2D<T, U>
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
-=
operation. Read moreimpl<T: Copy, U> Copy for Size2D<T, U>
impl<T, U> Eq for Size2D<T, U>where
T: Eq,
Auto Trait Implementations§
impl<T, U> Freeze for Size2D<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Size2D<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Size2D<T, U>
impl<T, U> Sync for Size2D<T, U>
impl<T, U> Unpin for Size2D<T, U>
impl<T, U> UnwindSafe for Size2D<T, U>where
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)