Struct Aabb 

pub struct Aabb { /* private fields */ }

An axis-aligned box, or the empty box.

The empty box is a distinct state rather than a degenerate one with reversed bounds: “no points at all” and “a box of zero size at the origin” answer containment questions differently, and conflating them makes an empty shape appear to be at the origin.

Implementations

impl Aabb

pub const EMPTY: Self

A box containing nothing.

pub const fn of_point(p: Point) -> Self

A box containing exactly one point.

pub fn of_corners(a: Point, b: Point) -> Self

A box spanning two corners, in either order.

pub fn of_points(points: &[Point]) -> Self

A box containing every point given.

pub const fn is_empty(&self) -> bool

Whether this box contains nothing.

pub fn low(&self) -> Option<Point>

The lower corner, or None if empty.

pub fn high(&self) -> Option<Point>

The upper corner, or None if empty.

pub fn centre(&self) -> Option<Point>

The centre, or None if empty.

pub fn size(&self) -> Vector

The size along each axis, or zero if empty.

pub fn extent_max(&self) -> f64

The length of the longest axis, or zero if empty.

pub fn diagonal(&self) -> f64

The length of the diagonal, or zero if empty.

pub fn volume(&self) -> f64

The enclosed volume, or zero if empty or flat.

pub fn with_point(&self, p: Point) -> Self

This box grown to include p.

pub fn union(&self, other: &Self) -> Self

This box grown to include other.

pub fn expanded(&self, margin: f64) -> Self

This box grown by margin in every direction.

The usual way to account for a tolerance before a rejection test: two shapes whose boxes miss by less than their tolerances may still touch.

pub fn with_tolerance(&self, tol: Tolerances) -> Self

This box grown by the confusion tolerance.

pub fn contains(&self, p: Point) -> bool

Whether p lies inside, boundary included.

pub fn contains_box(&self, other: &Self) -> bool

Whether other lies entirely inside this box.

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

Whether the two boxes share any point.

The rejection test everything else is built on. An empty box intersects nothing.

pub fn intersection(&self, other: &Self) -> Self

The overlap of two boxes, or empty if they do not meet.

pub fn distance_to(&self, p: Point) -> f64

The shortest distance from p to this box, zero if inside.

pub fn distance_to_box(&self, other: &Self) -> f64

A lower bound on the distance between two boxes, zero if they meet.

A bound, not the distance between the shapes inside them, which is why it is only ever useful for rejection: if this exceeds a threshold the shapes certainly do too.

pub fn corners(&self) -> Vec<Point>

The eight corners, or an empty list if the box is empty.

pub fn transformed(&self, t: &Transform) -> Self

This box transformed, as the box of the transformed corners.

The result contains the transformed box but is generally larger than the tightest one: a rotated box is not axis-aligned, and its bounding box must cover the rotation. Erring outward is the safe direction, and repeatedly transforming a box therefore inflates it; transform the geometry and re-bound instead of chaining this.

Trait Implementations

impl Clone for Aabb

fn clone(&self) -> Aabb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Aabb

impl Debug for Aabb

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

Formats the value using the given formatter.

impl Default for Aabb

fn default() -> Self

Returns the “default value” for a type.

impl Display for Aabb

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

Formats the value using the given formatter.

impl FromIterator<Point> for Aabb

fn from_iter<I: IntoIterator<Item = Point>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Aabb

fn eq(&self, other: &Aabb) -> 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 StructuralPartialEq for Aabb