Struct avian3d::collision::collider::ColliderQuery

pub struct ColliderQuery<C: AnyCollider> {

    pub entity: Entity,
    pub parent: Option<&'static ColliderParent>,
    pub position: Ref<'static, Position>,
    pub rotation: Ref<'static, Rotation>,
    pub accumulated_translation: Option<Ref<'static, AccumulatedTranslation>>,
    pub transform: Option<&'static ColliderTransform>,
    pub collision_margin: Option<&'static CollisionMargin>,
    pub speculative_margin: Option<&'static SpeculativeMargin>,
    pub is_rb: Has<RigidBody>,
    pub is_sensor: Has<Sensor>,
    pub friction: Option<&'static Friction>,
    pub restitution: Option<&'static Restitution>,
    pub shape: &'static C,
}

A QueryData struct to make code handling colliders cleaner.

This is mostly an internal type, but can also be used by users.

Fields

entity: Entity

parent: Option<&'static ColliderParent>

position: Ref<'static, Position>

rotation: Ref<'static, Rotation>

accumulated_translation: Option<Ref<'static, AccumulatedTranslation>>

transform: Option<&'static ColliderTransform>

collision_margin: Option<&'static CollisionMargin>

speculative_margin: Option<&'static SpeculativeMargin>

is_rb: Has<RigidBody>

is_sensor: Has<Sensor>

friction: Option<&'static Friction>

restitution: Option<&'static Restitution>

shape: &'static C

Trait Implementations

impl<C: AnyCollider> QueryData for ColliderQuery<C>

SAFETY: we assert fields are readonly below

type ReadOnly = ColliderQuery<C>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

impl<C: AnyCollider> WorldQuery for ColliderQuery<C>

unsafe fn set_archetype<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _archetype: &'__w Archetype, _table: &'__w Table )

SAFETY: we call set_archetype for each member that implements Fetch

unsafe fn set_table<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &Self::State, _table: &'__w Table )

SAFETY: we call set_table for each member that implements Fetch

unsafe fn fetch<'__w>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow ) -> <Self as WorldQuery>::Item<'__w>

SAFETY: we call fetch for each member that implements Fetch.

type Item<'__w> = ColliderQueryItem<'__w, C>

The item returned by this 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.

type Fetch<'__w> = ColliderQueryFetch<'__w, C>

Per archetype/table state used by this WorldQuery to fetch Self::Item

type State = ColliderQueryState<C>

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, '__wshort>( item: <ColliderQuery<C> as WorldQuery>::Item<'__wlong> ) -> <ColliderQuery<C> as WorldQuery>::Item<'__wshort>

This function manually implements subtyping for the query items.

unsafe fn init_fetch<'__w>( _world: UnsafeWorldCell<'__w>, state: &Self::State, _last_run: Tick, _this_run: Tick ) -> <Self as WorldQuery>::Fetch<'__w>

Creates a new instance of this fetch.

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.

fn update_component_access( state: &Self::State, _access: &mut FilteredAccess<ComponentId> )

Adds any component accesses used by this WorldQuery to access.

fn init_state(world: &mut World) -> ColliderQueryState<C>

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<ColliderQueryState<C>>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut.

impl<C: AnyCollider> ReadOnlyQueryData for ColliderQuery<C>

SAFETY: we assert fields are readonly below