Struct splashsurf_lib::AxisAlignedBoundingBox

source ·

pub struct AxisAlignedBoundingBox<R: Real, const D: usize> { /* private fields */ }

Expand description

Type representing an axis aligned bounding box in arbitrary dimensions

Implementations§

source §

impl<R, const D: usize> AxisAlignedBoundingBox<R, D>where R: Real, SVector<R, D>: ThreadSafe,

source

pub fn par_from_points(points: &[SVector<R, D>]) -> Self

Constructs the smallest AABB fitting around all the given points, parallel version

source §

impl<R, const D: usize> AxisAlignedBoundingBox<R, D>where R: Real,

source

pub fn zeros() -> Self

Constructs a degenerate AABB with min and max set to zero

source

pub fn new(min: SVector<R, D>, max: SVector<R, D>) -> Self

Constructs an AABB with the given min and max bounding points

source

pub fn from_point(point: SVector<R, D>) -> Self

Constructs a degenerate AABB with zero extents centered at the given point

source

pub fn from_points(points: &[SVector<R, D>]) -> Self

Constructs the smallest AABB fitting around all the given points

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;

assert_eq!(
    Aabb3d::<f64>::from_points(&[]),
    Aabb3d::<f64>::zeros()
);
assert_eq!(
    Aabb3d::<f64>::from_points(&[Vector3::new(1.0, 1.0, 1.0)]),
    Aabb3d::<f64>::from_point(Vector3::new(1.0, 1.0, 1.0))
);

let aabb = Aabb3d::<f64>::from_points(&[
    Vector3::new(1.0, 1.0, 1.0),
    Vector3::new(0.5, 3.0, 5.0),
    Vector3::new(-1.0, 1.0, 1.0)
]);
assert_eq!(aabb.min(), &Vector3::new(-1.0, 1.0, 1.0));
assert_eq!(aabb.max(), &Vector3::new(1.0, 3.0, 5.0));

source

pub fn try_convert<T>(&self) -> Option<AxisAlignedBoundingBox<T, D>>where T: Real,

Tries to convert the AABB from one real type to another real type, returns None if conversion fails

source

pub fn min(&self) -> &SVector<R, D>

Returns the min coordinate of the bounding box

source

pub fn max(&self) -> &SVector<R, D>

Returns the max coordinate of the bounding box

source

pub fn is_consistent(&self) -> bool

Returns whether the AABB is consistent, i.e. aabb.min()[i] <= aabb.max()[i] for all i

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;
assert_eq!(
    Aabb3d::<f64>::zeros().is_consistent(), true);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, -1.0, -1.0), Vector3::new(1.0, 1.0, 1.0)).is_consistent(), true);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 1.0, -1.0), Vector3::new(1.0, -1.0, 1.0)).is_consistent(), false);

source

pub fn is_degenerate(&self) -> bool

Returns whether the AABB is degenerate in any dimension, i.e. aabb.min()[i] == aabb.max()[i] for any i

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;
assert_eq!(Aabb3d::<f64>::zeros().is_degenerate(), true);
assert_eq!(Aabb3d::new(Vector3::new(1.0, 1.0, 1.0), Vector3::new(1.0, 1.0, 1.0)).is_degenerate(), true);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 0.0, -3.0), Vector3::new(2.0, 2.0, 4.0)).is_degenerate(), false);

source

pub fn extents(&self) -> SVector<R, D>

Returns the extents of the bounding box (vector connecting min and max point of the box)

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;
assert_eq!(Aabb3d::<f64>::zeros().extents(), Vector3::new(0.0, 0.0, 0.0));
assert_eq!(Aabb3d::new(Vector3::new(-1.0, -1.0, -1.0), Vector3::new(1.0, 1.0, 1.0)).extents(), Vector3::new(2.0, 2.0, 2.0));
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 0.0, -3.0), Vector3::new(2.0, 2.0, 4.0)).extents(), Vector3::new(3.0, 2.0, 7.0));
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 5.0, -3.0), Vector3::new(2.0, 15.0, 4.0)).extents(), Vector3::new(3.0, 10.0, 7.0));

source

pub fn min_extent(&self) -> R

Returns the smallest scalar extent of the AABB over all of its dimensions

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;
assert_eq!(Aabb3d::<f64>::zeros().min_extent(), 0.0);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, -2.0, -3.0), Vector3::new(2.0, 3.0, 4.0)).min_extent(), 3.0);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 0.0, -3.0), Vector3::new(2.0, 2.0, 4.0)).min_extent(), 2.0);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 0.0, 1.0), Vector3::new(2.0, 1.0, 1.0)).min_extent(), 0.0);

source

pub fn max_extent(&self) -> R

Returns the largest scalar extent of the AABB over all of its dimensions

use crate::splashsurf_lib::Aabb3d;
use nalgebra::Vector3;
assert_eq!(Aabb3d::<f64>::zeros().max_extent(), 0.0);
assert_eq!(Aabb3d::new(Vector3::new(-10.0, 0.0, -3.0), Vector3::new(2.0, 2.0, 4.0)).max_extent(), 12.0);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, -2.0, -3.0), Vector3::new(2.0, 3.0, 4.0)).max_extent(), 7.0);
assert_eq!(Aabb3d::new(Vector3::new(-1.0, 5.0, -3.0), Vector3::new(2.0, 15.0, 4.0)).max_extent(), 10.0);