Struct SpatialHashGrid 

pub struct SpatialHashGrid<D: Sized> { /* private fields */ }

Spatial hash data structure. see crate docs for usage.

Implementations

impl<D: Sized> SpatialHashGrid<D>

pub fn new<V>(x: usize, y: usize, z: usize, filler: V) -> Self

where V: FnMut() -> D,

x,y,z set the dimentsions, filler is a function that is used to initialize contents.

pub fn size(&self) -> Vector3<usize>

Get the size/bounds of the area under spatial hash.

pub fn get_mut(&mut self, idx: usize) -> Option<&mut D>

Safely retrieve element by index, will do runtime OOB checks

pub fn get(&mut self, idx: usize) -> Option<&D>

Safely retrieve element by index, will do runtime OOB checks

pub fn pos_to_index(&self, v: Vector3<u32>) -> Option<usize>

Convert given position into index in this spatial hash grid

pub fn iter_cube_indices( &self, min: Vector3<u32>, max: Vector3<u32>, ) -> BoxIdxIterator

Iterate over cube indices in given bounds [min, max]

pub fn iter_cubes( &self, min: Vector3<u32>, max: Vector3<u32>, ) -> BoxIterator<'_, D>

Iterate over cubes in given bounds [min, max] inside the main cube in read only state

pub fn iter_cubes_mut( &mut self, min: Vector3<u32>, max: Vector3<u32>, ) -> BoxIteratorMut<'_, D>

Iterate over cubes in given bounds [min, max] in read and write state.

Trait Implementations

impl<D: Debug> Debug for SpatialHashGrid<D>

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

Formats the value using the given formatter.

impl<D: Sized> Index<Vector3<u32>> for SpatialHashGrid<D>

fn index(&self, index: Vector3<u32>) -> &Self::Output

Retrieve reference to element by position

type Output = D

The returned type after indexing.

impl<D: Sized> Index<usize> for SpatialHashGrid<D>

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

Retrieve reference to element by index

type Output = D

The returned type after indexing.

impl<D: Sized> IndexMut<Vector3<u32>> for SpatialHashGrid<D>

fn index_mut(&mut self, index: Vector3<u32>) -> &mut Self::Output

Retrieve mutable reference to element by position

impl<D: Sized> IndexMut<usize> for SpatialHashGrid<D>

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

Retrieve mutable reference to element by index