Struct static_aabb2d_index::AABB

pub struct AABB<T = f64> {
    pub min_x: T,
    pub min_y: T,
    pub max_x: T,
    pub max_y: T,
}

Simple 2D axis aligned bounding box which holds the extents of a 2D box.

Fields

min_x: T

Min x extent of the axis aligned bounding box.

min_y: T

Min y extent of the axis aligned bounding box.

max_x: T

Max x extent of the axis aligned bounding box.

max_y: T

Max y extent of the axis aligned bounding box.

Implementations

impl<T> AABB<T> where
    T: IndexableNum, 

pub fn new(min_x: T, min_y: T, max_x: T, max_y: T) -> AABB<T>

pub fn overlaps_aabb(&self, other: &AABB<T>) -> bool

Tests if this AABB overlaps another AABB (inclusive).

Examples

use static_aabb2d_index::AABB;
let box_a = AABB::new(0, 0, 2, 2);
let box_b = AABB::new(1, 1, 3, 3);
assert!(box_a.overlaps_aabb(&box_b));
assert!(box_b.overlaps_aabb(&box_a));

let box_c = AABB::new(-1, -1, 0, 0);
assert!(!box_c.overlaps_aabb(&box_b));
// note: overlap check is inclusive of edges/corners touching
assert!(box_c.overlaps_aabb(&box_a));

pub fn overlaps(&self, min_x: T, min_y: T, max_x: T, max_y: T) -> bool

Tests if this AABB overlaps another AABB. Same as AABB::overlaps_aabb but accepts AABB extent parameters directly.

pub fn contains_aabb(&self, other: &AABB<T>) -> bool

Tests if this AABB fully contains another AABB (inclusive).

Examples

use static_aabb2d_index::AABB;
let box_a = AABB::new(0, 0, 3, 3);
let box_b = AABB::new(1, 1, 2, 2);
assert!(box_a.contains_aabb(&box_b));
assert!(!box_b.contains_aabb(&box_a));

pub fn contains(&self, min_x: T, min_y: T, max_x: T, max_y: T) -> bool

Tests if this AABB fully contains another AABB. Same as AABB::contains but accepts AABB extent parameters directly.

Trait Implementations

impl<T: Clone> Clone for AABB<T>

fn clone(&self) -> AABB<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for AABB<T>

impl<T: Debug> Debug for AABB<T>

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

Formats the value using the given formatter.

impl<T> Default for AABB<T> where
    T: IndexableNum, 

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq> Eq for AABB<T>

impl<T: Hash> Hash for AABB<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<AABB<T>> for AABB<T>

fn eq(&self, other: &AABB<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AABB<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for AABB<T>

impl<T> StructuralPartialEq for AABB<T>