Added onTick event to animations. (#415)

src/common/CommonTypes.ts

@@ -130,3 +130,10 @@ export interface FrameTickPayload {
   time: number;
   delta: number;
 }
+
+/**
+ * Event payload for when a an animtion tick event is emitted
+ */
+export interface AnimationTickPayload {
+  progress: number;
+}

src/core/animations/CoreAnimation.ts

@@ -329,6 +329,10 @@ export class CoreAnimation extends EventEmitter {
       }
     }
 
+    if (this.progress < 1) {
+      this.emit('tick', { progress: this.progress });
+    }
+
     if (this.progress === 1) {
       this.emit('finished', {});
     }

src/core/animations/CoreAnimationController.ts

@@ -26,6 +26,7 @@ import type { AnimationManager } from './AnimationManager.js';
 import type { CoreAnimation } from './CoreAnimation.js';
 import { assertTruthy } from '../../utils.js';
 import { EventEmitter } from '../../common/EventEmitter.js';
+import type { AnimationTickPayload } from '../../common/CommonTypes.js';
 
 export class CoreAnimationController
   extends EventEmitter
@@ -50,6 +51,7 @@ export class CoreAnimationController
     // Bind event handlers
     this.onAnimating = this.onAnimating.bind(this);
     this.onFinished = this.onFinished.bind(this);
+    this.onTick = this.onTick.bind(this);
   }
 
   start(): IAnimationController {
@@ -93,6 +95,7 @@ export class CoreAnimationController
     // Hook up event listeners
     this.animation.once('finished', this.onFinished);
     this.animation.on('animating', this.onAnimating);
+    this.animation.on('tick', this.onTick);
     // Then register the animation
     this.manager.registerAnimation(this.animation);
   }
@@ -103,6 +106,7 @@ export class CoreAnimationController
     // Then unhook event listeners
     this.animation.off('finished', this.onFinished);
     this.animation.off('animating', this.onAnimating);
+    this.animation.off('tick', this.onTick);
   }
 
   private makeStoppedPromise(): void {
@@ -142,4 +146,12 @@ export class CoreAnimationController
     this.state = 'running';
     this.emit('animating', this);
   }
+
+  private onTick(
+    this: CoreAnimationController,
+    _animation: CoreAnimation,
+    data: AnimationTickPayload,
+  ): void {
+    this.emit('tick', data);
+  }
 }