FIntegralCurve

An integral curve, which holds the key time and the key value

Windows
MacOS
Linux

Inheritance Hierarchy

FIndexedCurve

FIntegralCurve

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Curves/IntegralCurve.h

Include

#include "Curves/IntegralCurve.h"

Syntax

struct FIntegralCurve : public FIndexedCurve

Remarks

An integral curve, which holds the key time and the key value

Constructors

Name Description

Public function

FIntegralCurve()

Default constructor.

Destructors

Name Description

Public function Virtual

~FIntegralCurve()

Virtual destructor.

Functions

Name Description

Public function

FKeyHandle

 

AddKey

(
    float InTime,
    int32 InValue,
    FKeyHandle KeyHandle
)

Add a new key to the curve with the supplied Time and Value.

Public function

void

 

ClearDefaultValue()

Removes the default value for this curve.

Public function

void

 

DeleteKey

(
    FKeyHandle KeyHandle
)

Remove the specified key from the curve.

Public function Const

int32

 

Evaluate

(
    float Time,
    int32 InDefaultValue
)

Evaluates the value of an array of keys at a time

Public function Const

FKeyHandle

 

FindKey

(
    float KeyTime,
    float KeyTimeTolerance
)

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

int32

 

GetDefaultValue()

Get the default value for the curve

Public function

FIntegralKey...

 

GetKey

(
    FKeyHandle KeyHandle
)

Functions for getting keys based on handles

Public function Const

FIntegralKey

 

GetKey

(
    FKeyHandle KeyHandle
)

Functions for getting keys based on handles

Public function Const

TArray< FInt...

 

GetKeyIterator()

Const iterator for the keys, so the indices and handles stay valid

Public function Const

int32

 

GetKeyValue

(
    FKeyHandle KeyHandle
)

Get the value for the Key with the specified index.

Public function Const

bool

 

GetUseDefaultValueBeforeFirstKey()

Gets whether or not the default value should be used for evaluation for time values before the first key.

Public function Const

bool

 

HasAnyData()

Check whether this curve has any data or not

Public function

void

 

RemoveRedundantKeys()

Tries to reduce the number of keys required for accurate evaluation (zero error threshold)

Public function

void

 

SetDefaultValue

(
    int32 InDefaultValue
)

Set the default value for the curve

Public function

void

 

SetKeyValue

(
    FKeyHandle KeyHandle,
    int32 NewValue
)

Set the value of the key with the specified index.

Public function

void

 

SetUseDefaultValueBeforeFirstKey

(
    bool InbUseDefaultValueBeforeFirstK...
)

Sets whether or not the default value should be used for evaluation for time values before the first key.

Public function

FKeyHandle

 

UpdateOrAddKey

(
    float InTime,
    int32 Value,
    float KeyTimeTolerance
)

Finds the key at InTime, and updates its value.

Overridden from FIndexedCurve

Name Description

Public function Virtual Const

FIndexedCurv...

 

Duplicate()

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

 

GetNumKeys()

Get number of keys in curve.

Public function Virtual

void

 

SetKeyTime

(
    FKeyHandle KeyHandle,
    float NewTime
)

Move a key to a new time.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss