MovieSceneKeyStructHelper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneChannelHandle.h"
#include "Channels/MovieSceneChannelTraits.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "CoreTypes.h"
#include "Curves/KeyHandle.h"
#include "Evaluation/MovieSceneRootOverridePath.h"
#include "Misc/FrameNumber.h"
#include "Misc/InlineValue.h"
#include "Misc/Optional.h"
#include "Templates/Tuple.h"
#include "Templates/UnrealTemplate.h"
 
struct FMovieSceneChannelValueHelper;
 
struct FMovieSceneKeyStructHelper
{
    FMovieSceneKeyStructHelper() = default;
 
    FMovieSceneKeyStructHelper(const FMovieSceneKeyStructHelper&) = delete;
    FMovieSceneKeyStructHelper& operator=(const FMovieSceneKeyStructHelper&) = delete;
 
    MOVIESCENE_API void Add(FMovieSceneChannelValueHelper&& InHelper);
 
    MOVIESCENE_API void SetStartingValues();
 
    MOVIESCENE_API TOptional<FFrameNumber> GetUnifiedKeyTime() const;
 
    MOVIESCENE_API void Apply(FFrameNumber InUnifiedTime);
 
private:
    TOptional<FFrameNumber> UnifiedKeyTime;
 
    TArray<FMovieSceneChannelValueHelper> Helpers;
};
 
 
 
struct FMovieSceneChannelValueHelper
{
    template<typename ChannelType, typename ValueType>
    FMovieSceneChannelValueHelper(const TMovieSceneChannelHandle<ChannelType>& InChannel, ValueType* InUserValue, TArrayView<const FKeyHandle> AllKeyHandles);
 
    template<typename ChannelType, typename ValueType>
    FMovieSceneChannelValueHelper(const TMovieSceneChannelHandle<ChannelType>& InChannel, ValueType* InUserValue, TOptional<TTuple<FKeyHandle, FFrameNumber>> InKeyHandleAndTime);
 
    template<typename ChannelType>
    static TOptional<TTuple<FKeyHandle, FFrameNumber>> FindFirstKey(ChannelType* InChannel, TArrayView<const FKeyHandle> AllKeyHandles);
 
 
    struct IChannelValueHelper
    {
        virtual ~IChannelValueHelper(){}
        virtual void SetUserValueFromTime(FFrameNumber InUnifiedTime) = 0;
        virtual void SetKeyFromUserValue(FFrameNumber InUnifiedTime) = 0;
 
        TOptional<TTuple<FKeyHandle, FFrameNumber>> KeyHandleAndTime;
    };
 
    IChannelValueHelper* operator->()
    {
        return &Impl.GetValue();
    }
 
private:
 
    TInlineValue<IChannelValueHelper> Impl;
};
 
 
namespace MovieSceneImpl
{
 
template<typename ChannelType, typename ValueType>
struct TChannelValueHelper : FMovieSceneChannelValueHelper::IChannelValueHelper
{
    TChannelValueHelper(const TMovieSceneChannelHandle<ChannelType>& InChannel, ValueType* InValue)
        : ChannelHandle(InChannel), UserValue(InValue)
    {}
 
    virtual void SetUserValueFromTime(FFrameNumber InUnifiedTime)
    {
        if (ChannelType* Channel = ChannelHandle.Get())
        {
            using namespace UE::MovieScene;
            EvaluateChannel(Channel, InUnifiedTime, *UserValue);
        }
    }
 
    virtual void SetKeyFromUserValue(FFrameNumber InUnifiedTime)
    {
        ChannelType* Channel = ChannelHandle.Get();
 
        using namespace UE::MovieScene;
        if (Channel && KeyHandleAndTime.IsSet())
        {
            FKeyHandle Handle = KeyHandleAndTime->Get<0>();
 
            AssignValue(Channel, Handle, *UserValue);
            Channel->SetKeyTime(Handle, InUnifiedTime);
        }
    }
 
    TMovieSceneChannelHandle<ChannelType> ChannelHandle;
 
    ValueType* UserValue;
};
 
}   // namespace MovieSceneImpl
 
template<typename ChannelType, typename ValueType>
FMovieSceneChannelValueHelper::FMovieSceneChannelValueHelper(const TMovieSceneChannelHandle<ChannelType>& InChannel, ValueType* InUserValue, TArrayView<const FKeyHandle> AllKeyHandles)
    : Impl(MovieSceneImpl::TChannelValueHelper<ChannelType, ValueType>(InChannel, InUserValue))
{
    Impl->KeyHandleAndTime = FindFirstKey(InChannel.Get(), AllKeyHandles);
}
 
 
 
template<typename ChannelType, typename ValueType>
FMovieSceneChannelValueHelper::FMovieSceneChannelValueHelper(const TMovieSceneChannelHandle<ChannelType>& InChannel, ValueType* InUserValue, TOptional<TTuple<FKeyHandle, FFrameNumber>> InKeyHandleAndTime)
    : Impl(MovieSceneImpl::TChannelValueHelper<ChannelType, ValueType>(InChannel, InUserValue))
{
    Impl->KeyHandleAndTime = InKeyHandleAndTime;
}
 
 
 
template<typename ChannelType>
TOptional<TTuple<FKeyHandle, FFrameNumber>> FMovieSceneChannelValueHelper::FindFirstKey(ChannelType* InChannel, TArrayView<const FKeyHandle> AllKeyHandles)
{
    if (InChannel)
    {
        auto ChannelData = InChannel->GetData();
        for (FKeyHandle Handle : AllKeyHandles)
        {
            const int32 KeyIndex = ChannelData.GetIndex(Handle);
            if (KeyIndex != INDEX_NONE)
            {
                return MakeTuple(Handle, ChannelData.GetTimes()[KeyIndex]);
            }
        }
    }
 
    return TOptional<TTuple<FKeyHandle, FFrameNumber>>();
}