Struct avian3d::schedule::PostProcessCollisions

pub struct PostProcessCollisions;

A schedule where you can add systems to filter or modify collisions using the Collisions resource.

The schedule is empty by default and runs in NarrowPhaseSet::PostProcess.

Example

Below is an example of how you could add a system that filters collisions.

use avian3d::prelude::*;
use bevy::prelude::*;

#[derive(Component)]
struct Invulnerable;

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, PhysicsPlugins::default()))
        .add_systems(PostProcessCollisions, filter_collisions)
        .run();
}

fn filter_collisions(mut collisions: ResMut<Collisions>, query: Query<(), With<Invulnerable>>) {
    // Remove collisions where one of the colliders has an `Invulnerable` component.
    // In a real project, this could be done more efficiently with collision layers.
    collisions.retain(|contacts| {
        !query.contains(contacts.entity1) && !query.contains(contacts.entity2)
    });
}

Trait Implementations

impl Clone for PostProcessCollisions

fn clone(&self) -> PostProcessCollisions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PostProcessCollisions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for PostProcessCollisions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PostProcessCollisions

fn eq(&self, other: &PostProcessCollisions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ScheduleLabel for PostProcessCollisions

where Self: 'static + Send + Sync + Clone + Eq + Debug + Hash,

fn dyn_clone(&self) -> Box<dyn ScheduleLabel>

Clones this ScheduleLabel.

fn as_dyn_eq(&self) -> &dyn DynEq

Casts this value to a form where it can be compared with other type-erased values.

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.

fn intern(&self) -> Interned<dyn ScheduleLabel>

where Self: Sized,

Returns an Interned value corresponding to self.

impl Eq for PostProcessCollisions

impl StructuralPartialEq for PostProcessCollisions