@woosh/meep-engine 2.53.0 → 2.55.0

package/src/engine/ecs/speaker/VoiceSystem.js

@@ -52,25 +52,21 @@ const TIMING_MINIMUM_READ_TIME = 1.2;
 const temp_lines = [];
 
 class LineWeigher {
-    constructor() {
-
-        /**
-         *
-         * @type {number}
-         */
-        this.entity = -1;
-        /**
-         *
-         * @type {VoiceSystem}
-         */
-        this.system = null;
-
-        /**
-         *
-         * @type {number}
-         */
-        this.time = 0;
-    }
+    /**
+     *
+     * @type {number}
+     */
+    entity = -1;
+    /**
+     *
+     * @type {VoiceSystem}
+     */
+    system = null;
+    /**
+     *
+     * @type {number}
+     */
+    time = 0;
 
     /**
      *

package/src/engine/ecs/speaker/lines/LineDescription.js

@@ -1,31 +1,26 @@
 import { assert } from "../../../../core/assert.js";
 
 export class LineDescription {
-    constructor() {
-        /**
-         * Unique id
-         * @type {string}
-         */
-        this.id = "";
-
-        /**
-         * Comment about the line, useful for development purposes
-         * @type {string}
-         */
-        this.comment = "";
-
-        /**
-         * Localization key for the line of text
-         * @type {string}
-         */
-        this.text = "";
-
-        /**
-         * Time the line should be displayed on the screen before being removed, normalized value, 1 means standard, 1.5 means 50% longer
-         * @type {number}
-         */
-        this.displayDuration = 1;
-    }
+    /**
+     * Unique id
+     * @type {string}
+     */
+    id = "";
+    /**
+     * Comment about the line, useful for development purposes
+     * @type {string}
+     */
+    comment = "";
+    /**
+     * Localization key for the line of text
+     * @type {string}
+     */
+    text = "";
+    /**
+     * Time the line should be displayed on the screen before being removed, normalized value, 1 means standard, 1.5 means 50% longer
+     * @type {number}
+     */
+    displayDuration = 1;
 
     fromJSON({
                  id,

package/src/engine/ecs/speaker/lines/sets/LineSetDescription.js

@@ -1,25 +1,21 @@
 const temp_array = [];
 
 export class LineSetDescription {
-    constructor() {
-        /**
-         *
-         * @type {string}
-         */
-        this.id = "";
-
-        /**
-         *
-         * @type {LineDescription[]}
-         */
-        this.lines = [];
-
-        /**
-         *
-         * @type {LineSetDescription[]}
-         */
-        this.sets = [];
-    }
+    /**
+     *
+     * @type {string}
+     */
+    id = "";
+    /**
+     *
+     * @type {LineDescription[]}
+     */
+    lines = [];
+    /**
+     *
+     * @type {LineSetDescription[]}
+     */
+    sets = [];
 
     /**
      * Collect all lines from this set recursively

package/src/engine/ecs/storage/binary/BinaryClassSerializationAdapter.js

@@ -1,12 +1,19 @@
+/**
+ * Defines how to serialize and deserialize an instance of a given class
+ */
 export class BinaryClassSerializationAdapter {
 
     /**
+     * Class that this adapter handles
      * @protected
      * @type {Class}
      */
     klass = null;
 
     /**
+     * Format version number, used to check for format changes and data compatibility
+     * Increment the number if you change the adapter to indicate the change in format
+     * See {@link BinaryClassUpgrader} for details on how to handle support for outdated format versions
      * @protected
      * @type {number}
      */

package/src/engine/ecs/storage/binary/collection/BinaryCollectionSerializer.js

@@ -1,6 +1,6 @@
 import { assert } from "../../../../../core/assert.js";
 import { BinaryCollectionHeaderCodec, BinaryCollectionHeaderLayout } from "./BinaryCollectionHeaderCodec.js";
-import { HashMap } from "../../../../../core/collection/HashMap.js";
+import { HashMap } from "../../../../../core/collection/map/HashMap.js";
 import { returnEmptyArray } from "../../../../../core/function/Functions.js";
 
 export class BinaryCollectionSerializer {

package/src/engine/ecs/storage/binary/object/ObjectBasedClassSerializationAdapter.js

@@ -1,15 +1,12 @@
 import { BinaryClassSerializationAdapter } from "../BinaryClassSerializationAdapter.js";
 
-export class ObjectBasedClassSerializationAdapter extends BinaryClassSerializationAdapter{
-    constructor(){
-        super();
+export class ObjectBasedClassSerializationAdapter extends BinaryClassSerializationAdapter {
 
-        /**
-         *
-         * @type {BinaryObjectSerializationAdapter}
-         */
-        this.objectAdapter = null;
-    }
+    /**
+     *
+     * @type {BinaryObjectSerializationAdapter}
+     */
+    objectAdapter = null;
 
     /**
      *

package/src/engine/ecs/team/TeamSerializationAdapter.js

@@ -2,12 +2,9 @@ import { BinaryClassSerializationAdapter } from "../storage/binary/BinaryClassSe
 import Team from "./Team.js";
 
 export class TeamSerializationAdapter extends BinaryClassSerializationAdapter {
-    constructor() {
-        super();
 
-        this.klass = Team;
-        this.version = 0;
-    }
+    klass = Team;
+    version = 0;
 
     /**
      *

package/src/engine/ecs/terrain/ecs/Terrain.spec.js

@@ -0,0 +1,5 @@
+import Terrain from "./Terrain.js";
+
+test("constructor does not throw", () => {
+    new Terrain();
+});

package/src/engine/ecs/terrain/ecs/cling/ClingToTerrain.js

@@ -5,28 +5,30 @@ import Vector3 from "../../../../../core/geom/Vector3.js";
 import Quaternion from "../../../../../core/geom/Quaternion.js";
 
 class ClingToTerrain {
-    constructor({ normalAlign = false } = {}) {
-        /**
-         * @type {boolean}
-         */
-        this.normalAlign = normalAlign;
-
-        /**
-         * Used internally for caching updates
-         * @type {Vector3}
-         */
-        this.__lastPosition = new Vector3(0, 0, 0);
-        /**
-         *
-         * @type {Quaternion}
-         */
-        this.__lastRotation = new Quaternion(0, 0, 0, 1);
+    /**
+     * @type {boolean}
+     */
+    normalAlign = false;
+    /**
+     * Used internally for caching updates
+     * @type {Vector3}
+     */
+    __lastPosition=new Vector3(0, 0, 0);
+    /**
+     *
+     * @type {Quaternion}
+     */
+    __lastRotation=new Quaternion(0, 0, 0, 1);
+    /**
+     * Speed in Rad/s (Radians/second) by which rotation can change
+     * @type {number}
+     */
+    rotationSpeed = 3;
 
-        /**
-         * Speed in Rad/s (Radians/second) by which rotation can change
-         * @type {number}
-         */
-        this.rotationSpeed = 3;
+    constructor(opt) {
+        if(opt !== undefined){
+            throw new Error("constructor options deprecated");
+        }
     }
 
     toJSON() {

package/src/engine/ecs/terrain/ecs/cling/ClingToTerrainSerializationAdapter.js

@@ -2,12 +2,9 @@ import { BinaryClassSerializationAdapter } from "../../../storage/binary/BinaryC
 import ClingToTerrain from "./ClingToTerrain.js";
 
 export class ClingToTerrainSerializationAdapter extends BinaryClassSerializationAdapter {
-    constructor() {
-        super();
 
-        this.klass = ClingToTerrain;
-        this.version = 0;
-    }
+    klass = ClingToTerrain;
+    version = 0;
 
     /**
      *

package/src/engine/ecs/terrain/ecs/layers/TerrainLayers.js

@@ -19,18 +19,15 @@ import { Sampler2D } from "../../../../graphics/texture/sampler/Sampler2D.js";
 import { sampler2d_scale } from "../../../../graphics/texture/sampler/resize/sampler2d_scale.js";
 import List from "../../../../../core/collection/list/List.js";
 import { Cache } from "../../../../../core/cache/Cache.js";
-import { BinaryClassSerializationAdapter } from "../../../storage/binary/BinaryClassSerializationAdapter.js";
 import { computeStringHash } from "../../../../../core/primitives/strings/computeStringHash.js";
 import { invokeObjectEquals } from "../../../../../core/model/object/invokeObjectEquals.js";
 import { invokeObjectHash } from "../../../../../core/model/object/invokeObjectHash.js";
 import { typed_array_copy } from "../../../../../core/collection/array/typed/typed_array_copy.js";
 
 class ScaledTextureKey {
-    constructor() {
-        this.uri = '';
+    uri = '';
 
-        this.size = new Vector2();
-    }
+    size = new Vector2();
 
     /**
      *
@@ -58,41 +55,6 @@ class ScaledTextureKey {
     }
 }
 
-class ScaledTextureKeySerializationAdapter extends BinaryClassSerializationAdapter {
-    constructor() {
-        super();
-        this.klass = ScaledTextureKey;
-        this.version = 0;
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {ScaledTextureKey} value
-     */
-    serialize(buffer, value) {
-        // serialize uri
-        buffer.writeUTF8String(value.uri);
-        // serialize size
-        buffer.writeFloat64(value.size.x);
-        buffer.writeFloat64(value.size.y);
-    }
-
-    /**
-     *
-     * @param {BinaryBuffer} buffer
-     * @param {ScaledTextureKey} value
-     */
-    deserialize(buffer, value) {
-        value.uri = buffer.readUTF8String();
-
-        const size_x = buffer.readFloat64();
-        const size_y = buffer.readFloat64();
-
-        value.size.set(size_x, size_y);
-    }
-}
-
 /**
  *
  * @type {Cache<ScaledTextureKey,Sampler2D>}

package/src/engine/ecs/terrain/overlay/TerrainOverlay.spec.js

@@ -0,0 +1,6 @@
+import { TerrainOverlay } from "./TerrainOverlay.js";
+import Vector2 from "../../../../core/geom/Vector2.js";
+
+test("constructor does not throw", () => {
+    new TerrainOverlay(new Vector2(1, 1))
+});

package/src/engine/ecs/terrain/serialization/TerrainSerializationAdapter.js

@@ -7,18 +7,15 @@ import { objectKeyByValue } from "../../../../core/model/object/objectKeyByValue
 import { TerrainFlags } from "../ecs/TerrainFlags.js";
 
 export class TerrainSerializationAdapter extends BinaryClassSerializationAdapter {
-    constructor() {
-        super();
 
-        this.klass = Terrain;
-        this.version = 2;
+    klass = Terrain;
+    version = 2;
 
-        /**
-         *
-         * @type {TerrainSystem}
-         */
-        this.system = null;
-    }
+    /**
+     *
+     * @type {TerrainSystem}
+     */
+    system = null;
 
     initialize(system) {
         this.system = system;

package/src/engine/ecs/terrain/tiles/TerrainTile.js

@@ -33,98 +33,101 @@ import { passThrough } from "../../../../core/function/Functions.js";
  * terrain tile is a part of a 2d array
  */
 class TerrainTile {
-    constructor() {
-        this.gridPosition = new Vector2();
-        this.scale = new Vector2(1, 1);
-        this.size = new Vector2();
-        this.position = new Vector2();
-        this.resolution = new ObservedInteger(1);
+    gridPosition = new Vector2();
+    scale = new Vector2(1, 1);
+    size = new Vector2();
+    position = new Vector2();
+    resolution = new ObservedInteger(1);
 
-        /**
-         *
-         * @type {Material}
-         */
-        this.material = null;
-        this.mesh = ThreeFactory.createMesh();
+    /**
+     *
+     * @type {Material}
+     */
+    material = null;
+    mesh = ThreeFactory.createMesh();
 
-        this.mesh.name = "TerrainTile";
 
-        /**
-         * Terrain mesh is static, it never changes its transform. Updates are wasteful.
-         * @type {boolean}
-         */
-        this.mesh.matrixWorldNeedsUpdate = false;
+    /**
+     *
+     * @type {THREE.BufferGeometry}
+     */
+    geometry = null;
 
-        /**
-         *
-         * @type {THREE.BufferGeometry}
-         */
-        this.geometry = null;
+    /**
+     *
+     * @type {boolean}
+     */
+    enableBVH = true;
 
-        /**
-         *
-         * @type {boolean}
-         */
-        this.enableBVH = true;
+    /**
+     *
+     * @type {LeafNode}
+     */
+    boundingBox = new LeafNode(this);
 
-        /**
-         *
-         * @type {LeafNode}
-         */
-        this.boundingBox = new LeafNode(this);
+    /**
+     *
+     * @type {BinaryNode}
+     */
+    bvh = null;
 
-        /**
-         *
-         * @type {BinaryNode}
-         */
-        this.bvh = null;
+    /**
+     *
+     * @type {boolean}
+     */
+    isBuilt = false;
+    /**
+     *
+     * @type {boolean}
+     */
+    isBuildInProgress = false;
+    referenceCount = 0;
 
-        /**
-         *
-         * @type {boolean}
-         */
-        this.isBuilt = false;
-        /**
-         *
-         * @type {boolean}
-         */
-        this.isBuildInProgress = false;
-        this.referenceCount = 0;
+    /**
+     *
+     * @type {Signal<TerrainTile>}
+     */
+    onBuilt = new Signal();
+    onDestroyed = new Signal();
 
-        /**
-         *
-         * @type {Signal<TerrainTile>}
-         */
-        this.onBuilt = new Signal();
-        this.onDestroyed = new Signal();
+    /**
+     * Encodes whether stitching has been performed on per-neighbour basis
+     * @private
+     * @type {{bottomLeft: boolean, top: boolean, left: boolean, bottom: boolean, bottomRight: boolean, topLeft: boolean, topRight: boolean, right: boolean}}
+     */
+    stitching = {
+        top: false,
+        bottom: false,
+        left: false,
+        right: false,
 
-        /**
-         * Encodes whether stitching has been performed on per-neighbour basis
-         * @private
-         * @type {{bottomLeft: boolean, top: boolean, left: boolean, bottom: boolean, bottomRight: boolean, topLeft: boolean, topRight: boolean, right: boolean}}
-         */
-        this.stitching = {
-            top: false,
-            bottom: false,
-            left: false,
-            right: false,
+        topLeft: false,
+        topRight: false,
+
+        bottomLeft: false,
+        bottomRight: false
+    };
 
-            topLeft: false,
-            topRight: false,
+    /**
+     * Initial estimate of height bounds for this tile
+     * Untransformed by transform matrix
+     * @type {NumericInterval}
+     * @private
+     */
+    __initial_height_range = new NumericInterval(Number.NEGATIVE_INFINITY, Number.POSITIVE_INFINITY);
 
-            bottomLeft: false,
-            bottomRight: false
-        };
+    raycaster = new BVHGeometryRaycaster();
+
+    constructor() {
+
+        this.mesh.name = "TerrainTile";
 
         /**
-         * Initial estimate of height bounds for this tile
-         * Untransformed by transform matrix
-         * @type {NumericInterval}
-         * @private
+         * Terrain mesh is static, it never changes its transform. Updates are wasteful.
+         * @type {boolean}
          */
-        this.__initial_height_range = new NumericInterval(Number.NEGATIVE_INFINITY, Number.POSITIVE_INFINITY);
+        this.mesh.matrixWorldNeedsUpdate = false;
 
-        this.raycaster = new BVHGeometryRaycaster();
         //Binary BVH form doesn't have distinct leaf objects and stores face indices directly, this requires a special face index extractor that treats leaves as indices directly.
         this.raycaster.extractFaceIndexFromLeaf = passThrough;
     }

package/src/engine/ecs/terrain/tiles/TerrainTile.spec.js

@@ -0,0 +1,25 @@
+import TerrainTile from "./TerrainTile.js";
+import { MATRIX_4_IDENTITY } from "../../../../core/geom/3d/matrix/MATRIX_4_IDENTITY.js";
+
+test("constructor does not throw", () => {
+    new TerrainTile();
+});
+
+test("get/set transform", () => {
+
+    const tile = new TerrainTile();
+    tile.setInitialHeightBounds(1, 7);
+
+    tile.transform = MATRIX_4_IDENTITY;
+
+    expect(Array.from(tile.transform)).toEqual(Array.from(MATRIX_4_IDENTITY));
+
+});
+
+test("using 'dispose' method on newly created tile", () => {
+
+    const tile = new TerrainTile();
+
+    expect(() => tile.dispose()).not.toThrow();
+    
+});

package/src/engine/ecs/tooltip/TooltipComponent.spec.js

@@ -0,0 +1,47 @@
+import { TooltipComponent } from "./TooltipComponent.js";
+
+test("constructor does not throw", () => {
+    new TooltipComponent()
+});
+
+test("to/from JSON", () => {
+
+    const source = new TooltipComponent();
+
+    source.key = "x";
+
+    const destination = new TooltipComponent();
+
+    destination.fromJSON(source.toJSON());
+
+    expect(destination.equals(source)).toBe(true);
+});
+
+test("equals", () => {
+
+    const a = new TooltipComponent();
+
+    a.key = "x";
+
+    const b = new TooltipComponent();
+
+    b.key = "a";
+
+    expect(a.equals(b)).toBe(false);
+
+    b.key = "x";
+
+    expect(a.equals(b)).toBe(true);
+});
+
+test("hash", () => {
+    const tip = new TooltipComponent();
+
+    tip.key = "x";
+
+    const hash = tip.hash();
+
+    expect(tip.hash()).toEqual(hash);
+    expect(typeof hash).toEqual("number");
+    expect(Number.isInteger(hash)).toBe(true);
+});

package/src/engine/ecs/tooltip/TooltipComponentSerializationAdapter.js

@@ -2,12 +2,9 @@ import { BinaryClassSerializationAdapter } from "../storage/binary/BinaryClassSe
 import { TooltipComponent } from "./TooltipComponent.js";
 
 export class TooltipComponentSerializationAdapter extends BinaryClassSerializationAdapter {
-    constructor() {
-        super();
 
-        this.klass = TooltipComponent;
-        this.version = 0;
-    }
+    klass = TooltipComponent;
+    version = 0;
 
     /**
      *