@woosh/meep-engine 2.169.0 → 2.169.2

package/src/engine/graphics/ecs/highlight/system/HighlightSystemBase.js

@@ -0,0 +1,205 @@
+import { System } from "../../../../ecs/System.js";
+import Highlight from "../Highlight.js";
+import { HighlightRenderElementSource } from "../plugin/HighlightRenderElementSource.js";
+import { OutlineRenderPlugin } from "../plugin/OutlineRenderPlugin.js";
+
+/**
+ * Traverses `[Highlight, <renderable component>]` tuples and hands each one to
+ * the owning system.
+ *
+ * Kept as an inner class rather than being merged into the system: the outline
+ * plugin's contract is `HighlightRenderElementSource`, and a `System` is not
+ * one. The pool and group are stashed per-collect because
+ * {@link HighlightRenderElementSource#collect} receives them but the per-entity
+ * visitor does not.
+ */
+class HighlightElementSupplier extends HighlightRenderElementSource {
+
+    /**
+     * @param {HighlightSystemBase} system
+     * @param {Function} component_class the renderable component paired with {@link Highlight}
+     */
+    constructor(system, component_class) {
+        super();
+
+        /**
+         * @type {HighlightSystemBase}
+         * @private
+         */
+        this.__system = system;
+
+        /**
+         * @type {Function}
+         * @private
+         */
+        this.__component_class = component_class;
+
+        /**
+         * @type {ObjectPoolFactory<HighlightRenderElement>}
+         * @private
+         */
+        this.__pool = null;
+
+        /**
+         * @type {HighlightRenderGroup}
+         * @private
+         */
+        this.__group = null;
+    }
+
+    collect(pool, group) {
+
+        this.__pool = pool;
+        this.__group = group;
+
+        const system = this.__system;
+
+        /**
+         * @type {EntityManager}
+         */
+        const em = system.entityManager;
+
+        const dataset = em.dataset;
+
+        if (dataset === null) {
+            return;
+        }
+
+        dataset.traverseEntities([Highlight, this.__component_class], this.__visit, this);
+    }
+
+    /**
+     * @param {Highlight} highlight
+     * @param {*} component
+     * @param {number} entity
+     * @private
+     */
+    __visit(highlight, component, entity) {
+        this.__system.visit(highlight, component, entity);
+    }
+
+    /**
+     * @param {THREE.Object3D} object
+     * @param {HighlightDefinition[]} definitions
+     */
+    submit(object, definitions) {
+        const renderElement = this.__pool.create();
+
+        renderElement.definitions = definitions;
+        renderElement.object = object;
+
+        this.__group.elements.add(renderElement);
+    }
+}
+
+/**
+ * Shared scaffold for the outline-highlight systems.
+ *
+ * WHY THIS EXISTS
+ *
+ * `MeshHighlightSystem`, `RenderableHighlightSystem` and
+ * `ShadedGeometryHighlightSystem` were three copies of one system. The
+ * `OutlineRenderPlugin` reference lifecycle in particular — acquire in
+ * `startup`, `removeSource` + `release` + null out in `shutdown` — is a
+ * resource protocol that is easy to get subtly wrong, and it was written out
+ * three times. So were the element-source registration, the dataset-null guard
+ * and the pool/group plumbing. Everything that genuinely differs between the
+ * three is now exactly one method, {@link visit}.
+ *
+ * Plain typed inheritance: a subclass names its component class in the
+ * constructor and implements `visit`. No registry, no string keys.
+ *
+ * @abstract
+ */
+export class HighlightSystemBase extends System {
+
+    /**
+     * @type {Engine}
+     */
+    #engine;
+
+    /**
+     * @type {Reference<OutlineRenderPlugin>|null}
+     */
+    #plugin_renderer_ref = null;
+
+    /**
+     * @param {Engine} engine
+     * @param {Function} component_class renderable component this system outlines, paired with {@link Highlight}
+     */
+    constructor(engine, component_class) {
+        super();
+
+        this.#engine = engine;
+
+        this.dependencies = [Highlight, component_class];
+
+        /**
+         * @type {HighlightElementSupplier}
+         * @private
+         */
+        this.__element_source = new HighlightElementSupplier(this, component_class);
+    }
+
+    /**
+     * @param {EntityManager} entityManager
+     */
+    async startup(entityManager) {
+        /**
+         * @type {EntityManager}
+         */
+        this.entityManager = entityManager;
+
+        const ref = await this.#engine.plugins.acquire(OutlineRenderPlugin);
+
+        this.#plugin_renderer_ref = ref;
+
+        /**
+         * @type {OutlineRenderPlugin}
+         */
+        const plugin = ref.getValue();
+
+        plugin.addSource(this.__element_source);
+    }
+
+    /**
+     * @param {EntityManager} entityManager
+     */
+    async shutdown(entityManager) {
+
+        if (this.#plugin_renderer_ref !== null) {
+
+            this.#plugin_renderer_ref.getValue().removeSource(this.__element_source);
+
+            this.#plugin_renderer_ref.release();
+
+            this.#plugin_renderer_ref = null;
+        }
+
+    }
+
+    /**
+     * Queue one outline element for the current frame. Only valid to call from
+     * inside {@link visit}, which is the only point at which the pool and the
+     * render group exist.
+     *
+     * @param {THREE.Object3D} object three.js object whose silhouette is outlined
+     * @param {HighlightDefinition[]} definitions outline styles to draw for it
+     */
+    submit(object, definitions) {
+        this.__element_source.submit(object, definitions);
+    }
+
+    /**
+     * Decide whether this entity should be outlined this frame and, if so, call
+     * {@link submit} with the three.js object to trace.
+     *
+     * @abstract
+     * @param {Highlight} highlight
+     * @param {*} component instance of the component class given to the constructor
+     * @param {number} entity
+     */
+    visit(highlight, component, entity) {
+        throw new Error('Not implemented');
+    }
+}

package/src/engine/graphics/ecs/highlight/system/MeshHighlightSystem.d.ts

@@ -1,57 +1,16 @@
 export default MeshHighlightSystem;
-declare class MeshHighlightSystem extends System<any> {
+declare class MeshHighlightSystem extends HighlightSystemBase {
     /**
-     *
      * @param {Engine} engine
-     * @constructor
      */
     constructor(engine: Engine);
     /**
-     *
-     * @type {Engine}
-     * @private
-     */
-    private __engine;
-    dependencies: (typeof Mesh | typeof Highlight)[];
-    __element_source: Supplier;
-    /**
-     *
-     * @type {Reference<OutlineRenderPlugin>}
-     * @private
-     */
-    private __plugin_renderer_ref;
-}
-import { System } from '../../../../ecs/System.js';
-import Mesh from '../../mesh/Mesh.js';
-import Highlight from '../Highlight.js';
-declare class Supplier extends HighlightRenderElementSource {
-    /**
-     *
-     * @param {MeshHighlightSystem} system
-     */
-    constructor(system: MeshHighlightSystem);
-    __system: MeshHighlightSystem;
-    /**
-     *
-     * @type {ObjectPoolFactory<HighlightRenderElement>}
-     * @private
-     */
-    private __pool;
-    /**
-     *
-     * @type {HighlightRenderGroup}
-     * @private
-     */
-    private __group;
-    collect(pool: any, group: any): void;
-    /**
-     *
      * @param {Highlight} highlight
      * @param {Mesh} model
      * @param {number} entity
-     * @private
      */
-    private __visitHighlightMeshPreRender;
+    visit(highlight: Highlight, model: Mesh, entity: number): void;
 }
-import { HighlightRenderElementSource } from "../plugin/HighlightRenderElementSource.js";
+import { HighlightSystemBase } from "./HighlightSystemBase.js";
+import Mesh from '../../mesh/Mesh.js';
 //# sourceMappingURL=MeshHighlightSystem.d.ts.map

package/src/engine/graphics/ecs/highlight/system/MeshHighlightSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MeshHighlightSystem.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/highlight/system/MeshHighlightSystem.js"],"names":[],"mappings":";AAsFA;IACI;;;;OAIG;IACH,4BAsBC;IAnBG;;;;OAIG;IACH,iBAAsB;IAEtB,iDAAqC;IAErC,2BAA0C;IAE1C;;;;OAIG;IACH,8BAAiC;CA+CxC;uBA9JsB,2BAA2B;iBAClB,oBAAoB;sBAC9B,iBAAiB;AAMvC;IACI;;;OAGG;IACH,oBAFW,mBAAmB,EAmB7B;IAdG,8BAAsB;IAEtB;;;;OAIG;IACH,eAAkB;IAClB;;;;OAIG;IACH,gBAAmB;IAGvB,qCAoBC;IAED;;;;;;OAMG;IACH,sCAsBC;CACJ;6CAjF4C,2CAA2C"}
+{"version":3,"file":"MeshHighlightSystem.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/highlight/system/MeshHighlightSystem.js"],"names":[],"mappings":";AAGA;IAEI;;OAEG;IACH,4BAEC;IAED;;;;OAIG;IACH,mCAHW,IAAI,UACJ,MAAM,QAmBhB;CACJ;oCAlCmC,0BAA0B;iBAD9B,oBAAoB"}

package/src/engine/graphics/ecs/highlight/system/MeshHighlightSystem.js

@@ -1,162 +1,39 @@
-import { System } from '../../../../ecs/System.js';
-import Mesh, { MeshFlags } from '../../mesh/Mesh.js';
-import Highlight from '../Highlight.js';
-import { HighlightRenderElementSource } from "../plugin/HighlightRenderElementSource.js";
-import { OutlineRenderPlugin } from "../plugin/OutlineRenderPlugin.js";
-import { HighlightRenderElement } from "../renderer/HighlightRenderElement.js";
-import { HighlightRenderGroup } from "../renderer/HighlightRenderGroup.js";
-
-class Supplier extends HighlightRenderElementSource {
-    /**
-     *
-     * @param {MeshHighlightSystem} system
-     */
-    constructor(system) {
-        super();
-
-        this.__system = system;
-
-        /**
-         *
-         * @type {ObjectPoolFactory<HighlightRenderElement>}
-         * @private
-         */
-        this.__pool = null;
-        /**
-         *
-         * @type {HighlightRenderGroup}
-         * @private
-         */
-        this.__group = null;
-    }
-
-    collect(pool, group) {
-
-        this.__pool = pool;
-        this.__group = group;
-
-        const system = this.__system;
-
-        /**
-         *
-         * @type {EntityManager}
-         */
-        const em = system.entityManager;
-
-        const dataset = em.dataset;
-
-        if (dataset === null) {
-            return;
-        }
-
-        dataset.traverseEntities([Highlight, Mesh], this.__visitHighlightMeshPreRender, this);
-    }
-
-    /**
-     *
-     * @param {Highlight} highlight
-     * @param {Mesh} model
-     * @param {number} entity
-     * @private
-     */
-    __visitHighlightMeshPreRender(highlight, model, entity) {
-        if (!model.hasMesh()) {
-            return;
-        }
-
-        if (!model.getFlag(MeshFlags.InView)) {
-            return;
-        }
-
-        const elements = highlight.elements;
-
-        if (elements.isEmpty()) {
-            // no elements
-            return;
-        }
-
-        const renderElement = this.__pool.create();
-
-        renderElement.definitions = elements.asArray();
-        renderElement.object = model.mesh;
-
-        this.__group.elements.add(renderElement);
-    }
-}
-
-class MeshHighlightSystem extends System {
-    /**
-     *
-     * @param {Engine} engine
-     * @constructor
-     */
-    constructor(engine) {
-        super();
-
-        /**
-         *
-         * @type {Engine}
-         * @private
-         */
-        this.__engine = engine;
-
-        this.dependencies = [Highlight, Mesh];
-
-        this.__element_source = new Supplier(this);
-
-        /**
-         *
-         * @type {Reference<OutlineRenderPlugin>}
-         * @private
-         */
-        this.__plugin_renderer_ref = null;
-
-
-    }
-
-    /**
-     *
-     * @param {EntityManager} entityManager
-     */
-    async shutdown(entityManager) {
-
-        if (this.__plugin_renderer_ref !== null) {
-
-            this.__plugin_renderer_ref.getValue().removeSource(this.__element_source);
-
-            this.__plugin_renderer_ref.release();
-
-            this.__plugin_renderer_ref = null;
-        }
-    }
-
-    /**
-     *
-     * @param {EntityManager} entityManager
-     */
-    async startup(entityManager) {
-        /**
-         *
-         * @type {EntityManager}
-         */
-        this.entityManager = entityManager;
-
-        const engine = this.__engine;
-
-        const ref = await engine.plugins.acquire(OutlineRenderPlugin)
-
-        this.__plugin_renderer_ref = ref;
-
-        /**
-         *
-         * @type {OutlineRenderPlugin}
-         */
-        const plugin = ref.getValue();
-
-        plugin.addSource(this.__element_source);
-
-    }
-}
-
-
-export default MeshHighlightSystem;
+import Mesh, { MeshFlags } from '../../mesh/Mesh.js';
+import { HighlightSystemBase } from "./HighlightSystemBase.js";
+
+class MeshHighlightSystem extends HighlightSystemBase {
+
+    /**
+     * @param {Engine} engine
+     */
+    constructor(engine) {
+        super(engine, Mesh);
+    }
+
+    /**
+     * @param {Highlight} highlight
+     * @param {Mesh} model
+     * @param {number} entity
+     */
+    visit(highlight, model, entity) {
+        if (!model.hasMesh()) {
+            return;
+        }
+
+        if (!model.getFlag(MeshFlags.InView)) {
+            return;
+        }
+
+        const elements = highlight.elements;
+
+        if (elements.isEmpty()) {
+            // no elements
+            return;
+        }
+
+        this.submit(model.mesh, elements.asArray());
+    }
+}
+
+
+export default MeshHighlightSystem;

package/src/engine/graphics/ecs/highlight/system/RenderableHighlightSystem.d.ts

@@ -1,62 +1,15 @@
-export class RenderableHighlightSystem extends System<any> {
+export class RenderableHighlightSystem extends HighlightSystemBase {
     /**
-     *
      * @param {Engine} engine
-     * @constructor
      */
     constructor(engine: Engine);
     /**
-     *
-     * @type {Engine}
-     * @private
-     */
-    private __engine;
-    dependencies: (typeof Renderable | typeof Highlight)[];
-    __element_source: Supplier;
-    /**
-     *
-     * @type {Reference<OutlineRenderPlugin>}
-     * @private
-     */
-    private __plugin_renderer_ref;
-}
-import { System } from "../../../../ecs/System.js";
-import Renderable from "../../../../ecs/renderable/Renderable.js";
-import Highlight from "../Highlight.js";
-declare class Supplier extends HighlightRenderElementSource {
-    /**
-     *
-     * @param {RenderableHighlightSystem} system
-     */
-    constructor(system: RenderableHighlightSystem);
-    /**
-     *
-     * @type {RenderableHighlightSystem}
-     * @private
-     */
-    private __system;
-    /**
-     *
-     * @type {ObjectPoolFactory<HighlightRenderElement>}
-     * @private
-     */
-    private __pool;
-    /**
-     *
-     * @type {HighlightRenderGroup}
-     * @private
-     */
-    private __group;
-    collect(pool: any, group: any): void;
-    /**
-     *
      * @param {Highlight} highlight
      * @param {Renderable} renderable
      * @param {number} entity
-     * @private
      */
-    private __visit;
+    visit(highlight: Highlight, renderable: Renderable, entity: number): void;
 }
-import { HighlightRenderElementSource } from "../plugin/HighlightRenderElementSource.js";
-export {};
+import { HighlightSystemBase } from "./HighlightSystemBase.js";
+import Renderable from "../../../../ecs/renderable/Renderable.js";
 //# sourceMappingURL=RenderableHighlightSystem.d.ts.map

package/src/engine/graphics/ecs/highlight/system/RenderableHighlightSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderableHighlightSystem.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/highlight/system/RenderableHighlightSystem.js"],"names":[],"mappings":"AA0FA;IACI;;;;OAIG;IACH,4BAsBC;IAnBG;;;;OAIG;IACH,iBAAsB;IAEtB,uDAA2C;IAE3C,2BAA0C;IAE1C;;;;OAIG;IACH,8BAAiC;CAgDxC;uBAjKsB,2BAA2B;uBAF3B,0CAA0C;sBAG3C,iBAAiB;AAKvC;IACI;;;OAGG;IACH,oBAFW,yBAAyB,EAwBnC;IAnBG;;;;OAIG;IACH,iBAAsB;IAEtB;;;;OAIG;IACH,eAAkB;IAClB;;;;OAIG;IACH,gBAAmB;IAGvB,qCAoBC;IAED;;;;;;OAMG;IACH,gBAqBC;CACJ;6CApF4C,2CAA2C"}
+{"version":3,"file":"RenderableHighlightSystem.d.ts","sourceRoot":"","sources":["../../../../../../../src/engine/graphics/ecs/highlight/system/RenderableHighlightSystem.js"],"names":[],"mappings":"AAIA;IAEI;;OAEG;IACH,4BAEC;IAED;;;;OAIG;IACH,wCAHW,UAAU,UACV,MAAM,QAgBhB;CACJ;oCA/BmC,0BAA0B;uBAFvC,0CAA0C"}