Struct shipyard::SparseSet

pub struct SparseSet<T: Component, Track: Tracking = <T as Component>::Tracking> { /* private fields */ }

Default component storage.

Implementations

impl<T: Component> SparseSet<T>

pub fn new_custom_storage() -> Self

Returns a new SparseSet to be used in custom storage.

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

Returns a slice of all the components in this storage.

impl<T: Component> 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: Component> 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: Component<Tracking = Deletion>> SparseSet<T, Deletion>

pub fn clear_all_deleted(&mut self)

Clear all deletion tracking data.

pub fn clear_all_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion tracking data older than some timestamp.

pub fn clear_all_removed_or_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion and removal tracking data older than some timestamp.

impl<T: Component<Tracking = Removal>> SparseSet<T, Removal>

pub fn clear_all_removed(&mut self)

Clear all removal tracking data.

pub fn clear_all_removed_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all removal tracking data older than some timestamp.

pub fn clear_all_removed_and_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion and removal tracking data older than some timestamp.

impl<T: Component<Tracking = All>> SparseSet<T, All>

pub fn clear_all_deleted(&mut self)

Clear all deletion tracking data.

pub fn clear_all_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion tracking data older than some timestamp.

pub fn clear_all_removed(&mut self)

Clear all removal tracking data.

pub fn clear_all_removed_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all removal tracking data older than some timestamp.

pub fn clear_all_removed_and_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion and removal tracking data older than some timestamp.

impl<T: Component> SparseSet<T>

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: Component> SparseSet<T>

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

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

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

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

impl<T: Ord + Component> SparseSet<T>

pub fn sort_unstable(&mut self)

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

Trait Implementations

impl<'a, T: Component> 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: Component> 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<'a, T: Component> 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<T: Debug + Component> Debug for SparseSet<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: 'static + Component> Storage for SparseSet<T>

fn delete(&mut self, entity: EntityId, current: u32)

Deletes an entity from this storage.

fn clear(&mut self, current: u32)

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, BUCKET_SIZE>>

Returns a SparseSet’s internal SparseArray.

fn is_empty(&self) -> bool

Returns true if the storage is empty.

fn clear_all_removed_or_deleted(&mut self)

Clear all deletion and removal tracking data.

fn clear_all_removed_or_deleted_older_than_timestamp( &mut self, timestamp: TrackingTimestamp, )

Clear all deletion and removal tracking data older than some timestamp.

fn any(&self) -> &dyn Any

Casts to &dyn Any.

fn any_mut(&mut self) -> &mut dyn Any

Casts to &mut dyn Any.

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

Returns the storage’s name.