@woosh/meep-engine 3.3.0 → 3.4.0

package/src/engine/animation/AnimatedActions.d.ts

@@ -6,11 +6,16 @@
  */
 export function removeEntityStylish(entity: number, ecd: EntityComponentDataset): Promise<any>;
 /**
+ * Fade an entity's {@link AudioEmitter} to silence and resolve once it is quiet.
+ *
+ * The fade is driven on the component's `volume` rather than on the voice: a live volume write reaches
+ * the instance gain on both of `AudioEmitterSystem`'s play routes, so this one handle works for a
+ * spatially managed emitter and a direct one alike, and it needs no reference to the system.
  *
  * @param {number} entity
  * @param {EntityComponentDataset} ecd
  */
-export function stopSoundEmitterAndNotifyOnceFinished(entity: number, ecd: EntityComponentDataset): Promise<void>;
+export function stopAudioEmitterAndNotifyOnceFinished(entity: number, ecd: EntityComponentDataset): Promise<void>;
 /**
  *
  * @param {number} entity

package/src/engine/animation/AnimatedActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnimatedActions.d.ts","sourceRoot":"","sources":["../../../../src/engine/animation/AnimatedActions.js"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,4CAJW,MAAM,6CA4BhB;AAED;;;;GAIG;AACH,8DAHW,MAAM,8CAmBhB;AAGD;;;;;GAKG;AACH,uDAJW,MAAM,6CAUhB"}
+{"version":3,"file":"AnimatedActions.d.ts","sourceRoot":"","sources":["../../../../src/engine/animation/AnimatedActions.js"],"names":[],"mappings":"AAoBA;;;;;GAKG;AACH,4CAJW,MAAM,6CA4BhB;AAED;;;;;;;;;GASG;AACH,8DAHW,MAAM,8CAoChB;AAGD;;;;;GAKG;AACH,uDAJW,MAAM,6CAUhB"}

package/src/engine/animation/AnimatedActions.js

@@ -1,81 +1,111 @@
-import Vector3 from "../../core/geom/Vector3.js";
-import Timer from "../ecs/components/Timer.js";
-import { Transform } from "../ecs/transform/Transform.js";
-import { removeComponentsExcept } from "../ecs/util/removeComponentsExcept.js";
-import { SGMesh } from "../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
-import { ParticleEmitter } from "../graphics/particles/particular/engine/emitter/ParticleEmitter.js";
-import { SoundEmitter } from "../sound/ecs/emitter/SoundEmitter.js";
-import { shutdownParticleEmitter, stopTrailAndNotifyOnceFinished } from "./AnimationUtils.js";
-import EntityAnimation from "./EntityAnimation.js";
-import TransitionFunctions from "./TransitionFunctions.js";
-
-
-/**
- *
- * @param {number}  entity
- * @param {EntityComponentDataset} ecd
- * @returns {Promise}
- */
-export function removeEntityStylish(entity, ecd) {
-    //leave only model and transform
-    removeComponentsExcept(ecd, entity, [Transform, SGMesh, ParticleEmitter]);
-
-    const duration = 2;
-
-    //create animation
-    const animation = new EntityAnimation(entity);
-
-    const result = Promise.all([
-        animation.promiseEnd(),
-        stopEntityAndNotifyWhenStopped(entity, ecd)
-    ]).then(function () {
-        ecd.removeEntity(entity);
-    });
-
-
-    animation
-        .translate(new Vector3(0, 2, 0), duration, TransitionFunctions.EaseIn)
-        .fade(0, duration)
-        .start(ecd);
-
-
-    return result;
-}
-
-/**
- *
- * @param {number} entity
- * @param {EntityComponentDataset} ecd
- */
-export async function stopSoundEmitterAndNotifyOnceFinished(entity, ecd) {
-
-    if (!ecd.entityExists(entity)) {
-        return;
-    }
-
-    const soundEmitter = ecd.getComponent(entity, SoundEmitter);
-
-
-    if (soundEmitter === undefined) {
-        return;
-    }
-
-    soundEmitter.fadeOutAllTracks(0.3);
-
-    await Timer.createTimeoutPromise(ecd, 0.3);
-}
-
-
-/**
- *
- * @param {number} entity
- * @param {EntityComponentDataset} ecd
- * @returns {Promise}
- */
-export function stopEntityAndNotifyWhenStopped(entity, ecd) {
-    return Promise.all([
-        shutdownParticleEmitter(entity, ecd),
-        stopTrailAndNotifyOnceFinished(entity, ecd),
-        stopSoundEmitterAndNotifyOnceFinished(entity, ecd)
-    ]);
-}
+import Vector3 from "../../core/geom/Vector3.js";
+import { SerializationMetadata } from "../ecs/components/SerializationMetadata.js";
+import Entity from "../ecs/Entity.js";
+import { Transform } from "../ecs/transform/Transform.js";
+import { removeComponentsExcept } from "../ecs/util/removeComponentsExcept.js";
+import { SGMesh } from "../graphics/ecs/mesh-v2/aggregate/SGMesh.js";
+import { ParticleEmitter } from "../graphics/particles/particular/engine/emitter/ParticleEmitter.js";
+import { SequenceBehavior } from "../intelligence/behavior/composite/SequenceBehavior.js";
+import { BehaviorComponent } from "../intelligence/behavior/ecs/BehaviorComponent.js";
+import { DieBehavior } from "../intelligence/behavior/ecs/DieBehavior.js";
+import { ActionBehavior } from "../intelligence/behavior/primitive/ActionBehavior.js";
+import { AudioEmitter } from "../sound/ecs/audio/AudioEmitter.js";
+import { shutdownParticleEmitter, stopTrailAndNotifyOnceFinished } from "./AnimationUtils.js";
+import EntityAnimation from "./EntityAnimation.js";
+import AnimationTrack from "./keyed2/AnimationTrack.js";
+import AnimationTrackPlayback from "./keyed2/AnimationTrackPlayback.js";
+import { AnimationBehavior } from "./keyed2/behavior/AnimationBehavior.js";
+import TransitionFunctions from "./TransitionFunctions.js";
+
+
+/**
+ *
+ * @param {number}  entity
+ * @param {EntityComponentDataset} ecd
+ * @returns {Promise}
+ */
+export function removeEntityStylish(entity, ecd) {
+    //leave only model and transform
+    removeComponentsExcept(ecd, entity, [Transform, SGMesh, ParticleEmitter]);
+
+    const duration = 2;
+
+    //create animation
+    const animation = new EntityAnimation(entity);
+
+    const result = Promise.all([
+        animation.promiseEnd(),
+        stopEntityAndNotifyWhenStopped(entity, ecd)
+    ]).then(function () {
+        ecd.removeEntity(entity);
+    });
+
+
+    animation
+        .translate(new Vector3(0, 2, 0), duration, TransitionFunctions.EaseIn)
+        .fade(0, duration)
+        .start(ecd);
+
+
+    return result;
+}
+
+/**
+ * Fade an entity's {@link AudioEmitter} to silence and resolve once it is quiet.
+ *
+ * The fade is driven on the component's `volume` rather than on the voice: a live volume write reaches
+ * the instance gain on both of `AudioEmitterSystem`'s play routes, so this one handle works for a
+ * spatially managed emitter and a direct one alike, and it needs no reference to the system.
+ *
+ * @param {number} entity
+ * @param {EntityComponentDataset} ecd
+ */
+export async function stopAudioEmitterAndNotifyOnceFinished(entity, ecd) {
+
+    if (!ecd.entityExists(entity)) {
+        return;
+    }
+
+    const audioEmitter = ecd.getComponent(entity, AudioEmitter);
+
+    if (audioEmitter === undefined) {
+        return;
+    }
+
+    const fadeOutDuration = 0.3;
+
+    const volume = audioEmitter.volume;
+
+    const fade = new AnimationTrack(['volume']);
+
+    fade.addKey(0, [volume.getValue()]);
+    fade.addKey(fadeOutDuration, [0]);
+    fade.addTransition(0, TransitionFunctions.Linear);
+
+    //wait out the fade before reporting the emitter as stopped
+    await new Promise(resolve => {
+        new Entity()
+            .add(SerializationMetadata.Transient)
+            .add(BehaviorComponent.from(SequenceBehavior.from([
+                new AnimationBehavior(new AnimationTrackPlayback(fade, v => volume.set(v))),
+                new ActionBehavior(resolve),
+                DieBehavior.create()
+            ])))
+            .build(ecd);
+    });
+}
+
+
+/**
+ *
+ * @param {number} entity
+ * @param {EntityComponentDataset} ecd
+ * @returns {Promise}
+ */
+export function stopEntityAndNotifyWhenStopped(entity, ecd) {
+    return Promise.all([
+        shutdownParticleEmitter(entity, ecd),
+        stopTrailAndNotifyOnceFinished(entity, ecd),
+        stopAudioEmitterAndNotifyOnceFinished(entity, ecd)
+    ]);
+}

package/src/engine/animation/AnimationUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnimationUtils.d.ts","sourceRoot":"","sources":["../../../../src/engine/animation/AnimationUtils.js"],"names":[],"mappings":"AAsBA;;;;;GAKG;AACH,uDAJW,MAAM,6CA2BhB;AAED;;;;;GAKG;AACH,yDAJW,MAAM,6CA6DhB;AAGD;;;;;GAKG;AACH,gDAJW,MAAM,6CAmChB;AAED;;;;;;;;GAQG;AACH;;;;;;iBAoFC"}
+{"version":3,"file":"AnimationUtils.d.ts","sourceRoot":"","sources":["../../../../src/engine/animation/AnimationUtils.js"],"names":[],"mappings":"AAsBA;;;;;GAKG;AACH,uDAJW,MAAM,6CA2BhB;AAED;;;;;GAKG;AACH,yDAJW,MAAM,6CA2ChB;AAGD;;;;;GAKG;AACH,gDAJW,MAAM,6CAmChB;AAED;;;;;;;;GAQG;AACH;;;;;;iBAoFC"}