#[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§impl<T, U> Box3D<T, U>where
T: PartialOrd,
impl<T, U> Box3D<T, U>where
T: PartialOrd,
Sourcepub fn is_negative(&self) -> bool
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 intersects(&self, other: &Self) -> bool
Sourcepub fn contains(&self, other: Point3D<T, U>) -> bool
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.
Sourcepub fn contains_box(&self, other: &Self) -> bool
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,
impl<T, U> Box3D<T, U>where
T: Copy + PartialOrd,
pub fn to_non_empty(&self) -> Option<Self>
pub fn intersection(&self, other: &Self) -> Option<Self>
pub fn intersection_unchecked(&self, other: &Self) -> Self
Source§impl<T, U> Box3D<T, U>
impl<T, U> Box3D<T, U>
Sourcepub fn from_size(size: Size3D<T, U>) -> Self
pub fn from_size(size: Size3D<T, U>) -> Self
Creates a Box3D of the given size, at offset zero.
Sourcepub fn from_points<I>(points: I) -> Self
pub fn from_points<I>(points: I) -> Self
Returns the smallest box containing all of the provided points.
Source§impl<T, U> Box3D<T, U>where
T: Copy,
impl<T, U> Box3D<T, U>where
T: Copy,
Sourcepub fn to_untyped(&self) -> Box3D<T, UnknownUnit>
pub fn to_untyped(&self) -> Box3D<T, UnknownUnit>
Drop the units, preserving only the numeric value.
Sourcepub fn from_untyped(c: &Box3D<T, UnknownUnit>) -> Box3D<T, U>
pub fn from_untyped(c: &Box3D<T, UnknownUnit>) -> Box3D<T, U>
Tag a unitless value with units.
pub fn scale<S: Copy>(&self, x: S, y: S, z: S) -> Selfwhere
T: Mul<S, Output = T>,
Source§impl<T: NumCast + Copy, U> Box3D<T, U>
impl<T: NumCast + Copy, U> Box3D<T, U>
Sourcepub fn cast<NewT: NumCast>(&self) -> Box3D<NewT, U>
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.
Sourcepub fn try_cast<NewT: NumCast>(&self) -> Option<Box3D<NewT, U>>
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.
Sourcepub fn to_usize(&self) -> Box3D<usize, U>
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.
Sourcepub fn to_u32(&self) -> Box3D<u32, U>
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§impl<T, U> Box3D<T, U>where
T: Round,
impl<T, U> Box3D<T, U>where
T: Round,
Sourcepub fn round(&self) -> Self
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).
Trait Implementations§
Source§impl<'de, T, U> Deserialize<'de> for Box3D<T, U>where
T: Deserialize<'de>,
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>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box3D<T, U>
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>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moreSource§impl<T: Copy + DivAssign, U> DivAssign<T> for Box3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<T> for Box3D<T, U>
Source§fn div_assign(&mut self, scale: T)
fn div_assign(&mut self, scale: T)
/=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box3D<T, U>
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>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<T> for Box3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<T> for Box3D<T, U>
Source§fn mul_assign(&mut self, scale: T)
fn mul_assign(&mut self, scale: T)
*=
operation. Read moreimpl<T: Copy, U> Copy for Box3D<T, U>
impl<T: Eq, U> Eq for Box3D<T, U>
Auto Trait Implementations§
impl<T, U> Freeze for Box3D<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Box3D<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Box3D<T, U>
impl<T, U> Sync for Box3D<T, U>
impl<T, U> Unpin for Box3D<T, U>
impl<T, U> UnwindSafe for Box3D<T, U>where
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)