Struct planck_ecs::Components [−][src]
pub struct Components<T> { /* fields omitted */ }Expand description
Holds components of a given type indexed by Entity.
We do not check if the given entity is alive here, this should be done using
Entities.
Implementations
impl<T> Components<T>[src]
impl<T> Components<T>[src]pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>[src]
pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>[src]Inserts a component for the given Entity index.
Returns the previous component, if any.
pub fn get(&self, entity: Entity) -> Option<&T>[src]
pub fn get(&self, entity: Entity) -> Option<&T>[src]Gets an immutable reference to the component of Entity.
pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>[src]
pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>[src]Gets a mutable reference to the component of Entity.
pub fn remove(&mut self, entity: Entity) -> Option<T>[src]
pub fn remove(&mut self, entity: Entity) -> Option<T>[src]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.
pub fn iter(&'a self) -> impl Iterator<Item = &'a T>[src]
pub fn iter(&'a self) -> impl Iterator<Item = &'a T>[src]Iterates immutably over all components of this type. Very fast but doesn’t allow joining with other component types.
pub fn iter_mut(&'a mut self) -> impl Iterator<Item = &'a mut T>[src]
pub fn iter_mut(&'a mut self) -> impl Iterator<Item = &'a mut T>[src]Iterates mutably over all components of this type. Very fast but doesn’t allow joining with other component types.
pub fn iter_with_bitset(
&'a self,
bitset: Rc<Vec<[u32; 8], Global>>
) -> ComponentIterator<'a, T>ⓘNotable traits for ComponentIterator<'a, T>
impl<'a, T> Iterator for ComponentIterator<'a, T> type Item = Option<&'a T>;[src]
pub fn iter_with_bitset(
&'a self,
bitset: Rc<Vec<[u32; 8], Global>>
) -> ComponentIterator<'a, T>ⓘNotable traits for ComponentIterator<'a, T>
impl<'a, T> Iterator for ComponentIterator<'a, T> type Item = Option<&'a T>;[src]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.
pub fn iter_mut_with_bitset(
&'a mut self,
bitset: Rc<Vec<[u32; 8], Global>>
) -> ComponentIteratorMut<'a, T>ⓘNotable traits for ComponentIteratorMut<'a, T>
impl<'a, T> Iterator for ComponentIteratorMut<'a, T> type Item = Option<&'a mut T>;[src]
pub fn iter_mut_with_bitset(
&'a mut self,
bitset: Rc<Vec<[u32; 8], Global>>
) -> ComponentIteratorMut<'a, T>ⓘNotable traits for ComponentIteratorMut<'a, T>
impl<'a, T> Iterator for ComponentIteratorMut<'a, T> type Item = Option<&'a mut T>;[src]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.
pub fn bitset(&self) -> &Vec<[u32; 8], Global>[src]
pub fn bitset(&self) -> &Vec<[u32; 8], Global>[src]Returns the bitset indicating which entity indices have a component
associated to them.
Useful to build conditions between multiple Components’ bitsets.
For example, take two bitsets from two different Components types.
Then, bitset1.clone().bit_and(bitset2);
And finally, you can use bitset1 in iter_with_bitset and iter_mut_with_bitset.
This will iterate over the components of the entity only for entities that have both
components.
Trait Implementations
impl<T> Default for Components<T> where
T: 'static, [src]
impl<T> Default for Components<T> where
T: 'static, [src]pub fn default() -> Components<T>[src]
pub fn default() -> Components<T>[src]Returns the “default value” for a type. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Components<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Components<T> where
T: Send,
T: Send,
impl<T> Sync for Components<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Components<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Components<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]
pub fn borrow_mut(&mut self) -> &mut T[src]Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any, pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any(&self) -> &(dyn Any + 'static)Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more