Struct euclid::Box3D

#[repr(C)]
pub struct Box3D<T, U> {
    pub min: Point3D<T, U>,
    pub max: Point3D<T, U>,
}

An axis aligned 3D box represented by its minimum and maximum coordinates.

Fields

min: Point3D<T, U>

max: Point3D<T, U>

Methods

impl<T, U> Box3D<T, U>

pub const fn new(min: Point3D<T, U>, max: Point3D<T, U>) -> Self

Constructor.

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

pub fn from_size(size: Size3D<T, U>) -> Self

Creates a Box3D of the given size, at offset zero.

impl<T, U> Box3D<T, U> where
    T: Copy + PartialOrd, 

pub fn is_negative(&self) -> bool

Returns true if the box has a negative volume.

The common interpretation for a negative box is to consider it empty. It can be obtained by calculating the intersection of two boxes that do not intersect.

pub fn is_empty_or_negative(&self) -> bool

Returns true if the size is zero or negative.

pub fn to_non_empty(&self) -> Option<NonEmpty<Self>>

pub fn intersects(&self, other: &Self) -> bool

pub fn try_intersection(&self, other: &Self) -> Option<NonEmpty<Self>>

pub fn intersection(&self, other: &Self) -> Self

impl<T, U> Box3D<T, U> where
    T: Copy + Add<T, Output = T>, 

#[must_use] pub fn translate(&self, by: Vector3D<T, U>) -> Self

Returns the same box3d, translated by a vector.

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

pub fn contains(&self, other: Point3D<T, U>) -> bool

Returns true if this box3d contains the point. Points are considered in the box3d if they are on the front, left or top faces, but outside if they are on the back, right or bottom faces.

impl<T, U> Box3D<T, U> where
    T: Copy + PartialOrd + Zero + Sub<T, Output = T>, 

pub fn contains_box(&self, other: &Self) -> bool

Returns true if this box3d contains the interior of the other box3d. Always returns true if other is empty, and always returns false if other is nonempty but this box3d is empty.

impl<T, U> Box3D<T, U> where
    T: Copy + Sub<T, Output = T>, 

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

impl<T, U> Box3D<T, U> where
    T: Copy + PartialEq + Add<T, Output = T> + Sub<T, Output = T>, 

#[must_use] pub fn inflate(&self, width: T, height: T, depth: T) -> Self

Inflates the box by the specified sizes on each side respectively.

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

pub fn from_points<I>(points: I) -> Self where
    I: IntoIterator,
    I::Item: Borrow<Point3D<T, U>>, 

Returns the smallest box containing all of the provided points.

impl<T, U> Box3D<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this box3d and another box3d.

t is expected to be between zero and one.

impl<T, U> Box3D<T, U> where
    T: Copy + One + Add<Output = T> + Div<Output = T>, 

pub fn center(&self) -> Point3D<T, U>

impl<T, U> Box3D<T, U> where
    T: Copy + Clone + PartialOrd + Add<T, Output = T> + Sub<T, Output = T> + Zero, 

pub fn union(&self, other: &Self) -> Self

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

pub fn scale<S: Copy>(&self, x: S, y: S, z: S) -> Self where
    T: Mul<S, Output = T>, 

impl<T, U> Box3D<T, U> where
    T: Copy + Mul<T, Output = T> + Sub<T, Output = T>, 

pub fn volume(&self) -> T

pub fn xy_area(&self) -> T

pub fn yz_area(&self) -> T

pub fn xz_area(&self) -> T

impl<T, U> Box3D<T, U> where
    T: Copy + Zero, 

pub fn zero() -> Self

Constructor, setting all sides to zero.

impl<T, U> Box3D<T, U> where
    T: PartialEq, 

pub fn is_empty(&self) -> bool

Returns true if the volume is zero.

impl<T, Unit> Box3D<T, Unit> where
    T: Copy, 

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

Drop the units, preserving only the numeric value.

pub fn from_untyped(c: &Box3D<T, UnknownUnit>) -> Box3D<T, Unit>

Tag a unitless value with units.

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

Cast the unit

impl<T0, Unit> Box3D<T0, Unit> where
    T0: NumCast + Copy, 

pub fn cast<T1: NumCast + Copy>(&self) -> Box3D<T1, Unit>

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(), round_in or round_out() before casting.

pub fn try_cast<T1: NumCast + Copy>(&self) -> Option<Box3D<T1, Unit>>

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(), round_in or round_out() before casting.

impl<T, U> Box3D<T, U> where
    T: Round, 

#[must_use] pub fn round(&self) -> Self

Return a box3d with edges rounded to integer coordinates, such that the returned box3d has the same set of pixel centers as the original one. Values equal to 0.5 round up. Suitable for most places where integral device coordinates are needed, but note that any translation should be applied first to avoid pixel rounding errors. Note that this is not rounding to nearest integer if the values are negative. They are always rounding as floor(n + 0.5).

impl<T, U> Box3D<T, U> where
    T: Floor + Ceil, 

#[must_use] pub fn round_in(&self) -> Self

Return a box3d with faces/edges rounded to integer coordinates, such that the original box3d contains the resulting box3d.

#[must_use] pub fn round_out(&self) -> Self

Return a box3d with faces/edges rounded to integer coordinates, such that the original box3d is contained in the resulting box3d.

impl<T: NumCast + Copy, Unit> Box3D<T, Unit>

pub fn to_f32(&self) -> Box3D<f32, Unit>

Cast into an f32 box3d.

pub fn to_f64(&self) -> Box3D<f64, Unit>

Cast into an f64 box3d.

pub fn to_usize(&self) -> Box3D<usize, Unit>

Cast into an usize box3d, truncating decimals if any.

When casting from floating point cuboids, it is worth considering whether to round(), round_in() or round_out() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(&self) -> Box3D<u32, Unit>

Cast into an u32 box3d, truncating decimals if any.

When casting from floating point cuboids, it is worth considering whether to round(), round_in() or round_out() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(&self) -> Box3D<i32, Unit>

Cast into an i32 box3d, truncating decimals if any.

When casting from floating point cuboids, it is worth considering whether to round(), round_in() or round_out() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(&self) -> Box3D<i64, Unit>

Cast into an i64 box3d, truncating decimals if any.

When casting from floating point cuboids, it is worth considering whether to round(), round_in() or round_out() before the cast in order to obtain the desired conversion behavior.

Trait Implementations

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

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

Performs the conversion.

impl<T: Display, U> Display for Box3D<T, U>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Debug, U> Debug for Box3D<T, U>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T, U> Div<T> for Box3D<T, U> where
    T: Copy + Div<T, Output = T>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self

Performs the / operation.

impl<T, U1, U2> Div<Scale<T, U1, U2>> for Box3D<T, U2> where
    T: Copy + Div<T, Output = T>, 

type Output = Box3D<T, U1>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Box3D<T, U1>

Performs the / operation.

impl<T: PartialEq, U> PartialEq<Box3D<T, U>> for Box3D<T, U>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Eq, U> Eq for Box3D<T, U>

impl<T, U> Mul<T> for Box3D<T, U> where
    T: Copy + Mul<T, Output = T>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self

Performs the * operation.

impl<T, U1, U2> Mul<Scale<T, U1, U2>> for Box3D<T, U1> where
    T: Copy + Mul<T, Output = T>, 

type Output = Box3D<T, U2>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Box3D<T, U2>

Performs the * operation.

impl<T: Hash, U> Hash for Box3D<T, U>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T: Copy, U> Copy for Box3D<T, U>

impl<T: Copy, U> Clone for Box3D<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.