Skip to main content

BoundingBox

Struct BoundingBox 

Source
pub struct BoundingBox<S: 'static + Debug + Copy + PartialEq, const D: usize> {
    pub min: Point<S, D>,
    pub max: Point<S, D>,
}
Expand description

3D Bounding Box - defined by two diagonally opposing points.

Fields§

§min: Point<S, D>

X-Y-Z-Minimum corner of the box.

§max: Point<S, D>

X-Y-Z-Maximum corner of the box.

Implementations§

Source§

impl<S: Float + Debug + RealField, const D: usize> BoundingBox<S, D>

Source

pub fn infinity() -> Self

Returns an infinte sized box.

Source

pub fn neg_infinity() -> Self

Returns a negatively infinte sized box.

Source

pub fn new(a: &Point<S, D>, b: &Point<S, D>) -> Self

Create a new Bounding Box by supplying two points.

Source

pub fn is_empty(&self) -> bool

Returns true if the Bounding Box is empty.

Source

pub fn is_finite(&self) -> bool

Returns true if the Bounding Box has finite size.

Source

pub fn center(&self) -> Point<S, D>

Returns the center point of the Bounding Box.

Source

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

Create a CSG Union of two Bounding Boxes.

Source

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

Create a CSG Intersection of two Bounding Boxes.

Source

pub fn get_corners(&self) -> Vec<Point<S, D>>

Get the corners of the Bounding Box

Warning: bounding box of dimension D has 2^D corners

Source

pub fn dilate(&mut self, d: S) -> &mut Self

Dilate a Bounding Box by some amount in all directions.

Source

pub fn insert(&mut self, o: &Point<S, D>) -> &mut Self

Add a Point to a Bounding Box, e.g. expand the Bounding Box to contain that point.

Source

pub fn dim(&self) -> SVector<S, D>

Return the size of the Box.

Source

pub fn distance(&self, point: &Point<S, D>) -> S

Returns the approximate distance of p to the box. The result is guarateed to be not less than the euclidean distance of p to the box.

Source

pub fn contains(&self, point: &Point<S, D>) -> bool

Return true if the Bounding Box contains p.

Source§

impl<S: Float + Debug + RealField> BoundingBox<S, 3>

Source

pub fn transform(&self, mat: &Matrix4<S>) -> Self

Transform a Bounding Box - resulting in a enclosing axis aligned Bounding Box.

Trait Implementations§

Source§

impl<T, const D: usize> AbsDiffEq for BoundingBox<T, D>
where <T as AbsDiffEq>::Epsilon: Copy, T: AbsDiffEq + Debug + Float,

Source§

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.
Source§

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together. Read more
Source§

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.
Source§

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.
Source§

impl<S: Clone + 'static + Debug + Copy + PartialEq, const D: usize> Clone for BoundingBox<S, D>

Source§

fn clone(&self) -> BoundingBox<S, D>

Returns a duplicate 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<S: Debug + 'static + Debug + Copy + PartialEq, const D: usize> Debug for BoundingBox<S, D>

Source§

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

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

impl<S: Float + RealField, T: AsRef<[Point<S, D>]>, const D: usize> From<T> for BoundingBox<S, D>

Source§

fn from(points: T) -> Self

Converts to this type from the input type.
Source§

impl<S: PartialEq + 'static + Debug + Copy + PartialEq, const D: usize> PartialEq for BoundingBox<S, D>

Source§

fn eq(&self, other: &BoundingBox<S, D>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T, const D: usize> RelativeEq for BoundingBox<T, D>
where <T as AbsDiffEq>::Epsilon: Copy, T: RelativeEq + Debug + Float,

Source§

fn default_max_relative() -> <T as AbsDiffEq>::Epsilon

The default relative tolerance for testing values that are far-apart. Read more
Source§

fn relative_eq( &self, other: &Self, epsilon: <T as AbsDiffEq>::Epsilon, max_relative: <T as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.
Source§

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.
Source§

impl<S: 'static + Debug + Copy + PartialEq, const D: usize> StructuralPartialEq for BoundingBox<S, D>

Auto Trait Implementations§

§

impl<S, const D: usize> Freeze for BoundingBox<S, D>
where S: Freeze,

§

impl<S, const D: usize> RefUnwindSafe for BoundingBox<S, D>
where S: RefUnwindSafe,

§

impl<S, const D: usize> Send for BoundingBox<S, D>
where S: Send,

§

impl<S, const D: usize> Sync for BoundingBox<S, D>
where S: Sync,

§

impl<S, const D: usize> Unpin for BoundingBox<S, D>
where S: Unpin,

§

impl<S, const D: usize> UnsafeUnpin for BoundingBox<S, D>
where S: UnsafeUnpin,

§

impl<S, const D: usize> UnwindSafe for BoundingBox<S, D>
where S: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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

Source§

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

Source§

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§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,