pub struct NarrowPhase { /* private fields */ }Expand description
The narrow-phase collision detector that computes precise contact points between colliders.
After the broad-phase quickly filters out distant object pairs, the narrow-phase performs detailed geometric computations to find exact:
- Contact points (where surfaces touch)
- Contact normals (which direction surfaces face)
- Penetration depths (how much objects overlap)
You typically don’t interact with this directly - it’s managed by PhysicsPipeline::step.
However, you can access it to query contact information or intersection state between specific colliders.
For spatial queries (raycasts, shape casts), use QueryPipeline instead.
Implementations§
Source§impl NarrowPhase
impl NarrowPhase
Sourcepub fn with_query_dispatcher<D>(d: D) -> Self
pub fn with_query_dispatcher<D>(d: D) -> Self
Creates a new empty narrow-phase with a custom query dispatcher.
Sourcepub fn query_dispatcher(
&self,
) -> &dyn PersistentQueryDispatcher<ContactManifoldData, ContactData>
pub fn query_dispatcher( &self, ) -> &dyn PersistentQueryDispatcher<ContactManifoldData, ContactData>
The query dispatcher used by this narrow-phase to select the right collision-detection algorithms depending on the shape types.
Sourcepub fn contact_graph(&self) -> &InteractionGraph<ColliderHandle, ContactPair>
pub fn contact_graph(&self) -> &InteractionGraph<ColliderHandle, ContactPair>
The contact graph containing all contact pairs and their contact information.
Sourcepub fn intersection_graph(
&self,
) -> &InteractionGraph<ColliderHandle, IntersectionPair>
pub fn intersection_graph( &self, ) -> &InteractionGraph<ColliderHandle, IntersectionPair>
The intersection graph containing all intersection pairs and their intersection information.
Sourcepub fn contact_pairs_with_unknown_gen(
&self,
collider: u32,
) -> impl Iterator<Item = &ContactPair>
pub fn contact_pairs_with_unknown_gen( &self, collider: u32, ) -> impl Iterator<Item = &ContactPair>
All the contacts involving the given collider.
It is strongly recommended to use the NarrowPhase::contact_pairs_with method instead. This
method can be used if the generation number of the collider handle isn’t known.
Sourcepub fn contact_pairs_with(
&self,
collider: ColliderHandle,
) -> impl Iterator<Item = &ContactPair>
pub fn contact_pairs_with( &self, collider: ColliderHandle, ) -> impl Iterator<Item = &ContactPair>
All the contact pairs involving the given collider.
The returned contact pairs identify pairs of colliders with intersecting bounding-volumes.
To check if any geometric contact happened between the collider shapes, check
ContactPair::has_any_active_contact.
Sourcepub fn intersection_pairs_with_unknown_gen(
&self,
collider: u32,
) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
pub fn intersection_pairs_with_unknown_gen( &self, collider: u32, ) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
All the intersection pairs involving the given collider.
It is strongly recommended to use the NarrowPhase::intersection_pairs_with method instead.
This method can be used if the generation number of the collider handle isn’t known.
Sourcepub fn intersection_pairs_with(
&self,
collider: ColliderHandle,
) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
pub fn intersection_pairs_with( &self, collider: ColliderHandle, ) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
All the intersection pairs involving the given collider, where at least one collider involved in the intersection is a sensor.
The returned contact pairs identify pairs of colliders (where at least one is a sensor) with intersecting bounding-volumes. To check if any geometric overlap happened between the collider shapes, check the returned boolean.
Sourcepub fn contact_pair_at_index(
&self,
id: TemporaryInteractionIndex,
) -> &ContactPair
pub fn contact_pair_at_index( &self, id: TemporaryInteractionIndex, ) -> &ContactPair
Returns the contact pair at the given temporary index.
Sourcepub fn contact_pair_unknown_gen(
&self,
collider1: u32,
collider2: u32,
) -> Option<&ContactPair>
pub fn contact_pair_unknown_gen( &self, collider1: u32, collider2: u32, ) -> Option<&ContactPair>
The contact pair involving two specific colliders.
It is strongly recommended to use the NarrowPhase::contact_pair method instead. This
method can be used if the generation number of the collider handle isn’t known.
If this returns None, there is no contact between the two colliders.
If this returns Some, then there may be a contact between the two colliders. Check the
result ContactPair::has_any_active_contact method to see if there is an actual contact.
Sourcepub fn contact_pair(
&self,
collider1: ColliderHandle,
collider2: ColliderHandle,
) -> Option<&ContactPair>
pub fn contact_pair( &self, collider1: ColliderHandle, collider2: ColliderHandle, ) -> Option<&ContactPair>
The contact pair involving two specific colliders.
If this returns None, there is no contact between the two colliders.
If this returns Some, then there may be a contact between the two colliders. Check the
result ContactPair::has_any_active_contact method to see if there is an actual contact.
Sourcepub fn intersection_pair_unknown_gen(
&self,
collider1: u32,
collider2: u32,
) -> Option<bool>
pub fn intersection_pair_unknown_gen( &self, collider1: u32, collider2: u32, ) -> Option<bool>
The intersection pair involving two specific colliders.
It is strongly recommended to use the NarrowPhase::intersection_pair method instead. This
method can be used if the generation number of the collider handle isn’t known.
If this returns None or Some(false), then there is no intersection between the two colliders.
If this returns Some(true), then there may be an intersection between the two colliders.
Sourcepub fn intersection_pair(
&self,
collider1: ColliderHandle,
collider2: ColliderHandle,
) -> Option<bool>
pub fn intersection_pair( &self, collider1: ColliderHandle, collider2: ColliderHandle, ) -> Option<bool>
The intersection pair involving two specific colliders.
If this returns None or Some(false), then there is no intersection between the two colliders.
If this returns Some(true), then there may be an intersection between the two colliders.
Sourcepub fn contact_pairs(&self) -> impl Iterator<Item = &ContactPair>
pub fn contact_pairs(&self) -> impl Iterator<Item = &ContactPair>
All the contact pairs maintained by this narrow-phase.
Sourcepub fn intersection_pairs(
&self,
) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
pub fn intersection_pairs( &self, ) -> impl Iterator<Item = (ColliderHandle, ColliderHandle, bool)> + '_
All the intersection pairs maintained by this narrow-phase.
Sourcepub fn handle_user_changes(
&mut self,
islands: Option<&mut IslandManager>,
modified_colliders: &[ColliderHandle],
removed_colliders: &[ColliderHandle],
colliders: &mut ColliderSet,
bodies: &mut RigidBodySet,
events: &dyn EventHandler,
)
pub fn handle_user_changes( &mut self, islands: Option<&mut IslandManager>, modified_colliders: &[ColliderHandle], removed_colliders: &[ColliderHandle], colliders: &mut ColliderSet, bodies: &mut RigidBodySet, events: &dyn EventHandler, )
Maintain the narrow-phase internal state by taking collider removal into account.
Trait Implementations§
Source§impl Clone for NarrowPhase
impl Clone for NarrowPhase
Source§fn clone(&self) -> NarrowPhase
fn clone(&self) -> NarrowPhase
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 NarrowPhase
impl !RefUnwindSafe for NarrowPhase
impl Send for NarrowPhase
impl Sync for NarrowPhase
impl Unpin for NarrowPhase
impl !UnwindSafe for NarrowPhase
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.