Struct shipyard::View

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

Shared view over a component storage.

Implementations

impl<'a, T: Component, Track: Tracking> View<'a, T, Track>

pub const ASSERT_VIEW_TRACKING_INSERTION: () = _

Check that the view tracks insertion if the component is tracking it.

pub const ASSERT_VIEW_TRACKING_MODIFICATION: () = _

Check that the view tracks modification if the component is tracking it.

pub const ASSERT_VIEW_TRACKING_DELETION: () = _

Check that the view tracks deletion if the component is tracking it.

pub const ASSERT_VIEW_TRACKING_REMOVAL: () = _

Check that the view tracks removal if the component is tracking it.

impl<'a, T: Component, Track> View<'a, T, Track>

where Track: Tracking,

pub fn override_last_insertion( &mut self, new_timestamp: TrackingTimestamp, ) -> TrackingTimestamp

Replaces the timestamp starting the tracking time window for insertions.

Tracking works based on a time window. From the last time the system ran (in workloads) or since the last clear.

Sometimes this automatic time window isn’t what you need. This can happen when you want to keep the same tracking information for multiple runs of the same system.

For example if you interpolate movement between frames, you might run an interpolation workload multiple times but not change the World during its execution.
In this case you want the same tracking information for all runs of this workload which would have disappeared using the automatic window.

pub fn override_last_modification( &mut self, new_timestamp: TrackingTimestamp, ) -> TrackingTimestamp

Replaces the timestamp starting the tracking time window for modifications.

Tracking works based on a time window. From the last time the system ran (in workloads) or since the last clear.

Sometimes this automatic time window isn’t what you need. This can happen when you want to keep the same tracking information for multiple runs of the same system.

For example if you interpolate movement between frames, you might run an interpolation workload multiple times but not change the World during its execution.
In this case you want the same tracking information for all runs of this workload which would have disappeared using the automatic window.

pub fn override_last_removal_or_deletion( &mut self, new_timestamp: TrackingTimestamp, ) -> TrackingTimestamp

Replaces the timestamp starting the tracking time window for removals and deletions.

Tracking works based on a time window. From the last time the system ran (in workloads) or since the last clear.

Sometimes this automatic time window isn’t what you need. This can happen when you want to keep the same tracking information for multiple runs of the same system.

For example if you interpolate movement between frames, you might run an interpolation workload multiple times but not change the World during its execution.
In this case you want the same tracking information for all runs of this workload which would have disappeared using the automatic window.

impl<'a, T: Component> View<'a, T, Untracked>

pub fn new_for_custom_storage( storage_id: StorageId, all_storages: ARef<'a, &'a AllStorages>, ) -> Result<Self, CustomStorageView>

Creates a new View for custom SparseSet storage.

use shipyard::{track, Component, SparseSet, StorageId, View, World};

struct ScriptingComponent(Vec<u8>);
impl Component for ScriptingComponent {
    type Tracking = track::Untracked;
}

let world = World::new();

world.add_custom_storage(
    StorageId::Custom(0),
    SparseSet::<ScriptingComponent>::new_custom_storage(),
).unwrap();

let all_storages = world.all_storages().unwrap();
let scripting_storage =
    View::<ScriptingComponent>::new_for_custom_storage(StorageId::Custom(0), all_storages)
        .unwrap();

impl<Track, T: Component> View<'_, T, Track>

where Track: InsertionTracking,

pub fn inserted(&self) -> Inserted<&Self>

Wraps this view to be able to iterate inserted components.

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

Inside a workload returns true if entity’s component was inserted since the last run of this system.
Outside workloads returns true if entity’s component was inserted since the last call to clear_all_inserted.
Returns false if entity does not have a component in this storage.

impl<Track, T: Component> View<'_, T, Track>

where Track: ModificationTracking,

pub fn modified(&self) -> Modified<&Self>

Wraps this view to be able to iterate modified components.

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

Inside a workload returns true if entity’s component was modified since the last run of this system.
Outside workloads returns true if entity’s component was modified since the last call to clear_all_modified.
Returns false if entity does not have a component in this storage.

impl<Track, T: Component> View<'_, T, Track>

where Track: InsertionTracking + ModificationTracking,

pub fn inserted_or_modified(&self) -> InsertedOrModified<&Self>

Wraps this view to be able to iterate inserted and modified components.

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

Inside a workload returns true if entity’s component was inserted or modified since the last run of this system.
Outside workloads returns true if entity’s component was inserted or modified since the last call to clear_all_inserted.
Returns false if entity does not have a component in this storage.

impl<Track, T: Component> View<'_, T, Track>

where Track: DeletionTracking,

pub fn deleted(&self) -> impl Iterator<Item = (EntityId, &T)> + '_

Returns the deleted components of a storage tracking deletion.

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

Inside a workload returns true if entity’s component was deleted since the last run of this system.
Outside workloads returns true if entity’s component was deleted since the last call to clear_all_deleted.
Returns false if entity does not have a component in this storage.

impl<Track, T: Component> View<'_, T, Track>

where Track: RemovalTracking,

pub fn removed(&self) -> impl Iterator<Item = EntityId> + '_

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

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

Inside a workload returns true if entity’s component was removed since the last run of this system.
Outside workloads returns true if entity’s component was removed since the last call to clear_all_removed.
Returns false if entity does not have a component in this storage.

impl<Track, T: Component> View<'_, T, Track>

where Track: RemovalTracking + DeletionTracking,

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.

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

Inside a workload returns true if entity’s component was deleted or removed since the last run of this system.
Outside workloads returns true if entity’s component was deleted or removed since the last clear call.
Returns false if entity does not have a component in this storage.

Methods from Deref<Target = SparseSet<T>>

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

Returns a slice of all the components in this storage.

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.

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.

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, deletion or removal.

Trait Implementations

impl<'a, T: Component, Track: Tracking> AsRef<SparseSet<T>> for View<'a, T, Track>

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

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

impl<'a, T: Component, Track: Tracking, U: IntoAbstract> BitOr<U> for &'a View<'a, T, Track>

type Output = Or<(&'a View<'a, T, Track>, U)>

The resulting type after applying the | operator.

fn bitor(self, rhs: U) -> Self::Output

Performs the | operation.

impl<T: Send + Sync + Component, Track> Borrow for View<'_, T, Track>

where Track: Tracking,

type View<'a> = View<'a, T, Track>

fn borrow<'a>( all_storages: &'a AllStorages, all_borrow: Option<SharedBorrow<'a>>, last_run: Option<TrackingTimestamp>, current: TrackingTimestamp, ) -> Result<Self::View<'a>, GetStorage>

This function is where the actual borrowing happens.

impl<'a, T: Send + Sync + Component, Track> BorrowInfo for View<'a, T, Track>

where Track: Tracking,

fn borrow_info(info: &mut Vec<TypeInfo>)

This information is used during workload creation to determine which systems can run in parallel.

fn enable_tracking( enable_tracking_fn: &mut Vec<fn(_: &AllStorages) -> Result<(), GetStorage>>, )

Enable tracking on the World where this storage is borrowed.

impl<'a, T: Component, Track: Tracking> Clone for View<'a, T, Track>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a: 'b, 'b, T: Component, Track: Tracking> Contains for &'b View<'a, T, Track>

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

Returns true if all storages contains entity.

impl<T: Debug + Component, Track: Tracking> Debug for View<'_, T, Track>

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

Formats the value using the given formatter.

impl<'a, T: Component, Track: Tracking> Deref for View<'a, T, Track>

type Target = SparseSet<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, 'b, T: Component, Track: Tracking> Get for &'b View<'a, T, Track>

type Out = &'b T

fn get(self, entity: EntityId) -> Result<Self::Out, MissingComponent>

Retrieve components of entity.

impl<T: Component, Track: Tracking> Index<EntityId> for View<'_, T, Track>

type Output = T

The returned type after indexing.

fn index(&self, entity: EntityId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a: 'b, 'b, T: Component, Track: Tracking> IntoAbstract for &'b View<'a, T, Track>

type AbsView = FullRawWindow<'b, T>

impl<T: Component, Track: Tracking> Not for &View<'_, T, Track>

type Output = Not<&View<'_, T, Track>>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.