Struct sark_grids::sparse_grid::SparseGrid

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

A sparse grid that stores elements in a BTreeMap.

Implementations

impl<T: Clone> SparseGrid<T>

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

Creates a new SparseGrid.

pub fn iter(&self) -> impl Iterator<Item = (&usize, &T)>

An iterator over all elements in the grid.

Yields (&usize,&mut T) where usize is the 1d position of the element in the grid.

pub fn iter_values(&self) -> impl Iterator<Item = &T>

An iterator over just the values in the grid.

Yields &T.

pub fn iter_values_mut(&mut self) -> impl Iterator<Item = &mut T>

A mutable iterator over just the values in the grid.

Yields &mut T.

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

A mutable iterator over all elements in the grid.

Yields (&usize,&mut T) where usize is the 1d position of the element in the grid.

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

A 2d iterator over all elements in the grid.

Yields (IVec2,&mut T) where IVec2 is the 2d position of the element in the grid.

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

A mutable iterator over all elements in the grid.

Yields (IVec,&mut T) where IVec2 is the 2d position of the element in the grid.

pub fn insert_row(
    &mut self,
    y: usize,
    row: impl IntoIterator<Item = T> + 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 IntoIterator<Item = T> + 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> + Iterator<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> + Iterator<Item = T>
)

Insert into a column of the grid starting from some point using an iterator.

Will insert up to the height of a column.

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

Remove the element/tile at the given position.

Returns the removed element if one was present.

pub fn remove_index(&mut self, index: usize) -> Option<T>

Remove the element/tile at the given 1d index.

Returns the removed element if one was present.

pub fn clear(&mut self)

Clears the grid, removing all elements.

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn size(&self) -> IVec2

pub fn len(&self) -> usize

How many tiles/elements are in the grid.

pub fn is_empty(&self) -> bool

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

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

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

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

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

Gets the index for a given side.

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

Returns true if the position is in the bounds of the grid. Note this doesn’t necessarily mean a tile exists at that point - just that it’s in bounds.

pub fn bounds(&self) -> GridRect

Returns the bounds of the grid.

pub fn insert_index(&mut self, index: usize, value: T) -> Option<T>

Insert a value in the grid at the given 1d index.

Returns None if no value was already present. Otherwise the old value is returned.

pub fn insert(&mut self, pos: impl GridPoint, value: T) -> Option<T>

Insert a value in the grid.

Returns None if no value was already present. Otherwise the old value is returned.

pub fn get_index(&self, index: usize) -> Option<&T>

Retrieve a value in the grid from it’s 1d index.

Returns None if there is no value at the index.

pub fn get_mut_index(&mut self, index: usize) -> Option<&mut T>

Retrieve a mutable value in the grid from it’s 1d index.

Returns None if there is no value at the index.

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

Retrieve a value in the grid from it’s 2d position.

Returns None if there is no value at the position, or if the position is out of bounds.

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

Retrieve a mutable value in the grid from it’s 2d position.

Returns None if there is no value at the position.

Trait Implementations

impl<T: Clone> Clone for SparseGrid<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SparseGrid<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for SparseGrid<T>

fn default() -> SparseGrid<T>

Returns the “default value” for a type.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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