diff --git a/cocos/core/animation/animation-clip.ts b/cocos/core/animation/animation-clip.ts index bc7ba9287a..c98ce97c20 100644 --- a/cocos/core/animation/animation-clip.ts +++ b/cocos/core/animation/animation-clip.ts @@ -325,6 +325,18 @@ export class AnimationClip extends Asset { ); } + /** + * Creates an embedded player evaluator for this animation. + * @param targetNode Target node. + * @internal Do not use this in your code. + */ + public createEmbeddedPlayerEvaluator (targetNode: Node) { + return new EmbeddedPlayerEvaluation( + this._embeddedPlayers, + targetNode, + ); + } + /** * Creates an evaluator for this animation. * @param context The context. @@ -701,19 +713,10 @@ export class AnimationClip extends Asset { exoticAnimationEvaluator = this._exoticAnimation.createEvaluator(binder); } - let embeddedPlayerEvaluation: EmbeddedPlayerEvaluation | undefined; - if (target instanceof Node) { // Note: when this method is called from bake(), target is undefined. - const { _embeddedPlayers: embeddedPlayers } = this; - if (this._embeddedPlayers.length !== 0) { - embeddedPlayerEvaluation = new EmbeddedPlayerEvaluation(embeddedPlayers, target); - } - } - const evaluation = new AnimationClipEvaluation( trackEvalStatues, exoticAnimationEvaluator, rootMotionEvaluation, - embeddedPlayerEvaluation, ); return evaluation; @@ -931,12 +934,19 @@ class EmbeddedPlayerEvaluation { instantiatedPlayer, entered: false, hostPauseTime: 0.0, + lastIterations: 0, }; }, ); } - public evaluate (time: number) { + /** + * Evaluates the embedded players. + * @param time The time([0, clipDuration]). + * @param iterations The iterations the evaluation occurred. Should be integral. + */ + public evaluate (time: number, iterations: number) { + assertIsTrue(Number.isInteger(iterations)); const { _embeddedPlayers: embeddedPlayers, _embeddedPlayerEvaluationInfos: embeddedPlayerEvaluationInfos, @@ -947,18 +957,27 @@ class EmbeddedPlayerEvaluation { if (!embeddedPlayerEvaluationInfo) { continue; } - const { entered, instantiatedPlayer } = embeddedPlayerEvaluationInfo; + const { entered, instantiatedPlayer, lastIterations } = embeddedPlayerEvaluationInfo; const { begin, end } = embeddedPlayers[iEmbeddedPlayer]; const withinEmbeddedPlayer = time >= begin && time <= end; if (withinEmbeddedPlayer) { if (!entered) { - instantiatedPlayer.play(time - begin); + instantiatedPlayer.play(); + embeddedPlayerEvaluationInfo.entered = true; + } else if (iterations !== lastIterations) { + instantiatedPlayer.stop(); + instantiatedPlayer.play(); embeddedPlayerEvaluationInfo.entered = true; } } else if (entered) { instantiatedPlayer.stop(); embeddedPlayerEvaluationInfo.entered = false; } + embeddedPlayerEvaluationInfo.lastIterations = iterations; + if (embeddedPlayerEvaluationInfo.entered) { + const playerTime = time - begin; + embeddedPlayerEvaluationInfo.instantiatedPlayer.setTime(playerTime); + } } } @@ -982,6 +1001,10 @@ class EmbeddedPlayerEvaluation { } } + /** + * Notifies that the host has ran into **playing** state. + * @param time The time where host ran into playing state. + */ public notifyHostPlay (time: number) { // Host has switched to "playing", this can be happened when: // - Previous state is "stopped": we must have stopped all embedded players. @@ -1006,7 +1029,8 @@ class EmbeddedPlayerEvaluation { // Otherwise we have to say goodbye to that embedded player. if (instantiatedPlayer.randomAccess || approx(hostPauseTime, time, 1e-5)) { const startTime = clamp(time, begin, end); - instantiatedPlayer.play(startTime - begin); + instantiatedPlayer.play(); + instantiatedPlayer.setTime(startTime - begin); } else { instantiatedPlayer.stop(); } @@ -1014,6 +1038,9 @@ class EmbeddedPlayerEvaluation { } } + /** + * Notifies that the host has ran into **pause** state. + */ public notifyHostPause (time: number) { // Host is paused, simply transmit this to embedded players. const { @@ -1034,6 +1061,9 @@ class EmbeddedPlayerEvaluation { } } + /** + * Notifies that the host has ran into **stopped** state. + */ public notifyHostStop () { // Now that host is stopped, we stop all embedded players' playing // regardless of their progresses. @@ -1061,6 +1091,7 @@ class EmbeddedPlayerEvaluation { instantiatedPlayer: EmbeddedPlayableState; entered: boolean; hostPauseTime: number; + lastIterations: number; }>; } @@ -1069,12 +1100,10 @@ class AnimationClipEvaluation { trackEvalStatuses: TrackEvalStatus[], exoticAnimationEvaluator: ExoticAnimationEvaluator | undefined, rootMotionEvaluation: RootMotionEvaluation | undefined, - embeddedPlayerEvaluation: EmbeddedPlayerEvaluation | undefined, ) { this._trackEvalStatues = trackEvalStatuses; this._exoticAnimationEvaluator = exoticAnimationEvaluator; this._rootMotionEvaluation = rootMotionEvaluation; - this._embeddedPlayerEvaluation = embeddedPlayerEvaluation; } /** @@ -1085,7 +1114,6 @@ class AnimationClipEvaluation { const { _trackEvalStatues: trackEvalStatuses, _exoticAnimationEvaluator: exoticAnimationEvaluator, - _embeddedPlayerEvaluation: embeddedPlayerEvaluation, } = this; const nTrackEvalStatuses = trackEvalStatuses.length; @@ -1098,36 +1126,6 @@ class AnimationClipEvaluation { if (exoticAnimationEvaluator) { exoticAnimationEvaluator.evaluate(time); } - - if (embeddedPlayerEvaluation) { - embeddedPlayerEvaluation.evaluate(time); - } - } - - public notifyHostSpeedChanged (value: number) { - this._embeddedPlayerEvaluation?.notifyHostSpeedChanged(value); - } - - /** - * Notifies that the host has ran into **playing** state. - * @param time The time where host ran into playing state. - */ - public notifyHostPlay (time: number) { - this._embeddedPlayerEvaluation?.notifyHostPlay(time); - } - - /** - * Notifies that the host has ran into **pause** state. - */ - public notifyHostPause (time: number) { - this._embeddedPlayerEvaluation?.notifyHostPause(time); - } - - /** - * Notifies that the host has ran into **stopped** state. - */ - public notifyHostStop () { - this._embeddedPlayerEvaluation?.notifyHostStop(); } /** @@ -1145,7 +1143,6 @@ class AnimationClipEvaluation { private _exoticAnimationEvaluator: ExoticAnimationEvaluator | undefined; private _trackEvalStatues:TrackEvalStatus[] = []; private _rootMotionEvaluation: RootMotionEvaluation | undefined = undefined; - private _embeddedPlayerEvaluation: EmbeddedPlayerEvaluation | undefined = undefined; } class BoneTransform { diff --git a/cocos/core/animation/animation-state.ts b/cocos/core/animation/animation-state.ts index 1a7d3ce987..91c66072c8 100644 --- a/cocos/core/animation/animation-state.ts +++ b/cocos/core/animation/animation-state.ts @@ -222,7 +222,7 @@ export class AnimationState extends Playable { set speed (value) { this._speed = value; - this._clipEval?.notifyHostSpeedChanged(value); + this._clipEmbeddedPlayerEval.notifyHostSpeedChanged(value); } /** @@ -305,6 +305,7 @@ export class AnimationState extends Playable { private _weight = 1.0; private _clipEval: ReturnType | undefined; private _clipEventEval: ReturnType | undefined; + private declare _clipEmbeddedPlayerEval: ReturnType; /** * @internal For internal usage. Really hack... */ @@ -347,7 +348,7 @@ export class AnimationState extends Playable { this.duration = clip.duration; this._invDuration = 1.0 / this.duration; - this.speed = clip.speed; + this._speed = clip.speed; this.wrapMode = clip.wrapMode; this.frameRate = clip.sample; this._playbackRange.min = 0.0; @@ -376,7 +377,8 @@ export class AnimationState extends Playable { this._clipEventEval = clip.createEventEvaluator(this._targetNode); } - this._clipEval?.notifyHostSpeedChanged(this._speed); + this._clipEmbeddedPlayerEval = clip.createEmbeddedPlayerEvaluator(this._targetNode); + this._clipEmbeddedPlayerEval.notifyHostSpeedChanged(this._speed); } public destroy () { @@ -496,6 +498,7 @@ export class AnimationState extends Playable { if (!EDITOR || legacyCC.GAME_VIEW) { this._sampleEvents(info); } + this._sampleEmbeddedPlayers(info); return info; } @@ -504,7 +507,7 @@ export class AnimationState extends Playable { this._delayTime = this._delay; this._onReplayOrResume(); this.emit(EventType.PLAY, this); - this._clipEval?.notifyHostPlay(this.current); + this._clipEmbeddedPlayerEval.notifyHostPlay(this.current); } protected onStop () { @@ -512,19 +515,19 @@ export class AnimationState extends Playable { this._onPauseOrStop(); } this.emit(EventType.STOP, this); - this._clipEval?.notifyHostStop(); + this._clipEmbeddedPlayerEval.notifyHostStop(); } protected onResume () { this._onReplayOrResume(); this.emit(EventType.RESUME, this); - this._clipEval?.notifyHostPlay(this.current); + this._clipEmbeddedPlayerEval.notifyHostPlay(this.current); } protected onPause () { this._onPauseOrStop(); this.emit(EventType.PAUSE, this); - this._clipEval?.notifyHostPause(this.current); + this._clipEmbeddedPlayerEval.notifyHostPause(this.current); } /** @@ -583,10 +586,13 @@ export class AnimationState extends Playable { const ratio = realTime * this._invDuration; this._sampleCurves(playbackStart + time); + const wrapInfo = this.getWrappedInfo(this.time, this._wrappedInfo); if (!EDITOR || legacyCC.GAME_VIEW) { - this._sampleEvents(this.getWrappedInfo(this.time, this._wrappedInfo)); + this._sampleEvents(wrapInfo); } + this._sampleEmbeddedPlayers(wrapInfo); + if (this._allowLastFrame) { if (Number.isNaN(this._lastIterations)) { this._lastIterations = ratio; @@ -694,6 +700,13 @@ export class AnimationState extends Playable { ); } + private _sampleEmbeddedPlayers (wrapInfo: WrappedInfo) { + this._clipEmbeddedPlayerEval.evaluate( + wrapInfo.time, + Math.trunc(wrapInfo.iterations), + ); + } + private _emit (type, state) { if (this._target && this._target.isValid) { this._target.emit(type, type, state); diff --git a/cocos/core/animation/embedded-player/embedded-animation-clip-player.ts b/cocos/core/animation/embedded-player/embedded-animation-clip-player.ts index b7c69e82e5..df00661fff 100644 --- a/cocos/core/animation/embedded-player/embedded-animation-clip-player.ts +++ b/cocos/core/animation/embedded-player/embedded-animation-clip-player.ts @@ -63,9 +63,8 @@ class EmbeddedAnimationClipPlayableState extends EmbeddedPlayableState { /** * Plays the animation state at specified time. */ - public play (time: number): void { - this._animationState.play(); // Note play() rewinds the time to 0 - this._animationState.time = time; + public play (): void { + this._animationState.play(); } /** @@ -89,5 +88,9 @@ class EmbeddedAnimationClipPlayableState extends EmbeddedPlayableState { this._animationState.speed = speed; } + public setTime (time: number): void { + this._animationState.time = time; + } + private _animationState: AnimationState; } diff --git a/cocos/core/animation/embedded-player/embedded-particle-system-player.ts b/cocos/core/animation/embedded-player/embedded-particle-system-player.ts index 35d4f5f688..3fcf15610f 100644 --- a/cocos/core/animation/embedded-player/embedded-particle-system-player.ts +++ b/cocos/core/animation/embedded-player/embedded-particle-system-player.ts @@ -56,9 +56,8 @@ class EmbeddedParticleSystemPlayableState extends EmbeddedPlayableState { /** * Plays the particle system from the beginning no matter current time. - * @param _time Ignored. */ - public play (_time: number): void { + public play (): void { this._particleSystem.play(); } diff --git a/cocos/core/animation/embedded-player/embedded-player.ts b/cocos/core/animation/embedded-player/embedded-player.ts index 3c19c01810..02c553d2f2 100644 --- a/cocos/core/animation/embedded-player/embedded-player.ts +++ b/cocos/core/animation/embedded-player/embedded-player.ts @@ -82,9 +82,8 @@ export abstract class EmbeddedPlayableState { * 该方法在此播放器开始播放时触发。 * @en * This method is called when this player gets to play. - * @param time Current time on the embedded player, relative to embedded player's start。 */ - public abstract play(time: number): void; + public abstract play(): void; /** * @zh @@ -111,5 +110,8 @@ export abstract class EmbeddedPlayableState { */ public abstract setSpeed(speed: number): void; + public setTime (_time: number) { + } + private declare _randomAccess: boolean; } diff --git a/tests/animation/embedded-player/evaluate-embedded-players-in-animation-state.test.ts b/tests/animation/embedded-player/evaluate-embedded-players-in-animation-state.test.ts new file mode 100644 index 0000000000..04ba2e1239 --- /dev/null +++ b/tests/animation/embedded-player/evaluate-embedded-players-in-animation-state.test.ts @@ -0,0 +1,87 @@ +import { Node } from "../../../cocos/core"; +import { AnimationClip } from "../../../cocos/core/animation/animation-clip"; +import { AnimationState } from "../../../cocos/core/animation/animation-state"; + +test('Evaluate embedded players in animation state', () => { + const clip = new AnimationClip(); + clip.duration = 0.8; + clip.speed = 0.6; + clip.wrapMode = AnimationClip.WrapMode.Loop; + + const node = new Node(); + + const embeddedPlayerEvaluation = new EmbeddedPlayerEvaluationMock(); + jest.spyOn(clip, 'createEmbeddedPlayerEvaluator').mockImplementation((targetNode: Node) => { + expect(targetNode).toBe(node); + return embeddedPlayerEvaluation as unknown as ReturnType; + }); + + const animationState = new AnimationState(clip); + animationState.initialize(node); + expect(embeddedPlayerEvaluation.notifyHostSpeedChanged).toBeCalledTimes(1); + expect(embeddedPlayerEvaluation.notifyHostSpeedChanged.mock.calls[0][0]).toBe(0.6); + embeddedPlayerEvaluation.notifyHostSpeedChanged.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + animationState.play(); + expect(embeddedPlayerEvaluation.notifyHostPlay).toBeCalledTimes(1); + expect(embeddedPlayerEvaluation.notifyHostPlay.mock.calls[0][0]).toBeCloseTo(0.0); + embeddedPlayerEvaluation.notifyHostPlay.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + animationState.update(0.2); + expect(embeddedPlayerEvaluation.evaluate).toBeCalledTimes(1); + // Perfect first frame.. + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][0]).toBeCloseTo(0.0); + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][1]).toBeCloseTo(0); + embeddedPlayerEvaluation.evaluate.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + animationState.update(0.3); + expect(embeddedPlayerEvaluation.evaluate).toBeCalledTimes(1); + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][0]).toBeCloseTo(0.3 * 0.6); + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][1]).toBeCloseTo(0); + embeddedPlayerEvaluation.evaluate.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + // Cross iterations + animationState.update(10.0); + expect(embeddedPlayerEvaluation.evaluate).toBeCalledTimes(1); + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][0]).toBeCloseTo(animationState.current); + expect(embeddedPlayerEvaluation.evaluate.mock.calls[0][1]).toBe(Math.trunc((0.3 + 10.0) * 0.6 / 0.8)); + embeddedPlayerEvaluation.evaluate.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + animationState.pause(); + expect(embeddedPlayerEvaluation.notifyHostPause).toBeCalledTimes(1); + expect(embeddedPlayerEvaluation.notifyHostPause.mock.calls[0][0]).toBeCloseTo(animationState.current); + embeddedPlayerEvaluation.notifyHostPause.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); + + animationState.stop(); + expect(embeddedPlayerEvaluation.notifyHostStop).toBeCalledTimes(1); + embeddedPlayerEvaluation.notifyHostStop.mockClear(); + embeddedPlayerEvaluation.zeroCheck(); +}); + +// @ts-expect-error +class EmbeddedPlayerEvaluationMock implements ReturnType { + public notifyHostSpeedChanged: jest.Mock = jest.fn(); + + public notifyHostPlay: jest.Mock = jest.fn(); + + public notifyHostPause: jest.Mock = jest.fn(); + + public notifyHostStop: jest.Mock = jest.fn(); + + public evaluate: jest.Mock = jest.fn(); + + public zeroCheck() { + expect(this.notifyHostSpeedChanged).not.toBeCalled(); + expect(this.notifyHostPlay).not.toBeCalled(); + expect(this.notifyHostPause).not.toBeCalled(); + expect(this.notifyHostStop).not.toBeCalled(); + expect(this.evaluate).not.toBeCalled(); + } +} + diff --git a/tests/animation/embedded-player/genernal-embedded-player.test.ts b/tests/animation/embedded-player/genernal-embedded-player.test.ts index 3ad2b20ee9..95d0664afe 100644 --- a/tests/animation/embedded-player/genernal-embedded-player.test.ts +++ b/tests/animation/embedded-player/genernal-embedded-player.test.ts @@ -25,10 +25,12 @@ describe('General embedded player test', () => { host.play(0.32); // The time has arrived in embedded player's interval, but it has not been evaluated. expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(0); - host.evaluateAt(0.33); // Enter the region + host.evaluateAt(0.33, 0); // Enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.03); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); embeddedPlayerMock.playMock.mockClear(); + embeddedPlayerMock.setTimeMock.mockClear(); embeddedPlayerMock.zeroCheck(); }); @@ -41,14 +43,19 @@ describe('General embedded player test', () => { const node = new Node(); const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); - host.evaluateAt(0.33); // Enter the region + host.evaluateAt(0.33, 0); // Enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.03); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); embeddedPlayerMock.playMock.mockClear(); + embeddedPlayerMock.setTimeMock.mockClear(); - host.evaluateAt(0.6); // Evaluate at the middle, nothing happened + host.evaluateAt(0.6, 0); // Evaluate at the middle, nothing happened + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.3); + embeddedPlayerMock.setTimeMock.mockClear(); - host.evaluateAt(0.75); // Evaluate outside the interval, call `stop()` + host.evaluateAt(0.75, 0); // Evaluate outside the interval, call `stop()` expect(embeddedPlayerMock.stopMock).toHaveBeenCalledTimes(1); embeddedPlayerMock.stopMock.mockClear(); @@ -63,9 +70,11 @@ describe('General embedded player test', () => { const node = new Node(); const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); - host.evaluateAt(0.33); // Enter the region + host.evaluateAt(0.33, 0); // Enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.03); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); + embeddedPlayerMock.setTimeMock.mockClear(); embeddedPlayerMock.playMock.mockClear(); host.stop(); // Evaluate outside the interval, call `stop()` @@ -83,19 +92,23 @@ describe('General embedded player test', () => { const node = new Node(); const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); - host.evaluateAt(0.33); // Enter the region + host.evaluateAt(0.33, 0); // Enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.03); embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); + embeddedPlayerMock.setTimeMock.mockClear(); - host.evaluateAt(0.8); // Evaluate outside the interval + host.evaluateAt(0.8, 0); // Evaluate outside the interval expect(embeddedPlayerMock.stopMock).toHaveBeenCalledTimes(1); embeddedPlayerMock.stopMock.mockClear(); - host.evaluateAt(0.42); // Again enter the region + host.evaluateAt(0.42, 0); // Again enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.12); embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.12); + embeddedPlayerMock.setTimeMock.mockClear(); embeddedPlayerMock.zeroCheck(); }); @@ -109,13 +122,14 @@ describe('General embedded player test', () => { const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); host.play(0.13); - host.evaluateAt(0.13); + host.evaluateAt(0.13, 0); host.pause(0.14); // Pause at the outside before the first time the embedded player entered. expect(embeddedPlayerMock.pauseMock).not.toHaveBeenCalled(); host.play(0.32); - host.evaluateAt(0.32); // Enter the embedded player + host.evaluateAt(0.32, 0); // Enter the embedded player embeddedPlayerMock.playMock.mockClear(); + embeddedPlayerMock.setTimeMock.mockClear(); expect(embeddedPlayerMock.pauseMock).not.toHaveBeenCalled(); host.pause(0.33); @@ -124,7 +138,8 @@ describe('General embedded player test', () => { host.play(0.4); embeddedPlayerMock.playMock.mockClear(); - host.evaluateAt(0.87); // Exit the embedded player + embeddedPlayerMock.setTimeMock.mockClear(); + host.evaluateAt(0.87, 0); // Exit the embedded player embeddedPlayerMock.stopMock.mockClear(); host.pause(0.9); // Pause at the outside @@ -172,10 +187,12 @@ describe('General embedded player test', () => { host.play(0.0); - host.evaluateAt(0.33); // Enter the region + host.evaluateAt(0.33, 0); // Enter the region expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(0.03); embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); + embeddedPlayerMock.setTimeMock.mockClear(); host.pause(0.4); expect(embeddedPlayerMock.pauseMock).toHaveBeenCalledTimes(1); @@ -188,8 +205,10 @@ describe('General embedded player test', () => { if (embeddedPlayerResumable) { expect(embeddedPlayerMock.playMock).toHaveBeenCalledTimes(1); - expect(embeddedPlayerMock.playMock.mock.calls[0][0]).toBeCloseTo(hostResumeTime - 0.3); embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(hostResumeTime - 0.3); + embeddedPlayerMock.setTimeMock.mockClear(); } else { expect(embeddedPlayerMock.stopMock).toHaveBeenCalledTimes(1); embeddedPlayerMock.stopMock.mockClear(); @@ -231,27 +250,91 @@ describe('General embedded player test', () => { embeddedPlayerMock.zeroCheck(); }); - test('Broadcasting of animation state\'s speed', () => { - const clip = new AnimationClip(); - clip.speed = 0.6; + test('Twice evaluations occur in different iterations', () => { + const embeddedPlayer = new EmbeddedPlayer(); + const embeddedPlayerMock = embeddedPlayer.playable = new EmbeddedPlayerMock(false); + embeddedPlayer.begin = 0.3; + embeddedPlayer.end = 0.7; + embeddedPlayer.reconciledSpeed = false; + const node = new Node(); + const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); + + host.evaluateAt(0.31, 0); + expect(embeddedPlayerMock.playMock).toBeCalledTimes(1); + embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.01); + embeddedPlayerMock.setTimeMock.mockClear(); + + // Evaluate at an outside region in different iterations. Stop. + host.evaluateAt(0.1, 1); + expect(embeddedPlayerMock.stopMock).toBeCalledTimes(1); + embeddedPlayerMock.stopMock.mockClear(); + + // Evaluate at an inside-region in different iterations. Play. + host.evaluateAt(0.32, 2); + expect(embeddedPlayerMock.playMock).toBeCalledTimes(1); + embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.02); + embeddedPlayerMock.setTimeMock.mockClear(); + + // Slightly tweak the time, to ensure the "last iterations" has been remembered by the evaluation. + // (if not, play() will be triggered!) + host.evaluateAt(0.33, 2); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.03); + embeddedPlayerMock.setTimeMock.mockClear(); + embeddedPlayerMock.zeroCheck(); + + // Evaluate at an inside-region in different iterations. Stop then play. + host.evaluateAt(0.4, 3); + expect(embeddedPlayerMock.stopMock).toBeCalledTimes(1); + expect(embeddedPlayerMock.playMock).toBeCalledTimes(1); + // Stop then play + expect(embeddedPlayerMock.stopMock.mock.invocationCallOrder[0]).toBeLessThan( + embeddedPlayerMock.playMock.mock.invocationCallOrder[0] + ); + embeddedPlayerMock.stopMock.mockClear(); + embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.1); + embeddedPlayerMock.setTimeMock.mockClear(); + + // Even the evaluations span more than one iterations, + // there still only one stop/play invocation. + host.evaluateAt(0.5, 8); + expect(embeddedPlayerMock.stopMock).toBeCalledTimes(1); + expect(embeddedPlayerMock.playMock).toBeCalledTimes(1); + // Stop then play + expect(embeddedPlayerMock.stopMock.mock.invocationCallOrder[0]).toBeLessThan( + embeddedPlayerMock.playMock.mock.invocationCallOrder[0] + ); + embeddedPlayerMock.stopMock.mockClear(); + embeddedPlayerMock.playMock.mockClear(); + expect(embeddedPlayerMock.setTimeMock).toHaveBeenCalledTimes(1); + expect(embeddedPlayerMock.setTimeMock.mock.calls[0][0]).toBeCloseTo(0.2); + embeddedPlayerMock.setTimeMock.mockClear(); + + // The above also holds for cross-iterations stopping. + host.evaluateAt(0.8, 100); + expect(embeddedPlayerMock.stopMock).toBeCalledTimes(1); + embeddedPlayerMock.stopMock.mockClear(); + + embeddedPlayerMock.zeroCheck(); + }); + + test('Speed', () => { const embeddedPlayer = new EmbeddedPlayer(); embeddedPlayer.reconciledSpeed = true; const playerMock = embeddedPlayer.playable = new EmbeddedPlayerMock(); - clip[addEmbeddedPlayerTag](embeddedPlayer); - const animationState = new AnimationState(clip); const node = new Node(); - expect(playerMock.setSpeedMock).not.toBeCalled(); - - animationState.initialize(node); + const host = new AnimationClipHostEmbeddedPlayerMock(node, embeddedPlayer, 1.2); + + host.setSpeed(0.618); expect(playerMock.setSpeedMock).toBeCalledTimes(1); - expect(playerMock.setSpeedMock.mock.calls[0][0]).toBe(0.6); - playerMock.setSpeedMock.mockClear(); - - animationState.speed = 0.8; - expect(playerMock.setSpeedMock).toBeCalledTimes(1); - expect(playerMock.setSpeedMock.mock.calls[0][0]).toBe(0.8); - playerMock.setSpeedMock.mockClear(); + expect(playerMock.setSpeedMock.mock.calls[0][0]).toBe(0.618); }); }); }); @@ -281,6 +364,10 @@ class EmbeddedPlayerMock extends EmbeddedPlayable { return this._setSpeedMock; } + get setTimeMock() { + return this._setTimeMock; + } + public zeroCheck() { for (const mock of [ this._destroyMock, @@ -288,6 +375,7 @@ class EmbeddedPlayerMock extends EmbeddedPlayable { this._pauseMock, this._stopMock, this._setSpeedMock, + this._setTimeMock, ]) { expect(mock).toBeCalledTimes(0); } @@ -301,6 +389,7 @@ class EmbeddedPlayerMock extends EmbeddedPlayable { this._pauseMock, this._stopMock, this._setSpeedMock, + this._setTimeMock, ); } @@ -309,6 +398,7 @@ class EmbeddedPlayerMock extends EmbeddedPlayable { private _pauseMock = jest.fn(); private _stopMock = jest.fn(); private _setSpeedMock = jest.fn(); + private _setTimeMock = jest.fn(); } class InstantiatedEmbeddedPlayerMock extends EmbeddedPlayableState { @@ -319,6 +409,7 @@ class InstantiatedEmbeddedPlayerMock extends EmbeddedPlayableState { private _pauseMock: jest.Mock, private _stopMock: jest.Mock, private _setSpeedMock: jest.Mock, + private _setTimeMock: jest.Mock, ) { super(randomAccess); } @@ -342,4 +433,8 @@ class InstantiatedEmbeddedPlayerMock extends EmbeddedPlayableState { public setSpeed(...args: Parameters): void { this._setSpeedMock(...args); } + + public setTime(...args: Parameters): void { + this._setTimeMock(...args); + } } \ No newline at end of file diff --git a/tests/animation/embedded-player/util.ts b/tests/animation/embedded-player/util.ts index c985dab5a0..88789a7514 100644 --- a/tests/animation/embedded-player/util.ts +++ b/tests/animation/embedded-player/util.ts @@ -5,7 +5,7 @@ import { EmbeddedPlayer } from "../../../editor/exports/embedded-player"; export class EmbeddedPlayerHostMock { constructor(root: Node, private _embeddedPlayer: EmbeddedPlayer, _hostDuration: number) { - const instantiatedPlayer = this._embeddedPlayer.playable.instantiate(root); + const instantiatedPlayer = this._embeddedPlayer.playable?.instantiate(root) ?? null; this._instantiatedPlayer = instantiatedPlayer; } @@ -14,19 +14,19 @@ export class EmbeddedPlayerHostMock { } get randomAccessible() { - return this._instantiatedPlayer.randomAccess; + return this._instantiatedPlayer?.randomAccess ?? false; } public play(time: number) { - this._instantiatedPlayer.play(time); + this._instantiatedPlayer?.play(); } public stop() { - this._instantiatedPlayer.stop(); + this._instantiatedPlayer?.stop(); } public setSpeed(speed: number) { - this._instantiatedPlayer.setSpeed(speed); + this._instantiatedPlayer?.setSpeed(speed); } private _instantiatedPlayer: EmbeddedPlayableState | null; @@ -37,7 +37,7 @@ export class AnimationClipHostEmbeddedPlayerMock { const animationClip = new AnimationClip(); animationClip.duration = hostDuration; animationClip[addEmbeddedPlayerTag](embeddedPlayer); - const evaluator = animationClip.createEvaluator({ target: _root }); + const evaluator = animationClip.createEmbeddedPlayerEvaluator(_root); this._animationEvaluator = evaluator; } @@ -57,9 +57,9 @@ export class AnimationClipHostEmbeddedPlayerMock { this._animationEvaluator.notifyHostSpeedChanged(speed); } - public evaluateAt(time: number) { - this._animationEvaluator.evaluate(time); + public evaluateAt(time: number, iterations: number) { + this._animationEvaluator.evaluate(time, iterations); } - private _animationEvaluator: ReturnType; + private _animationEvaluator: ReturnType; } \ No newline at end of file