Struct sark_grids::grid::Grid

source [−]

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

Expand description

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

source

impl<T: Clone> Grid<T>

source

pub fn new(value: T, size: [u32 ; 2]) -> Self

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

source

pub fn default(size: [u32 ; 2]) -> Self where
T: Default,

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

source

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

An iterator over all elements in the grid.

source

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

A mutable iterator over all elements in the grid.

source

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

An iterator over a single row of the grid.

Goes from left to right.

source

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.

source

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.

source

pub fn insert_row_at(&mut self, xy: [i32 ; 2], row: impl Iterator<Item = T>)

Insert into a row of the grid using an iterator.

Will insert up to the length of a row.

source

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.

source

pub fn insert_column_at(
 &mut self,
 xy: [i32 ; 2],
 column: impl IntoIterator<Item = T>
)

Insert into a column of the grid using an iterator.

Will insert up to the height of a column.

source

pub fn column_iter(&self, x: usize) -> StepBy<Iter<'_, T>>

An iterator over a single column of the grid.

Goes from bottom to top.

source

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.

source

pub fn len(&self) -> usize

How many tiles/elements are in the grid.

source

pub fn pos_to_index(&self, pos: [i32 ; 2]) -> usize

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

source

pub fn upos_to_index(&self, pos: [u32 ; 2]) -> usize

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

source

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

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

source

pub fn index_to_upos(&self, index: usize) -> UVec2

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

source

pub fn top_index(&self) -> usize

Returns the index of the top row.

source

pub fn bottom_index(&self) -> usize

Returns the index of the bottom row (0).

source

pub fn left_index(&self) -> usize

Returns the index of the left-most column (0).

source

pub fn right_index(&self) -> usize

Returns the index of the right-most column.

source

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

Get the position of a tile on the grid at the given pivot.

Note that for even-sized grids the “center” will be rounded down. For example, for a a 4x4 grid calling pivot_position(Pivot::Center) will return (1,1).

source

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

source

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.

source

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.

source

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.

source

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.

source

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.

source