@woosh/meep-engine 3.3.0 → 3.4.0

package/src/view/interaction/createInterfaceCommandButton.js

@@ -1,124 +1,115 @@
-import { createSound } from "../../engine/EntityCreator.js";
-import { SoundEmitterChannels } from "../../engine/sound/ecs/emitter/SoundEmitterSystem.js";
-import ButtonView from "../elements/button/ButtonView.js";
-import { globalMetrics } from "../../engine/metrics/GlobalMetrics.js";
-import { MetricsCategory } from "../../engine/metrics/MetricsCategory.js";
-
-/**
- *
- * @param {InterfaceCommand} command
- * @param {GUIEngine} gui
- * @param {EntityComponentDataset} ecd
- * @returns {View}
- */
-export function createInterfaceCommandButton({
-                                                 command,
-                                                 gui,
-                                                 ecd
-                                             }) {
-
-    /**
-     *
-     * @type {InteractionCommand}
-     */
-    const interaction = command.command;
-
-    /**
-     *
-     * @param {SoundTrack} sound
-     */
-    function playSound(sound) {
-        if (sound === null) {
-            return;
-        }
-
-        createSound({
-            timeout: 5,
-            track: sound,
-            positioned: false,
-            channel: SoundEmitterChannels.Effects
-        }).build(ecd);
-
-        // track.on.ended.add(console.log);
-    }
-
-    const button = new ButtonView({
-        action() {
-            if (interaction.enabled.getValue()) {
-                interaction.action();
-
-                playSound(command.actionSound);
-
-                globalMetrics.record("command-used", {
-                    category: MetricsCategory.Interaction,
-                    label: interaction.id
-                });
-            }
-        },
-        classList: [
-            `command-${interaction.id}`
-        ],
-        css: command.style
-    });
-
-    button.el.addEventListener('mouseenter', () => {
-
-        if (interaction.enabled.getValue()) {
-            //only play the sound if the button is enabled
-            playSound(command.hoverSound);
-        }
-    });
-
-
-    function updateEnableStatus() {
-        const v = interaction.enabled.getValue();
-
-        button.enabled = v;
-    }
-
-    function featureClassName(f) {
-        return "feature-" + f;
-    }
-
-    function addCommandFeature(f) {
-        button.addClass(featureClassName(f));
-    }
-
-    function removeCommandFeature(f) {
-        button.removeClass(featureClassName(f));
-    }
-
-    if (interaction.features !== undefined) {
-        interaction.features.forEach(addCommandFeature);
-        interaction.features.on.added.add(addCommandFeature);
-        interaction.features.on.removed.add(removeCommandFeature);
-    }
-
-    button.bindSignal(interaction.enabled.onChanged, updateEnableStatus);
-    button.bindSignal(interaction.features.on.added, addCommandFeature);
-    button.bindSignal(interaction.features.on.removed, removeCommandFeature);
-
-    function tooltipFactory() {
-        return gui.localization.getString(command.tooltip);
-    }
-
-    if (command.tooltip !== undefined) {
-        gui.viewTooltips.manage(button, tooltipFactory);
-    }
-
-    button.on.linked.add(() => {
-        interaction.features.forEach(addCommandFeature);
-        updateEnableStatus();
-    });
-
-    button.on.unlinked.add(() => {
-        interaction.features.forEach(removeCommandFeature);
-    });
-
-
-    command.tags.forEach(tag => {
-        button.addClass(`tag-${tag}`);
-    });
-
-    return button;
-}
+import { createSound } from "../../engine/EntityCreator.js";
+import ButtonView from "../elements/button/ButtonView.js";
+import { globalMetrics } from "../../engine/metrics/GlobalMetrics.js";
+import { MetricsCategory } from "../../engine/metrics/MetricsCategory.js";
+
+/**
+ *
+ * @param {InterfaceCommand} command
+ * @param {GUIEngine} gui
+ * @param {EntityComponentDataset} ecd
+ * @returns {View}
+ */
+export function createInterfaceCommandButton({
+                                                 command,
+                                                 gui,
+                                                 ecd
+                                             }) {
+
+    /**
+     *
+     * @type {InteractionCommand}
+     */
+    const interaction = command.command;
+
+    /**
+     * @param {EventDescription|null} sound authored event — it carries its own bus and spatialization
+     */
+    function playSound(sound) {
+        if (sound === null) {
+            return;
+        }
+
+        createSound({ timeout: 5, event: sound }).build(ecd);
+    }
+
+    const button = new ButtonView({
+        action() {
+            if (interaction.enabled.getValue()) {
+                interaction.action();
+
+                playSound(command.actionSound);
+
+                globalMetrics.record("command-used", {
+                    category: MetricsCategory.Interaction,
+                    label: interaction.id
+                });
+            }
+        },
+        classList: [
+            `command-${interaction.id}`
+        ],
+        css: command.style
+    });
+
+    button.el.addEventListener('mouseenter', () => {
+
+        if (interaction.enabled.getValue()) {
+            //only play the sound if the button is enabled
+            playSound(command.hoverSound);
+        }
+    });
+
+
+    function updateEnableStatus() {
+        const v = interaction.enabled.getValue();
+
+        button.enabled = v;
+    }
+
+    function featureClassName(f) {
+        return "feature-" + f;
+    }
+
+    function addCommandFeature(f) {
+        button.addClass(featureClassName(f));
+    }
+
+    function removeCommandFeature(f) {
+        button.removeClass(featureClassName(f));
+    }
+
+    if (interaction.features !== undefined) {
+        interaction.features.forEach(addCommandFeature);
+        interaction.features.on.added.add(addCommandFeature);
+        interaction.features.on.removed.add(removeCommandFeature);
+    }
+
+    button.bindSignal(interaction.enabled.onChanged, updateEnableStatus);
+    button.bindSignal(interaction.features.on.added, addCommandFeature);
+    button.bindSignal(interaction.features.on.removed, removeCommandFeature);
+
+    function tooltipFactory() {
+        return gui.localization.getString(command.tooltip);
+    }
+
+    if (command.tooltip !== undefined) {
+        gui.viewTooltips.manage(button, tooltipFactory);
+    }
+
+    button.on.linked.add(() => {
+        interaction.features.forEach(addCommandFeature);
+        updateEnableStatus();
+    });
+
+    button.on.unlinked.add(() => {
+        interaction.features.forEach(removeCommandFeature);
+    });
+
+
+    command.tags.forEach(tag => {
+        button.addClass(`tag-${tag}`);
+    });
+
+    return button;
+}

package/src/engine/ecs/components/Timer.d.ts

@@ -1,50 +0,0 @@
-export default Timer;
-/**
- * @deprecated entirely superseded by the {@link BehaviorSystem}, prefer using a {@link DelayBehavior} instead
- */
-declare class Timer {
-    /**
-     *
-     * @param {EntityComponentDataset} ecd
-     * @param {number} timeout
-     * @returns {Promise}
-     */
-    static createTimeoutPromise(ecd: EntityComponentDataset, timeout: number): Promise<any>;
-    /**
-     *
-     * @param options
-     * @constructor
-     * @property {number} repeat
-     * @property {number} timeout
-     * @property {Array.<function>} actions
-     * @property {boolean} active
-     */
-    constructor(options?: {});
-    /**
-     *
-     * @type {boolean}
-     */
-    active: boolean;
-    /**
-     *
-     * @type {number}
-     */
-    ticks: number;
-    /**
-     * represents current time elapsed in a cycle, always less than timeout value
-     * @type {number}
-     */
-    counter: number;
-    repeat: any;
-    timeout: any;
-    /**
-     *
-     * @type {Function[]}
-     */
-    actions: Function[];
-}
-declare namespace Timer {
-    let typeName: string;
-    let serializable: boolean;
-}
-//# sourceMappingURL=Timer.d.ts.map

package/src/engine/ecs/components/Timer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Timer.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/components/Timer.js"],"names":[],"mappings":";AAEA;;GAEG;AACH;IAuCI;;;;;OAKG;IACH,kEAHW,MAAM,gBA0BhB;IAjDD;;;;;;;;OAQG;IACH,0BASC;IApCD;;;OAGG;IACH,QAFU,OAAO,CAEH;IAEd;;;OAGG;IACH,OAFU,MAAM,CAEN;IAEV;;;OAGG;IACH,SAFU,MAAM,CAEJ;IAYR,YAA4D;IAC5D,aAA8B;IAE9B;;;OAGG;IACH,SAFU,UAAU,CAEgB;CAiC3C"}

package/src/engine/ecs/components/Timer.js

@@ -1,80 +0,0 @@
-
-
-/**
- * @deprecated entirely superseded by the {@link BehaviorSystem}, prefer using a {@link DelayBehavior} instead
- */
-class Timer {
-    /**
-     *
-     * @type {boolean}
-     */
-    active = true;
-
-    /**
-     *
-     * @type {number}
-     */
-    ticks = 0;
-
-    /**
-     * represents current time elapsed in a cycle, always less than timeout value
-     * @type {number}
-     */
-    counter = 0;
-
-    /**
-     *
-     * @param options
-     * @constructor
-     * @property {number} repeat
-     * @property {number} timeout
-     * @property {Array.<function>} actions
-     * @property {boolean} active
-     */
-    constructor(options = {}) {
-        this.repeat = options.repeat !== void 0 ? options.repeat : 0;
-        this.timeout = options.timeout;
-
-        /**
-         *
-         * @type {Function[]}
-         */
-        this.actions = options.actions || [];
-    }
-
-    /**
-     *
-     * @param {EntityComponentDataset} ecd
-     * @param {number} timeout
-     * @returns {Promise}
-     */
-    static createTimeoutPromise(ecd, timeout) {
-
-
-        return new Promise((resolve, reject) => {
-
-            const entity = ecd.createEntity();
-
-            const timer = new Timer();
-
-            timer.repeat = 0;
-
-            timer.actions.push(() => {
-                ecd.removeEntity(entity);
-
-                resolve();
-            });
-
-            timer.timeout = timeout;
-
-            ecd.addComponentToEntity(entity, timer);
-        });
-
-
-    }
-}
-
-Timer.typeName = "Timer";
-Timer.serializable = false;
-
-export default Timer;

package/src/engine/ecs/evaluation/PointFitnessBinary.d.ts

@@ -1,22 +0,0 @@
-export class PointFitnessBinary extends PointFitnessFunction {
-    /**
-     *
-     * @type {PointFitnessFunction}
-     */
-    left: PointFitnessFunction;
-    /**
-     *
-     * @type {PointFitnessFunction}
-     */
-    right: PointFitnessFunction;
-    /**
-     *
-     * @param {number} left
-     * @param {number} right
-     * @returns {number}
-     */
-    operation(left: number, right: number): number;
-    evaluate(ecd: any, x: any, y: any, z: any): number;
-}
-import { PointFitnessFunction } from "./PointFitnessFunction.js";
-//# sourceMappingURL=PointFitnessBinary.d.ts.map

package/src/engine/ecs/evaluation/PointFitnessBinary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessBinary.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/evaluation/PointFitnessBinary.js"],"names":[],"mappings":"AAEA;IACI;;;OAGG;IACH,MAFU,oBAAoB,CAElB;IAEZ;;;OAGG;IACH,OAFU,oBAAoB,CAEjB;IAEb;;;;;OAKG;IACH,gBAJW,MAAM,SACN,MAAM,GACJ,MAAM,CAIlB;IAED,mDAMC;CACJ;qCAhCoC,2BAA2B"}

package/src/engine/ecs/evaluation/PointFitnessBinary.js

@@ -1,33 +0,0 @@
-import { PointFitnessFunction } from "./PointFitnessFunction.js";
-
-export class PointFitnessBinary extends PointFitnessFunction {
-    /**
-     *
-     * @type {PointFitnessFunction}
-     */
-    left = null;
-
-    /**
-     *
-     * @type {PointFitnessFunction}
-     */
-    right = null;
-
-    /**
-     *
-     * @param {number} left
-     * @param {number} right
-     * @returns {number}
-     */
-    operation(left, right) {
-        throw new Error(`Not implemented`);
-    }
-
-    evaluate(ecd, x, y, z) {
-        const left = this.left.evaluate(ecd, x, y, z);
-        const right = this.right.evaluate(ecd, x, y, z);
-
-
-        return this.operation(left, right);
-    }
-}

package/src/engine/ecs/evaluation/PointFitnessConstant.d.ts

@@ -1,12 +0,0 @@
-export class PointFitnessConstant extends PointFitnessFunction {
-    static from(v: any): PointFitnessConstant;
-    /**
-     *
-     * @type {number}
-     */
-    value: number;
-    evaluate(ecd: any, x: any, y: any, z: any): number;
-    type: string;
-}
-import { PointFitnessFunction } from "./PointFitnessFunction.js";
-//# sourceMappingURL=PointFitnessConstant.d.ts.map

package/src/engine/ecs/evaluation/PointFitnessConstant.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessConstant.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/evaluation/PointFitnessConstant.js"],"names":[],"mappings":"AAGA;IAOI,0CAQC;IAdD;;;OAGG;IACH,OAFU,MAAM,CAEN;IAYV,mDAEC;IAIL,aAAmC;CAHlC;qCAvBoC,2BAA2B"}

package/src/engine/ecs/evaluation/PointFitnessConstant.js

@@ -1,27 +0,0 @@
-import { PointFitnessFunction } from "./PointFitnessFunction.js";
-import { assert } from "../../../core/assert.js";
-
-export class PointFitnessConstant extends PointFitnessFunction {
-    /**
-     *
-     * @type {number}
-     */
-    value = 0;
-
-    static from(v) {
-        assert.isNumber(v, 'v');
-
-        const r = new PointFitnessConstant();
-
-        r.value = v;
-
-        return r;
-    }
-
-    evaluate(ecd, x, y, z) {
-        return this.value;
-    }
-}
-
-
-PointFitnessConstant.prototype.type = "PointFitnessConstant";

package/src/engine/ecs/evaluation/PointFitnessFunction.d.ts

@@ -1,17 +0,0 @@
-export class PointFitnessFunction {
-    /**
-     *
-     * @param {EntityComponentDataset} ecd
-     * @param {number} x
-     * @param {number} y
-     * @param {number} z
-     * @returns {number}
-     */
-    evaluate(ecd: EntityComponentDataset, x: number, y: number, z: number): number;
-    /**
-     *
-     * @type {boolean}
-     */
-    isPointFitnessFunction: boolean;
-}
-//# sourceMappingURL=PointFitnessFunction.d.ts.map

package/src/engine/ecs/evaluation/PointFitnessFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessFunction.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/evaluation/PointFitnessFunction.js"],"names":[],"mappings":"AAAA;IAEI;;;;;;;OAOG;IACH,yCALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,MAAM,CAIlB;IAGL;;;OAGG;IACH,wBAFU,OAAO,CAEoC;CANpD"}

package/src/engine/ecs/evaluation/PointFitnessFunction.js

@@ -1,20 +0,0 @@
-export class PointFitnessFunction {
-
-    /**
-     *
-     * @param {EntityComponentDataset} ecd
-     * @param {number} x
-     * @param {number} y
-     * @param {number} z
-     * @returns {number}
-     */
-    evaluate(ecd, x, y, z) {
-        throw new Error(`Not implemented`);
-    }
-}
-
-/**
- *
- * @type {boolean}
- */
-PointFitnessFunction.prototype.isPointFitnessFunction = true;

package/src/engine/ecs/evaluation/arithmetic/PointFitnessAdd.d.ts

@@ -1,12 +0,0 @@
-export class PointFitnessAdd extends PointFitnessBinary {
-    /**
-     * @param {PointFitnessFunction} left
-     * @param {PointFitnessFunction} right
-     * @returns {PointFitnessAdd}
-     */
-    static from(left: PointFitnessFunction, right: PointFitnessFunction): PointFitnessAdd;
-    operation(left: any, right: any): any;
-    type: string;
-}
-import { PointFitnessBinary } from "../PointFitnessBinary.js";
-//# sourceMappingURL=PointFitnessAdd.d.ts.map

package/src/engine/ecs/evaluation/arithmetic/PointFitnessAdd.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessAdd.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/ecs/evaluation/arithmetic/PointFitnessAdd.js"],"names":[],"mappings":"AAGA;IACI;;;;OAIG;IACH,sEAFa,eAAe,CAY3B;IAED,sCAEC;IAGL,aAA8B;CAF7B;mCAxBkC,0BAA0B"}

package/src/engine/ecs/evaluation/arithmetic/PointFitnessAdd.js

@@ -1,27 +0,0 @@
-import { PointFitnessBinary } from "../PointFitnessBinary.js";
-import { assert } from "../../../../core/assert.js";
-
-export class PointFitnessAdd extends PointFitnessBinary {
-    /**
-     * @param {PointFitnessFunction} left
-     * @param {PointFitnessFunction} right
-     * @returns {PointFitnessAdd}
-     */
-    static from(left, right) {
-        assert.equal(left.isPointFitnessFunction, true, 'left.isPointFitnessFunction !== true');
-        assert.equal(right.isPointFitnessFunction, true, 'right.isPointFitnessFunction !== true');
-
-        const r = new PointFitnessAdd();
-
-        r.left = left;
-        r.right = right;
-
-        return r;
-    }
-
-    operation(left, right) {
-        return left + right;
-    }
-}
-
-PointFitnessAdd.prototype.type = "PointFitnessAdd";

package/src/engine/ecs/evaluation/arithmetic/PointFitnessMultiply.d.ts

@@ -1,12 +0,0 @@
-export class PointFitnessMultiply extends PointFitnessBinary {
-    /**
-     * @param {PointFitnessFunction} left
-     * @param {PointFitnessFunction} right
-     * @returns {PointFitnessMultiply}
-     */
-    static from(left: PointFitnessFunction, right: PointFitnessFunction): PointFitnessMultiply;
-    operation(left: any, right: any): number;
-    type: string;
-}
-import { PointFitnessBinary } from "../PointFitnessBinary.js";
-//# sourceMappingURL=PointFitnessMultiply.d.ts.map

package/src/engine/ecs/evaluation/arithmetic/PointFitnessMultiply.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessMultiply.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/ecs/evaluation/arithmetic/PointFitnessMultiply.js"],"names":[],"mappings":"AAGA;IACI;;;;OAIG;IACH,sEAFa,oBAAoB,CAYhC;IAED,yCAEC;IAIL,aAAmC;CAHlC;mCAxBkC,0BAA0B"}

package/src/engine/ecs/evaluation/arithmetic/PointFitnessMultiply.js

@@ -1,28 +0,0 @@
-import { PointFitnessBinary } from "../PointFitnessBinary.js";
-import { assert } from "../../../../core/assert.js";
-
-export class PointFitnessMultiply extends PointFitnessBinary {
-    /**
-     * @param {PointFitnessFunction} left
-     * @param {PointFitnessFunction} right
-     * @returns {PointFitnessMultiply}
-     */
-    static from(left, right) {
-        assert.equal(left.isPointFitnessFunction, true, 'left.isPointFitnessFunction !== true');
-        assert.equal(right.isPointFitnessFunction, true, 'right.isPointFitnessFunction !== true');
-
-        const r = new PointFitnessMultiply();
-
-        r.left = left;
-        r.right = right;
-
-        return r;
-    }
-
-    operation(left, right) {
-        return left * right;
-    }
-}
-
-
-PointFitnessMultiply.prototype.type = "PointFitnessMultiply";

package/src/engine/ecs/evaluation/complex/PointFitnessGaussianBlur.d.ts

@@ -1,50 +0,0 @@
-/**
- * Blurs another {@link PointFitnessFunction} by sampling it over an axis-aligned box centred on the
- * query point and weighting the samples with a separable 3D gaussian.
- *
- * Sampling convention (shared with {@link CellFilterGaussianBlur}): the taps are centred on
- * `(samples-1)/2` and spaced `size/(samples-1)` apart, so the outermost taps land exactly on the
- * faces of the box and the tap pattern is symmetric about the query point.
- *
- * An axis with a zero `size` still gets its (minimum) taps, but they all land on the query point,
- * so the axis contributes a constant factor that cancels in the normalisation — i.e. a `size_z` of
- * 0 gives a plain 2D blur.
- */
-export class PointFitnessGaussianBlur extends PointFitnessFunction {
-    /**
-     *
-     * @param {PointFitnessFunction} source
-     * @param {number} x size of the blur box along X, in world units
-     * @param {number} y
-     * @param {number} z
-     * @param {number} [quality] taps per world unit along each axis
-     * @returns {PointFitnessGaussianBlur}
-     */
-    static from(source: PointFitnessFunction, x: number, y: number, z: number, quality?: number): PointFitnessGaussianBlur;
-    samples_x: number;
-    samples_y: number;
-    samples_z: number;
-    sigma_x: number;
-    sigma_y: number;
-    sigma_z: number;
-    size_x: number;
-    size_y: number;
-    size_z: number;
-    /**
-     * Taps per world unit that {@link samples_x}/{@link samples_y}/{@link samples_z} were derived
-     * from. Kept only so the derivation can be reproduced (serialization records the box size and
-     * the quality, not the resulting tap counts); {@link evaluate} reads the sample counts.
-     *
-     * @type {number}
-     */
-    quality: number;
-    /**
-     *
-     * @type {PointFitnessFunction}
-     */
-    source: PointFitnessFunction;
-    evaluate(ecd: any, x: any, y: any, z: any): number;
-    type: string;
-}
-import { PointFitnessFunction } from "../PointFitnessFunction.js";
-//# sourceMappingURL=PointFitnessGaussianBlur.d.ts.map

package/src/engine/ecs/evaluation/complex/PointFitnessGaussianBlur.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PointFitnessGaussianBlur.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/ecs/evaluation/complex/PointFitnessGaussianBlur.js"],"names":[],"mappings":"AAiCA;;;;;;;;;;;GAWG;AACH;IA6BI;;;;;;;;OAQG;IACH,oBAPW,oBAAoB,KACpB,MAAM,KACN,MAAM,KACN,MAAM,YACN,MAAM,GACJ,wBAAwB,CA8BpC;IAhED,kBAAc;IACd,kBAAc;IACd,kBAAc;IAEd,gBAAwB;IACxB,gBAAwB;IACxB,gBAAwB;IAExB,eAAW;IACX,eAAW;IACX,eAAW;IAEX;;;;;;OAMG;IACH,SAFU,MAAM,CAEJ;IAEZ;;;OAGG;IACH,QAFU,oBAAoB,CAEhB;IAyCd,mDA2DC;IAGL,aAAuC;CAFtC;qCA7KoC,4BAA4B"}