1. Epic GamesDeveloper
  3. FStringCurve

FStringCurve

Implements a curve of FStrings.

API > API/Runtime > API/Runtime/Engine

Implements a curve of FStrings.

   
Name FStringCurve
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Curves/StringCurve.h
Include Path #include "Curves/StringCurve.h"

Syntax

USTRUCT ()  
struct FStringCurve : public FIndexedCurve

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FStringCurve()

 Virtual destructor. Curves/StringCurve.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DefaultValue FString Default value Curves/StringCurve.h
  • EditAnywhere
  • Category="Curve"
Keys TArray< FStringCurveKey > Sorted array of keys Curves/StringCurve.h
  • EditAnywhere
  • EditFixedSize
  • Category="Curve"

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. Curves/StringCurve.h  

void ClearDefaultValue()

 Clears the default value for this curve if it has been set. Curves/StringCurve.h  

void DeleteKey ( FKeyHandle KeyHandle
)

 Remove the specified key from the curve. Curves/StringCurve.h  

FString Eval ( float Time,
const FString& InDefaultValue
) const

 Evaluate the curve at the specified time. Curves/StringCurve.h  

FKeyHandle FindKey ( float KeyTime,
float KeyTimeTolerance
) const

 Finds a key a the specified time. Curves/StringCurve.h  

FString GetDefaultValue()

 Get the default value for the curve Curves/StringCurve.h  
Get a key. Curves/StringCurve.h  

FStringCurveKey GetKey ( FKeyHandle KeyHandle
) const

   Curves/StringCurve.h  

const TArray< FStringCurveKey > & GetKeys()

 Read-only access to the key collection. Curves/StringCurve.h  

FString GetKeyValue ( FKeyHandle KeyHandle
) const

 Get the value for the Key with the specified index. Curves/StringCurve.h  

bool HasAnyData()

 Check whether this curve has any data or not Curves/StringCurve.h  

void RemoveRedundantKeys()

 Tries to reduce the number of keys required for accurate evaluation (removing duplicates) Curves/StringCurve.h  

void SetDefaultValue ( const FString& InDefaultValue
)

 Set the default value of the curve. Curves/StringCurve.h  

void SetKeyValue ( FKeyHandle KeyHandle,
FString NewValue
)

 Assign a new value to a key. Curves/StringCurve.h  

FKeyHandle UpdateOrAddKey ( float InTime,
const FString& InValue,
float KeyTimeTolerance
)

 Finds the key at InTime, and updates its value. Curves/StringCurve.h  

Overridden from FIndexedCurve

Name Remarks Include Path Unreal Specifiers

virtual FIndexedCurve * Duplicate()

 Allocates a duplicate of the curve Curves/StringCurve.h  

virtual float GetKeyTime ( FKeyHandle KeyHandle
) const

 Get the time for the Key with the specified index. Curves/StringCurve.h  

virtual int32 GetNumKeys()

 Get number of keys in curve. Curves/StringCurve.h  

virtual void SetKeyTime ( FKeyHandle KeyHandle,
float NewTime
)

 Move a key to a new time. Curves/StringCurve.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page