1. Epic GamesDeveloper
  3. FStringCurve

FStringCurve

Implements a curve of FStrings.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Curves

Inheritance Hierarchy

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

  Type Name Description
Public variable FString DefaultValue Default value
Public variable TArray< FStringCurveKey > Keys Sorted array of keys

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type 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 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 Get the default value for the curve
Public function FStringCurveKey &

GetKey ( FKeyHandle KeyHandle
)

 Get a key.
Public function Const FStringCurveKey

GetKey ( FKeyHandle KeyHandle
)

 Get a key.
Public function Const const TArray< FStringCurveKey > &

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 Check whether this curve has any data or not
Public function void 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

  Type Name Description
Public function Virtual Const FIndexedCurve * 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 Get number of keys in curve.
Public function Virtual void

SetKeyTime ( FKeyHandle KeyHandle,
float NewTime
)

 Move a key to a new time.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page