MovieSceneSequenceInstance.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Compilation/MovieSceneCompiledDataID.h"
#include "Containers/Array.h"
#include "Containers/SortedMap.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/IDelegateInstance.h"
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneEntityLedger.h"
#include "EntitySystem/MovieSceneEntityManager.h"
#include "EntitySystem/MovieSceneSequenceInstanceHandle.h"
#include "Evaluation/MovieScenePlayback.h"
#include "MovieSceneSequenceID.h"
#include "Templates/UniquePtr.h"
 
class FMovieSceneLegacyPlayer;
class IMovieScenePlayer;
class UMovieSceneEntitySystemLinker;
class UObject;
struct FFrameTime;
struct FMovieSceneTrackEvaluator;
template <typename ElementType> class TRange;
 
namespace UE
{
namespace MovieScene
{
 
struct FCompiledDataVolatilityManager;
struct FPreAnimatedStateExtension;
struct FSequenceInstance;
struct FSharedPlaybackState;
struct FSubSequencePath;
struct ISequenceUpdater;
 
enum class ESequenceInstanceUpdateFlags : uint8
{
    None                = 0,
    NeedsDissection     = 1u << 0,
    NeedsPreEvaluation  = 1u << 1,
    NeedsPostEvaluation = 1u << 2,
    HasLegacyTemplates  = 1u << 3,
};
ENUM_CLASS_FLAGS(ESequenceInstanceUpdateFlags);
 
enum class ESequenceInstanceInvalidationType : uint8
{
    DataChanged,
 
    All
};
 
struct FSequenceInstance
{
    FEntityLedger Ledger;
 
public:
 
    MOVIESCENE_API bool ConditionalRecompile();
 
    MOVIESCENE_API void DissectContext(const FMovieSceneContext& Context, TArray<TRange<FFrameTime>>& OutDissections);
 
    MOVIESCENE_API void Start(const FMovieSceneContext& InContext);
 
    MOVIESCENE_API void PreEvaluation();
 
    MOVIESCENE_API void Update(const FMovieSceneContext& InContext);
 
    MOVIESCENE_API bool CanFinishImmediately() const;
 
    MOVIESCENE_API void Finish();
 
    MOVIESCENE_API void PostEvaluation();
 
    MOVIESCENE_API void RunLegacyTrackTemplates();
 
public:
 
    TSharedRef<FSharedPlaybackState> GetSharedPlaybackState() const
    {
        return SharedPlaybackState;
    }
 
    UE_DEPRECATED(5.5, "The player interface is now optional and will be deprecated in a future relase. Please use FPlayerIndexPlaybackCapability::GetPlayer()")
    MOVIESCENE_API IMovieScenePlayer* GetPlayer() const;
 
    UE_DEPRECATED(5.5, "The player interface is now optional and will be deprecated in a future relase. Please use FPlayerIndexPlaybackCapability::GetPlayerIndex()")
    MOVIESCENE_API uint16 GetPlayerIndex() const;
 
    FMovieSceneSequenceID GetSequenceID() const
    {
        return SequenceID;
    }
 
    const FMovieSceneContext& GetContext() const
    {
        return Context;
    }
 
    FInstanceHandle GetInstanceHandle() const
    {
        return InstanceHandle;
    }
 
    FRootInstanceHandle GetRootInstanceHandle() const
    {
        return RootInstanceHandle;
    }
 
    FInstanceHandle GetParentInstanceHandle() const
    {
        return ParentInstanceHandle;
    }
 
    bool IsRootSequence() const
    {
        return RootInstanceHandle == InstanceHandle;
    }
 
    bool IsSubSequence() const
    {
        return RootInstanceHandle != InstanceHandle;
    }
 
    uint16 GetSerialNumber() const
    {
        return InstanceHandle.InstanceSerial;
    }
 
    bool HasFinished() const
    {
        return bFinished;
    }
 
    bool HasEverUpdated() const
    {
        return bHasEverUpdated;
    }
 
    ESequenceInstanceUpdateFlags GetUpdateFlags() const
    {
        return UpdateFlags;
    }
 
    MOVIESCENE_API FInstanceHandle FindSubInstance(FMovieSceneSequenceID SequenceID) const;
 
    MOVIESCENE_API FMovieSceneEntityID FindEntity(UObject* Owner, uint32 EntityID) const;
 
    MOVIESCENE_API void FindEntities(UObject* Owner, TArray<FMovieSceneEntityID>& OutEntityIDs) const;
 
    const FMovieSceneTrackEvaluator* GetLegacyEvaluator() const
    {
        return LegacyEvaluator.Get();
    }
 
    MOVIESCENE_API FSubSequencePath GetSubSequencePath() const;
 
public:
 
    void SetContext(const FMovieSceneContext& InContext)
    {
        Context = InContext;
    }
 
    void SetFinished(bool bInFinished)
    {
        bFinished = bInFinished;
    }
 
    MOVIESCENE_API void InvalidateCachedData(ESequenceInstanceInvalidationType InvalidationType = ESequenceInstanceInvalidationType::All);
 
    MOVIESCENE_API void DestroyImmediately();
 
    MOVIESCENE_API void OverrideRootSequence(FMovieSceneSequenceID NewRootSequenceID);
 
    /*
    * Evaluate a condition on this sequence instance hierarchy, utilizing any cache as relevant.
    */
    MOVIESCENE_API bool EvaluateCondition(const FGuid& BindingID, const FMovieSceneSequenceID& SequenceID, const UMovieSceneCondition* Condition, UObject* ConditionOwnerObject) const;
 
public:
 
    MOVIESCENE_API explicit FSequenceInstance(TSharedRef<FSharedPlaybackState> PlaybackState);
 
    MOVIESCENE_API explicit FSequenceInstance(TSharedRef<FSharedPlaybackState> PlaybackState, FInstanceHandle ThisInstanceHandle, FInstanceHandle InParentInstanceHandle, FMovieSceneSequenceID InSequenceID);
 
    MOVIESCENE_API void Initialize();
 
    MOVIESCENE_API ~FSequenceInstance();
 
    FSequenceInstance(const FSequenceInstance&) = delete;
    FSequenceInstance& operator=(const FSequenceInstance&) = delete;
 
    MOVIESCENE_API FSequenceInstance(FSequenceInstance&&);
    MOVIESCENE_API FSequenceInstance& operator=(FSequenceInstance&&);
 
public:
 
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    bool ConditionalRecompile(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void DissectContext(UMovieSceneEntitySystemLinker* Linker, const FMovieSceneContext& Context, TArray<TRange<FFrameTime>>& OutDissections);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void Start(UMovieSceneEntitySystemLinker* Linker, const FMovieSceneContext& InContext);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void PreEvaluation(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void Update(UMovieSceneEntitySystemLinker* Linker, const FMovieSceneContext& InContext);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    bool CanFinishImmediately(UMovieSceneEntitySystemLinker* Linker) const;
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void Finish(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void PostEvaluation(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void InvalidateCachedData(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void DestroyImmediately(UMovieSceneEntitySystemLinker* Linker);
    UE_DEPRECATED(5.4, "Please use the version of this method without a Linker parameter")
    void OverrideRootSequence(UMovieSceneEntitySystemLinker* Linker, FMovieSceneSequenceID NewRootSequenceID);
 
private:
 
    void InitializeLegacyEvaluator();
    void InitializeLegacyPlayer();
 
private:
 
    FMovieSceneContext Context;
 
#if !UE_BUILD_SHIPPING && !UE_BUILD_TEST
    FString RootSequenceName;
#endif
 
    TUniquePtr<FMovieSceneTrackEvaluator> LegacyEvaluator;
    TUniquePtr<FMovieSceneLegacyPlayer> LegacyPlayer;
    TUniquePtr<ISequenceUpdater> SequenceUpdater;
    TUniquePtr<FCompiledDataVolatilityManager> VolatilityManager;
 
    TSharedRef<FSharedPlaybackState> SharedPlaybackState;
 
    FMovieSceneSequenceID SequenceID;
    FMovieSceneSequenceID RootOverrideSequenceID;
    ESequenceInstanceUpdateFlags UpdateFlags;
    FInstanceHandle InstanceHandle;
    FInstanceHandle ParentInstanceHandle;
    FRootInstanceHandle RootInstanceHandle;
    bool bInitialized : 1;
    bool bFinished : 1;
    bool bHasEverUpdated : 1;
 
    friend struct FScopedVolatilityManagerSuppression;
};
 
 
} // namespace MovieScene
} // namespace UE