pub struct FilteredEntityRef<'w> { /* private fields */ }
Expand description
Provides read-only access to a single entity and some of its components defined by the contained Access
.
Implementations§
Source§impl<'w> FilteredEntityRef<'w>
impl<'w> FilteredEntityRef<'w>
Sourcepub fn location(&self) -> EntityLocation
pub fn location(&self) -> EntityLocation
Gets metadata indicating the location where the current entity is stored.
Sourcepub fn archetype(&self) -> &Archetype
pub fn archetype(&self) -> &Archetype
Returns the archetype that the current entity belongs to.
Sourcepub fn components(&self) -> impl Iterator<Item = ComponentId> + '_
pub fn components(&self) -> impl Iterator<Item = ComponentId> + '_
Returns an iterator over the component ids that are accessed by self.
Sourcepub fn access(&self) -> &Access<ComponentId>
pub fn access(&self) -> &Access<ComponentId>
Returns a reference to the underlying Access
.
Sourcepub fn contains<T: Component>(&self) -> bool
pub fn contains<T: Component>(&self) -> bool
Returns true
if the current entity has a component of type T
.
Otherwise, this returns false
.
§Notes
If you do not know the concrete type of a component, consider using
Self::contains_id
or Self::contains_type_id
.
Sourcepub fn contains_id(&self, component_id: ComponentId) -> bool
pub fn contains_id(&self, component_id: ComponentId) -> bool
Returns true
if the current entity has a component identified by component_id
.
Otherwise, this returns false.
§Notes
- If you know the concrete type of the component, you should prefer
Self::contains
. - If you know the component’s
TypeId
but not itsComponentId
, consider usingSelf::contains_type_id
.
Sourcepub fn contains_type_id(&self, type_id: TypeId) -> bool
pub fn contains_type_id(&self, type_id: TypeId) -> bool
Returns true
if the current entity has a component with the type identified by type_id
.
Otherwise, this returns false.
§Notes
- If you know the concrete type of the component, you should prefer
Self::contains
. - If you have a
ComponentId
instead of aTypeId
, consider usingSelf::contains_id
.
Sourcepub fn get<T: Component>(&self) -> Option<&'w T>
pub fn get<T: Component>(&self) -> Option<&'w T>
Gets access to the component of type T
for the current entity.
Returns None
if the entity does not have a component of type T
.
Sourcepub fn get_ref<T: Component>(&self) -> Option<Ref<'w, T>>
pub fn get_ref<T: Component>(&self) -> Option<Ref<'w, T>>
Gets access to the component of type T
for the current entity,
including change detection information as a Ref
.
Returns None
if the entity does not have a component of type T
.
Sourcepub fn get_change_ticks<T: Component>(&self) -> Option<ComponentTicks>
pub fn get_change_ticks<T: Component>(&self) -> Option<ComponentTicks>
Retrieves the change ticks for the given component. This can be useful for implementing change detection in custom runtimes.
Sourcepub fn get_change_ticks_by_id(
&self,
component_id: ComponentId,
) -> Option<ComponentTicks>
pub fn get_change_ticks_by_id( &self, component_id: ComponentId, ) -> Option<ComponentTicks>
Retrieves the change ticks for the given ComponentId
. This can be useful for implementing change
detection in custom runtimes.
You should prefer to use the typed API Self::get_change_ticks
where possible and only
use this in cases where the actual component types are not known at
compile time.
Sourcepub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'w>>
pub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'w>>
Gets the component of the given ComponentId
from the entity.
You should prefer to use the typed API Self::get
where possible and only
use this in cases where the actual component types are not known at
compile time.
Unlike FilteredEntityRef::get
, this returns a raw pointer to the component,
which is only valid while the FilteredEntityRef
is alive.
Trait Implementations§
Source§impl<'w> Clone for FilteredEntityRef<'w>
impl<'w> Clone for FilteredEntityRef<'w>
Source§fn clone(&self) -> FilteredEntityRef<'w>
fn clone(&self) -> FilteredEntityRef<'w>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<'a> From<&'a EntityMut<'_>> for FilteredEntityRef<'a>
impl<'a> From<&'a EntityMut<'_>> for FilteredEntityRef<'a>
Source§impl<'a> From<&'a EntityRef<'_>> for FilteredEntityRef<'a>
impl<'a> From<&'a EntityRef<'_>> for FilteredEntityRef<'a>
Source§impl<'a> From<&'a EntityWorldMut<'_>> for FilteredEntityRef<'a>
impl<'a> From<&'a EntityWorldMut<'_>> for FilteredEntityRef<'a>
Source§fn from(entity: &'a EntityWorldMut<'_>) -> Self
fn from(entity: &'a EntityWorldMut<'_>) -> Self
Source§impl<'a> From<&'a FilteredEntityMut<'_>> for FilteredEntityRef<'a>
impl<'a> From<&'a FilteredEntityMut<'_>> for FilteredEntityRef<'a>
Source§fn from(entity_mut: &'a FilteredEntityMut<'_>) -> Self
fn from(entity_mut: &'a FilteredEntityMut<'_>) -> Self
Source§impl<'a> From<EntityMut<'a>> for FilteredEntityRef<'a>
impl<'a> From<EntityMut<'a>> for FilteredEntityRef<'a>
Source§impl<'a> From<EntityRef<'a>> for FilteredEntityRef<'a>
impl<'a> From<EntityRef<'a>> for FilteredEntityRef<'a>
Source§impl<'a> From<EntityWorldMut<'a>> for FilteredEntityRef<'a>
impl<'a> From<EntityWorldMut<'a>> for FilteredEntityRef<'a>
Source§fn from(entity: EntityWorldMut<'a>) -> Self
fn from(entity: EntityWorldMut<'a>) -> Self
Source§impl<'w> From<FilteredEntityMut<'w>> for FilteredEntityRef<'w>
impl<'w> From<FilteredEntityMut<'w>> for FilteredEntityRef<'w>
Source§fn from(entity_mut: FilteredEntityMut<'w>) -> Self
fn from(entity_mut: FilteredEntityMut<'w>) -> Self
Source§impl<'a> QueryData for FilteredEntityRef<'a>
impl<'a> QueryData for FilteredEntityRef<'a>
SAFETY: Self
is the same as Self::ReadOnly
Source§type ReadOnly = FilteredEntityRef<'a>
type ReadOnly = FilteredEntityRef<'a>
QueryData
, which satisfies the ReadOnlyQueryData
trait.Source§impl<'a> TryFrom<&'a FilteredEntityRef<'_>> for EntityRef<'a>
impl<'a> TryFrom<&'a FilteredEntityRef<'_>> for EntityRef<'a>
Source§impl<'a> TryFrom<FilteredEntityRef<'a>> for EntityRef<'a>
impl<'a> TryFrom<FilteredEntityRef<'a>> for EntityRef<'a>
Source§impl<'a> WorldQuery for FilteredEntityRef<'a>
impl<'a> WorldQuery for FilteredEntityRef<'a>
SAFETY: The accesses of Self::ReadOnly
are a subset of the accesses of Self
Source§const IS_DENSE: bool = false
const IS_DENSE: bool = false
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§type Fetch<'w> = (UnsafeWorldCell<'w>, Access<ComponentId>)
type Fetch<'w> = (UnsafeWorldCell<'w>, Access<ComponentId>)
WorldQuery
to fetch Self::Item
Source§type Item<'w> = FilteredEntityRef<'w>
type Item<'w> = FilteredEntityRef<'w>
WorldQuery
For QueryData
this will be the item returned by the query.
For QueryFilter
this will be either ()
, or a bool
indicating whether the entity should be included
or a tuple of such things.Source§type State = FilteredAccess<ComponentId>
type State = FilteredAccess<ComponentId>
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: Self::Item<'wlong>,
) -> Self::Item<'wshort>
fn shrink<'wlong: 'wshort, 'wshort>( item: Self::Item<'wlong>, ) -> Self::Item<'wshort>
Source§unsafe fn init_fetch<'w>(
world: UnsafeWorldCell<'w>,
_state: &Self::State,
_last_run: Tick,
_this_run: Tick,
) -> Self::Fetch<'w>
unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, _state: &Self::State, _last_run: Tick, _this_run: Tick, ) -> Self::Fetch<'w>
Source§unsafe fn set_archetype<'w>(
fetch: &mut Self::Fetch<'w>,
state: &Self::State,
archetype: &'w Archetype,
_table: &Table,
)
unsafe fn set_archetype<'w>( fetch: &mut Self::Fetch<'w>, state: &Self::State, archetype: &'w Archetype, _table: &Table, )
Archetype
. This will always be called on
archetypes that match this WorldQuery
. Read moreSource§unsafe fn set_table<'w>(
fetch: &mut Self::Fetch<'w>,
state: &Self::State,
table: &'w Table,
)
unsafe fn set_table<'w>( fetch: &mut Self::Fetch<'w>, state: &Self::State, table: &'w Table, )
Table
. This will always be called on tables
that match this WorldQuery
. Read moreSource§fn set_access<'w>(state: &mut Self::State, access: &FilteredAccess<ComponentId>)
fn set_access<'w>(state: &mut Self::State, access: &FilteredAccess<ComponentId>)
FilteredEntityRef
or FilteredEntityMut
. Read moreSource§unsafe fn fetch<'w>(
(world, access): &mut Self::Fetch<'w>,
entity: Entity,
_table_row: TableRow,
) -> Self::Item<'w>
unsafe fn fetch<'w>( (world, access): &mut Self::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> Self::Item<'w>
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(
state: &Self::State,
filtered_access: &mut FilteredAccess<ComponentId>,
)
fn update_component_access( state: &Self::State, filtered_access: &mut FilteredAccess<ComponentId>, )
Source§fn init_state(_world: &mut World) -> Self::State
fn init_state(_world: &mut World) -> Self::State
State
for this WorldQuery
type.Source§fn matches_component_set(
_state: &Self::State,
_set_contains_id: &impl Fn(ComponentId) -> bool,
) -> bool
fn matches_component_set( _state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool
impl ReadOnlyQueryData for FilteredEntityRef<'_>
SAFETY: Access is read-only.
Auto Trait Implementations§
impl<'w> Freeze for FilteredEntityRef<'w>
impl<'w> !RefUnwindSafe for FilteredEntityRef<'w>
impl<'w> Send for FilteredEntityRef<'w>
impl<'w> Sync for FilteredEntityRef<'w>
impl<'w> Unpin for FilteredEntityRef<'w>
impl<'w> !UnwindSafe for FilteredEntityRef<'w>
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
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>
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)
&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)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.