@woosh/meep-engine 2.126.48 → 2.126.50

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,720 handwritten unit tests
+Meep is covered by 2,753 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.48",
+  "version": "2.126.50",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/geom/3d/frustum/frustum_slice.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Carves out a slice of a frustum, given a normalized set of intervals [0,1] for each axis.
+ * Works with perspective and orthographic frustums.
+ * Input frustum is assumed to have planes in the following order [x0, x1, y0, y1, z0, z1]
+ * @param {number[]|Float32Array} output
+ * @param {number} output_offset
+ * @param {number[]|Float32Array} frustum
+ * @param {number} x0
+ * @param {number} y0
+ * @param {number} z0
+ * @param {number} x1
+ * @param {number} y1
+ * @param {number} z1
+ */
+export function frustum_slice(output: number[] | Float32Array, output_offset: number, frustum: number[] | Float32Array, x0: number, y0: number, z0: number, x1: number, y1: number, z1: number): void;
+//# sourceMappingURL=frustum_slice.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"frustum_slice.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/frustum/frustum_slice.js"],"names":[],"mappings":"AAoDA;;;;;;;;;;;;;GAaG;AACH,sCAVW,MAAM,EAAE,GAAC,YAAY,iBACrB,MAAM,WACN,MAAM,EAAE,GAAC,YAAY,MACrB,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,QA6BhB"}

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

@@ -0,0 +1,94 @@
+import { assert } from "../../../assert.js";
+import { plane3_lerp } from "../plane/plane3_lerp.js";
+
+/**
+ * Lerp between two planes of a frustum, opposing planes (x0,x1) or (y0,y1) or (z0,z1)
+ * @param {number[]} output
+ * @param {number} output_offset
+ * @param {number[]} input
+ * @param {number} plane_min_offset
+ * @param {number} plane_max_offset
+ * @param {number} section0
+ * @param {number} section1
+ */
+function frustum_plane_pair_lerp(
+    output, output_offset,
+    input,
+    plane_min_offset,
+    plane_max_offset,
+    section0, section1
+) {
+
+    assert.isArrayLike(input, 'input');
+    assert.isNonNegativeInteger(plane_min_offset, 'plane_min_offset');
+    assert.isNonNegativeInteger(plane_max_offset, 'plane_max_offset');
+    assert.isNumber(section0, 'section0');
+    assert.isNumber(section1, 'section1');
+
+    const p0_nx = input[plane_min_offset];
+    const p0_ny = input[plane_min_offset + 1];
+    const p0_nz = input[plane_min_offset + 2];
+    const p0_c = input[plane_min_offset + 3];
+
+    const p1_nx = input[plane_max_offset];
+    const p1_ny = input[plane_max_offset + 1];
+    const p1_nz = input[plane_max_offset + 2];
+    const p1_c = input[plane_max_offset + 3];
+
+    plane3_lerp(
+        output, output_offset,
+        p0_nx, p0_ny, p0_nz, p0_c,
+        -p1_nx, -p1_ny, -p1_nz, -p1_c,
+        section0
+    );
+
+    plane3_lerp(
+        output, output_offset + 4,
+        -p0_nx, -p0_ny, -p0_nz, -p0_c,
+        p1_nx, p1_ny, p1_nz, p1_c,
+        section1
+    );
+}
+
+/**
+ * Carves out a slice of a frustum, given a normalized set of intervals [0,1] for each axis.
+ * Works with perspective and orthographic frustums.
+ * Input frustum is assumed to have planes in the following order [x0, x1, y0, y1, z0, z1]
+ * @param {number[]|Float32Array} output
+ * @param {number} output_offset
+ * @param {number[]|Float32Array} frustum
+ * @param {number} x0
+ * @param {number} y0
+ * @param {number} z0
+ * @param {number} x1
+ * @param {number} y1
+ * @param {number} z1
+ */
+export function frustum_slice(
+    output, output_offset,
+    frustum,
+    x0, y0, z0,
+    x1, y1, z1,
+) {
+    // X planes
+    frustum_plane_pair_lerp(
+        output, output_offset,
+        frustum,
+        0, 4, x0, x1,
+    );
+
+    // Y planes
+    frustum_plane_pair_lerp(
+        output, output_offset + 8,
+        frustum,
+        8, 12, y0, y1,
+    );
+
+    // Z planes
+    frustum_plane_pair_lerp(
+        output, output_offset + 16,
+        frustum,
+        16, 20, z0, z1,
+    );
+
+}

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

@@ -1,5 +1,6 @@
 /**
- * Multiplies two 4x4 matrices
+ * Multiplies two 4x4 matrices.
+ * `out = a * b`.
  *
  * @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":"AAEA;;;;;;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,QAwEjD"}
+{"version":3,"file":"m4_multiply.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/mat4/m4_multiply.js"],"names":[],"mappings":"AAEA;;;;;;;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,QAwEjD"}

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

@@ -1,7 +1,8 @@
 import { assert } from "../../../assert.js";
 
 /**
- * Multiplies two 4x4 matrices
+ * Multiplies two 4x4 matrices.
+ * `out = a * b`.
  *
  * @param {number[]|ArrayLike<number>|Float32Array} out the receiving matrix
  * @param {number[]|ArrayLike<number>|Float32Array} a the first operand

package/src/core/geom/3d/plane/plane3_lerp.d.ts

@@ -1,6 +1,7 @@
 /**
- * TODO this produces increasingly incorrect when planes diverge
- * Interpolate between two planes in linear space
+ * Interpolate between two planes in linear space.
+ *
+ * Note: It does not work for planes that are parallel with opposing normals. There is no valid solution, as the number of such planes would be infinite.
  * @param {number[]} destination
  * @param {number} destination_offset
  * @param {number} a_normal_x

package/src/core/geom/3d/plane/plane3_lerp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plane3_lerp.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/plane/plane3_lerp.js"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;GAcG;AACH,yCAZW,MAAM,EAAE,sBACR,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,KACN,MAAM,QAuChB"}
+{"version":3,"file":"plane3_lerp.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/plane/plane3_lerp.js"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,yCAZW,MAAM,EAAE,sBACR,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,KACN,MAAM,QAkBhB"}

package/src/core/geom/3d/plane/plane3_lerp.js

@@ -1,15 +1,11 @@
 import { lerp } from "../../../math/lerp.js";
-import Vector3 from "../../Vector3.js";
-import { plane3_intersect_plane } from "./plane3_intersect_plane.js";
-import { v3_dot } from "../../vec3/v3_dot.js";
-import { v3_length } from "../../vec3/v3_length.js";
+import { plane3_normalize } from "./plane3_normalize.js";
 
-const v0 = new Vector3();
-const v1 = new Vector3();
 
 /**
- * TODO this produces increasingly incorrect when planes diverge
- * Interpolate between two planes in linear space
+ * Interpolate between two planes in linear space.
+ *
+ * Note: It does not work for planes that are parallel with opposing normals. There is no valid solution, as the number of such planes would be infinite.
  * @param {number[]} destination
  * @param {number} destination_offset
  * @param {number} a_normal_x
@@ -28,35 +24,14 @@ export function plane3_lerp(
     b_normal_x, b_normal_y, b_normal_z, b_constant,
     t
 ) {
-    // compute result normal
-    let normal_x = lerp(a_normal_x, b_normal_x, t);
-    let normal_y = lerp(a_normal_y, b_normal_y, t);
-    let normal_z = lerp(a_normal_z, b_normal_z, t);
 
-    // normalize the normal vector
-    const normal_length = v3_length(normal_x, normal_y, normal_z);
-    const normal_length_inv = 1 / normal_length;
+    const nx = lerp(a_normal_x, b_normal_x, t);
+    const ny = lerp(a_normal_y, b_normal_y, t);
+    const nz = lerp(a_normal_z, b_normal_z, t);
+    const c = lerp(a_constant, b_constant, t);
 
-    normal_x *= normal_length_inv;
-    normal_y *= normal_length_inv;
-    normal_z *= normal_length_inv;
-
-    // compute 2-plane intersection
-    const intersection_exists = plane3_intersect_plane(v0, v1,
-        a_normal_x, a_normal_y, a_normal_z, a_constant,
-        b_normal_x, b_normal_y, b_normal_z, b_constant,
+    plane3_normalize(
+        destination, destination_offset,
+        nx, ny, nz, c
     );
-
-    if (!intersection_exists) {
-        // special case, planes are parallel
-        // TODO implement handling
-    }
-
-    const r_constant = -v3_dot(v0.x, v0.y, v0.z, normal_x, normal_y, normal_z);
-
-    // write result
-    destination[destination_offset] = normal_x;
-    destination[destination_offset + 1] = normal_y;
-    destination[destination_offset + 2] = normal_z;
-    destination[destination_offset + 3] = r_constant;
 }

package/src/core/geom/3d/plane/plane3_normalize.d.ts

@@ -1,5 +1,6 @@
 /**
- * Normalizes plane representation
+ * Normalizes plane representation.
+ * Note plane normal must have a non-zero length.
  * @param {number[]} destination
  * @param {number} destination_offset
  * @param {number} x plane normal X

package/src/core/geom/3d/plane/plane3_normalize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plane3_normalize.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/plane/plane3_normalize.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,8CAPW,MAAM,EAAE,sBACR,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,QAgBhB"}
+{"version":3,"file":"plane3_normalize.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/plane/plane3_normalize.js"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,8CAPW,MAAM,EAAE,sBACR,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,QAgBhB"}

package/src/core/geom/3d/plane/plane3_normalize.js

@@ -1,7 +1,8 @@
 import { v3_length } from "../../vec3/v3_length.js";
 
 /**
- * Normalizes plane representation
+ * Normalizes plane representation.
+ * Note plane normal must have a non-zero length.
  * @param {number[]} destination
  * @param {number} destination_offset
  * @param {number} x plane normal X

package/src/core/geom/3d/plane/plane3_lerp_v0.d.ts

@@ -1,17 +0,0 @@
-/**
- * TODO this produces increasingly incorrect when planes diverge
- * Interpolate between two planes in linear space
- * @param {number[]} destination
- * @param {number} destination_offset
- * @param {number} a_normal_x
- * @param {number} a_normal_y
- * @param {number} a_normal_z
- * @param {number} a_constant
- * @param {number} b_normal_x
- * @param {number} b_normal_y
- * @param {number} b_normal_z
- * @param {number} b_constant
- * @param {number} t
- */
-export function plane3_lerp_v0(destination: number[], destination_offset: number, a_normal_x: number, a_normal_y: number, a_normal_z: number, a_constant: number, b_normal_x: number, b_normal_y: number, b_normal_z: number, b_constant: number, t: number): void;
-//# sourceMappingURL=plane3_lerp_v0.d.ts.map

package/src/core/geom/3d/plane/plane3_lerp_v0.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plane3_lerp_v0.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/plane/plane3_lerp_v0.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,4CAZW,MAAM,EAAE,sBACR,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,cACN,MAAM,KACN,MAAM,QA8BhB"}

package/src/core/geom/3d/plane/plane3_lerp_v0.js

@@ -1,46 +0,0 @@
-import { lerp } from "../../../math/lerp.js";
-
-/**
- * TODO this produces increasingly incorrect when planes diverge
- * Interpolate between two planes in linear space
- * @param {number[]} destination
- * @param {number} destination_offset
- * @param {number} a_normal_x
- * @param {number} a_normal_y
- * @param {number} a_normal_z
- * @param {number} a_constant
- * @param {number} b_normal_x
- * @param {number} b_normal_y
- * @param {number} b_normal_z
- * @param {number} b_constant
- * @param {number} t
- */
-export function plane3_lerp_v0(
-    destination, destination_offset,
-    a_normal_x, a_normal_y, a_normal_z, a_constant,
-    b_normal_x, b_normal_y, b_normal_z, b_constant,
-    t
-) {
-
-    const n_x = lerp(a_normal_x, b_normal_x, t);
-    const n_y = lerp(a_normal_y, b_normal_y, t);
-    const n_z = lerp(a_normal_z, b_normal_z, t);
-
-    const v_len_sqr = n_x * n_x + n_y * n_y + n_z * n_z;
-
-    const v_len = Math.sqrt(v_len_sqr);
-
-    const v_len_1 = 1 / v_len;
-
-    const nn_x = n_x * v_len_1;
-    const nn_y = n_y * v_len_1;
-    const nn_z = n_z * v_len_1;
-
-    const distance = lerp(a_constant, b_constant, t);
-
-    // write result
-    destination[destination_offset] = nn_x;
-    destination[destination_offset + 1] = nn_y;
-    destination[destination_offset + 2] = nn_z;
-    destination[destination_offset + 3] = distance;
-}