MovieSceneChannelEditorDataEntry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "Misc/InlineValue.h"
#include "Algo/Sort.h"
#include "Misc/Attribute.h"
#include "Misc/Optional.h"
#include "Channels/MovieSceneChannelEditorData.h"
 
template<typename> struct TMovieSceneChannelTraits;
 
#if WITH_EDITOR
 
struct FMovieSceneChannelEditorDataEntry
{
    template<typename ChannelType>
    explicit FMovieSceneChannelEditorDataEntry(const ChannelType& Channel)
    {
        ConstructExtendedEditorDataArray<ChannelType>((typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType*)nullptr);
    }
 
    TArrayView<const FMovieSceneChannelMetaData> GetMetaData() const
    {
        return MetaDataArray;
    }
 
    const void* GetExtendedEditorData(int32 ChannelIndex) const
    {
        if (ExtendedEditorDataArray.IsValid())
        {
            return ExtendedEditorDataArray->GetChannel(ChannelIndex);
        }
        return nullptr;
    }
 
protected:
 
    template<typename ChannelType>
    void AddMetaData(const FMovieSceneChannelMetaData& MetaData)
    {
        static_assert(std::is_same_v<typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType, void>, "Must supply extended editor data according to the channel's traits.");
 
        // Add the editor meta-data
        MetaDataArray.Add(MetaData);
    }
 
    template<typename ChannelType, typename ExtendedEditorDataType>
    void AddMetaData(const FMovieSceneChannelMetaData& MetaData, ExtendedEditorDataType&& InExtendedEditorData)
    {
        // Add the editor meta-data
        MetaDataArray.Add(MetaData);
 
        // Add the extended channel-type specific editor data
        auto& TypedImpl = static_cast<TMovieSceneExtendedEditorDataArray<ChannelType>&>(ExtendedEditorDataArray.GetValue());
        TypedImpl.Data.Add(Forward<ExtendedEditorDataType>(InExtendedEditorData));
    }
 
    template<typename ChannelType, typename ExtendedEditorDataType>
    void SetExtendedEditorData(int32 EntryIndex, ExtendedEditorDataType&& InExtendedEditorData)
    {
        // Set the extended channel-type specific editor data
        auto& TypedImpl = static_cast<TMovieSceneExtendedEditorDataArray<ChannelType>&>(ExtendedEditorDataArray.GetValue());
        TypedImpl.Data[EntryIndex] = Forward<ExtendedEditorDataType>(InExtendedEditorData);
    }
 
    template<typename ChannelType>
    TArrayView<const typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType> GetAllExtendedEditorData() const
    {
        static_assert(!std::is_same_v<typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType, void>, "This channel type does not define any extended editor data.");
 
        const auto& TypedImpl = static_cast<const TMovieSceneExtendedEditorDataArray<ChannelType>&>(ExtendedEditorDataArray.GetValue());
        return TypedImpl.Data;
    }
 
private:
 
    template<typename ChannelType, typename ExtendedEditorDataType>
    void ConstructExtendedEditorDataArray(ExtendedEditorDataType*)
    {
        ExtendedEditorDataArray = TMovieSceneExtendedEditorDataArray<ChannelType>();
    }
 
    template<typename ChannelType>
    void ConstructExtendedEditorDataArray(void*)
    {
    }
 
private:
 
    TArray<FMovieSceneChannelMetaData, TInlineAllocator<1>> MetaDataArray;
 
    struct IMovieSceneExtendedEditorDataArray
    {
        virtual ~IMovieSceneExtendedEditorDataArray() {}
        virtual const void* GetChannel(int32 Index) const = 0;
    };
 
    template<typename ChannelType>
    struct TMovieSceneExtendedEditorDataArray : IMovieSceneExtendedEditorDataArray
    {
        typedef typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType ExtendedEditorDataType;
 
        virtual const void* GetChannel(int32 Index) const { return &Data[Index]; }
 
        TArray<ExtendedEditorDataType> Data;
    };
 
    TInlineValue<IMovieSceneExtendedEditorDataArray, 8> ExtendedEditorDataArray;
};
 
#else // WITH_EDITOR
 
struct FMovieSceneChannelEditorDataEntry
{
    template<typename ChannelType> FMovieSceneChannelEditorDataEntry(const ChannelType&){}
};
 
#endif // WITH_EDITOR