Struct valence_math::Aabb

pub struct Aabb { /* private fields */ }

A three-dimensional axis-aligned bounding box, or “AABB”.

The AABB is defined by two points—min and max. min is less than or equal to max componentwise.

Implementations

impl Aabb

pub const ZERO: Self = _

pub fn new(min: DVec3, max: DVec3) -> Self

Constructs a new AABB from min and max points.

Panics

Panics if debug_assertions are enabled and min is not less than or equal to max componentwise.

pub fn new_point(p: DVec3) -> Self

Returns a new AABB containing a single point p.

pub fn from_bottom_size(bottom: DVec3, size: DVec3) -> Self

pub const fn min(self) -> DVec3

pub const fn max(self) -> DVec3

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

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

pub fn contains_point(self, p: DVec3) -> bool

Does this bounding box contain the given point?

pub fn projected_point(self, p: DVec3) -> DVec3

Returns the closest point in the AABB to the given point.

pub fn distance_to_point(self, p: DVec3) -> f64

Returns the smallest distance from the AABB to the point.

pub fn ray_intersection( self, origin: DVec3, direction: DVec3, ) -> Option<[f64; 2]>

Calculates the intersection between this AABB and a ray defined by its origin point and direction vector.

If an intersection occurs, Some([near, far]) is returned. near and far are the values of t in the equation origin + t * direction = point where point is the nearest or furthest intersection point to the origin. If no intersection occurs, then None is returned.

In other words, if direction is normalized, then near and far are the distances to the nearest and furthest intersection points.

Trait Implementations

impl Add<Aabb> for DVec3

type Output = Aabb

The resulting type after applying the + operator.

fn add(self, rhs: Aabb) -> Self::Output

Performs the + operation.

impl Add<DVec3> for Aabb

type Output = Aabb

The resulting type after applying the + operator.

fn add(self, rhs: DVec3) -> Self::Output

Performs the + operation.

impl Clone for Aabb

fn clone(&self) -> Aabb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Aabb

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

Formats the value using the given formatter.

impl Default for Aabb

fn default() -> Aabb

Returns the “default value” for a type.

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 Sub<Aabb> for DVec3

type Output = Aabb

The resulting type after applying the - operator.

fn sub(self, rhs: Aabb) -> Self::Output

Performs the - operation.

impl Sub<DVec3> for Aabb

type Output = Aabb

The resulting type after applying the - operator.

fn sub(self, rhs: DVec3) -> Self::Output

Performs the - operation.

impl Copy for Aabb

impl StructuralPartialEq for Aabb