@woosh/meep-engine 2.120.1 → 2.120.3

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

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

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

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

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

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

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

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

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

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

package/src/core/model/ModuleRegistry.js

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

package/src/engine/EngineConfiguration.js

@@ -1,5 +1,5 @@
 import { assert } from "../core/assert.js";
-import { computeSystemName } from "./ecs/System.js";
+import { computeSystemName } from "./ecs/computeSystemName.js";
 
 export class EngineConfiguration {
 

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;;;GAGG;AACH;IAgaI;;;;;OAKG;IACH,+BAJW,MAAM,WACN,sBAAsB,GACpB,MAAM,CAgBlB;IAlbD;;;OAGG;IACH,oBAFU,eAAe,CAES;IAWlC;;;OAGG;IACH,UAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAmBD;;;OAGG;IACH,kBAFW,MAAM,EAIhB;IAfD;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAWD;;;;OAIG;IACH,2BAAgB;IAQhB;;;OAGG;IACH,SAFU,sBAAsB,CAEjB;IAEf;;;OAGG;IACH,OAFU,WAAW,GAAC,MAAM,CAEN;IAEtB;;;OAGG;IACH,gBAAgB;IAEhB;;OAEG;IACH;;MAEE;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,eAFa,OAAO,CAInB;IAED;;OAEG;IACH,4BAQC;IAED;;;OAGG;IACH,aAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,IAJa,CAAC,qBACH,CAAC,GACC,MAAM,CAiBlB;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;;;;OAIG;IACH,eAFW,sBAAsB,GADpB,MAAM,CAyDlB;IAyBL;;;;OAIG;IACH,mBAFU,OAAO,CAEQ;;CAPxB;gCApc+B,sBAAsB;4BAF1B,kBAAkB;mBAF3B,oCAAoC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/Entity.js"],"names":[],"mappings":";AAgBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH;IAgaI;;;;;OAKG;IACH,+BAJW,MAAM,WACN,sBAAsB,GACpB,MAAM,CAgBlB;IAlbD;;;OAGG;IACH,oBAFU,eAAe,CAES;IAWlC;;;OAGG;IACH,UAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,UAFa,MAAM,CAIlB;IAmBD;;;OAGG;IACH,kBAFW,MAAM,EAIhB;IAfD;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAWD;;;;OAIG;IACH,2BAAgB;IAQhB;;;OAGG;IACH,SAFU,sBAAsB,CAEjB;IAEf;;;OAGG;IACH,OAFU,WAAW,GAAC,MAAM,CAEN;IAEtB;;;OAGG;IACH,gBAAgB;IAEhB;;OAEG;IACH;;MAEE;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,eAFa,OAAO,CAInB;IAED;;OAEG;IACH,4BAQC;IAED;;;OAGG;IACH,aAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,IAJa,CAAC,qBACH,CAAC,GACC,MAAM,CAiBlB;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;;;;OAIG;IACH,eAFW,sBAAsB,GADpB,MAAM,CAyDlB;IAyBL;;;;OAIG;IACH,mBAFU,OAAO,CAEQ;;CAPxB;gCA7e+B,sBAAsB;4BAD1B,kBAAkB;mBAF3B,oCAAoC"}

package/src/engine/ecs/Entity.js

@@ -2,8 +2,8 @@ import { assert } from "../../core/assert.js";
 import Signal from "../../core/events/signal/Signal.js";
 import { isDefined } from "../../core/process/matcher/isDefined.js";
 import { EntityFlags } from "./EntityFlags.js";
-import { EventType } from "./EntityManager.js";
 import { EntityReference } from "./EntityReference.js";
+import { EventType } from "./EventType.js";
 
 /**
  * Set of default flags
@@ -16,7 +16,47 @@ const DEFAULT_FLAGS =
 
 /**
  * Representation of an entity, helps build entities and keep track of them without having to access {@link EntityComponentDataset} directly
- * @class
+ *
+ *
+ * @example
+ * // Create a new entity (initially has no components).
+ * const entity = new Entity();
+ *
+ * // Define some components (simple data containers).
+ * class PositionComponent {
+ *   constructor(x, y) {
+ *     this.x = x;
+ *     this.y = y;
+ *   }
+ * }
+ *
+ * class VelocityComponent {
+ *   constructor(x, y) {
+ *     this.x = x;
+ *     this.y = y;
+ *   }
+ * }
+ *
+ * // Add components to the entity.
+ * entity.add(new PositionComponent(10, 20));
+ * entity.add(new VelocityComponent(1, 2));
+
+ *
+ * // Get a component (would return null if the entity doesn't have it).
+ * const position = entity.getComponent(PositionComponent); // { x:10, y:20 }
+ *
+ * // Remove a component.
+ * entity.removeComponent(VelocityComponent);
+ *
+ * // To actually use the entity in a game, you need to build it using an EntityComponentDataset.
+ * const dataset = new EntityComponentDataset(); // You would typically have one already
+ *
+ * entity.build(dataset);
+ * // Now the entity and its components are managed by the ECS.
+ *
+ * // later, you can destroy the entity:
+ * entity.destroy();
+ *
  */
 class Entity {
 
@@ -68,7 +108,7 @@ class Entity {
     components = [];
 
     /**
-     *
+     * Listeners added before the entity is build live here
      * @type {{name:string,listener:(function|Function), context:*}[]}
      */
     #deferredListeners = [];
@@ -451,7 +491,7 @@ class Entity {
 
         r.dataset = dataset;
 
-        r.reference.bind(dataset,entity);
+        r.reference.bind(dataset, entity);
 
         return r;
     }

package/src/engine/ecs/EntityBuilderUtils.js

@@ -1,4 +1,4 @@
-import { EventType } from "./EntityManager.js";
+import { EventType } from "./EventType.js";
 
 /**
  *

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

@@ -23,7 +23,7 @@ export class EntityComponentDataset {
 
     public createEntitySpecific(entityId: number): void
 
-    public removeEntity(entityIndex: number): void
+    public removeEntity(entityIndex: number): boolean
 
     public removeEntities(entityIndices: number[]): void
 

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

@@ -1 +1 @@
-{"version":3,"file":"EntityComponentDataset.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityComponentDataset.js"],"names":[],"mappings":"AA2GA;;;;;GAKG;AACH;IAEI;;;OAGG;IACH,wBAA+B;IAE/B;;;;;OAKG;IACH,yBAAsC;IAEtC;;;OAGG;IACH,2BAAkC;IAElC;;;OAGG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAgC;IAEhC;;;;OAIG;IACH,2BAAuB;IAEvB;;;OAGG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,oBAAgB;IAEhB;;;;;;;OAOG;IACH,mBAAe;IAEf;;;OAGG;IACH,0BAFU,MAAM,CAAC,MAAM,CAAC,CAEO;IAE/B;;;OAGG;IACH,0BAFU,MAAM,CAEe;IAG/B;;;;OAIG;IACH,+BAA4B;IAE5B;;;;OAIG;IACH,kCAA+B;IAE/B;;;OAGG;IACH,kBAAe;IAGf;;;;;;OAMG;IACH,iBALa,CAAC,EAAE,CAAC,UACN,GAAG,iBACH,CAAC,GACC,OAAO,CAAC,CAAC,CAAC,CAoCtB;IAED;;;;;OAKG;IACH,sBAJW,cAAc,cACd,OAAO,GACL,OAAO,CAqDnB;IAED;;;;;OAKG;IACH,yBAJW,cAAc,cACd,OAAO,GACL,OAAO,CAuDnB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,yBAFa,MAAM,CAIlB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,kCAoChB;IAED;;;;OAIG;IACH,8BAFW,MAAM,SAkBhB;IAED;;;;OAIG;IACH,yBAHW,KAAK,EAAE,QAwLjB;IAED;;;;OAIG;IACH,mCAHW,KAAK,EAAE,GACL,OAAO,CAYnB;IAED;;;OAGG;IACH,gCAHW,KAAK,WAAS,GACb,OAAO,CAMlB;IAED;;;OAGG;IACH,uBAFa,KAAK,EAAE,CAInB;IAED;;;;OAIG;IACH,kCAHW,KAAK,EAAE,GACL,OAAO,CAgBnB;IAED;;;;OAIG;IACH,4BAHW,KAAK,WAAS,GACZ,OAAO,CAanB;IAED;;;;OAIG;IACH,8BAHW,KAAK,GACH,OAAO,CAiBnB;IAED;;;OAGG;IACH,iCAFW,MAAM,QAgBhB;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;OAGG;IACH,2BAiBC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAQlB;IAED;;;;OAIG;IACH,gCAHW,MAAM,QAShB;IAED;;;;OAIG;IACH,0BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,qCAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,OAAO,CAsCnB;IAED;;;OAGG;IACH,8BAFW,MAAM,EAAE,QAQlB;IAED;;;;OAIG;IACH,uCAHW,MAAM,SACN,KAAK,QAUf;IAED;;;;OAIG;IACH,8CAHW,MAAM,kBACN,MAAM,QAiBhB;IAED;;;;;;OAMG;IACH,mDAgBC;IAED;;;;OAIG;IACH,uCAFa,MAAM,CAUlB;IAED;;;;OAIG;IACH,6BAHW,CAAC,GACC,MAAM,CAUlB;IAED;;;;OAIG;IACH,gBAJa,CAAC,iBACH,KAAK,CAAC,CAAC,CAAC,GACN;QAAC,MAAM,EAAC,MAAM,CAAC;QAAC,SAAS,EAAC,CAAC,CAAA;KAAC,CAiBxC;IAED;;;;;;OAMG;IACH,qBAJa,CAAC,eACH,MAAM,qBACN,CAAC,QAmBX;IAED;;;;;OAKG;IACH,4BALa,CAAC,eACH,MAAM,kBACN,MAAM,qBACN,CAAC,QA4BX;IAED;;;;;OAKG;IACH,oBALa,CAAC,eACH,MAAM,kBACN,MAAM,GACJ,CAAC,GAAC,SAAS,CASvB;IAED;;;;;;OAMG;IACH,aALa,CAAC,eACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,OAAO,CAInB;IAED;;;;;OAKG;IACH,aALa,CAAC,aACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,SAAS,CAevB;IAED;;;;;;;OAOG;IACH,iBANa,CAAC,eACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,CAWb;IAED;;;;;;OAMG;IACH,oDAJW,KAAK,gCAEL,GAAC,QAiBX;IAED;;;;;;OAMG;IACH,0CAHW,IAAS,IAAO,EAAP,OAAO,KAAE,OAAO,YACzB,MAAM,QAyEhB;IAED;;;;;;OAMG;IACH,4EAwDC;IAED;;;OAGG;IACH,wBAFa,SAAS,CAAC,MAAM,CAAC,CAU7B;IAED;;;;;OAKG;IACH,mBALa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,0BAER,GAAC,QAaX;IAED;;;;;OAKG;IACH,8CAJW,MAAM,+BAEN,GAAC,QAQX;IAED;;;;;OAKG;IACH,2DAJW,MAAM,+BAEN,GAAC,QA2BX;IAED;;;;;OAKG;IACH,6DAJW,MAAM,+BAEN,GAAC,QAwBX;IAED;;;;OAIG;IACH,wCAgCC;IAED;;;;OAIG;IACH,0CA2BC;IAED;;;;;OAKG;IACH,kCAJW,MAAM,gCAEN,GAAC,QAoBX;IAED;;;;;;OAMG;IACH,+BALW,MAAM,gCAEN,GAAC,GACC,OAAO,CA4BnB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,aACN,MAAM,YACN,SAAU,YACV,GAAC,QA8BX;IAED;;;;;;;;OAQG;IACH,kCAPW,MAAM,aACN,MAAM,gCAEN,GAAC,GAEC,OAAO,CAoCnB;IAED;;;;;OAKG;IACH,2DAeC;IAED;;;;OAIG;IACH,iCAHW,MAAM,GACJ,OAAO,CAenB;IAED;;OAEG;IACH,cAMC;IAED;;;OAGG;IACH,iBAYC;IAED;;;;OAIG;IACH,wBAJa,CAAC,aACH,MAAM,GACJ,IAAI,cAAU,KAAK,CAAC,CAAC,CAAC,CAYlC;IAED;;;;OAIG;IACH,mBAFW,sBAAsB,iCA6DhC;IAED;;;;OAIG;IACH,+EAiDC;IAED;;;OAGG;IACH,WAFa,OAAO,CAInB;IAED;;;OAGG;IACH,0CAQC;IAGL;;;OAGG;IACH,mCAFU,OAAO,CAEwC;CANxD;mBA1zDkB,oCAAoC"}
+{"version":3,"file":"EntityComponentDataset.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityComponentDataset.js"],"names":[],"mappings":"AA4GA;;;;;;;;;;;;;;;;;GAiBG;AACH;IAEI;;;OAGG;IACH,wBAA+B;IAE/B;;;;;OAKG;IACH,yBAAsC;IAEtC;;;OAGG;IACH,2BAAkC;IAElC;;;OAGG;IACH,yBAAsB;IAEtB;;;;OAIG;IACH,4BAAgC;IAEhC;;;;OAIG;IACH,2BAAuB;IAEvB;;;OAGG;IACH,mBAAgB;IAEhB;;;;OAIG;IACH,oBAAgB;IAEhB;;;;;;;OAOG;IACH,mBAAe;IAEf;;;OAGG;IACH,0BAFU,MAAM,CAAC,MAAM,CAAC,CAEO;IAE/B;;;OAGG;IACH,0BAFU,MAAM,CAEe;IAG/B;;;;OAIG;IACH,+BAA4B;IAE5B;;;;OAIG;IACH,kCAA+B;IAE/B;;;OAGG;IACH,kBAAe;IAGf;;;;;;OAMG;IACH,iBALa,CAAC,EAAE,CAAC,UACN,GAAG,iBACH,CAAC,GACC,OAAO,CAAC,CAAC,CAAC,CAoCtB;IAED;;;;;OAKG;IACH,sBAJW,cAAc,cACd,OAAO,GACL,OAAO,CAqDnB;IAED;;;;;OAKG;IACH,yBAJW,cAAc,cACd,OAAO,GACL,OAAO,CAuDnB;IAED;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,yBAFa,MAAM,CAIlB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,kCAoChB;IAED;;;;OAIG;IACH,4BAHW,MAAM,GACJ,EAAE,CAyBd;IAED;;;;OAIG;IACH,yBAHW,KAAK,EAAE,QAwLjB;IAED;;;;OAIG;IACH,mCAHW,KAAK,EAAE,GACL,OAAO,CAYnB;IAED;;;OAGG;IACH,gCAHW,KAAK,WAAS,GACb,OAAO,CAMlB;IAED;;;OAGG;IACH,uBAFa,KAAK,EAAE,CAInB;IAED;;;;OAIG;IACH,kCAHW,KAAK,EAAE,GACL,OAAO,CAgBnB;IAED;;;;OAIG;IACH,4BAHW,KAAK,WAAS,GACZ,OAAO,CAanB;IAED;;;;OAIG;IACH,8BAHW,KAAK,GACH,OAAO,CAiBnB;IAED;;;OAGG;IACH,iCAFW,MAAM,QAgBhB;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,MAAM,CAMlB;IAED;;;OAGG;IACH,2BAiBC;IAED;;;OAGG;IACH,gBAFa,MAAM,CAQlB;IAED;;;;OAIG;IACH,gCAHW,MAAM,QAShB;IAED;;;;OAIG;IACH,0BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,qCAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,OAAO,CAsCnB;IAED;;;OAGG;IACH,8BAFW,MAAM,EAAE,QAQlB;IAED;;;;OAIG;IACH,uCAHW,MAAM,SACN,KAAK,QAUf;IAED;;;;OAIG;IACH,8CAHW,MAAM,kBACN,MAAM,QAiBhB;IAED;;;;;;OAMG;IACH,mDAgBC;IAED;;;;OAIG;IACH,uCAFa,MAAM,CAUlB;IAED;;;;OAIG;IACH,sBAJa,CAAC,SACH,CAAC,GACC,MAAM,CAUlB;IAED;;;;OAIG;IACH,gBAJa,CAAC,iBACH,KAAK,CAAC,CAAC,CAAC,GACN;QAAC,MAAM,EAAC,MAAM,CAAC;QAAC,SAAS,EAAC,CAAC,CAAA;KAAC,CAiBxC;IAED;;;;;;OAMG;IACH,qBAJa,CAAC,eACH,MAAM,qBACN,CAAC,QAuBX;IAED;;;;;OAKG;IACH,4BALa,CAAC,eACH,MAAM,kBACN,MAAM,qBACN,CAAC,QA4BX;IAED;;;;;OAKG;IACH,oBALa,CAAC,eACH,MAAM,kBACN,MAAM,GACJ,CAAC,GAAC,SAAS,CASvB;IAED;;;;;;OAMG;IACH,aALa,CAAC,eACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,OAAO,CAInB;IAED;;;;;OAKG;IACH,aALa,CAAC,aACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,SAAS,CAevB;IAED;;;;;;;OAOG;IACH,iBANa,CAAC,eACH,MAAM,SACN,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,CAWb;IAED;;;;;;OAMG;IACH,oDAJW,KAAK,gCAEL,GAAC,QAiBX;IAED;;;;;;;;;;;;OAYG;IACH,0CAHW,IAAS,IAAO,EAAP,OAAO,KAAE,OAAO,YACzB,MAAM,QAyEhB;IAED;;;;;;OAMG;IACH,4EAwDC;IAED;;;OAGG;IACH,wBAFa,SAAS,CAAC,MAAM,CAAC,CAU7B;IAED;;;;;OAKG;IACH,mBALa,CAAC,SACH,KAAK,CAAC,CAAC,CAAC,0BAER,GAAC,QAaX;IAED;;;;;OAKG;IACH,8CAJW,MAAM,+BAEN,GAAC,QAQX;IAED;;;;;OAKG;IACH,2DAJW,MAAM,+BAEN,GAAC,QA2BX;IAED;;;;;OAKG;IACH,6DAJW,MAAM,+BAEN,GAAC,QAwBX;IAED;;;;OAIG;IACH,wCAgCC;IAED;;;;OAIG;IACH,0CA2BC;IAED;;;;;OAKG;IACH,kCAJW,MAAM,gCAEN,GAAC,QAoBX;IAED;;;;;;OAMG;IACH,+BALW,MAAM,gCAEN,GAAC,GACC,OAAO,CA4BnB;IAED;;;;;;OAMG;IACH,+BALW,MAAM,aACN,MAAM,YACN,SAAU,YACV,GAAC,QA8BX;IAED;;;;;;;;OAQG;IACH,kCAPW,MAAM,aACN,MAAM,gCAEN,GAAC,GAEC,OAAO,CAoCnB;IAED;;;;;OAKG;IACH,2DAeC;IAED;;;;OAIG;IACH,iCAHW,MAAM,GACJ,OAAO,CAenB;IAED;;OAEG;IACH,cAMC;IAED;;;OAGG;IACH,iBAYC;IAED;;;;OAIG;IACH,wBAJa,CAAC,aACH,MAAM,GACJ,IAAI,cAAU,KAAK,CAAC,CAAC,CAAC,CAYlC;IAED;;;;OAIG;IACH,mBAFW,sBAAsB,iCA6DhC;IAED;;;;OAIG;IACH,+EAiDC;IAED;;;OAGG;IACH,WAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,8CAFW,GAAC,QAgBX;IAGL;;;OAGG;IACH,mCAFU,OAAO,CAEwC;CANxD;mBAj2DkB,oCAAoC"}

package/src/engine/ecs/EntityComponentDataset.js

@@ -9,7 +9,8 @@ import {
 import Signal from "../../core/events/signal/Signal.js";
 import { SignalHandler } from "../../core/events/signal/SignalHandler.js";
 import { max3 } from "../../core/math/max3.js";
-import { EventType } from "./EntityManager.js";
+
+import { EventType } from "./EventType.js";
 
 /**
  *
@@ -110,6 +111,18 @@ const scratch_array_1 = [];
  * Entities are just integer IDs and components are stored in a virtual table, where each component type has a separate column and each entity is a row in that table
  * It is valid for entities to have no components or to have every possible component
  * Generally the entity IDs are compacted, meaning that when an entity is removed - it's ID will be later reused
+ * Typically you would use {@link Entity} helper class instead of working directly with the dataset as it offers a higher-level API
+ *
+ * @example
+ *   const ecd = new EntityComponentDataset();
+ *   // create an entity
+ *   const entityId = ecd.createEntity();
+ *
+ *   // add a component to your entity
+ *   ecd.addComponentToEntity(entityId, myComponentInstance);
+ *
+ *   // destroy the entity
+ *   ecd.removeEntity(entityId);
  */
 export class EntityComponentDataset {
 
@@ -431,22 +444,29 @@ export class EntityComponentDataset {
 
     /**
      * Get all components associated with a given entity
-     * @returns {Array}
-     * @param {number} entityIndex
+     * @param {number} entity_id
+     * @returns {[]} all components attached to the entity, array is not compacted
      */
-    getAllComponents(entityIndex) {
-        assert.ok(this.entityExists(entityIndex), `Entity ${entityIndex} doesn't exist`);
+    getAllComponents(entity_id) {
+        assert.isNonNegativeInteger(entity_id, 'entity_id');
+        assert.ok(this.entityExists(entity_id), `Entity ${entity_id} doesn't exist`);
 
         const ret = [];
 
         const componentTypeCount = this.componentTypeCount;
-        const occupancyStart = componentTypeCount * entityIndex;
-        const occupancyEnd = occupancyStart + componentTypeCount;
+        const occupancy_start = componentTypeCount * entity_id;
+        const occupancy_end = occupancy_start + componentTypeCount;
 
-        for (let i = this.componentOccupancy.nextSetBit(occupancyStart); i < occupancyEnd && i !== -1; i = this.componentOccupancy.nextSetBit(i + 1)) {
+        const occupancy = this.componentOccupancy;
+
+        for (
+            let i = occupancy.nextSetBit(occupancy_start);
+            i < occupancy_end && i !== -1;
+            i = occupancy.nextSetBit(i + 1)
+        ) {
             const componentIndex = i % componentTypeCount;
 
-            ret[componentIndex] = this.components[componentIndex][entityIndex];
+            ret[componentIndex] = this.components[componentIndex][entity_id];
         }
 
         return ret;
@@ -762,6 +782,8 @@ export class EntityComponentDataset {
      * @returns {number}
      */
     getEntityGeneration(entity_id) {
+        assert.isNonNegativeInteger(entity_id, 'entity_id');
+
         return this.entityGeneration[entity_id];
     }
 
@@ -836,9 +858,9 @@ export class EntityComponentDataset {
     }
 
     /**
-     *
+     * Remove entity from the dataset, effectively destroying it from the world
      * @param {number} entity_id
-     * @returns {boolean}
+     * @returns {boolean} true if entity was removed, false if it doesn't exist
      */
     removeEntity(entity_id) {
         if (!this.entityExists(entity_id)) {
@@ -968,7 +990,7 @@ export class EntityComponentDataset {
     }
 
     /**
-     * @template {T}
+     * @template T
      * @param {T} klass
      * @returns {number}
      */
@@ -1017,6 +1039,10 @@ export class EntityComponentDataset {
 
         assert.defined(componentInstance, "componentInstance");
 
+        /**
+         *
+         * @type {Class<C>}
+         */
         const klass = componentInstance.constructor;
 
         const componentTypeIndex = this.__type_to_index_map.get(klass);
@@ -1155,7 +1181,13 @@ export class EntityComponentDataset {
 
     /**
      * Performs traversal on a subset of entities which have specified components.
-     * @example traverseEntities([Transform,Renderable,Tag],function(transform, renderable, tag, entity){ ... }, this);
+     * @example
+     *  ecd.traverseEntities(
+     *      [Transform, Renderable, Tag], // Component classes to match
+     *      (transform, renderable, tag, entity ) => {  // actual component instances along with entity ID
+     *          // do something
+     *      }
+     *  );
      * @param {Array} classes
      * @param {function(...args):boolean} visitor Visitor can return optional "false" to terminate traversal earlier
      * @param {object} [thisArg] specifies context object on which callbacks are to be called, optional
@@ -1836,7 +1868,7 @@ export class EntityComponentDataset {
     }
 
     /**
-     * Tells whether or not dataset has any entities
+     * Tells if dataset has any entities
      * @returns {boolean}
      */
     isEmpty() {
@@ -1846,14 +1878,21 @@ export class EntityComponentDataset {
     /**
      *
      * @param {function(entityIndex:number)} visitor
+     * @param {*} [thisArg]
      */
-    traverseEntityIndices(visitor) {
+    traverseEntityIndices(visitor, thisArg) {
         let entityIndex;
 
         const occupancy = this.entityOccupancy;
 
-        for (entityIndex = occupancy.nextSetBit(0); entityIndex !== -1; entityIndex = occupancy.nextSetBit(entityIndex + 1)) {
-            visitor(entityIndex);
+        for (
+            entityIndex = occupancy.nextSetBit(0);
+            entityIndex !== -1;
+            entityIndex = occupancy.nextSetBit(entityIndex + 1)
+        ) {
+
+            visitor.call(thisArg, entityIndex);
+
         }
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"EntityManager.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityManager.js"],"names":[],"mappings":";;;wBAcU,MAAM;;;;;;iCAWN,MAAM;;;;;;;;;AAWhB;IAEI;;;OAGG;IACH,kBAFU,iCAAQ,CAEL;IAEb;;;OAGG;IACH,gCAFU,iCAAQ,CAES;IAE3B;;;OAGG;IACH,0BAFU,cAAc,EAAE,CAEL;IAErB;;OAEG;IACH;;;QAGI;;WAEG;qBADO,MAAM,iCAAQ;;MAI1B;IAEF;;;OAGG;IACH,OAFU,kBAAkB,CAEO;IAEnC;;;;OAIG;IACH,gDAA2C;IAE3C;;;;OAIG;IACH,qBAFU,MAAM,CAEY;IAE5B;;;;;OAKG;IACH,wCAFU,MAAM,CAE4B;IAE5C;;;OAGG;IACH,SAFU,sBAAsB,CAEjB;IAEf;;;;OAIG;IACH,uCAAsC;IAEtC;;;OAGG;IACH,6BA8EC;IAED,sBAcC;IAED;;;OAGG;IACH,uBAFa,KAAK,EAAE,CAuBnB;IAED;;;;;OAKG;IACH,uBAJW,sBAAsB,QA0BhC;IAED;;;;OAIG;IACH,UAJa,CAAC,eACH,KAAK,CAAC,CAAC,CAAC,GACN,OAAO,CAInB;IAED;;;;OAIG;IACH,UAJa,CAAC,eACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,IAAI,CAgBlB;IAED;;;;;OAKG;IACH,wBAJa,CAAC,aACH,MAAM,GACJ,IAAI,GAAC,KAAK,CAAC,CAAC,CAAC,CAezB;IAGD;;;OAGG;IACH,oBAFW,MAAM,QAkEhB;IAED;;;;;OAKG;IACH,iEA0EC;IAED;;;;OAIG;IACH,uDAFa,OAAO,CAAC,OAAO,CAAC,CAyC5B;IAED;;;;;OAKG;IACH,mBA6BC;IAED;;;;;OAKG;IACH,oBAwCC;IAED;;;;OAIG;IACH,gEAwEC;IAED;;;;OAIG;IACH,2BAHW,KAAK,GACH,OAAO,iCAAS,CA0B5B;IAED;;;;;OAKG;IACH,kCAJW,KAAK,SACL,WAAW,GACT,OAAO,iCAAS,CAsB5B;IAED;;;;OAIG;IACH,iEAkEC;CACJ;uBApyBsD,aAAa;+BADrC,qBAAqB;mBALjC,oCAAoC"}
+{"version":3,"file":"EntityManager.d.ts","sourceRoot":"","sources":["../../../../src/engine/ecs/EntityManager.js"],"names":[],"mappings":"iCAeU,MAAM;;;;;;;;;AAWhB;;;GAGG;AACH;IAEI;;;OAGG;IACH,kBAFU,iCAAQ,CAEL;IAEb;;;;OAIG;IACH,uCAA2B;IAE3B;;;;OAIG;IACH,iCAAqB;IAErB;;OAEG;IACH;;;QAGI;;WAEG;qBADO,MAAM,iCAAQ;;MAI1B;IAEF;;;OAGG;IACH,OAFU,kBAAkB,CAEO;IAEnC;;;;;;OAMG;IACH,gDAA2C;IAE3C;;;;OAIG;IACH,qBAFU,MAAM,CAEY;IAE5B;;;;;OAKG;IACH,wCAFU,MAAM,CAE4B;IAE5C;;;OAGG;IACH,SAFU,sBAAsB,CAEjB;IAEf;;;;;OAKG;IACH,uCAAsC;IAEtC;;;OAGG;IACH,6BA8EC;IAED,sBAcC;IAED;;;OAGG;IACH,uBAFa,KAAK,EAAE,CAuBnB;IAED;;;;;OAKG;IACH,uBAJW,sBAAsB,QA0BhC;IAED;;;;OAIG;IACH,UAJa,CAAC,eACH,KAAK,CAAC,CAAC,CAAC,GACN,OAAO,CAInB;IAED;;;;OAIG;IACH,UAJa,CAAC,eACH,KAAK,CAAC,CAAC,CAAC,GACN,CAAC,GAAC,IAAI,CAgBlB;IAED;;;;;OAKG;IACH,wBAJa,CAAC,aACH,MAAM,GACJ,IAAI,GAAC,KAAK,CAAC,CAAC,CAAC,CAezB;IAGD;;;OAGG;IACH,oBAFW,MAAM,QAkEhB;IAED;;;;;OAKG;IACH,iEA0EC;IAED;;;;OAIG;IACH,uDAFa,OAAO,CAAC,OAAO,CAAC,CAyC5B;IAED;;;;;OAKG;IACH,mBA6BC;IAED;;;;;OAKG;IACH,oBAwCC;IAED;;;;OAIG;IACH,gEAwEC;IAED;;;;OAIG;IACH,2BAHW,KAAK,GACH,OAAO,iCAAS,CA0B5B;IAED;;;;;OAKG;IACH,kCAJW,KAAK,SACL,WAAW,GACT,OAAO,iCAAS,CAsB5B;IAED;;;;OAIG;IACH,iEAsEC;CACJ;uBAtyBmC,aAAa;mBAP9B,oCAAoC"}