MovieSceneTextChannel.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/MovieSceneChannelTraits.h"
 
#if WITH_EDITOR
#include "UObject/WeakObjectPtr.h"
#endif
 
#include "MovieSceneTextChannel.generated.h"
 
#if WITH_EDITOR
class UPackage;
#endif
 
USTRUCT()
struct FMovieSceneTextChannel : public FMovieSceneChannel
{
    GENERATED_BODY()
 
    typedef FText CurveValueType;
 
#if WITH_EDITOR
    MOVIESCENETRACKS_API void SetPackage(UPackage* InPackage);
 
    MOVIESCENETRACKS_API UPackage* GetPackage() const;
#endif
 
    inline TMovieSceneChannelData<FText> GetData()
    {
        return TMovieSceneChannelData<FText>(&Times, &Values, this, &KeyHandles);
    }
 
    inline TMovieSceneChannelData<const FText> GetData() const
    {
        return TMovieSceneChannelData<const FText>(&Times, &Values);
    }
 
    inline TConstArrayView<FFrameNumber> GetTimes() const
    {
        return Times;
    }
 
    inline bool HasAnyData() const
    {
        return Times.Num() != 0 || bHasDefaultValue == true;
    }
 
    MOVIESCENETRACKS_API const FText* Evaluate(FFrameTime InTime) const;
 
    inline void AddKeys(const TArray<FFrameNumber>& InTimes, const TArray<FText>& InValues)
    {
        check(InTimes.Num() == InValues.Num());
        Times.Append(InTimes);
        Values.Append(InValues);
    }
 
    inline void SetDefault(FText InDefaultValue)
    {
        bHasDefaultValue = true;
        DefaultValue = InDefaultValue;
    }
 
    inline TOptional<FText> GetDefault() const
    {
        return bHasDefaultValue ? TOptional<FText>(DefaultValue) : TOptional<FText>();
    }
 
    inline void RemoveDefault()
    {
        bHasDefaultValue = false;
    }
 
    //~ Begin FMovieSceneChannel
    MOVIESCENETRACKS_API virtual void GetKeys(const TRange<FFrameNumber>& WithinRange, TArray<FFrameNumber>* OutKeyTimes, TArray<FKeyHandle>* OutKeyHandles) override;
    MOVIESCENETRACKS_API virtual void GetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<FFrameNumber> OutKeyTimes) override;
    MOVIESCENETRACKS_API virtual void SetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<const FFrameNumber> InKeyTimes) override;
    MOVIESCENETRACKS_API virtual void DuplicateKeys(TArrayView<const FKeyHandle> InHandles, TArrayView<FKeyHandle> OutNewHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeys(TArrayView<const FKeyHandle> InHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeysFrom(FFrameNumber InTime, bool bDeleteKeysBefore) override;
    MOVIESCENETRACKS_API virtual void RemapTimes(const UE::MovieScene::IRetimingInterface& Retimer) override;
    MOVIESCENETRACKS_API virtual TRange<FFrameNumber> ComputeEffectiveRange() const override;
    MOVIESCENETRACKS_API virtual int32 GetNumKeys() const override;
    MOVIESCENETRACKS_API virtual void Reset() override;
    MOVIESCENETRACKS_API virtual void Offset(FFrameNumber DeltaPosition) override;
    MOVIESCENETRACKS_API virtual void Optimize(const FKeyDataOptimizationParams& InParameters) override;
    MOVIESCENETRACKS_API virtual void ClearDefault() override;
    //~ End FMovieSceneChannel
 
private:
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> Times;
 
    UPROPERTY(meta=(KeyValues))
    TArray<FText> Values;
 
    UPROPERTY()
    FText DefaultValue;
 
    UPROPERTY()
    bool bHasDefaultValue = false;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
 
#if WITH_EDITOR
    TWeakObjectPtr<UPackage> Package;
#endif
};
 
template<>
struct TMovieSceneChannelTraits<FMovieSceneTextChannel> : TMovieSceneChannelTraitsBase<FMovieSceneTextChannel>
{
#if WITH_EDITOR
    typedef TMovieSceneExternalValue<FText> ExtendedEditorDataType;
#endif
};
 
inline bool EvaluateChannel(const FMovieSceneTextChannel* InChannel, FFrameTime InTime, FText& OutValue)
{
    if (const FText* Result = InChannel->Evaluate(InTime))
    {
        OutValue = *Result;
        return true;
    }
    return false;
}
 
inline bool ValueExistsAtTime(const FMovieSceneTextChannel* Channel, FFrameNumber InFrameNumber, const FText& Value)
{
    const FFrameTime FrameTime(InFrameNumber);
 
    const FText* ExistingValue = Channel->Evaluate(FrameTime);
 
    return ExistingValue && Value.EqualTo(*ExistingValue);
}