2D 碰撞回调

2D 碰撞回调

当物体在场景中移动并碰撞到其它物体时，物理引擎会处理大部分必要的碰撞检测，我们一般不需要关心这些情况。但是制作物理游戏最主要的点是有些情况下物体碰撞后应该发生些什么，比如角色碰到怪物后会死亡，或者球在地上弹动时应该产生声音等。

我们需要一个方式来获取到这些碰撞信息，物理引擎提供的方式是在碰撞发生时产生回调，在回调里我们可以根据产生碰撞的两个碰撞体的类型信息来判断需要作出什么样的动作。

注意：

Box2D 物理模块需要先在 Rigidbody 中 开启碰撞监听，才会有相应的回调产生。Builtin 物理模块只需要有碰撞体组件就可以产生碰撞回调。开启方法为，在 Rigidbody2D 的 属性检查器 勾选 EnabledContactListener 属性，如下图所示：
回调中的信息在物理引擎都是以缓存的形式存在的，所以信息只有在这个回调中才是有用的，不要在你的脚本里直接缓存这些信息，但可以缓存这些信息的副本。
在回调中创建的物理物体，比如刚体，关节等，这些不会立刻就创建出对应的物体，会在整个物理系统更新完成后再进行这些物体的创建。

注册回调函数

注册一个碰撞回调函数有两种方式，一种是通过指定的 collider 注册；另一种是通过 2D 物理系统注册一个全局的回调函数。

注意：Builtin 2D 物理模块只会发送 BEGIN_CONTACT 和 END_CONTACT 回调消息。

@ccclass('TestContactCallBack')
export class TestContactCallBack extends Component {
    start () {
        // 注册单个碰撞体的回调函数
        let collider = this.getComponent(Collider2D);
        if (collider) {
            collider.on(Contact2DType.BEGIN_CONTACT, this.onBeginContact, this);
            collider.on(Contact2DType.END_CONTACT, this.onEndContact, this);
            collider.on(Contact2DType.PRE_SOLVE, this.onPreSolve, this);
            collider.on(Contact2DType.POST_SOLVE, this.onPostSolve, this);
        }
        // 注册全局碰撞回调函数
        if (PhysicsSystem2D.instance) {
            PhysicsSystem2D.instance.on(Contact2DType.BEGIN_CONTACT, this.onBeginContact, this);
            PhysicsSystem2D.instance.on(Contact2DType.END_CONTACT, this.onEndContact, this);
            PhysicsSystem2D.instance.on(Contact2DType.PRE_SOLVE, this.onPreSolve, this);
            PhysicsSystem2D.instance.on(Contact2DType.POST_SOLVE, this.onPostSolve, this);
        }
    }
    onBeginContact (selfCollider: Collider2D, otherCollider: Collider2D, contact: IPhysics2DContact | null) {
        // 只在两个碰撞体开始接触时被调用一次
        console.log('onBeginContact');
    }
    onEndContact (selfCollider: Collider2D, otherCollider: Collider2D, contact: IPhysics2DContact | null) {
        // 只在两个碰撞体结束接触时被调用一次
        console.log('onEndContact');
    }
    onPreSolve (selfCollider: Collider2D, otherCollider: Collider2D, contact: IPhysics2DContact | null) {
        // 每次将要处理碰撞体接触逻辑时被调用
        console.log('onPreSolve');
    }
    onPostSolve (selfCollider: Collider2D, otherCollider: Collider2D, contact: IPhysics2DContact | null) {
        // 每次处理完碰撞体接触逻辑时被调用
        console.log('onPostSolve');
    }
}

上面的代码示例演示了如何在脚本中添加所有的碰撞回调函数。回调一共有四种，每种回调函数都有三个参数，详情可查看下方的 回调参数 说明。每种回调函数的作用如注释所示，开发者可以根据自己的需求实现相应的回调函数。

Box2D 物理模块碰撞回调的顺序

Box2D 物理模块模拟碰撞的过程是比较复杂的，我们可以通过拆分一个简单示例的碰撞过程来查看碰撞回调函数的回调顺序和回调的时机。假设有两个刚体正相互移动，三角形往右运动，方块往左运动，它们即将碰撞到一起。

碰撞的过程

碰撞 1

碰撞 2

碰撞 3

当两个碰撞体相互覆盖时，Box2D 默认的行为是给每个碰撞体一个冲量将它们分开，但是这个行为不一定能在一个物理周期内完成。像这里显示的一样，示例中的碰撞体会在三个物理周期内相互覆盖直到“反弹”完成并且它们相互分离。在这个时间里可以定制我们想要的行为，onPreSolve 会在每次物理引擎处理碰撞前回调，可以在这个回调里修改碰撞信息； onPostSolve 会在处理完成这次碰撞后回调，可以在这个回调中获取到物理引擎计算出的碰撞的冲量信息。

下面给出的输出信息能使我们更清楚回调的顺序。

        …
    Step
    Step
    BeginContact
    PreSolve
    PostSolve
    Step
    PreSolve
    PostSolve
    Step
    PreSolve
    PostSolve
    Step
    EndContact
    Step
    Step
    …

回调的参数

回调的参数包含了所有的碰撞接触信息，每个回调函数都提供了三个参数：

selfCollider：指的是回调脚本的节点上的碰撞体；
otherCollider：指的是发生碰撞的另一个碰撞体；
contact：是一个 IPhysics2DContact。包含碰撞最主要的信息。其中比较常用的信息就是碰撞的位置和法向量，contact 内部是按照刚体的本地坐标来存储信息的，而我们一般需要的是世界坐标系下的信息，我们可以通过 contact.getWorldManifold 来获取这些信息。注意，在 Builtin 物理模块这个参数为空。

worldManifold

const worldManifold = contact.getWorldManifold();
const points = worldManifold.points;
const normal = worldManifold.normal;

worldManifold 包括以下成员：

points

碰撞点数组，它们不一定会精确地在碰撞体碰撞的地方上，如下图所示（除非你将刚体设置为子弹类型，但是会比较耗性能），但实际上这些点在使用时一般都是够用的。

注意：不是每一个碰撞都会有两个碰撞点，在模拟的更多的情况下只会产生一个碰撞点，下面列举一些其它的碰撞示例。
normal

碰撞点上的法向量，由自身碰撞体指向对方碰撞体，指明解决碰撞最快的方向。

上图所示的线条即碰撞点上的法向量，在这个碰撞中，解决碰撞最快的途径是添加冲量将三角形往左上推，将方块往右下推。需要注意的是这里的法向量只是一个方向，并不带有位置属性，也不会连接到这些碰撞点中的任何一个。

你还需要注意的是 碰撞法向量并不是碰撞体碰撞的角度，它只会指明可以解决两个碰撞体相互覆盖这一问题最短的方向。比如上面的例子中如果三角形移动得更快一点，覆盖的情形像下图所示的话：

那么最短的方式将会是把三角形往右上推，所以使用法向量来作为碰撞角度不是一个好主意。如果想要知道碰撞的真正方向，可以使用以下方式获取两个碰撞体相互碰撞时在碰撞点上的相对速度。
```
const vel1 = triangleBody.getLinearVelocityFromWorldPoint(worldManifold.points[0]);
const vel2 = squareBody.getLinearVelocityFromWorldPoint(worldManifold.points[0]);
const relativeVelocity = vel1.sub(vel2);
```

禁用 contact

contact.disabled = true;

禁用 contact 会使物理引擎在计算碰撞时会忽略掉这次碰撞，禁用将会持续到碰撞完成，除非在其它回调中再将这个 contact 启用。

或者如果只想在本次物理处理步骤中禁用 contact，可以使用 disabledOnce。

contact.disabledOnce = true;

修改 contact 信息

前面有提到我们在 onPreSolve 中修改 contact 的信息，因为 onPreSolve 是在物理引擎处理碰撞信息前回调的，所以对碰撞信息的修改会影响到后面的碰撞计算。

// 修改碰撞体间的摩擦力
contact.setFriction(friction);
// 修改碰撞体间的弹性系数
contact.setRestitution(restitution);

注意：这些修改只会在本次物理处理步骤中生效。