Struct bevy_ecs::change_detection::Ref
source · pub struct Ref<'a, 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§
source§impl<'a, T: ?Sized> Ref<'a, T>
impl<'a, T: ?Sized> Ref<'a, T>
sourcepub fn into_inner(self) -> &'a T
pub fn into_inner(self) -> &'a T
Returns the reference wrapped by this type. The reference is allowed to outlive self
, which makes this method more flexible than simply borrowing self
.
sourcepub fn map<U: ?Sized>(self, f: impl FnOnce(&T) -> &U) -> Ref<'a, U>
pub fn map<U: ?Sized>(self, f: impl FnOnce(&T) -> &U) -> Ref<'a, U>
Map Ref
to a different type using f
.
This doesn’t do anything else than call f
on the wrapped value.
This is equivalent to Mut::map_unchanged
.
sourcepub fn new(
value: &'a T,
added: &'a Tick,
changed: &'a Tick,
last_run: Tick,
this_run: Tick
) -> Ref<'a, T>
pub fn new( value: &'a T, added: &'a Tick, changed: &'a Tick, last_run: Tick, this_run: Tick ) -> Ref<'a, T>
Create a new Ref
using provided values.
This is an advanced feature, Ref
s are designed to be created by
engine-internal code and consumed by end-user code.
value
- The value wrapped byRef
.added
- ATick
that stores the tick when the wrapped value was created.changed
- ATick
that stores the last time the wrapped value was changed.last_run
- ATick
, occurring beforethis_run
, which is used as a reference to determine whether the wrapped value is newly added or changed.this_run
- ATick
corresponding to the current point in time – “now”.
Trait Implementations§
source§impl<'a, T: ?Sized> DetectChanges for Ref<'a, T>
impl<'a, T: ?Sized> DetectChanges for Ref<'a, T>
source§fn is_changed(&self) -> bool
fn is_changed(&self) -> bool
Returns
true
if this value was added or mutably dereferenced
either since the last time the system ran or, if the system never ran,
since the beginning of the program. Read moresource§fn last_changed(&self) -> Tick
fn last_changed(&self) -> Tick
Returns the change tick recording the time this data was most recently changed. Read more
source§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,
source§impl<'__w, T: Component> WorldQuery for Ref<'__w, T>
impl<'__w, T: Component> WorldQuery for Ref<'__w, T>
SAFETY: Self
is the same as Self::ReadOnly
§type Fetch<'w> = RefFetch<'w, T>
type Fetch<'w> = RefFetch<'w, T>
Per archetype/table state used by this
WorldQuery
to fetch Self::Item
§type Item<'w> = Ref<'w, T>
type Item<'w> = 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
.source§fn shrink<'wlong: 'wshort, 'wshort>(item: Ref<'wlong, T>) -> Ref<'wshort, T>
fn shrink<'wlong: 'wshort, 'wshort>(item: Ref<'wlong, T>) -> Ref<'wshort, T>
This function manually implements subtyping for the query items.
source§const IS_DENSE: bool = _
const IS_DENSE: bool = _
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.source§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
source§unsafe fn init_fetch<'w>(
world: UnsafeWorldCell<'w>,
component_id: &ComponentId,
last_run: Tick,
this_run: Tick
) -> RefFetch<'w, T>
unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, component_id: &ComponentId, last_run: Tick, this_run: Tick ) -> RefFetch<'w, T>
Creates a new instance of this fetch. Read more
source§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 moresource§unsafe fn set_table<'w>(
fetch: &mut RefFetch<'w, T>,
component_id: &ComponentId,
table: &'w Table
)
unsafe fn set_table<'w>( fetch: &mut RefFetch<'w, T>, component_id: &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 moresource§unsafe fn fetch<'w>(
fetch: &mut Self::Fetch<'w>,
entity: Entity,
table_row: TableRow
) -> Self::Item<'w>
unsafe fn fetch<'w>( fetch: &mut Self::Fetch<'w>, entity: Entity, table_row: TableRow ) -> Self::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 moresource§fn update_component_access(
component_id: &ComponentId,
access: &mut FilteredAccess<ComponentId>
)
fn update_component_access( component_id: &ComponentId, access: &mut FilteredAccess<ComponentId> )
Adds any component accesses used by this
WorldQuery
to access
.source§fn update_archetype_component_access(
component_id: &ComponentId,
archetype: &Archetype,
access: &mut Access<ArchetypeComponentId>
)
fn update_archetype_component_access( component_id: &ComponentId, archetype: &Archetype, access: &mut Access<ArchetypeComponentId> )
source§fn init_state(world: &mut World) -> ComponentId
fn init_state(world: &mut World) -> ComponentId
Creates and initializes a
State
for this WorldQuery
type.source§fn matches_component_set(
state: &ComponentId,
set_contains_id: &impl Fn(ComponentId) -> bool
) -> bool
fn matches_component_set( state: &ComponentId, set_contains_id: &impl Fn(ComponentId) -> bool ) -> bool
Returns
true
if this query matches a set of components. Otherwise, returns false
.impl<'__w, T: Component> ReadOnlyWorldQuery for Ref<'__w, T>
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§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.source§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.