[−][src]Struct euclid::Size3D
A 3d size tagged with a unit.
Fields
width: TThe extent of the element in the U units along the x axis.
height: TThe extent of the element in the U units along the y axis.
depth: TThe extent of the element in the U units along the z axis.
Methods
impl<T, U> Size3D<T, U>[src]
pub fn zero() -> Self where
T: Zero, [src]
T: Zero,
The same as Zero::zero() but available without importing trait.
pub const fn new(width: T, height: T, depth: T) -> Self[src]
Constructor taking scalar values.
pub fn from_lengths(
width: Length<T, U>,
height: Length<T, U>,
depth: Length<T, U>
) -> Self[src]
width: Length<T, U>,
height: Length<T, U>,
depth: Length<T, U>
) -> Self
Constructor taking scalar strongly typed lengths.
pub fn from_untyped(p: Size3D<T, UnknownUnit>) -> Self[src]
Tag a unitless value with units.
impl<T: Copy, U> Size3D<T, U>[src]
pub fn to_array(&self) -> [T; 3][src]
Return this size as an array of three elements (width, then height, then depth).
pub fn to_tuple(&self) -> (T, T, T)[src]
Return this size as an array of three elements (width, then height, then depth).
pub fn to_vector(&self) -> Vector3D<T, U>[src]
Return this size as a vector with width, height and depth.
pub fn to_untyped(&self) -> Size3D<T, UnknownUnit>[src]
Drop the units, preserving only the numeric value.
pub fn cast_unit<V>(&self) -> Size3D<T, V>[src]
Cast the unit
#[must_use]pub fn round(&self) -> Self where
T: Round, [src]
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))
#[must_use]pub fn ceil(&self) -> Self where
T: Ceil, [src]
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))
#[must_use]pub fn floor(&self) -> Self where
T: Floor, [src]
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>, [src]
T: Mul<Output = T>,
Returns result of multiplication of all components
pub fn lerp(&self, other: Self, t: T) -> Self where
T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>, [src]
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: NumCast + Copy, U> Size3D<T, U>[src]
pub fn cast<NewT: NumCast>(&self) -> Size3D<NewT, U>[src]
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<Size3D<NewT, U>>[src]
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>[src]
Cast into an f32 size.
pub fn to_f64(&self) -> Size3D<f64, U>[src]
Cast into an f64 size.
pub fn to_usize(&self) -> Size3D<usize, U>[src]
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>[src]
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>[src]
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>[src]
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: Signed, U> Size3D<T, U>[src]
pub fn abs(&self) -> Self[src]
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[src]
Returns true if all components is positive and false any component is zero or negative.
impl<T: PartialOrd, U> Size3D<T, U>[src]
pub fn min(self, other: Self) -> Self[src]
Returns the size each component of which are minimum of this size and another.
pub fn max(self, other: Self) -> Self[src]
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, [src]
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 greater_than(&self, other: Self) -> BoolVector3D[src]
Returns vector with results of "greater than" operation on each component.
pub fn lower_than(&self, other: Self) -> BoolVector3D[src]
Returns vector with results of "lower than" operation on each component.
pub fn is_empty_or_negative(&self) -> bool where
T: Zero, [src]
T: Zero,
Returns true if any component of size is zero or negative.
impl<T: PartialEq, U> Size3D<T, U>[src]
pub fn equal(&self, other: Self) -> BoolVector3D[src]
Returns vector with results of "equal" operation on each component.
pub fn not_equal(&self, other: Self) -> BoolVector3D[src]
Returns vector with results of "not equal" operation on each component.
Trait Implementations
impl<T: Add, U> Add<Size3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the + operator.
fn add(self, other: Size3D<T, U>) -> Self::Output[src]
impl<T: Add, U> Add<Size3D<T, U>> for Size3D<T, U>[src]
type Output = Size3D<T::Output, U>
The resulting type after applying the + operator.
fn add(self, other: Self) -> Self::Output[src]
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>[src]
fn add_assign(&mut self, other: Size3D<T, U>)[src]
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Size3D<T, U>[src]
fn add_assign(&mut self, other: Self)[src]
impl<T: Ceil, U> Ceil for Size3D<T, U>[src]
fn ceil(self) -> Self[src]
See Size3D::ceil().
impl<T: Clone, U> Clone for Size3D<T, U>[src]
fn clone(&self) -> Self[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<T: Copy, U> Copy for Size3D<T, U>[src]
impl<T: Debug, U> Debug for Size3D<T, U>[src]
impl<T: Default, U> Default for Size3D<T, U>[src]
impl<T: Display, U> Display for Size3D<T, U>[src]
impl<T: Clone + Div, U1, U2> Div<Scale<T, U1, U2>> for Size3D<T, U2>[src]
type Output = Size3D<T::Output, U1>
The resulting type after applying the / operator.
fn div(self, scale: Scale<T, U1, U2>) -> Self::Output[src]
impl<T: Clone + Div, U> Div<T> for Size3D<T, U>[src]
type Output = Size3D<T::Output, U>
The resulting type after applying the / operator.
fn div(self, scale: T) -> Self::Output[src]
impl<T: Clone + DivAssign, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>[src]
fn div_assign(&mut self, other: Scale<T, U, U>)[src]
impl<T: Clone + DivAssign, U> DivAssign<T> for Size3D<T, U>[src]
fn div_assign(&mut self, other: T)[src]
impl<T, U> Eq for Size3D<T, U> where
T: Eq, [src]
T: Eq,
impl<T: Floor, U> Floor for Size3D<T, U>[src]
fn floor(self) -> Self[src]
See Size3D::floor().
impl<T, U> From<[T; 3]> for Size3D<T, U>[src]
impl<T, U> From<(T, T, T)> for Size3D<T, U>[src]
impl<T, U> From<Size3D<T, U>> for Box3D<T, U> where
T: Copy + Zero + PartialOrd, [src]
T: Copy + Zero + PartialOrd,
impl<T, U> From<Vector3D<T, U>> for Size3D<T, U>[src]
impl<T, U> Hash for Size3D<T, U> where
T: Hash, [src]
T: Hash,
fn hash<H: Hasher>(&self, h: &mut H)[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
impl<T, U> Into<[T; 3]> for Size3D<T, U>[src]
impl<T, U> Into<(T, T, T)> for Size3D<T, U>[src]
impl<T: Clone + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Size3D<T, U1>[src]
type Output = Size3D<T::Output, U2>
The resulting type after applying the * operator.
fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output[src]
impl<T: Clone + Mul, U> Mul<T> for Size3D<T, U>[src]
type Output = Size3D<T::Output, U>
The resulting type after applying the * operator.
fn mul(self, scale: T) -> Self::Output[src]
impl<T: Clone + MulAssign, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>[src]
fn mul_assign(&mut self, other: Scale<T, U, U>)[src]
impl<T: Clone + MulAssign, U> MulAssign<T> for Size3D<T, U>[src]
fn mul_assign(&mut self, other: T)[src]
impl<T: Neg, U> Neg for Size3D<T, U>[src]
type Output = Size3D<T::Output, U>
The resulting type after applying the - operator.
fn neg(self) -> Self::Output[src]
impl<T, U> PartialEq<Size3D<T, U>> for Size3D<T, U> where
T: PartialEq, [src]
T: PartialEq,
impl<T: Round, U> Round for Size3D<T, U>[src]
fn round(self) -> Self[src]
See Size3D::round().
impl<T: Sub, U> Sub<Size3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the - operator.
fn sub(self, other: Size3D<T, U>) -> Self::Output[src]
impl<T: Sub, U> Sub<Size3D<T, U>> for Size3D<T, U>[src]
type Output = Size3D<T::Output, U>
The resulting type after applying the - operator.
fn sub(self, other: Self) -> Self::Output[src]
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>[src]
fn sub_assign(&mut self, other: Size3D<T, U>)[src]
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Size3D<T, U>[src]
fn sub_assign(&mut self, other: Self)[src]
impl<T: Zero, U> Zero for Size3D<T, U>[src]
Auto Trait Implementations
impl<T, U> RefUnwindSafe for Size3D<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Size3D<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for Size3D<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> Unpin for Size3D<T, U> where
T: Unpin,
U: Unpin,
T: Unpin,
U: Unpin,
impl<T, U> UnwindSafe for Size3D<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Zero for T where
T: Zero, [src]
T: Zero,