1. Epic GamesDeveloper
  3. FAttributeCurve

FAttributeCurve

API > API/Runtime > API/Runtime/Engine

   
Name FAttributeCurve
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AttributeCurve.h
Include Path #include "Animation/AttributeCurve.h"

Syntax

USTRUCT (BlueprintType )  
struct FAttributeCurve : public FIndexedCurve

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAttributeCurve ( const FAttributeCurve& OtherCurve
)

   Animation/AttributeCurve.h  

FAttributeCurve ( UScriptStruct* InScriptStruct
)

   Animation/AttributeCurve.h  
  Animation/AttributeCurve.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAttributeCurve()

 Virtual destructor. Animation/AttributeCurve.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FKeyHandle AddTypedKey ( float InTime,
const AttributeType& InValue,
FKeyHandle InKeyHandle
)

 Add a new typed key to the curve with the supplied Time and Value. Animation/AttributeCurve.h  

bool CanEvaluate()

 Whether or not the curve can be evaluated, based upon having a valid type and any keys Animation/AttributeCurve.h  

void DeleteKey ( FKeyHandle KeyHandle
)

 Remove the specified key from the curve. Animation/AttributeCurve.h  

AttributeType Evaluate ( float Time
) const

 Evaluate the curve keys into a temporary value container Animation/AttributeCurve.h  

FKeyHandle FindKey ( float KeyTime,
float KeyTimeTolerance
) const

 Finds the key at KeyTime and returns its handle. Animation/AttributeCurve.h  

FKeyHandle FindKeyBeforeOrAt ( float KeyTime
) const

 Gets the handle for the last key which is at or before the time requested. Animation/AttributeCurve.h  

const TArray< FAttributeKey > & GetConstRefOfKeys()

   Animation/AttributeCurve.h  

TArray< FAttributeKey > GetCopyOfKeys()

 Return copy of contained key-data Animation/AttributeCurve.h  

const FAttributeKey & GetKey ( FKeyHandle KeyHandle
) const

   Animation/AttributeCurve.h  

FAttributeKey & GetKey ( FKeyHandle KeyHandle
)

 Functions for getting keys based on handles Animation/AttributeCurve.h  

TArray< FAttributeKey >::TConstIterator GetKeyIterator()

 Const iterator for the keys, so the indices and handles stay valid Animation/AttributeCurve.h  

const UScriptStruct * GetScriptStruct()

   Animation/AttributeCurve.h  

void GetTypedKeys ( TArray< const AttributeType* >& OutKeys
) const

 Populates OutKeys with typed value-ptrs Animation/AttributeCurve.h  

bool HasAnyData()

 Check whether this curve has any data or not Animation/AttributeCurve.h  

void ReadjustTimeRange ( float NewMinTimeRange,
float NewMaxTimeRange,
bool bInsert,
float OldStartTime,
float OldEndTime
)

 Used for adjusting the internal key-data when owning object its playlength changes Animation/AttributeCurve.h  

void RemoveRedundantKeys()

 Tries to reduce the number of keys required for accurate evaluation (zero error threshold) Animation/AttributeCurve.h  

void Reset()

 Removes all key data Animation/AttributeCurve.h  

bool Serialize ( FArchive& Ar
)

   Animation/AttributeCurve.h  

void SetKeys ( TArrayView< const float > InTimes,
TArrayView< const void* > InValues
)

   Animation/AttributeCurve.h  

void SetScriptStruct ( UScriptStruct* InScriptStruct
)

 End FIndexedCurve overrides Sets the underlying type for the curve, only possible when not containing any keys (see Reset) Animation/AttributeCurve.h  

FKeyHandle UpdateOrAddTypedKey ( float InTime,
const AttributeType& InValue,
float KeyTimeTolerance
)

 Finds the key at InTime, and updates its typed value. Animation/AttributeCurve.h  

FKeyHandle UpdateOrAddTypedKey ( float InTime,
const void* InValue,
const UScriptStruct* ValueType,
float KeyTimeTolerance
)

 Finds the key at InTime, and updates its typed value. Animation/AttributeCurve.h  

Overridden from FIndexedCurve

Name Remarks Include Path Unreal Specifiers

virtual FAttributeCurve * Duplicate()

 Allocates a duplicate of the curve Animation/AttributeCurve.h  

virtual float GetKeyTime ( FKeyHandle KeyHandle
) const

 Get the time for the Key with the specified index. Animation/AttributeCurve.h  

virtual int32 GetNumKeys()

 Begin FIndexedCurve overrides Animation/AttributeCurve.h  

virtual void SetKeyTime ( FKeyHandle KeyHandle,
float NewTime
)

 Move a key to a new time. This may change the index of the key, so the new key index is returned. Animation/AttributeCurve.h  

Protected

Name Remarks Include Path Unreal Specifiers

FKeyHandle AddKey ( float InTime,
const void* InValue,
FKeyHandle InKeyHandle
)

 Add a new raw memory key (should be appropriately sized) to the curve with the supplied Time and Value. Animation/AttributeCurve.h  

void EvaluateToPtr ( const UScriptStruct* InScriptStruct,
float Time,
uint8* InOutDataPtr
) const

 Evaluate the curve keys into the provided memory (should be appropriatedly sized) Animation/AttributeCurve.h  

FKeyHandle UpdateOrAddKey ( float InTime,
const void* InValue,
float KeyTimeTolerance
)

 Finds the key at InTime, and updates its typed value. Animation/AttributeCurve.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page