@woosh/meep-engine 2.120.2 → 2.120.4

package/src/core/geom/3d/ray/Ray3.d.ts

@@ -94,5 +94,16 @@ export class Ray3 extends Float32Array<ArrayBuffer> {
      * @returns {boolean}
      */
     equals(other: Ray3): boolean;
+    /**
+     * Compute `t` value for a given point in 3d space.
+     * This is the distance along the direction from origin of the ray
+     * Value will be negative if the ray is pointing away from the point
+     * PRECONDITION: ray direction must be normalized
+     * @param {number} x
+     * @param {number} y
+     * @param {number} z
+     * @returns {number}
+     */
+    computeSignedDistance(x: number, y: number, z: number): number;
 }
 //# sourceMappingURL=Ray3.d.ts.map

package/src/core/geom/3d/ray/Ray3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ray3.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/ray/Ray3.js"],"names":[],"mappings":"AASA;;;GAGG;AACH;IA0MI;;;;;;;;;;OAUG;IACH,sBATW,MAAM,YACN,MAAM,YACN,MAAM,eACN,MAAM,eACN,MAAM,eACN,MAAM,UACN,MAAM,GACL,IAAI,CAqBf;IAvOD,cAKC;IAMD,iBAEC;IAND,gBAEC;IAGG,OAAW;IAOf;;;OAGG;IACH,cAFW,MAAM,EAAE,GAAC,YAAY,EAI/B;IAVD,cAMW,MAAM,EAAE,GAAC,YAAY,CAJ/B;IAUD,uBAEC;IAED,uBAEC;IAED,uBAEC;IAGD;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,KACN,MAAM,QAUhB;IAHG,UAAW;IACX,UAAW;IACX,UAAW;IAQf;;;OAGG;IACH,iBAFW,MAAM,EAAE,GAAC,YAAY,EAI/B;IAVD,iBAMW,MAAM,EAAE,GAAC,YAAY,CAJ/B;IAWD,0BAEC;IAED,0BAEC;IAED,0BAEC;IAED;;;;;OAKG;IACH,gBAJW,MAAM,KACN,MAAM,KACN,MAAM,QAUhB;IAHG,UAAW;IACX,UAAW;IACX,UAAW;IAGf,2BAEC;IAED;;;;;;;OAOG;IACH,gCANW,MAAM,KACN,MAAM,KACN,MAAM,aACN,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,sBAC1B,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,QA6BpC;IAED;;;OAGG;IACH,uBAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,iBAFW,MAAM,EAAE,GAAC,IAAI,GAAC,YAAY,QAepC;IAED;;;OAGG;IACH,SAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,YAFW,IAAI,QAId;IAED,eAEC;IAED;;;;OAIG;IACH,cAHW,IAAI,GACF,OAAO,CAInB;CAiCJ"}
+{"version":3,"file":"Ray3.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/ray/Ray3.js"],"names":[],"mappings":"AAUA;;;GAGG;AACH;IAkOI;;;;;;;;;;OAUG;IACH,sBATW,MAAM,YACN,MAAM,YACN,MAAM,eACN,MAAM,eACN,MAAM,eACN,MAAM,UACN,MAAM,GACL,IAAI,CAqBf;IA/PD,cAKC;IAMD,iBAEC;IAND,gBAEC;IAGG,OAAW;IAOf;;;OAGG;IACH,cAFW,MAAM,EAAE,GAAC,YAAY,EAI/B;IAVD,cAMW,MAAM,EAAE,GAAC,YAAY,CAJ/B;IAUD,uBAEC;IAED,uBAEC;IAED,uBAEC;IAGD;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,KACN,MAAM,QAUhB;IAHG,UAAW;IACX,UAAW;IACX,UAAW;IAQf;;;OAGG;IACH,iBAFW,MAAM,EAAE,GAAC,YAAY,EAI/B;IAVD,iBAMW,MAAM,EAAE,GAAC,YAAY,CAJ/B;IAWD,0BAEC;IAED,0BAEC;IAED,0BAEC;IAED;;;;;OAKG;IACH,gBAJW,MAAM,KACN,MAAM,KACN,MAAM,QAUhB;IAHG,UAAW;IACX,UAAW;IACX,UAAW;IAGf,2BAEC;IAED;;;;;;;OAOG;IACH,gCANW,MAAM,KACN,MAAM,KACN,MAAM,aACN,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,sBAC1B,MAAM,EAAE,GAAC,YAAY,GAAC,IAAI,QA6BpC;IAED;;;OAGG;IACH,uBAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,iBAFW,MAAM,EAAE,GAAC,IAAI,GAAC,YAAY,QAepC;IAED;;;OAGG;IACH,SAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,YAFW,IAAI,QAId;IAED,eAEC;IAED;;;;OAIG;IACH,cAHW,IAAI,GACF,OAAO,CAInB;IAED;;;;;;;;;OASG;IACH,yBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,MAAM,CAclB;CAiCJ"}

package/src/core/geom/3d/ray/Ray3.js

@@ -4,6 +4,7 @@ import { array_range_equal_strict } from "../../../collection/array/array_range_
 import { computeHashFloatArray } from "../../../math/hash/computeHashFloatArray.js";
 import { v3_array_matrix4_rotate } from "../../vec3/v3_array_matrix4_rotate.js";
 import { v3_array_normalize } from "../../vec3/v3_array_normalize.js";
+import { v3_dot } from "../../vec3/v3_dot.js";
 import { v3_matrix4_multiply } from "../../vec3/v3_matrix4_multiply.js";
 import { ray3_interval_array_apply_matrix4 } from "./ray3_interval_array_apply_matrix4.js";
 
@@ -213,6 +214,30 @@ export class Ray3 extends Float32Array {
         return array_range_equal_strict(this, 0, other, 0, 7);
     }
 
+    /**
+     * Compute `t` value for a given point in 3d space.
+     * This is the distance along the direction from origin of the ray
+     * Value will be negative if the ray is pointing away from the point
+     * PRECONDITION: ray direction must be normalized
+     * @param {number} x
+     * @param {number} y
+     * @param {number} z
+     * @returns {number}
+     */
+    computeSignedDistance(x, y, z) {
+        assert.isNumber(x, 'x');
+        assert.isNumber(y, 'y');
+        assert.isNumber(z, 'z');
+
+        // localize point to ray's origin
+        const _x = x - this.origin_x;
+        const _y = y - this.origin_y;
+        const _z = z - this.origin_z;
+
+        // we assume that direction is normalized
+        return v3_dot(_x, _y, _z, this.direction_x, this.direction_y, this.direction_z);
+    }
+
     /**
      *
      * @param {number} origin_x

package/src/core/geom/Vector4.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Vector4.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector4.js"],"names":[],"mappings":";AAMA;IA2YI;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IAxZD;;;;;;;;OAQG;IACH,4DAOC;IANG,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IAEV,eAA6B;IAOjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAUD;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAShB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAOhB;IAED;;;;;;;OAOG;IACH,iDAFa,OAAO,CAkCnB;IAED;;;OAGG;IACH,oBAFW,OAAO,QAQjB;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAOnB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAlBW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,OAAO,CAoBnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,SAHW,OAAO,GAAC,OAAO,GACb,OAAO,CASnB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,OAAO,CAUnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,SAFa,OAAO,CAQnB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAyBpB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;;OAIG;IACH,gBAJW,OAAO,MACP,OAAO,mBAKjB;IAED;;;OAGG;IACH,gBAFW,MAAM,EAAE,QAOlB;IAED;;OAEG;IACH,WAFa,MAAM,EAAE,CAQpB;IAED;;;;OAIG;IACH,mBAHW,MAAM,EAAE,UACR,MAAM,QAIhB;IAED;;;;;MAOC;IAED,0BAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED,sDAOC;CAiBJ"}
+{"version":3,"file":"Vector4.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector4.js"],"names":[],"mappings":";AAMA;IAiaI;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IA9aD;;;;;;;;OAQG;IACH,gBAPW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAiBhB;IANG,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IAEV,eAA6B;IAWjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAUD;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAShB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAOhB;IAED;;;;;;;OAOG;IACH,iDAFa,OAAO,CAkCnB;IAED;;;OAGG;IACH,oBAFW,OAAO,QAQjB;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAOnB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAlBW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,OAAO,CAoBnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,SAHW,OAAO,GAAC,OAAO,GACb,OAAO,CASnB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,OAAO,CAUnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,SAFa,OAAO,CAQnB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAyBpB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;;OAIG;IACH,gBAJW,OAAO,MACP,OAAO,mBAKjB;IAED;;;OAGG;IACH,gBAFW,MAAM,EAAE,QAOlB;IAED;;OAEG;IACH,WAFa,MAAM,EAAE,CAQpB;IAED;;;;OAIG;IACH,mBAHW,MAAM,EAAE,UACR,MAAM,QAIhB;IAED;;;;;MAOC;IAED,0BAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED,sDAOC;CAiBJ"}

package/src/core/geom/Vector4.js

@@ -7,14 +7,20 @@ import { computeHashFloat } from "../primitives/numbers/computeHashFloat.js";
 class Vector4 {
     /**
      *
-     * @param {Number} [x=0]
-     * @param {Number} [y=0]
-     * @param {Number} [z=0]
-     * @param {Number} [w=0]
+     * @param {number} [x=0]
+     * @param {number} [y=0]
+     * @param {number} [z=0]
+     * @param {number} [w=0]
      * @constructor
      * @class
      */
-    constructor(x = 0, y = 0, z = 0, w = 0) {
+    constructor(
+        x = 0,
+        y = 0,
+        z = 0,
+        w = 0
+    ) {
+
         this.x = x;
         this.y = y;
         this.z = z;
@@ -23,6 +29,10 @@ class Vector4 {
         this.onChanged = new Signal();
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 0() {
         return this.x;
     }
@@ -35,6 +45,10 @@ class Vector4 {
         this.x = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 1() {
         return this.y;
     }
@@ -47,6 +61,10 @@ class Vector4 {
         this.y = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 2() {
         return this.z;
     }
@@ -59,6 +77,10 @@ class Vector4 {
         this.z = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 3() {
         return this.w;
     }

package/src/core/math/gaussian.d.ts

@@ -1,8 +1,9 @@
 /**
- *
- * @param {number} sigma distance from mean
- * @param {number} v Variance
- * @returns {number}
+ * This is not the standard gaussian.
+ * It lacks the normalization factor, standard gaussian would be weighted by `1 / √(2π * variance)`
+ * @param {number} sigma Standard deviation. Distance from mean. Represents the "width" of the Gaussian-like curve.  Note: The parameter is named `sigma`, but its placement in the formula means it scales inversely to the usual effect of sigma.
+ * @param {number} v Variance. Represents the "height" or "amplitude" of the curve, but at a distance from the mean.  Larger variance values result in larger function values further away from the mean (0).
+ * @returns {number} Ranges from 0 to 1 (exclusive of 0)
  */
 export function gaussian(sigma: number, v: number): number;
 //# sourceMappingURL=gaussian.d.ts.map

package/src/core/math/gaussian.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gaussian.d.ts","sourceRoot":"","sources":["../../../../src/core/math/gaussian.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,gCAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAOlB"}
+{"version":3,"file":"gaussian.d.ts","sourceRoot":"","sources":["../../../../src/core/math/gaussian.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,gCAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAOlB"}

package/src/core/math/gaussian.js

@@ -1,8 +1,9 @@
 /**
- *
- * @param {number} sigma distance from mean
- * @param {number} v Variance
- * @returns {number}
+ * This is not the standard gaussian.
+ * It lacks the normalization factor, standard gaussian would be weighted by `1 / √(2π * variance)`
+ * @param {number} sigma Standard deviation. Distance from mean. Represents the "width" of the Gaussian-like curve.  Note: The parameter is named `sigma`, but its placement in the formula means it scales inversely to the usual effect of sigma.
+ * @param {number} v Variance. Represents the "height" or "amplitude" of the curve, but at a distance from the mean.  Larger variance values result in larger function values further away from the mean (0).
+ * @returns {number} Ranges from 0 to 1 (exclusive of 0)
  */
 export function gaussian(sigma, v) {
     const v2 = v * v;

package/src/core/math/matrix/SquareMatrix.d.ts

@@ -1,93 +1,116 @@
+/**
+ * Represents a square matrix (number of rows equals number of columns).
+ * Data is stored in a typed array.
+ */
 export class SquareMatrix {
     /**
-     *
-     * @param {number} size
-     * @param {BinaryDataType|string} type
+     * @param {number} size  Side length of the matrix (e.g. '3' for a 3x3 matrix).
+     * @param {BinaryDataType|string} type Data type of the elements. Must be a valid BinaryDataType (e.g., "uint8", "float32").
+     * @throws {Error} If the provided type is not supported.
      */
     constructor(size: number, type: BinaryDataType | string);
     /**
-     *
+     * Side length of the matrix.
      * @type {number}
      */
     size: number;
     /**
-     *
+     * Data type of matrix elements.
      * @type {BinaryDataType}
      */
     type: BinaryDataType;
     /**
+     * Matrix data, stored as a typed array. Column-major order.
      * @type {number[]}
      */
     data: number[];
+    /**
+     * @returns {number} Side length of the matrix.
+     */
     get n(): number;
+    /**
+     * @returns {number} Total number of elements in the matrix (size * size).
+     */
     get length(): number;
+    /**
+     * Returns direct reference to underlying data, modifying it WILL affect the matrix.
+     * @returns {number[]}
+     */
     get val(): number[];
-    fill(v: any): void;
     /**
-     *
-     * @param {SquareMatrix} other
+     * Fills the entire matrix with the given value.
+     * @param {number} v Value to fill the matrix with.
+     * @returns {void}
+     */
+    fill(v: number): void;
+    /**
+     * Subtracts another matrix from this matrix (this = this - other).
+     * @param {SquareMatrix} other The matrix to subtract. Must be of the same size.
      */
     subtract(other: SquareMatrix): void;
     /**
-     * Component-size subtraction
-     * @param {SquareMatrix} a
-     * @param {SquareMatrix} b
+     * Subtracts matrix 'b' from matrix 'a', storing the result in this matrix (this = a - b).
+     * Component-wise operation.
+     * @param {SquareMatrix} a The first matrix.
+     * @param {SquareMatrix} b The second matrix.
      */
     subtractMatrices(a: SquareMatrix, b: SquareMatrix): void;
     /**
-     * Individually negate each value in the matrix
+     * Negates all elements of the matrix (multiplies each element by -1).
      */
     negate(): void;
     /**
-     * Set all cells to 0
+     * Sets all elements of the matrix to 0.
      */
     clear(): void;
     /**
      * Set diagonal to 1
+     * NOTE: if the other cells are 0s - it will produce identity matrix, but those cells will not be written explicitly
      */
     eye(): void;
     /**
-     *
-     * @param {SquareMatrix} other
+     * Copies the elements of another matrix into this matrix.
+     * @param {SquareMatrix} other The matrix to copy from.  Must be the same size.
      */
     copy(other: SquareMatrix): void;
     /**
-     *
-     * @return {SquareMatrix}
+     * Creates a new matrix that is a copy of this matrix.
+     * @returns {SquareMatrix} A new matrix with the same elements.
      */
     clone(): SquareMatrix;
     /**
-     * Transpose matrix
+     * Transposes the matrix in-place (swaps rows and columns).
      */
     transpose(): void;
     /**
-     *
-     * @param {number[]} arr
+     * Populates matrix from a 1D array.
+     * @param {number[]} arr Source array.  Must have at least size*size elements.
      */
     fromArray(arr: number[]): void;
     /**
-     *
-     * @param {number[]} [destination]
-     * @param {number} [offset]
+     * Copies matrix elements into a 1D array.
+     * @param {number[]} [destination] Array to store matrix into. Creates a new array if not provided.
+     * @param {number} [offset=0] Starting index in the destination array.
+     * @returns {number[]} The array containing the matrix data.
      */
     toArray(destination?: number[], offset?: number): number[];
     /**
-     *
-     * @param {number} row_index
-     * @param {number} column_index
-     * @param {number} value
+     * Sets the value of a cell in the matrix.
+     * @param {number} row_index Row index (0-based).
+     * @param {number} column_index Column index (0-based).
+     * @param {number} value The value to set.
      */
     setCellValue(row_index: number, column_index: number, value: number): void;
     /**
-     *
-     * @param {number} row_index
-     * @param {number} column_index
-     * @return {number}
+     * Retrieves the value of a cell in the matrix.
+     * @param {number} row_index Row index (0-based).
+     * @param {number} column_index Column index (0-based).
+     * @returns {number} The value of the cell.
      */
     getCellValue(row_index: number, column_index: number): number;
     /**
      * Read values at the diagonal, from left to right, top to bottom
-     * @param {number[]|Float32Array|Float64Array} result
+     * @param {number[]|Float32Array|Float64Array} result Array to store the diagonal.
      */
     readDiagonal(result: number[] | Float32Array | Float64Array): void;
 }

package/src/core/math/matrix/SquareMatrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SquareMatrix.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/matrix/SquareMatrix.js"],"names":[],"mappings":"AAIA;IACI;;;;OAIG;IACH,kBAHW,MAAM,QACN,cAAc,GAAC,MAAM,EA2B/B;IAhBG;;;OAGG;IACH,MAFU,MAAM,CAEA;IAEhB;;;OAGG;IACH,MAFU,cAAc,CAER;IAEhB;;OAEG;IACH,MAFU,MAAM,EAAE,CAEqB;IAG3C,gBAEC;IAED,qBAEC;IAED,oBAEC;IAED,mBAEC;IAED;;;OAGG;IACH,gBAFW,YAAY,QAItB;IAED;;;;OAIG;IACH,oBAHW,YAAY,KACZ,YAAY,QAiBtB;IAED;;OAEG;IACH,eAMC;IAED;;OAEG;IACH,cAEC;IAED;;OAEG;IACH,YAMC;IAED;;;OAGG;IACH,YAFW,YAAY,QAMtB;IAED;;;OAGG;IACH,SAFY,YAAY,CAQvB;IAED;;OAEG;IACH,kBAcC;IAED;;;OAGG;IACH,eAFW,MAAM,EAAE,QAIlB;IAED;;;;OAIG;IACH,sBAHW,MAAM,EAAE,WACR,MAAM,YAMhB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gBACN,MAAM,SACN,MAAM,QAYhB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gBACN,MAAM,GACL,MAAM,CAWjB;IAED;;;OAGG;IACH,qBAFW,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,QAU5C;CACJ"}
+{"version":3,"file":"SquareMatrix.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/matrix/SquareMatrix.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH;IAEI;;;;OAIG;IACH,kBAJW,MAAM,QACN,cAAc,GAAC,MAAM,EA6B/B;IAjBG;;;OAGG;IACH,MAFU,MAAM,CAEA;IAEhB;;;OAGG;IACH,MAFU,cAAc,CAER;IAEhB;;;OAGG;IACH,MAFU,MAAM,EAAE,CAEqB;IAG3C;;OAEG;IACH,SAFa,MAAM,CAIlB;IAED;;OAEG;IACH,cAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,WAFa,MAAM,EAAE,CAIpB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;OAGG;IACH,gBAFW,YAAY,QAItB;IAED;;;;;OAKG;IACH,oBAHW,YAAY,KACZ,YAAY,QAiBtB;IAED;;OAEG;IACH,eAMC;IAED;;OAEG;IACH,cAEC;IAED;;;OAGG;IACH,YAMC;IAED;;;OAGG;IACH,YAFW,YAAY,QAMtB;IAED;;;OAGG;IACH,SAFa,YAAY,CAQxB;IAED;;OAEG;IACH,kBAcC;IAED;;;OAGG;IACH,eAFW,MAAM,EAAE,QAIlB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,EAAE,WACR,MAAM,GACJ,MAAM,EAAE,CASpB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gBACN,MAAM,SACN,MAAM,QAYhB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CAUlB;IAED;;;OAGG;IACH,qBAFW,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,QAU5C;CACJ"}

package/src/core/math/matrix/SquareMatrix.js

@@ -2,11 +2,16 @@ import { assert } from "../../assert.js";
 import { DataType2TypedArrayConstructorMapping } from "../../binary/type/DataType2TypedArrayConstructorMapping.js";
 import { array_copy } from "../../collection/array/array_copy.js";
 
+/**
+ * Represents a square matrix (number of rows equals number of columns).
+ * Data is stored in a typed array.
+ */
 export class SquareMatrix {
+
     /**
-     *
-     * @param {number} size
-     * @param {BinaryDataType|string} type
+     * @param {number} size  Side length of the matrix (e.g. '3' for a 3x3 matrix).
+     * @param {BinaryDataType|string} type Data type of the elements. Must be a valid BinaryDataType (e.g., "uint8", "float32").
+     * @throws {Error} If the provided type is not supported.
      */
     constructor(size, type) {
         assert.isNonNegativeInteger(size, 'size');
@@ -18,51 +23,68 @@ export class SquareMatrix {
         }
 
         /**
-         *
+         * Side length of the matrix.
          * @type {number}
          */
         this.size = size;
 
         /**
-         *
+         * Data type of matrix elements.
          * @type {BinaryDataType}
          */
         this.type = type;
 
         /**
+         * Matrix data, stored as a typed array. Column-major order.
          * @type {number[]}
          */
         this.data = new TypedArray(size * size);
     }
 
+    /**
+     * @returns {number} Side length of the matrix.
+     */
     get n() {
         return this.size;
     }
 
+    /**
+     * @returns {number} Total number of elements in the matrix (size * size).
+     */
     get length() {
         return this.size * this.size;
     }
 
+    /**
+     * Returns direct reference to underlying data, modifying it WILL affect the matrix.
+     * @returns {number[]}
+     */
     get val() {
         return this.data;
     }
 
+    /**
+     * Fills the entire matrix with the given value.
+     * @param {number} v Value to fill the matrix with.
+     * @returns {void}
+     */
     fill(v) {
         this.data.fill(v);
     }
 
     /**
-     *
-     * @param {SquareMatrix} other
+     * Subtracts another matrix from this matrix (this = this - other).
+     * @param {SquareMatrix} other The matrix to subtract. Must be of the same size.
      */
     subtract(other) {
         this.subtractMatrices(this, other);
     }
 
     /**
-     * Component-size subtraction
-     * @param {SquareMatrix} a
-     * @param {SquareMatrix} b
+     * Subtracts matrix 'b' from matrix 'a', storing the result in this matrix (this = a - b).
+     * Component-wise operation.
+     * @param {SquareMatrix} a The first matrix.
+     * @param {SquareMatrix} b The second matrix.
      */
     subtractMatrices(a, b) {
         const size = this.size;
@@ -82,7 +104,7 @@ export class SquareMatrix {
     }
 
     /**
-     * Individually negate each value in the matrix
+     * Negates all elements of the matrix (multiplies each element by -1).
      */
     negate() {
         const data = this.data;
@@ -93,7 +115,7 @@ export class SquareMatrix {
     }
 
     /**
-     * Set all cells to 0
+     * Sets all elements of the matrix to 0.
      */
     clear() {
         this.data.fill(0);
@@ -101,6 +123,7 @@ export class SquareMatrix {
 
     /**
      * Set diagonal to 1
+     * NOTE: if the other cells are 0s - it will produce identity matrix, but those cells will not be written explicitly
      */
     eye() {
         const size = this.size;
@@ -111,8 +134,8 @@ export class SquareMatrix {
     }
 
     /**
-     *
-     * @param {SquareMatrix} other
+     * Copies the elements of another matrix into this matrix.
+     * @param {SquareMatrix} other The matrix to copy from.  Must be the same size.
      */
     copy(other) {
         assert.equal(this.size, other.size, 'difference sizes');
@@ -121,8 +144,8 @@ export class SquareMatrix {
     }
 
     /**
-     *
-     * @return {SquareMatrix}
+     * Creates a new matrix that is a copy of this matrix.
+     * @returns {SquareMatrix} A new matrix with the same elements.
      */
     clone() {
         const r = new SquareMatrix(this.size, this.type);
@@ -133,7 +156,7 @@ export class SquareMatrix {
     }
 
     /**
-     * Transpose matrix
+     * Transposes the matrix in-place (swaps rows and columns).
      */
     transpose() {
         const size = this.size;
@@ -152,29 +175,33 @@ export class SquareMatrix {
     }
 
     /**
-     *
-     * @param {number[]} arr
+     * Populates matrix from a 1D array.
+     * @param {number[]} arr Source array.  Must have at least size*size elements.
      */
     fromArray(arr) {
         this.data.set(arr);
     }
 
     /**
-     *
-     * @param {number[]} [destination]
-     * @param {number} [offset]
+     * Copies matrix elements into a 1D array.
+     * @param {number[]} [destination] Array to store matrix into. Creates a new array if not provided.
+     * @param {number} [offset=0] Starting index in the destination array.
+     * @returns {number[]} The array containing the matrix data.
      */
-    toArray(destination = new Array(this.length), offset = 0) {
+    toArray(
+        destination = new Array(this.length),
+        offset = 0
+    ) {
         array_copy(this.data, 0, destination, offset, this.length);
 
         return destination;
     }
 
     /**
-     *
-     * @param {number} row_index
-     * @param {number} column_index
-     * @param {number} value
+     * Sets the value of a cell in the matrix.
+     * @param {number} row_index Row index (0-based).
+     * @param {number} column_index Column index (0-based).
+     * @param {number} value The value to set.
      */
     setCellValue(row_index, column_index, value) {
         assert.isNonNegativeInteger(row_index, 'row_index');
@@ -189,10 +216,10 @@ export class SquareMatrix {
     }
 
     /**
-     *
-     * @param {number} row_index
-     * @param {number} column_index
-     * @return {number}
+     * Retrieves the value of a cell in the matrix.
+     * @param {number} row_index Row index (0-based).
+     * @param {number} column_index Column index (0-based).
+     * @returns {number} The value of the cell.
      */
     getCellValue(row_index, column_index) {
         assert.isNonNegativeInteger(row_index, 'row_index');
@@ -201,13 +228,12 @@ export class SquareMatrix {
         assert.lessThan(row_index, this.size, 'row overflow');
         assert.lessThan(column_index, this.size, 'column overflow');
 
-
         return this.data[this.size * column_index + row_index];
     }
 
     /**
      * Read values at the diagonal, from left to right, top to bottom
-     * @param {number[]|Float32Array|Float64Array} result
+     * @param {number[]|Float32Array|Float64Array} result Array to store the diagonal.
      */
     readDiagonal(result) {
         const n = this.size;

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

@@ -1,12 +1,13 @@
 /**
+ * One-dimensional curve conversion from cubic Hermite to bezier
  * TODO: not tested
- * @param {Float32Array|number[]} result
- * @param {number} result_offset
- * @param {number} result_stride
+ * @param {Float32Array|number[]} result where to put results
+ * @param {number} result_offset offset to start writing at in result array
+ * @param {number} result_stride how far to step between each written value. Necessary for N-dimensional curves where we want to interleave multiple curves together, such as for color or quaternions
  * @param {number} p0
  * @param {number} p1
- * @param {number} m0
- * @param {number} m1
+ * @param {number} m0 tangent at p0
+ * @param {number} m1 tangent at p1
  */
 export function spline_hermite3_to_bezier(result: Float32Array | number[], result_offset: number, result_stride: number, p0: number, p1: number, m0: number, m1: number): void;
 //# sourceMappingURL=spline_hermite3_to_bezier.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"spline_hermite3_to_bezier.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/spline/spline_hermite3_to_bezier.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,kDARW,YAAY,GAAC,MAAM,EAAE,iBACrB,MAAM,iBACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,QAehB"}
+{"version":3,"file":"spline_hermite3_to_bezier.d.ts","sourceRoot":"","sources":["../../../../../src/core/math/spline/spline_hermite3_to_bezier.js"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,kDARW,YAAY,GAAC,MAAM,EAAE,iBACrB,MAAM,iBACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,QAkBhB"}

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

@@ -1,24 +1,28 @@
 /**
+ * One-dimensional curve conversion from cubic Hermite to bezier
  * TODO: not tested
- * @param {Float32Array|number[]} result
- * @param {number} result_offset
- * @param {number} result_stride
+ * @param {Float32Array|number[]} result where to put results
+ * @param {number} result_offset offset to start writing at in result array
+ * @param {number} result_stride how far to step between each written value. Necessary for N-dimensional curves where we want to interleave multiple curves together, such as for color or quaternions
  * @param {number} p0
  * @param {number} p1
- * @param {number} m0
- * @param {number} m1
+ * @param {number} m0 tangent at p0
+ * @param {number} m1 tangent at p1
  */
-export function spline_hermite3_to_bezier(result, result_offset, result_stride, p0, p1, m0, m1) {
+export function spline_hermite3_to_bezier(
+    result,
+    result_offset,
+    result_stride,
+    p0, p1,
+    m0, m1
+) {
 
     // see https://stackoverflow.com/questions/42574940/draw-hermite-curve-on-browser-canvas-javascript
     // see https://pomax.github.io/bezierinfo/#catmullconv
 
-    const tension = 1;
-    const tension_factor = 2 * tension;
-
     result[result_offset + 0 * result_stride] = p0;
-    result[result_offset + 1 * result_stride] = p0 + m0 / tension_factor;
-    result[result_offset + 2 * result_stride] = p1 - m1 / tension_factor;
+    result[result_offset + 1 * result_stride] = p0 + m0 / 3;
+    result[result_offset + 2 * result_stride] = p1 - m1 / 3;
     result[result_offset + 3 * result_stride] = p1;
 
 }

package/src/core/model/ModuleRegistry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModuleRegistry.d.ts","sourceRoot":"","sources":["../../../../src/core/model/ModuleRegistry.js"],"names":[],"mappings":"AAEA;;GAEG;AACH,4BAFa,CAAC;IAeV;;;OAGG;IACH,oCAiBG;IAEH;;;OAGG;IACH,6BAEC;IAGD;;;;OAIG;IACH,IAJiB,CAAC,SAAJ,CAAE,iBAEH,CAAC,CAIb;IAED;;;;OAIG;IACH,UAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;OAKG;IACH,IALiB,CAAC,SAAJ,CAAE,QACL,MAAM,UACN,CAAC,GACC,OAAO,CA0BnB;IAED;;;;;;OAMG;IACH,kBALiB,CAAC,SAAJ,CAAE,UACL,CAAC,GACC,MAAM,EAAE,CAYpB;IAED,mBAEC;;CACJ"}
+{"version":3,"file":"ModuleRegistry.d.ts","sourceRoot":"","sources":["../../../../src/core/model/ModuleRegistry.js"],"names":[],"mappings":"AAEA;;GAEG;AACH,4BAFa,CAAC;IAeV;;;OAGG;IACH,oCAiBG;IAEH;;;OAGG;IACH,6BAEC;IAGD;;;;OAIG;IACH,IAJiB,CAAC,SAAJ,CAAE,iBAEH,CAAC,CAIb;IAED;;;;OAIG;IACH,UAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;OAKG;IACH,IALiB,CAAC,SAAJ,CAAE,QACL,MAAM,UACN,CAAC,GACC,OAAO,CA0BnB;IAED;;;;;;OAMG;IACH,kBALa,CAAC,UACH,CAAC,GACC,MAAM,EAAE,CAYpB;IAED,mBAEC;;CACJ"}

package/src/core/model/ModuleRegistry.js

@@ -100,10 +100,10 @@ export class ModuleRegistry {
 
     /**
      * Find all names associated with the given module
-     * @template {T} M
+     * @template M
      * @param {M} module
      * @returns {string[]}
-     * @throws if module is not registered
+     * @throws {Error} if module is not registered
      */
     findNamesByModule(module) {
 

package/src/core/model/stat/Stat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stat.d.ts","sourceRoot":"","sources":["../../../../../src/core/model/stat/Stat.js"],"names":[],"mappings":";AASA;IAiPI;;;;;OAKG;IACH,6BAJW,MAAM,aACN,IAAI,CAAC,cAAc,CAAC,GAClB,MAAM,CAoBlB;IAxQD;;;OAGG;IACH,mBAHW,MAAM,EAoChB;IA5BG;;;OAGG;IACH,IAFU,MAAM,CAEL;IAEX;;;OAGG;IACH,MAFU,OAAO,CAEa;IAE9B;;;;OAIG;IACH,6BAA6B;IAE7B,eAA+B;IAI/B;;;OAGG;IACH,aAFU,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,CAEE;IAGxC;;;OAGG;IACH,uBAFa,MAAM,CAAC,cAAc,CAAC,CAIlC;IAED;;;OAGG;IACH,yBAFa,MAAM,CAAC,cAAc,CAAC,CAIlC;IAED;;OAEG;IACH,uBAEC;IAUD;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED,oBAUC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,gBAFW,MAAM,QAIhB;IAED;;;OAGG;IACH,gBAFY,cAAc,EAAE,CAI3B;IAED;;;OAGG;IACH,iBAFW,cAAc,QAMxB;IAED;;;;OAIG;IACH,iBAHW,cAAc,GACb,OAAO,CAIlB;IAED;;;;OAIG;IACH,oBAHW,cAAc,GACZ,OAAO,CAQnB;IAED;;;;OAIG;IACH,cAHW,IAAI,GACF,OAAO,CASnB;IAED;;;OAGG;IACH,YAFW,IAAI,QAOd;IAED;;;OAGG;IACH,gBAFW,IAAI,QAId;IAED;;;;OAIG;IACH,iCAHW,CAAS,IAAM,EAAN,MAAM,KAAE,MAAM,KACvB,MAAM,QAKhB;IAED;;OAEG;IACH,wCAFW,IAAI,QAmBd;IAED;;;MAKC;IAED,0BAIC;IAED;;;OAGG;IACH,iBAFa,MAAM,CAIlB;IAqDL;;;OAGG;IACH,iBAFU,OAAO,CAEI;CA9BpB;;;QAOe,8BAHD,MAAM,GACL,MAAM,CAIjB;QACK,kCAEL;QAMS,gCAHC,MAAM,GACJ,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,CAMpC;;;;oBAtSe,uBAAuB;2BAIhB,qBAAqB;iBAN/B,+BAA+B;sBAC1B,yBAAyB"}
+{"version":3,"file":"Stat.d.ts","sourceRoot":"","sources":["../../../../../src/core/model/stat/Stat.js"],"names":[],"mappings":";AASA;;;;;;;GAOG;AACH;IAyPI;;;;;OAKG;IACH,6BAJW,MAAM,aACN,IAAI,CAAC,cAAc,CAAC,GAClB,MAAM,CAoBlB;IA3PD;;;OAGG;IACH,oBAHW,MAAM,EAuBhB;IA7CD;;;OAGG;IACH,IAFU,MAAM,CAET;IAEP;;;;;;OAMG;IACH,6BAAyB;IAEzB;;;OAGG;IACH,aAFU,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,CAEF;IAY5B;;;OAGG;IACH,MAFU,OAAO,CAEa;IAE9B;;;OAGG;IACH,OAFU,OAAO,CAEc;IAMnC;;;OAGG;IACH,uBAFa,MAAM,CAAC,cAAc,CAAC,CAIlC;IAED;;;OAGG;IACH,yBAFa,MAAM,CAAC,cAAc,CAAC,CAIlC;IAED;;OAEG;IACH,uBAEC;IAUD;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED,oBAUC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,gBAFW,MAAM,QAIhB;IAED;;;OAGG;IACH,gBAFY,cAAc,EAAE,CAI3B;IAED;;;OAGG;IACH,iBAFW,cAAc,QAMxB;IAED;;;;OAIG;IACH,iBAHW,cAAc,GACb,OAAO,CAIlB;IAED;;;;OAIG;IACH,oBAHW,cAAc,GACZ,OAAO,CAQnB;IAED;;;;OAIG;IACH,cAHW,IAAI,GACF,OAAO,CASnB;IAED;;;OAGG;IACH,YAFW,IAAI,QAOd;IAED;;;OAGG;IACH,gBAFW,IAAI,QAId;IAED;;;;OAIG;IACH,iCAHW,CAAS,IAAM,EAAN,MAAM,KAAE,MAAM,KACvB,MAAM,QAKhB;IAED;;OAEG;IACH,wCAFW,IAAI,QAmBd;IAED;;;MAKC;IAED,0BAIC;IAED;;;OAGG;IACH,iBAFa,MAAM,CAIlB;IAwDL;;;OAGG;IACH,iBAFU,OAAO,CAEI;CAjCpB;;;QAOe,8BAHD,MAAM,GACL,MAAM,CAIjB;QACK,kCAEL;QAMS,gCAHC,MAAM,GACJ,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,CAMpC;;;;oBAtTe,uBAAuB;2BAIhB,qBAAqB;iBAN/B,+BAA+B;sBAC1B,yBAAyB"}