IntegralCurve.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 "Curves/KeyHandle.h"
#include "Curves/IndexedCurve.h"
#include "IntegralCurve.generated.h"
 
 
USTRUCT()
struct FIntegralKey
{
    GENERATED_USTRUCT_BODY()
public:
 
    FIntegralKey(float InTime = 0.f, int32 InValue = 0)
        : Time(InTime)
        , Value(InValue)
    { }
    
    UPROPERTY(EditAnywhere, Category=Key)
    float Time;
 
    UPROPERTY(EditAnywhere, Category=Key)
    int32 Value;
};
 
 
USTRUCT()
struct FIntegralCurve
    : public FIndexedCurve
{
    GENERATED_USTRUCT_BODY()
 
public:
 
    FIntegralCurve() 
        : FIndexedCurve()
        , DefaultValue(MAX_int32)
        , bUseDefaultValueBeforeFirstKey(false)
    { }
 
    virtual ~FIntegralCurve() { }
    
    virtual int32 GetNumKeys() const override final { return Keys.Num(); }
 
    virtual FIndexedCurve* Duplicate() const final { return new FIntegralCurve(*this); }
 
    ENGINE_API int32 Evaluate(float Time, int32 InDefaultValue = 0) const;
 
    bool HasAnyData() const
    {
        return DefaultValue != MAX_int32 || Keys.Num();
    }
 
    ENGINE_API TArray<FIntegralKey>::TConstIterator GetKeyIterator() const;
    
    ENGINE_API FKeyHandle AddKey( float InTime, int32 InValue, FKeyHandle KeyHandle = FKeyHandle() );
    
    ENGINE_API void DeleteKey(FKeyHandle KeyHandle);
    
    ENGINE_API FKeyHandle UpdateOrAddKey( float InTime, int32 Value, float KeyTimeTolerance = UE_KINDA_SMALL_NUMBER );
    
    ENGINE_API virtual void SetKeyTime(FKeyHandle KeyHandle, float NewTime) override final;
 
    ENGINE_API virtual float GetKeyTime(FKeyHandle KeyHandle) const override final;
 
    ENGINE_API void SetKeyValue(FKeyHandle KeyHandle, int32 NewValue);
 
    ENGINE_API int32 GetKeyValue(FKeyHandle KeyHandle) const;
    
    void SetDefaultValue(int32 InDefaultValue) { DefaultValue = InDefaultValue; }
 
    int32 GetDefaultValue() const { return DefaultValue; }
    
    void ClearDefaultValue() { DefaultValue = MAX_int32; }
 
    void SetUseDefaultValueBeforeFirstKey(bool InbUseDefaultValueBeforeFirstKey) { bUseDefaultValueBeforeFirstKey = InbUseDefaultValueBeforeFirstKey; }
    
    bool GetUseDefaultValueBeforeFirstKey() const { return bUseDefaultValueBeforeFirstKey; }
 
    ENGINE_API FIntegralKey& GetKey(FKeyHandle KeyHandle);
    ENGINE_API FIntegralKey GetKey(FKeyHandle KeyHandle) const;
 
    ENGINE_API FKeyHandle FindKey(float KeyTime, float KeyTimeTolerance = UE_KINDA_SMALL_NUMBER) const;
 
    ENGINE_API FKeyHandle FindKeyBeforeOrAt(float KeyTime) const;
 
    ENGINE_API void RemoveRedundantKeys();
private:
 
    UPROPERTY(EditAnywhere, Category="Curve")
    TArray<FIntegralKey> Keys;
 
    UPROPERTY(EditAnywhere, Category="Curve")
    int32 DefaultValue;
 
    UPROPERTY()
    bool bUseDefaultValueBeforeFirstKey;
};