1. Epic GamesDeveloper
  3. FAttributeCurve

FAttributeCurve

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AttributeCurve.h
Include #include "Animation/AttributeCurve.h"

Syntax

struct FAttributeCurve : public FIndexedCurve

Variables

  Type Name Description
Protected variable bool bShouldInterpolate Whether or not to interpolate between keys of ScripStruct type
Protected variable TArray< FAttributeKey > Keys The keys, ordered by time
Protected variable const UE::Anim::IAttributeBlendOperator * Operator Operator instanced used for interpolating between keys
Protected variable TObjectPtr< UScriptStruct > ScriptStruct Transient UScriptStruct instance representing the underlying value type for the curve
Protected variable FSoftObjectPath ScriptStructPath Path to UScriptStruct to be loaded

Constructors

  Type Name Description
Public function    
Public function  

FAttributeCurve ( UScriptStruct* InScriptStruct
)

  
Public function  

FAttributeCurve ( const FAttributeCurve& OtherCurve
)

  

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Protected function 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.
Public function FKeyHandle

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

 Add a new typed key to the curve with the supplied Time and Value.
Public function Const bool Whether or not the curve can be evaluated, based upon having a valid type and any keys
Public function void

DeleteKey ( FKeyHandle KeyHandle
)

 Remove the specified key from the curve.
Public function Const AttributeType

Evaluate ( float Time
)

 Evaluate the curve keys into a temporary value container
Protected function Const void

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

 Evaluate the curve keys into the provided memory (should be appropriatedly sized)
Public function Const FKeyHandle

FindKey ( float KeyTime,
float KeyTimeTolerance
)

 Finds the key at KeyTime and returns its handle.
Public function Const FKeyHandle

FindKeyBeforeOrAt ( float KeyTime
)

 Gets the handle for the last key which is at or before the time requested.
Public function Const const TArray< FAttributeKey > &  
Public function Const TArray< FAttributeKey > Return copy of contained key-data
Public function Const const FAttributeKey &

GetKey ( FKeyHandle KeyHandle
)

 Functions for getting keys based on handles
Public function FAttributeKey &

GetKey ( FKeyHandle KeyHandle
)

 Functions for getting keys based on handles
Public function Const TArray< FAttributeKey >::TConstIterator Const iterator for the keys, so the indices and handles stay valid
Public function Const const UScriptStruct *  
Public function Const void

GetTypedKeys ( TArray< const AttributeType* >& OutKeys
)

 Populates OutKeys with typed value-ptrs
Public function Const bool Check whether this curve has any data or not
Public function 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
Public function void Tries to reduce the number of keys required for accurate evaluation (zero error threshold)
Public function void

Reset ()

 Removes all key data
Public function bool  
Public function void

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

  
Public function void

SetScriptStruct ( UScriptStruct* InScriptStruct
)

 End FIndexedCurve overrides Sets the underlying type for the curve, only possible when not containing any keys (see Reset)
Protected function FKeyHandle

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

 Finds the key at InTime, and updates its typed value.
Public function FKeyHandle

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

 Finds the key at InTime, and updates its typed value.
Public function FKeyHandle

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

 Finds the key at InTime, and updates its typed value.

Overridden from FIndexedCurve

  Type Name Description
Public function Virtual Const FAttributeCurve * Allocates a duplicate of the curve
Public function Virtual Const float

GetKeyTime ( FKeyHandle KeyHandle
)

 Get the time for the Key with the specified index.
Public function Virtual Const int32 Begin FIndexedCurve overrides
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page