@woosh/meep-engine 2.126.54 → 2.126.57

package/src/core/geom/3d/morton/v3_morton_encode_transformed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"v3_morton_encode_transformed.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/morton/v3_morton_encode_transformed.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,gDANW,MAAM,KACN,MAAM,KACN,MAAM,UACN,MAAM,EAAE,GACN,MAAM,CA2BlB"}
+{"version":3,"file":"v3_morton_encode_transformed.d.ts","sourceRoot":"","sources":["../../../../../../src/core/geom/3d/morton/v3_morton_encode_transformed.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,gDANW,MAAM,KACN,MAAM,KACN,MAAM,UACN,MAAM,EAAE,GACN,MAAM,CAqBlB"}

package/src/core/geom/3d/morton/v3_morton_encode_transformed.js

@@ -1,5 +1,5 @@
-import { clamp } from "../../../math/clamp.js";
-import v3_morton_encode from "./v3_morton_encode.js";
+import { clamp01 } from "../../../math/clamp01.js";
+import { v3_morton_encode_normalized } from "./v3_morton_encode_normalized.js";
 
 /**
  * Assumes that coordinates will be mapped to -1..1 range after transform
@@ -17,22 +17,16 @@ export function v3_morton_encode_transformed(x, y, z, matrix) {
     const _z = matrix[2] * x + matrix[6] * y + matrix[10] * z + matrix[14];
     const _w = matrix[3] * x + matrix[7] * y + matrix[11] * z + matrix[15];
 
-    const d = 511.5 / _w;
+    const d = 0.5 / _w;
 
-    // apply perspective divide as well as scaling to 10 bits
-    const ndc_x = _x * d;
-    const ndc_y = _y * d;
-    const ndc_z = _z * d;
+    const n_x = clamp01(_x * d + 0.5);
+    const n_y = clamp01(_y * d + 0.5);
+    const n_z = clamp01(_z * d + 0.5);
 
-    // Normalize values (0,1023) and clamp to prevent wrapping
-    const px = clamp(ndc_x + 511.5, 0, 1023);
-    const py = clamp(ndc_y + 511.5, 0, 1023);
-    const pz = clamp(ndc_z + 511.5, 0, 1023);
-
-    return v3_morton_encode(
-        Math.round(px),
-        Math.round(py),
-        Math.round(pz)
+    return v3_morton_encode_normalized(
+        n_x,
+        n_y,
+        n_z
     );
 }
 

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

@@ -3,7 +3,7 @@
  * Represents rotation in 3d space
  *
  * Iterating through a Quaternion instance will yield its components `(x, y, z, w)` in the corresponding order.
- *
+ * Note that a quaternion must be {@link normalize}d to properly represent rotation. Check documentation of individual operations when in doubt.
  * @see https://en.wikipedia.org/wiki/Quaternion
  * @implements Iterable<number>
  *
@@ -120,7 +120,8 @@ export class Quaternion implements Iterable<number> {
     get 3(): number;
     /**
      * Orient quaternion on a `forward` vector, with the spin matching `up` vector
-     * Useful for `lookAt` operations, such as for camera or inverse kinematics
+     * Useful for `lookAt` operations, such as for camera or inverse kinematics.
+     * Normalizes input, meaning input does not have to be normalized.
      * @param {number} fx forward vector
      * @param {number} fy forward vector
      * @param {number} fz forward vector
@@ -131,11 +132,12 @@ export class Quaternion implements Iterable<number> {
      */
     _lookRotation(fx: number, fy: number, fz: number, ux: number, uy: number, uz: number): this;
     /**
-     * Orient quaternion to align with the `forward` drection.
-     * @param {Vector3} forward
-     * @param {Vector3} [up=Vector3.up]
+     * Orient quaternion to align with the `forward` direction.
+     * @param {Vector3} forward Does not need to be normalized.
+     * @param {Vector3} [up=Vector3.up] Does not need to be normalized.
+     * @returns {this}
      */
-    lookRotation(forward: Vector3, up?: Vector3): void;
+    lookRotation(forward: Vector3, up?: Vector3): this;
     /**
      * Vector dot product in 4 dimensions
      * @param {Quaternion} other
@@ -145,8 +147,9 @@ export class Quaternion implements Iterable<number> {
     /**
      * Makes this quaternion into an inverse of the other
      * @param {Quaternion} other
+     * @returns {this}
      */
-    copyInverse(other: Quaternion): void;
+    copyInverse(other: Quaternion): this;
     /**
      * Calculates the inverse
      * @returns {this}
@@ -162,16 +165,18 @@ export class Quaternion implements Iterable<number> {
      * Set quaternion from axis + angle definition
      * @param {Vector3} axis
      * @param {number} angle
+     * @returns {this}
      */
-    fromAxisAngle(axis: Vector3, angle: number): void;
+    fromAxisAngle(axis: Vector3, angle: number): this;
     /**
      *
      * @param {number} axis_x
      * @param {number} axis_y
      * @param {number} axis_z
      * @param {number} angle
+     * @returns {this}
      */
-    _fromAxisAngle(axis_x: number, axis_y: number, axis_z: number, angle: number): void;
+    _fromAxisAngle(axis_x: number, axis_y: number, axis_z: number, angle: number): this;
     /**
      * 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.
@@ -189,11 +194,11 @@ export class Quaternion implements Iterable<number> {
      */
     computeTwistAngle(axis: Vector3): number;
     /**
-     *
-     * @param {Vector3} axis
+     * Decompose quaternion to the axis of rotation and angle around this axis.
+     * @param {Vector3} out_axis axis will be written here
      * @returns {number} angle in radians
      */
-    toAxisAngle(axis: Vector3): number;
+    toAxisAngle(out_axis: Vector3): number;
     /**
      *
      * @returns {this}
@@ -261,9 +266,15 @@ export class Quaternion implements Iterable<number> {
      * @param {number} y
      * @param {number} z
      * @param {String} [order='XYZ'] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
-     * @returns {Quaternion}
+     * @returns {this}
+     * @see fromEulerAnglesXYZ
+     * @see fromEulerAnglesYXZ
+     * @see fromEulerAnglesZXY
+     * @see fromEulerAnglesZYX
+     * @see fromEulerAnglesYZX
+     * @see fromEulerAnglesXZY
      */
-    __setFromEuler(x: number, y: number, z: number, order?: string): Quaternion;
+    __setFromEuler(x: number, y: number, z: number, order?: string): this;
     /**
      * @see https://localcoder.org/euler-angle-to-quaternion-then-quaternion-to-euler-angle
      * @see https://discourse.mcneel.com/t/what-is-the-right-method-to-convert-quaternion-to-plane-using-rhinocommon/92411/21?page=2
@@ -349,18 +360,18 @@ export class Quaternion implements Iterable<number> {
     /**
      * NOTE: Vectors need to be normalized
      *
-     * @param {Vector3} from
-     * @param {Vector3} to
+     * @param {Vector3} from Must be normalized
+     * @param {Vector3} to Must be normalized
      * @returns {this}
      */
     fromUnitVectors(from: Vector3, to: Vector3): this;
     /**
-     * @param {number[]} m4x4
+     * @param {number[]|Float32Array} m4x4
      * @returns {this}
      */
-    setFromRotationMatrix(m4x4: number[]): this;
+    setFromRotationMatrix(m4x4: number[] | Float32Array): this;
     /**
-     * This algorithm comes from  "Quaternion Calculus and Fast Animation",
+     * This algorithm comes from "Quaternion Calculus and Fast Animation",
      * Ken Shoemake, 1987 SIGGRAPH course notes
      * @see https://gitlab.com/libeigen/eigen/-/blob/master/Eigen/src/Geometry/Quaternion.h#L813
      * @param {number} m11
@@ -395,7 +406,7 @@ export class Quaternion implements Iterable<number> {
      * Spherical linear interpolation
      * @param {Quaternion} from
      * @param {Quaternion} to
-     * @param {number} t coefficient, how much between the input quats?
+     * @param {number} t coefficient, how much between the input quaternions? Must be a value between 0 and 1
      * @returns {this}
      */
     slerpQuaternions(from: Quaternion, to: Quaternion, t: number): this;

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":"AAoBA;;;;;;;;;;;GAWG;AACH,mCALe,QAAQ,CAAC,MAAM;IA4R1B;;;;;OAKG;IACH,2BAJW,OAAO,SACP,MAAM,GACJ,UAAU,CAQtB;IAspCD;;;;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,QA0BhB;IAp/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;;;;;;OAMG;IACH,eALW,OAAO,UACP,OAAO,OACP,OAAO,QAWjB;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;IAiEL,mBApLe,MAAM,EAAE,WACR,MAAM,gBAmLS;IAC9B,kBAtKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAoKG;IAC5B,kBAvKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAqKG;IAC5B,qBA3yBe,MAAM,KACN,MAAM,KACN,MAAM,gBAyyBe;IAQpC;;;;OAIG;IACH,uBAFU,OAAO,CAEgB;IAx5C7B;;;OAGG;IACH,qBAFa,SAAS,CAAC,MAAM,CAAC,CAS7B;CA23CJ;;kBASS,UAAU;kBAaV,MAAM;;;mBA3iDG,4BAA4B;oBAU3B,cAAc"}
+{"version":3,"file":"Quaternion.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Quaternion.js"],"names":[],"mappings":"AAoBA;;;;;;;;;;;GAWG;AACH,mCALe,QAAQ,CAAC,MAAM;IA+R1B;;;;;OAKG;IACH,2BAJW,OAAO,SACP,MAAM,GACJ,UAAU,CAQtB;IAiqCD;;;;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,QA0BhB;IAlgDD;;;;;;;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;;;;;;;;;;;OAWG;IACH,kBARW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,IAAI,CAqDhB;IAED;;;;;OAKG;IACH,sBAJW,OAAO,OACP,OAAO,GACL,IAAI,CAShB;IAED;;;;OAIG;IACH,WAHW,UAAU,GACT,MAAM,CAQjB;IAED;;;;OAIG;IACH,mBAHW,UAAU,GACR,IAAI,CAKhB;IAED;;;OAGG;IACH,UAFa,IAAI,CAuBhB;IAED;;;;OAIG;IACH,eAHW,UAAU,GACT,MAAM,CAoBjB;IAiBD;;;;;OAKG;IACH,oBAJW,OAAO,SACP,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;OAOG;IACH,uBANW,MAAM,UACN,MAAM,UACN,MAAM,SACN,MAAM,GACJ,IAAI,CAkChB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,SACP,UAAU,SACV,UAAU,GACR,IAAI,CAyChB;IAED;;;;OAIG;IACH,wBAHW,OAAO,GACL,MAAM,CAYlB;IAED;;;;OAIG;IACH,sBAHW,OAAO,GACL,MAAM,CAmBlB;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;;;;;;OAMG;IACH,eALW,OAAO,UACP,OAAO,OACP,OAAO,QAWjB;IAED;;;OAGG;IACH,kBAFW,MAAW,MAAM,QAI3B;IAED;;;;;;;;;;;;;OAaG;IACH,kBAZW,MAAM,KACN,MAAM,KACN,MAAM,mBAEJ,IAAI,CA8ChB;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,GAAC,YAAY,GACnB,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;IAiEL,mBApLe,MAAM,EAAE,WACR,MAAM,gBAmLS;IAC9B,kBAtKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAoKG;IAC5B,kBAvKe,MAAM,EAAE,WACR,MAAM,KACJ,MAAM,EAAE,CAqKG;IAC5B,qBA3yBe,MAAM,KACN,MAAM,KACN,MAAM,gBAyyBe;IAQpC;;;;OAIG;IACH,uBAFU,OAAO,CAEgB;IAt6C7B;;;OAGG;IACH,qBAFa,SAAS,CAAC,MAAM,CAAC,CAS7B;CAy4CJ;;kBASS,UAAU;kBAaV,MAAM;;;mBAzjDG,4BAA4B;oBAU3B,cAAc"}

package/src/core/geom/Quaternion.js

@@ -23,7 +23,7 @@ const cos = Math.cos;
  * Represents rotation in 3d space
  *
  * Iterating through a Quaternion instance will yield its components `(x, y, z, w)` in the corresponding order.
- *
+ * Note that a quaternion must be {@link normalize}d to properly represent rotation. Check documentation of individual operations when in doubt.
  * @see https://en.wikipedia.org/wiki/Quaternion
  * @implements Iterable<number>
  *
@@ -158,7 +158,8 @@ export class Quaternion {
 
     /**
      * Orient quaternion on a `forward` vector, with the spin matching `up` vector
-     * Useful for `lookAt` operations, such as for camera or inverse kinematics
+     * Useful for `lookAt` operations, such as for camera or inverse kinematics.
+     * Normalizes input, meaning input does not have to be normalized.
      * @param {number} fx forward vector
      * @param {number} fy forward vector
      * @param {number} fz forward vector
@@ -221,13 +222,14 @@ export class Quaternion {
     }
 
     /**
-     * Orient quaternion to align with the `forward` drection.
-     * @param {Vector3} forward
-     * @param {Vector3} [up=Vector3.up]
+     * Orient quaternion to align with the `forward` direction.
+     * @param {Vector3} forward Does not need to be normalized.
+     * @param {Vector3} [up=Vector3.up] Does not need to be normalized.
+     * @returns {this}
      */
     lookRotation(forward, up = Vector3.up) {
 
-        this._lookRotation(
+        return this._lookRotation(
             forward.x, forward.y, forward.z,
             up.x, up.y, up.z
         );
@@ -250,10 +252,11 @@ export class Quaternion {
     /**
      * Makes this quaternion into an inverse of the other
      * @param {Quaternion} other
+     * @returns {this}
      */
     copyInverse(other) {
         this.copy(other);
-        this.invert();
+        return this.invert();
     }
 
     /**
@@ -327,11 +330,14 @@ export class Quaternion {
      * Set quaternion from axis + angle definition
      * @param {Vector3} axis
      * @param {number} angle
+     * @returns {this}
      */
     fromAxisAngle(axis, angle) {
         assert.defined(axis, 'axis');
+        assert.isObject(axis, 'axis');
+        assert.isNumber(angle, 'angle');
 
-        this._fromAxisAngle(axis.x, axis.y, axis.z, angle);
+        return this._fromAxisAngle(axis.x, axis.y, axis.z, angle);
     }
 
     /**
@@ -340,6 +346,7 @@ export class Quaternion {
      * @param {number} axis_y
      * @param {number} axis_z
      * @param {number} angle
+     * @returns {this}
      */
     _fromAxisAngle(axis_x, axis_y, axis_z, angle) {
         assert.isNumber(axis_x, 'axis_x');
@@ -372,7 +379,7 @@ export class Quaternion {
         const z = qz * m;
         const w = qw * m;
 
-        this.set(x, y, z, w);
+        return this.set(x, y, z, w);
     }
 
     /**
@@ -442,25 +449,26 @@ export class Quaternion {
     }
 
     /**
-     *
-     * @param {Vector3} axis
+     * Decompose quaternion to the axis of rotation and angle around this axis.
+     * @param {Vector3} out_axis axis will be written here
      * @returns {number} angle in radians
      */
-    toAxisAngle(axis) {
+    toAxisAngle(out_axis) {
         const rad = Math.acos(this.w) * 2.0;
 
         const s = sin(rad * 0.5);
 
         if (Math.abs(s) > EPSILON) {
-            axis.set(
+            out_axis.set(
                 this.x / s,
                 this.y / s,
                 this.z / s
             );
         } else {
             // If s is zero, return any axis (no rotation - axis does not matter)
-            axis.set(1, 0, 0);
+            out_axis.set(1, 0, 0);
         }
+
         return rad;
     }
 
@@ -608,7 +616,13 @@ export class Quaternion {
      * @param {number} y
      * @param {number} z
      * @param {String} [order='XYZ'] a combination of capital letters X,Y,Z. Examples: XYZ, YXZ
-     * @returns {Quaternion}
+     * @returns {this}
+     * @see fromEulerAnglesXYZ
+     * @see fromEulerAnglesYXZ
+     * @see fromEulerAnglesZXY
+     * @see fromEulerAnglesZYX
+     * @see fromEulerAnglesYZX
+     * @see fromEulerAnglesXZY
      */
     __setFromEuler(
         x,
@@ -934,12 +948,12 @@ export class Quaternion {
     /**
      * NOTE: Vectors need to be normalized
      *
-     * @param {Vector3} from
-     * @param {Vector3} to
+     * @param {Vector3} from Must be normalized
+     * @param {Vector3} to Must be normalized
      * @returns {this}
      */
     fromUnitVectors(from, to) {
-        // Based on blog post: http://lolengine.net/blog/2013/09/18/beautiful-maths-quaternion-from-vectors
+        // Based on this blog post: http://lolengine.net/blog/2013/09/18/beautiful-maths-quaternion-from-vectors
 
         assert.ok(from.isNormalized(), `from vector is not normalized, length = ${from.length()}`);
         assert.ok(to.isNormalized(), `to vector is not normalized, length = ${to.length()}`);
@@ -1005,7 +1019,7 @@ export class Quaternion {
     }
 
     /**
-     * @param {number[]} m4x4
+     * @param {number[]|Float32Array} m4x4
      * @returns {this}
      */
     setFromRotationMatrix(m4x4) {
@@ -1021,7 +1035,7 @@ export class Quaternion {
     }
 
     /**
-     * This algorithm comes from  "Quaternion Calculus and Fast Animation",
+     * This algorithm comes from "Quaternion Calculus and Fast Animation",
      * Ken Shoemake, 1987 SIGGRAPH course notes
      * @see https://gitlab.com/libeigen/eigen/-/blob/master/Eigen/src/Geometry/Quaternion.h#L813
      * @param {number} m11
@@ -1151,7 +1165,7 @@ export class Quaternion {
      * Spherical linear interpolation
      * @param {Quaternion} from
      * @param {Quaternion} to
-     * @param {number} t coefficient, how much between the input quats?
+     * @param {number} t coefficient, how much between the input quaternions? Must be a value between 0 and 1
      * @returns {this}
      */
     slerpQuaternions(from, to, t) {

package/src/engine/ecs/Entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/Entity.js"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;IAsaI;;;;;;;;;;;OAWG;IACH,+BAJW,MAAM,WACN,sBAAsB,GACpB,MAAM,CAqBlB;IAncD;;;;;OAKG;IACH,oBAFU,eAAe,CAES;IAGlC;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,2BAAgB;IAQhB;;;;OAIG;IACH,SAFU,sBAAsB,CAEjB;IAEf;;;OAGG;IACH,OAFU,WAAW,GAAC,MAAM,CAEN;IAEtB;;;;OAIG;IACH,yBAAgB;IAEhB;;OAEG;IACH;QACI;;WAEG;;MAEL;IAUF;;;OAGG;IACH,eAFW,MAAM,GAAC,WAAW,QAI5B;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,WAAW,GAChB,OAAO,CAMnB;IAED;;;OAGG;IACH,gBAFW,MAAM,GAAC,WAAW,QAI5B;IAED;;;OAGG;IACH,wBAFa,OAAO,CAInB;IAED;;OAEG;IACH,4BAQC;IAED;;;OAGG;IACH,aAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,IAJa,CAAC,qBACH,CAAC,GACC,MAAM,CAsBlB;IAED;;;;OAIG;IACH,aAJa,CAAC,SACH,CAAC,GACC,OAAO,CAInB;IAED;;;;OAIG;IACH,aAJa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,IAAI,CAclB;IAED;;;;;OAKG;IACH,iBAJa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,CAUb;IAED;;;;OAIG;IACH,kCAFa,GAAC,GAAC,IAAI,CA0BlB;IAED;;;;OAIG;IACH,qBAHW,MAAM,UACN,GAAC,QAQX;IAED;;;OAGG;IACH,wBAFW,MAAM,gBAiBhB;IAED;;;;;;OAMG;IACH,4BALW,MAAM,gCAEN,GAAC,GACC,MAAM,CAalB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,gCAEN,GAAC,GACC,MAAM,CAyBlB;IAED;;;OAGG;IACH,WAFa,OAAO,CAwBnB;IAED;;;;;;;;;;;;OAYG;IACH,eAFW,sBAAsB,GADpB,MAAM,CA4DlB;IAoCL;;;;OAIG;IACH,mBAFU,OAAO,CAEQ;;CAPxB;;gCA9e+B,sBAAsB;4BAD1B,kBAAkB;mBAF3B,oCAAoC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/Entity.js"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH;IAsbI;;;;;;;;;;;;OAYG;IACH,+BAJW,MAAM,WACN,sBAAsB,GACpB,MAAM,CAqBlB;IApdD;;;;;OAKG;IACH,oBAFU,eAAe,CAES;IAGlC;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,2BAAgB;IAShB;;;;;;OAMG;IACH,SAJU,sBAAsB,CAIjB;IAEf;;;OAGG;IACH,OAFU,WAAW,GAAC,MAAM,CAEN;IAEtB;;;;OAIG;IACH,yBAAgB;IAEhB;;OAEG;IACH;QACI;;WAEG;;MAEL;IAUF;;;OAGG;IACH,eAFW,MAAM,GAAC,WAAW,QAI5B;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,WAAW,GAChB,OAAO,CAMnB;IAED;;;OAGG;IACH,gBAFW,MAAM,GAAC,WAAW,QAI5B;IAED;;;;;;;OAOG;IACH,wBALa,OAAO,CAOnB;IAED;;OAEG;IACH,4BAQC;IAED;;;OAGG;IACH,aAFY,MAAM,CAIjB;IAED;;;;;;OAMG;IACH,IAJa,CAAC,sBACH,CAAC,GACC,MAAM,CAsBlB;IAED;;;;;OAKG;IACH,aAJa,CAAC,SACH,CAAC,GACC,OAAO,CAInB;IAED;;;;OAIG;IACH,aAJa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,IAAI,CAclB;IAED;;;;;OAKG;IACH,iBAJa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,CAUb;IAED;;;;OAIG;IACH,kCAFa,GAAC,GAAC,IAAI,CA0BlB;IAED;;;;OAIG;IACH,qBAHW,MAAM,UACN,GAAC,QAQX;IAED;;;OAGG;IACH,wBAFW,MAAM,gBAiBhB;IAED;;;;;;OAMG;IACH,4BALW,MAAM,gCAEN,GAAC,GACC,MAAM,CAalB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,gCAEN,GAAC,GACC,MAAM,CAyBlB;IAED;;;;;;OAMG;IACH,WAJa,OAAO,CA0BnB;IAED;;;;;;;;;;;;;;;OAeG;IACH,eALW,sBAAsB,GADpB,MAAM,CA+DlB;IAqCL;;;;OAIG;IACH,mBAFU,OAAO,CAEQ;;CAPxB;;gCAhgB+B,sBAAsB;4BAD1B,kBAAkB;mBAF3B,oCAAoC"}

package/src/engine/ecs/Entity.js

@@ -39,6 +39,7 @@ const DEFAULT_FLAGS =
  * // ... Once entity is no longer needed, we destroy it
  * entity.destroy();
  *
+ * @see {@link EntityComponentDataset}
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
@@ -46,7 +47,7 @@ export class Entity {
 
     /**
      * Reference to the entity in a dataset. Do not modify directly.
-     * Only valid when the entity is built. Check with {@link isBuilt}.
+     * Only valid when the entity is built, check with {@link isBuilt}.
      * @readonly
      * @type {EntityReference}
      */
@@ -78,6 +79,7 @@ export class Entity {
 
     /**
      * Listeners added before the entity is build live here
+     * @private
      * @type {{name:string,listener:(function|Function), context:*}[]}
      */
     #deferredListeners = [];
@@ -86,17 +88,19 @@ export class Entity {
      * Dataset in which this entity exists, if built. If not built - null.
      * Do not modify directly.
      * @type {EntityComponentDataset}
+     * @see {@link build}
+     * @see {@link destroy}
      */
     dataset = null;
 
     /**
-     *
+     * Do not modify directly unless you understand the consequences of doing so.
      * @type {EntityFlags|number}
      */
     flags = DEFAULT_FLAGS;
 
     /**
-     * Arbitrary user metadata, add anything you want here
+     * Arbitrary user data, add anything you want here.
      * @readonly
      * @type {Object}
      */
@@ -148,8 +152,12 @@ export class Entity {
     }
 
     /**
+     * True is the entity is currently attached to a dataset. When this is `true`, {@link dataset} property will be set as well.
      * @readonly
      * @returns {boolean}
+     * @see {@link build}
+     * @see {@link destroy}
+     *
      */
     get isBuilt() {
         return this.getFlag(EntityFlags.Built);
@@ -177,35 +185,38 @@ export class Entity {
     }
 
     /**
-     * @template T
-     * @param {T} componentInstance
+     * Note that this is live-edit, if the {@link Entity} is built - component will be added to the dataset as well.
+     *
+     * @template T class of the component
+     * @param {T} component_instance
      * @returns {Entity}
      */
-    add(componentInstance) {
-        assert.defined(componentInstance, 'componentInstance');
-        assert.notNull(componentInstance, 'componentInstance');
+    add(component_instance) {
+        assert.defined(component_instance, 'component_instance');
+        assert.notNull(component_instance, 'component_instance');
 
-        assert.notOk(this.hasComponent(Object.getPrototypeOf(componentInstance).constructor), 'Component of this type already exists');
+        assert.notOk(this.hasComponent(Object.getPrototypeOf(component_instance).constructor), 'Component of this type already exists');
 
-        this.components.push(componentInstance);
+        this.components.push(component_instance);
 
         if (this.getFlag(EntityFlags.Built)) {
 
             //already built, add component to entity
 
             if (this.getFlag(EntityFlags.RegisterComponents)) {
-                this.dataset.registerComponentType(componentInstance.constructor)
+                this.dataset.registerComponentType(component_instance.constructor)
             }
 
-            this.dataset.addComponentToEntity(this.reference.id, componentInstance);
+            this.dataset.addComponentToEntity(this.reference.id, component_instance);
         }
 
         return this;
     }
 
     /**
+     * Check if a component of a given type is present on this entity.
      * @template T
-     * @param {T} klass
+     * @param {T} klass type of the component
      * @returns {boolean}
      */
     hasComponent(klass) {
@@ -214,7 +225,7 @@ export class Entity {
 
     /**
      * @template T
-     * @param {Class<T>} klass
+     * @param {Class<T>} klass type of the component
      * @returns {T|null} component of specified class
      */
     getComponent(klass) {
@@ -248,7 +259,7 @@ export class Entity {
     }
 
     /**
-     *
+     * Note that this is live-edit, if the {@link Entity} is built - component will be removed from the dataset as well.
      * @param {function} klass
      * @returns {*|null}
      */
@@ -365,8 +376,11 @@ export class Entity {
     }
 
     /**
-     * Removes built entity from the {@link EntityManager}. Note that the destroyed {@link Entity} can be later re-built.
+     * Removes built entity from the {@link EntityManager}.
+     * Note that the destroyed {@link Entity} can be later re-built.
      * @returns {boolean} true if entity was destroyed, false if entity was not built
+     * @see {@link build}
+     * @see {@link isBuilt}
      */
     destroy() {
         if (!this.getFlag(EntityFlags.Built)) {
@@ -404,6 +418,9 @@ export class Entity {
      *
      * @returns {number} entity ID
      * @param {EntityComponentDataset} dataset
+     * @see {@link destroy}
+     * @see {@link isBuilt}
+     *
      */
     build(dataset) {
         assert.defined(dataset, "dataset");
@@ -466,6 +483,7 @@ export class Entity {
 
     /**
      * Extract data about an entity and its components from a dataset.
+     * Note that this behaves the same way as if you first created the {@link Entity} and then called {@link build} on it, just the other way around.
      *
      * @example
      *  const ecd:EntityComponentDataset = ...;

package/src/engine/ecs/EntityReference.d.ts

@@ -14,6 +14,7 @@
  *  // 4. After you no longer need the entity - destroy the entity via reference.
  *  entityRef.destroy(ecd);
  *
+ * @see {@link EntityComponentDataset}
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
@@ -41,7 +42,7 @@ export class EntityReference {
     /**
      * Entity generation number. This uniquely identifies an entity in combination with the ID
      * Generation of an existing entity must match for it to be considered "the same".
-     * see {@link EntityComponentDataset.getEntityGeneration}
+     * @see {@link EntityComponentDataset.getEntityGeneration}
      * @type {number}
      */
     generation: number;

package/src/engine/ecs/EntityReference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EntityReference.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityReference.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAsHI;;;;;OAKG;IACH,gBAJW,MAAM,cACN,MAAM,GACL,eAAe,CAQ1B;IAED;;;;;OAKG;IACH,iBAJW,sBAAsB,MACtB,MAAM,GACJ,eAAe,CAQ3B;IA9ID;;;;OAIG;IACH,IAFU,MAAM,CAET;IAEP;;;;;OAKG;IACH,YAFU,MAAM,CAED;IAEf;;;OAGG;IACH,YAFW,eAAe,QAKzB;IAED;;;OAGG;IACH,SAFa,eAAe,CAQ3B;IAED;;;OAGG;IACH,QAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,cAHW,eAAe,GACd,OAAO,CAMlB;IAED;;;;OAIG;IACH,YAHW,sBAAsB,GACpB,OAAO,CAYnB;IAED;;;;;OAKG;IACH,aAHW,sBAAsB,GACpB,OAAO,CASnB;IAED;;;;OAIG;IACH,UAHW,sBAAsB,UACtB,MAAM,QAShB;IAED;;;;OAIG;IACH,SAHW,MAAM,cACN,MAAM,QAUhB;IA+BL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAN1C;;cAWS,eAAe"}
+{"version":3,"file":"EntityReference.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityReference.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;GAmBG;AACH;IAsHI;;;;;OAKG;IACH,gBAJW,MAAM,cACN,MAAM,GACL,eAAe,CAQ1B;IAED;;;;;OAKG;IACH,iBAJW,sBAAsB,MACtB,MAAM,GACJ,eAAe,CAQ3B;IA9ID;;;;OAIG;IACH,IAFU,MAAM,CAET;IAEP;;;;;OAKG;IACH,YAFU,MAAM,CAED;IAEf;;;OAGG;IACH,YAFW,eAAe,QAKzB;IAED;;;OAGG;IACH,SAFa,eAAe,CAQ3B;IAED;;;OAGG;IACH,QAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,cAHW,eAAe,GACd,OAAO,CAMlB;IAED;;;;OAIG;IACH,YAHW,sBAAsB,GACpB,OAAO,CAYnB;IAED;;;;;OAKG;IACH,aAHW,sBAAsB,GACpB,OAAO,CASnB;IAED;;;;OAIG;IACH,UAHW,sBAAsB,UACtB,MAAM,QAShB;IAED;;;;OAIG;IACH,SAHW,MAAM,cACN,MAAM,QAUhB;IA+BL;;;OAGG;IACH,4BAFU,OAAO,CAE0B;CAN1C;;cAWS,eAAe"}

package/src/engine/ecs/EntityReference.js

@@ -16,6 +16,7 @@ import { assert } from "../../core/assert.js";
  *  // 4. After you no longer need the entity - destroy the entity via reference.
  *  entityRef.destroy(ecd);
  *
+ * @see {@link EntityComponentDataset}
  * @author Alex Goldring
  * @copyright Company Named Limited (c) 2025
  */
@@ -31,7 +32,7 @@ export class EntityReference {
     /**
      * Entity generation number. This uniquely identifies an entity in combination with the ID
      * Generation of an existing entity must match for it to be considered "the same".
-     * see {@link EntityComponentDataset.getEntityGeneration}
+     * @see {@link EntityComponentDataset.getEntityGeneration}
      * @type {number}
      */
     generation = -1
@@ -62,7 +63,7 @@ export class EntityReference {
      * @return {number}
      */
     hash() {
-        return this.id ^ this.generation;
+        return (this.id * 31) ^ this.generation;
     }
 
     /**
@@ -173,7 +174,7 @@ export class EntityReference {
 EntityReference.prototype.isEntityReference = true;
 
 /**
- * Special singleton to describe an invalid reference
+ * Special utility singleton to describe an invalid reference.
  * @readonly
  * @type {EntityReference}
  */