com.almasb.fxgl.physics.box2d.callbacks

Interface ContactListener

All Known Implementing Classes:

PhysicsWorld

public interface ContactListener

Implement this class to get contact information. You can use these results for things like sounds and game logic. You can also get contact results by traversing the contact lists after the time step. However, you might miss some contacts because continuous physics leads to sub-stepping. Additionally you may receive multiple callbacks for the same contact in a single time step. You should strive to make your callbacks efficient because there may be many callbacks per time step.

Author:

Daniel Murphy

Warning:

You cannot create/destroy Box2D entities inside these callbacks.

Method Summary

Modifier and Type	Method and Description
void	beginContact(Contact contact) Called when two fixtures begin to touch.
void	endContact(Contact contact) Called when two fixtures cease to touch.
void	postSolve(Contact contact, ContactImpulse impulse) This lets you inspect a contact after the solver is finished.
void	preSolve(Contact contact, Manifold oldManifold) This is called after a contact is updated.

Method Detail

beginContact

void beginContact(Contact contact)

Called when two fixtures begin to touch.

Parameters:

contact - contact info

endContact

void endContact(Contact contact)

Called when two fixtures cease to touch.

Parameters:

contact - contact info

preSolve

void preSolve(Contact contact,
              Manifold oldManifold)

This is called after a contact is updated. This allows you to inspect a contact before it goes to the solver. If you are careful, you can modify the contact manifold (e.g. disable contact). A copy of the old manifold is provided so that you can detect changes.

Note:

• This is called only for awake bodies.
• This is called even when the number of contact points is zero.
• This is not called for sensors.
• If you set the number of contact points to zero, you will not get an EndContact callback. However, you may get a BeginContact callback the next step.
• The oldManifold parameter is pooled, so it will be the same object for every callback for each thread.

Parameters:

contact - contact info

oldManifold - the old manifold

postSolve

void postSolve(Contact contact,
               ContactImpulse impulse)

This lets you inspect a contact after the solver is finished. This is useful for inspecting impulses.

Note:

• The contact manifold does not include time of impact impulses, which can be arbitrarily large if the sub-step is small. Hence the impulse is provided explicitly in a separate data structure.
• This is only called for contacts that are touching, solid, and awake.
• The impulse parameter is usually a pooled variable, so it will be modified after this call.

Parameters:

contact - contact info

impulse - contact impulse