MovieSceneSequenceUpdaters.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "CoreTypes.h"
#include "Math/Range.h"
#include "Misc/FrameTime.h"
#include "Templates/SharedPointer.h"
#include "Templates/UniquePtr.h"
 
class UMovieSceneCompiledDataManager;
class UMovieSceneEntitySystemLinker;
class UMovieSceneCondition;
class UMovieSceneSequence;
struct FFrameTime;
struct FMovieSceneCompiledDataID;
struct FMovieSceneContext;
struct FMovieSceneSequenceID;
template <typename ElementType> class TRange;
 
namespace UE
{
namespace MovieScene
{
 
struct FInstanceHandle;
struct FSharedPlaybackState;
 
enum class ESequenceInstanceUpdateFlags : uint8;
enum class ESequenceInstanceInvalidationType : uint8;
 
struct ISequenceUpdater
{
    static void FactoryInstance(TUniquePtr<ISequenceUpdater>& OutPtr, UMovieSceneCompiledDataManager* CompiledDataManager, FMovieSceneCompiledDataID CompiledDataID);
 
public:
 
    virtual ~ISequenceUpdater() {}
 
    virtual void PopulateUpdateFlags(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, ESequenceInstanceUpdateFlags& OutUpdateFlags) = 0;
 
    virtual void DissectContext(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, const FMovieSceneContext& InContext, TArray<TRange<FFrameTime>>& OutDissections) = 0;
 
 
    virtual void Start(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, const FMovieSceneContext& InContext) = 0;
 
 
    virtual void Update(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, const FMovieSceneContext& InContext) = 0;
 
 
    virtual bool CanFinishImmediately(TSharedRef<const FSharedPlaybackState> SharedPlaybackState) const = 0;
 
 
    virtual void Finish(TSharedRef<const FSharedPlaybackState> SharedPlaybackState) = 0;
 
 
    virtual void InvalidateCachedData(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, ESequenceInstanceInvalidationType InvalidationType) = 0;
 
 
    virtual void Destroy(TSharedRef<const FSharedPlaybackState> SharedPlaybackState) = 0;
 
 
    virtual void OverrideRootSequence(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, FMovieSceneSequenceID NewRootOverrideSequenceID) = 0;
 
 
    virtual TUniquePtr<ISequenceUpdater> MigrateToHierarchical() = 0;
 
    virtual FInstanceHandle FindSubInstance(FMovieSceneSequenceID SubSequenceID) const = 0;
 
    /*
    * Evaluate a condition on this sequence instance hierarchy, utilizing any cache as relevant.
    */
    virtual bool EvaluateCondition(const FGuid& BindingID, const FMovieSceneSequenceID& SequenceID, const UMovieSceneCondition* Condition, UObject* ConditionOwnerObject, TSharedRef<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState) const = 0;
 
public:
 
    UE_DEPRECATED(5.5, "Please use the method that takes a reason parameter.")
    MOVIESCENE_API void InvalidateCachedData(TSharedRef<const FSharedPlaybackState> SharedPlaybackState);
};
 
} // namespace MovieScene
} // namespace UE