MovieScenePlaybackManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "EntitySystem/MovieSceneSharedPlaybackState.h"
#include "Evaluation/MovieScenePlayback.h"
#include "Evaluation/MovieSceneSequenceTransform.h"
#include "Misc/Optional.h"
#include "MovieSceneFwd.h"
 
class UMovieSceneSequence;
 
namespace UE::MovieScene { struct FSharedPlaybackState; }
 
enum class EMovieSceneLoopDissection
{
    None,
 
    DissectOne,
 
    DissectAll
};
 
class FMovieScenePlaybackManager
{
public:
 
    using FContexts = TArray<FMovieSceneContext, TInlineAllocator<2>>;
 
    MOVIESCENE_API FMovieScenePlaybackManager();
 
    MOVIESCENE_API FMovieScenePlaybackManager(UMovieSceneSequence* InSequence);
 
    MOVIESCENE_API void Initialize(UMovieSceneSequence* InSequence);
 
    MOVIESCENE_API void Update(float InDeltaSeconds, FContexts& OutContexts);
 
    MOVIESCENE_API void UpdateTo(const FFrameTime NextTime, FContexts& OutContexts);
 
    MOVIESCENE_API FMovieSceneContext UpdateToNextTick();
 
    MOVIESCENE_API FMovieSceneContext UpdateAtCurrentTime() const;
 
    MOVIESCENE_API FFrameTime GetCurrentTime() const;
 
    MOVIESCENE_API void SetCurrentTime(const FFrameTime& InFrameTime);
    MOVIESCENE_API void SetCurrentTimeOffset(const FFrameTime& InFrameTimeOffset);
 
    MOVIESCENE_API TRange<FFrameTime> GetEffectivePlaybackRange() const;
 
    MOVIESCENE_API FFrameTime GetEffectiveStartTime() const;
    MOVIESCENE_API FFrameTime GetEffectiveEndTime() const;
 
public:
 
    FFrameRate GetDisplayRate() const { return DisplayRate; }
    FFrameRate GetTickResolution() const { return PlaybackPosition.GetOutputRate(); }
 
    EMovieSceneLoopDissection GetDissectLooping() const { return DissectLooping; }
    void SetDissectLooping(EMovieSceneLoopDissection InDissectLooping) { DissectLooping = InDissectLooping; }
 
    EMovieScenePlayerStatus::Type GetPlaybackStatus() const { return PlaybackStatus; }
    void SetPlaybackStatus(EMovieScenePlayerStatus::Type InPlaybackStatus) { PlaybackStatus = InPlaybackStatus; }
 
    int32 GetNumLoopsToPlay() const { return NumLoopsToPlay; }
    MOVIESCENE_API void SetNumLoopsToPlay(int32 InNumLoopsToPlay);
 
    int32 GetNumLoopsCompleted() const { return NumLoopsCompleted; }
    void ResetNumLoopsCompleted() { NumLoopsCompleted = 0; }
 
    double GetPlayRate() const { return PlayRate; }
    void SetPlayRate(double InPlayRate) { PlayRate = InPlayRate; }
 
    bool IsPlayingForward() const { return PlayDirection == EPlayDirection::Forwards; } 
    bool IsPlayingBackward() const { return PlayDirection == EPlayDirection::Backwards; } 
    EPlayDirection GetPlayDirection() const { return PlayDirection; }
    void SetPlayDirection(EPlayDirection InPlayDirection) { PlayDirection = InPlayDirection; }
    MOVIESCENE_API void ReversePlayDirection();
 
    bool IsPingPongPlayback() const { return bPingPongPlayback; }
    MOVIESCENE_API void SetPingPongPlayback(bool bInPingPongPlayback);
 
    MOVIESCENE_API FFrameTime GetStartOffset() const;
    MOVIESCENE_API FFrameTime GetEndOffset() const;
    MOVIESCENE_API void SetStartOffset(const FFrameTime& InStartOffset);
    MOVIESCENE_API void SetEndOffset(const FFrameTime& InEndOffset);
    MOVIESCENE_API void SetEndOffsetAsTime(const FFrameTime& InEndTime);
 
    MOVIESCENE_API TOptional<FFrameTime> GetPlaybackEndTime() const;
    MOVIESCENE_API void SetPlaybackEndTime(const FFrameTime& InEndTime);
    MOVIESCENE_API void ClearPlaybackEndTime();
 
    bool ShouldTransformPlaybackTime() const { return bTransformPlaybackTime; }
    void SetTransformPlaybackTime(bool bInTransformPlaybackTime) { bTransformPlaybackTime = bInTransformPlaybackTime; }
 
    const FMovieSceneSequenceTransform& GetPlaybackTimeTransform() const { return TimeTransform; }
 
    /*
     * Sets the time transform to apply to the current time when updating.
     * Only used if ShouldTransformPlaybackTime is true.
     */
    void SetPlaybackTimeTransform(const FMovieSceneSequenceTransform& InTimeTransform) { TimeTransform = InTimeTransform; }
 
private:
 
    void InternalUpdateToTick(const FFrameNumber NextTick, FContexts& OutContexts);
 
    void ResetPlaybackSettings();
 
    void SetStartAndEndOffsetTicks(FFrameNumber InStartOffsetTicks, FFrameNumber InEndOffsetTicks);
 
    FFrameNumber GetLastValidTick() const;
 
private:
 
    FMovieScenePlaybackPosition PlaybackPosition;
 
    FFrameRate DisplayRate;
 
    EMovieScenePlayerStatus::Type PlaybackStatus;
    EPlayDirection PlayDirection;
 
    FFrameNumber SequenceStartTick;
    FFrameNumber SequenceEndTick;
 
    FFrameNumber StartOffsetTicks;
    FFrameNumber EndOffsetTicks;
 
    TOptional<FFrameNumber> PlaybackEndTick;
 
    int32 NumLoopsToPlay = 1;
    int32 NumLoopsCompleted = 0;
 
    double PlayRate = 1.0;
 
    FMovieSceneSequenceTransform TimeTransform;
 
    EMovieSceneLoopDissection DissectLooping = EMovieSceneLoopDissection::DissectOne;
 
    bool bPingPongPlayback = false;
    bool bTransformPlaybackTime = false;
};