Struct fj_math::Aabb

#[repr(C)]
pub struct Aabb<const D: usize> {
    pub min: Point<D>,
    pub max: Point<D>,
}

An axis-aligned bounding box (AABB)

Fields

min: Point<D>

The minimum coordinates of the AABB

max: Point<D>

The maximum coordinates of the AABB

Implementations

impl<const D: usize> Aabb<D>

pub fn contains(&self, point: impl Into<Point<D>>) -> bool

Determine whether the AABB contains a given point

impl Aabb<2>

pub fn from_points(
    points: impl IntoIterator<Item = impl Into<Point<2>>>
) -> Self

Construct a 2-dimensional AABB from a list of points

The resulting AABB will contain all the points.

pub fn from_parry(aabb: Aabb) -> Self

Construct a 2-dimensional AABB from a Parry AABB

Examples found in repository

src/aabb.rs (line 133)

    fn from(aabb: parry2d_f64::bounding_volume::Aabb) -> Self {
        Self::from_parry(aabb)
    }

impl Aabb<3>

pub fn from_points(
    points: impl IntoIterator<Item = impl Into<Point<3>>>
) -> Self

Construct a 3-dimensional AABB from a list of points

The resulting AABB will contain all the points.

pub fn from_parry(aabb: Aabb) -> Self

Construct a 3-dimensional AABB from a Parry AABB

Examples found in repository

src/aabb.rs (line 122)

    pub fn include_point(self, point: &Point<3>) -> Self {
        let mut aabb = self.to_parry();
        aabb.take_point(point.to_na());

        Self::from_parry(aabb)
    }

    /// Merge this AABB with another
    pub fn merged(&self, other: &Self) -> Self {
        self.to_parry().merged(&other.to_parry()).into()
    }
}

impl From<parry2d_f64::bounding_volume::Aabb> for Aabb<2> {
    fn from(aabb: parry2d_f64::bounding_volume::Aabb) -> Self {
        Self::from_parry(aabb)
    }
}

impl From<parry3d_f64::bounding_volume::Aabb> for Aabb<3> {
    fn from(aabb: parry3d_f64::bounding_volume::Aabb) -> Self {
        Self::from_parry(aabb)
    }

pub fn to_parry(self) -> Aabb

Convert the AABB to a Parry AABB

Examples found in repository

src/aabb.rs (line 104)

    pub fn vertices(&self) -> [Point<3>; 8] {
        self.to_parry().vertices().map(Into::into)
    }

    /// Compute the center point of the AABB
    pub fn center(&self) -> Point<3> {
        self.to_parry().center().into()
    }

    /// Compute the size of the AABB
    pub fn size(&self) -> Vector<3> {
        self.to_parry().extents().into()
    }

    /// Compute an AABB that includes an additional point
    pub fn include_point(self, point: &Point<3>) -> Self {
        let mut aabb = self.to_parry();
        aabb.take_point(point.to_na());

        Self::from_parry(aabb)
    }

    /// Merge this AABB with another
    pub fn merged(&self, other: &Self) -> Self {
        self.to_parry().merged(&other.to_parry()).into()
    }

pub fn vertices(&self) -> [Point<3>; 8]

Access the vertices of the AABB

pub fn center(&self) -> Point<3>

Compute the center point of the AABB

pub fn size(&self) -> Vector<3>

Compute the size of the AABB

pub fn include_point(self, point: &Point<3>) -> Self

Compute an AABB that includes an additional point

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

Merge this AABB with another

Trait Implementations

impl<const D: usize> Clone for Aabb<D>

fn clone(&self) -> Aabb<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for Aabb<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for Aabb<D>

fn default() -> Aabb<D>

Returns the “default value” for a type.

impl From<Aabb> for Aabb<2>

fn from(aabb: Aabb) -> Self

Converts to this type from the input type.

impl From<Aabb> for Aabb<3>

fn from(aabb: Aabb) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for Aabb<D>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<const D: usize> Ord for Aabb<D>

fn cmp(&self, other: &Aabb<D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<const D: usize> PartialEq<Aabb<D>> for Aabb<D>

fn eq(&self, other: &Aabb<D>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const D: usize> PartialOrd<Aabb<D>> for Aabb<D>

fn partial_cmp(&self, other: &Aabb<D>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const D: usize> Copy for Aabb<D>

impl<const D: usize> Eq for Aabb<D>

impl<const D: usize> StructuralEq for Aabb<D>

impl<const D: usize> StructuralPartialEq for Aabb<D>