Struct Aabb3

pub struct Aabb3<S> { /* private fields */ }

3D axis-aligned bounding box.

See also shape::Aabb trait for primitive and shape types that can compute a 3D AABB.

Min/max can be co-planar or co-linear:

let x = Aabb3::with_minmax (
  [0.0, 0.0, 0.0].into(),
  [0.0, 1.0, 1.0].into()
);
let y = Aabb3::with_minmax (
  [0.0, 0.0, 0.0].into(),
  [0.0, 1.0, 0.0].into()
);

But not identical:

let x = Aabb3::with_minmax (
  [0.0, 0.0, 0.0].into(),
  [0.0, 0.0, 0.0].into()
);

Implementations

impl<S> Aabb3<S>

pub fn numcast<T>(self) -> Option<Aabb3<T>>

where S: NumCast, T: NumCast,

impl<S> Aabb3<S>

where S: Ring,

pub fn with_minmax(min: Point3<S>, max: Point3<S>) -> Aabb3<S>

where S: Debug,

Construct a new AABB with given min and max points.

Debug panic if points are not min/max:

let b = Aabb3::with_minmax ([1.0, 1.0, 1.0].into(), [0.0, 0.0, 0.0].into());  // panic!

Debug panic if points are identical:

let b = Aabb3::with_minmax ([0.0, 0.0, 0.0].into(), [0.0, 0.0, 0.0].into());  // panic!

pub fn from_points(a: Point3<S>, b: Point3<S>) -> Aabb3<S>

where S: Debug,

Construct a new AABB using the two given points to determine min/max.

Panic if points are identical:

let b = Aabb3::from_points (
  [0.0, 0.0, 0.0].into(),
  [0.0, 0.0, 0.0].into());  // panic!

pub fn containing(points: &[Point3<S>]) -> Aabb3<S>

where S: Debug,

Construct the minimum AABB containing the given set of points.

Debug panic if fewer than 2 points are given:

let b = Aabb3::<f32>::containing (&[]);  // panic!

let b = Aabb3::containing (&[[0.0, 0.0, 0.0].into()]);  // panic!

pub fn union(a: &Aabb3<S>, b: &Aabb3<S>) -> Aabb3<S>

where S: Debug,

Create a new AABB that is the union of the two input AABBs

pub fn min(&self) -> &Point3<S>

pub fn max(&self) -> &Point3<S>

pub fn center(&self) -> Point3<S>

where S: Field,

pub fn dimensions(&self) -> Vec3<S>

pub fn width(&self) -> NonNegative<S>

X extent

pub fn depth(&self) -> NonNegative<S>

Y extent

pub fn height(&self) -> NonNegative<S>

Z extent

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

pub fn clamp(&self, point: &Point3<S>) -> Point3<S>

Clamp a given point to the AABB.

let b = Aabb3::with_minmax ([-1.0, -1.0, -1.0].into(), [1.0, 1.0, 1.0].into());
assert_eq!(b.clamp (&[-2.0, 0.0, 0.0].into()), [-1.0, 0.0, 0.0].into());
assert_eq!(b.clamp (&[ 2.0, 2.0, 0.0].into()), [ 1.0, 1.0, 0.0].into());
assert_eq!(b.clamp (&[-1.0, 2.0, 3.0].into()), [-1.0, 1.0, 1.0].into());
assert_eq!(b.clamp (&[-0.5, 0.5, 0.0].into()), [-0.5, 0.5, 0.0].into());

pub fn rand_point<R>(&self, rng: &mut R) -> Point3<S>

where S: SampleUniform, R: Rng,

Generate a random point contained in the AABB

use rand_xorshift;
use rand::SeedableRng;
// random sequence will be the same each time this is run
let mut rng = rand_xorshift::XorShiftRng::seed_from_u64 (0);
let aabb = Aabb3::<f32>::with_minmax (
  [-10.0, -10.0, -10.0].into(),
  [ 10.0,  10.0,  10.0].into());
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (&point));

pub fn intersects(&self, other: &Aabb3<S>) -> bool

pub fn intersection(self, other: Aabb3<S>) -> Option<Aabb3<S>>

where S: Debug,

pub fn corner(&self, octant: Octant) -> Point3<S>

pub fn face(&self, direction: SignedAxis3) -> Aabb3<S>

where S: Debug,

pub fn extrude(&self, axis: SignedAxis3, amount: Positive<S>) -> Aabb3<S>

pub fn extend(&mut self, axis: SignedAxis3, amount: Positive<S>)

pub fn dilate(self, amount: S) -> Aabb3<S>

where S: Debug,

Increase or decrease each dimension by the given amount.

Debug panic if any dimension would become negative:

let x = Aabb3::with_minmax ([0.0, 0.0, 0.0].into(), [1.0, 2.0, 3.0].into());
let y = x.dilate (-1.0); // panic!

pub fn project(self, axis: Axis3) -> Aabb2<S>

where S: Debug,

Project along the given axis.

For example, projecting along the X-axis projects onto the YZ-plane.

Trait Implementations

impl<S> Add<Vec3<S>> for Aabb3<S>

where S: Field, Aabb3<S>: Primitive<S, Vec3<S>>,

type Output = Aabb3<S>

The resulting type after applying the + operator.

fn add(self, displacement: Vec3<S>) -> Aabb3<S>

Performs the + operation.

impl<S> Clone for Aabb3<S>

where S: Clone,

fn clone(&self) -> Aabb3<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Aabb3<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Aabb3<S>

where S: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Aabb3<S>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> From<Aabb3<S>> for Cuboid<S>

where S: Field,

fn from(aabb: Aabb3<S>) -> Cuboid<S>

Converts to this type from the input type.

impl<S> PartialEq for Aabb3<S>

where S: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S> Primitive<S, Vec3<S>> for Aabb3<S>

where S: Field,

fn translate(self, displacement: Vec3<S>) -> Aabb3<S>

fn scale(self, scale: NonZero<S>) -> Aabb3<S>

impl<S> Serialize for Aabb3<S>

where S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> Sub<Vec3<S>> for Aabb3<S>

where S: Field, Aabb3<S>: Primitive<S, Vec3<S>>,

type Output = Aabb3<S>

The resulting type after applying the - operator.

fn sub(self, displacement: Vec3<S>) -> Aabb3<S>

Performs the - operation.

impl<S> Copy for Aabb3<S>

where S: Copy,

impl<S> StructuralPartialEq for Aabb3<S>