Struct rstar::primitives::Rectangle

source · [−]

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

Expand description

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

source

impl Rectangle where
P: Point,

source

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

Creates a new rectangle defined by two corners.

source

pub fn from_aabb(aabb: AABB) -> Self

Creates a new rectangle defined by it’s [axis aligned bounding box(AABB).

source

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.

source

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.

source

impl Rectangle where
P: Point,

source

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

source

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

source

fn clone(&self) -> Rectangle

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn from(aabb: AABB) -> Self

Converts to this type from the input type.

source

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

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

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

source

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

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

source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl PointDistance for Rectangle where
P: Point,

source

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

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

source

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

Returns true if a point is contained within this object. Read more

source

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. Read more

source

impl RTreeObject for Rectangle where
P: Point,

type Envelope = AABB

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the object’s dimensionality. Read more

source

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

Returns the object’s envelope. Read more

source

impl StructuralPartialEq for Rectangle where
P: Point,

Auto Trait Implementations

impl RefUnwindSafe for Rectangle where
P: RefUnwindSafe,

impl Send for Rectangle where
P: Send,

impl Sync for Rectangle where
P: Sync,

impl Unpin for Rectangle where
P: Unpin,

impl UnwindSafe for Rectangle where
P: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rstar::primitives::Rectangle

Type parameters

Implementations

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

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

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

pub fn lower(&self) -> P

pub fn upper(&self) -> P

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

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

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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>

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

type Envelope = AABB<P>

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

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

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

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

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

Auto Trait Implementations

impl<P> RefUnwindSafe for Rectangle<P> where P: RefUnwindSafe,

impl<P> Send for Rectangle<P> where P: Send,

impl<P> Sync for Rectangle<P> where P: Sync,

impl<P> Unpin for Rectangle<P> where P: Unpin,

impl<P> UnwindSafe for Rectangle<P> where P: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

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

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

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

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

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

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>

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

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

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

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

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

impl<P> RefUnwindSafe for Rectangle<P> where
P: RefUnwindSafe,

impl<P> Send for Rectangle<P> where
P: Send,

impl<P> Sync for Rectangle<P> where
P: Sync,

impl<P> Unpin for Rectangle<P> where
P: Unpin,

impl<P> UnwindSafe for Rectangle<P> where
P: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,