bullet trimesh caching (cocos#13488)

* bullet trimesh caching cocos#12949

cocos/physics/bullet/bullet-triangle-mesh.ts

@@ -0,0 +1,66 @@
+/*
+ Copyright (c) 2020 Xiamen Yaji Software Co., Ltd.
+
+ https://www.cocos.com/
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated engine source code (the "Software"), a limited,
+ worldwide, royalty-free, non-assignable, revocable and non-exclusive license
+ to use Cocos Creator solely to develop games on your target platforms. You shall
+ not use Cocos Creator software for developing other software or tools that's
+ used for developing games. You are not granted to publish, distribute,
+ sublicense, and/or sell copies of Cocos Creator.
+
+ The software or tools in this License Agreement are licensed, not sold.
+ Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+import { bt, EBulletType } from './instantiated';
+import { Mesh } from '../../3d/assets';
+import { cocos2BulletTriMesh } from './bullet-utils';
+
+export class BulletTriangleMesh {
+    private static readonly BulletTriangleMeshMap = new Map<number, BulletTriangleMesh>();
+
+    static getBulletTriangleMesh (key: number, mesh: Mesh) {
+        let newTriangleMesh!: BulletTriangleMesh;//Bullet.ptr;
+        if (BulletTriangleMesh.BulletTriangleMeshMap.has(key)) { //can be improved
+            newTriangleMesh = BulletTriangleMesh.BulletTriangleMeshMap.get(key)!;
+        } else {
+            newTriangleMesh = new BulletTriangleMesh(key);
+            cocos2BulletTriMesh(newTriangleMesh.bulletTriangleMeshInternal, mesh);
+            BulletTriangleMesh.BulletTriangleMeshMap.set(key, newTriangleMesh);
+        }
+        return newTriangleMesh;
+    }
+
+    private readonly key: number;
+    private ref = 0;
+    bulletTriangleMeshInternal : Bullet.ptr;
+
+    set reference (v: boolean) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+        v ? this.ref++ : this.ref--;
+        if (this.ref === 0) { this.destroy(); }
+    }
+
+    private constructor (key: number) {
+        this.key = key;
+        this.bulletTriangleMeshInternal = bt.TriangleMesh_new();
+    }
+
+    private destroy () {
+        if (this.bulletTriangleMeshInternal) {
+            bt._safe_delete(EBulletType.EBulletTypeTriangleMesh, this.bulletTriangleMeshInternal);
+        }
+        BulletTriangleMesh.BulletTriangleMeshMap.delete(this.key);
+    }
+}

cocos/physics/bullet/shapes/bullet-trimesh-shape.ts

@@ -31,8 +31,11 @@ import { cocos2BulletVec3, cocos2BulletTriMesh } from '../bullet-utils';
 import { ITrimeshShape } from '../../spec/i-physics-shape';
 import { BulletCache } from '../bullet-cache';
 import { bt, EBulletType } from '../instantiated';
+import { BulletTriangleMesh } from '../bullet-triangle-mesh';
 
 export class BulletTrimeshShape extends BulletShape implements ITrimeshShape {
+    private static _mapTrimesh2btBVHMeshShape = {};
+
     public get collider () {
         return this._collider as MeshCollider;
     }
@@ -49,13 +52,18 @@ export class BulletTrimeshShape extends BulletShape implements ITrimeshShape {
                 const btTriangleMesh = this._getBtTriangleMesh(mesh);
                 if (this.collider.convex) {
                     this._impl = bt.ConvexTriangleMeshShape_new(btTriangleMesh);
-                } else {
-                    this._impl = bt.BvhTriangleMeshShape_new(btTriangleMesh, true, true);
+                } else if (BulletTrimeshShape._mapTrimesh2btBVHMeshShape[mesh.hash] == null) { // triangle mesh and bvh is not built
+                    const bvhTrimesh = bt.BvhTriangleMeshShape_new(btTriangleMesh, true, true);
+                    BulletTrimeshShape._mapTrimesh2btBVHMeshShape[mesh.hash] = bvhTrimesh;
+                    this._impl = bt.ScaledBvhTriangleMeshShape_new(bvhTrimesh, 1, 1, 1);
+                } else if (BulletTrimeshShape._mapTrimesh2btBVHMeshShape[mesh.hash]) { // triangle mesh and bvh is already built
+                    const bvhMeshShapePtr = BulletTrimeshShape._mapTrimesh2btBVHMeshShape[mesh.hash];
+                    this._impl = bt.ScaledBvhTriangleMeshShape_new(bvhMeshShapePtr, 1, 1, 1);
                 }
                 const bt_v3 = BulletCache.instance.BT_V3_0;
                 cocos2BulletVec3(bt_v3, this._collider.node.worldScale);
-                bt.CollisionShape_setMargin(this._impl, 0.01);
                 bt.CollisionShape_setLocalScaling(this._impl, bt_v3);
+                bt.CollisionShape_setMargin(this._impl, 0.01);
                 this.setCompound(this._compound);
                 this.updateByReAdd();
                 this.setWrapper();
@@ -66,13 +74,15 @@ export class BulletTrimeshShape extends BulletShape implements ITrimeshShape {
     }
 
     private refBtTriangleMesh: Bullet.ptr = 0;
+    private triangleMesh!: BulletTriangleMesh;
 
     onComponentSet () {
         this.setMesh(this.collider.mesh);
     }
 
     onDestroy () {
         if (this.refBtTriangleMesh) {  bt._safe_delete(this.refBtTriangleMesh, EBulletType.EBulletTypeTriangleMesh); }
+        if (this.triangleMesh) { this.triangleMesh.reference = false; }
         super.onDestroy();
     }
 
@@ -85,8 +95,11 @@ export class BulletTrimeshShape extends BulletShape implements ITrimeshShape {
     }
 
     private _getBtTriangleMesh (mesh: Mesh): Bullet.ptr {
-        this.refBtTriangleMesh = bt.TriangleMesh_new();
-        cocos2BulletTriMesh(this.refBtTriangleMesh, mesh);
-        return this.refBtTriangleMesh;
+        this.triangleMesh = BulletTriangleMesh.getBulletTriangleMesh(mesh.hash, mesh);
+        if (!this.triangleMesh.bulletTriangleMeshInternal) {
+            console.warn('BulletTrimeshShape::_getBtTriangleMesh() return null');
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return this.triangleMesh.bulletTriangleMeshInternal;
     }
 }

package.json

@@ -87,7 +87,7 @@
   },
   "dependencies": {
     "@cocos/box2d": "1.0.1",
-    "@cocos/bullet": "1.0.6",
+    "@cocos/bullet": "1.0.7",
     "@cocos/cannon": "1.2.8",
     "@cocos/dragonbones-js": "^1.0.1",
     "@cocos/physx": "1.0.7"