#[repr(C)]pub struct Size3D<T, U> {
pub width: T,
pub height: T,
pub depth: T,
/* private fields */
}
Expand description
A 3d size tagged with a unit.
Fields§
§width: T
The extent of the element in the U
units along the x
axis.
height: T
The extent of the element in the U
units along the y
axis.
depth: T
The extent of the element in the U
units along the z
axis.
Implementations§
source§impl<T, U> Size3D<T, U>
impl<T, U> Size3D<T, U>
sourcepub fn zero() -> Size3D<T, U>where
T: Zero,
pub fn zero() -> Size3D<T, U>where
T: Zero,
The same as Zero::zero
but available without importing trait.
sourcepub const fn new(width: T, height: T, depth: T) -> Size3D<T, U>
pub const fn new(width: T, height: T, depth: T) -> Size3D<T, U>
Constructor taking scalar values.
sourcepub fn from_lengths(
width: Length<T, U>,
height: Length<T, U>,
depth: Length<T, U>,
) -> Size3D<T, U>
pub fn from_lengths( width: Length<T, U>, height: Length<T, U>, depth: Length<T, U>, ) -> Size3D<T, U>
Constructor taking scalar strongly typed lengths.
sourcepub fn splat(v: T) -> Size3D<T, U>where
T: Clone,
pub fn splat(v: T) -> Size3D<T, U>where
T: Clone,
Constructor setting all components to the same value.
sourcepub fn from_untyped(p: Size3D<T, UnknownUnit>) -> Size3D<T, U>
pub fn from_untyped(p: Size3D<T, UnknownUnit>) -> Size3D<T, U>
Tag a unitless value with units.
source§impl<T, U> Size3D<T, U>where
T: Copy,
impl<T, U> Size3D<T, U>where
T: Copy,
sourcepub fn to_array(self) -> [T; 3]
pub fn to_array(self) -> [T; 3]
Return this size as an array of three elements (width, then height, then depth).
sourcepub fn to_tuple(self) -> (T, T, T)
pub fn to_tuple(self) -> (T, T, T)
Return this size as an array of three elements (width, then height, then depth).
sourcepub fn to_vector(self) -> Vector3D<T, U>
pub fn to_vector(self) -> Vector3D<T, U>
Return this size as a vector with width, height and depth.
sourcepub fn to_untyped(self) -> Size3D<T, UnknownUnit>
pub fn to_untyped(self) -> Size3D<T, UnknownUnit>
Drop the units, preserving only the numeric value.
sourcepub fn round(self) -> Size3D<T, U>where
T: Round,
pub fn round(self) -> Size3D<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!(size3::<_, Mm>(-0.1, -0.8, 0.4).round(), size3::<_, Mm>(0.0, -1.0, 0.0))
sourcepub fn ceil(self) -> Size3D<T, U>where
T: Ceil,
pub fn ceil(self) -> Size3D<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!(size3::<_, Mm>(-0.1, -0.8, 0.4).ceil(), size3::<_, Mm>(0.0, 0.0, 1.0))
sourcepub fn floor(self) -> Size3D<T, U>where
T: Floor,
pub fn floor(self) -> Size3D<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!(size3::<_, Mm>(-0.1, -0.8, 0.4).floor(), size3::<_, Mm>(-1.0, -1.0, 0.0))
sourcepub fn volume(self) -> Twhere
T: Mul<Output = T>,
pub fn volume(self) -> Twhere
T: Mul<Output = T>,
Returns result of multiplication of all components
sourcepub fn lerp(self, other: Size3D<T, U>, t: T) -> Size3D<T, U>
pub fn lerp(self, other: Size3D<T, U>, t: T) -> Size3D<T, U>
Linearly interpolate between this size and another size.
§Example
use euclid::size3;
use euclid::default::Size3D;
let from: Size3D<_> = size3(0.0, 10.0, -1.0);
let to: Size3D<_> = size3(8.0, -4.0, 0.0);
assert_eq!(from.lerp(to, -1.0), size3(-8.0, 24.0, -2.0));
assert_eq!(from.lerp(to, 0.0), size3( 0.0, 10.0, -1.0));
assert_eq!(from.lerp(to, 0.5), size3( 4.0, 3.0, -0.5));
assert_eq!(from.lerp(to, 1.0), size3( 8.0, -4.0, 0.0));
assert_eq!(from.lerp(to, 2.0), size3(16.0, -18.0, 1.0));
source§impl<T, U> Size3D<T, U>
impl<T, U> Size3D<T, U>
sourcepub fn cast<NewT>(self) -> Size3D<NewT, U>where
NewT: NumCast,
pub fn cast<NewT>(self) -> Size3D<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.
sourcepub fn try_cast<NewT>(self) -> Option<Size3D<NewT, U>>where
NewT: NumCast,
pub fn try_cast<NewT>(self) -> Option<Size3D<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.
sourcepub fn to_usize(self) -> Size3D<usize, U>
pub fn to_usize(self) -> Size3D<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) -> Size3D<u32, U>
pub fn to_u32(self) -> Size3D<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.
source§impl<T, U> Size3D<T, U>where
T: Signed,
impl<T, U> Size3D<T, U>where
T: Signed,
sourcepub fn abs(self) -> Size3D<T, U>
pub fn abs(self) -> Size3D<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
.
sourcepub fn is_positive(self) -> bool
pub fn is_positive(self) -> bool
Returns true
if all components is positive and false
any component is zero or negative.
source§impl<T, U> Size3D<T, U>where
T: PartialOrd,
impl<T, U> Size3D<T, U>where
T: PartialOrd,
sourcepub fn min(self, other: Size3D<T, U>) -> Size3D<T, U>
pub fn min(self, other: Size3D<T, U>) -> Size3D<T, U>
Returns the size each component of which are minimum of this size and another.
sourcepub fn max(self, other: Size3D<T, U>) -> Size3D<T, U>
pub fn max(self, other: Size3D<T, U>) -> Size3D<T, U>
Returns the size each component of which are maximum of this size and another.
sourcepub fn clamp(self, start: Size3D<T, U>, end: Size3D<T, U>) -> Size3D<T, U>where
T: Copy,
pub fn clamp(self, start: Size3D<T, U>, end: Size3D<T, U>) -> Size3D<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: Size3D<T, U>) -> bool
sourcepub fn greater_than(self, other: Size3D<T, U>) -> BoolVector3D
pub fn greater_than(self, other: Size3D<T, U>) -> BoolVector3D
Returns vector with results of “greater than” operation on each component.
sourcepub fn lower_than(self, other: Size3D<T, U>) -> BoolVector3D
pub fn lower_than(self, other: Size3D<T, U>) -> BoolVector3D
Returns vector with results of “lower than” operation on each component.
source§impl<T, U> Size3D<T, U>where
T: PartialEq,
impl<T, U> Size3D<T, U>where
T: PartialEq,
sourcepub fn equal(self, other: Size3D<T, U>) -> BoolVector3D
pub fn equal(self, other: Size3D<T, U>) -> BoolVector3D
Returns vector with results of “equal” operation on each component.
sourcepub fn not_equal(self, other: Size3D<T, U>) -> BoolVector3D
pub fn not_equal(self, other: Size3D<T, U>) -> BoolVector3D
Returns vector with results of “not equal” operation on each component.
Trait Implementations§
source§impl<T, U> AddAssign<Size3D<T, U>> for Point3D<T, U>where
T: AddAssign,
impl<T, U> AddAssign<Size3D<T, U>> for Point3D<T, U>where
T: AddAssign,
source§fn add_assign(&mut self, other: Size3D<T, U>)
fn add_assign(&mut self, other: Size3D<T, U>)
+=
operation. Read moresource§impl<T, U> AddAssign for Size3D<T, U>where
T: AddAssign,
impl<T, U> AddAssign for Size3D<T, U>where
T: AddAssign,
source§fn add_assign(&mut self, other: Size3D<T, U>)
fn add_assign(&mut self, other: Size3D<T, U>)
+=
operation. Read moresource§impl<T, U> Ceil for Size3D<T, U>where
T: Ceil,
impl<T, U> Ceil for Size3D<T, U>where
T: Ceil,
source§fn ceil(self) -> Size3D<T, U>
fn ceil(self) -> Size3D<T, U>
See Size3D::ceil
.
source§impl<T, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>
impl<T, U> DivAssign<Scale<T, U, U>> for Size3D<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, U> DivAssign<T> for Size3D<T, U>
impl<T, U> DivAssign<T> for Size3D<T, U>
source§fn div_assign(&mut self, other: T)
fn div_assign(&mut self, other: T)
/=
operation. Read moresource§impl<T, U> Floor for Size3D<T, U>where
T: Floor,
impl<T, U> Floor for Size3D<T, U>where
T: Floor,
source§fn floor(self) -> Size3D<T, U>
fn floor(self) -> Size3D<T, U>
See Size3D::floor
.
source§impl<T, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>
impl<T, U> MulAssign<Scale<T, U, U>> for Size3D<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, U> MulAssign<T> for Size3D<T, U>
impl<T, U> MulAssign<T> for Size3D<T, U>
source§fn mul_assign(&mut self, other: T)
fn mul_assign(&mut self, other: T)
*=
operation. Read moresource§impl<T, U> Round for Size3D<T, U>where
T: Round,
impl<T, U> Round for Size3D<T, U>where
T: Round,
source§fn round(self) -> Size3D<T, U>
fn round(self) -> Size3D<T, U>
See Size3D::round
.
source§impl<T, U> SubAssign<Size3D<T, U>> for Point3D<T, U>where
T: SubAssign,
impl<T, U> SubAssign<Size3D<T, U>> for Point3D<T, U>where
T: SubAssign,
source§fn sub_assign(&mut self, other: Size3D<T, U>)
fn sub_assign(&mut self, other: Size3D<T, U>)
-=
operation. Read moresource§impl<T, U> SubAssign for Size3D<T, U>where
T: SubAssign,
impl<T, U> SubAssign for Size3D<T, U>where
T: SubAssign,
source§fn sub_assign(&mut self, other: Size3D<T, U>)
fn sub_assign(&mut self, other: Size3D<T, U>)
-=
operation. Read moreimpl<T, U> Copy for Size3D<T, U>where
T: Copy,
impl<T, U> Eq for Size3D<T, U>where
T: Eq,
Auto Trait Implementations§
impl<T, U> Freeze for Size3D<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Size3D<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Size3D<T, U>
impl<T, U> Sync for Size3D<T, U>
impl<T, U> Unpin for Size3D<T, U>
impl<T, U> UnwindSafe for Size3D<T, U>where
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.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
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more