@woosh/meep-engine 3.14.6 → 3.16.0

package/src/engine/graphics3/ShadedGeometrySystem.js

@@ -1,169 +1,180 @@
-import { assert } from "../../core/assert.js";
-import { SignalBinding } from "../../core/events/signal/SignalBinding.js";
-import { Mesh } from "../../shade/renderer/scene/Mesh.js";
-import Name from "../ecs/name/Name.js";
-import { System } from "../ecs/System.js";
-import { Transform } from "../ecs/transform/Transform.js";
-import { t64_copy_from_transform } from "../ecs/transform/t64_copy_from_transform.js";
-import { ShadedGeometry } from "../graphics/ecs/mesh-v2/ShadedGeometry.js";
-
-/**
- * Puts one primitive into Shade's scene, and keeps it where the entity says.
- *
- * **The component and the row are the same shape, which is the whole reason this system is short.**
- * `ShadedGeometry` is a geometry, a material and a flat transform — *"not a hierarchical data
- * structure"*, in its own docblock — and Shade's `Mesh` is a `Node3D` carrying a `MeshletGeometry`
- * and a `ShadeMaterial`. §4.3 asks for exactly that mapping, 1:1, and there is nothing else to do.
- *
- * **What it is not is a model.** A model file is many primitives arranged in a hierarchy, and in an
- * ECS a hierarchy is entities — one per node, parented through `EntityNode`, each carrying its own
- * `ShadedGeometry` where it draws (D47). `SGMesh` is the layer that expands a loaded file into
- * those entities; this system never sees the file, only the primitives that came out of it, and
- * cannot tell them from primitives some tool built by hand.
- *
- * **The payload is the renderer's own.** Under three the same component holds a `BufferGeometry`
- * and a three `Material`, and `ShadedGeometrySystem` reads those; here it holds Shade's pair. One
- * renderer runs at a time and each system reads what its own renderer draws — the same bargain the
- * v1 component made with `Mesh.mesh`, and not a neutral geometry format, which would be a redesign
- * rather than a transition.
- */
-export class ShadedGeometrySystem extends System {
-    /**
-     * @type {GraphicsEngine}
-     */
-    #graphics;
-
-    /**
-     * @type {Scene}
-     */
-    #scene;
-
-    /**
-     * What each entity put in the scene, and what is listening on its behalf.
-     *
-     * @type {Map<number, {node: Mesh, bindings: SignalBinding[]}>}
-     */
-    #entries = new Map();
-
-    /**
-     * @param {GraphicsEngine} graphics
-     * @param {Scene} scene
-     */
-    constructor(graphics, scene) {
-        super();
-
-        assert.defined(graphics, 'graphics');
-        assert.defined(scene, 'scene');
-
-        this.#graphics = graphics;
-        this.#scene = scene;
-
-        this.dependencies = [ShadedGeometry, Transform];
-    }
-
-    async startup(entityManager) {
-        this.entityManager = entityManager;
-    }
-
-    async shutdown(entityManager) {
-        for (const entity of Array.from(this.#entries.keys())) {
-            this.#drop(entity);
-        }
-    }
-
-    /**
-     * @param {ShadedGeometry} geometry
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    link(geometry, transform, entity) {
-        const node = new Mesh();
-
-        node.geometry = geometry.geometry;
-        node.material = geometry.material;
-
-        /*
-         The row takes the entity's name when it has one. Nothing draws differently for it — what it
-         buys is that a walk over what is in the scene still answers with the names the model file
-         gave its nodes, which is what `MeshSystem.traverse_meshes` has always yielded and what
-         makes a scene readable in a debugger.
-        */
-        const name = this.entityManager.dataset.getComponent(entity, Name);
-
-        if (name !== undefined && name !== null) {
-            node.name = name.getValue();
-        }
-
-        const bindings = [];
-
-        // placed when the transform moves rather than on a poll, which is the bargain `MeshSystem`
-        // makes for the same reason: an entity that has not moved costs nothing downstream either
-        const place = () => this.#place(entity, transform);
-
-        for (const component of [transform.position, transform.rotation, transform.scale]) {
-            const binding = new SignalBinding(component.onChanged, place);
-
-            binding.link();
-
-            bindings.push(binding);
-        }
-
-        this.#entries.set(entity, { node, bindings });
-
-        // the component carries its own row, so anything holding the component can ask where the
-        // primitive ended up without going through this system
-        geometry.node = node;
-
-        this.#scene.add(node);
-
-        this.#place(entity, transform);
-    }
-
-    /**
-     * @param {ShadedGeometry} geometry
-     * @param {Transform} transform
-     * @param {number} entity
-     */
-    unlink(geometry, transform, entity) {
-        geometry.node = null;
-
-        this.#drop(entity);
-    }
-
-    /**
-     * @param {number} entity
-     * @param {Transform} transform
-     */
-    #place(entity, transform) {
-        const entry = this.#entries.get(entity);
-
-        if (entry === undefined) {
-            return;
-        }
-
-        t64_copy_from_transform(entry.node.transform_local, transform);
-
-        // recomputes `transform_global` and bumps the version the scene database reads to decide
-        // what to upload
-        entry.node.updateMatrices();
-    }
-
-    /**
-     * @param {number} entity
-     */
-    #drop(entity) {
-        const entry = this.#entries.get(entity);
-
-        if (entry === undefined) {
-            return;
-        }
-
-        for (const binding of entry.bindings) {
-            binding.unlink();
-        }
-
-        this.#scene.remove(entry.node);
-
-        this.#entries.delete(entity);
-    }
-}
+import { assert } from "../../core/assert.js";
+import { SignalBinding } from "../../core/events/signal/SignalBinding.js";
+import { Mesh } from "../../shade/renderer/scene/Mesh.js";
+import Name from "../ecs/name/Name.js";
+import { System } from "../ecs/System.js";
+import { Transform64 } from "../ecs/transform/Transform64.js";
+import { ShadedGeometry } from "../graphics/ecs/mesh-v2/ShadedGeometry.js";
+import { EventType } from "../ecs/EventType.js";
+
+/**
+ * Puts one primitive into Shade's scene, and keeps it where the entity says.
+ *
+ * **The component and the row are the same shape, which is the whole reason this system is short.**
+ * `ShadedGeometry` is a geometry, a material and a flat transform — *"not a hierarchical data
+ * structure"*, in its own docblock — and Shade's `Mesh` is a `Node3D` carrying a `MeshletGeometry`
+ * and a `ShadeMaterial`. §4.3 asks for exactly that mapping, 1:1, and there is nothing else to do.
+ *
+ * **What it is not is a model.** A model file is many primitives arranged in a hierarchy, and in an
+ * ECS a hierarchy is entities — one per node, parented through `EntityNode`, each carrying its own
+ * `ShadedGeometry` where it draws (D47). `SGMesh` is the layer that expands a loaded file into
+ * those entities; this system never sees the file, only the primitives that came out of it, and
+ * cannot tell them from primitives some tool built by hand.
+ *
+ * **The payload is the renderer's own.** Under three the same component holds a `BufferGeometry`
+ * and a three `Material`, and `ShadedGeometrySystem` reads those; here it holds Shade's pair. One
+ * renderer runs at a time and each system reads what its own renderer draws — the same bargain the
+ * v1 component made with `Mesh.mesh`, and not a neutral geometry format, which would be a redesign
+ * rather than a transition.
+ */
+export class ShadedGeometrySystem extends System {
+    /**
+     * @type {GraphicsEngine}
+     */
+    #graphics;
+
+    /**
+     * @type {Scene}
+     */
+    #scene;
+
+    /**
+     * What each entity put in the scene, and what is listening on its behalf.
+     *
+     * @type {Map<number, {node: Mesh, bindings: SignalBinding[]}>}
+     */
+    #entries = new Map();
+
+    /**
+     * @param {GraphicsEngine} graphics
+     * @param {Scene} scene
+     */
+    constructor(graphics, scene) {
+        super();
+
+        assert.defined(graphics, 'graphics');
+        assert.defined(scene, 'scene');
+
+        this.#graphics = graphics;
+        this.#scene = scene;
+
+        this.dependencies = [ShadedGeometry, Transform64];
+    }
+
+    async startup(entityManager) {
+        this.entityManager = entityManager;
+    }
+
+    async shutdown(entityManager) {
+        for (const entity of Array.from(this.#entries.keys())) {
+            this.#drop(entity);
+        }
+    }
+
+    /**
+     * @param {ShadedGeometry} geometry
+     * @param {Transform64} transform
+     * @param {number} entity
+     */
+    link(geometry, transform, entity) {
+        const node = new Mesh();
+
+        node.geometry = geometry.geometry;
+        node.material = geometry.material;
+
+        /*
+         The row takes the entity's name when it has one. Nothing draws differently for it — what it
+         buys is that a walk over what is in the scene still answers with the names the model file
+         gave its nodes, which is what `MeshSystem.traverse_meshes` has always yielded and what
+         makes a scene readable in a debugger.
+        */
+        const name = this.entityManager.dataset.getComponent(entity, Name);
+
+        if (name !== undefined && name !== null) {
+            node.name = name.getValue();
+        }
+
+        const bindings = [];
+
+        // placed when the transform moves rather than on a poll, which is the bargain `MeshSystem`
+        // makes for the same reason: an entity that has not moved costs nothing downstream either
+        const place = () => this.#place(entity, transform);
+
+        // One dataset listener replaces the three sub-object signals a Transform used to carry.
+        // Coarser - it wakes on any change to the transform rather than on a named channel - and
+        // that is the trade: the placement reads the whole transform anyway.
+        const on_transform_changed = event => {
+            if (event.klass === Transform64) {
+                place();
+            }
+        };
+
+        this.entityManager.dataset.addEntityEventListener(
+            entity, EventType.ComponentChanged, on_transform_changed
+        );
+
+        this.#entries.set(entity, { node, bindings, on_transform_changed });
+
+        // the component carries its own row, so anything holding the component can ask where the
+        // primitive ended up without going through this system
+        geometry.node = node;
+
+        this.#scene.add(node);
+
+        this.#place(entity, transform);
+    }
+
+    /**
+     * @param {ShadedGeometry} geometry
+     * @param {Transform64} transform
+     * @param {number} entity
+     */
+    unlink(geometry, transform, entity) {
+        geometry.node = null;
+
+        this.#drop(entity);
+    }
+
+    /**
+     * @param {number} entity
+     * @param {Transform64} transform
+     */
+    #place(entity, transform) {
+        const entry = this.#entries.get(entity);
+
+        if (entry === undefined) {
+            return;
+        }
+
+        entry.node.transform_local.copy(transform);
+
+        // recomputes `transform_global` and bumps the version the scene database reads to decide
+        // what to upload
+        entry.node.updateMatrices();
+    }
+
+    /**
+     * @param {number} entity
+     */
+    #drop(entity) {
+        const entry = this.#entries.get(entity);
+
+        if (entry === undefined) {
+            return;
+        }
+
+        for (const binding of entry.bindings) {
+            binding.unlink();
+        }
+
+        if (entry.on_transform_changed !== undefined) {
+            this.entityManager.dataset.removeEntityEventListener(
+                entity, EventType.ComponentChanged, entry.on_transform_changed
+            );
+        }
+
+        this.#scene.remove(entry.node);
+
+        this.#entries.delete(entity);
+    }
+}

package/src/engine/graphics3/TerrainSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainSystem.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/TerrainSystem.js"],"names":[],"mappings":"AA2CA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IAiCI;;;;OAIG;IACH,gFAUC;IA/CD,iCAAyB;IAiDzB,2CAQC;IAED,4CAUC;IAED;;;OAGG;IACH,cAHW,OAAO,UACP,MAAM,QA2DhB;IAED;;;OAGG;IACH,gBAHW,OAAO,UACP,MAAM,QAMhB;IAED,6BA0BC;IAoLD;;;;;;;;;OASG;IACH,oBALW,MAAM,2BAEJ,MAAM,GAAC,IAAI,CA2FvB;IAED;;OAEG;IACH,kCAaC;;CACJ;AAED;;;;;;GAMG;AACH;IAUI;;OAEG;IACH,oBAFW,aAAa,EAMvB;IAED,yBAEC;;CACJ;uBA5iBsB,kBAAkB;oBACrB,+BAA+B;gCAUnB,mDAAmD"}
+{"version":3,"file":"TerrainSystem.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/TerrainSystem.js"],"names":[],"mappings":"AA0CA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IAiCI;;;;OAIG;IACH,gFAUC;IA/CD,iCAAyB;IAiDzB,2CAQC;IAED,4CAUC;IAED;;;OAGG;IACH,cAHW,OAAO,UACP,MAAM,QA2DhB;IAED;;;OAGG;IACH,gBAHW,OAAO,UACP,MAAM,QAMhB;IAED,6BA0BC;IAoLD;;;;;;;;;OASG;IACH,oBALW,MAAM,2BAEJ,MAAM,GAAC,IAAI,CA2FvB;IAED;;OAEG;IACH,kCAaC;;CACJ;AAED;;;;;;GAMG;AACH;IAUI;;OAEG;IACH,oBAFW,aAAa,EAMvB;IAED,yBAEC;;CACJ;uBA3iBsB,kBAAkB;oBACrB,+BAA+B;gCASnB,mDAAmD"}