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: ColliderHandleThe first collider involved in the contact pair.
collider2: ColliderHandleThe 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: boolIs there any active contact in this contact pair?
Implementations§
Source§impl ContactPair
impl ContactPair
Sourcepub fn total_impulse(&self) -> Vector<f32>
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.
Sourcepub fn total_impulse_magnitude(&self) -> f32
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.
Sourcepub fn max_impulse(&self) -> (f32, Vector<f32>)
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.
Sourcepub fn find_deepest_contact(&self) -> Option<(&ContactManifold, &Contact)>
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
impl Clone for ContactPair
Source§fn clone(&self) -> ContactPair
fn clone(&self) -> ContactPair
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for ContactPair
impl !RefUnwindSafe for ContactPair
impl Send for ContactPair
impl Sync for ContactPair
impl Unpin for ContactPair
impl !UnwindSafe for ContactPair
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.