@woosh/meep-engine 3.42.0 → 3.44.0

package/src/engine/graphics3/AnimationGraphSystem.js

@@ -3,18 +3,19 @@ import { ResourceAccessKind } from "../../core/model/ResourceAccessKind.js";
 import { ResourceAccessSpecification } from "../../core/model/ResourceAccessSpecification.js";
 import { PosePlayback } from "../../shade/renderer/animation/pose/PosePlayback.js";
 import { System } from "../ecs/System.js";
-import { SGMesh } from "../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
+import { AnimationClips } from "./animation/AnimationClips.js";
 import { AnimationGraphController } from "./animation/AnimationGraphController.js";
 import { write_graph_playback } from "./animation/write_graph_playback.js";
-import {
-    register_instance_clips,
-    unregister_instance_clips
-} from "./register_instance_animation.js";
+import { register_clips, unregister_clips } from "./register_clips.js";
 
 /**
  * Drives every entity's {@link AnimationGraphController}: runs its clock, and tells the renderer
  * what its clips weigh and where they are playing.
  *
+ * **The clips are the entity's {@link AnimationClips}.** An entity is driven while it carries both
+ * components, whoever put them there — a model `MeshSystem` loaded, or a rig built in code. New
+ * clips are a new component, which this system sees as the entity leaving and coming back.
+ *
  * **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 controller's own clock. That is I-4: the pose
@@ -23,7 +24,7 @@ import {
  *
  * **Nothing here is culled.** The legacy system skipped entities smaller than 32 px², which let
  * camera framing decide whether a footstep effect or an ability release ever happened. The clock and
- * its notifications are gameplay and run for every entity whose model has arrived; what may be
+ * its notifications are gameplay and run for every entity whose clips have arrived; what may be
  * culled is drawing, and drawing is Shade's to cull.
  */
 export class AnimationGraphSystem extends System {
@@ -33,32 +34,31 @@ export class AnimationGraphSystem extends System {
     #graphics;
 
     /**
-     * The system that owns the scene, the model instances, and the ids the animation manager issued
-     * for them.
+     * The scene whose GPU context issues the clip ids.
      *
-     * @type {MeshSystem}
+     * @type {Scene}
      */
-    #meshes;
+    #scene;
 
     /**
-     * @type {Map<number, {controller: AnimationGraphController, instance: PrefabInstance|null, clip_registration: InstanceClipRegistration|null, slots: Int32Array, played_slots: Int32Array, clip_ids: Int32Array, weights: Float32Array, poses: PosePlayback[]}>}
+     * @type {Map<number, {controller: AnimationGraphController, clips: ShadeAnimationClip[], bound: boolean, clip_registration: ClipRegistration|null, slots: Int32Array, played_slots: Int32Array, clip_ids: Int32Array, weights: Float32Array, poses: PosePlayback[]}>}
      */
     #entries = new Map();
 
     /**
      * @param {GraphicsEngine} graphics
-     * @param {MeshSystem} meshes
+     * @param {Scene} scene
      */
-    constructor(graphics, meshes) {
+    constructor(graphics, scene) {
         super();
 
         assert.defined(graphics, 'graphics');
-        assert.defined(meshes, 'meshes');
+        assert.equal(scene?.isScene, true, 'scene.isScene !== true');
 
         this.#graphics = graphics;
-        this.#meshes = meshes;
+        this.#scene = scene;
 
-        this.dependencies = [AnimationGraphController, SGMesh];
+        this.dependencies = [AnimationGraphController, AnimationClips];
 
         // this tick's clip times are this system's to set: whatever evaluates a pose from them
         // (exact queries, IK's base pose) reads AnimationGraphController and so runs after it
@@ -68,14 +68,20 @@ export class AnimationGraphSystem extends System {
     }
 
     /**
+     * Only noted here: the graph is bound to the clips by the next {@link update}. A link can happen
+     * anywhere the components are added — inside a model's spawn, for one `MeshSystem` loads — and a
+     * graph naming a clip the entity has not got throws, which belongs in this system's tick and not
+     * in whoever added the component.
+     *
      * @param {AnimationGraphController} controller
-     * @param {SGMesh} model
+     * @param {AnimationClips} clips
      * @param {number} entity
      */
-    link(controller, model, entity) {
+    link(controller, clips, entity) {
         this.#entries.set(entity, {
             controller,
-            instance: null,
+            clips: clips.clips,
+            bound: false,
             clip_registration: null,
             slots: new Int32Array(0),
             played_slots: new Int32Array(0),
@@ -86,15 +92,15 @@ export class AnimationGraphSystem extends System {
     }
 
     /**
-     * What the entity's model is playing, in the form the CPU pose evaluator takes: one entry per
-     * clip **this graph names**, at the weight and the time the renderer has been given.
+     * What the entity is playing, in the form the CPU pose evaluator takes: one entry per clip
+     * **this graph names**, at the weight and the time the renderer has been given.
      *
      * **The clips the graph does not name are not here, because they are not 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 those clips to the evaluator so it can make
      * the same mistake; it is not to bind them. What the graph never names, nothing plays, and the
-     * joints it alone would have driven stay where the model rests.
+     * joints it alone would have driven stay where they rest.
      *
      * A clip the graph names but is not currently playing **is** here, at weight zero, because it is
      * bound and the accumulator does see it.
@@ -105,16 +111,17 @@ export class AnimationGraphSystem extends System {
      * @param {PosePlayback[]} target appended to
      * @param {number} entity
      * @returns {boolean} whether this system is driving the entity — `false` for one with no
-     * {@link AnimationGraphController}, and for one whose model has not arrived
+     * {@link AnimationGraphController} or no {@link AnimationClips}, and for one whose clips arrived
+     * since the last update
      */
     write_pose_playbacks(target, entity) {
         const entry = this.#entries.get(entity);
 
-        if (entry === undefined || entry.instance === null) {
+        if (entry === undefined || !entry.bound) {
             return false;
         }
 
-        const clips = entry.instance.clips;
+        const clips = entry.clips;
         const poses = entry.poses;
         const played = entry.played_slots;
 
@@ -136,7 +143,7 @@ export class AnimationGraphSystem extends System {
             const weight = weights[i];
 
             // assignment rather than accumulation, and it matters only where two of the graph's
-            // clips are one clip of the model: the renderer is written to in this order too, so the
+            // clips are one clip of the entity: the renderer is written to in this order too, so the
             // last of them is what it holds
             pose.weight = weight;
 
@@ -155,10 +162,10 @@ export class AnimationGraphSystem extends System {
 
     /**
      * @param {AnimationGraphController} controller
-     * @param {SGMesh} model
+     * @param {AnimationClips} clips
      * @param {number} entity
      */
-    unlink(controller, model, entity) {
+    unlink(controller, clips, entity) {
         controller.unlink();
 
         const entry = this.#entries.get(entity);
@@ -186,7 +193,7 @@ export class AnimationGraphSystem extends System {
      * **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 — returning it would corrupt a
-     * stranger's table. Same rule as {@link unregister_instance_animation}, same `===`.
+     * stranger's table. Same rule as {@link unregister_clips}, same `===`.
      *
      * @param {object} entry
      */
@@ -197,8 +204,8 @@ export class AnimationGraphSystem extends System {
             return;
         }
 
-        if (registration.context === this.#graphics.scene_context(this.#meshes.scene)) {
-            unregister_instance_clips(registration);
+        if (registration.context === this.#graphics.scene_context(this.#scene)) {
+            unregister_clips(registration);
         }
 
         entry.clip_registration = null;
@@ -210,22 +217,15 @@ export class AnimationGraphSystem extends System {
     update(time_delta_seconds) {
         const ecd = this.entityManager.dataset;
 
-        const context = this.#graphics.scene_context(this.#meshes.scene);
+        const context = this.#graphics.scene_context(this.#scene);
 
         // No device — before the first start, and again after a stop. The clocks still run: a unit
         // that fires an ability while the renderer is being replaced still fires it.
         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) {
-                this.#bind_model(entry, entity, instance, ecd);
+            if (!entry.bound) {
+                this.#bind_clips(entry, entity, ecd);
             }
 
             entry.controller.tick(time_delta_seconds);
@@ -240,7 +240,7 @@ export class AnimationGraphSystem extends System {
              noticed — in one comparison, without depending on when anything last ran.
             */
             if (entry.clip_registration === null || entry.clip_registration.context !== context) {
-                this.#bind_gpu(entry, instance, context);
+                this.#bind_gpu(entry, context);
             }
 
             write_graph_playback(manager, entry.controller, entry.clip_ids, entry.weights);
@@ -248,15 +248,16 @@ export class AnimationGraphSystem extends System {
     }
 
     /**
-     * Bind the graph to a model: work out which of the model's clips each of the graph's clips is,
-     * how long each of them runs, and start the graph on that.
+     * Bind the graph to the entity's clips: work out which of them each of the graph's clips is, how
+     * long each of them runs, and start the graph on that.
      *
      * @param {object} entry
      * @param {number} entity
-     * @param {PrefabInstance} instance
      * @param {EntityComponentDataset} ecd
      */
-    #bind_model(entry, entity, instance, ecd) {
+    #bind_clips(entry, entity, ecd) {
+        const clips = entry.clips;
+
         const clip_index = entry.controller.def.clipIndex;
         const clip_count = clip_index.length;
 
@@ -266,26 +267,25 @@ export class AnimationGraphSystem extends System {
         for (let i = 0; i < clip_count; i++) {
             const name = clip_index[i].name;
 
-            const slot = instance.clips.findIndex(clip => clip.name === name);
+            const slot = clips.findIndex(clip => clip.name === name);
 
             if (slot === -1) {
-                throw new Error(`Animation clip '${name}' is not in the model`);
+                throw new Error(`Animation clip '${name}' is not among the clips of entity ${entity}`);
             }
 
             slots[i] = slot;
-            durations[i] = instance.clips[slot].duration;
+            durations[i] = clips[slot].duration;
         }
 
         entry.controller.unlink();
         entry.controller.link(entity, ecd, durations);
 
-        entry.instance = instance;
         entry.slots = slots;
 
         /*
-         The distinct clips of the model this graph plays. Two states can name one clip — an idle a
-         hurt returns to, say — and it is one row on the GPU either way, so it is one entry here:
-         registered once, reported to the pose evaluator once.
+         The distinct clips this graph plays. Two states can name one clip — an idle a hurt returns
+         to, say — and it is one row on the GPU either way, so it is one entry here: registered once,
+         reported to the pose evaluator once.
         */
         const played = [];
 
@@ -299,28 +299,25 @@ export class AnimationGraphSystem extends System {
 
         entry.clip_ids = new Int32Array(clip_count);
         entry.weights = new Float32Array(clip_count).fill(-1);
-        entry.poses = instance.clips.map(() => new PosePlayback());
+        entry.poses = 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.bound = true;
     }
 
     /**
      * Make this graph's clips playable, and take up the ids that come back.
      *
      * **Only the clips the graph names are registered** (D37), so there is nothing to silence: a
-     * clip of the model no state plays is never bound, never marks a joint, and leaves the joints
-     * only it would have driven at rest. What this used to do instead — register everything and then
-     * write a zero weight over the surplus — kept them bound, and a bound clip at weight zero
-     * resolves its joints to zero rather than to the model's own pose.
+     * clip no state plays is never bound, never marks a joint, and leaves the joints only it would
+     * have driven at rest. What this used to do instead — register everything and then write a zero
+     * weight over the surplus — kept them bound, and a bound clip at weight zero resolves its joints
+     * to zero rather than to the rig's own pose.
      *
      * @param {object} entry
-     * @param {PrefabInstance} instance
      * @param {GPUSceneContext} context
      */
-    #bind_gpu(entry, instance, context) {
-        const registration = register_instance_clips(context, instance, entry.played_slots);
+    #bind_gpu(entry, context) {
+        const registration = register_clips(context, entry.clips, entry.played_slots);
 
         const slots = entry.slots;
         const clip_ids = entry.clip_ids;

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

@@ -4,9 +4,13 @@
  *
  * 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
+ * which clips each entity has, and when the ids the renderer issued for them stopped meaning
  * anything.
  *
+ * **The clips are the entity's {@link AnimationClips}.** An entity is driven while it carries both
+ * components, whoever put them there — a model `MeshSystem` loaded, or a rig built in code. New
+ * clips are a new component, which this system sees as the entity leaving and coming back.
+ *
  * **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
@@ -20,31 +24,31 @@
 export class AnimationSystem extends System<any> {
     /**
      * @param {GraphicsEngine} graphics
-     * @param {MeshSystem} meshes
+     * @param {Scene} scene
      */
-    constructor(graphics: GraphicsEngine, meshes: MeshSystem);
-    dependencies: (typeof SGMesh | typeof Animation)[];
+    constructor(graphics: GraphicsEngine, scene: Scene);
+    dependencies: (typeof Animation | typeof AnimationClips)[];
     components_used: ResourceAccessSpecification<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.
+     * system is not driving — one that has left, or one whose clips arrived since the last update.
      *
      * @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.
+     * What the entity is playing, in the form the CPU pose evaluator takes: one entry per clip of its
+     * {@link AnimationClips} that the list names, 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.
+     * a mistake; it is not to bind them, and then a clip 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.
@@ -52,27 +56,32 @@ export class AnimationSystem extends System<any> {
      * @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
+     * {@link Animation} or no {@link AnimationClips}, and for one whose clips arrived since the last
+     * update
      */
     write_pose_playbacks(target: PosePlayback[], entity: number): boolean;
     /**
+     * Only noted here: the clips are taken up by the next {@link update}. A link can happen anywhere
+     * the components are added — inside a model's spawn, for one `MeshSystem` loads — and binding is
+     * this system's work, on its own tick.
+     *
      * @param {Animation} component
-     * @param {SGMesh} model
+     * @param {AnimationClips} clips
      * @param {number} entity
      */
-    link(component: Animation, model: SGMesh, entity: number): void;
+    link(component: Animation, clips: AnimationClips, entity: number): void;
     /**
      * @param {Animation} component
-     * @param {SGMesh} model
+     * @param {AnimationClips} clips
      * @param {number} entity
      */
-    unlink(component: Animation, model: SGMesh, entity: number): void;
+    unlink(component: Animation, clips: AnimationClips, 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 { AnimationClips } from "./animation/AnimationClips.js";
 import { ResourceAccessSpecification } from "../../core/model/ResourceAccessSpecification.js";
 import { PosePlayback } from "../../shade/renderer/animation/pose/PosePlayback.js";
 //# sourceMappingURL=AnimationSystem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AnimationSystem.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/AnimationSystem.js"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAmBI;;;OAGG;IACH,0DAgBC;IAPG,mDAAuC;IAIvC,iEAEC;IAGL;;;;;;;;;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;uBAlWsB,kBAAkB;uBAClB,6CAA6C;0BAF1C,+BAA+B;4CAFb,iDAAiD;6BAChE,qDAAqD"}
+{"version":3,"file":"AnimationSystem.d.ts","sourceRoot":"","sources":["../../../../src/engine/graphics3/AnimationSystem.js"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IAkBI;;;OAGG;IACH,oDAgBC;IAPG,2DAA+C;IAI/C,iEAEC;IAGL;;;;;;;;OAQG;IACH,qBAHW,MAAM,GACJ,cAAc,CAU1B;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,6BANW,YAAY,EAAE,UACd,MAAM,GACJ,OAAO,CAyCnB;IAED;;;;;;;;OAQG;IACH,gBAJW,SAAS,SACT,cAAc,UACd,MAAM,QAYhB;IAED;;;;OAIG;IACH,kBAJW,SAAS,SACT,cAAc,UACd,MAAM,QAUhB;IAED,4CAMC;;CAsKJ;uBAxWsB,kBAAkB;0BADf,+BAA+B;+BAE1B,+BAA+B;4CAJlB,iDAAiD;6BAChE,qDAAqD"}