Struct Rect

pub struct Rect { /* private fields */ }

A non-empty rectangle on the 2D grid.

Implementations

impl Rect

pub fn from_point<T>(point: T) -> Self

where T: Into<Vec2>,

Creates a new Rect around a single point.

The size will be (1, 1).

pub fn from_size<U, V>(top_left: U, size: V) -> Self

where U: Into<Vec2>, V: Into<Vec2>,

Creates a new Rect with the given position and size.

The minimum size will (1, 1).

pub fn from_corners<U, V>(a: U, b: V) -> Self

where U: Into<Vec2>, V: Into<Vec2>,

Creates a new Rect from two corners.

It can be any two opposite corners.

pub fn expand_to<R>(&mut self, other: R)

where R: Into<Rect>,

Grow this rectangle if necessary to include other.

pub fn expanded_to<R>(self, other: R) -> Self

where R: Into<Rect>,

Returns a new rectangle that includes both self and other.

pub fn side(self, orientation: Orientation) -> (usize, usize)

Returns the start and end coordinate of one side of this rectangle.

Both start and end are inclusive.

pub fn edge(self, side: Absolute) -> usize

Returns the coordinate of the given edge.

All edges are inclusive.

pub fn offset<V>(&mut self, offset: V)

where V: Into<Vec2>,

Adds the given offset to this rectangle.

pub fn size(self) -> Vec2

Returns the size of the rectangle.

pub fn width(self) -> usize

Returns the width of the rectangle.

pub fn height(self) -> usize

Returns the height of the rectangle.

pub fn top_left(self) -> Vec2

Returns the top-left corner.

This is inclusive.

pub fn bottom_right(self) -> Vec2

Returns the bottom-right corner.

This is inclusive.

pub fn top_right(self) -> Vec2

Returns the top-right corner.

This is inclusive.

pub fn bottom_left(self) -> Vec2

Returns the bottom-left corner.

This is inclusive.

pub fn top(self) -> usize

Returns the Y value of the top edge of the rectangle.

This is inclusive.

pub fn left(self) -> usize

Returns the X value of the left edge of the rectangle.

This is inclusive.

pub fn right(self) -> usize

Returns the X value of the right edge of the rectangle.

This is inclusive.

pub fn bottom(self) -> usize

Returns the Y value of the bottom edge of the rectangle.

This is inclusive.

pub fn surface(self) -> usize

Returns the surface (number of cells) covered by the rectangle.

pub fn contains(self, point: Vec2) -> bool

Checks if a point is in self.

Trait Implementations

impl<T> Add<T> for Rect

where T: Into<Vec2>,

type Output = Rect

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self

Performs the + operation.

impl Clone for Rect

fn clone(&self) -> Rect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rect

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

Formats the value using the given formatter.

impl Hash for Rect

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

fn eq(&self, other: &Rect) -> 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 Resolvable for Rect

fn from_config(config: &Config, context: &Context) -> Result<Self, Error>

where Self: Sized,

Build from a config (a JSON value).

fn from_any(any: Box<dyn Any>) -> Option<Self>

where Self: Sized + Any,

Build from an Any variable.

impl Copy for Rect

impl Eq for Rect

impl StructuralPartialEq for Rect