IndexedCurve.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 "IndexedCurve.generated.h"
 
 
USTRUCT()
struct FIndexedCurve
{
    GENERATED_USTRUCT_BODY()
 
public:
 
    FIndexedCurve() { }
 
    virtual ~FIndexedCurve() { }
 
public:
 
    ENGINE_API int32 GetIndexSafe(FKeyHandle KeyHandle) const;
 
    TArray<FKeyHandle>::TConstIterator GetKeyHandleIterator() const
    {
        EnsureAllIndicesHaveHandles();
        return KeyHandlesToIndices.CreateConstIterator();
    }
 
    virtual int32 GetNumKeys() const PURE_VIRTUAL(FIndexedCurve::GetNumKeys, return 0;);
 
    virtual void SetKeyTime(FKeyHandle KeyHandle, float NewTime) PURE_VIRTUAL(FIndexedCurve::SetKeyTime, );
 
    virtual float GetKeyTime(FKeyHandle KeyHandle) const PURE_VIRTUAL(FIndexedCurve::GetKeyTime, return 0.f;);
    
    virtual FIndexedCurve* Duplicate() const PURE_VIRTUAL(FIndexedCurve::Duplicate, return nullptr;);
 
    ENGINE_API bool IsKeyHandleValid(FKeyHandle KeyHandle) const;
 
    FKeyHandle GetFirstKeyHandle() const { return (GetNumKeys() > 0 ? GetKeyHandle(0) : FKeyHandle::Invalid()); }
 
    FKeyHandle GetLastKeyHandle() const { const int32 NumKeys = GetNumKeys(); return (NumKeys > 0 ? GetKeyHandle(NumKeys-1) : FKeyHandle::Invalid()); }
 
    ENGINE_API FKeyHandle GetNextKey(FKeyHandle KeyHandle) const;
 
    ENGINE_API FKeyHandle GetPreviousKey(FKeyHandle KeyHandle) const;
 
    ENGINE_API void ShiftCurve(float DeltaTime);
    ENGINE_API void ShiftCurve(float DeltaTime, const TSet<FKeyHandle>& KeyHandles);
 
    ENGINE_API void ScaleCurve(float ScaleOrigin, float ScaleFactor);
    ENGINE_API void ScaleCurve(float ScaleOrigin, float ScaleFactor, const TSet<FKeyHandle>& KeyHandles);
 
protected:
 
    void EnsureAllIndicesHaveHandles() const { EnsureAllIndicesHaveHandles_Internal(GetNumKeys()); }
    void EnsureIndexHasAHandle(int32 KeyIndex) const { KeyHandlesToIndices.EnsureIndexHasAHandle(KeyIndex); }
 
private:
    ENGINE_API void EnsureAllIndicesHaveHandles_Internal(int32 NumKeys) const;
 
protected:
 
    const int32* FindIndex(FKeyHandle KeyHandle) const { return KeyHandlesToIndices.Find(KeyHandle); }
 
    ENGINE_API int32 GetIndex(FKeyHandle KeyHandle) const;
 
    ENGINE_API FKeyHandle GetKeyHandle(int32 KeyIndex) const;
 
protected:
 
    UPROPERTY(transient)
    mutable FKeyHandleMap KeyHandlesToIndices;
};
 
template<>
struct TStructOpsTypeTraits<FIndexedCurve> : public TStructOpsTypeTraitsBase2<FIndexedCurve>
{
    enum
    {
        WithPureVirtual = true,
    };
};