Navigation
API > API/Runtime > API/Runtime/Engine
An integral curve, which holds the key time and the key value
| Name | FIntegralCurve |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Curves/IntegralCurve.h |
| Include Path | #include "Curves/IntegralCurve.h" |
Syntax
USTRUCT ()
struct FIntegralCurve : public FIndexedCurve
Inheritance Hierarchy
- FIndexedCurve → FIntegralCurve
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FIntegralCurve() |
Default constructor. | Curves/IntegralCurve.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FIntegralCurve() |
Virtual destructor. | Curves/IntegralCurve.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseDefaultValueBeforeFirstKey | bool | Curves/IntegralCurve.h | ||
| DefaultValue | int32 | Default value | Curves/IntegralCurve.h |
|
| Keys | TArray< FIntegralKey > | The keys, ordered by time | Curves/IntegralCurve.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FKeyHandle AddKey
(
float InTime, |
Add a new key to the curve with the supplied Time and Value. | Curves/IntegralCurve.h | |
void ClearDefaultValue() |
Removes the default value for this curve. | Curves/IntegralCurve.h | |
void DeleteKey
(
FKeyHandle KeyHandle |
Remove the specified key from the curve. | Curves/IntegralCurve.h | |
int32 Evaluate
(
float Time, |
Evaluates the value of an array of keys at a time | Curves/IntegralCurve.h | |
FKeyHandle FindKey
(
float KeyTime, |
Curves/IntegralCurve.h | ||
FKeyHandle FindKeyBeforeOrAt
(
float KeyTime |
Gets the handle for the last key which is at or before the time requested. | Curves/IntegralCurve.h | |
int32 GetDefaultValue() |
Get the default value for the curve | Curves/IntegralCurve.h | |
FIntegralKey & GetKey
(
FKeyHandle KeyHandle |
Functions for getting keys based on handles | Curves/IntegralCurve.h | |
FIntegralKey GetKey
(
FKeyHandle KeyHandle |
Curves/IntegralCurve.h | ||
TArray< FIntegralKey >::TConstIterator GetKeyIterator() |
Const iterator for the keys, so the indices and handles stay valid | Curves/IntegralCurve.h | |
int32 GetKeyValue
(
FKeyHandle KeyHandle |
Get the value for the Key with the specified index. | Curves/IntegralCurve.h | |
bool GetUseDefaultValueBeforeFirstKey() |
Gets whether or not the default value should be used for evaluation for time values before the first key. | Curves/IntegralCurve.h | |
bool HasAnyData() |
Check whether this curve has any data or not | Curves/IntegralCurve.h | |
void RemoveRedundantKeys() |
Tries to reduce the number of keys required for accurate evaluation (zero error threshold) | Curves/IntegralCurve.h | |
void SetDefaultValue
(
int32 InDefaultValue |
Set the default value for the curve | Curves/IntegralCurve.h | |
void SetKeyValue
(
FKeyHandle KeyHandle, |
Set the value of the key with the specified index. | Curves/IntegralCurve.h | |
void SetUseDefaultValueBeforeFirstKey
(
bool InbUseDefaultValueBeforeFirstKey |
Sets whether or not the default value should be used for evaluation for time values before the first key. | Curves/IntegralCurve.h | |
FKeyHandle UpdateOrAddKey
(
float InTime, |
Finds the key at InTime, and updates its value. | Curves/IntegralCurve.h |
Overridden from FIndexedCurve
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FIndexedCurve * Duplicate() |
Allocates a duplicate of the curve | Curves/IntegralCurve.h | |
virtual float GetKeyTime
(
FKeyHandle KeyHandle |
Get the time for the Key with the specified index. | Curves/IntegralCurve.h | |
virtual int32 GetNumKeys() |
Get number of keys in curve. | Curves/IntegralCurve.h | |
virtual void SetKeyTime
(
FKeyHandle KeyHandle, |
Move a key to a new time. | Curves/IntegralCurve.h |