@woosh/meep-engine 2.50.2 → 2.51.0

package/src/core/process/matcher/Matchers.js

@@ -25,7 +25,7 @@ export function isDefined(value) {
 
 /**
  * performs instanceof match
- * @param {class} type
+ * @param {function} type
  * @returns {function(*): boolean}
  */
 export function isInstanceOf(type) {

package/src/engine/asset/loaders/image/png/PNG.spec.js

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

package/src/engine/asset/loaders/image/png/PNGReader.spec.js

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

package/src/engine/asset/loaders/image/png/crc.spec.js

@@ -0,0 +1,15 @@
+import { crc } from "./crc.js";
+
+test("sanity", () => {
+
+    const empty = crc(new Uint8Array(0), 0, 0);
+
+    expect(typeof empty).toBe("number");
+    expect(Number.isInteger(empty)).toBe(true);
+
+    const one = crc(new Uint8Array([1]), 0, 1);
+
+    expect(typeof one).toBe("number");
+    expect(Number.isInteger(one)).toBe(true);
+
+});

package/src/engine/{Platform.js → browserInfo.js}

@@ -4,7 +4,7 @@ let cached = null;
  * https://stackoverflow.com/questions/5916900/how-can-you-detect-the-version-of-a-browser
  * @returns {{name:String, version:Number}}
  */
-function browserInfo() {
+export function browserInfo() {
     if (cached !== null) {
         return cached;
     }
@@ -46,7 +46,3 @@ function browserInfo() {
 
     return result;
 }
-
-export {
-    browserInfo
-}

package/src/engine/ecs/EntityBlueprint.js

@@ -56,6 +56,10 @@ function populateJsonTemplate(template, seed) {
     }
 }
 
+/**
+ * Template for instantiating entities
+ * @class
+ */
 export class EntityBlueprint {
     constructor() {
         /**

package/src/engine/ecs/EntityBuilder.js

@@ -15,59 +15,58 @@ const DEFAULT_FLAGS =
 
 /**
  * Representation of an entity, helps build entities and keep track of them without having to access {@link EntityComponentDataset} directly
+ * @class
  */
 class EntityBuilder {
+
+    /**
+     * @type {number}
+     */
+    entity = void 0;
+
+    /**
+     * Generation is a unique identifier coming from the dataset
+     * Generation of an existing entity must match for it to be considered "the same"
+     * @type {number}
+     */
+    generation = -1;
+
     /**
      *
-     * @constructor
+     * @type {Array}
      */
-    constructor() {
-        /**
-         * @type {number}
-         */
-        this.entity = void 0;
-
-        /**
-         * Generation is a unique identifier coming from the dataset
-         * Generation of an existing entity must match for it to be considered "the same"
-         * @type {number}
-         */
-        this.generation = -1;
-
-        /**
-         *
-         * @type {Array}
-         */
-        this.element = [];
-
-        /**
-         *
-         * @type {{name:string,listener:(function|Function), context:*}[]}
-         */
-        this.deferredListeners = [];
-
-        /**
-         *
-         * @type {EntityComponentDataset}
-         */
-        this.dataset = null;
-
-        /**
-         *
-         * @type {EntityBuilderFlags|number}
-         */
-        this.flags = DEFAULT_FLAGS;
-
-        /**
-         *
-         * @type {Object}
-         */
-        this.properties = {};
-
-        this.on = {
-            built: new Signal()
-        };
-    }
+    element = [];
+
+    /**
+     *
+     * @type {{name:string,listener:(function|Function), context:*}[]}
+     */
+    deferredListeners = [];
+
+    /**
+     *
+     * @type {EntityComponentDataset}
+     */
+    dataset = null;
+
+    /**
+     *
+     * @type {EntityBuilderFlags|number}
+     */
+    flags = DEFAULT_FLAGS;
+
+    /**
+     *
+     * @type {Object}
+     */
+    properties = {};
+
+    /**
+     * @readonly
+     */
+    on = {
+        built: new Signal()
+    };
 
     /**
      * Handles event when entity is removed without invoking {@link #destroy} method
@@ -200,7 +199,7 @@ class EntityBuilder {
 
     /**
      *
-     * @param {class} klass
+     * @param {function} klass
      * @returns {*|null}
      */
     removeComponent(klass) {

package/src/engine/ecs/EntityBuilderFlags.js

@@ -8,11 +8,11 @@ export const EntityBuilderFlags = {
      */
     Built: 1,
     /**
-     * If component type is not registered on the {@link EntityComponentDataset} when calling {@link #build} - will register the component first
+     * If component type is not registered on the {@link EntityComponentDataset} when calling {@link EntityBuilder#build} - will register the component first
      */
     RegisterComponents: 2,
     /**
-     * Entity builder will watch destruction of the entity (subscribe to event), this will make the EntityBuilder automatically
+     * Entity builder will watch destruction of the entity (subscribe to event), this will make the {@link EntityBuilder} automatically
      * recognize when the corresponding entity is destroyed outside the EntityBuilder API
      * NOTE: useful to turn off to save a bit of memory, as those event listeners take up a bit of space. Feel free to turn this flag off when you don't care to keep the reference to the EntityBuilder
      */

package/src/engine/ecs/fow/FogOfWar.js

@@ -45,62 +45,63 @@ const revealMaskTableSpec = new RowFirstTableSpec([
 
 const fadeRow = [];
 
+/**
+ * @class
+ */
 export class FogOfWar {
-    constructor() {
-        /**
-         *
-         * @type {boolean}
-         */
-        this.textureNeedsUpdate = false;
-        /**
-         *
-         * @type {boolean}
-         */
-        this.distanceFieldNeedsUpdate = false;
 
-        /**
-         *
-         * @type {Sampler2D}
-         */
-        this.sampler = null;
-        /**
-         *
-         * @type {Sampler2D}
-         */
-        this.distanceSampler = null;
+    /**
+     *
+     * @type {boolean}
+     */
+    textureNeedsUpdate = true;
+    /**
+     *
+     * @type {boolean}
+     */
+    distanceFieldNeedsUpdate = false;
 
-        /**
-         *
-         * @type {DataTexture|null}
-         */
-        this.texture = null;
+    /**
+     *
+     * @type {DataTexture|null}
+     */
+    texture = null;
 
-        /**
-         * Resolution scale of FoW versus terrain resolution, higher number makes FoW more detailed
-         * @type {Vector1}
-         */
-        this.scale = new Vector1(1);
+    /**
+     * Resolution scale of FoW versus terrain resolution, higher number makes FoW more detailed
+     * @type {Vector1}
+     */
+    scale = new Vector1(1);
 
-        /**
-         * Size of the fog area
-         * @type {Vector2}
-         */
-        this.size = new Vector2(0, 0);
+    /**
+     * Size of the fog area
+     * @type {Vector2}
+     */
+    size = new Vector2(0, 0);
 
-        this.color = new Vector4(0.1, 0.1, 0.1, 1);
+    color = new Vector4(0.1, 0.1, 0.1, 1);
 
-        /**
-         * Contains indices of pixes that are currently being updated
-         * @type {RowFirstTable}
-         */
-        this.fadeMask = new RowFirstTable(revealMaskTableSpec);
+    /**
+     * Contains indices of pixes that are currently being updated
+     * @type {RowFirstTable}
+     */
+    fadeMask = new RowFirstTable(revealMaskTableSpec);
 
-        this.on = {
-            textureChanged: new Signal()
-        };
+    on = {
+        textureChanged: new Signal()
+    };
 
-        this.initialize();
-    }
+    /**
+     *
+     * @type {Sampler2D}
+     */
+    sampler = Sampler2D.uint8(1, 0, 0);
+
+    /**
+     *
+     * @type {Sampler2D}
+     */
+    distanceSampler = Sampler2D.uint8(1, 0, 0);
 
     /**
      *
@@ -159,13 +160,6 @@ export class FogOfWar {
         }
     }
 
-    initialize() {
-        this.sampler = new Sampler2D(new Uint8Array(0), 1, 0, 0);
-        this.distanceSampler = new Sampler2D(new Uint8Array(0), 1, 0, 0);
-
-        this.textureNeedsUpdate = true;
-    }
-
     /**
      *
      * @param {number} x

package/src/engine/ecs/guid/GUID.js

@@ -23,6 +23,7 @@ let _clockseq = ((randomUint8(random) << 8) | randomUint8(random)) & 0x3fff;
 
 /**
  * Globally unique identifier
+ * @class
  */
 export class GUID {
     #data = new Uint8Array(16);

package/src/engine/ecs/{systems → renderable}/RenderSystem.d.ts

@@ -1,6 +1,6 @@
 import {System} from "../System";
 import {GraphicsEngine} from "../../graphics/GraphicsEngine";
-import Renderable from "../components/Renderable";
+import Renderable from "./Renderable";
 
 export default class RenderSystem extends System<Renderable> {
     constructor(graphics: GraphicsEngine)

package/src/engine/ecs/{systems → renderable}/RenderSystem.js

@@ -2,15 +2,15 @@
  * Created by Alex on 01/04/2014.
  */
 import { System } from '../System.js';
-import Renderable from '../components/Renderable.js';
+import Renderable from './Renderable.js';
 import { Transform } from '../transform/Transform.js';
 import { SignalBinding } from "../../../core/events/signal/SignalBinding.js";
-import { RenderableFlags } from "../components/RenderableFlags.js";
+import { RenderableFlags } from "./RenderableFlags.js";
 import { rootObject3DFastMatrixUpdate } from "../../graphics/ecs/mesh/rootObject3DFastMatrixUpdate.js";
 import { updateNodeByTransformAndBBB } from "../../graphics/ecs/mesh/updateNodeByTransformAndBBB.js";
-import { three_computeObjectBoundingBox } from "../../graphics/three/three_computeObjectBoundingBox.js";
 import { ResourceAccessSpecification } from "../../../core/model/ResourceAccessSpecification.js";
 import { ResourceAccessKind } from "../../../core/model/ResourceAccessKind.js";
+import { copy_transform_to_threejs_object } from "../../graphics/copy_transform_to_threejs_object.js";
 
 
 /**
@@ -111,37 +111,11 @@ class RenderSystem extends System {
 
         if (renderable.getFlag(RenderableFlags.BoundingBoxNeedsUpdate)) {
             // compute bounding box
-            three_computeObjectBoundingBox(renderable.object, renderable.boundingBox);
-
-            renderable.clearFlag(RenderableFlags.BoundingBoxNeedsUpdate);
+            renderable.computeBoundsFromObject();
         }
 
-        function copyPositionOfMesh(x, y, z) {
-            const m = renderable.object;
-            const p = m.position;
-            if (p.x !== x || p.y !== y || p.z !== z) {
-                p.set(x, y, z);
-            }
-            updateMeshTransform(renderable);
-            updateNodeByTransformAndBBB(renderable.bvh, renderable.boundingBox, transform);
-        }
-
-        function copyScaleOfMesh(x, y, z) {
-            const m = renderable.object;
-            const scale = m.scale;
-            if (scale.x !== x || scale.y !== y || scale.z !== z) {
-                scale.set(x, y, z);
-            }
-            updateMeshTransform(renderable);
-            updateNodeByTransformAndBBB(renderable.bvh, renderable.boundingBox, transform);
-        }
-
-        function handleRotationChange() {
-            const m = renderable.object;
-            const euler = m.rotation;
-
-            transform.rotation.__setFromEuler(euler.x, euler.y, euler.z, euler.order);
-
+        function handle_transform_change() {
+            copy_transform_to_threejs_object(renderable.object, transform);
             updateMeshTransform(renderable);
             updateNodeByTransformAndBBB(renderable.bvh, renderable.boundingBox, transform);
         }
@@ -149,9 +123,9 @@ class RenderSystem extends System {
         const position = transform.position;
         const scale = transform.scale;
 
-        const bPosition = new SignalBinding(position.onChanged, copyPositionOfMesh);
-        const bRotation = new SignalBinding(transform.rotation.onChanged, handleRotationChange);
-        const bScale = new SignalBinding(scale.onChanged, copyScaleOfMesh);
+        const bPosition = new SignalBinding(position.onChanged, handle_transform_change);
+        const bRotation = new SignalBinding(transform.rotation.onChanged, handle_transform_change);
+        const bScale = new SignalBinding(scale.onChanged, handle_transform_change);
 
         bPosition.link();
         bRotation.link();
@@ -163,9 +137,7 @@ class RenderSystem extends System {
             bScale
         ];
 
-        copyPositionOfMesh(position.x, position.y, position.z);
-        copyScaleOfMesh(scale.x, scale.y, scale.z);
-        handleRotationChange();
+        handle_transform_change();
 
         this.bvh.insertNode(renderable.bvh);
     }

package/src/engine/ecs/renderable/Renderable.d.ts

@@ -0,0 +1,25 @@
+import {Object3D} from "three";
+import {AABB3} from "../../../core/geom/3d/aabb/AABB3";
+import {LeafNode} from "../../../core/bvh2/LeafNode";
+
+export default class Renderable {
+    readonly object: Object3D
+    readonly boundingBox: AABB3
+
+    matrixAutoUpdate: boolean
+    boundingBoxNeedsUpdate: boolean
+
+    readonly bvh: LeafNode<Object3D>
+
+    constructor(object: Object3D)
+
+    setFlag(flag: number): void
+
+    clearFlag(flag: number): void
+
+    writeFlag(flag: number, value: boolean): void
+
+    getFlag(flag: number): boolean
+
+    computeBoundsFromObject(): void
+}

package/src/engine/ecs/{components → renderable}/Renderable.js

@@ -5,29 +5,15 @@
 
 import { LeafNode } from "../../../core/bvh2/LeafNode.js";
 import { AABB3 } from "../../../core/geom/3d/aabb/AABB3.js";
-import { Vector3 as ThreeVector3 } from "three";
-import { max2 } from "../../../core/math/max2.js";
-import { min2 } from "../../../core/math/min2.js";
 import { RenderableFlags } from "./RenderableFlags.js";
+import { MATRIX_4_IDENTITY } from "../../../core/geom/3d/matrix/MATRIX_4_IDENTITY.js";
+import {
+    expand_aabb_by_transformed_three_object
+} from "../../graphics/three/expand_aabb_by_transformed_three_object.js";
 
 const DEFAULT_FLAGS = RenderableFlags.UpdateMatrix | RenderableFlags.BoundingBoxNeedsUpdate;
 
 
-/**
- *
- * @type {Vector3[]}
- */
-const scratch_corners = [
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3(),
-    new ThreeVector3()
-];
-
 /**
  @deprecated use {@link ShadedGeometry} instead
  */
@@ -157,83 +143,32 @@ class Renderable {
     computeBoundsFromObject() {
         const object = this.object;
 
-        let x0 = Infinity,
-            y0 = Infinity,
-            z0 = Infinity,
-            x1 = -Infinity,
-            y1 = -Infinity,
-            z1 = -Infinity;
-
-        object.updateMatrixWorld(false, true);
-
-        object.traverse(function (object) {
-            if (object.isLine || object.isMesh) {
-
-
-                const geometry = object.geometry;
-
-                geometry.computeBoundingBox();
-
-                const boundingBox = geometry.boundingBox;
+        object.updateMatrixWorld();
 
-                const bbMin = boundingBox.min;
-                const bbMax = boundingBox.max;
+        const aabb = new Float32Array([
+            Infinity, Infinity, Infinity,
+            -Infinity, -Infinity, -Infinity
+        ]);
 
-                if (bbMax.equals(bbMin)) {
-                    // object has 0 bounds, skip
-                    return;
-                }
-
-                object.updateMatrixWorld();
-
-                const worldMatrix = object.matrixWorld;
-
-                // set corner data
-                scratch_corners[0].set(bbMin.x, bbMin.y, bbMin.z);
-                scratch_corners[1].set(bbMin.x, bbMin.y, bbMax.z);
-                scratch_corners[2].set(bbMin.x, bbMax.y, bbMin.z);
-                scratch_corners[3].set(bbMin.x, bbMax.y, bbMax.z);
-                scratch_corners[4].set(bbMax.x, bbMin.y, bbMin.z);
-                scratch_corners[5].set(bbMax.x, bbMin.y, bbMax.z);
-                scratch_corners[6].set(bbMax.x, bbMax.y, bbMin.z);
-                scratch_corners[7].set(bbMax.x, bbMax.y, bbMax.z);
-
-                for (let i = 0; i < 8; i++) {
-                    const corner = scratch_corners[i];
-
-                    corner.applyMatrix4(worldMatrix);
-
-                    x0 = min2(x0, corner.x);
-                    y0 = min2(y0, corner.y);
-                    z0 = min2(z0, corner.z);
-
-                    x1 = max2(x1, corner.x);
-                    y1 = max2(y1, corner.y);
-                    z1 = max2(z1, corner.z);
-                }
-            }
-        });
+        expand_aabb_by_transformed_three_object(aabb, object, MATRIX_4_IDENTITY);
 
         // sanity checks to ensure valid bounds
-        if (!Number.isFinite(x0)) {
-            x0 = 0;
-            x1 = 0;
+        if (!Number.isFinite(aabb[0])) {
+            aabb[0] = aabb[3] = 0;
         }
 
-        if (!Number.isFinite(y0)) {
-            y0 = 0;
-            y1 = 0;
+        if (!Number.isFinite(aabb[1])) {
+            aabb[1] = aabb[4] = 0;
         }
 
-        if (!Number.isFinite(z0)) {
-            z0 = 0;
-            z1 = 0;
+        if (!Number.isFinite(aabb[2])) {
+            aabb[2] = aabb[5] = 0;
         }
 
 
-        this.boundingBox.setBounds(x0, y0, z0, x1, y1, z1);
+        this.boundingBox.readFromArray(aabb);
 
-        this.bvh.resize(x0, y0, z0, x1, y1, z1);
+        this.clearFlag(RenderableFlags.BoundingBoxNeedsUpdate);
     }
 }
 

package/src/engine/ecs/renderable/Renderable.spec.js

@@ -0,0 +1,10 @@
+import Renderable from "./Renderable.js";
+import { Object3D } from "three";
+import { RenderableFlags } from "./RenderableFlags.js";
+
+test("constructor", () => {
+
+    const unit = new Renderable(new Object3D());
+
+    expect(unit.getFlag(RenderableFlags.BoundingBoxNeedsUpdate)).toBe(true);
+});

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

@@ -20,7 +20,6 @@ import { Blackboard } from "../../intelligence/blackboard/Blackboard.js";
 import { VoiceFlags } from "./VoiceFlags.js";
 import { assert } from "../../../core/assert.js";
 import { weightedRandomFromArray } from "../../../core/collection/array/weightedRandomFromArray.js";
-import { MeepSettings } from "../../MeepSettings.js";
 import { GameAssetType } from "../../asset/GameAssetType.js";
 import { DomSizeObserver } from "../../../view/util/DomSizeObserver.js";
 import { SpeechBubbleView } from "./SpeechBubbleView.js";
@@ -140,8 +139,6 @@ class Context extends SystemEntityContext {
     }
 }
 
-const VOICE_SETTINGS = MeepSettings.ecs.Voice;
-
 const SPEECH_BUBBLE_ANIMATION_INTRO = new AnimationTrack(['alpha']);
 SPEECH_BUBBLE_ANIMATION_INTRO.addKey(0, [0]);
 SPEECH_BUBBLE_ANIMATION_INTRO.addKey(0.1, [1]);
@@ -167,8 +164,12 @@ export class VoiceSystem extends AbstractContextSystem {
     /**
      *
      * @param {Engine} engine
+     * @param settings
      */
-    constructor(engine) {
+    constructor(engine, settings = {
+        font: "unknown.ttf", //path to font file
+        font_size: 16
+    }) {
         super(Context);
 
         this.dependencies = [Voice];
@@ -239,9 +240,16 @@ export class VoiceSystem extends AbstractContextSystem {
 
         /**
          *
+         * @type {string}
          * @private
          */
-        this.__font_size = VOICE_SETTINGS.font_size;
+        this.__font_path = settings.font;
+
+        /**
+         *
+         * @private
+         */
+        this.__font_size = settings.font_size;
 
         /**
          * Print debug output into console
@@ -274,11 +282,9 @@ export class VoiceSystem extends AbstractContextSystem {
         assert.defined(this.lines, 'lines');
         assert.defined(this.sets, 'sets');
 
-        const p_font_setting = engine.assetManager.promise(VOICE_SETTINGS.font, GameAssetType.Font).then(font_asset => {
-
-            const font = font_asset.create();
+        const p_font_setting = engine.assetManager.promise(this.__font_path, GameAssetType.Font).then(font_asset => {
 
-            this.__font = font;
+            this.__font = font_asset.create();
         });
 
         p_font_setting.then(() => {

package/src/engine/ecs/systems/MeshColliderSystem.js

@@ -4,7 +4,7 @@
 import { System } from '../System.js';
 import Tag from '../components/Tag.js';
 import { Transform } from '../transform/Transform.js';
-import Renderable from '../components/Renderable.js';
+import Renderable from '../renderable/Renderable.js';
 import MeshCollider from '../components/MeshCollider.js';
 import { Raycaster } from "three";