Struct sark_grids::grid::Grid

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

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

This grid assumes that [0,0] refers to the bottom-left most tile, and [width -1, height -1] refers to the top-right-most tile.

Implementations

impl<T: Clone> Grid<T>

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

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

pub fn default(size: impl Size2d) -> Self where
    T: Default, 

Creates a new Grid with all elements initialized to default values.

pub fn iter(&self) -> Iter<'_, T>

An iterator over all elements in the grid.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

A mutable iterator over all elements in the grid.

pub fn row_iter(&self, y: usize) -> Iter<'_, T>

An iterator over a single row of the grid.

Goes from left to right.

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

A mutable iterator over a single row of the grid.

Goes from left to right.

pub fn insert_row(&mut self, y: usize, 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_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 column_iter(&self, x: usize) -> StepBy<Iter<'_, T>>

An iterator over a single column of the grid.

Goes from bottom to top.

pub fn column_iter_mut(&mut self, x: usize) -> StepBy<IterMut<'_, T>>

A mutable iterator over a single column of the grid.

Goes from bottom to top.

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

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

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

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

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

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

pub fn in_bounds(&self, pos: IVec2) -> bool

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

Gets the index for a given side.

pub fn rect_iter<RANGE: RangeBounds<[i32; 2]>>(
    &self,
    range: RANGE
) -> 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 to_world_pivot(&self, pivot: Pivot) -> WorldGrid

Creates a crate::world_grid::WorldGrid from this grid with the given pivot. This can be used to translate between grid points and world space.

pub fn to_world(&self) -> WorldGrid

Creates a crate::world_grid::WorldGrid from this grid with the default bottom left pivot. This can be used to translate between grid points and world space.

pub fn slice<R: RangeBounds<usize>>(&self, slice: R) -> &[T]

pub fn slice_mut<R: RangeBounds<usize>>(&mut self, slice: R) -> &mut [T]

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

Iterate over a range of rows.

Yields &[T] (Slice of T)

pub fn rows_iter_mut(
    &mut self,
    range: impl RangeBounds<usize>
) -> Take<ChunksMut<'_, T>>

Iterate mutably over a range of rows.

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

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

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

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

Trait Implementations

impl<T: Clone + 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 + Clone> Debug for Grid<T>

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

Formats the value using the given formatter.

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

fn default() -> Grid<T>

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: Clone, P: GridPoint> IndexMut<P> for Grid<T> where
    T: Default, 

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

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

impl<T: Clone> IndexMut<usize> for Grid<T> where
    T: Default, 

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

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