@perplexdotgg/bounce 1.2.5 → 1.3.0

package/build/bounce.d.ts

@@ -272,7 +272,7 @@ readonly scale: 1;
 declare class Body_2 extends Body_base {
     world: World | null;
     get shape(): Shape | null;
-    set shape(value: Shape);
+    set shape(newShape: Shape);
     /**
      * integrates the linear velocity of a body
      */
@@ -318,7 +318,7 @@ declare class Body_2 extends Body_base {
 }
 export { Body_2 as Body }
 
-declare const Body_base: Monomorph<Body_2, ConvertedInputPropertyDefinitionMap<    {
+declare const Body_base: Monomorph<Body_2, ConvertedInputPropertyDefinitionMap<{
 readonly type: PropertyDefinition_2<BodyType, true>;
 readonly position: typeof Vec3;
 readonly orientation: typeof Quat;
@@ -329,7 +329,7 @@ x?: number;
 y?: number;
 z?: number;
 } | undefined>, true, typeof Vec3>;
-readonly computedBounds: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedBounds: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly min: typeof Vec3;
 readonly max: typeof Vec3;
 readonly centroid: PropertyDefinition_2<NoInfer<number[] | {
@@ -358,7 +358,7 @@ readonly restitutionFunction: PropertyDefinition_2<CoefficientFunctionType, true
 readonly mass: 0;
 readonly density: 0;
 readonly inverseMass: PropertyDefinitionNumber<true>;
-readonly computedLocalInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedLocalInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly e0: 0;
 readonly e1: 0;
 readonly e2: 0;
@@ -369,7 +369,7 @@ readonly e6: 0;
 readonly e7: 0;
 readonly e8: 0;
 }>> | undefined>, true, typeof Mat3>;
-readonly computedWorldInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedWorldInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly e0: 0;
 readonly e1: 0;
 readonly e2: 0;
@@ -411,7 +411,7 @@ readonly linearDamping: -1;
 readonly angularDamping: -1;
 readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
 readonly visitGeneration: PropertyDefinitionNumber<true>;
-}>, PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+}>, PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly type: PropertyDefinition_2<BodyType, true>;
 readonly position: typeof Vec3;
 readonly orientation: typeof Quat;
@@ -422,7 +422,7 @@ x?: number;
 y?: number;
 z?: number;
 } | undefined>, true, typeof Vec3>;
-readonly computedBounds: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedBounds: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly min: typeof Vec3;
 readonly max: typeof Vec3;
 readonly centroid: PropertyDefinition_2<NoInfer<number[] | {
@@ -451,7 +451,7 @@ readonly restitutionFunction: PropertyDefinition_2<CoefficientFunctionType, true
 readonly mass: 0;
 readonly density: 0;
 readonly inverseMass: PropertyDefinitionNumber<true>;
-readonly computedLocalInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedLocalInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly e0: 0;
 readonly e1: 0;
 readonly e2: 0;
@@ -462,7 +462,7 @@ readonly e6: 0;
 readonly e7: 0;
 readonly e8: 0;
 }>> | undefined>, true, typeof Mat3>;
-readonly computedWorldInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
+readonly computedWorldInverseInertia: PropertyDefinition_2<NoInfer<PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<{
 readonly e0: 0;
 readonly e1: 0;
 readonly e2: 0;
@@ -504,7 +504,9 @@ readonly linearDamping: -1;
 readonly angularDamping: -1;
 readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
 readonly visitGeneration: PropertyDefinitionNumber<true>;
-}>> | undefined>;
+}>> & {
+world?: World | null;
+}>;
 
 declare class BodyPairEdge extends BodyPairEdge_base {
 }
@@ -709,12 +711,12 @@ declare interface BuildTriangleMeshParams {
     vertexPositions: Float32Array;
     faceIndices: Uint32Array;
     /**
-     * If true, skips the creation of a convex hull for the triangle mesh.
-     * The hull is only used for dynamic bodies, so if the trimesh is only intended
-     * for static bodies, this can be set to true to save computation time.
-     * Also this allows for building trimeshes with more than 1k verts (hull limit)
+     * If true, forces the creation of a convex hull for the triangle mesh to estimate properties
+     * like volume and inertia tensor. The hull is only used for dynamic bodies, so if the trimesh is
+     * only intended for static bodies, this can be set to true to save computation time.
+     * Also this allows for building trimeshes with more than 1k verts (default convex hull limit)
      */
-    skipHullCreation?: boolean;
+    forceCreateConvexHull?: boolean;
 }
 
 declare class BvhModule {
@@ -862,7 +864,9 @@ readonly linearDamping: -1;
 readonly angularDamping: -1;
 readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
 readonly visitGeneration: PropertyDefinitionNumber<true>;
-}>> | undefined)[] | undefined;
+}>> & {
+world?: World | null;
+})[] | undefined;
 maxLength?: number;
 }>;
 }>, PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
@@ -974,7 +978,9 @@ readonly linearDamping: -1;
 readonly angularDamping: -1;
 readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
 readonly visitGeneration: PropertyDefinitionNumber<true>;
-}>> | undefined)[] | undefined;
+}>> & {
+world?: World | null;
+})[] | undefined;
 maxLength?: number;
 }>;
 }>> | undefined>;
@@ -1105,7 +1111,9 @@ export declare class BvhTree {
     readonly angularDamping: -1;
     readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
     readonly visitGeneration: PropertyDefinitionNumber<true>;
-    }>> | undefined)[] | undefined;
+    }>> & {
+    world?: World | null;
+    })[] | undefined;
     maxLength?: number;
     }>;
     }>, PropertyDefinitionMapInput<ConvertedInputPropertyDefinitionMap<    {
@@ -1217,7 +1225,9 @@ export declare class BvhTree {
     readonly angularDamping: -1;
     readonly firstPotentialConstraintPairEdge: PropertyDefinitionReference<ConstraintPairEdge | null, true>;
     readonly visitGeneration: PropertyDefinitionNumber<true>;
-    }>> | undefined)[] | undefined;
+    }>> & {
+    world?: World | null;
+    })[] | undefined;
     maxLength?: number;
     }>;
     }>> | undefined, BvhNode>;
@@ -2207,7 +2217,7 @@ readonly copyForDiff: PropertyDefinitionReference<ConvexHull | null, true>;
 }>> | undefined>;
 
 declare class ConvexHullBuilder {
-    buildFromPoints(vertices: Float32Array, convexRadius?: number, hullTolerance?: number, convexHullPool?: typeof ConvexHull.Pool, facePool?: typeof ConvexHullFace.Pool, numberValuePool?: typeof NumberValue.Pool, planePool?: typeof Plane.Pool, pointPool?: typeof ConvexHullPoint.Pool, shapeNoConvexPointsPool?: typeof Vec3.Pool): ConvexHull;
+    buildFromPoints(vertices: Float32Array, convexRadius?: number, hullTolerance?: number, maxPoints?: number, maxVertexIndices?: number, convexHullPool?: typeof ConvexHull.Pool, facePool?: typeof ConvexHullFace.Pool, numberValuePool?: typeof NumberValue.Pool, planePool?: typeof Plane.Pool, pointPool?: typeof ConvexHullPoint.Pool, shapeNoConvexPointsPool?: typeof Vec3.Pool): ConvexHull;
 }
 
 declare class ConvexHullFace extends ConvexHullFace_base {
@@ -5200,7 +5210,7 @@ export declare class World {
     createCylinder(options: InputType<Cylinder>): NoInfer<WithPool<Cylinder>>;
     createCapsule(options: InputType<Capsule>): NoInfer<WithPool<Capsule>>;
     createTriangleMesh(params: BuildTriangleMeshParams): NoInfer<WithPool<TriangleMesh>>;
-    createConvexHull(vertices: Float32Array, convexRadius?: number, hullTolerance?: number): NoInfer<WithPool<ConvexHull>>;
+    createConvexHull(vertices: Float32Array, convexRadius?: number, hullTolerance?: number, maxPoints?: number, maxVertexIndices?: number): NoInfer<WithPool<ConvexHull>>;
     createCompoundShape(params: {
         shape: Shape;
         transform: InputType<BasicTransform>;

package/build/bounce.js

@@ -2854,64 +2854,6 @@ class ArrayPool {
     this._count = 0;
   }
 }
-function coerceVec3Argument(obj, key) {
-  let value = obj[key];
-  if (!value) {
-    return;
-  }
-  if (Array.isArray(value)) {
-    value = { x: value[0], y: value[1], z: value[2] };
-  }
-  obj[key] = value;
-}
-function coerceQuatArgument(obj, key) {
-  let value = obj[key];
-  if (!value) {
-    return;
-  }
-  if (Array.isArray(value)) {
-    if (Array.length === 3) {
-      let x2 = value[0] * (180 / Math.PI);
-      let y4 = value[1] * (180 / Math.PI);
-      let z = value[2] * (180 / Math.PI);
-      let halfToRad = Math.PI / 360;
-      x2 *= halfToRad;
-      z *= halfToRad;
-      y4 *= halfToRad;
-      let sx = Math.sin(x2);
-      let cx = Math.cos(x2);
-      let sy = Math.sin(y4);
-      let cy = Math.cos(y4);
-      let sz = Math.sin(z);
-      let cz = Math.cos(z);
-      value = { x: 0, y: 0, z: 0, w: 0 };
-      value.x = sx * cy * cz + cx * sy * sz;
-      value.y = cx * sy * cz - sx * cy * sz;
-      value.z = cx * cy * sz + sx * sy * cz;
-      value.w = cx * cy * cz - sx * sy * sz;
-    }
-  } else if (!("w" in value)) {
-    let x2 = value.x * (180 / Math.PI);
-    let y4 = value.y * (180 / Math.PI);
-    let z = value.z * (180 / Math.PI);
-    let halfToRad = Math.PI / 360;
-    x2 *= halfToRad;
-    z *= halfToRad;
-    y4 *= halfToRad;
-    let sx = Math.sin(x2);
-    let cx = Math.cos(x2);
-    let sy = Math.sin(y4);
-    let cy = Math.cos(y4);
-    let sz = Math.sin(z);
-    let cz = Math.cos(z);
-    value = { x: 0, y: 0, z: 0, w: 0 };
-    value.x = sx * cy * cz + cx * sy * sz;
-    value.y = cx * sy * cz - sx * cy * sz;
-    value.z = cx * cy * sz + sx * sy * cz;
-    value.w = cx * cy * cz - sx * sy * sz;
-  }
-  obj[key] = value;
-}
 function getCombinedFriction(bodyA, bodyB, fallbackFrictionFunction) {
   const frictionFunction = bodyA.frictionFunction !== bodyB.frictionFunction ? fallbackFrictionFunction : bodyA.frictionFunction;
   return coefficientFunctions[frictionFunction](bodyA.friction, bodyB.friction);
@@ -8094,10 +8036,28 @@ class Body extends createClass(bodyProps, { afterConstructorCode }) {
   get shape() {
     return this["shape" + this.shapeType];
   }
-  set shape(value) {
+  set shape(newShape) {
     this["shape" + this.shapeType] = null;
-    this["shape" + value.type] = value;
-    this.shapeType = value.type;
+    this["shape" + newShape.type] = newShape;
+    this.shapeType = newShape.type;
+    if (newShape.type === ShapeType.triangleMesh && this.type === 0 && !newShape.computedVolume) {
+      const float32Array = new Float32Array(newShape.vertexPositions.length * 3);
+      let index = 0;
+      for (const vertexPosition of newShape.vertexPositions) {
+        float32Array[index++] = vertexPosition.x;
+        float32Array[index++] = vertexPosition.y;
+        float32Array[index++] = vertexPosition.z;
+      }
+      const hull = this.world.triangleMeshBuilder.convexHullBuilder.buildFromPoints(
+        float32Array,
+        0.02,
+        1e-3,
+        Infinity,
+        Infinity
+      );
+      newShape.computedVolume = hull.computedVolume;
+      newShape.inertia.copy(hull.inertia);
+    }
     updateBody(this);
   }
   // physics integration functions
@@ -8350,6 +8310,21 @@ class Body extends createClass(bodyProps, { afterConstructorCode }) {
     this.world.broadphase.markDynamicBodyAsDirty(this);
   }
 }
+const oldCreate$1 = Body.create;
+Body.create = function() {
+  const data = arguments[0];
+  const body2 = oldCreate$1.apply(this, arguments);
+  body2.orientation.normalize();
+  body2.previousPosition.copy(body2.position);
+  body2.previousOrientation.copy(body2.orientation);
+  if (data.world) {
+    body2.world = data.world;
+  }
+  if (data.shape) {
+    body2.shape = data.shape;
+  }
+  return body2;
+};
 const forcePointInWorldSpace = /* @__PURE__ */ Vec3.create();
 const impulsePointInWorldSpace = /* @__PURE__ */ Vec3.create();
 const angularDofsMask = /* @__PURE__ */ Vec3.create();
@@ -8364,20 +8339,6 @@ const deltaVelocity = /* @__PURE__ */ Vec3.create();
 const angularInverseMass = /* @__PURE__ */ Vec3.create();
 const rotationDelta = /* @__PURE__ */ Vec3.create();
 const isometry$1 = /* @__PURE__ */ Isometry.create();
-const oldCreate$1 = Body.create;
-Body.create = function() {
-  const data = arguments[0];
-  coerceVec3Argument(data, "position");
-  coerceQuatArgument(data, "orientation");
-  const body2 = oldCreate$1.apply(this, arguments);
-  body2.orientation.normalize();
-  body2.previousPosition.copy(body2.position);
-  body2.previousOrientation.copy(body2.orientation);
-  if (data.shape) {
-    body2.shape = data.shape;
-  }
-  return body2;
-};
 function updateCenterOfMassPosition(body2) {
   shapeCenterOfMassInWorldSpace$1.copy(body2.shape.computedCenterOfMass);
   shapeCenterOfMassInWorldSpace$1.transformByQuat(body2.orientation);
@@ -14852,9 +14813,7 @@ const n = /* @__PURE__ */ Mat3.create();
 const adj_n = /* @__PURE__ */ Mat3.create();
 const transformedOffset = /* @__PURE__ */ Vec3.create();
 class ConvexHullBuilder {
-  buildFromPoints(vertices, convexRadius = 0.02, hullTolerance = 1e-3, convexHullPool = new ConvexHull.Pool(), facePool = new ConvexHullFace.Pool(), numberValuePool = new NumberValue.Pool(), planePool = new Plane.Pool(), pointPool = new ConvexHullPoint.Pool(), shapeNoConvexPointsPool = new Vec3.Pool()) {
-    const maxPoints = 1e3;
-    const maxVertexIndices = 1e3;
+  buildFromPoints(vertices, convexRadius = 0.02, hullTolerance = 1e-3, maxPoints = 1e3, maxVertexIndices = 1e3, convexHullPool = new ConvexHull.Pool(), facePool = new ConvexHullFace.Pool(), numberValuePool = new NumberValue.Pool(), planePool = new Plane.Pool(), pointPool = new ConvexHullPoint.Pool(), shapeNoConvexPointsPool = new Vec3.Pool()) {
     const hull = ConvexHull.create({
       convexRadius,
       faces: { pool: facePool },
@@ -15130,8 +15089,8 @@ class TriangleMeshBuilder {
       nodes: { pool: nodes }
     }, bvhTreePool);
     mesh.bvh.build(mesh, triangles);
-    if (!params.skipHullCreation) {
-      const hull = this.convexHullBuilder.buildFromPoints(params.vertexPositions, 0, 1e-3);
+    if (params.forceCreateConvexHull) {
+      const hull = this.convexHullBuilder.buildFromPoints(params.vertexPositions, 0, 1e-3, Infinity, Infinity);
       mesh.computedVolume = hull.computedVolume;
       mesh.inertia.copy(hull.inertia);
     }
@@ -15624,11 +15583,13 @@ class World {
     shape.world = this;
     return shape;
   }
-  createConvexHull(vertices, convexRadius = 0.02, hullTolerance = 1e-3) {
+  createConvexHull(vertices, convexRadius = 0.02, hullTolerance = 1e-3, maxPoints = 1e3, maxVertexIndices = 1e3) {
     const shape = this.convexHullBuilder.buildFromPoints(
       vertices,
       convexRadius,
       hullTolerance,
+      maxPoints,
+      maxVertexIndices,
       this.pools.convexHull,
       this.pools.convexHullFace,
       this.pools.convexHullNumberValue,
@@ -15698,6 +15659,7 @@ class World {
   createStaticBody(options) {
     options = options ?? {};
     options.type = BodyType.static;
+    options.world = this;
     const body2 = this.staticBodies.create(options);
     const bodyCopy = this.staticBodyCopies.create(options);
     bodyCopy.copy(body2);
@@ -15709,22 +15671,22 @@ class World {
   createDynamicBody(options) {
     options = options ?? {};
     options.type = BodyType.dynamic;
+    options.world = this;
     const body2 = this.dynamicBodies.create(options);
     const bodyCopy = this.dynamicBodyCopies.create(options);
     bodyCopy.copy(body2);
     body2.copyForDiff = bodyCopy;
-    body2.world = this;
     this.broadphase.addDynamicBody(body2);
     return body2;
   }
   createKinematicBody(options) {
     options = options ?? {};
     options.type = BodyType.kinematic;
+    options.world = this;
     const body2 = this.kinematicBodies.create(options);
     const bodyCopy = this.kinematicBodyCopies.create(options);
     bodyCopy.copy(body2);
     body2.copyForDiff = bodyCopy;
-    body2.world = this;
     this.broadphase.addKinematicBody(body2);
     return body2;
   }

package/docs/documentation.md

@@ -99,9 +99,10 @@ const world = new World({
   isWarmStartingEnabled: true,
 
   // contact manifold limits
-  // by default since 1.3.0, these are unlimited
+  // by default since v1.3.0, these are unlimited
   // if set to a finite amount, an error is thrown when an allocation is attempted past the limit
   // this may be desired during development to stay within a strict memory budget, for example
+  // 1024 is a reasonable limit for many use cases (it was the default prior to v1.3.0)
   contactManifoldOptions: {
     maxContactManifolds: Infinity,
     maxContactPairs: Infinity,
@@ -142,7 +143,9 @@ const vertexPositions = new Float32Array([0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]);
 const shape = world.createConvexHull(
   vertexPositions, // Float32Array of vertex positions
   0.02, // convexRadius (optional, default 0.02)
-  1e-3 // hullTolerance (optional, default 1e-3)
+  1e-3, // hullTolerance (optional, default 1e-3 = 0.001)
+  1000, // maxPoints (optional, default 1000)
+  1000  // maxVertexIndices (optional, default 1000)
 );
 
 const body = world.createDynamicBody({ shape: shape, position: [0, 0, 5] });
@@ -169,7 +172,11 @@ const indices = new Uint32Array([
 const shape = world.createTriangleMesh({
   vertexPositions: vertices,
   faceIndices: indices,
-  skipHullCreation: true, // skip hull for static-only meshes (allows >1k verts)
+
+  // optional, if you want to estimate the volume or inertia tensor based on the convex hull
+  // note that a convex hull is automatically created if a triangle mesh is used as a dynamic body
+  // that said, triangle meshes are generally not recommended as dynamic bodies, for performance reasons
+  forceCreateConvexHull: false,
 });
 
 const body = world.createStaticBody({ shape: shape });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perplexdotgg/bounce",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "license": "MIT",
   "description": "Bounce",
   "main": "./build/bounce.js",