@woosh/meep-engine 2.124.10 → 2.124.11

package/package.json

@@ -5,7 +5,7 @@
   "description": "Pure JavaScript game engine. Fully featured and production ready.",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.124.10",
+  "version": "2.124.11",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/math/spline/spline_hermite3.d.ts

@@ -7,6 +7,9 @@
  * @param {number} m0 first tangent (tangent exiting from first value)
  * @param {number} m1 second tangent (tangent entering into second value)
  * @return {number}
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export function spline_hermite3(t: number, p0: number, p1: number, m0: number, m1: number): number;
 //# sourceMappingURL=spline_hermite3.d.ts.map

package/src/core/math/spline/spline_hermite3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spline_hermite3.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/spline/spline_hermite3.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,mCAPW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACL,MAAM,CAajB"}
+{"version":3,"file":"spline_hermite3.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/spline/spline_hermite3.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,mCAVW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACL,MAAM,CAgBjB"}

package/src/core/math/spline/spline_hermite3.js

@@ -7,6 +7,9 @@
  * @param {number} m0 first tangent (tangent exiting from first value)
  * @param {number} m1 second tangent (tangent entering into second value)
  * @return {number}
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export function spline_hermite3(t, p0, p1, m0, m1) {
 

package/src/engine/animation/curve/AnimationCurve.d.ts

@@ -1,6 +1,10 @@
 /**
- * Describes change of a numeric value over time. Values are stored in {@link Keyframe}s, interpolation is defined by tangents on keyframes
- * Inspired by unity's AnimationCurve, see https://docs.unity3d.com/ScriptReference/AnimationCurve.html
+ * Describes change of a numeric value over time.
+ * Values are stored in {@link Keyframe}s, interpolation is defined by tangents on {@link Keyframe}s.
+ * The curve is a cubic Hermite spline, see https://en.wikipedia.org/wiki/Cubic_Hermite_spline.
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export class AnimationCurve {
     /**
@@ -81,6 +85,12 @@ export class AnimationCurve {
      * @returns {number}
      */
     get duration(): number;
+    /**
+     * Returns index of a key that is just before or at the time specified.
+     * @param {number} time
+     * @returns {number} index of the key
+     */
+    getKeyIndexByTime(time: number): number;
     /**
      *
      * @param {number} time time in seconds

package/src/engine/animation/curve/AnimationCurve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnimationCurve.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/AnimationCurve.js"],"names":[],"mappings":"AAqBA;;;GAGG;AACH;IAkFI;;;;OAIG;IACH,kBAHW,QAAQ,EAAE,GACR,cAAc,CAQ1B;IA0ND;;;;;;;OAOG;IACH,6BANW,MAAM,eACN,MAAM,YACN,MAAM,aACN,MAAM,GACL,cAAc,CAUzB;IAED;;;;;;OAMG;IACH,4BALW,MAAM,YACN,MAAM,UACN,MAAM,GACL,cAAc,CAOzB;IAED;;;;;;;OAOG;IACH,0BANW,MAAM,eACN,MAAM,YACN,MAAM,aACN,MAAM,GACL,cAAc,CAYzB;IAxWD;;;OAGG;IACH,eAFU,QAAQ,EAAE,CAEV;IAEV;;;;OAIG;IACH,SAHW,QAAQ,GACN,MAAM,CAgClB;IAED;;;OAGG;IACH,cAFW,QAAQ,EAAE,QAUpB;IAED;;;;OAIG;IACH,YAHW,QAAQ,GACN,OAAO,CAYnB;IAED;;OAEG;IACH,cAEC;IAeD;;;OAGG;IACH,cAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAYlB;IAED;;;OAGG;IACH,gBAFY,MAAM,CAYjB;IAED;;;OAGG;IACH,gBAFa,MAAM,CAelB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACL,MAAM,CAiCjB;IAED;;;;OAIG;IACH,qBAFW,MAAM,QA+BhB;IAED;;;;OAIG;IACH,sBAHW,MAAM,UACN,MAAM,QAWhB;IAED,0BAKC;IAED;;;;OAIG;IACH,cAHW,cAAc,GACb,OAAO,CAIlB;IAED;;;OAGG;IACH,YAFW,cAAc,QAIxB;IAED;;;OAGG;IACH,SAFY,cAAc,CAQzB;IAED;;;OAGG;IACH,QAFY,MAAM,CAIjB;IAED;;MAIC;IAED;;aAeC;CAqDJ;yBA1XwB,eAAe"}
+{"version":3,"file":"AnimationCurve.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/AnimationCurve.js"],"names":[],"mappings":"AAqBA;;;;;;;GAOG;AACH;IAkFI;;;;OAIG;IACH,kBAHW,QAAQ,EAAE,GACR,cAAc,CAQ1B;IAgRD;;;;;;;OAOG;IACH,6BANW,MAAM,eACN,MAAM,YACN,MAAM,aACN,MAAM,GACL,cAAc,CAUzB;IAED;;;;;;OAMG;IACH,4BALW,MAAM,YACN,MAAM,UACN,MAAM,GACL,cAAc,CAOzB;IAED;;;;;;;OAOG;IACH,0BANW,MAAM,eACN,MAAM,YACN,MAAM,aACN,MAAM,GACL,cAAc,CAYzB;IA9ZD;;;OAGG;IACH,eAFU,QAAQ,EAAE,CAEV;IAEV;;;;OAIG;IACH,SAHW,QAAQ,GACN,MAAM,CAgClB;IAED;;;OAGG;IACH,cAFW,QAAQ,EAAE,QAUpB;IAED;;;;OAIG;IACH,YAHW,QAAQ,GACN,OAAO,CAYnB;IAED;;OAEG;IACH,cAEC;IAeD;;;OAGG;IACH,cAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAYlB;IAED;;;OAGG;IACH,gBAFY,MAAM,CAYjB;IAED;;;OAGG;IACH,gBAFa,MAAM,CAelB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,MAAM,CA0ClB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACL,MAAM,CAoCjB;IAED;;;;OAIG;IACH,qBAFW,MAAM,QAmChB;IAED;;;;OAIG;IACH,sBAHW,MAAM,UACN,MAAM,QAWhB;IAED,0BAKC;IAED;;;;OAIG;IACH,cAHW,cAAc,GACb,OAAO,CAIlB;IAED;;;OAGG;IACH,YAFW,cAAc,QAIxB;IAED;;;OAGG;IACH,SAFY,cAAc,CAQzB;IAED;;;OAGG;IACH,QAFY,MAAM,CAIjB;IAED;;MAIC;IAED;;aAeC;CAqDJ;yBApbwB,eAAe"}

package/src/engine/animation/curve/AnimationCurve.js

@@ -20,8 +20,12 @@ function compareKeyframeToTime(time, keyframe) {
 }
 
 /**
- * Describes change of a numeric value over time. Values are stored in {@link Keyframe}s, interpolation is defined by tangents on keyframes
- * Inspired by unity's AnimationCurve, see https://docs.unity3d.com/ScriptReference/AnimationCurve.html
+ * Describes change of a numeric value over time.
+ * Values are stored in {@link Keyframe}s, interpolation is defined by tangents on {@link Keyframe}s.
+ * The curve is a cubic Hermite spline, see https://en.wikipedia.org/wiki/Cubic_Hermite_spline.
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export class AnimationCurve {
     /**
@@ -177,6 +181,53 @@ export class AnimationCurve {
         return last.time - first.time;
     }
 
+    /**
+     * Returns index of a key that is just before or at the time specified.
+     * @param {number} time
+     * @returns {number} index of the key
+     */
+    getKeyIndexByTime(time) {
+        const keys = this.keys;
+        const key_count = keys.length;
+
+        let i0 = 0;
+        let i1 = key_count - 1;
+
+        if (time <= keys[0].time) {
+            // before start
+            return 0;
+        }
+
+        // binary search
+        while (i0 <= i1) {
+            const pivot = (i0 + i1) >>> 1;
+
+            const key = keys[pivot];
+            const key_time = key.time;
+
+            if (key_time < time) {
+                i0 = pivot + 1;
+            } else if (key_time > time) {
+                i1 = pivot - 1;
+            } else {
+                i0 = pivot;
+                break;
+            }
+        }
+
+        if (i0 > i1) {
+            // swap
+            i0 = i1;
+        }
+
+        // fast-forward to last matching frame if there are multiple matches
+        while (i0 + 1 < key_count - 1 && keys[i0 + 1].time === time) {
+            i0++;
+        }
+
+        return i0;
+    }
+
     /**
      *
      * @param {number} time time in seconds
@@ -189,30 +240,33 @@ export class AnimationCurve {
         const key_count = keys.length;
 
         if (key_count === 0) {
+            // no keys, produce arbitrary value
             return 0;
         }
 
         if (key_count === 1) {
+            // only have one key
             return keys[0].value;
         }
 
-        if (time <= keys[0].time) {
-            // before start
-            return keys[0].value;
-        }
+        const i = this.getKeyIndexByTime(time);
 
-        for (let i = 1; i < key_count; i++) {
-            const keyframe1 = keys[i];
+        if (i >= key_count - 1) {
+            // past last keyframe
+            return keys[key_count - 1].value;
+        }
 
-            if (time < keyframe1.time) {
-                const keyframe0 = keys[i - 1];
+        const keyframe0 = keys[i];
 
-                return evaluate_two_key_curve(time, keyframe0, keyframe1);
-            }
+        if (keyframe0.time >= time) {
+            // on or past the keyframe
+            return keyframe0.value;
         }
 
-        // past end
-        return keys[key_count - 1].value;
+        const keyframe1 = keys[i + 1];
+
+        return evaluate_two_key_curve(time, keyframe0, keyframe1);
+
     }
 
     /**
@@ -230,6 +284,11 @@ export class AnimationCurve {
         const key_main = keys[index];
 
         const has_previous = index > 0;
+
+        const has_next = index < last_index;
+
+        // TODO check out https://github.com/MonoGame/MonoGame/blob/f6ce4cbbe3ca5a93f0d1926f58ed501217a04069/MonoGame.Framework/Curve.cs#L232
+
         if (has_previous) {
             const key_previous = keys[index - 1];
 
@@ -239,7 +298,6 @@ export class AnimationCurve {
             key_main.inTangent = value_span / time_span;
         }
 
-        const has_next = index < last_index;
 
         if (has_next) {
             const key_next = keys[index + 1];

package/src/engine/animation/curve/Keyframe.d.ts

@@ -1,5 +1,8 @@
 /**
  * Single keyframe of {@link AnimationCurve}
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export class Keyframe {
     /**

package/src/engine/animation/curve/Keyframe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Keyframe.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/Keyframe.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAyBI;;;;;;;OAOG;IACH,kBANW,MAAM,SACN,MAAM,cACN,MAAM,eACN,MAAM,GACL,QAAQ,CAQnB;IAtCD;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,MAFU,MAAM,CAEP;IAET;;;OAGG;IACH,WAFU,MAAM,CAEF;IAEd;;;OAGG;IACH,YAFU,MAAM,CAED;IAkBf;;;;;;OAMG;IACH,UALW,MAAM,SACN,MAAM,aACN,MAAM,cACN,MAAM,QAmBhB;IAED;;;;OAIG;IACH,cAHW,QAAQ,GACN,OAAO,CAQnB;IAED;;;OAGG;IACH,YAFW,QAAQ,QAOlB;IAED;;;OAGG;IACH,SAFY,QAAQ,CAQnB;IAED;;;OAGG;IACH,QAFY,MAAM,CAKjB;IAED;;;;;MAOC;IAED;;;;;aAQC;IAIL;;;;OAIG;IACH,qBAFU,OAAO,CAEY;CAP5B"}
+{"version":3,"file":"Keyframe.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/Keyframe.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH;IAyBI;;;;;;;OAOG;IACH,kBANW,MAAM,SACN,MAAM,cACN,MAAM,eACN,MAAM,GACL,QAAQ,CAQnB;IAtCD;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,MAFU,MAAM,CAEP;IAET;;;OAGG;IACH,WAFU,MAAM,CAEF;IAEd;;;OAGG;IACH,YAFU,MAAM,CAED;IAkBf;;;;;;OAMG;IACH,UALW,MAAM,SACN,MAAM,aACN,MAAM,cACN,MAAM,QAmBhB;IAED;;;;OAIG;IACH,cAHW,QAAQ,GACN,OAAO,CAQnB;IAED;;;OAGG;IACH,YAFW,QAAQ,QAOlB;IAED;;;OAGG;IACH,SAFY,QAAQ,CAQnB;IAED;;;OAGG;IACH,QAFY,MAAM,CAKjB;IAED;;;;;MAOC;IAED;;;;;aAQC;IAIL;;;;OAIG;IACH,qBAFU,OAAO,CAEY;CAP5B"}

package/src/engine/animation/curve/Keyframe.js

@@ -3,6 +3,9 @@ import { computeHashFloat } from "../../../core/primitives/numbers/computeHashFl
 
 /**
  * Single keyframe of {@link AnimationCurve}
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export class Keyframe {
     /**

package/src/engine/animation/curve/animation_curve_optimize.d.ts

@@ -3,6 +3,9 @@
  * Intended to reduce complexity of a curve to improve performance and lower memory usage
  * @param {AnimationCurve} curve
  * @param {number} [error_tolerance] how much of a loss to accept, this is relative to normalized value bounds of the curve
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export function animation_curve_optimize(curve: AnimationCurve, error_tolerance?: number): void;
 //# sourceMappingURL=animation_curve_optimize.d.ts.map

package/src/engine/animation/curve/animation_curve_optimize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"animation_curve_optimize.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/animation_curve_optimize.js"],"names":[],"mappings":"AA0CA;;;;;GAKG;AACH,gDAHW,cAAc,oBACd,MAAM,QA0ChB"}
+{"version":3,"file":"animation_curve_optimize.d.ts","sourceRoot":"","sources":["../../../../../src/engine/animation/curve/animation_curve_optimize.js"],"names":[],"mappings":"AAkDA;;;;;;;;GAQG;AACH,gDANW,cAAc,oBACd,MAAM,QA6ChB"}

package/src/engine/animation/curve/animation_curve_optimize.js

@@ -12,9 +12,17 @@ const NORMALIZED_CHECK_DISTANCE = 0.07;
  * @param {Keyframe} key_middle
  * @param {Keyframe} key_previous
  * @param {Keyframe} key_next
- * @return {number} value delta if the middle frame is removed
+ * @return {number} value delta if the middle frame is removed, the higher this value - the more important the middle keyframe is
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
-function compute_keyframe_value_effect(key_middle, key_previous, key_next) {
+function compute_keyframe_value_effect(
+    key_middle,
+    key_previous,
+    key_next
+) {
+
     // check if this key contributes to the shape
     const v1_actual = evaluate_two_key_curve(key_middle.time, key_previous, key_next);
     const v1_expected = key_middle.value;
@@ -45,6 +53,9 @@ function compute_keyframe_value_effect(key_middle, key_previous, key_next) {
  * Intended to reduce complexity of a curve to improve performance and lower memory usage
  * @param {AnimationCurve} curve
  * @param {number} [error_tolerance] how much of a loss to accept, this is relative to normalized value bounds of the curve
+ *
+ * @author Alex Goldring
+ * @copyright Company Named Limited (c) 2025
  */
 export function animation_curve_optimize(curve, error_tolerance = 1e-3) {
     assert.lessThan(error_tolerance, 1, 'error_tolerance must be less than 1');