@woosh/meep-engine 2.84.6 → 2.84.8

package/build/meep.module.js

@@ -61116,6 +61116,7 @@ function objectsEqual(a, b) {
 }
 
 /**
+ * Works similarly to `Array.prototype.indexOf`, but instead of strict equality - uses provided equality method
  * @template T
  * @param {T[]} array
  * @param {T} element
@@ -61219,7 +61220,7 @@ class List {
         this.data = array !== undefined ? array.slice() : [];
 
         /**
-         *
+         * Number of elements in the list
          * @type {number}
          */
         this.length = this.data.length;
@@ -61788,30 +61789,30 @@ class List {
     }
 
     /**
-     *
+     * @deprecated use `#reset` directly in combination with `this.on.removed` signal
      * @param {function(element:T,index:number)} callback
      * @param {*} [thisArg]
      */
     resetViaCallback(callback, thisArg) {
+
         const length = this.length;
-        if (length > 0) {
 
-            const removed = this.on.removed;
+        const removed = this.on.removed;
 
-            const oldElements = this.data;
+        const data = this.data;
 
-            //only signal if there are listeners attached
-            for (let i = length - 1; i >= 0; i--) {
-                const element = oldElements[i];
-                // decrement data length gradually to allow handlers access to the rest of the elements
-                this.data.length = i;
-                this.length = i;
-                removed.send2(element, i);
+        for (let i = length - 1; i >= 0; i--) {
+            const element = data[i];
 
-                callback.call(thisArg, element, i);
-            }
+            // decrement data length gradually to allow handlers access to the rest of the elements
+            data.length = i;
+            this.length = i;
+
+            removed.send2(element, i);
 
+            callback.call(thisArg, element, i);
         }
+
     }
 
     reset() {
@@ -62031,11 +62032,19 @@ class List {
     }
 
     /**
-     *
+     * First element in the list
+     * @returns {T|undefined}
+     */
+    first() {
+        return this.get(0);
+    }
+
+    /**
+     * Last element in the list
      * @return {T|undefined}
      */
     last() {
-        return this.data[this.length - 1];
+        return this.get(this.length - 1);
     }
 
     /**
@@ -63119,10 +63128,11 @@ class WorkerProxy {
     }
 
     /**
+     * Invoke a given method on the worker, as defined by the `WorkerBuilder`
      * @template T
-     * @param {number} name
+     * @param {number} name Method's name
      * @param {Array} args
-     * @return {Promise<T>}
+     * @return {Promise<T>} eventual result of the invoked method
      */
     $submitRequest(name, args) {
         const pending = this.__pending[name];
@@ -63345,6 +63355,10 @@ class WorkerBuilder {
     functions = [];
     preamble = new LineBuilder();
 
+    /**
+     *
+     * @param {string} code
+     */
     addCode(code) {
         this.preamble.add(code);
     }
@@ -79747,28 +79761,19 @@ function m3_cm_compose_transform(
 }
 
 /**
- * @author Alex Goldring, 2018
- * @copyright Alex Goldring 2018
+ * Smallest safe increment for a Float32
+ * @see https://www.cplusplus.com/reference/cfloat/
+ * @see https://bitbashing.io/comparing-floats.html
+ * @type {number}
  */
-
-
-
-const scratch_m3_0 = new Float32Array(9);
-
+const FLT_EPSILON_32 = 1.192092896E-7;
+
 /**
- * @see https://dev.opera.com/articles/understanding-the-css-transforms-matrix/
- * @param domElement
- * @param {Vector2} position
- * @param {Vector2} scale
- * @param {number} rotation angle in radians
+ *
+ * @param {Float32Array} m3
+ * @param {HTMLElement} domElement
  */
-function setElementTransform(domElement, position, scale, rotation) {
-
-    const m3 = scratch_m3_0;
-
-    m3_cm_compose_transform(m3, position.x, position.y, scale.x, scale.y, 0, 0, rotation);
-
-
+function writeCssTransformMatrix(m3, domElement) {
     /*
      * CSS matrix is:
      *      a c e
@@ -79788,7 +79793,13 @@ function setElementTransform(domElement, position, scale, rotation) {
     const style = domElement.style;
 
     style.transform = transform;
-}
+}
+
+/**
+ * @author Alex Goldring, 2018
+ * @copyright Alex Goldring 2018
+ */
+
 
 /**
  *
@@ -79827,6 +79838,9 @@ const INITIAL_FLAGS = ViewFlags.Visible;
  * @class
  */
 class View {
+    #transform_written = new Float32Array(9);
+    #transform_current = new Float32Array(9);
+
     /**
      * @constructor
      */
@@ -79851,31 +79865,32 @@ class View {
         this.flags = INITIAL_FLAGS;
 
         /**
-         *
+         * @readonly
          * @type {Vector2}
          */
         const position = this.position = new Vector2(0, 0);
 
         /**
-         *
+         * @readonly
          * @type {Vector1}
          */
         const rotation = this.rotation = new Vector1(0);
 
         /**
-         *
+         * @readonly
          * @type {Vector2}
          */
         const scale = this.scale = new Vector2(1, 1);
 
         /**
-         *
+         * @readonly
          * @type {Vector2}
          */
         const size = this.size = new Vector2(0, 0);
 
         /**
          * Origin from which rotation and scaling is applied
+         * @readonly
          * @type {Vector2}
          */
         this.transformOrigin = new Vector2(0.5, 0.5);
@@ -80013,7 +80028,41 @@ class View {
      * @private
      */
     __updateTransform() {
-        setElementTransform(this.el, this.position, this.scale, this.rotation.getValue());
+        const position = this.position;
+        const scale = this.scale;
+        const rotation = this.rotation.getValue();
+
+        m3_cm_compose_transform(this.#transform_current, position.x, position.y, scale.x, scale.y, 0, 0, rotation);
+
+        this.#tryWriteTransform();
+    }
+
+    #tryWriteTransform() {
+
+        const current = this.#transform_current;
+        const written = this.#transform_written;
+
+        for (let i = 0; i < 9; i++) {
+            const a = current[i];
+            const b = written[i];
+
+            if (epsilonEquals(a, b, FLT_EPSILON_32)) {
+                // common path
+                continue;
+            }
+
+            this.#writeTransform();
+            return true;
+
+        }
+
+        return false;
+    }
+
+    #writeTransform() {
+        writeCssTransformMatrix(this.#transform_current, this.el);
+
+        this.#transform_written.set(this.#transform_current);
     }
 
     /**
@@ -93077,10 +93126,10 @@ class EntityComponentDataset {
 
     /**
      *
-     * @param {number} entityIndex
+     * @param {number} entity_id
      */
-    removeEntity(entityIndex) {
-        if (!this.entityExists(entityIndex)) {
+    removeEntity(entity_id) {
+        if (!this.entityExists(entity_id)) {
             // entity doesn't exist
             return;
         }
@@ -93088,26 +93137,31 @@ class EntityComponentDataset {
         const componentOccupancy = this.componentOccupancy;
         const typeCount = this.componentTypeCount;
 
-        const occupancyStart = entityIndex * typeCount;
+        const occupancyStart = entity_id * typeCount;
         const occupancyEnd = occupancyStart + typeCount;
 
-        for (let i = componentOccupancy.nextSetBit(occupancyStart); i < occupancyEnd && i !== -1; i = componentOccupancy.nextSetBit(i + 1)) {
+        // remove all components from the entity
+        for (
+            let i = componentOccupancy.nextSetBit(occupancyStart);
+            i < occupancyEnd && i !== -1;
+            i = componentOccupancy.nextSetBit(i + 1)
+        ) {
             const componentIndex = i % typeCount;
-            this.removeComponentFromEntityByIndex_Unchecked(entityIndex, componentIndex, i);
+            this.removeComponentFromEntityByIndex_Unchecked(entity_id, componentIndex, i);
         }
 
         //dispatch event
-        this.sendEvent(entityIndex, EventType.EntityRemoved, entityIndex);
+        this.sendEvent(entity_id, EventType.EntityRemoved, entity_id);
 
         //purge all event listeners
-        delete this.__entityEventListeners[entityIndex];
-        delete this.__entityAnyEventListeners[entityIndex];
+        delete this.__entityEventListeners[entity_id];
+        delete this.__entityAnyEventListeners[entity_id];
 
-        this.entityOccupancy.set(entityIndex, false);
+        this.entityOccupancy.set(entity_id, false);
 
         this.entityCount--;
 
-        this.onEntityRemoved.send1(entityIndex);
+        this.onEntityRemoved.send1(entity_id);
     }
 
     /**
@@ -93157,6 +93211,7 @@ class EntityComponentDataset {
     }
 
     /**
+     * This method doesn't perform any checks, make sure you understand what you are doing when using it
      * @private
      * @param {number} entityIndex
      * @param {number} componentIndex

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.84.6",
+  "version": "2.84.8",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/collection/array/arrayIndexByEquality.js

@@ -1,4 +1,5 @@
 /**
+ * Works similarly to `Array.prototype.indexOf`, but instead of strict equality - uses provided equality method
  * @template T
  * @param {T[]} array
  * @param {T} element

package/src/core/collection/list/List.js

@@ -43,7 +43,7 @@ class List {
         this.data = array !== undefined ? array.slice() : [];
 
         /**
-         *
+         * Number of elements in the list
          * @type {number}
          */
         this.length = this.data.length;
@@ -628,30 +628,30 @@ class List {
     }
 
     /**
-     *
+     * @deprecated use `#reset` directly in combination with `this.on.removed` signal
      * @param {function(element:T,index:number)} callback
      * @param {*} [thisArg]
      */
     resetViaCallback(callback, thisArg) {
+
         const length = this.length;
-        if (length > 0) {
 
-            const removed = this.on.removed;
+        const removed = this.on.removed;
 
-            const oldElements = this.data;
+        const data = this.data;
 
-            //only signal if there are listeners attached
-            for (let i = length - 1; i >= 0; i--) {
-                const element = oldElements[i];
-                // decrement data length gradually to allow handlers access to the rest of the elements
-                this.data.length = i;
-                this.length = i;
-                removed.send2(element, i);
-
-                callback.call(thisArg, element, i);
-            }
+        for (let i = length - 1; i >= 0; i--) {
+            const element = data[i];
+
+            // decrement data length gradually to allow handlers access to the rest of the elements
+            data.length = i;
+            this.length = i;
 
+            removed.send2(element, i);
+
+            callback.call(thisArg, element, i);
         }
+
     }
 
     reset() {
@@ -875,11 +875,19 @@ class List {
     }
 
     /**
-     *
+     * First element in the list
+     * @returns {T|undefined}
+     */
+    first() {
+        return this.get(0);
+    }
+
+    /**
+     * Last element in the list
      * @return {T|undefined}
      */
     last() {
-        return this.data[this.length - 1];
+        return this.get(this.length - 1);
     }
 
     /**

package/src/core/collection/list/List.spec.js

@@ -9,6 +9,18 @@ class DummyNumber {
     equals(o) {
         return o.v === this.v;
     }
+
+    copy(other) {
+        this.v = other.v;
+    }
+
+    clone() {
+        const r = new DummyNumber();
+
+        r.copy(this);
+
+        return r;
+    }
 }
 
 test("constructor doesn't throw", () => {
@@ -254,4 +266,65 @@ test("patch", () => {
 
     expect(list.asArray()).toEqual([3, 1, 2]);
     expect(list.length).toBe(3);
+});
+
+test("equals", () => {
+
+    expect(
+        new List().equals(new List())
+    ).toBe(true);
+
+    expect(
+        new List(["a"]).equals(new List(["a"]))
+    ).toBe(true);
+
+    expect(
+        new List(["a"]).equals(new List(["b"]))
+    ).toBe(false);
+
+    expect(
+        new List(["a", "b"]).equals(new List(["a"]))
+    ).toBe(false);
+
+    expect(
+        new List(["a", "b"]).equals(new List(["b"]))
+    ).toBe(false);
+
+    expect(
+        new List(["a", "b"]).equals(new List(["a", "b"]))
+    ).toBe(true);
+
+});
+
+test("fist", () => {
+
+    expect(new List([1]).first()).toBe(1);
+    expect(new List([1, 2]).first()).toBe(1);
+
+});
+test("last", () => {
+
+    expect(new List([1]).last()).toBe(1);
+    expect(new List([1, 2]).last()).toBe(2);
+
+});
+
+test("deepCopy", () => {
+
+    const a = new List();
+    const b = new List();
+
+    b.deepCopy(a);
+
+    expect(b.isEmpty()).toBe(true);
+
+    const v = new DummyNumber(7);
+    b.addAll([v]);
+
+    a.deepCopy(b);
+
+    expect(a.length).toBe(1);
+    expect(a.first()).toBeDefined();
+    expect(a.first().v).toBe(7);
+    expect(a.first()).not.toBe(v);
 });

package/src/core/process/worker/WorkerBuilder.js

@@ -3,7 +3,7 @@
  */
 
 
-import {convertPathToURL} from "../../../engine/network/convertPathToURL.js";
+import { convertPathToURL } from "../../../engine/network/convertPathToURL.js";
 import LineBuilder from "../../codegen/LineBuilder.js";
 import WorkerProxy from "./WorkerProxy.js";
 
@@ -16,6 +16,10 @@ class WorkerBuilder {
     functions = [];
     preamble = new LineBuilder();
 
+    /**
+     *
+     * @param {string} code
+     */
     addCode(code) {
         this.preamble.add(code);
     }

package/src/core/process/worker/WorkerProxy.js

@@ -66,10 +66,11 @@ class WorkerProxy {
     }
 
     /**
+     * Invoke a given method on the worker, as defined by the `WorkerBuilder`
      * @template T
-     * @param {number} name
+     * @param {number} name Method's name
      * @param {Array} args
-     * @return {Promise<T>}
+     * @return {Promise<T>} eventual result of the invoked method
      */
     $submitRequest(name, args) {
         const pending = this.__pending[name];

package/src/engine/ecs/Entity.spec.js

@@ -153,3 +153,36 @@ test("promiseEvent", async () => {
 
     await promise;
 });
+
+test("generation correctly set for build", () => {
+
+    const entity = new Entity();
+
+    const ecd = sampleDataset();
+
+    entity.build(ecd);
+
+    expect(entity.generation).toEqual(ecd.getEntityGeneration(entity.id));
+
+    // rebuild
+    entity.destroy();
+
+    entity.build(ecd);
+
+    expect(entity.generation).toEqual(ecd.getEntityGeneration(entity.id));
+});
+
+test("generation correctly set when binding live entity", () => {
+
+
+    const ecd = sampleDataset();
+
+
+    const entity_a = ecd.createEntity();
+    const entity_b = ecd.createEntity();
+    const entity_c = ecd.createEntity();
+
+    const entity = Entity.readFromDataset(entity_b, ecd);
+
+    expect(entity.generation).toEqual(ecd.getEntityGeneration(entity_b));
+});

package/src/engine/ecs/EntityComponentDataset.js

@@ -836,10 +836,10 @@ export class EntityComponentDataset {
 
     /**
      *
-     * @param {number} entityIndex
+     * @param {number} entity_id
      */
-    removeEntity(entityIndex) {
-        if (!this.entityExists(entityIndex)) {
+    removeEntity(entity_id) {
+        if (!this.entityExists(entity_id)) {
             // entity doesn't exist
             return;
         }
@@ -847,26 +847,31 @@ export class EntityComponentDataset {
         const componentOccupancy = this.componentOccupancy;
         const typeCount = this.componentTypeCount;
 
-        const occupancyStart = entityIndex * typeCount;
+        const occupancyStart = entity_id * typeCount;
         const occupancyEnd = occupancyStart + typeCount;
 
-        for (let i = componentOccupancy.nextSetBit(occupancyStart); i < occupancyEnd && i !== -1; i = componentOccupancy.nextSetBit(i + 1)) {
+        // remove all components from the entity
+        for (
+            let i = componentOccupancy.nextSetBit(occupancyStart);
+            i < occupancyEnd && i !== -1;
+            i = componentOccupancy.nextSetBit(i + 1)
+        ) {
             const componentIndex = i % typeCount;
-            this.removeComponentFromEntityByIndex_Unchecked(entityIndex, componentIndex, i);
+            this.removeComponentFromEntityByIndex_Unchecked(entity_id, componentIndex, i);
         }
 
         //dispatch event
-        this.sendEvent(entityIndex, EventType.EntityRemoved, entityIndex);
+        this.sendEvent(entity_id, EventType.EntityRemoved, entity_id);
 
         //purge all event listeners
-        delete this.__entityEventListeners[entityIndex];
-        delete this.__entityAnyEventListeners[entityIndex];
+        delete this.__entityEventListeners[entity_id];
+        delete this.__entityAnyEventListeners[entity_id];
 
-        this.entityOccupancy.set(entityIndex, false);
+        this.entityOccupancy.set(entity_id, false);
 
         this.entityCount--;
 
-        this.onEntityRemoved.send1(entityIndex);
+        this.onEntityRemoved.send1(entity_id);
     }
 
     /**
@@ -919,6 +924,7 @@ export class EntityComponentDataset {
     }
 
     /**
+     * This method doesn't perform any checks, make sure you understand what you are doing when using it
      * @private
      * @param {number} entityIndex
      * @param {number} componentIndex