MovieSceneStringChannel.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/MovieSceneChannelEditorData.h"
#include "Channels/MovieSceneChannelTraits.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Math/Range.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameTime.h"
#include "Misc/Optional.h"
#include "Serialization/StructuredArchive.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
 
#include "MovieSceneStringChannel.generated.h"
 
struct FFrameRate;
struct FKeyHandle;
struct FPropertyTag;
 
USTRUCT()
struct FMovieSceneStringChannel : public FMovieSceneChannel
{
    GENERATED_BODY()
 
    typedef FString CurveValueType;
 
    FMovieSceneStringChannel()
        : DefaultValue(), bHasDefaultValue(false)
    {}
 
    MOVIESCENETRACKS_API bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
 
    inline TMovieSceneChannelData<FString> GetData()
    {
        return TMovieSceneChannelData<FString>(&Times, &Values, this, &KeyHandles);
    }
 
    inline TMovieSceneChannelData<const FString> GetData() const
    {
        return TMovieSceneChannelData<const FString>(&Times, &Values);
    }
 
    inline TArrayView<const FFrameNumber> GetTimes() const
    {
        return Times;
    }
 
    inline bool HasAnyData() const
    {
        return Times.Num() != 0 || bHasDefaultValue == true;
    }
 
    MOVIESCENETRACKS_API const FString* Evaluate(FFrameTime InTime) const;
 
    inline void AddKeys(const TArray<FFrameNumber>& InTimes, const TArray<FString>& InValues)
    {
        check(InTimes.Num() == InValues.Num());
        Times.Append(InTimes);
        Values.Append(InValues);
    }
 
public:
 
    // ~ FMovieSceneChannel Interface
    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;
    MOVIESCENETRACKS_API virtual FKeyHandle GetHandle(int32 Index) override;
    MOVIESCENETRACKS_API virtual int32 GetIndex(FKeyHandle Handle) override;
 
public:
 
    inline void SetDefault(FString InDefaultValue)
    {
        bHasDefaultValue = true;
        DefaultValue = InDefaultValue;
    }
 
    inline TOptional<FString> GetDefault() const
    {
        return bHasDefaultValue ? TOptional<FString>(DefaultValue) : TOptional<FString>();
    }
 
    inline void RemoveDefault()
    {
        bHasDefaultValue = false;
    }
 
private:
 
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> Times;
 
    UPROPERTY(meta=(KeyValues))
    TArray<FString> Values;
 
    UPROPERTY()
    FString DefaultValue;
 
    UPROPERTY()
    bool bHasDefaultValue;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneStringChannel> : public TStructOpsTypeTraitsBase2<FMovieSceneStringChannel>
{
    enum { WithStructuredSerializeFromMismatchedTag = true };
};
 
 
template<>
struct TMovieSceneChannelTraits<FMovieSceneStringChannel> : TMovieSceneChannelTraitsBase<FMovieSceneStringChannel>
{
#if WITH_EDITOR
 
    typedef TMovieSceneExternalValue<FString> ExtendedEditorDataType;
 
#endif
};
 
inline bool EvaluateChannel(const FMovieSceneStringChannel* InChannel, FFrameTime InTime, FString& OutValue)
{
    if (const FString* Result = InChannel->Evaluate(InTime))
    {
        OutValue = *Result;
        return true;
    }
    return false;
}
 
inline bool ValueExistsAtTime(const FMovieSceneStringChannel* Channel, FFrameNumber InFrameNumber, const FString& Value)
{
    const FFrameTime FrameTime(InFrameNumber);
 
    const FString* ExistingValue = Channel->Evaluate(FrameTime);
    return ExistingValue && Value == *ExistingValue;
}