Collision-detection is a two-steps process. First the broad-phase detects pairs of colliders that are potentially in contact or intersecting. Second, the narrow-phase processes all these pairs in order to compute contacts points and generate contact or intersection events.
All the pairs detected by the broad-phase can be accessed from the physics
There events can be collected by optionally passing an instance of
The colliders involved in each event is identified by its integer handle.
Intersection events are triggered when two colliders (where at least one of them is a sensor) transition between intersecting or not. Contact events are triggered when two non-sensor colliders transition between having zero contact points and having at least one contact point. Transitioning between having one contact point to having more than one contact points is not reported an event.
Intersection (resp. contact) events are only generated between two colliders (where at least one of the is a sensor) if at
least one of them has the
ActiveEvents.CONTACT_EVENTS) flag in its
The contact graph (encapsulated by the
World class) can be read in order to determine whether two specific
non-sensor colliders are in contact, or to determine all the non-sensor colliders in contact with one particular
non-sensor collider. Contact points and contact normals will also be provided when a contact exists.
The contact geometry (contact points, contact normal, penetration depth, etc.) can be read from the contact manifolds stored in a contact pair:
- Each contact pair may contain multiple contact manifolds. Each contact manifold represents a set of contacts sharing the same contact normal.
- Each contact manifold contains the list of geometric contacts detected by the narrow-phase.
- Each contact manifold also contains a list of contacts that were processed by the constraints solver for force calculation (aka. the solver contacts). These solver contacts are a subset of the contacts detected by the narrow-phase, expressed in a way that is more efficient for the constraints solver to process.
All the geometric contact data are expressed in the local-space of the colliders. The solver contacts are expressed in world-space.
There will always be only up to one contact manifold between two colliders with convex primitive shapes. If one collider has a shape composed of several pieces (trimesh, polyline, heightfield, or compound shape) then there will be multiple contact manifolds, one for each piece that may result in an actual contact.
The intersection graph can be read in order to determine whether two specific colliders (assuming at least one of them is a sensor) are intersecting, or to determine all the colliders intersecting one particular collider (assuming at least one collider of each pair is a sensor). The intersection graph contains one graph edge for each pair of colliders such that:
- At least one of the collider is a sensor.
- And they are close enough so the broad-phase considers they have a chance to be intersecting.
Each such edge contains one boolean indicating if the colliders are actually intersecting or not:
Keep in mind that intersection tests are performed between two colliders only if at least one of the colliders is a sensor. If they are both non-sensor colliders then they will be involved in the contact graph instead of the intersection graph.
Physics hooks are user-defined callbacks used to change the behavior of the physics simulation. In particular, they can be used to filter contacts (in a more flexible way than collision groups and solver groups).
Sometimes, collision groups and solver groups are not flexible enough to achieve the desired behavior. In that case, the contact filtering hooks let you apply custom rules to filter contact pairs and intersection pairs:
- For each potential contact pair (between two non-sensor colliders) detected by the broad-phase, if at least one
of the colliders involved in the pair has the bit
ActiveHooks.FILTER_CONTACT_PAIRSenabled in its active hooks, then
PhysicsHooks.firterContactPairwill be called. If this filter returns
nullthen no contact computation will happen for this pair of colliders. If it returns a
SolverFlagsvalue then the narrow-phase will compute contact points.
- For each potential intersection pair (between a sensor colliders and another collider) detected by the broad-phase, if
at least one of the colliders involved in the pair has the bit
ActiveHooks.FILTER_INTERSECTION_PAIRSenabled in its active hooks, then
PhysicsHooks.filterIntersectionPairwill be called. If this filter returns
falsethen no intersection computation will happen for this pair of colliders. If it returns
truethen the narrow-phase will test whether or not they are intersecting.
PhysicsHooks.filterContactPair returns a not-null value, it
needs to provide a set of solver flags for this contact pair. These solver flags indicate what happen with the contacts of this contact pair afterwards:
- If the returned solver flags contains the
SolverFlags.COMPUTE_IMPULSESbit, then the constraints solver will compute forces for these contacts. If this bit is not included in the returned flags, then no contact force will be computed for this pair of colliders.
Right now there is no solver flags other than
Other flags may be added in the future.
Continuous Collision Detection (CCD) is used to make sure that fast-moving objects don't miss any contacts (a problem usually called tunneling). See the rigid-body CCD section for details.