Struct euclid::Size3D [−][src]
#[repr(C)]pub struct Size3D<T, U> { pub width: T, pub height: T, pub depth: T, // some fields omitted }
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>
[src]
impl<T, U> Size3D<T, U>
[src]pub fn zero() -> Self where
T: Zero,
[src]
pub fn zero() -> Self where
T: Zero,
[src]The same as Zero::zero()
but available without importing trait.
pub fn from_lengths(
width: Length<T, U>,
height: Length<T, U>,
depth: Length<T, U>
) -> Self
[src]
pub fn from_lengths(
width: Length<T, U>,
height: Length<T, U>,
depth: Length<T, U>
) -> Self
[src]Constructor taking scalar strongly typed lengths.
pub fn splat(v: T) -> Self where
T: Clone,
[src]
pub fn splat(v: T) -> Self where
T: Clone,
[src]Constructor setting all components to the same value.
pub fn from_untyped(p: Size3D<T, UnknownUnit>) -> Self
[src]
pub fn from_untyped(p: Size3D<T, UnknownUnit>) -> Self
[src]Tag a unitless value with units.
impl<T: Copy, U> Size3D<T, U>
[src]
impl<T: Copy, U> Size3D<T, U>
[src]pub fn to_array(self) -> [T; 3]
[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]
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]
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]
pub fn to_untyped(self) -> Size3D<T, UnknownUnit>
[src]Drop the units, preserving only the numeric value.
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]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]
#[must_use]pub fn ceil(self) -> Self where
T: Ceil,
[src]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]
#[must_use]pub fn floor(self) -> Self where
T: Floor,
[src]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]
pub fn volume(self) -> T where
T: Mul<Output = T>,
[src]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]
pub fn lerp(self, other: Self, t: T) -> Self where
T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,
[src]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]
impl<T: NumCast + Copy, U> Size3D<T, U>
[src]pub fn cast<NewT: NumCast>(self) -> Size3D<NewT, 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]
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_usize(self) -> Size3D<usize, U>
[src]
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]
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.
impl<T: Signed, U> Size3D<T, U>
[src]
impl<T: Signed, U> Size3D<T, U>
[src]pub fn abs(self) -> Self
[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]
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]
impl<T: PartialOrd, U> Size3D<T, U>
[src]pub fn min(self, other: Self) -> Self
[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]
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]
pub fn clamp(self, start: Self, end: Self) -> Self where
T: Copy,
[src]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: Self) -> bool
[src]
pub fn greater_than(self, other: Self) -> BoolVector3D
[src]
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]
pub fn lower_than(self, other: Self) -> BoolVector3D
[src]Returns vector with results of “lower than” operation on each component.
impl<T: PartialEq, U> Size3D<T, U>
[src]
impl<T: PartialEq, U> Size3D<T, U>
[src]pub fn equal(self, other: Self) -> BoolVector3D
[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]
pub fn not_equal(self, other: Self) -> BoolVector3D
[src]Returns vector with results of “not equal” operation on each component.
Trait Implementations
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
[src]
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
[src]fn add_assign(&mut self, other: Size3D<T, U>)
[src]
fn add_assign(&mut self, other: Size3D<T, U>)
[src]Performs the +=
operation. Read more
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for 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]
fn add_assign(&mut self, other: Self)
[src]Performs the +=
operation. Read more
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>
[src]fn div_assign(&mut self, other: Scale<T, U, U>)
[src]
fn div_assign(&mut self, other: Scale<T, U, U>)
[src]Performs the /=
operation. Read more
impl<T: Copy + DivAssign, U> DivAssign<T> for Size3D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<T> for Size3D<T, U>
[src]fn div_assign(&mut self, other: T)
[src]
fn div_assign(&mut self, other: T)
[src]Performs the /=
operation. Read more
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>
[src]fn mul_assign(&mut self, other: Scale<T, U, U>)
[src]
fn mul_assign(&mut self, other: Scale<T, U, U>)
[src]Performs the *=
operation. Read more
impl<T: Copy + MulAssign, U> MulAssign<T> for Size3D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<T> for Size3D<T, U>
[src]fn mul_assign(&mut self, other: T)
[src]
fn mul_assign(&mut self, other: T)
[src]Performs the *=
operation. Read more
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
[src]
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
[src]fn sub_assign(&mut self, other: Size3D<T, U>)
[src]
fn sub_assign(&mut self, other: Size3D<T, U>)
[src]Performs the -=
operation. Read more
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for 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]
fn sub_assign(&mut self, other: Self)
[src]Performs the -=
operation. Read more
impl<T: Copy, U> Copy for Size3D<T, U>
[src]
impl<T, U> Eq for Size3D<T, U> where
T: Eq,
[src]
T: Eq,
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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more