Struct scoundrel::SparseSet

pub struct SparseSet<T> { /* private fields */ }

Default component storage.

Implementations

impl<T> SparseSet<T>

pub fn as_slice(&self) -> &[T]

Returns a slice of all the components in this storage.

impl<T> SparseSet<T>

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

Returns true if entity owns a component in this storage.

pub fn len(&self) -> usize

Returns the length of the storage.

pub fn is_empty(&self) -> bool

Returns true if the storage’s length is 0.

impl<T> SparseSet<T>

pub fn index_of(&self, entity: EntityId) -> Option<usize>

Returns the index of entity’s component in the dense and data vectors.
This index is only valid for this storage and until a modification happens.

pub unsafe fn index_of_unchecked(&self, entity: EntityId) -> usize

Returns the index of entity’s component in the dense and data vectors.
This index is only valid for this storage and until a modification happens.

Safety

entity has to own a component of this type.
The index is only valid until a modification occurs in the storage.

pub fn id_at(&self, index: usize) -> Option<EntityId>

Returns the EntityId at a given index.

impl<T> SparseSet<T>

pub fn remove(&mut self, entity: EntityId) -> Option<T> where
    T: 'static, 

Removes entity’s component from this storage.

pub fn delete(&mut self, entity: EntityId) -> bool where
    T: 'static, 

Deletes entity’s component from this storage.

impl<T> SparseSet<T>

pub fn is_inserted(&self, entity: EntityId) -> bool

Returns true if entity’s component was inserted since the last clear_inserted or clear_all_inserted call.
Returns false if entity does not have a component in this storage.

pub fn is_modified(&self, entity: EntityId) -> bool

Returns true if entity’s component was modified since the last clear_modified or clear_all_modified call.
Returns false if entity does not have a component in this storage.

pub fn is_inserted_or_modified(&self, entity: EntityId) -> bool

Returns true if entity’s component was inserted or modified since the last clear call.
Returns false if entity does not have a component in this storage.

pub fn deleted(&self) -> &[(EntityId, T)]

Returns the deleted components of a storage tracking deletion.

Panics

• Storage does not track deletion. Start tracking by calling track_deletion or track_all.

pub fn removed(&self) -> &[EntityId]

Returns the ids of removed components of a storage tracking removal.

Panics

• Storage does not track removal. Start tracking by calling track_removal or track_all.

pub fn removed_or_deleted(&self) -> impl Iterator<Item = EntityId>

Returns the ids of removed or deleted components of a storage tracking removal and/or deletion.

Panics

• Storage does not track removal nor deletion. Start tracking by calling track_removal, track_deletion or track_all.

pub fn take_deleted(&mut self) -> Vec<(EntityId, T), Global>

Takes ownership of the deleted components of a storage tracking deletion.

Panics

• Storage does not track deletion. Start tracking by calling track_deletion or track_all.

pub fn take_removed(&mut self) -> Vec<EntityId, Global>

Takes ownership of the ids of removed components of a storage tracking removal.

Panics

• Storage does not track removal. Start tracking by calling track_removal or track_all.

pub fn take_removed_and_deleted(
    &mut self
) -> (Vec<EntityId, Global>, Vec<(EntityId, T), Global>)

Takes ownership of the removed and deleted components of a storage tracking removal and/or deletion.

Panics

• Storage does not track removal nor deletion. Start tracking by calling track_removal, track_deletion or track_all.

pub fn clear_inserted(&mut self, entity: EntityId)

Removes the inserted flag on entity’s component.

Panics

• Storage does not track insertion. Start tracking by calling track_insertion or track_all.

pub fn clear_all_inserted(&mut self)

Removes the inserted flag on all components of this storage.

Panics

• Storage does not track insertion. Start tracking by calling track_insertion or track_all.

pub fn clear_modified(&mut self, entity: EntityId)

Removes the modified flag on entity’s component.

Panics

• Storage does not track modification. Start tracking by calling track_modification or track_all.

pub fn clear_all_modified(&mut self)

Removes the modified flag on all components of this storage.

Panics

• Storage does not track modification. Start tracking by calling track_modification or track_all.

pub fn clear_inserted_and_modified(&mut self, entity: EntityId)

Removes the inserted and modified flags on entity’s component.

Panics

• Storage does not track insertion not modification. Start tracking by calling track_insertion, track_modification or track_all.

pub fn clear_all_inserted_and_modified(&mut self)

Removes the inserted and modified flags on all components of this storage.

Panics

• Storage does not track insertion not modification. Start tracking by calling track_insertion, track_modification or track_all.

pub fn track_insertion(&mut self) -> &mut SparseSet<T>

Flags components when they are inserted.
To check the flag use is_inserted, is_inserted_or_modified or iterate over the storage after calling inserted.
To clear the flag use clear_inserted or clear_all_inserted.

pub fn track_modification(&mut self) -> &mut SparseSet<T>

Flags components when they are modified. Will not flag components already flagged inserted.
To check the flag use is_modified, is_inserted_or_modified or iterate over the storage after calling modified.
To clear the flag use clear_modified or clear_all_modified.

pub fn track_deletion(&mut self) -> &mut SparseSet<T>

Stores components and their EntityId when they are deleted.
You can access them with deleted or removed_or_deleted.
You can clear them and get back a Vec with take_deleted or take_removed_and_deleted.

pub fn track_removal(&mut self) -> &mut SparseSet<T>

Stores EntityId of deleted components.
You can access them with removed or removed_or_deleted.
You can clear them and get back a Vec with take_removed or take_removed_and_deleted.

pub fn track_all(&mut self)

Flags component insertion, modification, deletion and removal.
Same as calling track_insertion, track_modification, track_deletion and track_removal.

pub fn is_tracking_insertion(&self) -> bool

Returns true if the storage tracks insertion.

pub fn is_tracking_modification(&self) -> bool

Returns true if the storage tracks modification.

pub fn is_tracking_deletion(&self) -> bool

Returns true if the storage tracks deletion.

pub fn is_tracking_removal(&self) -> bool

Returns true if the storage tracks removal.

pub fn is_tracking_any(&self) -> bool

Returns true if the storage tracks insertion, modification, deletion or removal.

impl<T> SparseSet<T>

pub fn reserve(&mut self, additional: usize)

Reserves memory for at least additional components. Adding components can still allocate though.

pub fn clear(&mut self)

Deletes all components in this storage.

pub fn apply<R, F>(&mut self, a: EntityId, b: EntityId, f: F) -> R where
    F: FnOnce(&mut T, &T) -> R, 

Applies the given function f to the entities a and b.
The two entities shouldn’t point to the same component.

Panics

• MissingComponent - if one of the entity doesn’t have any component in the storage.
• IdenticalIds - if the two entities point to the same component.

pub fn apply_mut<R, F>(&mut self, a: EntityId, b: EntityId, f: F) -> R where
    F: FnOnce(&mut T, &mut T) -> R, 

Applies the given function f to the entities a and b.
The two entities shouldn’t point to the same component.

Panics

• MissingComponent - if one of the entity doesn’t have any component in the storage.
• IdenticalIds - if the two entities point to the same component.

pub fn drain(&mut self) -> SparseSetDrain<'_, T>

Creates a draining iterator that empties the storage and yields the removed items.

pub fn sort_unstable_by<F>(&mut self, compare: F) where
    F: FnMut(&T, &T) -> Ordering, 

Sorts the SparseSet with a comparator function, but may not preserve the order of equal elements.

impl<T> SparseSet<T> where
    T: Ord, 

pub fn sort_unstable(&mut self)

Sorts the SparseSet, but may not preserve the order of equal elements.

Trait Implementations

impl<'a, T> AsMut<SparseSet<T>> for ViewMut<'a, T>

fn as_mut(&mut self) -> &mut SparseSet<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T> AsRef<SparseSet<T>> for ViewMut<'a, T>

fn as_ref(&self) -> &SparseSet<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T> AsRef<SparseSet<T>> for View<'a, T>

fn as_ref(&self) -> &SparseSet<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Index<EntityId> for SparseSet<T>

type Output = T

The returned type after indexing.

fn index(&self, entity: EntityId) -> &<SparseSet<T> as Index<EntityId>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<EntityId> for SparseSet<T>

fn index_mut(
    &mut self,
    entity: EntityId
) -> &mut <SparseSet<T> as Index<EntityId>>::Output

Performs the mutable indexing (container[index]) operation.

impl<T> Storage for SparseSet<T> where
    T: 'static, 

fn delete(&mut self, entity: EntityId)

Deletes an entity from this storage.

fn clear(&mut self)

Deletes all components of this storage.

fn memory_usage(&self) -> Option<StorageMemoryUsage>

Returns how much memory this storage uses.

fn sparse_array(&self) -> Option<&SparseArray<[EntityId; 32]>>

Returns a SparseSet’s internal SparseArray.

fn any(&self) -> &(dyn Any + 'static)

Casts to &dyn Any.

fn any_mut(&mut self) -> &mut (dyn Any + 'static)

Casts to &mut dyn Any.

fn name(&self) -> Cow<'static, str>

Returns the storage’s name.