pub type Size2D = Size2D<f32, Measure>;
Aliased Type§
struct Size2D {
pub width: f32,
pub height: f32,
}
Fields§
§width: f32
The extent of the element in the U
units along the x
axis (usually horizontal).
height: f32
The extent of the element in the U
units along the y
axis (usually vertical).
Implementations
§impl<T, U> Size2D<T, U>
impl<T, U> Size2D<T, U>
pub fn zero() -> Size2D<T, U>where
T: Zero,
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>
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>
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,
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>
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: PartialOrd,
impl<T, U> Size2D<T, U>where
T: PartialOrd,
pub fn min(self, other: Size2D<T, U>) -> Size2D<T, U>
pub fn min(self, other: Size2D<T, U>) -> Size2D<T, U>
Returns the size each component of which are minimum of this size and another.
pub fn max(self, other: Size2D<T, U>) -> Size2D<T, U>
pub fn max(self, other: Size2D<T, U>) -> Size2D<T, U>
Returns the size each component of which are maximum of this size and another.
pub fn clamp(self, start: Size2D<T, U>, end: Size2D<T, U>) -> Size2D<T, U>where
T: Copy,
pub fn clamp(self, start: Size2D<T, U>, end: Size2D<T, U>) -> Size2D<T, U>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: Size2D<T, U>) -> bool
pub fn greater_than(self, other: Size2D<T, U>) -> BoolVector2D
pub fn greater_than(self, other: Size2D<T, U>) -> BoolVector2D
Returns vector with results of “greater then” operation on each component.
pub fn lower_than(self, other: Size2D<T, U>) -> BoolVector2D
pub fn lower_than(self, other: Size2D<T, U>) -> BoolVector2D
Returns vector with results of “lower then” operation on each component.
§impl<T, U> Size2D<T, U>where
T: Copy,
impl<T, U> Size2D<T, U>where
T: Copy,
pub fn to_vector(self) -> Vector2D<T, U>
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>
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>
pub fn cast_unit<V>(self) -> Size2D<T, V>
Cast the unit
pub fn round(self) -> Size2D<T, U>where
T: Round,
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,
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,
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>::Outputwhere
T: Mul,
pub fn area(self) -> <T as Mul>::Outputwhere
T: Mul,
Returns result of multiplication of both components
pub fn lerp(self, other: Size2D<T, U>, t: T) -> Size2D<T, U>
pub fn lerp(self, other: Size2D<T, U>, t: T) -> Size2D<T, U>
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>
impl<T, U> Size2D<T, U>
pub fn cast<NewT>(self) -> Size2D<NewT, U>where
NewT: NumCast,
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,
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_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.
pub 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.
pub 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.
§impl<T, U> Size2D<T, U>where
T: Signed,
impl<T, U> Size2D<T, U>where
T: Signed,
pub fn abs(self) -> Size2D<T, U>
pub fn abs(self) -> Size2D<T, U>
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
pub fn is_positive(self) -> bool
Returns true
if both components is positive and false
any component is zero or negative.
Trait Implementations§
§impl<T, U> AddAssign for Size2D<T, U>where
T: AddAssign,
impl<T, U> AddAssign for Size2D<T, U>where
T: AddAssign,
§fn add_assign(&mut self, other: Size2D<T, U>)
fn add_assign(&mut self, other: Size2D<T, U>)
+=
operation. Read more§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>,
§fn deserialize<D>(
deserializer: D,
) -> Result<Size2D<T, U>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<Size2D<T, U>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
Deserializes 2d size from tuple of width and height.
§impl<T, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
§fn div_assign(&mut self, other: Scale<T, U, U>)
fn div_assign(&mut self, other: Scale<T, U, U>)
/=
operation. Read more§impl<T, U> DivAssign<T> for Size2D<T, U>
impl<T, U> DivAssign<T> for Size2D<T, U>
§fn div_assign(&mut self, other: T)
fn div_assign(&mut self, other: T)
/=
operation. Read more§impl<T, U> Floor for Size2D<T, U>where
T: Floor,
impl<T, U> Floor for Size2D<T, U>where
T: Floor,
§impl<T, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
§fn mul_assign(&mut self, other: Scale<T, U, U>)
fn mul_assign(&mut self, other: Scale<T, U, U>)
*=
operation. Read more§impl<T, U> MulAssign<T> for Size2D<T, U>
impl<T, U> MulAssign<T> for Size2D<T, U>
§fn mul_assign(&mut self, other: T)
fn mul_assign(&mut self, other: T)
*=
operation. Read more§impl<T, U> PartialEq for Size2D<T, U>where
T: PartialEq,
impl<T, U> PartialEq for Size2D<T, U>where
T: PartialEq,
§impl<T, U> Round for Size2D<T, U>where
T: Round,
impl<T, U> Round for Size2D<T, U>where
T: Round,
§impl<T, U> Serialize for Size2D<T, U>where
T: Serialize,
impl<T, U> Serialize for Size2D<T, U>where
T: Serialize,
§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
Serializes 2d size to tuple of width and height.
§impl<T, U> SubAssign for Size2D<T, U>where
T: SubAssign,
impl<T, U> SubAssign for Size2D<T, U>where
T: SubAssign,
§fn sub_assign(&mut self, other: Size2D<T, U>)
fn sub_assign(&mut self, other: Size2D<T, U>)
-=
operation. Read more