Skip to main content

CircleOverlapEntities

Struct CircleOverlapEntities 

Source
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>

Source

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.

Source

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.

Source

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.

Source

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§

Source§

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>

Source§

type State = FetchState<F>

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = CircleOverlapEntities<'w, 's, F>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state(world: &mut World) -> Self::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next 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>

Creates a parameter to be passed into a SystemParamFunction. Read more

Auto 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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

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>

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)

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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more