MovieSceneRootOverridePath.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "HAL/Platform.h"
#include "MovieSceneSequenceID.h"
 
class IMovieScenePlayer;
struct FMovieSceneSequenceHierarchy;
 
namespace UE
{
namespace MovieScene
{
 
struct FSharedPlaybackState;
 
struct FSubSequencePath
{
    MOVIESCENE_API FSubSequencePath();
 
    MOVIESCENE_API explicit FSubSequencePath(FMovieSceneSequenceID LeafID, TSharedRef<const FSharedPlaybackState> SharedPlaybackState);
 
    UE_DEPRECATED(5.5, "Please use the version that takes an FSharedPlaybackState")
    MOVIESCENE_API explicit FSubSequencePath(FMovieSceneSequenceID LeafID, IMovieScenePlayer& Player);
 
    MOVIESCENE_API explicit FSubSequencePath(FMovieSceneSequenceID LeafID, const FMovieSceneSequenceHierarchy* RootHierarchy);
 
 
    static MOVIESCENE_API FMovieSceneSequenceID FindCommonParent(const FSubSequencePath& A, const FSubSequencePath& B);
 
 
    /*inline*/ FMovieSceneSequenceID ResolveChildSequenceID(FMovieSceneSequenceID SequenceID) const
    {
        if (LIKELY(PathToRoot.Num() == 0))
        {
            return SequenceID;
        }
 
        for (FSequenceIDPair Parent : PathToRoot)
        {
            SequenceID = SequenceID.AccumulateParentID(Parent.Unaccumulated);
        }
        return SequenceID;
    }
 
    MOVIESCENE_API void Reset();
 
 
    MOVIESCENE_API void Reset(FMovieSceneSequenceID LeafID, const FMovieSceneSequenceHierarchy* RootHierarchy);
 
 
    MOVIESCENE_API bool Contains(FMovieSceneSequenceID SequenceID) const;
 
 
    MOVIESCENE_API int32 NumGenerationsFromLeaf(FMovieSceneSequenceID SequenceID) const;
 
 
    MOVIESCENE_API int32 NumGenerationsFromRoot(FMovieSceneSequenceID SequenceID) const;
 
    MOVIESCENE_API FMovieSceneSequenceID MakeLocalSequenceID(FMovieSceneSequenceID ParentSequenceID) const;
 
    MOVIESCENE_API FMovieSceneSequenceID MakeLocalSequenceID(FMovieSceneSequenceID ParentSequenceID, FMovieSceneSequenceID TargetSequenceID) const;
 
    MOVIESCENE_API void PushGeneration(FMovieSceneSequenceID AccumulatedSequenceID, FMovieSceneSequenceID UnaccumulatedSequenceID);
 
    MOVIESCENE_API void PopTo(FMovieSceneSequenceID ParentSequenceID);
 
    MOVIESCENE_API void PopGenerations(int32 NumGenerations);
 
private:
 
    struct FSequenceIDPair
    {
        FMovieSceneSequenceID Unaccumulated;
        FMovieSceneSequenceID Accumulated;
    };
 
    TArray<FSequenceIDPair, TInlineAllocator<8>> PathToRoot;
};
 
 
} // namespace MovieScene
} // namespace UE