Struct dynec::system::iter::EntityIterator

pub struct EntityIterator<A: Archetype> { /* private fields */ }

Allows iterating all entities of an archetype.

Implementations

impl<A: Archetype> EntityIterator<A>

pub fn new(ealloc: Snapshot<A::RawEntity>) -> Self

Constructs an instance of EntityIterator that reads from the given allocator.

Although this function accepts an allocator shard, it actually reads the global buffer shared between shards, which is independent of the changes in the current shard. Hence, the iterator describe the state after the previous tick completes, which does not include newly initialized entities and includes those queued for deletion. This behavior is reasonable, because newly initialized entities should not be accessed at all, and those queued for deletion may have a finalizer or be given a finalizer when running later systems, so those queued for deletion are still included.

This function is typically called from the code generated by #[system].

pub fn entities(&self) -> impl Iterator<Item = TempRef<'_, A>>

Iterates over all entity IDs in this archetype.

pub fn chunks(&self) -> impl Iterator<Item = TempRefChunk<'_, A>> + '_

Iterates over all contiguous chunks of entity IDs.

pub fn entities_with<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl Iterator<Item = (TempRef<'_, A>, <IntoZ::IntoZip as Zip<A>>::Item)>

Iterates over all entities, yielding the components requested.

pub fn chunks_with<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl Iterator<Item = (TempRefChunk<'_, A>, <IntoZ::IntoZip as ZipChunked<A>>::Chunk)>

where IntoZ::IntoZip: ZipChunked<A>,

Iterates over all entities, yielding the components requested in contiguous chunks.

pub fn entities_with_chunked<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl Iterator<Item = (TempRef<'_, A>, <IntoZ::IntoZip as Zip<A>>::Item)>

where IntoZ::IntoZip: ZipChunked<A>,

Same as entities_with, but leverages chunked storages for better performance.

pub fn par_entities_with<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl ParallelIterator<Item = (TempRef<'_, A>, <IntoZ::IntoZip as Zip<A>>::Item)>

where IntoZ::IntoZip: Send, <IntoZ::IntoZip as Zip<A>>::Item: Send,

Iterates over all entities in parallel, yielding the components requested.

pub fn par_chunks_with<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl ParallelIterator<Item = (TempRefChunk<'_, A>, <IntoZ::IntoZip as ZipChunked<A>>::Chunk)>

where IntoZ::IntoZip: ZipChunked<A> + Send, <IntoZ::IntoZip as ZipChunked<A>>::Chunk: Send,

Iterates over all chunks of entities in parallel, yielding the components requested.

pub fn par_entities_with_chunked<IntoZ: IntoZip<A>>( &self, zip: IntoZ ) -> impl ParallelIterator<Item = (TempRef<'_, A>, <IntoZ::IntoZip as Zip<A>>::Item)>

where IntoZ::IntoZip: ZipChunked<A> + Send, <IntoZ::IntoZip as Zip<A>>::Item: Send,

Same as par_entities_with, but leverages chunked storages for better performance.