MovieSceneSequenceTickManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "MovieSceneSequenceTickInterval.h"
#include "MovieSceneLatentActionManager.h"
 
#include "MovieSceneSequenceTickManager.generated.h"
 
 
class FMovieSceneEntitySystemRunner;
class UMovieSceneEntitySystemLinker;
class IMovieSceneSequenceTickManagerClient;
 
UCLASS(MinimalAPI)
class UMovieSceneSequenceTickManager : public UObject
{
public:
    GENERATED_BODY()
 
    MOVIESCENE_API UMovieSceneSequenceTickManager(const FObjectInitializer& Init);
 
    static MOVIESCENE_API UMovieSceneSequenceTickManager* Get(UObject* PlaybackContext);
 
    MOVIESCENE_API void RegisterTickClient(const FMovieSceneSequenceTickInterval& TickInterval, TScriptInterface<IMovieSceneSequenceTickManagerClient> InTickInterface);
 
    MOVIESCENE_API void UnregisterTickClient(TScriptInterface<IMovieSceneSequenceTickManagerClient> InTickInterface);
 
    MOVIESCENE_API UMovieSceneEntitySystemLinker* GetLinker(const FMovieSceneSequenceTickInterval& TickInterval);
 
    MOVIESCENE_API TSharedPtr<FMovieSceneEntitySystemRunner> GetRunner(const FMovieSceneSequenceTickInterval& TickInterval);
 
    MOVIESCENE_API void AddLatentAction(FMovieSceneSequenceLatentActionDelegate Delegate);
 
    MOVIESCENE_API void RunLatentActions();
 
    MOVIESCENE_API void ClearLatentActions(UObject* Object);
 
public:
 
    static MOVIESCENE_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
 
private:
 
    /*~ UObject interface */
    MOVIESCENE_API virtual void BeginDestroy() override;
 
private:
 
    struct FTickableClientData
    {
        IMovieSceneSequenceTickManagerClient* Interface;
        TWeakObjectPtr<> WeakObject;
        int32 LinkerIndex;
        bool bTickWhenPaused;
    };
 
    struct FLinkerGroup
    {
        TObjectPtr<UMovieSceneEntitySystemLinker> Linker;
        TSharedPtr<FMovieSceneEntitySystemRunner> Runner;
 
        int32 RoundedTickIntervalMs = 0;
 
        float FrameBudgetMs = 0.f;
 
        float LastUnpausedTimeSeconds = -1;
        float LastTimeSeconds = -1;
 
        uint16 BudgetedStarvationCount = 0;
 
        uint16 NumClients = 0;
    };
 
    struct FPendingOperation
    {
        enum class EType
        {
            Register, Unregister
        };
        TScriptInterface<IMovieSceneSequenceTickManagerClient> Interface;
        TWeakObjectPtr<UObject> WeakObject;
        FMovieSceneSequenceTickInterval TickInterval;
        EType Type;
    };
 
private:
 
    void TickSequenceActors(float DeltaSeconds);
 
    void FlushRunners();
 
    void ProcessPendingOperations(TArrayView<const FPendingOperation> InOperations);
 
    void UnregisterTickClientImpl(IMovieSceneSequenceTickManagerClient* InClientInterface);
 
private:
 
    TArray<FTickableClientData> TickableClients;
 
    TSparseArray<FLinkerGroup> LinkerGroups;
 
    FDelegateHandle WorldTickDelegateHandle;
 
    TArray<FPendingOperation>* PendingActorOperations;
 
    FMovieSceneLatentActionManager LatentActionManager;
};