Struct keeshond::scene::ComponentStore

pub struct ComponentStore<C: Component + 'static> { /* fields omitted */ }

Stores all instances of a Component for a given type, indexed based on the Entities they belong to.

Implementations

impl<C: Component + 'static> ComponentStore<C>

pub fn get_entity(&self, entity: &Entity) -> Option<&C>

Returns an immutable reference to the Component for the given Entity, or None if it does not exist.

pub fn get_entity_mut(&mut self, entity: &Entity) -> Option<&mut C>

Returns a mutable reference to the Component for the given Entity, or None if it does not exist.

pub fn clone_from_entity(&self, entity: &Entity) -> Option<C> where
    C: Clone, 

Returns a clone of the Component for the given Entity. This is useful for getting around issues with the Rust borrow checker preventing you from accessing more than one component in the store at a time.

pub fn set_entity(&mut self, entity: &Entity, component: C) -> bool

Sets the Component for the given Entity in the store. Useful to “commit” changes to a component that you cloned previously with [clone_from_entity()]. Returns true if there is a component for the given entity.

pub fn get_nth(&self, index: usize) -> Option<(Entity, &C)>

Returns an immutable reference to the “n-th” Component in the store. This is primarily useful for when you want to get the first, last, or random component, etc. The index you use here should not be cached, as the components may move around in the store. In most cases you should use [get_entity()] instead.

pub fn get_nth_mut(&mut self, index: usize) -> Option<(Entity, &mut C)>

Returns a mutable reference to the “n-th” Component in the store. This is primarily useful for when you want to get the first, last, or random component, etc. The index you use here should not be cached, as the components may move around in the store. In most cases you should use [get_entity_mut()] instead.

pub fn first(&self) -> Option<(Entity, &C)>

pub fn first_mut(&mut self) -> Option<(Entity, &mut C)>

pub fn count(&self) -> usize

Returns the number of Entities with this Component

pub fn contains(&self, entity: &Entity) -> bool

Returns true if there is a Component for the given Entity

pub fn sort<F: FnMut(&C, &C) -> Ordering>(&mut self, compare: F)

pub fn iter(&self) -> ComponentIter<'_, C>

Returns a ComponentIter that iterates through all Components in the store. Typically used in a DrawerSystem.

pub fn iter_mut(&mut self) -> ComponentIterMut<'_, C>

Returns a ComponentIterMut that iterates through all Components in the store. Typically used in a ThinkerSystem.

pub fn singleton(&self) -> Option<&C>

pub fn singleton_mut(&mut self) -> &mut C where
    C: Default, 

pub fn singleton_mut_or<F: FnMut() -> C>(&mut self, func: F) -> &mut C

Trait Implementations

impl<C: Debug + Component + 'static> Debug for ComponentStore<C>

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

Formats the value using the given formatter.