Struct quadtree_rs::area::Area

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

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.

Implementations

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> Clone for Area<U>where U: PrimInt + Default + PartialOrd + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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.

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

Why this custom From<>? Useful for type coercion:

use quadtree_rs::{area::{Area, AreaBuilder}, point::Point};

let area: Area<_> = AreaBuilder::default()
    .anchor(Point{x:1, y:2})
    .dimensions((3,4))
    .build().unwrap();
let (anchor, dims) = area.into();
assert_eq!(anchor, (1,2));
assert_eq!(dims, (3,4));

fn from(value: Area<U>) -> Self

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

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