SequenceDirectorPlaybackCapability.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "Evaluation/IMovieScenePlaybackCapability.h"
#include "Evaluation/MovieScenePlaybackCapabilities.h"
#include "MovieSceneSequenceID.h"
#include "UObject/GCObject.h"
 
namespace UE::MovieScene
{
 
struct FSharedPlaybackState;
 
struct FSequenceDirectorPlaybackCapability : public IPlaybackCapability
{
    UE_DECLARE_MOVIESCENE_PLAYBACK_CAPABILITY_API(MOVIESCENE_API, FSequenceDirectorPlaybackCapability)
 
public:
 
    FSequenceDirectorPlaybackCapability() {}
    FSequenceDirectorPlaybackCapability(bool bInUseStrongCache) : bUseStrongCache(bInUseStrongCache) {}
 
public:
 
    MOVIESCENE_API void ResetDirectorInstances();
 
    MOVIESCENE_API UObject* GetOrCreateDirectorInstance(TSharedRef<const FSharedPlaybackState> SharedPlaybackState, FMovieSceneSequenceIDRef SequenceID);
 
public:
 
    // IPlaybackCapability interface.
    MOVIESCENE_API virtual void InvalidateCachedData(UMovieSceneEntitySystemLinker* Linker) override;
 
private:
 
    // The actual cache of BP instances is stored in a heap-allocated object
    // because it neeeds to be an FGCObject to keep those instances alive, and
    // an FGCObject isn't relocatable so we can't put it in a playback 
    // capabailities container.
    struct FDirectorInstanceCache : FGCObject
    {
        virtual FString GetReferencerName() const override;
        virtual void AddReferencedObjects(FReferenceCollector& Collector) override;
        TSortedMap<FMovieSceneSequenceID, TObjectPtr<UObject>> DirectorInstances;
    };
    TUniquePtr<FDirectorInstanceCache> Cache;
 
    TSortedMap<FMovieSceneSequenceID, TWeakObjectPtr<UObject>> WeakCache;
 
    bool bUseStrongCache = true;
};
 
}  // namespace UE::MovieScene