Struct sark_grids::sparse_grid::SparseGrid

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

A sparse grid that stores elements in a BTreeMap.

Implementations

impl<T: Clone> SparseGrid<T>

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

Creates a new SparseGrid.

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

An iterator over all elements in the grid.

Yields (&u32,&mut T) where u32 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(&self) -> impl Iterator<Item = &T>

A mutable iterator over just the values in the grid.

Yields &mut T.

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

A mutable iterator over all elements in the grid.

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

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

A 2d iterator over all elements in the grid.

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

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

A mutable iterator over all elements in the grid.

Yields (UVec,&mut T) where UVec2 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: [i32; 2],
    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: [i32; 2],
    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 remove(&mut self, pos: [u32; 2]) -> 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) -> u32

pub fn height(&self) -> u32

pub fn size(&self) -> UVec2

pub fn len(&self) -> usize

How many tiles/elements are in the grid.

pub fn is_empty(&self) -> bool

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

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

pub fn upos_to_index(&self, pos: [u32; 2]) -> 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 index_to_upos(&self, index: usize) -> UVec2

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

pub fn top_index(&self) -> usize

Returns the index of the top row.

pub fn bottom_index(&self) -> usize

Returns the index of the bottom row (0).

pub fn left_index(&self) -> usize

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

pub fn right_index(&self) -> usize

Returns the index of the right-most column.

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).

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

pub fn insert_index(&mut self, index: usize, 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 insert(&mut self, pos: [i32; 2], value: T) -> Option<T>

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: [i32; 2]) -> Option<&T>

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

Returns None if there is no value at the position.

pub fn get_mut(&mut self, pos: [i32; 2]) -> 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> 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 + Clone> Debug for SparseGrid<T>

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

Formats the value using the given formatter.

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

fn default() -> SparseGrid<T>

Returns the “default value” for a type.

impl<T: Clone> Index<[u32; 2]> for SparseGrid<T>

type Output = T

The returned type after indexing.

fn index(&self, index: [u32; 2]) -> &Self::Output

Performs the indexing (container[index]) operation.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

type Output = T

The returned type after indexing.

fn index(&self, index: UVec2) -> &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.