Struct semeion::env::NeighborHood

pub struct NeighborHood<'a, I: Eq + Hash + Debug, K, C, T, E> { /* fields omitted */ }

The neighbor tiles of a specific entity.

Implementations

impl<'a, I: Eq + Hash + Debug, K, C, T, E> NeighborHood<'a, I, K, C, T, E>

pub fn bounds(&self) -> Bounds

Gets the bounds of this neighborhood.

pub fn tiles(&self) -> &Vec<TileView<'a, I, K, C, T, E>>

Gets the list of tiles included in this NeighborHood.

pub fn tile(&self, offset: Offset) -> &TileView<'a, I, K, C, T, E>

Gets the tile located at the given offset from the center of this NeighborHood. The NeighborHood is seen as a Torus from this method, therefore, out of bounds offsets will be translated considering that the NeighborHood edges are joined.

pub fn center(&self) -> &TileView<'a, I, K, C, T, E>

Gets the tile located in the center of this NeighborHood.

pub fn border(
    &self,
    offset: Offset,
    scope: Scope
) -> Option<Vec<&TileView<'a, I, K, C, T, E>>>

Gets a list of tiles that surround the tile T of this NeighborHood, located at a given Offset from the center tile, and according to the given Scope, that represents the distance from the tile T. The tiles are returned in arbitrary order. Returns None if any of the border tiles is out of the NeighborHood bounds for the given Scope.

Trait Implementations

impl<'a, I: Debug + Eq + Hash, K: Debug, C: Debug, T: Debug, E: Debug> Debug for NeighborHood<'a, I, K, C, T, E>

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

Formats the value using the given formatter.

impl<'a, I: Eq + Hash + Debug, K, C, T, E> From<Vec<TileView<'a, I, K, C, T, E>>> for NeighborHood<'a, I, K, C, T, E>

fn from(tiles: Vec<TileView<'a, I, K, C, T, E>>) -> Self

Constructs a new NeighborHood from a list of tiles that can encode a squared grid.