MovieSceneSectionChannelOverrideRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#include "Containers/Map.h"
#include "CoreMinimal.h"
 
#include "Channels/MovieSceneChannel.h"
#include "Channels/MovieSceneChannelOverrideContainer.h"
#include "Channels/MovieSceneChannelProxy.h"
#include "EntitySystem/IMovieSceneEntityProvider.h"
#include "Evaluation/MovieSceneEvaluationField.h"
#include "HAL/Platform.h"
#include "MovieSceneSection.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "MovieSceneSectionChannelOverrideRegistry.generated.h"
 
class UMovieSceneChannelOverrideContainer;
class UMovieSceneEntitySystemLinker;
class UMovieScenePropertyTrack;
struct FFrameNumber;
struct FMovieSceneChannel;
struct FMovieSceneEntityComponentFieldBuilder;
struct FMovieSceneEvaluationFieldEntityMetaData;
template <typename ElementType> class TRange;
template <typename T> struct TObjectPtr;
 
namespace UE
{
namespace MovieScene
{
    struct FEntityImportParams;
    struct FImportedEntity;
}
}
 
UCLASS(MinimalAPI)
class UMovieSceneSectionChannelOverrideRegistry : public UObject
{
    GENERATED_BODY()
 
public:
    MOVIESCENE_API UMovieSceneSectionChannelOverrideRegistry();
 
    MOVIESCENE_API void AddChannel(FName ChannelName, UMovieSceneChannelOverrideContainer* ChannelContainer);
 
    MOVIESCENE_API bool ContainsChannel(FName ChannelName) const;
 
    MOVIESCENE_API int32 NumChannels() const;
 
    MOVIESCENE_API UMovieSceneChannelOverrideContainer* GetChannel(FName ChannelName) const;
 
    template<typename ChannelContainerType>
    void GetChannels(TArray<ChannelContainerType*>& OutChannels) const
    {
        for (TPair<FName, TObjectPtr<UMovieSceneChannelOverrideContainer>> Pair : Overrides)
        {
            ChannelContainerType* TypedContainer = Cast<ChannelContainerType>(Pair.Value);
            if (TypedContainer)
            {
                OutChannels.Add(TypedContainer);
            }
        }
    }
 
    MOVIESCENE_API void RemoveChannel(FName ChannelName);
 
    MOVIESCENE_API void ImportEntityImpl(const UE::MovieScene::FChannelOverrideEntityImportParams& OverrideParams, const UE::MovieScene::FEntityImportParams& ImportParams, UE::MovieScene::FImportedEntity* OutImportedEntity);
 
    MOVIESCENE_API void PopulateEvaluationFieldImpl(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder, UMovieSceneSection& OwnerSection);
 
#if WITH_EDITOR
 
    MOVIESCENE_API void OnPostPaste();
 
    MOVIESCENE_API virtual void PostEditUndo() override;
 
#endif
 
private:
 
    UPROPERTY()
    TMap<FName, TObjectPtr<UMovieSceneChannelOverrideContainer>> Overrides;
};
 
namespace UE
{
namespace MovieScene 
{
 
inline bool IsChannelOverriden(const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry, FName ChannelName)
{
    return OverrideRegistry && OverrideRegistry->ContainsChannel(ChannelName);
}
 
inline UMovieSceneChannelOverrideContainer* GetChannelOverride(const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry, FName ChannelName)
{
    return OverrideRegistry ? OverrideRegistry->GetChannel(ChannelName) : nullptr;
}
 
#if WITH_EDITOR
 
template<typename ChannelType, typename ExtendedEditorDataType>
void AddChannelProxy(
        FMovieSceneChannelProxyData& ProxyData, const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
        FName ChannelName, ChannelType& DefaultChannel, 
        const FMovieSceneChannelMetaData& InMetaData, ExtendedEditorDataType&& InExtendedEditorData)
{
    UMovieSceneChannelOverrideContainer* OverrideContainer = GetChannelOverride(OverrideRegistry, ChannelName);
    if (OverrideContainer)
    {
        // Because the extended editor data is a strongly-typed templated parameter, we can't pass it through the
        // virtual methods of the channel containers. So channel containers will add an entry with default extended
        // editor data, and we set the correct data immediately after.
        FMovieSceneChannelHandle ChannelHandle = OverrideContainer->AddChannelProxy(ChannelName, ProxyData, InMetaData);
        ProxyData.SetExtendedEditorData<ChannelType>(ChannelHandle, InExtendedEditorData);
    }
    else
    {
        ProxyData.Add(DefaultChannel, InMetaData, InExtendedEditorData);
    }
}
 
template<typename ChannelType, typename ExtendedEditorDataType>
TSharedPtr<FMovieSceneChannelProxy> MakeChannelProxy(
    const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
    ChannelType& DefaultChannel,
    const FMovieSceneChannelMetaData& InMetaData, ExtendedEditorDataType&& InExtendedEditorData)
{
    // When there's only one channel, it usually has no name. Create a channel proxy by hand if
    // you need a named singled channel.
    const FName ChannelName(NAME_None);
    FMovieSceneChannelProxyData ProxyData;
    UMovieSceneChannelOverrideContainer* OverrideContainer = GetChannelOverride(OverrideRegistry, ChannelName);
    if (OverrideContainer)
    {
        FMovieSceneChannelHandle ChannelHandle = OverrideContainer->AddChannelProxy(ChannelName, ProxyData, InMetaData);
        ProxyData.SetExtendedEditorData<ChannelType>(ChannelHandle, InExtendedEditorData);
    }
    else
    {
        ProxyData.Add(DefaultChannel, InMetaData, InExtendedEditorData);
    }
    return MakeShared<FMovieSceneChannelProxy>(MoveTemp(ProxyData));
}
 
#else
 
template<typename ChannelType>
void AddChannelProxy(
        FMovieSceneChannelProxyData& ProxyData, const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
        FName ChannelName, ChannelType& DefaultChannel)
{
    UMovieSceneChannelOverrideContainer* OverrideContainer = GetChannelOverride(OverrideRegistry, ChannelName);
    if (OverrideContainer)
    {
        OverrideContainer->AddChannelProxy(ChannelName, ProxyData);
    }
    else
    {
        ProxyData.Add(DefaultChannel);
    }
}
 
template<typename ChannelType>
TSharedPtr<FMovieSceneChannelProxy> MakeChannelProxy(
    const UMovieSceneSectionChannelOverrideRegistry* OverrideRegistry,
    ChannelType& DefaultChannel)
{
    const FName ChannelName(NAME_None);
    FMovieSceneChannelProxyData ProxyData;
    UMovieSceneChannelOverrideContainer* OverrideContainer = GetChannelOverride(OverrideRegistry, ChannelName);
    if (OverrideContainer)
    {
        OverrideContainer->AddChannelProxy(ChannelName, ProxyData);
    }
    else
    {
        ProxyData.Add(DefaultChannel);
    }
    return MakeShared<FMovieSceneChannelProxy>(MoveTemp(ProxyData));
}
 
#endif
 
}  // namespace MovieScene
}  // namespace UE