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

Implementations

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

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

Constructor.

pub fn from_origin_and_size( origin: Point3D<T, U>, size: Size3D<T, U>, ) -> Box3D<T, U>

where T: Copy + Add<Output = T>,

Constructor.

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

where T: Zero,

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

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

where T: 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(&self) -> bool

Returns true if the size is zero, negative or NaN.

pub fn intersects(&self, other: &Box3D<T, U>) -> bool

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

Returns true if this box3d contains the point p. A point is considered in the box3d if it lies on the front, left or top faces, but outside if it lies on the back, right or bottom faces.

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

Returns true if this box3d contains the point p. A point is considered in the box3d if it lies on any face of the box3d.

pub fn contains_box(&self, other: &Box3D<T, U>) -> 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 + PartialOrd,

pub fn to_non_empty(&self) -> Option<Box3D<T, U>>

pub fn intersection(&self, other: &Box3D<T, U>) -> Option<Box3D<T, U>>

pub fn intersection_unchecked(&self, other: &Box3D<T, U>) -> Box3D<T, U>

pub fn union(&self, other: &Box3D<T, U>) -> Box3D<T, U>

Computes the union of two boxes.

If either of the boxes is empty, the other one is returned.

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

where T: Copy + Add<Output = T>,

pub fn translate(&self, by: Vector3D<T, U>) -> Box3D<T, U>

Returns the same box3d, translated by a vector.

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

where T: Copy + Sub<Output = T>,

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

pub fn width(&self) -> T

pub fn height(&self) -> T

pub fn depth(&self) -> T

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

where T: Copy + Add<Output = T> + Sub<Output = T>,

pub fn inflate(&self, width: T, height: T, depth: T) -> Box3D<T, U>

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) -> Box3D<T, U>

where I: IntoIterator, <I as IntoIterator>::Item: Borrow<Point3D<T, U>>,

Returns the smallest box containing all of the provided points.

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

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

pub fn lerp(&self, other: Box3D<T, U>, t: T) -> Box3D<T, U>

Linearly interpolate between this box3d and another box3d.

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 + Mul<Output = T> + Sub<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: Zero,

pub fn zero() -> Box3D<T, U>

Constructor, setting all sides to zero.

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

where T: Copy,

pub fn x_range(&self) -> Range<T>

pub fn y_range(&self) -> Range<T>

pub fn z_range(&self) -> Range<T>

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, U>

Tag a unitless value with units.

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

Cast the unit

pub fn scale<S>(&self, x: S, y: S, z: S) -> Box3D<T, U>

where S: Copy, T: Mul<S, Output = T>,

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

where T: NumCast + Copy,

pub fn cast<NewT>(&self) -> Box3D<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, round_in or round_out before casting.

pub fn try_cast<NewT>(&self) -> Option<Box3D<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, round_in or round_out before casting.

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

Cast into an f32 box3d.

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

Cast into an f64 box3d.

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

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, U>

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, U>

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, U>

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.

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

where T: Float,

pub fn is_finite(self) -> bool

Returns true if all members are finite.

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

where T: Round,

pub fn round(&self) -> Box3D<T, U>

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,

pub fn round_in(&self) -> Box3D<T, U>

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

pub fn round_out(&self) -> Box3D<T, U>

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

Trait Implementations

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

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where T: Debug,

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

Formats the value using the given formatter.

impl<T, U> Default for Box3D<T, U>

where T: Default,

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

Returns the “default value” for a type.

impl<T, U1, U2> Div<Scale<T, U1, U2>> for Box3D<T, U2>

where T: Copy + Div,

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

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U> Div<T> for Box3D<T, U>

where T: Copy + Div,

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

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U> DivAssign<Scale<T, U, U>> for Box3D<T, U>

where T: Copy + DivAssign,

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

Performs the /= operation.

impl<T, U> DivAssign<T> for Box3D<T, U>

where T: Copy + DivAssign,

fn div_assign(&mut self, scale: T)

Performs the /= operation.

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> Hash for Box3D<T, U>

where T: Hash,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U1, U2> Mul<Scale<T, U1, U2>> for Box3D<T, U1>

where T: Copy + Mul,

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U> Mul<T> for Box3D<T, U>

where T: Copy + Mul,

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U> MulAssign<Scale<T, U, U>> for Box3D<T, U>

where T: Copy + MulAssign,

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

Performs the *= operation.

impl<T, U> MulAssign<T> for Box3D<T, U>

where T: Copy + MulAssign,

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

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

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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> Copy for Box3D<T, U>

where T: Copy,

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

where T: Eq,