Struct euclid::Box3D

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

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

Fields§

§`min: Point3D<T, U>`§`max: Point3D<T, U>`

Implementations§

source§

source

Constructor.

source§

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

source

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.

source

pub fn is_empty(&self) -> bool

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

source

source

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.

source

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.

source§

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

source

source

source

source

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

Returns the smallest box containing both of the provided boxes.

source§

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

source

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

Returns the same box3d, translated by a vector.

source§

source

source

source

source

source§

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

source

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

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

source§

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

source

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

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

source

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

Returns the smallest box containing all of the provided points.

source§

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

source

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

Linearly interpolate between this box3d and another box3d.

source§

source

source§

source

source

source

source

source§

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

source

pub fn zero() -> Self

Constructor, setting all sides to zero.

source§

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

source

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

Drop the units, preserving only the numeric value.

source

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

Tag a unitless value with units.

source

Cast the unit

source

source§

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

source

pub fn cast<NewT: NumCast>(&self) -> Box3D<NewT, U>

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.

source

pub fn try_cast<NewT: NumCast>(&self) -> Option<Box3D<NewT, U>>

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.

source

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

Cast into an `f32` box3d.

source

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

Cast into an `f64` box3d.

source

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.

source

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.

source

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.

source

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.

source§

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

source

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

source§

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

source

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.

source

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.

Trait Implementations§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

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

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

§

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

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

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

§

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

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

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

source§

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

Performs the `/=` operation. Read more
source§

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

source§

fn div_assign(&mut self, scale: T)

Performs the `/=` operation. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

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
source§

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

§

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

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

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

§

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

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

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

source§

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

Performs the `*=` operation. Read more
source§

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

source§

fn mul_assign(&mut self, scale: T)

Performs the `*=` operation. Read more
source§

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

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

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

source§

§

§

§

§

§

§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
source§