Struct minutiae::container::EntityContainer

pub struct EntityContainer<C: CellState, E: EntityState<C>, M: MutEntityState> {
    pub entities: Slab<(Entity<C, E, M>, usize)>,
    pub positions: Vec<Vec<usize>>,
}

Data structure holding all of the universe's entities. The entities and their state are held in a vector of EntitySlots, each of which either holds an entity or the index of the next empty slot. Using this method, it's possible to add/remove entities from anywhere in the container without causing any allocations.

A second internal structure is used to map universe indexes to entity indexes; it holds the entity indexes of all entities that reside in each universe index.

Fields

entities: Slab<(Entity<C, E, M>, usize)>

(entity, universe_ix)

positions: Vec<Vec<usize>>

A mapping of universe index to entity index

Methods

impl<C: CellState, E: EntityState<C>, M: MutEntityState> EntityContainer<C, E, M>

pub fn new(universe_size: usize) -> Self

pub fn insert(
    &mut self,
    entity: Entity<C, E, M>,
    universe_index: usize
) -> usize

Inserts an entity into the container, returning its index

pub fn remove(&mut self, entity_index: usize) -> Entity<C, E, M>

Removes an entity from the container, returning it along with its current index in the universe.

pub unsafe fn get(&self, index: usize) -> &Entity<C, E, M>

Returns a reference to the entity contained at the supplied index. Will cause undefined behavior in release mode and panic in debug mode ifthe index is out of bounds or the slot at the specified index is empty.

pub unsafe fn get_mut(&mut self, index: usize) -> &mut Entity<C, E, M>

Returns a mutable reference to the entity contained at the supplied index. Will cause undefined behavior in release mode and panic in debug mode ifthe index is out of bounds or the slot at the specified index is empty.

pub fn get_verify(
    &self,
    index: usize,
    uuid: Uuid
) -> Option<(&Entity<C, E, M>, usize)>

Checks if 1) an entity exists at the provided index and 2) that its UUID matches the supplied UUID. If so, returns a reference to the contained entity and its corresponding universe index.

pub fn get_verify_mut(
    &mut self,
    index: usize,
    uuid: Uuid
) -> Option<(&mut Entity<C, E, M>, usize)>

Checks if 1) an entity exists at the provided index and 2) that its UUID matches the supplied UUID. If so, returns the a mutable reference to the contained entity and its corresponding universe index.

pub fn move_entity(&mut self, entity_index: usize, dst_universe_index: usize)

Moves an entity from one location in the universe to another. This function assumes that the supplied index is occupied and that the destination index is sane.

pub fn iter<'a>(
    &'a self
) -> impl Iterator<Item = (&Entity<C, E, M>, usize, usize)>

Creates an iterator over the entities contained within the container with the format (Entity, entity_index, universe_index).

pub fn get_position_index(&self, entity_index: usize) -> usize

Creates a mutable iterator over the entities contained within the container with the format (Entity, entity_index, universe_index). Returns the position of the entity with the given entity index.

pub fn get_entities_at(&self, universe_index: usize) -> &[usize]

Returns a reference to the slice of all the entity_indexes of all entities at a certain universe index.

pub fn len(&self) -> usize

Trait Implementations

impl<C: Clone + CellState, E: Clone + EntityState<C>, M: Clone + MutEntityState> Clone for EntityContainer<C, E, M>

fn clone(&self) -> EntityContainer<C, E, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + CellState, E: Debug + EntityState<C>, M: Debug + MutEntityState> Debug for EntityContainer<C, E, M>

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

Formats the value using the given formatter.