pub struct CircleOverlapEntities<'w, 's, F: QueryFilter + 'static = ()> { /* private fields */ }Expand description
Live read-only search for enabled circular colliders in the active World.
F is a Bevy query filter applied only to candidate entities, such as
With<Coin> or (With<Target>, Without<Projectile>). The source entity
need not match F, but it must still be an enabled managed entity. The
supplied source transform and collider define the tested geometry. The
runtime validates the source handle, but their association with that handle
is caller-enforced; ordinary use borrows both from the same source entity.
Each call to CircleOverlapEntities::iter_overlapping performs an
allocation-free linear scan over ECS rows visited after archetype pruning
by F. Row-level filters may inspect rows that they do not yield. Results
exclude the source entity and have no stable iteration order. Direct
component changes made by an earlier System in the same stage are visible;
structural crate::commands::LogicCommands remain deferred until the
stage barrier.
This is an overlap query, not a spatial index or physics solver.
The source transform and collider are explicit method arguments rather
than hidden reads. A separate mutable query for Transform2d or
CircleCollider2d must still be archetype-disjoint from this parameter’s
candidate filter F; passing a source handle or proposed transform does
not establish disjointness for Bevy. Splitting movement and collision into
ordered Systems is the simplest general pattern.
Implementations§
Source§impl<'s, F: QueryFilter + 'static> CircleOverlapEntities<'_, 's, F>
impl<'s, F: QueryFilter + 'static> CircleOverlapEntities<'_, 's, F>
Sourcepub fn has_overlap(
&self,
source: LogicEntity,
source_transform: &Transform2d,
source_collider: &CircleCollider2d,
) -> Result<bool, QueryEntityError>
pub fn has_overlap( &self, source: LogicEntity, source_transform: &Transform2d, source_collider: &CircleCollider2d, ) -> Result<bool, QueryEntityError>
Reports whether at least one candidate overlaps source right now.
This is an early-exit boolean convenience over
Self::iter_overlapping. It preserves the same source validation,
filtering, caller-supplied geometry, and tangent-contact semantics, but
does not expose which unordered candidate matched. The worst case
remains a linear candidate scan.
Sourcepub fn iter_overlapping(
&self,
source: LogicEntity,
source_transform: &Transform2d,
source_collider: &CircleCollider2d,
) -> Result<impl Iterator<Item = LogicEntity> + '_, QueryEntityError>
pub fn iter_overlapping( &self, source: LogicEntity, source_transform: &Transform2d, source_collider: &CircleCollider2d, ) -> Result<impl Iterator<Item = LogicEntity> + '_, QueryEntityError>
Iterates over candidate identities overlapping source right now.
A foreign or retired handle is rejected before ECS lookup. A handle
that is absent, unmanaged, or disabled produces
QueryEntityError::DoesNotMatch. The supplied geometry is used by
value. Its association with source is caller-enforced; callers should
borrow it from that entity in the same System.
Sourcepub fn has_overlap_with_rectangle(
&self,
source: LogicEntity,
source_transform: &Transform2d,
source_collider: &RectangleCollider2d,
) -> Result<bool, QueryEntityError>
pub fn has_overlap_with_rectangle( &self, source: LogicEntity, source_transform: &Transform2d, source_collider: &RectangleCollider2d, ) -> Result<bool, QueryEntityError>
Reports whether at least one circular candidate overlaps a rectangular source.
This is exact early-exit sugar over
Self::iter_overlapping_with_rectangle. The source geometry is
supplied by the caller; filtering and source validation are identical
to the same-shape path.
Sourcepub fn iter_overlapping_with_rectangle(
&self,
source: LogicEntity,
source_transform: &Transform2d,
source_collider: &RectangleCollider2d,
) -> Result<impl Iterator<Item = LogicEntity> + '_, QueryEntityError>
pub fn iter_overlapping_with_rectangle( &self, source: LogicEntity, source_transform: &Transform2d, source_collider: &RectangleCollider2d, ) -> Result<impl Iterator<Item = LogicEntity> + '_, QueryEntityError>
Iterates over circular candidates overlapping a rectangular source.
Tangent face and corner contact count as overlap. A foreign or retired
handle is rejected before lookup; absent, unmanaged, disabled, or
private-marker-mismatched sources produce
QueryEntityError::DoesNotMatch. The supplied geometry is used by
value and its association with source is caller-enforced. F applies
only to circular candidates; the source and disabled candidates are
excluded. This is an allocation-free linear scan with no stable order.
Trait Implementations§
impl<'w, 's, F: QueryFilter + 'static> ReadOnlySystemParam for CircleOverlapEntities<'w, 's, F>where
BevyQuery<'w, 's, &'static ManagedEntity, (Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: ReadOnlySystemParam,
BevyQuery<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: ReadOnlySystemParam,
Res<'w, WorldIdentityState>: ReadOnlySystemParam,
Source§impl<F: QueryFilter + 'static> SystemParam for CircleOverlapEntities<'_, '_, F>
impl<F: QueryFilter + 'static> SystemParam for CircleOverlapEntities<'_, '_, F>
Source§type Item<'w, 's> = CircleOverlapEntities<'w, 's, F>
type Item<'w, 's> = CircleOverlapEntities<'w, 's, F>
Self, instantiated with new lifetimes. Read moreSource§fn init_access(
state: &Self::State,
system_meta: &mut SystemMeta,
component_access_set: &mut FilteredAccessSet,
world: &mut World,
)
fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )
Source§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
SystemParam’s state.
This is used to apply Commands during ApplyDeferred.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
ApplyDeferred.Source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick,
) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<Self::Item<'w, 's>, SystemParamValidationError>
SystemParamFunction. Read moreAuto Trait Implementations§
impl<'w, 's, F = ()> !RefUnwindSafe for CircleOverlapEntities<'w, 's, F>
impl<'w, 's, F = ()> !UnwindSafe for CircleOverlapEntities<'w, 's, F>
impl<'w, 's, F> Forget for CircleOverlapEntities<'w, 's, F>
impl<'w, 's, F> Freeze for CircleOverlapEntities<'w, 's, F>where
Query<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Freeze,
impl<'w, 's, F> Move for CircleOverlapEntities<'w, 's, F>
impl<'w, 's, F> Send for CircleOverlapEntities<'w, 's, F>where
Query<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Send,
impl<'w, 's, F> Sync for CircleOverlapEntities<'w, 's, F>where
Query<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Sync,
impl<'w, 's, F> Unpin for CircleOverlapEntities<'w, 's, F>where
Query<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Unpin,
impl<'w, 's, F> UnsafeUnpin for CircleOverlapEntities<'w, 's, F>where
Query<'w, 's, (Entity, &'static ManagedEntity, &'static Transform2d, &'static CircleCollider2d), (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: UnsafeUnpin,
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
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.