Struct sark_grids::grid::Grid

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

A dense sized grid that stores it’s elements in a Vec.

Implementations

impl<T> Grid<T>

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

where T: Default + Clone,

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

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

where T: Clone,

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 width(&self) -> usize

pub fn height(&self) -> usize

pub fn size(&self) -> UVec2

pub fn len(&self) -> usize

How many tiles/elements are in the grid.

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

Get the position of the given pivot point on the grid.

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 in_bounds(&self, pos: impl GridPoint) -> bool

pub fn side_index(&self, side: Side) -> usize

Gets the index for a given side.

pub fn axis_size(&self, axis: usize) -> usize

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_rows( &self, range: impl RangeBounds<usize> ) -> impl DoubleEndedIterator<Item = &[T]>

Iterate over a range of rows.

Yields &[T] (Slice of T)

pub fn iter_rows_mut( &mut self, range: impl RangeBounds<usize> ) -> impl DoubleEndedIterator<Item = &mut [T]>

Iterate mutably over a range of rows.

Yields &mut [T] (Slice of mutable T)

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 axis_index(&self, axis: usize) -> usize

Final index along a given axis, where 0 == width, and 1 == height.

pub fn rect_iter( &self, range: impl RangeBounds<[i32; 2]> ) -> impl Iterator<Item = (IVec2, &T)>

An iterator over a rectangular portion of the grid defined by the given range.

Yields (IVec2, &T), where IVec2 is the corresponding position of the value in the grid.

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

Returns an iterator which enumerates the 2d position of every value in the grid.

Yields (IVec2, &T), where IVec2 is the corresponding position of the value in the grid.

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

Returns a mutable iterator which enumerates the 2d position of every value in the grid.

Yields (IVec2, &mut T), where IVec2 is the corresponding position of the value in the grid.

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

Retrieve a linear slice of the underlying grid data.

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

Retrieve a mutable linear slice of the underlying grid data.

pub fn bounds(&self) -> GridRect

Returns the bounds of the grid.

pub fn transform_lti(&self, xy: impl GridPoint) -> usize

Converts a 2d grid position to it’s corresponding 1D index. If a pivot was applied to the given grid point, it will be accounted for.

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

Converts a 1d index to it’s corresponding grid position.

pub fn transform_ltw(&self, xy: impl GridPoint) -> IVec2

Convert a point from grid space (bottom-left origin) to world space (center origin).

pub fn transform_wtl(&self, xy: impl GridPoint) -> IVec2

Convert a point from world space (center origin) to grid space (bottom-left origin).

pub fn pivoted_point(&self, xy: impl GridPoint) -> IVec2

Retrieve a grid position from a pivoted point.

If no pivot has been applied, the point will be returned directly.

Trait Implementations

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

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

Returns a copy 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

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<T: Eq> Eq for Grid<T>

impl<T> StructuralPartialEq for Grid<T>