Struct bones_ecs::components::ComponentStore
source · pub struct ComponentStore<T: HasSchema> { /* private fields */ }
Expand description
A typed wrapper around UntypedComponentStore
.
Implementations§
source§impl<T: HasSchema> ComponentStore<T>
impl<T: HasSchema> ComponentStore<T>
sourcepub fn into_untyped(self) -> UntypedComponentStore
pub fn into_untyped(self) -> UntypedComponentStore
Converts to the internal, untyped ComponentStore
.
sourcepub fn from_untyped(untyped: UntypedComponentStore) -> Self
pub fn from_untyped(untyped: UntypedComponentStore) -> Self
Creates a ComponentStore
from an UntypedComponentStore
.
Panics
Panics if the schema doesn’t match T
.
sourcepub fn insert(&mut self, entity: Entity, component: T) -> Option<T>
pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>
Inserts a component for the given Entity
index.
Returns the previous component, if any.
sourcepub fn get(&self, entity: Entity) -> Option<&T>
pub fn get(&self, entity: Entity) -> Option<&T>
Gets an immutable reference to the component of Entity
.
sourcepub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>
pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>
Gets a mutable reference to the component of Entity
.
sourcepub fn get_mut_or_insert(
&mut self,
entity: Entity,
f: impl FnOnce() -> T
) -> &mut T
pub fn get_mut_or_insert( &mut self, entity: Entity, f: impl FnOnce() -> T ) -> &mut T
Get a mutable reference to component if it exists.
Otherwise inserts T
generated by calling parameter: f
.
sourcepub fn get_many_mut<const N: usize>(
&mut self,
entities: [Entity; N]
) -> [Option<&mut T>; N]
pub fn get_many_mut<const N: usize>( &mut self, entities: [Entity; N] ) -> [Option<&mut T>; N]
Get mutable references s to the component data for multiple entities at the same time.
Panics
This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.
sourcepub fn remove(&mut self, entity: Entity) -> Option<T>
pub fn remove(&mut self, entity: Entity) -> Option<T>
Removes the component of Entity
.
Returns Some(T)
if the entity did have the component.
Returns None
if the entity did not have the component.
Trait Implementations§
source§impl<'a, T: HasSchema> ComponentIterBitset<'a, T> for ComponentStore<T>
impl<'a, T: HasSchema> ComponentIterBitset<'a, T> for ComponentStore<T>
source§fn iter_with_bitset(
&self,
bitset: Rc<BitSetVec>
) -> ComponentBitsetIterator<'_, T>
fn iter_with_bitset( &self, bitset: Rc<BitSetVec> ) -> ComponentBitsetIterator<'_, T>
Iterates immutably over the components of this type where bitset
indicates the indices of entities.
Slower than iter()
but allows joining between multiple component types.
source§fn iter_with_bitset_optional(
&self,
bitset: Rc<BitSetVec>
) -> ComponentBitsetOptionalIterator<'_, T>
fn iter_with_bitset_optional( &self, bitset: Rc<BitSetVec> ) -> ComponentBitsetOptionalIterator<'_, T>
Iterates immutably over the components of this type where bitset
indicates the indices of entities where iterator returns an Option.
None is returned for entities in bitset when Component is not in ComponentStore
source§fn iter_mut_with_bitset(
&mut self,
bitset: Rc<BitSetVec>
) -> ComponentBitsetIteratorMut<'_, T>
fn iter_mut_with_bitset( &mut self, bitset: Rc<BitSetVec> ) -> ComponentBitsetIteratorMut<'_, T>
Iterates mutable over the components of this type where bitset
indicates the indices of entities.
Slower than iter()
but allows joining between multiple component types.
source§fn iter_mut_with_bitset_optional(
&mut self,
bitset: Rc<BitSetVec>
) -> ComponentBitsetOptionalIteratorMut<'_, T>
fn iter_mut_with_bitset_optional( &mut self, bitset: Rc<BitSetVec> ) -> ComponentBitsetOptionalIteratorMut<'_, T>
Iterates mutably over the components of this type where bitset
indicates the indices of entities where iterator returns an Option.
None is returned for entities in bitset when Component is not in [ComponentStore
source§fn bitset(&self) -> &BitSetVec
fn bitset(&self) -> &BitSetVec
Read the bitset containing the list of entites with this component type on it.
source§fn contains(&self, entity: Entity) -> bool
fn contains(&self, entity: Entity) -> bool
Check whether or not this component store has data for the given entity.
source§fn component_store(&self) -> &ComponentStore<T>
fn component_store(&self) -> &ComponentStore<T>
ComponentStore
for usage with generic types implementing ComponentIterBitset
.source§impl<T: HasSchema> Default for ComponentStore<T>
impl<T: HasSchema> Default for ComponentStore<T>
source§impl<T: HasSchema> TryFrom<UntypedComponentStore> for ComponentStore<T>
impl<T: HasSchema> TryFrom<UntypedComponentStore> for ComponentStore<T>
§type Error = SchemaMismatchError
type Error = SchemaMismatchError
Auto Trait Implementations§
impl<T> !RefUnwindSafe for ComponentStore<T>
impl<T> Send for ComponentStore<T>
impl<T> Sync for ComponentStore<T>
impl<T> Unpin for ComponentStore<T>where T: Unpin,
impl<T> !UnwindSafe for ComponentStore<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
source§fn from_world(_world: &World) -> T
fn from_world(_world: &World) -> T
Self
using data from the given World
.