Merge pull request #13641 from BabylonJS/animation-dispose-optimization

Improve how we delete massive group of animatables from animationgroup
BabylonJS · Mar 21, 2023 · d46cbb0 · d46cbb0
2 parents 2ef4b7c + 2e592cb
commit d46cbb0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git a/packages/dev/core/src/Animations/animatable.ts b/packages/dev/core/src/Animations/animatable.ts
@@ -16,7 +16,8 @@ export class Animatable {
     private _localDelayOffset: Nullable<number> = null;
     private _pausedDelay: Nullable<number> = null;
     private _manualJumpDelay: Nullable<number> = null;
-    private _runtimeAnimations = new Array<RuntimeAnimation>();
+    /** @hidden */
+    public _runtimeAnimations = new Array<RuntimeAnimation>();
     private _paused = false;
     private _scene: Scene;
     private _speedRatio = 1;
@@ -319,9 +320,10 @@ export class Animatable {
     /**
      * Stop and delete the current animation
      * @param animationName defines a string used to only stop some of the runtime animations instead of all
-     * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
+     * @param targetMask a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
+     * @param useGlobalSplice if true, the animatables will be removed by the caller of this function (false by default)
      */
-    public stop(animationName?: string, targetMask?: (target: any) => boolean): void {
+    public stop(animationName?: string, targetMask?: (target: any) => boolean, useGlobalSplice = false): void {
         if (animationName || targetMask) {
             const idx = this._scene._activeAnimatables.indexOf(this);
 
@@ -342,20 +344,20 @@ export class Animatable {
                 }
 
                 if (runtimeAnimations.length == 0) {
-                    this._scene._activeAnimatables.splice(idx, 1);
+                    if (!useGlobalSplice) {
+                        this._scene._activeAnimatables.splice(idx, 1);
+                    }
                     this._raiseOnAnimationEnd();
                 }
             }
         } else {
             const index = this._scene._activeAnimatables.indexOf(this);
 
             if (index > -1) {
-                this._scene._activeAnimatables.splice(index, 1);
-                const runtimeAnimations = this._runtimeAnimations;
-
-                for (let index = 0; index < runtimeAnimations.length; index++) {
-                    runtimeAnimations[index].dispose();
+                if (!useGlobalSplice) {
+                    this._scene._activeAnimatables.splice(index, 1);
                 }
+                this._runtimeAnimations.length = 0;
 
                 this._raiseOnAnimationEnd();
             }

diff --git a/packages/dev/core/src/Animations/animationGroup.ts b/packages/dev/core/src/Animations/animationGroup.ts
@@ -475,9 +475,12 @@ export class AnimationGroup implements IDisposable {
 
         const list = this._animatables.slice();
         for (let index = 0; index < list.length; index++) {
-            list[index].stop();
+            list[index].stop(undefined, undefined, true);
         }
 
+        // We will take care of removing all stopped animatables
+        this._scene._activeAnimatables = this._scene._activeAnimatables.filter((anim) => anim._runtimeAnimations.length > 0);
+
         this._isStarted = false;
 
         return this;

diff --git a/packages/dev/core/src/Animations/runtimeAnimation.ts b/packages/dev/core/src/Animations/runtimeAnimation.ts
@@ -317,6 +317,7 @@ export class RuntimeAnimation {
 
     /**
      * Disposes of the runtime animation
+     * Note: No hard dispose should happen here as this method is skipped for performance reason (look at animatable.stop())
      */
     public dispose(): void {
         const index = this._animation.runtimeAnimations.indexOf(this);