@woosh/meep-engine 3.11.3 → 3.12.0

package/src/engine/graphics3/WaterSystem3.js

@@ -1,293 +1,10 @@
-import { assert } from "../../core/assert.js";
-import Water from "../graphics/ecs/water/Water.js";
-import { WATER_SIZE } from "../graphics/ecs/water/WATER_SIZE.js";
-import { obtainTerrain } from "../ecs/terrain/util/obtainTerrain.js";
-import { System } from "../ecs/System.js";
-import { GPUWaterRenderer } from "../../shade/renderer/water/GPUWaterRenderer.js";
-import { water_height_texture_from_sampler } from "../../shade/renderer/water/water_height_texture_from_sampler.js";
-import { FramePhase } from "../../shade/renderer/extension/FramePhase.js";
-import { RenderExtension } from "../../shade/renderer/extension/RenderExtension.js";
-import { SceneColor } from "../../shade/renderer/extension/SceneColor.js";
-import { ViewTextures } from "../../shade/renderer/extension/ViewTextures.js";
+import { WaterSystem } from "./WaterSystem.js";
 
 /**
- * Draws the level's water under Shade.
+ * @deprecated Renamed to {@link WaterSystem}. The trailing `3` marked the 2.x → 3.x renderer transition;
+ * the 2.x name it disambiguated against is gone, so the suffix no longer distinguishes anything.
  *
- * **Water is a transparent pass on top of opaque**, so this system owns an extension rather than putting
- * anything in the scene: it registers once at startup against {@link FramePhase.AfterLighting} —
- * opaque lit and composited, transparency not yet run — and keeps a list of surfaces the pass draws.
- *
- * Registration does not wait for a device. `GraphicsEngine3` holds extensions and applies them
- * to the renderer when one exists and again after a restart (E9, §4.8).
- */
-export class WaterSystem3 extends System {
-    dependencies = [Water];
-
-    /**
-     * @type {GraphicsEngine3}
-     */
-    #graphics;
-
-    /**
-     * @type {GPUWaterRenderer}
-     */
-    #renderer = new GPUWaterRenderer();
-
-    /**
-     * What the pass draws, in link order.
-     *
-     * @type {WaterSurface[]}
-     */
-    #surfaces = [];
-
-    /**
-     * @type {Map<number, WaterSurface>}
-     */
-    #entries = new Map();
-
-    /**
-     * @type {RenderExtension|null}
-     */
-    #extension = null;
-
-    /**
-     * Seconds since startup. Waves are a function of it and nothing else advances it.
-     *
-     * @type {number}
-     */
-    #time = 0;
-
-    /**
-     * What the pass draws. Read-only — the surfaces follow the entities, and a harness that wants
-     * one gone takes its component off.
-     *
-     * @returns {WaterSurface[]}
-     */
-    get surfaces() {
-        return this.#surfaces;
-    }
-
-    /**
-     * @param {GraphicsEngine3} graphics
-     */
-    constructor(graphics) {
-        super();
-
-        assert.defined(graphics, 'graphics');
-
-        this.#graphics = graphics;
-    }
-
-    async startup(entityManager) {
-        this.entityManager = entityManager;
-
-        this.#extension = this.#graphics.add_extension(new WaterExtension(this));
-    }
-
-    async shutdown(entityManager) {
-        if (this.#extension !== null) {
-            this.#graphics.remove_extension(this.#extension);
-
-            this.#extension = null;
-        }
-
-        this.#surfaces.length = 0;
-        this.#entries.clear();
-    }
-
-    /**
-     * @param {FrameContext} frame
-     */
-    record(frame) {
-        if (this.#surfaces.length === 0) {
-            // nothing to draw, and the frame's colour is left exactly as it was
-            return;
-        }
-
-        const scene = frame.get(SceneColor);
-
-        scene.color = this.#renderer.graph_draw({
-            graph: frame.graph,
-            surfaces: this.#surfaces,
-            color: scene.color,
-            depth: frame.get(ViewTextures).depth,
-            camera: frame.view.camera.buffer
-        });
-    }
-
-    /**
-     * @param {Water} water
-     * @param {number} entity
-     */
-    link(water, entity) {
-        const surface = {
-            visible: true,
-            level: water.level.getValue(),
-            time: this.#time,
-            extent: new Float32Array(4),
-            height_uv: new Float32Array([0, 0, 1, 1]),
-            color_deep: new Float32Array(3),
-            color_shore: new Float32Array(3),
-            wave_amplitude: water.waveAmplitude.getValue(),
-            wave_speed: water.waveSpeed.getValue(),
-            wave_frequency: water.waveFrequency.getValue(),
-            scattering: water.scattering.getValue(),
-            shore_transition: new Float32Array(2),
-            height_texture: null,
-            height_data: null,
-            height_version: -1,
-            component: water
-        };
-
-        this.#entries.set(entity, surface);
-
-        this.#refresh(surface, water);
-
-        if (surface.height_texture !== null) {
-            this.#surfaces.push(surface);
-        }
-    }
-
-    /**
-     * @param {Water} water
-     * @param {number} entity
-     */
-    unlink(water, entity) {
-        const surface = this.#entries.get(entity);
-
-        if (surface === undefined) {
-            return;
-        }
-
-        const index = this.#surfaces.indexOf(surface);
-
-        if (index !== -1) {
-            this.#surfaces.splice(index, 1);
-        }
-
-        this.#entries.delete(entity);
-    }
-
-    update(timeDelta) {
-        this.#time += timeDelta;
-
-        for (const surface of this.#entries.values()) {
-            surface.time = this.#time;
-
-            this.#refresh(surface, surface.component);
-
-            if (surface.height_texture !== null && this.#surfaces.indexOf(surface) === -1) {
-                // the terrain arrived after the water did, which is ordinary at level-load rates
-                this.#surfaces.push(surface);
-            }
-        }
-    }
-
-    /**
-     * Copy the component's authored values across, and work out where the surface sits over the
-     * terrain it is flooding.
-     *
-     * @param {WaterSurface} surface
-     * @param {Water} water
-     */
-    #refresh(surface, water) {
-        surface.level = water.level.getValue();
-        surface.wave_amplitude = water.waveAmplitude.getValue();
-        surface.wave_speed = water.waveSpeed.getValue();
-        surface.wave_frequency = water.waveFrequency.getValue();
-        surface.scattering = water.scattering.getValue();
-
-        surface.color_deep[0] = water.color.r;
-        surface.color_deep[1] = water.color.g;
-        surface.color_deep[2] = water.color.b;
-
-        surface.color_shore[0] = water.shoreColor.r;
-        surface.color_shore[1] = water.shoreColor.g;
-        surface.color_shore[2] = water.shoreColor.b;
-
-        surface.shore_transition[0] = water.shoreDepthTransition.min;
-        surface.shore_transition[1] = water.shoreDepthTransition.max;
-
-        const terrain = obtainTerrain(this.entityManager.dataset);
-
-        if (terrain === null || terrain === undefined) {
-            // no terrain to flood; the shore line has nothing to read and the surface stays out of
-            // the pass until one exists
-            return;
-        }
-
-        const width = terrain.size.x * terrain.gridScale;
-        const height = terrain.size.y * terrain.gridScale;
-
-        /*
-         The legacy placement, read off it rather than derived: an 800-unit plane centred at
-         `WATER_SIZE / 4` on both axes, so it spans [-200, 600] regardless of how big the terrain is.
-         The map is an island in an ocean, not a lake fitted to the map, and where the surface hangs
-         past the terrain the height map clamps — which is what lets the shore line continue instead
-         of stopping at the boundary.
-
-         The three path stated the same thing as a UV transform,
-         `(uv - 0.25) * (WATER_SIZE / terrain_size)`, and the two agree by construction: world
-         position is `(u - 0.25) * WATER_SIZE`, and terrain uv is that over the terrain's own size.
-        */
-        const x0 = -WATER_SIZE * 0.25;
-        const z0 = -WATER_SIZE * 0.25;
-
-        surface.extent[0] = x0;
-        surface.extent[1] = z0;
-        surface.extent[2] = x0 + WATER_SIZE;
-        surface.extent[3] = z0 + WATER_SIZE;
-
-        surface.height_uv[0] = x0 / width;
-        surface.height_uv[1] = z0 / height;
-        surface.height_uv[2] = WATER_SIZE / width;
-        surface.height_uv[3] = WATER_SIZE / height;
-
-        const height_field = terrain.samplerHeight;
-
-        /*
-         The height field a water surface links against is not the one it will read. A `Terrain`
-         carries a 512² placeholder from the moment its entity exists, and the level's own field
-         arrives later — while Shade uploads a texture once and has no notion of one changing. So a
-         surface linked at load time would read a flat sea floor for the rest of the session.
-
-         Watched on the data array rather than on the sampler: `Sampler2D.fromJSON` replaces `data`
-         and leaves `version` alone, so deserialization is invisible to the counter. The version is
-         watched too, for the edits that do bump it and keep the array.
-        */
-        if (surface.height_data !== height_field.data || surface.height_version !== height_field.version) {
-            surface.height_texture = water_height_texture_from_sampler(height_field);
-            surface.height_data = height_field.data;
-            surface.height_version = height_field.version;
-        }
-    }
-}
-
-/**
- * Water is a transparent surface over the lit opaque scene, so it draws at
- * {@link FramePhase.AfterLighting} — opaque lit and composited, transparency not yet run, so what
- * transparency draws afterwards blends over the water rather than under it.
+ * Kept as a re-export rather than removed: this is a library, and an import path is as much a
+ * published interface as a class name.
  */
-export class WaterExtension extends RenderExtension {
-    name = "water";
-
-    phase = FramePhase.AfterLighting;
-
-    /**
-     * @type {WaterSystem3}
-     */
-    #system;
-
-    /**
-     * @param {WaterSystem3} system
-     */
-    constructor(system) {
-        super();
-
-        this.#system = system;
-    }
-
-    record(frame) {
-        this.#system.record(frame);
-    }
-}
+export const WaterSystem3 = WaterSystem;

package/src/engine/graphics3/animation/AnimationGraphController.d.ts

@@ -6,7 +6,7 @@
  * **The clock is here and not on the GPU**, and I-4 is what forces it. Shade advances clip time
  * itself in its tick shader, but the time gameplay reads has to be the time the picture is drawn
  * from: notifications fire at authored moments off this clock, and the CPU pose evaluator answers
- * socket queries from it. Two clocks drift, so there is one, and {@link AnimationGraphSystem3}
+ * socket queries from it. Two clocks drift, so there is one, and {@link AnimationGraphSystem}
  * writes it down to the renderer with `set_time` rather than letting the GPU advance anything.
  *
  * The state machine itself is not new — `AnimationState`, `AnimationTransition`, `BlendStateMatrix`