Struct Aabb3

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

3D axis-aligned bounding box

Implementations

impl<I> Aabb3<I>

where I: Integer,

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

where I: 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, 1, 1].into(), [0, 0, 0].into());  // panic!

Identical points are allowed:

let b = Aabb3::with_minmax ([0, 0, 0].into(), [0, 0, 0].into());  // ok

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

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

Identical points are allowed:

let b = Aabb3::from_points ([0, 0, 0].into(), [0, 0, 0].into());  // ok

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

where I: Debug,

Construct the minimum AABB containing the given set of points.

Identical points are allowed:

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

A single point is allowed:

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

Debug panic if no points are given:

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

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

where I: Debug,

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

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

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

pub fn width(&self) -> I

pub fn height(&self) -> I

pub fn depth(&self) -> I

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

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

Clamp a given point to the AABB.

let b = Aabb3::with_minmax ([-1, -1, -1].into(), [1, 1, 1].into());
assert_eq!(b.clamp (&[-2, 0, 0].into()), [-1, 0, 0].into());
assert_eq!(b.clamp (&[ 2, 2, 0].into()), [ 1, 1, 0].into());
assert_eq!(b.clamp (&[-1, 2, 3].into()), [-1, 1, 1].into());
assert_eq!(b.clamp (&[ 0, 0, 0].into()), [ 0, 0, 0].into());

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

where I: SampleUniform, R: Rng,

Generate a random point contained in the AABB

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::<i32>::with_minmax (
  [-10, -10, -10].into(),
  [ 10,  10,  10].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<I>) -> bool

Trait Implementations

impl<I> Clone for Aabb3<I>

where I: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Aabb3<I>

where I: Debug,

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

Formats the value using the given formatter.

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

where I: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I> PartialEq for Aabb3<I>

where I: PartialEq,

fn eq(&self, other: &Aabb3<I>) -> 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<I> Serialize for Aabb3<I>

where I: 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<I> StructuralPartialEq for Aabb3<I>