Struct rapier3d::geometry::NarrowPhase
source · pub struct NarrowPhase { /* private fields */ }
Expand description
The narrow-phase responsible for computing precise contact information between colliders.
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 of 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::contacts_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::intersections_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 moresource§impl Default for NarrowPhase
impl Default for NarrowPhase
source§impl<'de> Deserialize<'de> for NarrowPhase
impl<'de> Deserialize<'de> for NarrowPhase
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto 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> 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>
. Box<dyn Any>
can
then be further downcast
into Box<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>
. Rc<Any>
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> 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<T> Pointable for T
impl<T> Pointable for T
source§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.