Struct Grid 

pub struct Grid<T> { /* private fields */ }

A data structure for storing a 2d sized grid of data.

Implementations

impl<T> Grid<T>

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

where T: Default + Clone,

pub fn filled(value: T, size: impl GridPoint) -> Self

where T: Clone,

Creates a new Grid with all elements set to the given default value.

pub fn insert_row(&mut self, y: usize, row: impl DoubleEndedIterator<Item = T>)

Insert into a row of the grid using an iterator.

Will insert up to the length of a row.

pub fn insert_row_at( &mut self, xy: impl GridPoint, row: impl Iterator<Item = T>, )

Insert into a row of the grid using an iterator.

Will insert up to the length of a row.

pub fn insert_column(&mut self, x: usize, column: impl IntoIterator<Item = T>)

Insert into a column of the grid using an iterator.

Will insert up to the height of a column.

pub fn insert_column_at( &mut self, xy: impl GridPoint, column: impl IntoIterator<Item = T>, )

Insert into a column of the grid using an iterator.

Will insert up to the height of a column.

pub fn get(&self, xy: impl GridPoint) -> Option<&T>

Try to retrieve the value at the given position.

Returns None if the position is out of bounds.

pub fn get_mut(&mut self, xy: impl GridPoint) -> Option<&mut T>

Try to retrieve the mutable value at the given position.

Returns None if the position is out of bounds.

pub fn iter(&self) -> impl DoubleEndedIterator<Item = &T>

An iterator over all elements in the grid.

pub fn iter_mut(&mut self) -> impl DoubleEndedIterator<Item = &mut T>

A mutable iterator over all elements in the grid.

pub fn iter_row(&self, y: usize) -> impl DoubleEndedIterator<Item = &T>

An iterator over a single row of the grid.

Goes from left to right.

pub fn iter_row_mut( &mut self, y: usize, ) -> impl DoubleEndedIterator<Item = &mut T>

A mutable iterator over a single row of the grid.

Iterates from left to right.

pub fn iter_column(&self, x: usize) -> impl DoubleEndedIterator<Item = &T>

An iterator over a single column of the grid.

Goes from bottom to top.

pub fn iter_column_mut( &mut self, x: usize, ) -> impl DoubleEndedIterator<Item = &mut T>

A mutable iterator over a single column of the grid.

Goes from bottom to top.

pub fn iter_xy(&self) -> impl Iterator<Item = (IVec2, &T)>

Iterate over all grid elements along with their 2d positions.

pub fn iter_xy_mut(&mut self) -> impl Iterator<Item = (IVec2, &mut T)>

Iterate over all grid elements along with their 2d positions.

pub fn iter_rect(&self, rect: GridRect) -> impl Iterator<Item = (IVec2, &T)>

Iterate over a rectangular section of grid elements along with their 2d positions.

pub fn iter_rect_mut( &mut self, rect: GridRect, ) -> impl Iterator<Item = (IVec2, &mut T)>

Iterate over a rectangular section of grid elements along with their 2d positions.

pub fn slice(&self) -> &[T]

Retrieve a slice of the underlying grid data.

pub fn slice_mut(&mut self) -> &mut [T]

Retrieve a mutable slice of the underlying grid data.

pub fn bounds(&self) -> GridRect

Returns the bounds of the grid, with it’s bottom left tile at world origin.

Trait Implementations

impl<T: Clone> Clone for Grid<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Grid<T>

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

Formats the value using the given formatter.

impl<T> Default for Grid<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Clone, P: GridPoint> Index<P> for Grid<T>

type Output = T

The returned type after indexing.

fn index(&self, p: P) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Clone> Index<usize> for Grid<T>

type Output = T

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, P: GridPoint> IndexMut<P> for Grid<T>

where T: Default + Clone,

fn index_mut(&mut self, index: P) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<usize> for Grid<T>

where T: Default + Clone,

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq> PartialEq for Grid<T>

fn eq(&self, other: &Grid<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> SizedGrid for Grid<T>

fn size(&self) -> UVec2

fn width(&self) -> usize

fn height(&self) -> usize

fn tile_count(&self) -> usize

fn in_bounds(&self, p: impl Into<PivotedPoint>) -> bool

fn transform_lti(&self, pos: impl Into<PivotedPoint>) -> usize

Transform a local 2d grid position to a 1d array index.

fn transform_itl(&self, i: usize) -> IVec2

Transform an 1d array index to a local 2d grid position.

fn try_transform_lti(&self, pos: impl Into<PivotedPoint>) -> Option<usize>

Attempt to transform a 2d grid position to a 1d array index, returning None if the position is out of bounds.

fn try_transform_itl(&self, i: usize) -> Option<IVec2>

Attempt to transform an 1d array index to a local 2d grid position. Returns None if the index is out of bounds.

fn bottom_index(&self) -> usize

Index of the bottom row of the rect.

fn top_index(&self) -> usize

Index of the top row of the rect.

fn left_index(&self) -> usize

Index of the left column of the rect.

fn right_index(&self) -> usize

The index of the right most column of the rect.

fn grid_bounds(&self) -> GridRect

fn iter_grid_points(&self) -> GridRectIter

impl<T: Eq> Eq for Grid<T>

impl<T> StructuralPartialEq for Grid<T>