Struct Rect

pub struct Rect<T> {
    pub origin: Vec2<T>,
    pub size: Vec2<T>,
}

A rectangle on the integer grid.

Fields

origin: Vec2<T>

size: Vec2<T>

Implementations

impl<T> Rect<T>

pub const fn new(origin: Vec2<T>, size: Vec2<T>) -> Self

Creates a new rectangle.

impl<T> Rect<T>

where T: Copy,

pub const fn width(self) -> T

The rectangle’s width.

pub const fn height(self) -> T

The rectangle’s height.

pub const fn top_left(self) -> Vec2<T>

Fetches the top-left corner of the rectangle, i.e. the origin.

impl<T> Rect<T>

where T: Add<Output = T> + Copy,

pub fn bottom_right(self) -> Vec2<T>

Fetches the bottom-right corner of the rectangle.

impl<T> Rect<T>

where T: Add<Output = T> + Copy + Zero,

pub fn bottom_left(self) -> Vec2<T>

Fetches the bottom-left corner of the rectangle.

pub fn top_right(self) -> Vec2<T>

Fetches the top-right corner of the rectangle.

impl<T> Rect<T>

where T: Add<Output = T> + Div<Output = T> + Copy + Zero + Unity,

pub fn top_center(self) -> Vec2<T>

Fetches the top-center position of the rectangle.

pub fn center_left(self) -> Vec2<T>

Fetches the left-center position of the rectangle.

pub fn center_right(self) -> Vec2<T>

Fetches the right-center position of the rectangle.

pub fn bottom_center(self) -> Vec2<T>

Fetches the bottom-center position of the rectangle.

pub fn center(self) -> Vec2<T>

Fetches the center position of the rectangle.

impl<T> Rect<T>

where T: Mul<Output = T> + Copy,

pub fn area(self) -> T

The rectangle’s area.

impl<T> Rect<T>

where T: RemEuclid + Copy,

pub fn wrap(self, pos: Vec2<T>) -> Vec2<T>

Wraps a value to the rectangle’s bounds.

impl<T> Rect<T>

where T: Zero + Eq + Copy,

pub fn is_empty(self) -> bool

Whether this rectangle is empty.

impl<T> Rect<T>

where T: Add<Output = T> + Copy,

pub fn x_range(self) -> Range<T>

The range of x values.

pub fn y_range(self) -> Range<T>

The range of y values.

impl<T> Rect<T>

where T: Add<Output = T> + Copy, Range<T>: IteratorRandom<Item = T>,

pub fn sample_random_with(self, rng: &mut impl Rng) -> Option<Vec2<T>>

Samples a random position within the rectangle with the given rng.

pub fn sample_random(self) -> Option<Vec2<T>>

Samples a random position within the rectangle.

impl<T> Rect<T>

where T: Add<Output = T> + Ord + Copy,

pub fn contains(self, pos: Vec2<T>) -> bool

Checks whether the rectangle contains the given position.

pub fn intersects(self, other: Rect<T>) -> bool

Checks whether the rectangle intersects the given rectangle.

impl<T> Rect<T>

where T: Add<Output = T> + Sub<Output = T> + TryInto<usize> + Ord + Copy, T::Error: Debug,

pub fn index_of(self, pos: Vec2<T>) -> usize

Converts a position to an index.

Trait Implementations

impl<T: Clone> Clone for Rect<T>

fn clone(&self) -> Rect<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Rect<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Rect<T>

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<T: PartialEq> PartialEq for Rect<T>

fn eq(&self, other: &Rect<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Copy> Copy for Rect<T>

impl<T: Eq> Eq for Rect<T>

impl<T> StructuralPartialEq for Rect<T>