Struct NarrowPhase

pub struct NarrowPhase<'w, 's, C: AnyCollider> {
    pub contact_graph: ResMut<'w, ContactGraph>,
    pub joint_graph: ResMut<'w, JointGraph>,
    pub constraint_graph: ResMut<'w, ConstraintGraph>,
    pub islands: Option<ResMut<'w, PhysicsIslands>>,
    pub config: Res<'w, NarrowPhaseConfig>,
    /* private fields */
}

A system parameter for managing the narrow phase.

Responsibilities:

• Updates each active ContactPair in the ContactGraph.
• Sends collision events when colliders start or stop touching.
• Removes contact pairs from the ContactGraph when AABBs stop overlapping.
• Adds ContactManifolds to the ConstraintGraph when they are created.
• Removes ContactManifolds from the ConstraintGraph when they are destroyed.

Fields

contact_graph: ResMut<'w, ContactGraph>

joint_graph: ResMut<'w, JointGraph>

constraint_graph: ResMut<'w, ConstraintGraph>

islands: Option<ResMut<'w, PhysicsIslands>>

config: Res<'w, NarrowPhaseConfig>

Implementations

impl<C: AnyCollider> NarrowPhase<'_, '_, C>

pub fn update<H: CollisionHooks>( &mut self, collision_started_writer: &mut MessageWriter<'_, CollisionStart>, collision_ended_writer: &mut MessageWriter<'_, CollisionEnd>, delta_secs: Scalar, hooks: &SystemParamItem<'_, '_, H>, context: &SystemParamItem<'_, '_, C::Context>, commands: &mut ParallelCommands<'_, '_>, )

where for<'w, 's> SystemParamItem<'w, 's, H>: CollisionHooks,

Updates the narrow phase.

• Updates each active ContactPair in the ContactGraph.
• Sends collision events when colliders start or stop touching.
• Removes contact pairs from the ContactGraph when AABBs stop overlapping.
• Adds ContactManifolds to the ConstraintGraph when they are created.
• Removes ContactManifolds from the ConstraintGraph when they are destroyed.

Trait Implementations

impl<C: AnyCollider> SystemParam for NarrowPhase<'_, '_, C>

type State = FetchState<C>

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

type Item<'w, 's> = NarrowPhase<'w, 's, C>

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

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

Creates a new instance of this param’s State.

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

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.

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

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s mut Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, C: AnyCollider> ReadOnlySystemParam for NarrowPhase<'w, 's, C>

where Query<'w, 's, ColliderQuery<C>, Without<ColliderDisabled>>: ReadOnlySystemParam, Query<'w, 's, &'static mut CollidingEntities>: ReadOnlySystemParam, Query<'w, 's, RigidBodyQuery, Without<RigidBodyDisabled>>: ReadOnlySystemParam, Query<'w, 's, &'static mut BodyIslandNode, Or<(With<Disabled>, Without<Disabled>)>>: ReadOnlySystemParam, ResMut<'w, ContactGraph>: ReadOnlySystemParam, ResMut<'w, JointGraph>: ReadOnlySystemParam, ResMut<'w, ConstraintGraph>: ReadOnlySystemParam, Option<ResMut<'w, PhysicsIslands>>: ReadOnlySystemParam, ResMut<'w, ContactStatusBits>: ReadOnlySystemParam, ResMut<'w, ThreadLocalContactStatusBits>: ReadOnlySystemParam, Res<'w, NarrowPhaseConfig>: ReadOnlySystemParam, Res<'w, DefaultFriction>: ReadOnlySystemParam, Res<'w, DefaultRestitution>: ReadOnlySystemParam, Res<'w, PhysicsLengthUnit>: ReadOnlySystemParam, Local<'s, Scalar>: ReadOnlySystemParam,