Struct Aabb2 

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

Available on crate feature math-utils only.

2D axis-aligned bounding box.

Min/max can be co-linear:

let x = Aabb2::with_minmax (
  [0.0, 0.0].into(),
  [0.0, 1.0].into()
).unwrap();

But not identical:

// panic!
let x = Aabb2::with_minmax (
  [0.0, 0.0].into(),
  [0.0, 0.0].into()
).unwrap();

Implementations

impl<S> Aabb2<S>

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

where S: NumCast + PartialOrd + Zero, T: NumCast + PartialOrd + Zero,

impl<S> Aabb2<S>

where S: OrderedRing,

pub fn with_minmax(min: Point2<S>, max: Point2<S>) -> Option<Aabb2<S>>

Returns None if points are not min/max or points are identical

pub fn from_points(a: Point2<S>, b: Point2<S>) -> Option<Aabb2<S>>

Returns None if points are identical

pub fn with_minmax_unchecked(min: Point2<S>, max: Point2<S>) -> Aabb2<S>

Construct a new AABB with given min and max points.

Debug panic if points are not min/max:

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

Debug panic if points are identical:

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

pub fn from_points_unchecked(a: Point2<S>, b: Point2<S>) -> Aabb2<S>

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

Debug panic if points are identical:

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

pub fn containing(points: &[Point2<S>]) -> Option<Aabb2<S>>

Construct the minimum AABB containing the given set of points.

Returns None if fewer than 2 points are given or all points are identical:

assert!(Aabb2::<f32>::containing (&[]).is_none());

assert!(Aabb2::containing (&[[0.0, 0.0].into()]).is_none());

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

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

pub const fn min(self) -> Point2<S>

pub const fn max(self) -> Point2<S>

pub fn center(self) -> Point2<S>

pub fn dimensions(self) -> Vec2<NonNegative<S>>

pub fn extents(self) -> Vec2<NonNegative<S>>

where S: Field,

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

X dimension

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

Y dimension

pub fn area(self) -> NonNegative<S>

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

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

Clamp a given point to the AABB.

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

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

where S: SampleUniform, R: RngExt,

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 = Aabb2::<f32>::with_minmax (
  [-10.0, -10.0].into(),
  [ 10.0,  10.0].into()
).unwrap();
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: Aabb2<S>) -> bool

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

pub fn corner(self, quadrant: Quadrant) -> Point2<S>

pub fn corners(self) -> [Point2<S>; 4]

Corner points clockwise from min

pub fn edge(self, direction: SignedAxis2) -> Aabb2<S>

pub fn extrude(self, axis: SignedAxis2, amount: Positive<S>) -> Aabb2<S>

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

pub fn with_z(self, z: Interval<S>) -> Aabb3<S>

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

Increase or decrease each extent by the given amount.

Returns None if any extent would become negative or if all dimensions become zero:

let x = Aabb2::with_minmax ([0.0, 0.0].into(), [1.0, 2.0].into()).unwrap();
assert!(x.dilate (-1.0).is_none());

pub fn project(self, axis: Axis2) -> Interval<S>

Project along the given axis.

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

Trait Implementations

impl<S> Add<Vec2<S>> for Aabb2<S>

where S: Field, Aabb2<S>: Primitive<S, Point2<S>>,

type Output = Aabb2<S>

The resulting type after applying the + operator.

fn add(self, displacement: Vec2<S>) -> Aabb2<S>

Performs the + operation.

impl<S> Clone for Aabb2<S>

where S: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Aabb2<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> From<Aabb2<S>> for Obb2<S>

where S: Real,

fn from(aabb: Aabb2<S>) -> Obb2<S>

Panics if AABB has a zero dimension:

let x = Aabb2::with_minmax (
  [0.0, 0.0].into(),
  [0.0, 1.0].into()
).unwrap();
let y = Obb2::from (x); // panic!

impl<S> PartialEq for Aabb2<S>

where S: PartialEq,

fn eq(&self, other: &Aabb2<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, Point2<S>> for Aabb2<S>

where S: OrderedField,

fn translate(&mut self, displacement: Vec2<S>)

fn scale(&mut self, scale: Positive<S>)

fn support(&self, direction: NonZero2<S>) -> (Point2<S>, S)

Returns the point with largeest dot product in search direction

impl<S> Sub<Vec2<S>> for Aabb2<S>

where S: Field, Aabb2<S>: Primitive<S, Point2<S>>,

type Output = Aabb2<S>

The resulting type after applying the - operator.

fn sub(self, displacement: Vec2<S>) -> Aabb2<S>

Performs the - operation.

impl<S> Copy for Aabb2<S>

where S: Copy,

impl<S> Eq for Aabb2<S>

where S: Eq,

impl<S> StructuralPartialEq for Aabb2<S>