Struct rstar::primitives::Rectangle

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

An n-dimensional rectangle defined by its two corners.

This rectangle can be directly inserted into an r-tree.

Note: Despite being called rectangle, this struct can be used with more than two dimensions by using an appropriate point type.

Type parameters

P: The rectangle's Point type.

Implementations

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

pub fn from_corners(corner_1: P, corner_2: P) -> Self

Creates a new rectangle defined by two corners.

pub fn from_aabb(aabb: AABB<P>) -> Self

Creates a new rectangle defined by it's axis aligned bounding box.

pub fn lower(&self) -> P

Returns the rectangle's lower corner.

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

pub fn upper(&self) -> P

Returns the rectangle's upper corner.

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

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

pub fn nearest_point(&self, query_point: &P) -> P

Returns the nearest point within this rectangle to a given point.

If query_point is contained within this rectangle, query_point is returned.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

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

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

Performs the conversion.

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]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: PartialEq> PartialEq<Rectangle<P>> for Rectangle<P> where
    P: Point, 

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

impl<P> PointDistance for Rectangle<P> where
    P: Point, 

fn distance_2(
    &self,
    point: &<Self::Envelope as Envelope>::Point
) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object or None if the distance is larger than a given maximum value.

impl<P> RTreeObject for Rectangle<P> where
    P: Point, 

type Envelope = AABB<P>

The object's envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object's envelope.

impl<P> StructuralEq for Rectangle<P> where
    P: Point, 

impl<P> StructuralPartialEq for Rectangle<P> where
    P: Point,