ContactPair

Struct ContactPair 

Source
pub struct ContactPair {
    pub collider1: ColliderHandle,
    pub collider2: ColliderHandle,
    pub manifolds: Vec<ContactManifold>,
    pub has_any_active_contact: bool,
    /* private fields */
}
Expand description

All contact information between two colliding colliders.

When two colliders are touching, a ContactPair stores all the contact points, normals, and forces between them. You can access this through the narrow phase or in event handlers.

§Contact manifolds

The contacts are organized into “manifolds” - groups of contact points that share similar properties (like being on the same face). Most collider pairs have 1 manifold, but complex shapes may have multiple.

§Use cases

  • Reading contact normals for custom physics
  • Checking penetration depth
  • Analyzing impact forces
  • Implementing custom contact responses

§Example

if let Some((manifold, contact)) = contact_pair.find_deepest_contact() {
    println!("Deepest penetration: {}", -contact.dist);
    println!("Contact normal: {:?}", manifold.data.normal);
}

Fields§

§collider1: ColliderHandle

The first collider involved in the contact pair.

§collider2: ColliderHandle

The second collider involved in the contact pair.

§manifolds: Vec<ContactManifold>

The set of contact manifolds between the two colliders.

All contact manifold contain themselves contact points between the colliders. Note that contact points in the contact manifold do not take into account the Collider::contact_skin which only affects the constraint solver and the SolverContact.

§has_any_active_contact: bool

Is there any active contact in this contact pair?

Implementations§

Source§

impl ContactPair

Source

pub fn clear(&mut self)

Clears all the contacts of this contact pair.

Source

pub fn total_impulse(&self) -> Vector<f32>

The total impulse (force × time) applied by all contacts.

This is the accumulated force that pushed the colliders apart. Useful for determining impact strength.

Source

pub fn total_impulse_magnitude(&self) -> f32

The total magnitude of all contact impulses (sum of lengths, not length of sum).

This is what’s compared against contact_force_event_threshold.

Source

pub fn max_impulse(&self) -> (f32, Vector<f32>)

Finds the strongest contact impulse and its direction.

Returns (magnitude, normal_direction) of the strongest individual contact.

Source

pub fn find_deepest_contact(&self) -> Option<(&ContactManifold, &Contact)>

Finds the contact point with the deepest penetration.

When objects overlap, this returns the contact point that’s penetrating the most. Useful for:

  • Finding the “worst” overlap
  • Determining primary contact direction
  • Custom penetration resolution

Returns both the contact point and its parent manifold.

§Example
if let Some((manifold, contact)) = pair.find_deepest_contact() {
    let penetration_depth = -contact.dist;  // Negative dist = penetration
    println!("Deepest penetration: {} units", penetration_depth);
}

Trait Implementations§

Source§

impl Clone for ContactPair

Source§

fn clone(&self) -> ContactPair

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ContactPair

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &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)

Converts &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> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

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

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.