Struct sark_grids::geometry::GridRect

pub struct GridRect {
    pub center: IVec2,
    /* private fields */
}

A rectangle of points on a grid.

Fields

center: IVec2

Implementations

impl GridRect

pub fn new(center: impl GridPoint, size: impl GridPoint) -> GridRect

pub fn origin(size: impl GridPoint) -> Self

Create a grid rect with it’s center set to 0,0

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn from_points(a: impl GridPoint, b: impl GridPoint) -> GridRect

Create a grid rect from a min and max position.

pub fn from_bl(pos: impl GridPoint, size: impl GridPoint) -> GridRect

Create a rect with the bottom left corner at the given position.

pub fn min(&self) -> Vec2

Retrieve the bottom-left-most point of the rect

pub fn max(&self) -> Vec2

Retrieve the top-right-most point of the rect

pub fn min_i(&self) -> IVec2

Retrieve the bottom-left-most point of the rect as a grid position

pub fn max_i(&self) -> IVec2

Retrieve the top-right-most point of the rect as a grid position

pub fn min_max_i(&self) -> [IVec2; 2]

pub fn size(&self) -> IVec2

pub fn pivot_point(&self, pivot: Pivot) -> IVec2

Retrieve the position of a given corner of the rect

pub fn resized(&self, amount: impl GridPoint) -> GridRect

Return a rect with the same center but resized by the given amount on each axis

pub fn pivoted(&self, pivot: Pivot) -> GridRect

Returns a rect adjusted to the given pivot.

pub fn translated(&self, xy: impl GridPoint) -> GridRect

Returns a rect with it’s position adjusted by the given amount

pub fn contains(&self, p: impl GridPoint) -> bool

Check if a given point lies inside the rect

pub fn contains_rect(&self, rect: GridRect) -> bool

Returns true if the given rect is entirely contained within this one.

pub fn overlaps(&self, other: GridRect) -> bool

Check if any part of a rect overlaps another

pub fn envelope_point(&mut self, point: impl GridPoint)

Adjusts a single corner of the rect to contain the given point if it isn’t already.

pub fn envelope_rect(&mut self, rect: GridRect)

pub fn corners(&self) -> Corners

Returns the 4 corners of the rect, which can be accessed by index or name.

Order is BottomLeft, TopLeft, TopRight, BottomRight

pub fn iter_border(&self) -> BorderIterator

Returns an iterator that visits the position of every border tile in the rect.

pub fn clipped(&self, clipper: GridRect) -> GridRect

Returns a rect clipped by the bounds of the given rect

Trait Implementations

impl Clone for GridRect

fn clone(&self) -> GridRect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GridRect

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

Formats the value using the given formatter.

impl Default for GridRect

fn default() -> GridRect

Returns the “default value” for a type.

impl Display for GridRect

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

Formats the value using the given formatter.

impl GridShape for GridRect

fn iter(&self) -> GridShapeIterator

fn pos(&self) -> IVec2

fn set_pos(&mut self, pos: IVec2)

fn bounds(&self) -> GridRect

Get a rect encompassing the entire shape

impl IntoIterator for GridRect

type Item = IVec2

The type of the elements being iterated over.

type IntoIter = GridRectIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for GridRect

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

impl StructuralPartialEq for GridRect