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<P> Rectangle<P>where
P: Point,
impl<P> Rectangle<P>where P: Point,
sourcepub fn from_corners(corner_1: P, corner_2: P) -> Self
pub fn from_corners(corner_1: P, corner_2: P) -> Self
Creates a new rectangle defined by two corners.
sourcepub fn from_aabb(aabb: AABB<P>) -> Self
pub fn from_aabb(aabb: AABB<P>) -> Self
Creates a new rectangle defined by it’s [axis aligned bounding box(AABB).
Trait Implementations§
source§impl<P> Ord for Rectangle<P>where
P: Point + Ord,
impl<P> Ord for Rectangle<P>where P: Point + Ord,
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl<P> PartialEq<Rectangle<P>> for Rectangle<P>where
P: Point + PartialEq,
impl<P> PartialEq<Rectangle<P>> for Rectangle<P>where P: Point + PartialEq,
source§impl<P> PartialOrd<Rectangle<P>> for Rectangle<P>where
P: Point + PartialOrd,
impl<P> PartialOrd<Rectangle<P>> for Rectangle<P>where P: Point + PartialOrd,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
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 moresource§impl<P> PointDistance for Rectangle<P>where
P: Point,
impl<P> PointDistance for Rectangle<P>where P: Point,
source§fn distance_2(
&self,
point: &<Self::Envelope as Envelope>::Point
) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar
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
fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool
Returns
true
if a point is contained within this object. Read moresource§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>
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 moresource§impl<P> RTreeObject for Rectangle<P>where
P: Point,
impl<P> RTreeObject for Rectangle<P>where P: Point,
impl<P> Copy for Rectangle<P>where P: Point + Copy,
impl<P> Eq for Rectangle<P>where P: Point + Eq,
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more