@woosh/meep-engine 2.126.34 → 2.126.36

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.36",
   "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/Quaternion.d.ts

@@ -1,11 +1,16 @@
 /**
- * Rotation representation in 3d space
+ * Implementation of a quaternion.
+ * Represents rotation in 3d space
+ *
+ * Iterating through a Quaternion instance will yield its components `(x, y, z, w)` in the corresponding order.
+ *
  * @see https://en.wikipedia.org/wiki/Quaternion
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
-export class Quaternion {
+export class Quaternion implements Iterable<number> {
     /**
      *
      * @param {Vector3} axis
@@ -154,24 +159,27 @@ export class Quaternion {
      */
     angleTo(other: Quaternion): number;
     /**
-     *
+     * Set quaternion from axis + angle definition
      * @param {Vector3} axis
      * @param {number} angle
      */
     fromAxisAngle(axis: Vector3, angle: number): void;
     /**
      *
-     * @param {number} ax
-     * @param {number} ay
-     * @param {number} az
+     * @param {number} axis_x
+     * @param {number} axis_y
+     * @param {number} axis_z
      * @param {number} angle
      */
-    _fromAxisAngle(ax: number, ay: number, az: number, angle: number): void;
+    _fromAxisAngle(axis_x: number, axis_y: number, axis_z: number, angle: number): void;
     /**
-     * @see https://stackoverflow.com/questions/3684269/component-of-a-quaternion-rotation-around-an-axis
+     * Given a direction axis, compute rotation quaternions from current rotation to that axis as swing and twist. Swing moves to a given orientation while without "twisting",
+     * `twist` just the twist around the given axis, no change in orientation.
      * @param {Vector3} axis
-     * @param {Quaternion} swing
-     * @param {Quaternion} twist
+     * @param {Quaternion} swing Swing quaternion will be written here
+     * @param {Quaternion} twist Twist quaternion will be written here
+     * @returns {void}
+     * @see slerp
      */
     computeSwingAndTwist(axis: Vector3, swing: Quaternion, twist: Quaternion): void;
     /**
@@ -251,7 +259,7 @@ export class Quaternion {
      * @param {number} x
      * @param {number} y
      * @param {number} z
-     * @param {String} [order] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
+     * @param {String} [order='XYZ'] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
      * @returns {Quaternion}
      */
     __setFromEuler(x: number, y: number, z: number, order?: string): Quaternion;
@@ -477,9 +485,10 @@ export class Quaternion {
      */
     writeToArray(array?: number[], offset?: number): number[];
     /**
-     *
+     * Strict equality check
      * @param {Quaternion} other
      * @returns {boolean}
+     * @see roughlyEquals
      */
     equals(other: Quaternion): boolean;
     /**
@@ -500,7 +509,7 @@ export class Quaternion {
      * @param {number} y
      * @param {number} z
      * @param {number} w
-     * @param {number} [tolerance]
+     * @param {number} [tolerance] acceptable difference value per coordinate
      * @return {boolean}
      */
     _roughlyEquals(x: number, y: number, z: number, w: number, tolerance?: number): boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"Quaternion.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Quaternion.js"],"names":[],"mappings":"AAmBA;;;;;;GAMG;AACH;IAuRI;;;;;OAKG;IACH,2BAJW,OAAO,SACP,MAAM,GACJ,UAAU,CAQtB;IA6nCD;;;;OAIG;IACH,kCAFa,UAAU,CAQtB;IAED;;;;;;;OAOG;IACH,0BALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,UAAU,CAQtB;IAED;;;;;;OAMG;IACH,6BALW,UAAU,QACV,UAAU,MACV,UAAU,aACV,MAAM,QAuBhB;IAx9CD;;;;;;;OAOG;IACH,gBANW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAsChB;IA7BG;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;;;;OAMG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAEnD;IAqCjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAgDD;;;;;;;;;;OAUG;IACH,kBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAqDhB;IAED;;;;OAIG;IACH,sBAHW,OAAO,OACP,OAAO,QASjB;IAED;;;;OAIG;IACH,WAHW,UAAU,GACT,MAAM,CAQjB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAKpB;IAED;;;OAGG;IACH,UAFa,IAAI,CAuBhB;IAED;;;;OAIG;IACH,eAHW,UAAU,GACT,MAAM,CAoBjB;IAiBD;;;;OAIG;IACH,oBAHW,OAAO,SACP,MAAM,QAMhB;IAED;;;;;;OAMG;IACH,mBALW,MAAM,MACN,MAAM,MACN,MAAM,SACN,MAAM,QA6BhB;IAED;;;;;OAKG;IACH,2BAJW,OAAO,SACP,UAAU,SACV,UAAU,QA+BpB;IAED;;;;OAIG;IACH,wBAHW,OAAO,GACL,MAAM,CAYlB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAkBlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAehB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACL,IAAI,CASf;IAED;;;OAGG;IACH,gBAHW,UAAU,GACR,IAAI,CAIhB;IAED;;;;;OAKG;IACH,2BAJW,UAAU,UACV,UAAU,GACR,IAAI,CAchB;IAED;;;;;;;;;;;OAWG;IACH,yBAVW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAehB;IAED;;;OAGG;IACH,UAFY,MAAM,CASjB;IAED;;;;;OAKG;IACH,qBAJW,UAAU,aACV,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,eAJW,OAAO,UACP,OAAO,OACP,OAAO,QAUjB;IAED;;;OAGG;IACH,kBAFW,MAAW,MAAM,QAI3B;IAED;;;;;;;OAOG;IACH,kBANW,MAAM,KACN,MAAM,KACN,MAAM,mBAEJ,UAAU,CAwCtB;IAED;;;;OAIG;IACH,yBAFW,OAAO,QA4BjB;IAED;;;OAGG;IACH,yBAFW,OAAO,QA2BjB;IAED;;;OAGG;IACH,yBAFW,OAAO,QA0BjB;IAGD;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;OAMG;IACH,sBAJW,OAAO,MACP,OAAO,GACL,IAAI,CAkEhB;IAED;;;OAGG;IACH,4BAHW,MAAM,EAAE,GACN,IAAI,CAYhB;IAED;;;;;;;;;;;;;;OAcG;IACH,6BAXW,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,GACJ,IAAI,CA4EhB;IAED;;;;;OAKG;IACH,YAJW,UAAU,KACV,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;;;OAOG;IACH,uBALW,UAAU,UACV,UAAU,KACV,MAAM,GACJ,IAAI,CAgBhB;IAED;;;;;;OAMG;IACH,uBALW,UAAU,MACV,UAAU,KACV,MAAM,GACJ,IAAI,CAyDhB;IAGD;;;;;OAKG;IACH,aAJW,UAAU,KACV,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,gCAHW,GAAC,GACC,IAAI,CAUhB;IAED;;;;OAIG;IACH,YAHW,UAAU,GACR,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,UAAU,CAQtB;IAED;;;;;;;;OAQG;IACH,OANW,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CA+BhB;IAED;;;OAGG;IACH,aAFa,IAAI,CAIhB;IAED;;;;;MAOC;IAED;;;;OAIG;IACH,oBAFY,IAAI,CAIf;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED;;;OAGG;IACH,8BAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,gCAFW,YAAY,QAStB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,EAAE,WACR,MAAM,GACJ,IAAI,CAShB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,EAAE,WACR,MAAM,GACJ,MAAM,EAAE,CASpB;IAED;;;;OAIG;IACH,cAHW,UAAU,GACR,OAAO,CAQnB;IAED;;;OAGG;IACH,QAFa,MAAM,CAQlB;IAED;;;;;OAKG;IACH,qBAJW,UAAU,cACV,MAAM,GACL,OAAO,CAIlB;IAED;;;;;;;;OAQG;IACH,kBAPW,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CAOlB;IAED;;;;OAIG;IACH,gBAHW,MAAW,MAAM,GAChB,UAAU,CAyBrB;IAED,mBAEC;IA8DL,mBA7Ke,MAAM,EAAE,WACR,MAAM,gBA4KS;IAC9B,kBA/Je,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CA6JG;IAC5B,kBAhKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CA8JG;IAC5B,qBAjyBe,MAAM,KACN,MAAM,KACN,MAAM,gBA+xBe;IAQpC;;;;OAIG;IACH,uBAFU,OAAO,CAEgB;IA53C7B;;;OAGG;IACH,qBAFa,SAAS,CAAC,MAAM,CAAC,CAS7B;CA+1CJ;;kBASS,UAAU;kBAaV,MAAM;;;mBAzgDG,4BAA4B;oBAS3B,cAAc"}
+{"version":3,"file":"Quaternion.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Quaternion.js"],"names":[],"mappings":"AAoBA;;;;;;;;;;;GAWG;AACH,mCALe,QAAQ,CAAC,MAAM;IA4R1B;;;;;OAKG;IACH,2BAJW,OAAO,SACP,MAAM,GACJ,UAAU,CAQtB;IAqpCD;;;;OAIG;IACH,kCAFa,UAAU,CAQtB;IAED;;;;;;;OAOG;IACH,0BALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,UAAU,CAQtB;IAED;;;;;;OAMG;IACH,6BALW,UAAU,QACV,UAAU,MACV,UAAU,aACV,MAAM,QAuBhB;IAh/CD;;;;;;;OAOG;IACH,gBANW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAsChB;IA7BG;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;;;;OAMG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAEnD;IAqCjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAkCD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAtCD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAgDD;;;;;;;;;;OAUG;IACH,kBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAqDhB;IAED;;;;OAIG;IACH,sBAHW,OAAO,OACP,OAAO,QASjB;IAED;;;;OAIG;IACH,WAHW,UAAU,GACT,MAAM,CAQjB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAKpB;IAED;;;OAGG;IACH,UAFa,IAAI,CAuBhB;IAED;;;;OAIG;IACH,eAHW,UAAU,GACT,MAAM,CAoBjB;IAiBD;;;;OAIG;IACH,oBAHW,OAAO,SACP,MAAM,QAMhB;IAED;;;;;;OAMG;IACH,uBALW,MAAM,UACN,MAAM,UACN,MAAM,SACN,MAAM,QAkChB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,SACP,UAAU,SACV,UAAU,GACR,IAAI,CAyChB;IAED;;;;OAIG;IACH,wBAHW,OAAO,GACL,MAAM,CAYlB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAkBlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAehB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACL,IAAI,CASf;IAED;;;OAGG;IACH,gBAHW,UAAU,GACR,IAAI,CAIhB;IAED;;;;;OAKG;IACH,2BAJW,UAAU,UACV,UAAU,GACR,IAAI,CAchB;IAED;;;;;;;;;;;OAWG;IACH,yBAVW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAehB;IAED;;;OAGG;IACH,UAFY,MAAM,CASjB;IAED;;;;;OAKG;IACH,qBAJW,UAAU,aACV,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,eAJW,OAAO,UACP,OAAO,OACP,OAAO,QAUjB;IAED;;;OAGG;IACH,kBAFW,MAAW,MAAM,QAI3B;IAED;;;;;;;OAOG;IACH,kBANW,MAAM,KACN,MAAM,KACN,MAAM,mBAEJ,UAAU,CAwCtB;IAED;;;;OAIG;IACH,yBAFW,OAAO,QA4BjB;IAED;;;OAGG;IACH,yBAFW,OAAO,QA2BjB;IAED;;;OAGG;IACH,yBAFW,OAAO,QA0BjB;IAGD;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;;;;OASG;IACH,sBALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAqBhB;IAED;;;;;;OAMG;IACH,sBAJW,OAAO,MACP,OAAO,GACL,IAAI,CAkEhB;IAED;;;OAGG;IACH,4BAHW,MAAM,EAAE,GACN,IAAI,CAYhB;IAED;;;;;;;;;;;;;;OAcG;IACH,6BAXW,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,OACN,MAAM,GACJ,IAAI,CA4EhB;IAED;;;;;OAKG;IACH,YAJW,UAAU,KACV,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;;;OAOG;IACH,uBALW,UAAU,UACV,UAAU,KACV,MAAM,GACJ,IAAI,CAgBhB;IAED;;;;;;OAMG;IACH,uBALW,UAAU,MACV,UAAU,KACV,MAAM,GACJ,IAAI,CA4DhB;IAGD;;;;;OAKG;IACH,aAJW,UAAU,KACV,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,gCAHW,GAAC,GACC,IAAI,CAUhB;IAED;;;;OAIG;IACH,YAHW,UAAU,GACR,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,UAAU,CAQtB;IAED;;;;;;;;OAQG;IACH,OANW,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CA+BhB;IAED;;;OAGG;IACH,aAFa,IAAI,CAIhB;IAED;;;;;MAOC;IAED;;;;OAIG;IACH,oBAFY,IAAI,CAIf;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED;;;OAGG;IACH,8BAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,gCAFW,YAAY,QAStB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,EAAE,WACR,MAAM,GACJ,IAAI,CAShB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,EAAE,WACR,MAAM,GACJ,MAAM,EAAE,CASpB;IAED;;;;;OAKG;IACH,cAJW,UAAU,GACR,OAAO,CASnB;IAED;;;OAGG;IACH,QAFa,MAAM,CAQlB;IAED;;;;;OAKG;IACH,qBAJW,UAAU,cACV,MAAM,GACL,OAAO,CAOlB;IAED;;;;;;;;OAQG;IACH,kBAPW,MAAM,KACN,MAAM,KACN,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CASlB;IAED;;;;OAIG;IACH,gBAHW,MAAW,MAAM,GAChB,UAAU,CAuBrB;IAED,mBAEC;IA8DL,mBAjLe,MAAM,EAAE,WACR,MAAM,gBAgLS;IAC9B,kBAnKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAiKG;IAC5B,kBApKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAkKG;IAC5B,qBAxyBe,MAAM,KACN,MAAM,KACN,MAAM,gBAsyBe;IAQpC;;;;OAIG;IACH,uBAFU,OAAO,CAEgB;IAp5C7B;;;OAGG;IACH,qBAFa,SAAS,CAAC,MAAM,CAAC,CAS7B;CAu3CJ;;kBASS,UAAU;kBAaV,MAAM;;;mBAviDG,4BAA4B;oBAU3B,cAAc"}

package/src/core/geom/Quaternion.js

@@ -5,6 +5,7 @@ import { clamp01 } from "../math/clamp01.js";
 import { EPSILON } from "../math/EPSILON.js";
 import { epsilonEquals } from "../math/epsilonEquals.js";
 import { lerp } from "../math/lerp.js";
+import { PI2 } from "../math/PI2.js";
 import { computeHashFloat } from "../primitives/numbers/computeHashFloat.js";
 import { v3_dot } from "./vec3/v3_dot.js";
 import { v4_length } from "./vec4/v4_length.js";
@@ -18,8 +19,13 @@ const sin = Math.sin;
 const cos = Math.cos;
 
 /**
- * Rotation representation in 3d space
+ * Implementation of a quaternion.
+ * Represents rotation in 3d space
+ *
+ * Iterating through a Quaternion instance will yield its components `(x, y, z, w)` in the corresponding order.
+ *
  * @see https://en.wikipedia.org/wiki/Quaternion
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
@@ -207,7 +213,7 @@ export class Quaternion {
         const m12 = scratch_v3_a.y;
         const m22 = scratch_v3_a.z;
 
-       return this.__setFromRotationMatrix(
+        return this.__setFromRotationMatrix(
             m00, m01, m02,
             m10, m11, m12,
             m20, m21, m22
@@ -318,7 +324,7 @@ export class Quaternion {
     }
 
     /**
-     *
+     * Set quaternion from axis + angle definition
      * @param {Vector3} axis
      * @param {number} angle
      */
@@ -330,25 +336,30 @@ export class Quaternion {
 
     /**
      *
-     * @param {number} ax
-     * @param {number} ay
-     * @param {number} az
+     * @param {number} axis_x
+     * @param {number} axis_y
+     * @param {number} axis_z
      * @param {number} angle
      */
-    _fromAxisAngle(ax, ay, az, angle) {
-        assert.isNumber(ax, 'ax');
-        assert.isNumber(ay, 'ay');
-        assert.isNumber(az, 'az');
+    _fromAxisAngle(axis_x, axis_y, axis_z, angle) {
+        assert.isNumber(axis_x, 'axis_x');
+        assert.isNumber(axis_y, 'axis_y');
+        assert.isNumber(axis_z, 'axis_z');
         assert.isNumber(angle, 'angle');
 
+        assert.notNaN(axis_x, 'axis_x');
+        assert.notNaN(axis_y, 'axis_y');
+        assert.notNaN(axis_z, 'axis_z');
+        assert.notNaN(angle, 'angle');
+
         const halfAngle = angle * 0.5;
 
         const sinA2 = sin(halfAngle);
         const cosA2 = cos(halfAngle);
 
-        const qx = ax * sinA2;
-        const qy = ay * sinA2;
-        const qz = az * sinA2;
+        const qx = axis_x * sinA2;
+        const qy = axis_y * sinA2;
+        const qz = axis_z * sinA2;
         const qw = cosA2;
 
         //normalize
@@ -365,12 +376,21 @@ export class Quaternion {
     }
 
     /**
-     * @see https://stackoverflow.com/questions/3684269/component-of-a-quaternion-rotation-around-an-axis
+     * Given a direction axis, compute rotation quaternions from current rotation to that axis as swing and twist. Swing moves to a given orientation while without "twisting",
+     * `twist` just the twist around the given axis, no change in orientation.
      * @param {Vector3} axis
-     * @param {Quaternion} swing
-     * @param {Quaternion} twist
+     * @param {Quaternion} swing Swing quaternion will be written here
+     * @param {Quaternion} twist Twist quaternion will be written here
+     * @returns {void}
+     * @see slerp
      */
     computeSwingAndTwist(axis, swing, twist) {
+        assert.defined(axis, 'axis');
+        assert.defined(swing, 'swing');
+        assert.defined(twist, 'twist');
+
+        // see https://stackoverflow.com/questions/3684269/component-of-a-quaternion-rotation-around-an-axis
+
         const x = this.x;
         const y = this.y;
         const z = this.z;
@@ -388,16 +408,19 @@ export class Quaternion {
         const pz = axis.z * m;
 
         if (d < 0) {
+
             // axis points in the opposite direction from calculated twist, invert all components
             twist.set(-px, -py, -pz, -w);
+
         } else {
+
             twist.set(px, py, pz, w);
 
         }
 
         twist.normalize();
 
-        // rotation * twist.conjugated()
+        // rotation * twist.conjugated(), basically undo the twist
         swing._multiplyQuaternions(x, y, z, w, -twist.x, -twist.y, -twist.z, twist.w);
     }
 
@@ -414,7 +437,7 @@ export class Quaternion {
 
         this.computeSwingAndTwist(axis, swing, twist);
 
-        // extract twist angle from quaternion, see {@link #toAxisAngle}
+        // Extract the twist angle from quaternion, see {@link #toAxisAngle}
         return Math.acos(twist.w) * 2;
     }
 
@@ -583,7 +606,7 @@ export class Quaternion {
      * @param {number} x
      * @param {number} y
      * @param {number} z
-     * @param {String} [order] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
+     * @param {String} [order='XYZ'] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
      * @returns {Quaternion}
      */
     __setFromEuler(
@@ -1163,6 +1186,7 @@ export class Quaternion {
 
         // calculate coefficients
         if ((1.0 - cos_angle) > EPSILON) {
+
             // standard case (slerp)
             const angle = Math.acos(cos_angle);
 
@@ -1172,10 +1196,12 @@ export class Quaternion {
             scale1 = sin(t * angle) * recip_sin_angle;
 
         } else {
+
             // "from" and "to" quaternions are very close
             //  ... so we can do a linear interpolation
             scale0 = 1.0 - t;
             scale1 = t;
+
         }
 
         // calculate final values
@@ -1380,9 +1406,10 @@ export class Quaternion {
     }
 
     /**
-     *
+     * Strict equality check
      * @param {Quaternion} other
      * @returns {boolean}
+     * @see roughlyEquals
      */
     equals(other) {
         return this.x === other.x
@@ -1411,7 +1438,10 @@ export class Quaternion {
      * @return {boolean}
      */
     roughlyEquals(other, tolerance) {
-        return this._roughlyEquals(other.x, other.y, other.z, other.w, tolerance);
+        return this._roughlyEquals(
+            other.x, other.y, other.z, other.w,
+            tolerance
+        );
     }
 
     /**
@@ -1420,10 +1450,12 @@ export class Quaternion {
      * @param {number} y
      * @param {number} z
      * @param {number} w
-     * @param {number} [tolerance]
+     * @param {number} [tolerance] acceptable difference value per coordinate
      * @return {boolean}
      */
     _roughlyEquals(x, y, z, w, tolerance = EPSILON) {
+        assert.isNumber(tolerance, 'tolerance');
+
         return epsilonEquals(this.x, x, tolerance)
             && epsilonEquals(this.y, y, tolerance)
             && epsilonEquals(this.z, z, tolerance)
@@ -1446,8 +1478,6 @@ export class Quaternion {
         const sqrt1u1 = Math.sqrt(1 - u1);
         const sqrtu1 = Math.sqrt(u1);
 
-        const PI2 = 2 * Math.PI;
-
         const u2 = PI2 * random();
 
         const u3 = PI2 * random();

package/src/core/geom/Vector1.d.ts

@@ -1,4 +1,6 @@
 /**
+ * Wrapper around a scalar value, `Vector1` is used for consistence with {@link Vector2} and {@link Vector3}
+ *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
@@ -19,7 +21,11 @@ export class Vector1 extends Number {
      */
     constructor(x?: number);
     x: number;
-    onChanged: Signal<any, any, any, any, any, any, any, any>;
+    /**
+     *
+     * @type {Signal<number,number>}
+     */
+    onChanged: Signal<number, number>;
     /**
      *
      * @returns {string}

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

@@ -1 +1 @@
-{"version":3,"file":"Vector1.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector1.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IA4QI;;;;;OAKG;IACH,kBAJW,OAAO,KACP,OAAO,GACN,MAAM,CAIjB;IAnRD;;;;;;OAMG;IACH,gBALW,MAAM,EAchB;IAHG,UAAU;IAEV,0DAA6B;IAWjC;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,iBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,OAHW,MAAM,GACJ,OAAO,CAgBnB;IAED;;;OAGG;IACH,aAFW,MAAM,QAOhB;IAED;;;OAGG;IACH,UAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,kBAEC;IAED;;;OAGG;IACH,kBAEC;IAED;;;;OAIG;IACH,iBAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,WAFW,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,WAKzC;IAED;;;;OAIG;IACH,iBAFY,OAAO,CAIlB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,kBAFW,MAAM,QAIhB;IAED;;;;;OAKG;IACH,WAJW,MAAM,QACN,MAAM,GACJ,OAAO,CAInB;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,YAFW,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,QAIzC;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,QAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,4BAGC;IAED,iBAEC;IAED,yBAEC;IAED;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAIhB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAIhB;IAED,oBAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAItB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAMtB;IAkBD,iBAEC;IAND,gBAEC;IAaL;;;OAGG;IACH,oBAFU,OAAO,CAEU;IAXvB,sDAIC;CACJ;;kBAUS,MAAM;cAON,OAAO;aAOP,OAAO;;;mBArUE,4BAA4B"}
+{"version":3,"file":"Vector1.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector1.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH;IAgRI;;;;;OAKG;IACH,kBAJW,OAAO,KACP,OAAO,GACN,MAAM,CAIjB;IAvRD;;;;;;OAMG;IACH,gBALW,MAAM,EAkBhB;IAPG,UAAU;IAEV;;;OAGG;IACH,WAFU,MAAM,CAAC,MAAM,EAAC,MAAM,CAAC,CAEF;IAWjC;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,iBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,OAHW,MAAM,GACJ,OAAO,CAgBnB;IAED;;;OAGG;IACH,aAFW,MAAM,QAOhB;IAED;;;OAGG;IACH,UAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,kBAEC;IAED;;;OAGG;IACH,kBAEC;IAED;;;;OAIG;IACH,iBAFY,OAAO,CAIlB;IAED;;;OAGG;IACH,WAFW,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,WAKzC;IAED;;;;OAIG;IACH,iBAFY,OAAO,CAIlB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,kBAFW,MAAM,QAIhB;IAED;;;;;OAKG;IACH,WAJW,MAAM,QACN,MAAM,GACJ,OAAO,CAInB;IAED;;;OAGG;IACH,eAEC;IAED;;;OAGG;IACH,YAFW,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,OAAO,QAIzC;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,QAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,4BAGC;IAED,iBAEC;IAED,yBAEC;IAED;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAIhB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAIhB;IAED,oBAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAItB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAMtB;IAkBD,iBAEC;IAND,gBAEC;IAaL;;;OAGG;IACH,oBAFU,OAAO,CAEU;IAXvB,sDAIC;CACJ;;kBAUS,MAAM;cAON,OAAO;aAOP,OAAO;;;mBA3UE,4BAA4B"}

package/src/core/geom/Vector1.js

@@ -4,6 +4,8 @@ import { clamp } from "../math/clamp.js";
 import { computeHashFloat } from "../primitives/numbers/computeHashFloat.js";
 
 /**
+ * Wrapper around a scalar value, `Vector1` is used for consistence with {@link Vector2} and {@link Vector3}
+ *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
@@ -23,6 +25,10 @@ export class Vector1 extends Number {
 
         this.x = x;
 
+        /**
+         *
+         * @type {Signal<number,number>}
+         */
         this.onChanged = new Signal();
     }
 

package/src/core/geom/Vector2.d.ts

@@ -1,9 +1,19 @@
 /**
+ * Class representing a 2D vector. A 2D vector is an ordered pair of numbers (labeled x and y), which can be used to represent a number of things, such as:
+ *
+ * A point in 2D space (i.e. a position on a plane).
+ * A direction and length across a plane. The length will always be the Euclidean distance (straight-line distance) from `(0, 0)` to `(x, y)` and the direction is also measured from `(0, 0)` towards `(x, y)`.
+ * Any arbitrary ordered pair of numbers.
+ * There are other things a 2D vector can be used to represent, such as momentum vectors, complex numbers and so on, however these are the most common uses.
+ *
+ * Iterating through a Vector2 instance will yield its components `(x, y)` in the corresponding order.
+ *
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
-export class Vector2 {
+export class Vector2 implements Iterable<number> {
     /**
      *
      * @param {number} [x=0]

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

@@ -1 +1 @@
-{"version":3,"file":"Vector2.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector2.js"],"names":[],"mappings":"AAcA;;;;GAIG;AACH;IACI;;;;OAIG;IACH,gBAHW,MAAM,MACN,MAAM,EA0BhB;IAjBG;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAEhB;IAGjC;;;;;OAKG;IACH,iBAJW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,GACJ,IAAI,CAOhB;IAED;;;;OAIG;IACH,eAHW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,QAQhB;IAED,iBAMC;IAED;;;;;OAKG;IACH,OAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAuBhB;IAED;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAahB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,QAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAMhB;IAED;;;OAGG;IACH,OAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAOhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;OAGG;IACH,UAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,IAAI,CAOhB;IAED;;;MAEC;IAED,0BAOC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAKtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,8BAFW,YAAY,QAKtB;IAED;;;OAGG;IACH,gCAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,UAFa,OAAO,CAInB;IAED;;;;;;;OAOG;IACH,YANW,MAAM,QACN,MAAM,QACN,MAAM,QACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,eAJW,MAAM,QACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,iBAJW,MAAM,SACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,kBAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAMlB;IAED;;;;;;OAMG;IACH,eALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAOhB;IAED;;;;OAIG;IACH,sBAHW,MAAM,EAAE,GACN,IAAI,CAUhB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,eAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAIlB;IAED;;;;OAIG;IACH,2BAHW,OAAO,GACL,MAAM,CAOlB;IAED;;OAEG;IACH,UAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAahB;IAGD;;;OAGG;IACH,QAFa,MAAM,CAOlB;IAED;;;;OAIG;IACH,cAHW,MAAM,GACJ,IAAI,CAahB;IAED;;;;;OAKG;IACH,uCAHW,GAAC,GACC,IAAI,CAQhB;IAED,mBAEC;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAMnB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,cACP,MAAM,GACL,OAAO,CAIlB;IAED;;;;;;OAMG;IACH,kBALW,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CAKlB;IAUD,iBAEC;IAVD,gBAEC;IAUD,iBAEC;IAVD,gBAEC;IAsDL;;OAEG;IACH,sBAvoBe,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,UAsoBS;IAE9B;;OAEG;IACH,uBAzpBe,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,aAwpBU;IAG/B;;;OAGG;IACH,oBAFU,OAAO,CAEU;IA1DvB,sDAKC;CACJ;;mBAIS,OAAO;qBAMP,OAAO;qBAMP,OAAO;sBAMP,OAAO;qBAMP,OAAO;oBAKP,OAAO;;yBAsBP,MAAM;;;mBAvtBG,4BAA4B;4BAQnB,uBAAuB"}
+{"version":3,"file":"Vector2.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector2.js"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;GAcG;AACH,gCALe,QAAQ,CAAC,MAAM;IAM1B;;;;OAIG;IACH,gBAHW,MAAM,MACN,MAAM,EA0BhB;IAjBG;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAEhB;IAGjC;;;;;OAKG;IACH,iBAJW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,GACJ,IAAI,CAOhB;IAED;;;;OAIG;IACH,eAHW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,QAQhB;IAED,iBAMC;IAED;;;;;OAKG;IACH,OAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAuBhB;IAED;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAahB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,QAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,IAAI,CAMhB;IAED;;;OAGG;IACH,OAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,aAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAOhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;OAGG;IACH,UAFa,IAAI,CAIhB;IAED;;;;;OAKG;IACH,QAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,IAAI,CAOhB;IAED;;;MAEC;IAED,0BAOC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAKtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,8BAFW,YAAY,QAKtB;IAED;;;OAGG;IACH,gCAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,UAFa,OAAO,CAInB;IAED;;;;;;;OAOG;IACH,YANW,MAAM,QACN,MAAM,QACN,MAAM,QACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,eAJW,MAAM,QACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,iBAJW,MAAM,SACN,MAAM,GACJ,IAAI,CAMhB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,kBAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAMlB;IAED;;;;;;OAMG;IACH,eALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAOhB;IAED;;;;OAIG;IACH,sBAHW,MAAM,EAAE,GACN,IAAI,CAUhB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,eAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAIlB;IAED;;;;OAIG;IACH,2BAHW,OAAO,GACL,MAAM,CAOlB;IAED;;OAEG;IACH,UAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAahB;IAGD;;;OAGG;IACH,QAFa,MAAM,CAOlB;IAED;;;;OAIG;IACH,cAHW,MAAM,GACJ,IAAI,CAahB;IAED;;;;;OAKG;IACH,uCAHW,GAAC,GACC,IAAI,CAQhB;IAED,mBAEC;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAMnB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,cACP,MAAM,GACL,OAAO,CAIlB;IAED;;;;;;OAMG;IACH,kBALW,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CAKlB;IAUD,iBAEC;IAVD,gBAEC;IAUD,iBAEC;IAVD,gBAEC;IAsDL;;OAEG;IACH,sBAvoBe,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,UAsoBS;IAE9B;;OAEG;IACH,uBAzpBe,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,aAwpBU;IAG/B;;;OAGG;IACH,oBAFU,OAAO,CAEU;IA1DvB,sDAKC;CACJ;;mBAIS,OAAO;qBAMP,OAAO;qBAMP,OAAO;sBAMP,OAAO;qBAMP,OAAO;oBAKP,OAAO;;yBAsBP,MAAM;;;mBAjuBG,4BAA4B;4BAQnB,uBAAuB"}

package/src/core/geom/Vector2.js

@@ -13,6 +13,16 @@ import { v2_length } from "./vec2/v2_length.js";
 import { v2_length_sqr } from "./vec2/v2_length_sqr.js";
 
 /**
+ * Class representing a 2D vector. A 2D vector is an ordered pair of numbers (labeled x and y), which can be used to represent a number of things, such as:
+ *
+ * A point in 2D space (i.e. a position on a plane).
+ * A direction and length across a plane. The length will always be the Euclidean distance (straight-line distance) from `(0, 0)` to `(x, y)` and the direction is also measured from `(0, 0)` towards `(x, y)`.
+ * Any arbitrary ordered pair of numbers.
+ * There are other things a 2D vector can be used to represent, such as momentum vectors, complex numbers and so on, however these are the most common uses.
+ *
+ * Iterating through a Vector2 instance will yield its components `(x, y)` in the corresponding order.
+ *
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025

package/src/core/geom/Vector3.d.ts

@@ -1,9 +1,19 @@
 /**
+ * Class representing a 3D vector. A 3D vector is an ordered triplet of numbers (labeled x, y, and z), which can be used to represent a number of things, such as:
+ *
+ * A point in 3D space.
+ * A direction and length in 3D space. The length will always be the Euclidean distance (straight-line distance) from `(0, 0, 0)` to `(x, y, z)` and the direction is also measured from `(0, 0, 0)` towards `(x, y, z)`.
+ * Any arbitrary ordered triplet of numbers.
+ * There are other things a 3D vector can be used to represent, such as momentum vectors and so on, however these are the most common uses.
+ *
+ * Iterating through a Vector3 instance will yield its components `(x, y, z)` in the corresponding order.
+ *
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
-export class Vector3 {
+export class Vector3 implements Iterable<number> {
     /**
      * Dot product
      * @param {Vector3|Vector4} a
@@ -36,7 +46,6 @@ export class Vector3 {
      * @param {number} [x=0]
      * @param {number} [y=0]
      * @param {number} [z=0]
-     * @constructor
      */
     constructor(x?: number, y?: number, z?: number);
     /**
@@ -58,6 +67,7 @@ export class Vector3 {
      */
     readonly z: number;
     /**
+     * Dispatches ( x, y, z, old_x, old_y, old_z )
      * @readonly
      * @type {Signal<number,number,number,number,number,number>}
      */

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

@@ -1 +1 @@
-{"version":3,"file":"Vector3.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector3.js"],"names":[],"mappings":"AAeA;;;;GAIG;AACH;IA6+BI;;;;;OAKG;IACH,cAJW,OAAO,GAAC,OAAO,KACf,OAAO,GAAC,OAAO,GACb,MAAM,CAIlB;IAED;;;;;OAKG;IACH,mBAJW,OAAO,KACP,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,EAAE,WACR,MAAM,GACJ,OAAO,CAQnB;IAED;;;;OAIG;IACH,yBAHW,MAAM,GACJ,OAAO,CAInB;IArhCD;;;;;;OAMG;IACH,gBALW,MAAM,MACN,MAAM,MACN,MAAM,EAuChB;IA1BG;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAE9B;IA2BjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IA0BD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IA0BD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAsCD;;;;;OAKG;IACH,iBAJW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,GACJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,gBAJW,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,GACJ,MAAM,EAAE,CAQpB;IAED;;;;;;OAMG;IACH,OALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAgChB;IAED;;;;OAIG;IACH,aAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,QALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAGD;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,QALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;OAMG;IACH,aALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,mBAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;;;OAMG;IACH,WALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,IAAI,CAOhB;IAED;;;OAGG;IACH,UAFa,OAAO,CAOnB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,oBAJW,OAAO,UACP,OAAO,GACL,IAAI,CAWhB;IAED;;;;;;;;;OASG;IACH,kBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;OAGG;IACH,OAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,OAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAahB;IAED;;;OAGG;IACH,6BAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,YAHW,OAAO,GAAC;QAAC,CAAC,EAAC,MAAM,CAAC;QAAA,CAAC,EAAC,MAAM,CAAC;QAAA,CAAC,EAAC,MAAM,CAAA;KAAC,GAClC,IAAI,CAIhB;IAGD;;;OAGG;IACH,UAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;;OAMG;IACH,eALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,MAAM,CAOjB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,MAAM,CAMlB;IAED;;;;;;OAMG;IACH,kBALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,MAAM,CAQjB;IAED;;;;OAIG;IACH,eAHW,OAAO,GACL,MAAM,CAOlB;IAED;;;;OAIG;IACH,mBAHW,UAAU,GACR,IAAI,CA4BhB;IAED;;;;OAIG;IACH,QAFa,IAAI,CAQhB;IAED;;;;;OAKG;IACH,YAJW,OAAO,YACP,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,eALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,aAJW,OAAO,YACP,MAAM,GACL,IAAI,CAIf;IAED;;;;;;OAMG;IACH,gBALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAKhB;IAGD;;;;OAIG;IACH,iBAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAchB;IAED;;;;;OAKG;IACH,0BAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAoBhB;IAED;;;;OAIG;IACH,kBAHW,MAAM,EAAE,GAAC,YAAY,GACnB,IAAI,CAYhB;IAGD;;;;OAIG;IACH,+BAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAShB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAInB;IAED;;;;;;OAMG;IACH,WALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,OAAO,CAIlB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,cACP,MAAM,GACL,OAAO,CAIlB;IAED;;;;;;;OAOG;IACH,kBANW,MAAM,KACN,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CAMlB;IAED;;OAEG;IACH,SAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,0BAHW,OAAO,GACL,IAAI,CAYhB;IAED;;;;;;;;;OASG;IACH,oBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAkBhB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,OACN,MAAM,SACN,MAAM,GACJ,IAAI,CAuBhB;IAED;;;;;OAKG;IACH,uCAHW,GAAC,GACC,OAAO,CASnB;IAED;;;;MAMC;IAED;;;OAGG;IACH,eAFW;QAAC,CAAC,EAAC,MAAM,CAAC;QAAC,CAAC,EAAC,MAAM,CAAC;QAAC,CAAC,EAAC,MAAM,CAAA;KAAC,GAAC,MAAM,QAS/C;IAED,mBAEC;IAED;;;;OAIG;IACH,uBAHW,YAAY,QAOtB;IAED;;;;OAIG;IACH,yBAHW,YAAY,QAStB;IAED;;;;OAIG;IACH,8BAHW,YAAY,QAOtB;IAED;;;;OAIG;IACH,gCAHW,YAAY,QAStB;IAED,eAMC;IAgDL,2BA7de,OAAO,KACL,MAAM,CA4dY;IAEnC,gBA/iBiB,MAAM,CA+iBG;IAC1B;;;OAGG;IACH,gCAt7Be,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,aAq7BU;IAC/B;;;OAGG;IACH,gCA96Be,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,KACJ,MAAM,EAAE,CA46BK;IAC9B;;;OAGG;IACH,2BAn7Be,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,KACJ,MAAM,EAAE,CAi7BA;IA2DzB;;;OAGG;IACH,oBAFU,OAAO,CAEU;IA7gCvB;;;OAGG;IACH,qBAFY,SAAS,CAAC,MAAM,CAAC,CAQ5B;CA+6BJ;;cA0BS,OAAO;aAOP,OAAO;mBAOP,OAAO;YAMP,OAAO;cAMP,OAAO;cAMP,OAAO;eAMP,OAAO;iBAMP,OAAO;cAMP,OAAO;kBAYP,MAAM;;;mBAloCG,4BAA4B"}
+{"version":3,"file":"Vector3.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector3.js"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;GAcG;AACH,gCALe,QAAQ,CAAC,MAAM;IAk/B1B;;;;;OAKG;IACH,cAJW,OAAO,GAAC,OAAO,KACf,OAAO,GAAC,OAAO,GACb,MAAM,CAIlB;IAED;;;;;OAKG;IACH,mBAJW,OAAO,KACP,OAAO,GACL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,EAAE,WACR,MAAM,GACJ,OAAO,CAQnB;IAED;;;;OAIG;IACH,yBAHW,MAAM,GACJ,OAAO,CAInB;IArhCD;;;;;OAKG;IACH,gBAJW,MAAM,MACN,MAAM,MACN,MAAM,EAuChB;IA3BG;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,YAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAE9B;IA2BjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IA0BD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IA0BD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IA9BD;;;OAGG;IACH,SAFY,MAAM,CAIjB;IAsCD;;;;;OAKG;IACH,iBAJW,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,GACJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,gBAJW,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,GACJ,MAAM,EAAE,CAQpB;IAED;;;;;;OAMG;IACH,OALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAgChB;IAED;;;;OAIG;IACH,aAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,QAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,SAJW,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,QALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAGD;;;;;OAKG;IACH,cAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,QALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;OAMG;IACH,aALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,mBAJW,OAAO,KACP,OAAO,GACL,IAAI,CAQhB;IAED;;;;;;OAMG;IACH,WALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,IAAI,CAIhB;IAED;;;OAGG;IACH,SAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,oBAHW,MAAM,GACJ,IAAI,CAOhB;IAED;;;OAGG;IACH,UAFa,OAAO,CAOnB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,IAAI,CAIhB;IAED;;;;;OAKG;IACH,oBAJW,OAAO,UACP,OAAO,GACL,IAAI,CAWhB;IAED;;;;;;;;;OASG;IACH,kBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;OAGG;IACH,OAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,OAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,aAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAFa,IAAI,CAahB;IAED;;;OAGG;IACH,6BAHW,MAAM,GACL,OAAO,CAMlB;IAED;;;;OAIG;IACH,YAHW,OAAO,GAAC;QAAC,CAAC,EAAC,MAAM,CAAC;QAAA,CAAC,EAAC,MAAM,CAAC;QAAA,CAAC,EAAC,MAAM,CAAA;KAAC,GAClC,IAAI,CAIhB;IAGD;;;OAGG;IACH,UAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,kBAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;;;OAMG;IACH,eALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,MAAM,CAOjB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,MAAM,CAMlB;IAED;;;;;;OAMG;IACH,kBALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,MAAM,CAQjB;IAED;;;;OAIG;IACH,eAHW,OAAO,GACL,MAAM,CAOlB;IAED;;;;OAIG;IACH,mBAHW,UAAU,GACR,IAAI,CA4BhB;IAED;;;;OAIG;IACH,QAFa,IAAI,CAQhB;IAED;;;;;OAKG;IACH,YAJW,OAAO,YACP,MAAM,GACJ,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,eALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAMhB;IAED;;;;;OAKG;IACH,aAJW,OAAO,YACP,MAAM,GACL,IAAI,CAIf;IAED;;;;;;OAMG;IACH,gBALW,OAAO,KACP,OAAO,YACP,MAAM,GACJ,IAAI,CAKhB;IAGD;;;;OAIG;IACH,iBAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAchB;IAED;;;;;OAKG;IACH,0BAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAoBhB;IAED;;;;OAIG;IACH,kBAHW,MAAM,EAAE,GAAC,YAAY,GACnB,IAAI,CAYhB;IAGD;;;;OAIG;IACH,+BAHW,SAAS,CAAC,MAAM,CAAC,GAAC,MAAM,EAAE,GAAC,YAAY,GACrC,IAAI,CAShB;IAED;;;;OAIG;IACH,cAHW,OAAO,GACL,OAAO,CAInB;IAED;;;;;;OAMG;IACH,WALW,MAAM,KACN,MAAM,KACN,MAAM,GACL,OAAO,CAIlB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,cACP,MAAM,GACL,OAAO,CAIlB;IAED;;;;;;;OAOG;IACH,kBANW,MAAM,KACN,MAAM,KACN,MAAM,cACN,MAAM,GACL,OAAO,CAMlB;IAED;;OAEG;IACH,SAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,0BAHW,OAAO,GACL,IAAI,CAYhB;IAED;;;;;;;;;OASG;IACH,oBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAkBhB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,OACN,MAAM,SACN,MAAM,GACJ,IAAI,CAuBhB;IAED;;;;;OAKG;IACH,uCAHW,GAAC,GACC,OAAO,CASnB;IAED;;;;MAMC;IAED;;;OAGG;IACH,eAFW;QAAC,CAAC,EAAC,MAAM,CAAC;QAAC,CAAC,EAAC,MAAM,CAAC;QAAC,CAAC,EAAC,MAAM,CAAA;KAAC,GAAC,MAAM,QAS/C;IAED,mBAEC;IAED;;;;OAIG;IACH,uBAHW,YAAY,QAOtB;IAED;;;;OAIG;IACH,yBAHW,YAAY,QAStB;IAED;;;;OAIG;IACH,8BAHW,YAAY,QAOtB;IAED;;;;OAIG;IACH,gCAHW,YAAY,QAStB;IAED,eAMC;IAgDL,2BA7de,OAAO,KACL,MAAM,CA4dY;IAEnC,gBA/iBiB,MAAM,CA+iBG;IAC1B;;;OAGG;IACH,gCAt7Be,MAAM,EAAE,GAAC,YAAY,WACrB,MAAM,aAq7BU;IAC/B;;;OAGG;IACH,gCA96Be,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,KACJ,MAAM,EAAE,CA46BK;IAC9B;;;OAGG;IACH,2BAn7Be,MAAM,EAAE,GAAC,YAAY,iBAAU,WAC/B,MAAM,KACJ,MAAM,EAAE,CAi7BA;IA2DzB;;;OAGG;IACH,oBAFU,OAAO,CAEU;IA7gCvB;;;OAGG;IACH,qBAFY,SAAS,CAAC,MAAM,CAAC,CAQ5B;CA+6BJ;;cA0BS,OAAO;aAOP,OAAO;mBAOP,OAAO;YAMP,OAAO;cAMP,OAAO;cAMP,OAAO;eAMP,OAAO;iBAMP,OAAO;cAMP,OAAO;kBAYP,MAAM;;;mBA5oCG,4BAA4B"}

package/src/core/geom/Vector3.js

@@ -14,6 +14,16 @@ import { v3_slerp } from "./vec3/v3_slerp.js";
 
 
 /**
+ * Class representing a 3D vector. A 3D vector is an ordered triplet of numbers (labeled x, y, and z), which can be used to represent a number of things, such as:
+ *
+ * A point in 3D space.
+ * A direction and length in 3D space. The length will always be the Euclidean distance (straight-line distance) from `(0, 0, 0)` to `(x, y, z)` and the direction is also measured from `(0, 0, 0)` towards `(x, y, z)`.
+ * Any arbitrary ordered triplet of numbers.
+ * There are other things a 3D vector can be used to represent, such as momentum vectors and so on, however these are the most common uses.
+ *
+ * Iterating through a Vector3 instance will yield its components `(x, y, z)` in the corresponding order.
+ *
+ * @implements Iterable<number>
  *
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
@@ -24,7 +34,6 @@ export class Vector3 {
      * @param {number} [x=0]
      * @param {number} [y=0]
      * @param {number} [z=0]
-     * @constructor
      */
     constructor(x = 0, y = 0, z = 0) {
         assert.isNumber(x, 'x');
@@ -58,6 +67,7 @@ export class Vector3 {
         this.z = z;
 
         /**
+         * Dispatches ( x, y, z, old_x, old_y, old_z )
          * @readonly
          * @type {Signal<number,number,number,number,number,number>}
          */

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

@@ -1,4 +1,16 @@
-export class Vector4 {
+/**
+ * Class representing a 4D vector. A 4D vector is an ordered quadruplet of numbers (labeled x, y, z, and w), which can be used to represent a number of things, such as:
+ *
+ * A point in 4D space.
+ * A direction and length in 4D space. The length will always be the Euclidean distance (straight-line distance) from `(0, 0, 0, 0)` to `(x, y, z, w)` and the direction is also measured from `(0, 0, 0, 0)` towards `(x, y, z, w)`.
+ * Any arbitrary ordered quadruplet of numbers.
+ * There are other things a 4D vector can be used to represent, however these are the most common uses.
+ *
+ * Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.
+ *
+ * @implements Iterable<number>
+ */
+export class Vector4 implements Iterable<number> {
     /**
      *
      * @param {Vector4} v0
@@ -149,11 +161,17 @@ export class Vector4 {
      */
     add3(v3: Vector3 | Vector4): Vector4;
     /**
-     *
+     * @deprecated use {@link applyMatrix4} directly instead
      * @param {Matrix4} m
      * @returns {Vector4} this
      */
     threeApplyMatrix4(m: Matrix4): Vector4;
+    /**
+     *
+     * @param {number[]|Float32Array} m 4x4 transformation matrix
+     * @return {Vector4}
+     */
+    applyMatrix4(m: number[] | Float32Array): Vector4;
     /**
      *
      * @param {Vector4} vec4

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;IAsbI;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IAncD;;;;;;;;OAQG;IACH,gBAPW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAsChB;IA3BG;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAE5C;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;IAuGL,kBAnGe,MAAM,EAAE,UAmGE;IA1FrB;;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;IA4BL;;;OAGG;IACH,oBAFU,OAAO,CAEU;IAE3B,mBA7Ve,MAAM,EAAE,WACR,MAAM,UA4VM;IAhCvB,sDAOC;CAiBJ;;kBAaS,MAAM"}
+{"version":3,"file":"Vector4.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector4.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AACH,gCAFe,QAAQ,CAAC,MAAM;IAgc1B;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IA3cD;;;;;;;;OAQG;IACH,gBAPW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAsChB;IA3BG;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IACV;;;OAGG;IACH,GAFU,MAAM,CAEN;IAEV;;;;OAIG;IACH,oBAFU,MAAM,CAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,EAAC,MAAM,CAAC,CAE5C;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,CAInB;IAED;;;;OAIG;IACH,gBAHW,MAAM,EAAE,GAAC,YAAY,GACpB,OAAO,CASlB;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;IAuGL,kBAnGe,MAAM,EAAE,UAmGE;IA1FrB;;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;IA4BL;;;OAGG;IACH,oBAFU,OAAO,CAEU;IAE3B,mBArWe,MAAM,EAAE,WACR,MAAM,UAoWM;IAhCvB,sDAOC;CAiBJ;;kBAaS,MAAM"}

package/src/core/geom/Vector4.js

@@ -4,6 +4,18 @@ import { Signal } from "../events/signal/Signal.js";
 import { lerp } from "../math/lerp.js";
 import { computeHashFloat } from "../primitives/numbers/computeHashFloat.js";
 
+/**
+ * Class representing a 4D vector. A 4D vector is an ordered quadruplet of numbers (labeled x, y, z, and w), which can be used to represent a number of things, such as:
+ *
+ * A point in 4D space.
+ * A direction and length in 4D space. The length will always be the Euclidean distance (straight-line distance) from `(0, 0, 0, 0)` to `(x, y, z, w)` and the direction is also measured from `(0, 0, 0, 0)` towards `(x, y, z, w)`.
+ * Any arbitrary ordered quadruplet of numbers.
+ * There are other things a 4D vector can be used to represent, however these are the most common uses.
+ *
+ * Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.
+ *
+ * @implements Iterable<number>
+ */
 export class Vector4 {
     /**
      *
@@ -270,17 +282,25 @@ export class Vector4 {
     }
 
     /**
-     *
+     * @deprecated use {@link applyMatrix4} directly instead
      * @param {Matrix4} m
      * @returns {Vector4} this
      */
     threeApplyMatrix4(m) {
-        const e = m.elements;
+        return this.applyMatrix4(m.elements);
+    }
+
+    /**
+     *
+     * @param {number[]|Float32Array} m 4x4 transformation matrix
+     * @return {Vector4}
+     */
+    applyMatrix4(m) {
         return this._applyMatrix4(
-            e[0], e[1], e[2], e[3],
-            e[4], e[5], e[6], e[7],
-            e[8], e[9], e[10], e[11],
-            e[12], e[13], e[14], e[15]
+            m[0], m[1], m[2], m[3],
+            m[4], m[5], m[6], m[7],
+            m[8], m[9], m[10], m[11],
+            m[12], m[13], m[14], m[15]
         );
     }
 

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;
+}