pub struct Ref<'a, T>where
T: ?Sized,{ /* private fields */ }
Expand description
Shared borrow of an entity’s component with access to change detection.
Similar to Mut
but is immutable and so doesn’t require unique access.
Implementations§
§impl<'a, T> Ref<'a, T>where
T: ?Sized,
impl<'a, T> Ref<'a, T>where T: ?Sized,
pub fn into_inner(self) -> &'a T
Trait Implementations§
§impl<'a, T> DetectChanges for Ref<'a, T>where
T: ?Sized,
impl<'a, T> DetectChanges for Ref<'a, T>where T: ?Sized,
§fn is_changed(&self) -> bool
fn is_changed(&self) -> bool
Returns
true
if this value was added or mutably dereferenced after the system last ran.§fn last_changed(&self) -> u32
fn last_changed(&self) -> u32
Returns the change tick recording the time this data was most recently changed. Read more
§impl<'w, 'a, T> IntoIterator for &'a Ref<'w, T>where
&'a T: IntoIterator,
impl<'w, 'a, T> IntoIterator for &'a Ref<'w, T>where &'a T: IntoIterator,
§impl<'__w, T> WorldQuery for Ref<'__w, T>where
T: Component,
impl<'__w, T> WorldQuery for Ref<'__w, T>where T: Component,
SAFETY: Self
is the same as Self::ReadOnly
§type Fetch = RefFetch<'w, T>
type Fetch = RefFetch<'w, T>
Per archetype/table state used by this
WorldQuery
to fetch Self::Item
§type Item = Ref<'w, T>
type Item = Ref<'w, T>
The item returned by this
WorldQuery
§type ReadOnly = Ref<'__w, T>
type ReadOnly = Ref<'__w, T>
The read-only variant of this
WorldQuery
, which satisfies the ReadOnlyWorldQuery
trait.§type State = ComponentId
type State = ComponentId
State used to construct a
Self::Fetch
. This will be cached inside QueryState
,
so it is best to move as much data / computation here as possible to reduce the cost of
constructing Self::Fetch
.§fn shrink<'wlong, 'wshort>(item: Ref<'wlong, T>) -> Ref<'wshort, T>where
'wlong: 'wshort,
fn shrink<'wlong, 'wshort>(item: Ref<'wlong, T>) -> Ref<'wshort, T>where 'wlong: 'wshort,
This function manually implements subtyping for the query items.
§const IS_DENSE: bool = {
match <T::Storage>::STORAGE_TYPE {
StorageType::Table => true,
StorageType::SparseSet => false,
}
}
const IS_DENSE: bool = { match <T::Storage>::STORAGE_TYPE { StorageType::Table => true, StorageType::SparseSet => false, } }
Returns true if (and only if) every table of every archetype matched by this fetch contains
all of the matched components. This is used to select a more efficient “table iterator”
for “dense” queries. If this returns true,
WorldQuery::set_table
must be used before
WorldQuery::fetch
can be called for iterators. If this returns false,
WorldQuery::set_archetype
must be used before WorldQuery::fetch
can be called for
iterators.§const IS_ARCHETYPAL: bool = true
const IS_ARCHETYPAL: bool = true
Returns true if (and only if) this Fetch relies strictly on archetypes to limit which
components are accessed by the Query. Read more
§unsafe fn init_fetch<'w>(
world: &'w World,
_: &ComponentId,
last_change_tick: u32,
change_tick: u32
) -> RefFetch<'w, T>
unsafe fn init_fetch<'w>( world: &'w World, _: &ComponentId, last_change_tick: u32, change_tick: u32 ) -> RefFetch<'w, T>
Creates a new instance of this fetch. Read more
§unsafe fn clone_fetch<'w>(
fetch: &<Ref<'__w, T> as WorldQuery>::Fetch<'w>
) -> <Ref<'__w, T> as WorldQuery>::Fetch<'w>
unsafe fn clone_fetch<'w>( fetch: &<Ref<'__w, T> as WorldQuery>::Fetch<'w> ) -> <Ref<'__w, T> as WorldQuery>::Fetch<'w>
While this function can be called for any query, it is always safe to call if
Self: ReadOnlyWorldQuery
holds. Read more§unsafe fn set_archetype<'w>(
fetch: &mut RefFetch<'w, T>,
component_id: &ComponentId,
_archetype: &'w Archetype,
table: &'w Table
)
unsafe fn set_archetype<'w>( fetch: &mut RefFetch<'w, T>, component_id: &ComponentId, _archetype: &'w Archetype, table: &'w Table )
Adjusts internal state to account for the next
Archetype
. This will always be called on
archetypes that match this WorldQuery
. Read more§unsafe fn set_table<'w>(
fetch: &mut RefFetch<'w, T>,
_: &ComponentId,
table: &'w Table
)
unsafe fn set_table<'w>( fetch: &mut RefFetch<'w, T>, _: &ComponentId, table: &'w Table )
Adjusts internal state to account for the next
Table
. This will always be called on tables
that match this WorldQuery
. Read more§unsafe fn fetch<'w>(
fetch: &mut <Ref<'__w, T> as WorldQuery>::Fetch<'w>,
entity: Entity,
table_row: TableRow
) -> <Ref<'__w, T> as WorldQuery>::Item<'w>
unsafe fn fetch<'w>( fetch: &mut <Ref<'__w, T> as WorldQuery>::Fetch<'w>, entity: Entity, table_row: TableRow ) -> <Ref<'__w, T> as WorldQuery>::Item<'w>
Fetch
Self::Item
for either the given entity
in the current Table
,
or for the given entity
in the current Archetype
. This must always be called after
WorldQuery::set_table
with a table_row
in the range of the current Table
or after
WorldQuery::set_archetype
with a entity
in the current archetype. Read morefn update_component_access( _: &ComponentId, access: &mut FilteredAccess<ComponentId> )
fn update_archetype_component_access( _: &ComponentId, archetype: &Archetype, access: &mut Access<ArchetypeComponentId> )
fn init_state(world: &mut World) -> ComponentId
fn matches_component_set( _: &ComponentId, set_contains_id: &impl Fn(ComponentId) -> bool ) -> bool
impl<'__w, T> ReadOnlyWorldQuery for Ref<'__w, T>where T: Component,
SAFETY: access is read only
Auto Trait Implementations§
impl<'a, T: ?Sized> RefUnwindSafe for Ref<'a, T>where T: RefUnwindSafe,
impl<'a, T: ?Sized> Send for Ref<'a, T>where T: Sync,
impl<'a, T: ?Sized> Sync for Ref<'a, T>where T: Sync,
impl<'a, T: ?Sized> Unpin for Ref<'a, T>
impl<'a, T: ?Sized> UnwindSafe for Ref<'a, T>where T: RefUnwindSafe,
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.