MovieSceneSequenceHierarchy.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Evaluation/MovieSceneEvaluationTree.h"
#include "Evaluation/MovieSceneSectionParameters.h"
#include "Evaluation/MovieSceneSegment.h"
#include "Evaluation/MovieSceneSequenceInstanceData.h"
#include "Evaluation/MovieSceneSequenceTransform.h"
#include "HAL/PlatformCrt.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameRate.h"
#include "Misc/Guid.h"
#include "MovieSceneFrameMigration.h"
#include "MovieSceneSequenceID.h"
#include "Serialization/Archive.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
#include "MovieSceneSequenceHierarchy.generated.h"
 
class UMovieSceneSequence;
class UMovieSceneSubSection;
class UMovieSceneCondition;
struct FMovieSceneSequenceID;
template <typename ElementType> class TRange;
 
USTRUCT()
struct FMovieSceneSubSequenceData
{
    GENERATED_BODY()
 
    
    MOVIESCENE_API FMovieSceneSubSequenceData();
 
    MOVIESCENE_API FMovieSceneSubSequenceData(const UMovieSceneSubSection& InSubSection);
 
    /*~ Defined constructors, operators and destructor to work around deprecation warnings on linux */
    MOVIESCENE_API FMovieSceneSubSequenceData(const FMovieSceneSubSequenceData&);
    MOVIESCENE_API FMovieSceneSubSequenceData& operator=(const FMovieSceneSubSequenceData&);
    MOVIESCENE_API FMovieSceneSubSequenceData(FMovieSceneSubSequenceData&&);
    MOVIESCENE_API FMovieSceneSubSequenceData& operator=(FMovieSceneSubSequenceData&&);
    MOVIESCENE_API ~FMovieSceneSubSequenceData();
 
    MOVIESCENE_API UMovieSceneSequence* GetSequence() const;
 
    MOVIESCENE_API UMovieSceneSequence* GetLoadedSequence() const;
 
    MOVIESCENE_API bool IsDirty(const UMovieSceneSubSection& InSubSection) const;
 
    FGuid GetSubSectionSignature() const { return SubSectionSignature; }
 
    UE_DEPRECATED(5.5, "This function is no longer supported")
    MOVIESCENE_API FMovieSceneSectionParameters ToSubSectionParameters() const;
 
    UPROPERTY(meta=(AllowedClasses="/Script/MovieScene.MovieSceneSequence"))
    FSoftObjectPath Sequence;
 
    UPROPERTY()
    FMovieSceneSequenceTransform OuterToInnerTransform;
 
    UPROPERTY()
    FMovieSceneSequenceTransform RootToSequenceTransform;
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    FMovieSceneSequenceTransform LocalToWarpedLocalTransform;
 
    UPROPERTY()
    FMovieSceneSequenceTransform RootToUnwarpedLocalTransform;
 
    UPROPERTY()
    FMovieSceneTransformBreadcrumbs StartTimeBreadcrumbs;
 
    UPROPERTY()
    FMovieSceneTransformBreadcrumbs EndTimeBreadcrumbs;
 
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY()
    FFrameRate TickResolution;
 
    UPROPERTY()
    FMovieSceneSequenceID DeterministicSequenceID;
    
    UPROPERTY()
    FMovieSceneFrameRange PlayRange;
 
    UPROPERTY()
    FMovieSceneFrameRange ParentPlayRange;
 
    UPROPERTY()
    FMovieSceneFrameRange PreRollRange;
 
    UPROPERTY()
    FMovieSceneFrameRange PostRollRange;
 
    UPROPERTY()
    int16 HierarchicalBias;
 
    UPROPERTY()
    EMovieSceneSubSectionFlags AccumulatedFlags;
 
    UPROPERTY()
    bool bCanLoop = false;
 
    UPROPERTY()
    FMovieSceneSequenceInstanceDataPtr InstanceData;
 
    UPROPERTY()
    FName SectionPath;
 
#if WITH_EDITORONLY_DATA
 
    UE_DEPRECATED(5.5, "Please use GetSequence()->GetMovieScene()->GetPlaybackRange().")
    FMovieSceneFrameRange FullPlayRange;
    UE_DEPRECATED(5.5, "This field is no longer supported.")
    FFrameNumber ParentStartFrameOffset;
    UE_DEPRECATED(5.5, "This field is no longer supported.")
    FFrameNumber ParentEndFrameOffset;
    UE_DEPRECATED(5.5, "This field is no longer supported.")
    FFrameNumber ParentFirstLoopStartFrameOffset;
    UE_DEPRECATED(5.5, "This field is no longer used")
    FMovieSceneFrameRange UnwarpedPlayRange;
 
#endif
    
    /* Optional condition pulled off of the UMovieSceneSubSection or UMovieSceneSubTrack */
    UPROPERTY()
    TSoftObjectPtr<const UMovieSceneCondition> WeakCondition;
 
 
private:
 
    mutable TWeakObjectPtr<UMovieSceneSequence> CachedSequence;
 
    UPROPERTY()
    FGuid SubSectionSignature;
};
 
USTRUCT()
struct FMovieSceneSequenceHierarchyNode
{
    GENERATED_BODY()
 
    
    FMovieSceneSequenceHierarchyNode()
    {}
 
    FMovieSceneSequenceHierarchyNode(FMovieSceneSequenceIDRef InParentID)
        : ParentID(InParentID)
    {}
 
    UPROPERTY()
    FMovieSceneSequenceID ParentID;
 
    UPROPERTY()
    TArray<FMovieSceneSequenceID> Children;
};
 
USTRUCT()
struct FMovieSceneSubSequenceTreeEntry
{
    GENERATED_BODY()
 
    FMovieSceneSubSequenceTreeEntry(FMovieSceneSequenceID InSequenceID, ESectionEvaluationFlags InFlags)
        : SequenceID(InSequenceID)
        , Flags(InFlags)
    {}
 
    MOVIESCENE_API FMovieSceneSubSequenceTreeEntry();
 
    MOVIESCENE_API FMovieSceneSubSequenceTreeEntry(const FMovieSceneSubSequenceTreeEntry&);
    MOVIESCENE_API FMovieSceneSubSequenceTreeEntry& operator=(const FMovieSceneSubSequenceTreeEntry&);
 
    MOVIESCENE_API FMovieSceneSubSequenceTreeEntry(FMovieSceneSubSequenceTreeEntry&&);
    MOVIESCENE_API FMovieSceneSubSequenceTreeEntry& operator=(FMovieSceneSubSequenceTreeEntry&&);
 
    MOVIESCENE_API ~FMovieSceneSubSequenceTreeEntry();
 
    friend FArchive& operator<<(FArchive& Ar, FMovieSceneSubSequenceTreeEntry& InOutEntry);
    friend bool operator==(const FMovieSceneSubSequenceTreeEntry& A, const FMovieSceneSubSequenceTreeEntry& B);
 
    FMovieSceneSequenceID SequenceID;
    ESectionEvaluationFlags Flags;
 
    UE_DEPRECATED(5.5, "This member is no longer supported")
    FMovieSceneWarpCounter RootToSequenceWarpCounter;
};
 
USTRUCT()
struct FMovieSceneSubSequenceTree
{
    GENERATED_BODY()
 
    friend bool operator==(const FMovieSceneSubSequenceTree& A, const FMovieSceneSubSequenceTree& B)
    {
        return A.Data == B.Data;
    }
 
    bool Serialize(FArchive& Ar)
    {
        Ar << Data;
        return true;
    }
 
    TMovieSceneEvaluationTree<FMovieSceneSubSequenceTreeEntry> Data;
};
template<> struct TStructOpsTypeTraits<FMovieSceneSubSequenceTree> : public TStructOpsTypeTraitsBase2<FMovieSceneSubSequenceTree> { enum { WithSerializer = true, WithIdenticalViaEquality = true }; };
 
USTRUCT()
struct FMovieSceneSequenceHierarchy
{
    GENERATED_BODY()
 
    FMovieSceneSequenceHierarchy()
        : RootNode(MovieSceneSequenceID::Invalid)
    {}
 
    const FMovieSceneSequenceHierarchyNode* FindNode(FMovieSceneSequenceIDRef SequenceID) const
    {
        return SequenceID == MovieSceneSequenceID::Root ? &RootNode : Hierarchy.Find(SequenceID);
    }
 
    FMovieSceneSequenceHierarchyNode* FindNode(FMovieSceneSequenceIDRef SequenceID)
    {
        return SequenceID == MovieSceneSequenceID::Root ? &RootNode : Hierarchy.Find(SequenceID);
    }
 
    const FMovieSceneSubSequenceData* FindSubData(FMovieSceneSequenceIDRef SequenceID) const
    {
        return SequenceID == MovieSceneSequenceID::Root ? nullptr : SubSequences.Find(SequenceID);
    }
 
    FMovieSceneSubSequenceData* FindSubData(FMovieSceneSequenceIDRef SequenceID)
    {
        return SequenceID == MovieSceneSequenceID::Root ? nullptr : SubSequences.Find(SequenceID);
    }
 
    UMovieSceneSequence* FindSubSequence(FMovieSceneSequenceIDRef SequenceID) const
    {
        const FMovieSceneSubSequenceData* SubSequenceData = FindSubData(SequenceID);
        return SubSequenceData ? SubSequenceData->GetSequence(): nullptr;
    }
 
    void Add(const FMovieSceneSubSequenceData& Data, FMovieSceneSequenceIDRef ThisSequenceID, FMovieSceneSequenceIDRef ParentID);
 
    void Remove(TArrayView<const FMovieSceneSequenceID> SequenceIDs);
 
    void AddRange(const TRange<FFrameNumber>& RootSpaceRange, FMovieSceneSequenceIDRef InSequenceID, ESectionEvaluationFlags InFlags);
 
    UE_DEPRECATED(5.5, "The RootToSequenceWarpCounter parameter is no longer required or supported")
    void AddRange(const TRange<FFrameNumber>& RootSpaceRange, FMovieSceneSequenceIDRef InSequenceID, ESectionEvaluationFlags InFlags, FMovieSceneWarpCounter RootToSequenceWarpCounter);
 
    FMovieSceneSubSequenceData* MutateSubData(FMovieSceneSequenceIDRef SequenceID)
    {
        return SequenceID == MovieSceneSequenceID::Root ? nullptr : SubSequences.Find(SequenceID);
    }
 
    void SetRootTransform(FMovieSceneSequenceTransform&& InTransform)
    {
        RootTransform = MoveTemp(InTransform);
    }
 
    void AllSubSequenceIDs(TArray<FMovieSceneSequenceID>& OutSequenceIDs) const
    {
        Hierarchy.GetKeys(OutSequenceIDs);
    }
 
    const TMap<FMovieSceneSequenceID, FMovieSceneSubSequenceData>& AllSubSequenceData() const
    {
        return SubSequences;
    }
 
    const TMap<FMovieSceneSequenceID, FMovieSceneSequenceHierarchyNode>& AllSubSequenceNodes() const
    {
        return Hierarchy;
    }
 
    const TMovieSceneEvaluationTree<FMovieSceneSubSequenceTreeEntry>& GetTree() const
    {
        return Tree.Data;
    }
 
    EMovieSceneServerClientMask GetAccumulatedNetworkMask() const
    {
        return AccumulatedNetworkMask;
    }
 
    void AccumulateNetworkMask(EMovieSceneServerClientMask Mask)
    {
        AccumulatedNetworkMask &= Mask;
    }
 
    const FMovieSceneSequenceTransform& GetRootTransform() const
    {
        return RootTransform;
    }
 
#if !NO_LOGGING
    void LogHierarchy() const;
    void LogSubSequenceTree() const;
#endif
 
private:
 
 
    UPROPERTY()
    FMovieSceneSequenceHierarchyNode RootNode;
 
    UPROPERTY()
    FMovieSceneSubSequenceTree Tree;
 
    UPROPERTY()
    FMovieSceneSequenceTransform RootTransform;
 
    UPROPERTY()
    TMap<FMovieSceneSequenceID, FMovieSceneSubSequenceData> SubSequences;
 
    UPROPERTY()
    TMap<FMovieSceneSequenceID, FMovieSceneSequenceHierarchyNode> Hierarchy;
 
    UPROPERTY()
    EMovieSceneServerClientMask AccumulatedNetworkMask = EMovieSceneServerClientMask::All;
};