Struct rstar::AABB

pub struct AABB<P> where
    P: Point,  { /* fields omitted */ }

An n-dimensional axis aligned bounding box (AABB).

An object's AABB is the smallest box totally encompassing an object while being aligned to the current coordinate system. Although these structures are commonly called bounding boxes, they exist in any dimension.

Note that AABBs cannot be inserted into r-trees. Use the Rectangle struct for this purpose.

Type arguments

P: The struct is generic over which point type is used. Using an n-dimensional point type will result in an n-dimensional bounding box.

Methods

impl<P> AABB<P> where
    P: Point, 

pub fn from_point(p: P) -> Self

Returns the AABB encompassing a single point.

pub fn lower(&self) -> P

Returns the AABB's lower corner.

This is the point contained within the AABB with the smallest coordinate value in each dimension.

pub fn upper(&self) -> P

Returns the AABB's upper corner.

This is the point contained within the AABB with the largest coordinate value in each dimension.

pub fn from_corners(p1: P, p2: P) -> Self

Creates a new AABB encompassing two points.

pub fn from_points<'a, I>(i: I) -> Self where
    I: IntoIterator<Item = &'a P> + 'a,
    P: 'a, 

Creates a new AABB encompassing a collection of points.

pub fn min_point(&self, point: &P) -> P

Returns the point within this AABB closest to a given point.

If point is contained within the AABB, point will be returned.

pub fn distance_2(&self, point: &P) -> P::Scalar

Returns the squared distance to the AABB's min_point.

Trait Implementations

impl<P> Envelope for AABB<P> where
    P: Point, 

type Point = P

The envelope's point type.

fn new_empty() -> Self

Creates a new, empty envelope that does not encompass any child.

fn contains_point(&self, point: &P) -> bool

Returns true if a point is contained within this envelope.

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

Returns true if another envelope is fully contained within self.

fn merge(&mut self, other: &Self)

Extends self to contain another envelope.

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

Returns the minimal envelope containing self and another envelope.

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

Sets self to the intersection of self and another envelope.

fn area(&self) -> P::Scalar

Returns this envelope's area. Must be at least 0.

fn distance_2(&self, point: &P) -> P::Scalar

Returns the euclidean distance to the envelope's border.

fn min_max_dist_2(&self, point: &P) -> <P as Point>::Scalar

Returns the squared min-max distance, a concept that helps to find nearest neighbors efficiently.

fn center(&self) -> Self::Point

Returns the envelope's center point.

fn intersection_area(&self, other: &Self) -> <Self::Point as Point>::Scalar

Returns the area of the intersection of self and another envelope.

fn margin_value(&self) -> P::Scalar

Returns a value proportional to the envelope's margin.

fn sort_envelopes<T: RTreeObject<Envelope = Self>>(
    axis: usize,
    envelopes: &mut [T]
)

Sorts a given set of objects with envelopes along one of their axis.

fn partition_envelopes<T: RTreeObject<Envelope = Self>>(
    axis: usize,
    envelopes: &mut [T],
    selection_size: usize
)

Partitions objects with an envelopes along a certain axis.

impl<P: Clone> Clone for AABB<P> where
    P: Point, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Ord> Ord for AABB<P> where
    P: Point, 

fn cmp(&self, other: &AABB<P>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<P> From<AABB<P>> for Rectangle<P> where
    P: Point, 

fn from(aabb: AABB<P>) -> Self

Performs the conversion.

impl<P: PartialOrd> PartialOrd<AABB<P>> for AABB<P> where
    P: Point, 

fn partial_cmp(&self, other: &AABB<P>) -> Option<Ordering>

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

fn lt(&self, other: &AABB<P>) -> bool

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

fn le(&self, other: &AABB<P>) -> bool

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

fn gt(&self, other: &AABB<P>) -> bool

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

fn ge(&self, other: &AABB<P>) -> bool

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

impl<P: PartialEq> PartialEq<AABB<P>> for AABB<P> where
    P: Point, 

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

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

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

This method tests for !=.

impl<P: Copy> Copy for AABB<P> where
    P: Point, 

impl<P: Eq> Eq for AABB<P> where
    P: Point, 

impl<P: Debug> Debug for AABB<P> where
    P: Point, 

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

Formats the value using the given formatter.