Struct gut::bbox::BBox

pub struct BBox<T> { /* fields omitted */ }

General purpose bounding box structure.

Methods

impl<T: Float> BBox<T>

pub fn new(minb: [T; 3], maxb: [T; 3]) -> Self

Construct a bounding box containing points minb and maxb.

Examples

    let min_p = [0.0; 3];
    let max_p = [1.5, 0.5, 1.0];
    let sample_box = BBox::<f32>::new(min_p, max_p);

    assert_eq!(sample_box.min_corner(), min_p);
    assert_eq!(sample_box.max_corner(), max_p);

pub fn unit() -> BBox<T>

Construct a unit bounding box from zero to one in each dimension.

Examples

    let unit_box = BBox::<f32>::new(
        [0.0; 3],
        [1.0; 3]);
    assert_eq!(BBox::<f32>::unit(), unit_box);

pub fn size(&self) -> [T; 3]

Get the size of the box in each dimension.

Examples

    let unit_box = BBox::<f32>::unit();
    assert_eq!(unit_box.size(), [1.0, 1.0, 1.0]);

pub fn max_axis(&self) -> (u8, T)

Determine the axis of the maximum side length of the box and return both: the axis index (x => 0, y => 1, z => 2) and the length.

Examples

    let min_p = [0.0; 3];
    let max_p = [1.5, 0.5, 1.0];
    let sample_box = BBox::<f32>::new(min_p, max_p);

    assert_eq!(sample_box.max_axis(), (0, 1.5));

pub fn min_corner(&self) -> [T; 3]

pub fn max_corner(&self) -> [T; 3]

pub fn diameter(&self) -> T where
    T: BaseFloat, 

Diameter of the bounding box is the distance between the min and max corners.

pub fn corner<C: Copy + Into<Corner>>(&self, which: C) -> [T; 3]

Trait Implementations

impl<T: Float> Empty for BBox<T>

fn empty() -> Self

Construct an empty object.

fn is_empty(&self) -> bool

Check if this object is empty.

impl<T: PartialOrd + Copy> Contains<[T; 3]> for BBox<T>

fn contains(&self, p: [T; 3]) -> bool

Check if this object contains another.

impl<'a, T: Float, P> Absorb<P> for &'a mut BBox<T> where
    P: Into<[T; 3]>, 

type Output = &'a mut BBox<T>

fn absorb(self, p: P) -> Self::Output

Absorb another object. For example if a = [-1, 2] and b = [3, 4] is are closed intervals, then a.absorb(b) == [-1 4].

impl<'a, T: Float> Absorb<BBox<T>> for &'a mut BBox<T>

type Output = &'a mut BBox<T>

fn absorb(self, other: BBox<T>) -> Self::Output

Absorb another object. For example if a = [-1, 2] and b = [3, 4] is are closed intervals, then a.absorb(b) == [-1 4].

impl<T: Float> Intersect<BBox<T>> for BBox<T>

type Output = Self

fn intersect(self, other: Self) -> Self

Intersect on one object with another, producing the resulting intersection. For example if [-1, 2] and [0, 4] are two closed intervals, then their intersection is a closed interval [0, 2]. Note that the intersection object can be of a different type

fn intersects(self, other: Self) -> bool

Check if this object intersects another.

impl<'a, T: Float> Centroid<Option<[T; 3]>> for &'a BBox<T>

fn centroid(self) -> Option<[T; 3]>

Compute the centroid of the object.

impl<T: Clone> Clone for BBox<T>

fn clone(&self) -> BBox<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for BBox<T>

impl<T: PartialEq> PartialEq<BBox<T>> for BBox<T>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BBox<T>) -> bool

This method tests for !=.

impl<T: Debug> Debug for BBox<T>

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

Formats the value using the given formatter.

impl<T> StructuralPartialEq for BBox<T>