#[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>
impl<T, U> Box3D<T, U>
sourcepub fn from_origin_and_size(
origin: Point3D<T, U>,
size: Size3D<T, U>,
) -> Box3D<T, U>
pub fn from_origin_and_size( origin: Point3D<T, U>, size: Size3D<T, U>, ) -> Box3D<T, U>
Constructor.
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: &Box3D<T, U>) -> 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 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.
sourcepub fn contains_inclusive(&self, other: Point3D<T, U>) -> bool
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.
sourcepub fn contains_box(&self, other: &Box3D<T, U>) -> bool
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.
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<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>
source§impl<T, U> Box3D<T, U>
impl<T, U> Box3D<T, U>
sourcepub fn from_points<I>(points: I) -> Box3D<T, U>
pub fn from_points<I>(points: I) -> Box3D<T, U>
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,
pub fn x_range(&self) -> Range<T>
pub fn y_range(&self) -> Range<T>
pub fn z_range(&self) -> Range<T>
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>(&self, x: S, y: S, z: S) -> Box3D<T, U>
source§impl<T, U> Box3D<T, U>
impl<T, U> Box3D<T, U>
sourcepub fn cast<NewT>(&self) -> Box3D<NewT, U>where
NewT: NumCast,
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.
sourcepub fn try_cast<NewT>(&self) -> Option<Box3D<NewT, U>>where
NewT: NumCast,
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.
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) -> Box3D<T, U>
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).
Trait Implementations§
source§impl<T, U> DivAssign<Scale<T, U, U>> for Box3D<T, U>
impl<T, 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, U> DivAssign<T> for Box3D<T, U>
impl<T, 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, U> MulAssign<Scale<T, U, U>> for Box3D<T, U>
impl<T, 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, U> MulAssign<T> for Box3D<T, U>
impl<T, 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, U> Copy for Box3D<T, U>where
T: Copy,
impl<T, U> Eq for Box3D<T, U>where
T: Eq,
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<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.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
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more