@woosh/meep-engine 2.126.34 → 2.126.35

package/README.md

@@ -13,7 +13,7 @@ To help get you started, various samples are provided under `/samples` folder. F
 
 ## Quality
 
-Meep is covered by 2,716 handwritten unit tests
+Meep is covered by 2,720 handwritten unit tests
 
 The aim is to [ensure quality](https://about.codecov.io/blog/the-case-against-100-code-coverage/). As a result, the tests are written to cover complex code first and to exhaustively validate critical algorithms.
 Most of the test code is significantly larger than the code that is being tested.

package/package.json

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

package/src/core/geom/3d/frustum/frustum_compute_center.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frustum_compute_center.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/frustum/frustum_compute_center.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,+CALW,MAAM,EAAE,iBACR,MAAM,WACN,MAAM,EAAE,kBACR,MAAM,QA0BhB"}
+{"version":3,"file":"frustum_compute_center.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/frustum/frustum_compute_center.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,+CALW,MAAM,EAAE,iBACR,MAAM,WACN,MAAM,EAAE,kBACR,MAAM,QA8BhB"}

package/src/core/geom/3d/frustum/frustum_compute_center.js

@@ -1,3 +1,4 @@
+import { assert } from "../../../assert.js";
 import { frustum_compute_corners } from "./frustum_compute_corners.js";
 
 const scratch_corners = new Float32Array(24);
@@ -15,6 +16,10 @@ export function frustum_compute_center(
     frustum,
     frustum_offset
 ) {
+    assert.defined(output,'output');
+    assert.isNonNegativeInteger(output_offset,'output_offset');
+    assert.defined(frustum,'frustum');
+    assert.isNonNegativeInteger(frustum_offset,'frustum_offset');
 
     frustum_compute_corners(scratch_corners, 0, frustum, frustum_offset);
 

package/src/core/geom/3d/frustum/frustum_compute_corners.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frustum_compute_corners.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/frustum/frustum_compute_corners.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,gDALW,MAAM,EAAE,GAAC,YAAY,iBACrB,MAAM,WACN,MAAM,EAAE,GAAC,YAAY,kBACrB,MAAM,QAuEhB"}
+{"version":3,"file":"frustum_compute_corners.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/frustum/frustum_compute_corners.js"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,gDALW,MAAM,EAAE,GAAC,YAAY,iBACrB,MAAM,WACN,MAAM,EAAE,GAAC,YAAY,kBACrB,MAAM,QAgFhB"}

package/src/core/geom/3d/frustum/frustum_compute_corners.js

@@ -1,3 +1,4 @@
+import { assert } from "../../../assert.js";
 import { plane3_compute_convex_3_plane_intersection } from "../plane/plane3_compute_convex_3_plane_intersection.js";
 
 /**
@@ -9,7 +10,16 @@ import { plane3_compute_convex_3_plane_intersection } from "../plane/plane3_comp
  * @param {number[]|Float32Array} frustum defined as [plane_normal_x, plane_normal_y, plane_normal_z, plane_offset], planes should be in the following order [x0, x1, y0, y1, z0, z1]
  * @param {number} frustum_offset where to start reading from
  */
-export function frustum_compute_corners(output, output_offset, frustum, frustum_offset) {
+export function frustum_compute_corners(
+    output,
+    output_offset,
+    frustum,
+    frustum_offset
+) {
+    assert.defined(output,'output');
+    assert.isNonNegativeInteger(output_offset,'output_offset');
+    assert.defined(frustum,'frustum');
+    assert.isNonNegativeInteger(frustum_offset,'frustum_offset');
 
     const f = frustum;
     const o = frustum_offset;

package/src/core/geom/3d/mat4/MATRIX_4_IDENTITY.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Identity 4x4 matrix, also called "eye" matrix sometimes.
  * @type {number[]|mat4}
  */
 export const MATRIX_4_IDENTITY: number[] | mat4;

package/src/core/geom/3d/mat4/MATRIX_4_IDENTITY.js

@@ -1,5 +1,5 @@
 /**
- *
+ * Identity 4x4 matrix, also called "eye" matrix sometimes.
  * @type {number[]|mat4}
  */
 export const MATRIX_4_IDENTITY = Object.freeze([

package/src/core/geom/3d/mat4/eulerAnglesFromMatrix.d.ts

@@ -18,11 +18,11 @@
  * NOTE: ported from Eigen C++ library
  * @see https://gitlab.com/libeigen/eigen/-/blob/master/Eigen/src/Geometry/EulerAngles.h
  * @see https://stackoverflow.com/questions/11514063/extract-yaw-pitch-and-roll-from-a-rotationmatrix
- * @param {number[]} res
- * @param {number[]|Float32Array|mat4} m4
- * @param {number} a0 axis index
+ * @param {number[]} output
+ * @param {number[]|Float32Array|mat4} m4 source matrix to extract rotation from
+ * @param {number} a0 axis index (0 = X, 1 = Y, 2 = Z)
  * @param {number} a1 axis index
  * @param {number} a2 axis index
  */
-export function eulerAnglesFromMatrix(res: number[], m4: number[] | Float32Array | mat4, a0: number, a1: number, a2: number): void;
+export function eulerAnglesFromMatrix(output: number[], m4: number[] | Float32Array | mat4, a0: number, a1: number, a2: number): void;
 //# sourceMappingURL=eulerAnglesFromMatrix.d.ts.map

package/src/core/geom/3d/mat4/eulerAnglesFromMatrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eulerAnglesFromMatrix.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/eulerAnglesFromMatrix.js"],"names":[],"mappings":"AAkBA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,2CANW,MAAM,EAAE,MACR,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,MAC1B,MAAM,MACN,MAAM,MACN,MAAM,QA2EhB"}
+{"version":3,"file":"eulerAnglesFromMatrix.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/eulerAnglesFromMatrix.js"],"names":[],"mappings":"AAkBA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,8CANW,MAAM,EAAE,MACR,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,MAC1B,MAAM,MACN,MAAM,MACN,MAAM,QA2EhB"}

package/src/core/geom/3d/mat4/eulerAnglesFromMatrix.js

@@ -36,14 +36,14 @@ const atan2 = Math.atan2;
  * NOTE: ported from Eigen C++ library
  * @see https://gitlab.com/libeigen/eigen/-/blob/master/Eigen/src/Geometry/EulerAngles.h
  * @see https://stackoverflow.com/questions/11514063/extract-yaw-pitch-and-roll-from-a-rotationmatrix
- * @param {number[]} res
- * @param {number[]|Float32Array|mat4} m4
- * @param {number} a0 axis index
+ * @param {number[]} output
+ * @param {number[]|Float32Array|mat4} m4 source matrix to extract rotation from
+ * @param {number} a0 axis index (0 = X, 1 = Y, 2 = Z)
  * @param {number} a1 axis index
  * @param {number} a2 axis index
  */
 export function eulerAnglesFromMatrix(
-    res, m4,
+    output, m4,
     a0, a1, a2
 ) {
 
@@ -54,19 +54,19 @@ export function eulerAnglesFromMatrix(
     const k = (a0 + 2 - odd) % 3;
 
     if (a0 === a2) {
-        res[0] = atan2(coeff(m4, j, i), coeff(m4, k, i));
+        output[0] = atan2(coeff(m4, j, i), coeff(m4, k, i));
 
-        if ((odd && res[0] < 0) || ((~odd) && res[0] > 0)) {
-            if (res[0] > 0) {
-                res[0] -= Math.PI;
+        if ((odd && output[0] < 0) || ((~odd) && output[0] > 0)) {
+            if (output[0] > 0) {
+                output[0] -= Math.PI;
             } else {
-                res[0] += Math.PI;
+                output[0] += Math.PI;
             }
             const s2 = v2_length(coeff(m4, j, i), coeff(m4, k, i));
-            res[1] = -atan2(s2, coeff(m4, i, i));
+            output[1] = -atan2(s2, coeff(m4, i, i));
         } else {
             const s2 = v2_length(coeff(m4, j, i), coeff(m4, k, i));
-            res[1] = atan2(s2, coeff(m4, i, i));
+            output[1] = atan2(s2, coeff(m4, i, i));
         }
 
         // With a=(0,1,0), we have i=0; j=1; k=2, and after computing the first two angles,
@@ -79,40 +79,40 @@ export function eulerAnglesFromMatrix(
         //
         //  Thus:  m11.c1 - m21.s1 = c3  &   m12.c1 - m22.s1 = s3
 
-        const s1 = sin(res[0]);
-        const c1 = cos(res[0]);
+        const s1 = sin(output[0]);
+        const c1 = cos(output[0]);
 
-        res[2] = atan2(c1 * coeff(m4, j, k) - s1 * coeff(m4, k, k), c1 * coeff(m4, j, j) - s1 * coeff(m4, k, j));
+        output[2] = atan2(c1 * coeff(m4, j, k) - s1 * coeff(m4, k, k), c1 * coeff(m4, j, j) - s1 * coeff(m4, k, j));
 
     } else {
 
-        res[0] = atan2(coeff(m4, j, k), coeff(m4, k, k));
+        output[0] = atan2(coeff(m4, j, k), coeff(m4, k, k));
 
         const c2 = v2_length(coeff(m4, i, i), coeff(m4, i, j));
 
-        if ((odd && res[0] < 0) || ((~odd) && res[0] > 0)) {
-            if (res[0] > 0) {
-                res[0] -= Math.PI;
+        if ((odd && output[0] < 0) || ((~odd) && output[0] > 0)) {
+            if (output[0] > 0) {
+                output[0] -= Math.PI;
             } else {
-                res[0] += Math.PI;
+                output[0] += Math.PI;
             }
-            res[1] = atan2(-coeff(m4, i, k), -c2);
+            output[1] = atan2(-coeff(m4, i, k), -c2);
         } else {
-            res[1] = atan2(-coeff(m4, i, k), c2);
+            output[1] = atan2(-coeff(m4, i, k), c2);
         }
 
-        const s1 = sin(res[0]);
-        const c1 = cos(res[0]);
+        const s1 = sin(output[0]);
+        const c1 = cos(output[0]);
 
-        res[2] = atan2(s1 * coeff(m4, k, i) - c1 * coeff(m4, j, i), c1 * coeff(m4, j, j) - s1 * coeff(m4, k, j));
+        output[2] = atan2(s1 * coeff(m4, k, i) - c1 * coeff(m4, j, i), c1 * coeff(m4, j, j) - s1 * coeff(m4, k, j));
 
     }
 
     if (odd === 0) {
         // invert result
-        res[0] = -res[0];
-        res[1] = -res[1];
-        res[2] = -res[2];
+        output[0] = -output[0];
+        output[1] = -output[1];
+        output[2] = -output[2];
     }
 
 }

package/src/core/geom/3d/mat4/m4_inverse_rotation_translation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compose an inverse 4x4 transformation matrix from 3x3 rotation matrix and a translation vector
+ * @param {number[]} output 4x4 matrix
+ * @param {number[]} rotation_matrix 3x3 mat
+ * @param {number[]} translation 3d vector
+ * @see m4_rotation_translation
+ */
+export function m4_inverse_rotation_translation(output: number[], rotation_matrix: number[], translation: number[]): void;
+//# sourceMappingURL=m4_inverse_rotation_translation.d.ts.map

package/src/core/geom/3d/mat4/m4_inverse_rotation_translation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"m4_inverse_rotation_translation.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/m4_inverse_rotation_translation.js"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wDALW,MAAM,EAAE,mBACR,MAAM,EAAE,eACR,MAAM,EAAE,QAiClB"}

package/src/core/geom/3d/mat4/m4_inverse_rotation_translation.js

@@ -0,0 +1,40 @@
+import { v3_dot } from "../../vec3/v3_dot.js";
+
+/**
+ * Compose an inverse 4x4 transformation matrix from 3x3 rotation matrix and a translation vector
+ * @param {number[]} output 4x4 matrix
+ * @param {number[]} rotation_matrix 3x3 mat
+ * @param {number[]} translation 3d vector
+ * @see m4_rotation_translation
+ */
+export function m4_inverse_rotation_translation(
+    output,
+    rotation_matrix,
+    translation
+) {
+
+    const r = rotation_matrix;
+
+
+    output[0] = r[0];
+    output[1] = r[3];
+    output[2] = r[6];
+    output[3] = 0;
+
+    output[4] = r[1];
+    output[5] = r[4];
+    output[6] = r[7];
+    output[7] = 0;
+
+    output[8] = r[2];
+    output[9] = r[5];
+    output[10] = r[8];
+    output[11] = 0;
+
+    const t = translation;
+
+    output[12] = -v3_dot(t[0], t[1], t[2], r[0], r[1], r[2]);
+    output[13] = -v3_dot(t[0], t[1], t[2], r[3], r[4], r[5]);
+    output[14] = -v3_dot(t[0], t[1], t[2], r[6], r[7], r[8]);
+    output[15] = 1;
+}

package/src/core/geom/3d/mat4/m4_multiply.d.ts

@@ -1,6 +1,5 @@
 /**
  * Multiplies two 4x4 matrices
- * Adapted from gl-matrix
  *
  * @param {number[]|ArrayLike<number>|Float32Array} out the receiving matrix
  * @param {number[]|ArrayLike<number>|Float32Array} a the first operand

package/src/core/geom/3d/mat4/m4_multiply.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"m4_multiply.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/m4_multiply.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,iCAJW,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,KACvC,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,KACvC,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,QA4DjD"}
+{"version":3,"file":"m4_multiply.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/m4_multiply.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,iCAJW,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,KACvC,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,KACvC,MAAM,EAAE,GAAC,SAAS,CAAC,MAAM,CAAC,GAAC,YAAY,QA8DjD"}

package/src/core/geom/3d/mat4/m4_multiply.js

@@ -1,12 +1,13 @@
 /**
  * Multiplies two 4x4 matrices
- * Adapted from gl-matrix
  *
  * @param {number[]|ArrayLike<number>|Float32Array} out the receiving matrix
  * @param {number[]|ArrayLike<number>|Float32Array} a the first operand
  * @param {number[]|ArrayLike<number>|Float32Array} b the second operand
  */
 export function m4_multiply(out, a, b) {
+    // Adapted from gl-matrix
+
     const a00 = a[0],
         a01 = a[1],
         a02 = a[2],

package/src/core/geom/3d/mat4/m4_rotation_translation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compose a 4x4 transformation matrix from 3x3 rotation matrix and a translation vector
+ * @param {number[]} output 4x4 matrix
+ * @param {number[]} rotation_matrix 3x3 mat
+ * @param {number[]} translation 3d vector
+ * @see m4_inverse_rotation_translation
+ */
+export function m4_rotation_translation(output: number[], rotation_matrix: number[], translation: number[]): void;
+//# sourceMappingURL=m4_rotation_translation.d.ts.map

package/src/core/geom/3d/mat4/m4_rotation_translation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"m4_rotation_translation.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/m4_rotation_translation.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,gDALW,MAAM,EAAE,mBACR,MAAM,EAAE,eACR,MAAM,EAAE,QA2BlB"}

package/src/core/geom/3d/mat4/m4_rotation_translation.js

@@ -0,0 +1,32 @@
+/**
+ * Compose a 4x4 transformation matrix from 3x3 rotation matrix and a translation vector
+ * @param {number[]} output 4x4 matrix
+ * @param {number[]} rotation_matrix 3x3 mat
+ * @param {number[]} translation 3d vector
+ * @see m4_inverse_rotation_translation
+ */
+export function m4_rotation_translation(output, rotation_matrix, translation) {
+    const r = rotation_matrix;
+
+    output[0] = r[0];
+    output[1] = r[1];
+    output[2] = r[2];
+    output[3] = 0;
+
+    output[4] = r[3];
+    output[5] = r[4];
+    output[6] = r[5];
+    output[7] = 0;
+
+    output[8] = r[6];
+    output[9] = r[7];
+    output[10] = r[8];
+    output[11] = 0;
+
+    const t = translation;
+
+    output[12] = t[0];
+    output[13] = t[1];
+    output[14] = t[2];
+    output[15] = 1;
+}

package/src/core/geom/mat3/m3_make_rotation.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * @param {number[]} output 3x3 rotation matrix
+ * @param {Vector3} forward
+ * @param {Vector3} up_dir
+ */
+export function m3_make_rotation_TBN(output: number[], forward: Vector3, up_dir: Vector3): void;
+import Vector3 from "../Vector3.js";
+//# sourceMappingURL=m3_make_rotation.d.ts.map

package/src/core/geom/mat3/m3_make_rotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"m3_make_rotation.d.ts","sourceRoot":"","sources":["../../../../../src/core/geom/mat3/m3_make_rotation.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,6CAJW,MAAM,EAAE,WACR,OAAO,UACP,OAAO,QAqBjB;oBA9BmB,eAAe"}

package/src/core/geom/mat3/m3_make_rotation.js

@@ -0,0 +1,31 @@
+import Vector3 from "../Vector3.js";
+
+const v3_scratch_1 = new Vector3();
+const v3_scratch_2 = new Vector3();
+
+/**
+ *
+ * @param {number[]} output 3x3 rotation matrix
+ * @param {Vector3} forward
+ * @param {Vector3} up_dir
+ */
+export function m3_make_rotation_TBN(output, forward, up_dir) {
+    output[6] = forward.x;
+    output[7] = forward.y;
+    output[8] = forward.z;
+
+    v3_scratch_2.set(output[6], output[7], output[8]);
+    v3_scratch_1.crossVectors(up_dir, v3_scratch_2);
+    v3_scratch_1.normalize();
+
+    output[0] = v3_scratch_1.x;
+    output[1] = v3_scratch_1.y;
+    output[2] = v3_scratch_1.z;
+
+    v3_scratch_1.crossVectors(v3_scratch_2, v3_scratch_1);
+    v3_scratch_1.normalize();
+
+    output[3] = v3_scratch_1.x;
+    output[4] = v3_scratch_1.y;
+    output[5] = v3_scratch_1.z;
+}