Size3D

zng_layout::unit::euclid

Struct Size3D 

#[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§

§

impl<T, U> Size3D<T, U>

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

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

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

Constructor taking scalar values.

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.

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

Constructor setting all components to the same value.

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

Tag a unitless value with units.

§

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

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

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

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

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

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

Return this size as a vector with width, height and depth.

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

Drop the units, preserving only the numeric value.

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

Cast the unit

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

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

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

pub fn volume(self) -> T
where T: Mul<Output = T>,

Returns result of multiplication of all components

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

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

impl<T, U> Size3D<T, U>
where T: NumCast + Copy,

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.

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.

pub fn to_f32(self) -> Size3D<f32, U>

Cast into an f32 size.

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

Cast into an f64 size.

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.

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.

pub fn to_i32(self) -> Size3D<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) -> Size3D<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, U> Size3D<T, U>
where T: Float,

pub fn is_finite(self) -> bool

Returns true if all members are finite.

§

impl<T, U> Size3D<T, U>
where T: Signed,

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.

pub fn is_positive(self) -> bool

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

§

impl<T, U> Size3D<T, U>
where T: PartialOrd,

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.

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.

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

pub fn greater_than(self, other: Size3D<T, U>) -> BoolVector3D

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

pub fn lower_than(self, other: Size3D<T, U>) -> BoolVector3D

Returns vector with results of “lower than” 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, U> Size3D<T, U>
where T: PartialEq,

pub fn equal(self, other: Size3D<T, U>) -> BoolVector3D

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

pub fn not_equal(self, other: Size3D<T, U>) -> BoolVector3D

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

Trait Implementations§

§

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

§

type Output = Size3D<T, U>

The resulting type after applying the + operator.
§

fn add(self, other: &Size3D<T, U>) -> Size3D<T, U>

Performs the + operation. Read more
§

impl<T, U> Add<Size3D<T, U>> for Point3D<T, U>
where T: Add,

§

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

The resulting type after applying the + operator.
§

fn add( self, other: Size3D<T, U>, ) -> <Point3D<T, U> as Add<Size3D<T, U>>>::Output

Performs the + operation. Read more
§

impl<T, U> Add for Size3D<T, U>
where T: Add,

§

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

The resulting type after applying the + operator.
§

fn add(self, other: Size3D<T, U>) -> <Size3D<T, U> as Add>::Output

Performs the + operation. Read more
§

impl<T, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
where T: AddAssign,

§

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

Performs the += operation. Read more
§

impl<T, U> AddAssign for Size3D<T, U>
where T: AddAssign,

§

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

Performs the += operation. Read more
§

impl<T, U> Ceil for Size3D<T, U>
where T: Ceil,

§

fn ceil(self) -> Size3D<T, U>

See Size3D::ceil.

§

impl<T, U> Clone for Size3D<T, U>
where T: Clone,

§

fn clone(&self) -> Size3D<T, U>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<T, U> Debug for Size3D<T, U>
where T: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<T, U> Default for Size3D<T, U>
where T: Default,

§

fn default() -> Size3D<T, U>

Returns the “default value” for a type. Read more
§

impl<'de, T, U> Deserialize<'de> for Size3D<T, U>
where T: Deserialize<'de>,

§

fn deserialize<D>( deserializer: D, ) -> Result<Size3D<T, U>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

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

§

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

The resulting type after applying the / operator.
§

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

Performs the / operation. Read more
§

impl<T, U> Div<T> for Size3D<T, U>
where T: Copy + Div,

§

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

The resulting type after applying the / operator.
§

fn div(self, scale: T) -> <Size3D<T, U> as Div<T>>::Output

Performs the / operation. Read more
§

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

§

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

Performs the /= operation. Read more
§

impl<T, U> DivAssign<T> for Size3D<T, U>
where T: Copy + DivAssign,

§

fn div_assign(&mut self, other: T)

Performs the /= operation. Read more
§

impl<T, U> Floor for Size3D<T, U>
where T: Floor,

§

fn floor(self) -> Size3D<T, U>

See Size3D::floor.

§

impl<T, U> From<[T; 3]> for Size3D<T, U>

§

fn from(_: [T; 3]) -> Size3D<T, U>

Converts to this type from the input type.
§

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

§

fn from(tuple: (T, T, T)) -> Size3D<T, U>

Converts to this type from the input type.
§

impl<T, U> From<Size3D<T, U>> for Box3D<T, U>
where T: Copy + Zero + PartialOrd,

§

fn from(b: Size3D<T, U>) -> Box3D<T, U>

Converts to this type from the input type.
§

impl<T, U> From<Vector3D<T, U>> for Size3D<T, U>

§

fn from(v: Vector3D<T, U>) -> Size3D<T, U>

Converts to this type from the input type.
§

impl<T, U> Hash for Size3D<T, U>
where T: Hash,

§

fn hash<H>(&self, h: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

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

§

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

The resulting type after applying the * operator.
§

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

Performs the * operation. Read more
§

impl<T, U> Mul<T> for Size3D<T, U>
where T: Copy + Mul,

§

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

The resulting type after applying the * operator.
§

fn mul(self, scale: T) -> <Size3D<T, U> as Mul<T>>::Output

Performs the * operation. Read more
§

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

§

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

Performs the *= operation. Read more
§

impl<T, U> MulAssign<T> for Size3D<T, U>
where T: Copy + MulAssign,

§

fn mul_assign(&mut self, other: T)

Performs the *= operation. Read more
§

impl<T, U> Neg for Size3D<T, U>
where T: Neg,

§

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

The resulting type after applying the - operator.
§

fn neg(self) -> <Size3D<T, U> as Neg>::Output

Performs the unary - operation. Read more
§

impl<T, U> PartialEq for Size3D<T, U>
where T: PartialEq,

§

fn eq(&self, other: &Size3D<T, U>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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, U> Round for Size3D<T, U>
where T: Round,

§

fn round(self) -> Size3D<T, U>

See Size3D::round.

§

impl<T, U> Serialize for Size3D<T, U>
where T: Serialize,

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl<T, U> Sub<Size3D<T, U>> for Point3D<T, U>
where T: Sub,

§

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

The resulting type after applying the - operator.
§

fn sub( self, other: Size3D<T, U>, ) -> <Point3D<T, U> as Sub<Size3D<T, U>>>::Output

Performs the - operation. Read more
§

impl<T, U> Sub for Size3D<T, U>
where T: Sub,

§

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

The resulting type after applying the - operator.
§

fn sub(self, other: Size3D<T, U>) -> <Size3D<T, U> as Sub>::Output

Performs the - operation. Read more
§

impl<T, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
where T: SubAssign,

§

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

Performs the -= operation. Read more
§

impl<T, U> SubAssign for Size3D<T, U>
where T: SubAssign,

§

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

Performs the -= operation. Read more
§

impl<'a, T, U> Sum<&'a Size3D<T, U>> for Size3D<T, U>
where T: 'a + Add<Output = T> + Copy + Zero, U: 'a,

§

fn sum<I>(iter: I) -> Size3D<T, U>
where I: Iterator<Item = &'a Size3D<T, U>>,

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

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

§

fn sum<I>(iter: I) -> Size3D<T, U>
where I: Iterator<Item = Size3D<T, U>>,

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

impl<T, U> Transitionable for Size3D<T, U>
where T: Transitionable, U: Send + Sync + Any,

Source§

fn lerp(self, to: &Size3D<T, U>, step: Factor) -> Size3D<T, U>

Sample the linear interpolation from self -> to by step.
§

impl<T, U> Zero for Size3D<T, U>
where T: Zero,

§

fn zero() -> Size3D<T, U>

§

impl<T, U> Zeroable for Size3D<T, U>
where T: Zeroable,

§

fn zeroed() -> Self

Calls zeroed. Read more
§

impl<T, U> Copy for Size3D<T, U>
where T: Copy,

§

impl<T, U> Eq for Size3D<T, U>
where T: Eq,

§

impl<T, U> Pod for Size3D<T, U>
where T: Pod, U: 'static,

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>
where T: Send, U: Send,

§

impl<T, U> Sync for Size3D<T, U>
where T: Sync, U: Sync,

§

impl<T, U> Unpin for Size3D<T, U>
where T: Unpin, U: Unpin,

§

impl<T, U> UnwindSafe for Size3D<T, U>
where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyVarValue for T
where T: Debug + PartialEq + Clone + Any + Send + Sync,

Source§

fn clone_boxed(&self) -> BoxAnyVarValue

Clone the value.
Source§

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self and other are equal.
Source§

fn try_swap(&mut self, other: &mut (dyn AnyVarValue + 'static)) -> bool

Swap value with other if both are of the same type.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> IntoVar<T> for T
where T: VarValue,

Source§

fn into_var(self) -> Var<T>

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> AnyBitPattern for T
where T: Pod,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> IntoValue<T> for T
where T: VarValue,

§

impl<T> NoUninit for T
where T: Pod,

Source§

impl<T> VarValue for T
where T: AnyVarValue + Clone + PartialEq,