Struct quadtree_rs::area::Area

pub struct Area<U> where
    U: PrimInt + Default + PartialOrd,  { /* fields omitted */ }

A rectangular region in 2d space.

Lightweight, should be passed by value. Defined by its top-left anchor, width, and height.

NB:

• The top-left anchor can be any valid (U, U) coordinate, positive or negative, in any quadrant.
• The width and height must both be positive and nonzero.

Methods

impl<U> Area<U> where
    U: PrimInt + Default, 

pub fn anchor(&self) -> Point<U>

The top-left coordinate (anchor) of the region.

pub fn width(&self) -> U

The width of the region.

pub fn height(&self) -> U

The height of the region.

pub fn top_edge(&self) -> U

The coordinate of the top edge of the region.

pub fn bottom_edge(&self) -> U

The coordinate of the bottom edge of the region.

pub fn left_edge(&self) -> U

The coordinate of the left edge of the region.

pub fn right_edge(&self) -> U

The coordinate of the right edge of the region.

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

Whether or not an area intersects another area.

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

Whether or not an area wholly contains another area.

pub fn contains_pt(self, pt: Point<U>) -> bool

Whether or not an area contains a point.

Trait Implementations

impl<U: Copy> Copy for Area<U> where
    U: PrimInt + Default + PartialOrd, 

impl<U: PartialEq> PartialEq<Area<U>> for Area<U> where
    U: PrimInt + Default + PartialOrd, 

fn eq(&self, other: &Area<U>) -> bool

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

fn ne(&self, other: &Area<U>) -> bool

This method tests for !=.

impl<U: Eq> Eq for Area<U> where
    U: PrimInt + Default + PartialOrd, 

impl<U: Clone> Clone for Area<U> where
    U: PrimInt + Default + PartialOrd, 

fn clone(&self) -> Area<U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U> Into<((U, U), (U, U))> for Area<U> where
    U: PrimInt + Default, 

fn into(self) -> ((U, U), (U, U))

Performs the conversion.

impl<U: Hash> Hash for Area<U> where
    U: PrimInt + Default + PartialOrd, 

fn hash<__HU: Hasher>(&self, state: &mut __HU)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<U> Debug for Area<U> where
    U: PrimInt + Default + Debug, 

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

Formats the value using the given formatter.