@woosh/meep-engine 2.54.0 → 2.56.0

package/src/core/model/ObservedInteger.js

@@ -2,17 +2,24 @@ import { assert } from "../assert.js";
 import Signal from "../events/signal/Signal.js";
 
 class ObservedInteger extends Number {
+    /**
+     * @readonly
+     * @type {Signal}
+     */
+    onChanged = new Signal();
+
     /**
      *
-     * @param {Number} value
+     * @param {Number} [value]
      * @constructor
      */
-    constructor(value) {
+    constructor(value = 0) {
         super();
 
-        assert.equal(typeof value, "number", `Value must be of type "number", instead was "${typeof value}"`);
+        assert.isNumber(value, 'value');
         assert.ok(Number.isInteger(value) || !Number.isFinite(value), `Value must be an integer, instead was ${value}`);
 
+
         /**
          *
          * @type {Number}
@@ -20,7 +27,6 @@ class ObservedInteger extends Number {
          */
         this.__value = value;
 
-        this.onChanged = new Signal();
     }
 
     /**
@@ -41,7 +47,7 @@ class ObservedInteger extends Number {
      * @returns {ObservedInteger}
      */
     set(value) {
-        assert.equal(typeof value, "number", `Value must be of type "number", instead was "${typeof value}"`);
+        assert.isNumber(value, 'value');
         assert.ok(Number.isInteger(value) || !Number.isFinite(value), `Value must be an integer, instead was ${value}`);
 
         const oldValue = this.__value;
@@ -58,8 +64,7 @@ class ObservedInteger extends Number {
      * @param {number} value
      */
     setSilent(value) {
-
-        assert.equal(typeof value, "number", `Value must be of type "number", instead was "${typeof value}"`);
+        assert.isNumber(value, 'value');
         assert.ok(Number.isInteger(value) || !Number.isFinite(value), `Value must be an integer, instead was ${value}`);
 
         this.__value = value;

package/src/core/model/ObservedString.js

@@ -10,13 +10,13 @@ import { computeStringHash } from "../primitives/strings/computeStringHash.js";
 class ObservedString extends String {
     /**
      *
-     * @param {String} value
+     * @param {String} [value]
      * @constructor
      */
-    constructor(value) {
+    constructor(value = "") {
         super();
 
-        assert.equal(typeof value, "string", `Value must be of type "string", instead was "${typeof value}"`);
+        assert.isString(value, 'value');
 
         /**
          *
@@ -26,11 +26,6 @@ class ObservedString extends String {
         this.__value = value;
 
         this.onChanged = new Signal();
-        /**
-         * Used for optimized "instanceof" check
-         * @type {boolean}
-         */
-        this.isObservedString = true;
     }
 
     /**
@@ -133,4 +128,11 @@ class ObservedString extends String {
     }
 }
 
+/**
+ * Used for optimized "instanceof" check
+ * @readonly
+ * @type {boolean}
+ */
+ObservedString.prototype.isObservedString = true;
+
 export default ObservedString;

package/src/core/model/node-graph/visual/NodeGraphVisualData.js

@@ -1,5 +1,5 @@
 import { assert } from "../../../assert.js";
-import { HashMap } from "../../../collection/HashMap.js";
+import { HashMap } from "../../../collection/map/HashMap.js";
 import { Color } from "../../../color/Color.js";
 import { BoxLayoutSpec } from "./layout/BoxLayoutSpec.js";
 import { ConnectedBoxLayouter } from "./layout/ConnectedBoxLayouter.js";

package/src/core/model/object/ImmutableObjectPool.js

@@ -1,5 +1,5 @@
 import { CacheElement } from "../../cache/CacheElement.js";
-import { HashMap } from "../../collection/HashMap.js";
+import { HashMap } from "../../collection/map/HashMap.js";
 
 /**
  * @template Key, Value

package/src/core/model/object/read_property.js

@@ -1,4 +1,4 @@
-import { capitalize } from "../../primitives/strings/StringUtils.js";
+import { string_capitalize } from "../../primitives/strings/string_capitalize.js";
 
 /**
  * @template T
@@ -19,7 +19,7 @@ export function read_property(root, parts, part_offset, part_count) {
         if (typeof thing[part] !== 'undefined') {
             thing = thing[part];
         } else {
-            const getter_name = `get${capitalize(part)}`;
+            const getter_name = `get${string_capitalize(part)}`;
             const getter = thing[getter_name];
 
             if (typeof getter === "function") {

package/src/core/model/object/write_property.js

@@ -1,4 +1,4 @@
-import { capitalize } from "../../primitives/strings/StringUtils.js";
+import { string_capitalize } from "../../primitives/strings/string_capitalize.js";
 
 /**
  * @template T
@@ -23,7 +23,7 @@ export function write_property(root, parts, part_offset, part_count, value) {
             thing = thing_part;
         } else {
 
-            const getter_name = `get${capitalize(part)}`;
+            const getter_name = `get${string_capitalize(part)}`;
             const getter = thing[getter_name];
 
             if (typeof getter === "function") {
@@ -38,7 +38,7 @@ export function write_property(root, parts, part_offset, part_count, value) {
 
     const last_part = parts[last_index];
 
-    const setter_name = `set${capitalize(last_part)}`;
+    const setter_name = `set${string_capitalize(last_part)}`;
     const setter = thing[setter_name];
 
     if (typeof setter === "function") {

package/src/core/model/reactive/evaluation/MultiPredicateEvaluator.js

@@ -1,6 +1,6 @@
 import { assert } from "../../../assert.js";
 import { BitSet } from "../../../binary/BitSet.js";
-import { HashMap } from "../../../collection/HashMap.js";
+import { HashMap } from "../../../collection/map/HashMap.js";
 import { max2 } from "../../../math/max2.js";
 import DataType from "../../../parser/simple/DataType.js";
 

package/src/core/primitives/numbers/compareNumbers.js

@@ -1,9 +1,9 @@
+import { number_compare_ascending } from "./number_compare_ascending.js";
+
 /**
- *
+ * @deprecated use {@link number_compare_ascending} directly
  * @param {number} a
  * @param {number} b
  * @returns {number}
  */
-export function compareNumbers(a, b) {
-    return a - b;
-}
+export const compareNumbers = number_compare_ascending;

package/src/core/primitives/numbers/number_compare_ascending.js

@@ -0,0 +1,9 @@
+/**
+ *
+ * @param {number} a
+ * @param {number} b
+ * @return {number}
+ */
+export function number_compare_ascending(a, b) {
+    return a - b;
+}

package/src/core/primitives/numbers/number_compare_ascending.spec.js

@@ -0,0 +1,9 @@
+import { number_compare_ascending } from "./number_compare_ascending.js";
+
+test("basics", () => {
+
+    expect([1, 2].sort(number_compare_ascending)).toEqual([1, 2]);
+
+    expect([2, 1].sort(number_compare_ascending)).toEqual([1, 2]);
+
+});

package/src/core/primitives/numbers/number_compare_descending.js

@@ -0,0 +1,9 @@
+/**
+ *
+ * @param {number} a
+ * @param {number} b
+ * @return {number}
+ */
+export function number_compare_descending(a, b) {
+    return b - a;
+}

package/src/core/primitives/numbers/number_compare_descending.spec.js

@@ -0,0 +1,9 @@
+import { number_compare_descending } from "./number_compare_descending.js";
+
+test("basics", () => {
+
+    expect([2, 1].sort(number_compare_descending)).toEqual([2, 1]);
+
+    expect([1, 2].sort(number_compare_descending)).toEqual([2, 1]);
+
+});

package/src/core/primitives/numbers/number_format_by_thousands.spec.js

@@ -0,0 +1,12 @@
+import { number_format_by_thousands } from "./number_format_by_thousands.js";
+
+test("basics", () => {
+
+    expect(number_format_by_thousands(0, ',')).toEqual("0");
+    expect(number_format_by_thousands(987, ',')).toEqual("987");
+    expect(number_format_by_thousands(1234, ',')).toEqual("1,234");
+    expect(number_format_by_thousands(987654321, ',')).toEqual("987,654,321");
+
+    // different separator
+    expect(number_format_by_thousands(1234, ' -> ')).toEqual("1 -> 234");
+});

package/src/core/primitives/numbers/number_pretty_print.js

@@ -29,7 +29,7 @@ function countDecimals(value) {
 /**
  *
  * @param {number} value
- * @returns {string|number}
+ * @returns {string}
  */
 export function number_pretty_print(value) {
     assert.isNumber(value, 'value');

package/src/core/primitives/strings/compareStrings.spec.js

@@ -0,0 +1,12 @@
+import { compareStrings } from "./compareStrings.js";
+
+test("stability", () => {
+
+    const array_a = ["a", undefined, "test", null, ""];
+    const array_b = [null, undefined, "", "a", "test"];
+
+    array_a.sort(compareStrings);
+    array_b.sort(compareStrings);
+
+    expect(array_a).toEqual(array_b);
+});

package/src/core/primitives/strings/string_capitalize.js

@@ -0,0 +1,15 @@
+/**
+ * Turn first letter in the string to capital
+ * @example "text" will become "Text"
+ * @param {string} string
+ * @returns {string}
+ */
+export function string_capitalize(string) {
+    const length = string.length;
+
+    if (length === 0) {
+        return string;
+    } else {
+        return string.charAt(0).toLocaleUpperCase() + string.substring(1);
+    }
+}

package/src/core/primitives/strings/string_capitalize.spec.js

@@ -0,0 +1,13 @@
+import { string_capitalize } from "./string_capitalize.js";
+
+test("capitalize", () => {
+    expect(string_capitalize("")).toBe("");
+
+    expect(string_capitalize("a")).toBe("A");
+
+    expect(string_capitalize("A")).toBe("A");
+
+    expect(string_capitalize("aa")).toBe("Aa");
+
+    expect(string_capitalize("AA")).toBe("AA");
+});

package/src/core/primitives/strings/string_compute_byte_size.js

@@ -0,0 +1,21 @@
+/**
+ * Compute byte size of a UTF8 string
+ * @param {string} value
+ * @returns {number}
+ */
+export function string_compute_byte_size(value) {
+    const length = value.length;
+
+    let p = 0;
+
+    for (let i = 0; i < length; i++) {
+        let c = value.charCodeAt(i);
+        while (c > 0xff) {
+            p++;
+            c >>= 8;
+        }
+        p++;
+    }
+
+    return p;
+}

package/src/core/primitives/strings/string_compute_common_prefix.js

@@ -0,0 +1,44 @@
+/**
+ * @example: ['abra', 'abc', 'abode'] => 'ab'
+ * @param {String[]} strings
+ * @returns string
+ */
+export function string_compute_common_prefix(strings) {
+    let i, j;
+
+    const numInputs = strings.length;
+
+    let result = "";
+
+    if (numInputs === 0) {
+        return result;
+    }
+
+    const firstString = strings[0];
+
+    let lengthLimit = firstString.length;
+
+    for (i = 1; i < numInputs; i++) {
+        lengthLimit = Math.min(strings[i].length, lengthLimit);
+    }
+
+
+    main_loop:for (i = 0; i < lengthLimit; i++) {
+        const letter0 = firstString.charAt(i);
+
+        for (j = 1; j < numInputs; j++) {
+
+            const string = strings[j];
+
+            const letter1 = string.charAt(i);
+
+            if (letter0 !== letter1) {
+                break main_loop;
+            }
+        }
+
+        result += letter0;
+    }
+
+    return result;
+}

package/src/core/primitives/strings/string_compute_common_prefix.spec.js

@@ -0,0 +1,23 @@
+import { string_compute_common_prefix } from "./string_compute_common_prefix.js";
+
+test("common prefix", () => {
+    expect(string_compute_common_prefix([])).toBe("");
+
+    expect(string_compute_common_prefix([""])).toBe("");
+
+    expect(string_compute_common_prefix(["a"])).toBe("a");
+
+    expect(string_compute_common_prefix(["abc"])).toBe("abc");
+
+    expect(string_compute_common_prefix(["aa"])).toBe("aa");
+
+    expect(string_compute_common_prefix(["aa", "ab"])).toBe("a");
+
+    expect(string_compute_common_prefix(["abc", "abb"])).toBe("ab");
+
+    expect(string_compute_common_prefix(["abc", "abc"])).toBe("abc");
+
+    expect(string_compute_common_prefix(["abc", "abc", "a"])).toBe("a");
+
+    expect(string_compute_common_prefix(["abc", "abc", ""])).toBe("");
+});

package/src/core/primitives/strings/string_format_camel_to_kebab.js

@@ -0,0 +1,9 @@
+/**
+ * Convert camelCaseString to kebab-format-string
+ * useful for resolving CSS property names
+ * @param {string} string
+ * @returns {string}
+ */
+export function string_format_camel_to_kebab(string) {
+    return string.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+}

package/src/core/primitives/strings/string_format_camel_to_kebab.spec.js

@@ -0,0 +1,8 @@
+import { string_format_camel_to_kebab } from "./string_format_camel_to_kebab.js";
+
+test('camelToKebab', () => {
+    expect(string_format_camel_to_kebab('a')).toBe('a');
+    expect(string_format_camel_to_kebab('aA')).toBe('a-a');
+    expect(string_format_camel_to_kebab('helloWoRLD')).toBe('hello-wo-rld');
+    expect(string_format_camel_to_kebab('A')).toBe('a');
+});

package/src/core/primitives/strings/string_format_kebab_to_underscore.js

@@ -0,0 +1,8 @@
+/**
+ * Convert kebab-format-string to underscore_format_string
+ * @param {string} string
+ * @returns {string}
+ */
+export function string_format_kebab_to_underscore(string) {
+    return string.replace('-', '_');
+}

package/src/core/time/current_time_in_seconds.js

@@ -0,0 +1,11 @@
+
+//Use highest available resolution time source
+const source = typeof performance === "undefined" ? Date : performance;
+
+/**
+ * Current time in seconds
+ * @returns {number}
+ */
+export function current_time_in_seconds() {
+    return source.now() * 1e-3;
+}

package/src/engine/Clock.js

@@ -4,24 +4,14 @@
 
 
 import Stat from "../core/model/stat/Stat.js";
-
-//Use highest available resolution time source
-const source = typeof performance === "undefined" ? Date : performance;
-
-/**
- *
- * @returns {number}
- */
-export function currentTimeInSeconds() {
-    return source.now() * 0.001;
-}
+import { current_time_in_seconds } from "../core/time/current_time_in_seconds.js";
 
 /**
  *
  * @param {Clock} clock
  */
 function updateElapsedTime(clock) {
-    const now = currentTimeInSeconds();
+    const now = current_time_in_seconds();
     const delta = (now - clock.__lastMeasurement) * clock.speed;
     clock.__lastMeasurement = now;
     clock.elapsedTime += delta;
@@ -79,7 +69,7 @@ class Clock {
     }
 
     start() {
-        this.__lastMeasurement = currentTimeInSeconds();
+        this.__lastMeasurement = current_time_in_seconds();
         this.timeAtDelta = this.updateElapsedTime();
         this.__isRunning = true;
     }

package/src/engine/animation/curve/AnimationCurve.spec.js

@@ -46,6 +46,19 @@ test("removing exising key", () => {
     expect(curve.length).toBe(0);
 });
 
+test("evaluate on empty curve", () => {
+    const curve = new AnimationCurve();
+
+    expect(curve.evaluate(0)).toBe(0);
+});
+
+test("evaluate before first frame", () => {
+    const curve = new AnimationCurve();
+
+    curve.add(Keyframe.from(1, 7));
+
+    expect(curve.evaluate(0.9)).toEqual(7);
+});
 
 test("sample linear curve with 2 points", () => {
     const curve = new AnimationCurve();
@@ -78,6 +91,20 @@ test("smooth tangents with a single keyframe does not throw", () => {
 
     expect(() => curve.smoothTangents(0, 1)).not.toThrow()
 });
+test("smooth tangents on a middle frame", () => {
+    const curve = new AnimationCurve();
+
+    curve.add(Keyframe.from(0, 1));
+    curve.add(Keyframe.from(1, 2));
+    curve.add(Keyframe.from(2, 3));
+
+    curve.smoothTangents(1, 1);
+
+    const key = curve.keys[1];
+
+    expect(key.inTangent).toEqual(key.outTangent);
+});
+
 
 test("to/from JSON consistency", () => {
 

package/src/engine/asset/AssetManager.js

@@ -3,13 +3,12 @@
  */
 
 
-import { ObservedMap } from "../../core/collection/ObservedMap.js";
-import { HashMap } from "../../core/collection/HashMap.js";
+import { ObservedMap } from "../../core/collection/map/ObservedMap.js";
+import { HashMap } from "../../core/collection/map/HashMap.js";
 import { extractAssetListFromManager } from "./preloader/extractAssetListFromManager.js";
 import { assert } from "../../core/assert.js";
-import { HashSet } from "../../core/collection/HashSet.js";
+import { HashSet } from "../../core/collection/set/HashSet.js";
 import { CrossOriginConfig } from "./CORS/CrossOriginConfig.js";
-import { array_remove_element } from "../../core/collection/array/array_remove_element.js";
 import { AssetDescription } from "./AssetDescription.js";
 import { noop } from "../../core/function/Functions.js";
 import { Deque } from "../../core/collection/queue/Deque.js";
@@ -23,6 +22,7 @@ import ConcurrentExecutor from "../../core/process/executor/ConcurrentExecutor.j
 import { AssetLoader } from "./loaders/AssetLoader.js";
 import { array_push_if_unique } from "../../core/collection/array/array_push_if_unique.js";
 import { AssetRequestScope } from "./AssetRequestScope.js";
+import { array_remove_first } from "../../core/collection/array/array_remove_first.js";
 
 
 class Response {
@@ -701,7 +701,7 @@ export class AssetManager {
             return false;
         }
 
-        if (!array_remove_element(transformers, 0, transformers.length, transformer)) {
+        if (!array_remove_first(transformers, transformer)) {
             // not found
             return false;
         }

package/src/engine/asset/loaders/GLTFAssetLoader.js

@@ -20,7 +20,7 @@ import { CrossOriginKind } from "../CORS/CrossOriginKind.js";
 import { computeObjectBoundingSphere } from "./gltf/computeObjectBoundingSphere.js";
 import { isMesh } from "./gltf/isMesh.js";
 import { DRACOLoader } from "three/examples/jsm/loaders/DRACOLoader.js";
-import { HashSet } from "../../../core/collection/HashSet.js";
+import { HashSet } from "../../../core/collection/set/HashSet.js";
 import { computeGeometryHash } from "../../graphics/geometry/buffered/computeGeometryHash.js";
 import { computeGeometryEquality } from "../../graphics/geometry/buffered/computeGeometryEquality.js";
 import { traverseThreeObject } from "../../graphics/ecs/highlight/renderer/traverseThreeObject.js";

package/src/engine/ecs/EntityBlueprint.js

@@ -59,13 +59,11 @@ function populateJsonTemplate(template, seed) {
  * @class
  */
 export class EntityBlueprint {
-    constructor() {
-        /**
-         *
-         * @type {Map<Class, Object>}
-         */
-        this.componentnts = new Map();
-    }
+    /**
+     * @private
+     * @type {Map<Class, Object>}
+     */
+    #components = new Map();
 
     /**
      *
@@ -95,7 +93,7 @@ export class EntityBlueprint {
     }
 
     clear() {
-        this.componentnts.clear();
+        this.#components.clear();
     }
 
     /**
@@ -104,7 +102,7 @@ export class EntityBlueprint {
      * @param {Object} json
      */
     addJSON(klass, json) {
-        this.componentnts.set(klass, json);
+        this.#components.set(klass, json);
     }
 
     /**
@@ -148,7 +146,7 @@ export class EntityBlueprint {
     build(templateSeed) {
         const eb = new EntityBuilder();
 
-        this.componentnts.forEach((template, ComponentClass) => {
+        this.#components.forEach((template, ComponentClass) => {
             const component = new ComponentClass();
 
             const json = populateJsonTemplate(template, templateSeed);

package/src/engine/ecs/EntityManager.js

@@ -202,7 +202,7 @@ EntityManager.prototype.detachDataSet = function () {
 };
 
 /**
- *
+ * Get list of all components referenced by active systems
  * @returns {Class[]}
  */
 EntityManager.prototype.getComponentTypeMap = function () {
@@ -237,6 +237,12 @@ EntityManager.prototype.getComponentTypeMap = function () {
 EntityManager.prototype.attachDataSet = function (dataset) {
     //check if another dataset is attached
     if (this.dataset !== null) {
+
+        if (this.dataset === dataset) {
+            // special case, we already have this dataset attached. Nothing to more to do
+            return;
+        }
+
         throw new Error("Illegal status, another dataset is currently attached");
     }
 
@@ -285,6 +291,7 @@ EntityManager.prototype.getSystem = function (systemClass) {
 
 
 /**
+ * @deprecated use {@link EntityComponentDataset.getComponentClassByName} instead
  * @template T
  * @param {string} className
  * @returns {null|Class<T>}