MovieSceneCurveChannelImpl.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneChannel.h"
#include "Channels/MovieSceneChannelData.h"
#include "Channels/MovieSceneChannelProxy.h"
#include "Channels/MovieSceneChannelTraits.h"
#include "Channels/MovieSceneCurveChannelCommon.h"
#include "Curves/RealCurve.h"
#include "Curves/RichCurve.h"
#include "KeyParams.h"
#include "MovieSceneFwd.h"
 
 
namespace UE::MovieScene::Interpolation
{
    struct FCachedInterpolation;
}
 
 
template<typename ChannelType>
struct TMovieSceneCurveChannelImpl
{
    using ChannelValueType = typename ChannelType::ChannelValueType;
    using CurveValueType = typename ChannelType::CurveValueType;
 
    struct FTimeEvaluationCache
    {
        double InterpValue = 0.0;
        int32 Index1 = INDEX_NONE, Index2 = INDEX_NONE;
        int32 CachedNumFrames = INDEX_NONE;
        FFrameTime CacheFrameTime;
    };
 
    static bool Evaluate(const ChannelType* InChannel, FFrameTime InTime, CurveValueType& OutValue);
 
    static UE::MovieScene::Interpolation::FCachedInterpolation GetInterpolationForTime(const ChannelType* InChannel, FFrameTime InTime);
    static UE::MovieScene::Interpolation::FCachedInterpolation GetInterpolationForTime(const ChannelType* InChannel, FTimeEvaluationCache* InOutEvaluationCache, FFrameTime InTime);
 
    static UE::MovieScene::Interpolation::FCachedInterpolation GetInterpolationForKey(const ChannelType* InChannel, int32 KeyIndex, const UE::MovieScene::FCycleParams* Params = nullptr);
    static UE::MovieScene::Interpolation::FCachedInterpolation GetInterpolationForKey(const ChannelType* InChannel, int32 KeyIndex1, int32 KeyIndex2, const UE::MovieScene::FCycleParams* Params = nullptr);
 
    static bool EvaluateWithCache(const ChannelType* InChannel, FTimeEvaluationCache* InOutEvaluationCache, FFrameTime InTime, CurveValueType& OutValue);
    
     /*
      * Populate the specified array with times and values that represent the smooth interpolation of 
      * the given channel across the specified range
      */
    static void PopulateCurvePoints(const ChannelType* InChannel, double StartTimeSeconds, double EndTimeSeconds, double TimeThreshold, CurveValueType ValueThreshold, FFrameRate TickResolution, TArray<TTuple<double, double>>& OutPoints);
 
    static bool ValueExistsAtTime(const ChannelType* Channel, FFrameNumber InFrameNumber, typename ChannelType::CurveValueType Value);
 
    static bool ValueExistsAtTime(const ChannelType* Channel, FFrameNumber InFrameNumber, const typename ChannelType::ChannelValueType& InValue);
 
 
 
    static void Set(ChannelType* InChannel, TArray<FFrameNumber> InTimes, TArray<ChannelValueType> InValues);
 
    static int32 AddConstantKey(ChannelType* InChannel, FFrameNumber InTime, CurveValueType InValue);
 
    static int32 AddLinearKey(ChannelType* InChannel, FFrameNumber InTime, CurveValueType InValue);
 
    static int32 AddCubicKey(ChannelType* InChannel, FFrameNumber InTime, CurveValueType InValue, ERichCurveTangentMode TangentMode = RCTM_Auto, const FMovieSceneTangentData& Tangent = FMovieSceneTangentData());
 
    static float CalcSmartTangent(ChannelType* InChannel, int32 Index);
 
    static void AutoSetTangents(ChannelType* InChannel, float Tension = 0.f);
 
    static void DeleteKeysFrom(ChannelType* InChannel, FFrameNumber InTime, bool bDeleteKeysBefore);
 
    UE_DEPRECATED(5.6, "Please use RemapTimes")
    static void ChangeFrameResolution(ChannelType* InChannel, FFrameRate SourceRate, FFrameRate DestinationRate);
 
    static void RemapTimes(ChannelType* InChannel, const UE::MovieScene::IRetimingInterface& Retimer);
 
    static void Optimize(ChannelType* InChannel, const FKeyDataOptimizationParams& InParameters);
 
    static FKeyHandle AddKeyToChannel(ChannelType* InChannel, FFrameNumber InFrameNumber, float InValue, EMovieSceneKeyInterpolation Interpolation);
 
    static double GetTangentValue(ChannelType* InChannel, const FFrameNumber InFrameTime, const float InValue, double InDeltaTime);
 
    static EMovieSceneKeyInterpolation GetInterpolationMode(ChannelType* InChannel, const FFrameNumber& InTime, EMovieSceneKeyInterpolation DefaultInterpolationMode);
 
    static bool CacheExtrapolation(const ChannelType* InChannel, FFrameTime InTime, UE::MovieScene::Interpolation::FCachedInterpolation& OutValue);
    
    static void Dilate(ChannelType* InChannel, FFrameNumber Origin, float DilationFactor);
 
    static void AssignValue(ChannelType* InChannel, FKeyHandle InKeyHandle, typename ChannelType::CurveValueType InValue);
 
    static bool Serialize(ChannelType* InChannel, FArchive& Ar);
 
    static bool SerializeFromRichCurve(ChannelType* InChannel, const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
 
    static bool SerializeChannelValue(ChannelValueType& InValue, FArchive& Ar);
 
 
    template<typename OtherChannelType>
    static void CopyChannel(const OtherChannelType* InSourceChannel, ChannelType* OutDestinationChannel);
 
private:
 
    static int32 InsertKeyInternal(ChannelType* InChannel, FFrameNumber InTime);
 
    static bool EvaluateCached(const ChannelType* InChannel, FTimeEvaluationCache* InOutEvaluationCache, FFrameTime InTime, CurveValueType& OutValue);
};
 
template<typename ChannelType>
template<typename OtherChannelType>
void TMovieSceneCurveChannelImpl<ChannelType>::CopyChannel(const OtherChannelType* InSourceChannel, ChannelType* OutDestinationChannel)
{
    using OtherChannelValueType = typename OtherChannelType::ChannelValueType;
    using OtherCurveValueType = typename OtherChannelType::CurveValueType;
 
    OutDestinationChannel->PreInfinityExtrap = InSourceChannel->PreInfinityExtrap;
    OutDestinationChannel->PostInfinityExtrap = InSourceChannel->PostInfinityExtrap;
 
    TOptional<OtherCurveValueType> OtherChannelDefaultValue = InSourceChannel->GetDefault();
    OutDestinationChannel->DefaultValue = (CurveValueType)OtherChannelDefaultValue.Get(0.f);
    OutDestinationChannel->bHasDefaultValue = OtherChannelDefaultValue.IsSet();
 
    TArrayView<const FFrameNumber> OtherChannelTimes = InSourceChannel->GetTimes();
    TArrayView<const OtherChannelValueType> OtherChannelValues = InSourceChannel->GetValues();
    OutDestinationChannel->Times.Empty(OtherChannelTimes.Num());
    OutDestinationChannel->Values.Empty(OtherChannelValues.Num());
    for (int32 Index = 0; Index < OtherChannelTimes.Num(); ++Index)
    {
        OutDestinationChannel->Times.Add(OtherChannelTimes[Index]);
 
        const OtherChannelValueType& OtherChannelValue = OtherChannelValues[Index];
        ChannelValueType NewDoubleValue((CurveValueType)OtherChannelValue.Value);
        NewDoubleValue.Tangent = OtherChannelValue.Tangent;
        NewDoubleValue.InterpMode = OtherChannelValue.InterpMode;
        NewDoubleValue.TangentMode = OtherChannelValue.TangentMode;
        OutDestinationChannel->Values.Add(NewDoubleValue);
    }
 
    OutDestinationChannel->TickResolution = InSourceChannel->GetTickResolution();
 
#if WITH_EDITORONLY_DATA
    OutDestinationChannel->bShowCurve = InSourceChannel->GetShowCurve();
#endif
}