Struct bones_render::prelude::AtomicComponentStoreRef

pub struct AtomicComponentStoreRef<'a, T>where
    T: TypedEcsData,{ /* private fields */ }

A read-only borrow of AtomicComponentStore.

Implementations

impl<'a, T> AtomicComponentStoreRef<'a, T>where
    T: TypedEcsData,

pub fn get(&self, entity: Entity) -> Option<&T>

Gets an immutable reference to the component of Entity.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates immutably over all components of this type. Very fast but doesn’t allow joining with other component types.

pub 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.

pub fn bitset(&self) -> &BitSetVec

Read the bitset containing the list of entites with this component type on it.

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

Check whether or not this component store has data for the given entity.

Trait Implementations

impl<'a, 'q, T> QueryItem for &'a AtomicComponentStoreRef<'q, T>where
    T: TypedEcsData,

type Iter = ComponentBitsetIterator<'a, T>

The type of iterator this query item creates

fn apply_bitset(&self, bitset: &mut BitSetVec)

Modify the iteration bitset

fn iter_with_bitset(
    self,
    bitset: Rc<BitSetVec>
) -> <&'a AtomicComponentStoreRef<'q, T> as QueryItem>::Iter

Return an iterator over the provided bitset.

impl<'a, T> SystemParam for AtomicComponentStoreRef<'a, T>where
    T: TypedEcsData,

type State = AtomicComponentStore<T>

The intermediate state for the parameter, that may be extracted from the world.

type Param = AtomicComponentStoreRef<'p, T>

The type of the parameter, ranging over the lifetime of the intermediate state.

fn initialize(world: &mut World)

This will be called to give the parameter a chance to initialize it’s world storage.

fn get_state(
    world: &World
) -> <AtomicComponentStoreRef<'a, T> as SystemParam>::State

This is called to produce the intermediate state of the system parameter.

fn borrow(
    state: &mut <AtomicComponentStoreRef<'a, T> as SystemParam>::State
) -> <AtomicComponentStoreRef<'a, T> as SystemParam>::Param<'_>

This is used create an instance of the system parame, possibly borrowed from the intermediate parameter state.