@woosh/meep-engine 3.11.2 → 3.12.0

package/src/engine/graphics3/AnimationSystem.js

@@ -0,0 +1,352 @@
+import { assert } from "../../core/assert.js";
+import { PosePlayback } from "../../shade/renderer/animation/pose/PosePlayback.js";
+import { Animation } from "../ecs/animation/Animation.js";
+import { System } from "../ecs/System.js";
+import { SGMesh } from "../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
+import { ClipListPlayer } from "./animation/ClipListPlayer.js";
+import { write_clip_playback } from "./animation/write_clip_playback.js";
+import {
+    register_instance_clips,
+    unregister_instance_clips
+} from "./register_instance_animation.js";
+
+/**
+ * @type {ClipPlayback[]}
+ */
+const NOTHING = Object.freeze([]);
+
+/**
+ * Drives every entity's {@link Animation} component: runs the clocks of the clips its list names,
+ * and tells the renderer what each of them weighs and where it is playing.
+ *
+ * The list path is what the game uses wherever there is no state machine — buildings, critters and
+ * the strategy map's groups — and {@link ClipListPlayer} is what plays it. This is the ECS half:
+ * which entity has which model, and when the ids the renderer issued for it stopped meaning
+ * anything.
+ *
+ * **It is the CPU that plays the animation and the GPU that draws it.** Shade can advance a clip
+ * itself, and this never asks it to — `AnimationClipFlags.Playing` is left clear and every audible
+ * clip's time is written down each frame from the player's own clock. That is I-4: the pose
+ * gameplay reads and the pose on the screen have to be the same pose, and they cannot be if two
+ * clocks are running.
+ *
+ * **Nothing here is culled.** The legacy system skipped entities under 32 px², which let camera
+ * framing decide whether a clip ever reached its end. What may be culled is drawing, and drawing is
+ * Shade's to cull.
+ */
+export class AnimationSystem extends System {
+    /**
+     * @type {GraphicsEngine}
+     */
+    #graphics;
+
+    /**
+     * The system that owns the scene, the model instances, and the ids the animation manager issued
+     * for them.
+     *
+     * @type {MeshSystem}
+     */
+    #meshes;
+
+    /**
+     * @type {Map<number, {player: ClipListPlayer, instance: SceneBundleInstance|null, clip_registration: InstanceClipRegistration|null, played_slots: Int32Array, written: Float32Array, poses: PosePlayback[]}>}
+     */
+    #entries = new Map();
+
+    /**
+     * @param {GraphicsEngine} graphics
+     * @param {MeshSystem} meshes
+     */
+    constructor(graphics, meshes) {
+        super();
+
+        assert.defined(graphics, 'graphics');
+        assert.defined(meshes, 'meshes');
+
+        this.#graphics = graphics;
+        this.#meshes = meshes;
+
+        this.dependencies = [Animation, SGMesh];
+    }
+
+    /**
+     * What an entity is playing, and where each of them is.
+     *
+     * One entry per clip in the component's list, in the list's own order. Empty for an entity this
+     * system is not driving — one that has left, or one whose model has not arrived, which is the
+     * same wait the clip durations are on.
+     *
+     * @param {number} entity
+     * @returns {ClipPlayback[]}
+     */
+    playbacks_of(entity) {
+        const entry = this.#entries.get(entity);
+
+        if (entry === undefined) {
+            return NOTHING;
+        }
+
+        return entry.player.playbacks;
+    }
+
+    /**
+     * What the entity's model is playing, in the form the CPU pose evaluator takes: one entry per
+     * clip the model carries, at the weight and the time the renderer has been given.
+     *
+     * **Only the clips the list names are here, because they are the only ones registered** (D37).
+     * The GPU's accumulator marks a joint dirty for every bound clip that writes to it, weight and
+     * all — so a bound clip at weight zero resolves the joints only it drives to zero rather than
+     * leaving them at rest. The answer is not to hand the surplus to the evaluator so it agrees with
+     * a mistake; it is not to bind them, and then a clip of the model nothing names moves nothing.
+     *
+     * The entries are this system's own and are rewritten by the next call, which is what keeps a
+     * query on a per-frame path from allocating.
+     *
+     * @param {PosePlayback[]} target appended to
+     * @param {number} entity
+     * @returns {boolean} whether this system is driving the entity — `false` for one with no
+     * {@link Animation}, and for one whose model has not arrived
+     */
+    write_pose_playbacks(target, entity) {
+        const entry = this.#entries.get(entity);
+
+        if (entry === undefined || entry.instance === null) {
+            return false;
+        }
+
+        const clips = entry.instance.clips;
+        const weights = entry.player.weights;
+        const poses = entry.poses;
+        const played = entry.played_slots;
+
+        for (let i = 0; i < played.length; i++) {
+            const slot = played[i];
+            const pose = poses[slot];
+
+            pose.clip = clips[slot];
+            pose.weight = weights[slot];
+
+            // a clip the list names but has stopped playing is where it stopped, and at weight zero
+            // that is nowhere in particular
+            pose.time = 0;
+        }
+
+        const playbacks = entry.player.playbacks;
+
+        for (let i = 0; i < playbacks.length; i++) {
+            const playback = playbacks[i];
+
+            poses[playback.slot].time = playback.time;
+        }
+
+        for (let i = 0; i < played.length; i++) {
+            target.push(poses[played[i]]);
+        }
+
+        return true;
+    }
+
+    /**
+     * @param {Animation} component
+     * @param {SGMesh} model
+     * @param {number} entity
+     */
+    link(component, model, entity) {
+        this.#entries.set(entity, {
+            player: ClipListPlayer.from(component),
+            instance: null,
+            clip_registration: null,
+            played_slots: new Int32Array(0),
+            written: new Float32Array(0),
+            poses: []
+        });
+    }
+
+    /**
+     * @param {Animation} component
+     * @param {SGMesh} model
+     * @param {number} entity
+     */
+    unlink(component, model, entity) {
+        const entry = this.#entries.get(entity);
+
+        if (entry !== undefined) {
+            this.#release_clips(entry);
+        }
+
+        this.#entries.delete(entity);
+    }
+
+    async shutdown(entityManager) {
+        for (const entry of this.#entries.values()) {
+            this.#release_clips(entry);
+        }
+
+        this.#entries.clear();
+    }
+
+    /**
+     * Give this entity's clips back, if the manager that issued them is still the one running.
+     *
+     * **An id may only be handed back to the manager that issued it.** A renderer restart replaces
+     * the GPU scene context and voids every id it gave out, so a registration stamped with a context
+     * that is no longer current is forgotten rather than returned.
+     *
+     * @param {object} entry
+     */
+    #release_clips(entry) {
+        this.#release_clips_only(entry);
+
+        entry.played_slots = new Int32Array(0);
+    }
+
+    /**
+     * The registration alone, leaving {@link #refresh_played_slots}'s answer where it is — which is
+     * what a re-registration wants, since the set it is about to register with is the current one.
+     *
+     * @param {object} entry
+     */
+    #release_clips_only(entry) {
+        const registration = entry.clip_registration;
+
+        if (registration === null) {
+            return;
+        }
+
+        if (registration.context === this.#graphics.scene_context(this.#meshes.scene)) {
+            unregister_instance_clips(registration);
+        }
+
+        entry.clip_registration = null;
+    }
+
+    /**
+     * Which of the model's clips the list currently names, kept up to date.
+     *
+     * **The list is edited while the game runs** — `ClipListPlayer` reconciles its playbacks against
+     * it every tick, and `StopAnimationBehavior` empties it outright — so which clips are playable
+     * is not settled once at bind.
+     *
+     * Maintained here rather than alongside the registration because **the pose evaluator needs it
+     * whether or not there is a device**: `query_entity_node_world_pose` answers on the CPU, from
+     * the clips this driver plays, and a game with rendering disabled still asks (I-4).
+     *
+     * @param {object} entry
+     * @returns {boolean} whether the set changed
+     */
+    #refresh_played_slots(entry) {
+        const playbacks = entry.player.playbacks;
+        const played = entry.played_slots;
+
+        /*
+         The distinct slots, and distinct is the point: two entries of the list can name one clip of
+         the model, so the number of playbacks is not the number of clips. Comparing the two would
+         report a change on every frame for a list that had not moved, and a change here is a
+         re-registration.
+        */
+        const wanted = [];
+
+        for (let i = 0; i < playbacks.length; i++) {
+            const slot = playbacks[i].slot;
+
+            if (wanted.indexOf(slot) === -1) {
+                wanted.push(slot);
+            }
+        }
+
+        if (wanted.length === played.length) {
+            let same = true;
+
+            for (let i = 0; i < wanted.length; i++) {
+                if (played[i] !== wanted[i]) {
+                    same = false;
+                    break;
+                }
+            }
+
+            if (same) {
+                return false;
+            }
+        }
+
+        entry.played_slots = Int32Array.from(wanted);
+
+        return true;
+    }
+
+    /**
+     * Keep the registered clips equal to the ones the list names.
+     *
+     * A clip that leaves the list has to be unregistered, or it stays bound at weight zero and takes
+     * the joints only it drives down to zero with it.
+     *
+     * @param {object} entry
+     * @param {SceneBundleInstance} instance
+     * @param {GPUSceneContext} context
+     * @param {boolean} set_changed whether {@link #refresh_played_slots} just moved
+     * @returns {boolean} whether the registration was replaced
+     */
+    #refresh_clips(entry, instance, context, set_changed) {
+        const registration = entry.clip_registration;
+
+        if (!set_changed && registration !== null && registration.context === context) {
+            return false;
+        }
+
+        this.#release_clips_only(entry);
+
+        entry.clip_registration = register_instance_clips(context, instance, entry.played_slots);
+
+        return true;
+    }
+
+    /**
+     * @param {number} time_delta_seconds
+     */
+    update(time_delta_seconds) {
+        const ecd = this.entityManager.dataset;
+
+        const context = this.#graphics.scene_context(this.#meshes.scene);
+
+        // No device — before the first start, and again after a stop. The clocks still run: a clip
+        // that ends while the renderer is being replaced still says so.
+        const manager = context === null ? null : context.animation_manager;
+
+        for (const [entity, entry] of this.#entries) {
+            const instance = this.#meshes.instance_of(entity);
+
+            if (instance === null) {
+                // the model has not arrived, and its clips are what say how long they run
+                continue;
+            }
+
+            if (instance !== entry.instance) {
+                entry.instance = instance;
+
+                entry.player.bind(entity, ecd, instance);
+
+                entry.written = new Float32Array(instance.clips.length).fill(-1);
+                entry.poses = instance.clips.map(() => new PosePlayback());
+
+                // ids the manager issued for the model that was here before name clips this one
+                // does not have
+                this.#release_clips(entry);
+            }
+
+            entry.player.tick(time_delta_seconds);
+
+            const set_changed = this.#refresh_played_slots(entry);
+
+            if (context === null) {
+                continue;
+            }
+
+            if (this.#refresh_clips(entry, instance, context, set_changed)) {
+                // whatever the last registration was told is not what this one knows
+                entry.written.fill(-1);
+            }
+
+            write_clip_playback(manager, entry.player, entry.clip_registration.ids, entry.written);
+        }
+    }
+}

package/src/engine/graphics3/AnimationSystem3.d.ts

@@ -1,76 +1,10 @@
 /**
- * Drives every entity's {@link Animation} component: runs the clocks of the clips its list names,
- * and tells the renderer what each of them weighs and where it is playing.
+ * @deprecated Renamed to {@link AnimationSystem}. 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.
  *
- * The list path is what the game uses wherever there is no state machine — buildings, critters and
- * the strategy map's groups — and {@link ClipListPlayer} is what plays it. This is the ECS half:
- * which entity has which model, and when the ids the renderer issued for it stopped meaning
- * anything.
- *
- * **It is the CPU that plays the animation and the GPU that draws it.** Shade can advance a clip
- * itself, and this never asks it to — `AnimationClipFlags.Playing` is left clear and every audible
- * clip's time is written down each frame from the player's own clock. That is I-4: the pose
- * gameplay reads and the pose on the screen have to be the same pose, and they cannot be if two
- * clocks are running.
- *
- * **Nothing here is culled.** The legacy system skipped entities under 32 px², which let camera
- * framing decide whether a clip ever reached its end. What may be culled is drawing, and drawing is
- * Shade's to cull.
+ * 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 AnimationSystem3 extends System<any> {
-    /**
-     * @param {GraphicsEngine3} graphics
-     * @param {MeshSystem3} meshes
-     */
-    constructor(graphics: GraphicsEngine3, meshes: MeshSystem3);
-    dependencies: (typeof SGMesh | typeof Animation)[];
-    /**
-     * What an entity is playing, and where each of them is.
-     *
-     * One entry per clip in the component's list, in the list's own order. Empty for an entity this
-     * system is not driving — one that has left, or one whose model has not arrived, which is the
-     * same wait the clip durations are on.
-     *
-     * @param {number} entity
-     * @returns {ClipPlayback[]}
-     */
-    playbacks_of(entity: number): ClipPlayback[];
-    /**
-     * What the entity's model is playing, in the form the CPU pose evaluator takes: one entry per
-     * clip the model carries, at the weight and the time the renderer has been given.
-     *
-     * **Only the clips the list names are here, because they are the only ones registered** (D37).
-     * The GPU's accumulator marks a joint dirty for every bound clip that writes to it, weight and
-     * all — so a bound clip at weight zero resolves the joints only it drives to zero rather than
-     * leaving them at rest. The answer is not to hand the surplus to the evaluator so it agrees with
-     * a mistake; it is not to bind them, and then a clip of the model nothing names moves nothing.
-     *
-     * The entries are this system's own and are rewritten by the next call, which is what keeps a
-     * query on a per-frame path from allocating.
-     *
-     * @param {PosePlayback[]} target appended to
-     * @param {number} entity
-     * @returns {boolean} whether this system is driving the entity — `false` for one with no
-     * {@link Animation}, and for one whose model has not arrived
-     */
-    write_pose_playbacks(target: PosePlayback[], entity: number): boolean;
-    /**
-     * @param {Animation} component
-     * @param {SGMesh} model
-     * @param {number} entity
-     */
-    link(component: Animation, model: SGMesh, entity: number): void;
-    /**
-     * @param {Animation} component
-     * @param {SGMesh} model
-     * @param {number} entity
-     */
-    unlink(component: Animation, model: SGMesh, entity: number): void;
-    shutdown(entityManager: any): Promise<void>;
-    #private;
-}
-import { System } from "../ecs/System.js";
-import { SGMesh } from "../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
-import { Animation } from "../ecs/animation/Animation.js";
-import { PosePlayback } from "../../shade/renderer/animation/pose/PosePlayback.js";
+export const AnimationSystem3: typeof AnimationSystem;
+import { AnimationSystem } from "./AnimationSystem.js";
 //# sourceMappingURL=AnimationSystem3.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AnimationSystem3.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/AnimationSystem3.js"],"names":[],"mappings":"AAiBA;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAmBI;;;OAGG;IACH,4DAUC;IADG,mDAAuC;IAG3C;;;;;;;;;OASG;IACH,qBAHW,MAAM,GACJ,cAAc,CAU1B;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,6BALW,YAAY,EAAE,UACd,MAAM,GACJ,OAAO,CAwCnB;IAED;;;;OAIG;IACH,gBAJW,SAAS,SACT,MAAM,UACN,MAAM,QAWhB;IAED;;;;OAIG;IACH,kBAJW,SAAS,SACT,MAAM,UACN,MAAM,QAUhB;IAED,4CAMC;;CAsKJ;uBA5VsB,kBAAkB;uBAClB,6CAA6C;0BAF1C,+BAA+B;6BAD5B,qDAAqD"}
+{"version":3,"file":"AnimationSystem3.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/AnimationSystem3.js"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,sDAAgD;gCAThB,sBAAsB"}