StringCurve.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Class.h"
#include "Curves/KeyHandle.h"
#include "Curves/IndexedCurve.h"
#include "StringCurve.generated.h"
 
USTRUCT()
struct FStringCurveKey
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category="Key")
    float Time;
 
    UPROPERTY(EditAnywhere, Category="Key")
    FString Value;
 
    FStringCurveKey()
        : Time(0.0f)
    { }
 
    FStringCurveKey(float InTime, const FString& InValue)
        : Time(InTime)
        , Value(InValue)
    { }
 
public:
 
    //~ TStructOpsTypeTraits interface
 
    ENGINE_API bool operator==(const FStringCurveKey& Other) const;
    ENGINE_API bool operator!=(const FStringCurveKey& Other) const;
    ENGINE_API bool Serialize(FArchive& Ar);
 
    friend FArchive& operator<<(FArchive& Ar, FStringCurveKey& Key)
    {
        Key.Serialize(Ar);
        return Ar;
    }
};
 
 
template<>
struct TStructOpsTypeTraits<FStringCurveKey>
    : public TStructOpsTypeTraitsBase2<FStringCurveKey>
{
    enum
    {
        WithSerializer = true,
        WithCopy = false,
        WithIdenticalViaEquality = true,
    };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
 
USTRUCT()
struct FStringCurve
    : public FIndexedCurve
{
    GENERATED_USTRUCT_BODY()
 
    
    virtual ~FStringCurve() { }
 
public:
 
    bool HasAnyData() const
    {
        return DefaultValue.Len() || Keys.Num();
    }
 
    ENGINE_API FKeyHandle AddKey(float InTime, const FString& InValue, FKeyHandle KeyHandle = FKeyHandle());
 
    ENGINE_API void DeleteKey(FKeyHandle KeyHandle);
 
    ENGINE_API FString Eval(float Time, const FString& InDefaultValue) const;
 
    ENGINE_API FKeyHandle FindKey(float KeyTime, float KeyTimeTolerance = UE_KINDA_SMALL_NUMBER) const;
 
    FString GetDefaultValue() const
    {
        return DefaultValue;
    }
 
    ENGINE_API FStringCurveKey& GetKey(FKeyHandle KeyHandle);
    ENGINE_API FStringCurveKey GetKey(FKeyHandle KeyHandle) const;
 
    const TArray<FStringCurveKey>& GetKeys() const
    {
        return Keys;
    }
 
    ENGINE_API virtual float GetKeyTime(FKeyHandle KeyHandle) const override final;
 
    ENGINE_API FString GetKeyValue(FKeyHandle KeyHandle) const;
 
    void SetDefaultValue(const FString& InDefaultValue)
    {
        DefaultValue = InDefaultValue;
    }
 
    void ClearDefaultValue()
    {
        DefaultValue.Empty();
    }
 
    ENGINE_API virtual void SetKeyTime(FKeyHandle KeyHandle, float NewTime) override final;
 
    ENGINE_API void SetKeyValue(FKeyHandle KeyHandle, FString NewValue);
 
    ENGINE_API FKeyHandle UpdateOrAddKey(float InTime, const FString& InValue, float KeyTimeTolerance = UE_KINDA_SMALL_NUMBER);
 
    ENGINE_API void RemoveRedundantKeys();
public:
 
    //~ FIndexedCurve interface
 
    virtual int32 GetNumKeys() const override final { return Keys.Num(); }
 
    virtual FIndexedCurve* Duplicate() const final { return new FStringCurve(*this); }
 
public:
 
    UPROPERTY(EditAnywhere, Category="Curve")
    FString DefaultValue;
 
    UPROPERTY(EditAnywhere, EditFixedSize, Category="Curve")
    TArray<FStringCurveKey> Keys;
};