Struct fenris_geometry::AxisAlignedBoundingBox

pub struct AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,{ /* private fields */ }

Implementations

impl<T, D> AxisAlignedBoundingBox<T, D>where
    T: Scalar + PartialOrd,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

pub fn new(min: OPoint<T, D>, max: OPoint<T, D>) -> Self

pub fn min(&self) -> &OPoint<T, D>

pub fn max(&self) -> &OPoint<T, D>

impl<T, D> AxisAlignedBoundingBox<T, D>where
    T: Real,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

pub fn enclose(&self, other: &AxisAlignedBoundingBox<T, D>) -> Self

Computes the minimal bounding box which encloses both self and other.

pub fn from_points<'a>(
    points: impl IntoIterator<Item = &'a OPoint<T, D>>
) -> Option<Self>

pub fn extents(&self) -> OVector<T, D>

pub fn max_extent(&self) -> T

pub fn center(&self) -> OPoint<T, D>

pub fn uniformly_scale(&self, scale: T) -> Self

Uniformly scales each axis by the given scale amount, with respect to the center of the box.

use nalgebra::{point, vector};
use matrixcompare::assert_matrix_eq;

let aabb = AxisAlignedBoundingBox::new(point![0.0, 0.0], point![1.0, 1.0]);
let scaled = aabb.uniformly_scale(0.5);

assert_matrix_eq!(scaled.min().coords, vector![0.25, 0.25], comp = float);
assert_matrix_eq!(scaled.max().coords, vector![0.75, 0.75], comp = float);

pub fn contains_point(&self, point: &OPoint<T, D>) -> bool

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

pub fn grow_uniformly(&self, distance: T) -> Self

Grows the bounding box by distance in all directions.

Examples

let aabb = AxisAlignedBoundingBox::new(point![0.0, 0.0], point![1.0, 1.0]);
let grown = aabb.grow_uniformly(1.0);
assert_eq!(grown.min(), &point![-1.0, -1.0]);
assert_eq!(grown.max(), &point![2.0, 2.0]);

pub fn corners_iter<'a>(&'a self) -> impl 'a + Iterator<Item = OPoint<T, D>>where
    DefaultAllocator: Allocator<usize, D>,

Creates an iterator over the corners of the bounding box.

pub fn closest_point_to(&self, point: &OPoint<T, D>) -> OPoint<T, D>

Computes the point in the bounding box closest to the given point.

pub fn dist_to(&self, point: &OPoint<T, D>) -> T

Computes the distance between the bounding box and the given point.

pub fn dist2_to(&self, point: &OPoint<T, D>) -> T

Computes the squared distance between the bounding box and the given point.

pub fn furthest_point_to(&self, point: &OPoint<T, D>) -> OPoint<T, D>where
    DefaultAllocator: Allocator<usize, D>,

Compute the point in the bounding box furthest away from the given point.

pub fn max_dist2_to(&self, point: &OPoint<T, D>) -> Twhere
    DefaultAllocator: Allocator<usize, D>,

The squared distance to the point in the bounding box furthest away from the given point.

Panics

Panic behavior is identical to furthest_point_to.

pub fn max_dist_to(&self, point: &OPoint<T, D>) -> Twhere
    DefaultAllocator: Allocator<usize, D>,

The distance to the point in the bounding box furthest away from the given point.

Panics

Panic behavior is identical to max_dist2_to.

Trait Implementations

impl<T, D> BoundedGeometry<T> for AxisAlignedBoundingBox<T, D>where
    T: Real,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

type Dimension = D

fn bounding_box(&self) -> AxisAlignedBoundingBox<T, D>

impl<T, D> Clone for AxisAlignedBoundingBox<T, D>where
    T: Scalar + Clone,
    D: DimName + Clone,
    DefaultAllocator: Allocator<T, D>,

fn clone(&self) -> AxisAlignedBoundingBox<T, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, D> Debug for AxisAlignedBoundingBox<T, D>where
    T: Scalar + Debug,
    D: DimName + Debug,
    DefaultAllocator: Allocator<T, D>,

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

Formats the value using the given formatter.

impl<'de, T, D> Deserialize<'de> for AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,
    OPoint<T, D>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, D> From<OPoint<T, D>> for AxisAlignedBoundingBox<T, D>where
    T: Scalar + PartialOrd,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

fn from(point: OPoint<T, D>) -> Self

Converts to this type from the input type.

impl<T, D> PartialEq<AxisAlignedBoundingBox<T, D>> for AxisAlignedBoundingBox<T, D>where
    T: Scalar + PartialEq,
    D: DimName + PartialEq,
    DefaultAllocator: Allocator<T, D>,

fn eq(&self, other: &AxisAlignedBoundingBox<T, 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<T, D> Serialize for AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,
    OPoint<T, D>: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, D> Copy for AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,
    OPoint<T, D>: Copy,

impl<T, D> Eq for AxisAlignedBoundingBox<T, D>where
    T: Scalar + Eq,
    D: DimName + Eq,
    DefaultAllocator: Allocator<T, D>,

impl<T, D> StructuralEq for AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,

impl<T, D> StructuralPartialEq for AxisAlignedBoundingBox<T, D>where
    T: Scalar,
    D: DimName,
    DefaultAllocator: Allocator<T, D>,