MovieSceneTimeController.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/QualifiedFrameTime.h"
#include "MovieSceneFwd.h"
#include "Misc/Attribute.h"
#include "UObject/ObjectMacros.h"
 
class IMovieScenePlayer;
 
struct FMovieSceneTimeController
{
public:
 
    virtual ~FMovieSceneTimeController() {}
 
    MOVIESCENE_API void PrepareToPlay(const FQualifiedFrameTime& InStartTime);
 
    MOVIESCENE_API bool IsReadyToPlay();
 
    MOVIESCENE_API void StartPlaying(const FQualifiedFrameTime& InStartTime);
 
    MOVIESCENE_API void StopPlaying(const FQualifiedFrameTime& InStopTime);
 
    MOVIESCENE_API void Tick(float DeltaSeconds, float InPlayRate);
 
    MOVIESCENE_API FFrameTime RequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate, FFrameRate InDisplayRate);
 
    MOVIESCENE_API void PlayerStatusChanged(EMovieScenePlayerStatus::Type InStatus, const FQualifiedFrameTime& InCurrentTime);
 
    MOVIESCENE_API void Reset(const FQualifiedFrameTime& InNewStartTime);
 
protected:
 
    virtual void OnTick(float DeltaSeconds, float InPlayRate){}
    virtual void OnPrepareToPlay(const FQualifiedFrameTime& InStartTime) {}
    virtual bool OnIsReadyToPlay() { return true; }
    virtual void OnStartPlaying(const FQualifiedFrameTime& InStartTime){}
    virtual void OnStopPlaying(const FQualifiedFrameTime& InStopTime){}
    virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) = 0;
 
protected:
 
    TOptional<FQualifiedFrameTime> GetPlaybackStartTime() const
    {
        return PlaybackStartTime;
    }
 
    FFrameRate GetDisplayRate() const
    {
        return DisplayRate;
    }
 
private:
 
    TOptional<FQualifiedFrameTime> PlaybackStartTime;
 
    FFrameRate DisplayRate;
};
 
struct FMovieSceneTimeController_ExternalClock : FMovieSceneTimeController
{
protected:
 
    FMovieSceneTimeController_ExternalClock()
        : AccumulatedDilation(0.0)
    {}
 
    virtual ~FMovieSceneTimeController_ExternalClock() = default;
 
    virtual double GetCurrentTime() const = 0;
 
protected:
 
    MOVIESCENE_API virtual void OnStartPlaying(const FQualifiedFrameTime& InStartTime) override;
    MOVIESCENE_API virtual void OnStopPlaying(const FQualifiedFrameTime& InStopTime) override;
    MOVIESCENE_API virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) override;
 
private:
 
    double AccumulatedDilation;
 
    TOptional<double> ClockStartTime;
    TOptional<double> ClockLastUpdateTime;
};
 
struct FMovieSceneTimeController_PlatformClock : FMovieSceneTimeController_ExternalClock
{
    MOVIESCENE_API virtual double GetCurrentTime() const override;
};
 
struct FMovieSceneTimeController_AudioClock : FMovieSceneTimeController_ExternalClock
{
    MOVIESCENE_API virtual double GetCurrentTime() const override;
};
 
 
struct FMovieSceneTimeController_RelativeTimecodeClock : FMovieSceneTimeController_ExternalClock
{
    MOVIESCENE_API virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) override;
    MOVIESCENE_API virtual double GetCurrentTime() const override;
    MOVIESCENE_API virtual void OnStopPlaying(const FQualifiedFrameTime& InStopTime) override;
 
protected:
 
    TOptional<FFrameTime> LastCurrentFrameTime;
    TOptional<double> TimeSinceCurrentFrameTime;
 
    double AccumulatedFrameTime = 0.0;
};
 
 
struct FMovieSceneTimeController_TimecodeClock : FMovieSceneTimeController
{
    MOVIESCENE_API virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) override;
};
 
 
struct FMovieSceneTimeController_Tick : FMovieSceneTimeController
{
    FMovieSceneTimeController_Tick()
        : CurrentOffsetSeconds(0.0)
    {}
 
protected:
 
    MOVIESCENE_API virtual void OnTick(float DeltaSeconds, float InPlayRate) override;
    MOVIESCENE_API virtual void OnStartPlaying(const FQualifiedFrameTime& InStartTime) override;
    MOVIESCENE_API virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) override;
 
private:
    double CurrentOffsetSeconds;
};
 
struct FMovieSceneTimeController_PlayEveryFrame : FMovieSceneTimeController
{
    FMovieSceneTimeController_PlayEveryFrame()
        : PreviousPlatformTime(0.f)
    {}
 
protected:
 
    MOVIESCENE_API virtual void OnStartPlaying(const FQualifiedFrameTime& InStartTime) override;
    MOVIESCENE_API virtual FFrameTime OnRequestCurrentTime(const FQualifiedFrameTime& InCurrentTime, float InPlayRate) override;
 
private:
    double PreviousPlatformTime;
    FFrameTime CurrentTime;
};