FStringCurve

Implements a curve of FStrings.

Windows
MacOS
Linux

Inheritance Hierarchy

FIndexedCurve

FStringCurve

References

Module

Engine

Header

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

Include

#include "Curves/StringCurve.h"

Syntax

struct FStringCurve : public FIndexedCurve

Remarks

Implements a curve of FStrings.

Variables

Name Description

Public variable

FString

 

DefaultValue

Default value

Public variable

TArray< FString...

 

Keys

Sorted array of keys

Destructors

Name Description

Public function Virtual

~FStringCurve()

Virtual destructor.

Functions

Name Description

Public function

FKeyHandle

 

AddKey

(
    float InTime,
    const FString& InValue,
    FKeyHandle KeyHandle
)

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

Public function

void

 

ClearDefaultValue()

Clears the default value for this curve if it has been set.

Public function

void

 

DeleteKey

(
    FKeyHandle KeyHandle
)

Remove the specified key from the curve.

Public function Const

FString

 

Eval

(
    float Time,
    const FString& InDefaultValue
)

Evaluate the curve at the specified time.

Public function Const

FKeyHandle

 

FindKey

(
    float KeyTime,
    float KeyTimeTolerance
)

Finds a key a the specified time.

Public function Const

FString

 

GetDefaultValue()

Get the default value for the curve

Public function

FStringCurve...

 

GetKey

(
    FKeyHandle KeyHandle
)

Get a key.

Public function Const

FStringCurve...

 

GetKey

(
    FKeyHandle KeyHandle
)

Get a key.

Public function Const

const TArray...

 

GetKeys()

Read-only access to the key collection.

Public function Const

FString

 

GetKeyValue

(
    FKeyHandle KeyHandle
)

Get the value for the Key with the specified index.

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 (removing duplicates)

Public function

void

 

SetDefaultValue

(
    const FString& InDefaultValue
)

Set the default value of the curve.

Public function

void

 

SetKeyValue

(
    FKeyHandle KeyHandle,
    FString NewValue
)

Assign a new value to a key.

Public function

FKeyHandle

 

UpdateOrAddKey

(
    float InTime,
    const FString& InValue,
    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