MovieSceneEvaluationTemplate.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/SparseArray.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Evaluation/MovieSceneEvaluationTrack.h"
#include "Evaluation/MovieSceneEvaluationTree.h"
#include "Evaluation/MovieSceneSegment.h"
#include "Evaluation/MovieSceneTrackIdentifier.h"
#include "Misc/Guid.h"
#include "MovieSceneFrameMigration.h"
#include "MovieSceneTrack.h"
#include "Serialization/Archive.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
#include "MovieSceneEvaluationTemplate.generated.h"
 
class UMovieSceneSequence;
class UMovieSceneSubSection;
struct FMovieSceneEvaluationTrack;
struct FMovieSceneFrameRange;
 
 
 
USTRUCT()
struct FMovieSceneTemplateGenerationLedger
{
    GENERATED_BODY()
 
public:
 
    MOVIESCENE_API FMovieSceneTrackIdentifier FindTrackIdentifier(const FGuid& InSignature) const;
 
    MOVIESCENE_API void AddTrack(const FGuid& InSignature, FMovieSceneTrackIdentifier Identifier);
 
    bool ContainsSubSection(const FGuid& InSignature)
    {
        return SubSectionRanges.Contains(InSignature);
    }
 
public:
 
    UPROPERTY()
    FMovieSceneTrackIdentifier LastTrackIdentifier;
 
    UPROPERTY()
    TMap<FGuid, FMovieSceneTrackIdentifier> TrackSignatureToTrackIdentifier;
 
    UPROPERTY()
    TMap<FGuid, FMovieSceneFrameRange> SubSectionRanges;
};
template<> struct TStructOpsTypeTraits<FMovieSceneTemplateGenerationLedger> : public TStructOpsTypeTraitsBase2<FMovieSceneTemplateGenerationLedger> { enum { WithCopy = true }; };
 
USTRUCT()
struct FMovieSceneSubSectionData
{
    GENERATED_BODY()
 
    FMovieSceneSubSectionData() : Flags(ESectionEvaluationFlags::None) {}
 
    FMovieSceneSubSectionData(UMovieSceneSubSection& InSubSection, const FGuid& InObjectBindingId, ESectionEvaluationFlags InFlags);
 
    friend FArchive& operator<<(FArchive& Ar, FMovieSceneSubSectionData& In)
    {
        return Ar << In.Section << In.ObjectBindingId << In.Flags;
    }
 
    friend bool operator==(const FMovieSceneSubSectionData& A, const FMovieSceneSubSectionData& B)
    {
        return A.Section == B.Section && A.ObjectBindingId == B.ObjectBindingId && A.Flags == B.Flags;
    }
 
    UPROPERTY()
    TWeakObjectPtr<UMovieSceneSubSection> Section;
 
    UPROPERTY()
    FGuid ObjectBindingId;
 
    UPROPERTY()
    ESectionEvaluationFlags Flags;
};
 
USTRUCT()
struct FMovieSceneEvaluationTemplateSerialNumber
{
    GENERATED_BODY()
 
    FMovieSceneEvaluationTemplateSerialNumber()
        : Value(0)
    {}
 
    uint32 GetValue() const
    {
        return Value;
    }
 
    void Increment()
    {
        ++Value;
    }
 
private:
    
    friend struct FMovieSceneEvaluationTemplate;
 
    FMovieSceneEvaluationTemplateSerialNumber(const FMovieSceneEvaluationTemplateSerialNumber&) : Value(0) {}
    FMovieSceneEvaluationTemplateSerialNumber(FMovieSceneEvaluationTemplateSerialNumber&&)      : Value(0) {}
 
    FMovieSceneEvaluationTemplateSerialNumber& operator=(const FMovieSceneEvaluationTemplateSerialNumber&) { return *this; }
    FMovieSceneEvaluationTemplateSerialNumber& operator=(FMovieSceneEvaluationTemplateSerialNumber&&)      { return *this; }
 
    UPROPERTY()
    uint32 Value;
};
template<> struct TStructOpsTypeTraits<FMovieSceneEvaluationTemplateSerialNumber> : public TStructOpsTypeTraitsBase2<FMovieSceneEvaluationTemplateSerialNumber> { enum { WithCopy = false }; };
 
USTRUCT()
struct FMovieSceneEvaluationTemplate
{
    GENERATED_BODY()
 
public:
 
    FMovieSceneEvaluationTrack* FindTrack(FMovieSceneTrackIdentifier Identifier)
    {
        // Fast, most common path
        if (FMovieSceneEvaluationTrack* Track = Tracks.Find(Identifier))
        {
            return Track;
        }
 
        return StaleTracks.Find(Identifier);
    }
 
    const FMovieSceneEvaluationTrack* FindTrack(FMovieSceneTrackIdentifier Identifier) const
    {
        // Fast, most common path
        if (const FMovieSceneEvaluationTrack* Track = Tracks.Find(Identifier))
        {
            return Track;
        }
 
        return StaleTracks.Find(Identifier);
    }
 
    FMovieSceneEvaluationTrack* FindTrack(const FGuid& InSignature)
    {
        return FindTrack(TemplateLedger.FindTrackIdentifier(InSignature));
    }
 
    const FMovieSceneEvaluationTrack* FindTrack(const FGuid& InSignature) const
    {
        return FindTrack(TemplateLedger.FindTrackIdentifier(InSignature));
    }
 
    bool IsTrackStale(FMovieSceneTrackIdentifier Identifier) const
    {
        return StaleTracks.Contains(Identifier);
    }
 
    MOVIESCENE_API FMovieSceneTrackIdentifier AddTrack(const FGuid& InSignature, FMovieSceneEvaluationTrack&& InTrack);
 
    MOVIESCENE_API void RemoveTrack(const FGuid& InSignature);
 
    MOVIESCENE_API const TMap<FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack>& GetTracks() const;
 
    MOVIESCENE_API TMap<FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack>& GetTracks();
 
    MOVIESCENE_API const TMap<FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack>& GetStaleTracks() const;
 
#if WITH_EDITORONLY_DATA
    MOVIESCENE_API void PostSerialize(const FArchive& Ar);
#endif
 
    void PurgeStaleTracks()
    {
        StaleTracks.Reset();
    }
 
public:
 
    const FMovieSceneTemplateGenerationLedger& GetLedger() const
    {
        return TemplateLedger;
    }
 
    void RemoveStaleData(const TSet<FGuid>& ActiveSignatures);
private:
 
    UPROPERTY()
    TMap<FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack> Tracks;
 
    TMap<FMovieSceneTrackIdentifier, FMovieSceneEvaluationTrack> StaleTracks;
 
public:
 
    UPROPERTY()
    FGuid SequenceSignature;
 
    UPROPERTY()
    FMovieSceneEvaluationTemplateSerialNumber TemplateSerialNumber;
 
private:
 
    UPROPERTY()
    FMovieSceneTemplateGenerationLedger TemplateLedger;
 
};
#if WITH_EDITORONLY_DATA
template<> struct TStructOpsTypeTraits<FMovieSceneEvaluationTemplate> : public TStructOpsTypeTraitsBase2<FMovieSceneEvaluationTemplate> { enum { WithPostSerialize = true }; };
#endif