1. Epic GamesDeveloper
  3. FRealCurve

FRealCurve

A rich, editable float curve

API > API/Runtime > API/Runtime/Engine

A rich, editable float curve

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

Syntax

USTRUCT ()  
struct FRealCurve : public FIndexedCurve

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FRealCurve()

   Curves/RealCurve.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DefaultValue float Default value Curves/RealCurve.h
  • EditAnywhere
  • Category="Curve"
PostInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Post-infinity extrapolation state Curves/RealCurve.h  
PreInfinityExtrap TEnumAsByte< ERichCurveExtrapolation > Pre-infinity extrapolation state Curves/RealCurve.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FKeyHandle AddKey ( float InTime,
float InValue,
const bool bUnwindRotation,
FKeyHandle KeyHandle
)

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

virtual void BakeCurve ( float SampleRate,
float FirstKeyTime,
float LastKeyTime
)

   Curves/RealCurve.h  

virtual void BakeCurve ( float SampleRate
)

 Bake curve given the sample rate Curves/RealCurve.h  

void ClearDefaultValue()

 Removes the default value for this curve. Curves/RealCurve.h  

virtual void DeleteKey ( FKeyHandle KeyHandle
)

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

virtual float Eval ( float InTime,
float InDefaultValue
) const

 Evaluate this curve at the specified time Curves/RealCurve.h  

FKeyHandle FindKey ( float KeyTime,
float KeyTimeTolerance
) const

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

float GetDefaultValue()

 Get the default value for the curve Curves/RealCurve.h  

virtual ERichCurveInterpMode GetKeyInterpMode ( FKeyHandle KeyHandle
) const

   Curves/RealCurve.h  

virtual TPair< float, float > GetKeyTimeValuePair ( FKeyHandle KeyHandle
) const

 Returns a pair for the specified key Curves/RealCurve.h  

virtual float GetKeyValue ( FKeyHandle KeyHandle
) const

 Returns the value of the specified key Curves/RealCurve.h  

virtual void GetTimeRange ( float& MinTime,
float& MaxTime
) const

 Get range of input time values. Curves/RealCurve.h  

virtual void GetValueRange ( float& MinValue,
float& MaxValue
) const

 Get range of output values. Curves/RealCurve.h  

bool HasAnyData()

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

bool KeyExistsAtTime ( float KeyTime,
float KeyTimeTolerance
) const

 True if a key exists already, false otherwise Curves/RealCurve.h  

virtual void ReadjustTimeRange ( float NewMinTimeRange,
float NewMaxTimeRange,
bool bInsert,
float OldStartTime,
float OldEndTime
)

 Resize curve length to the [MinTimeRange, MaxTimeRange] Curves/RealCurve.h  

virtual void RemapTimeValue ( float& InTime,
float& CycleValueOffset
) const

 Remap InTime based on pre and post infinity extrapolation values Curves/RealCurve.h  

virtual void RemoveRedundantKeys ( float Tolerance,
FFrameRate SampleRate
)

 Remove redundant keys, comparing against Tolerance (and optional use of sample-rate for additional testing) Curves/RealCurve.h  

virtual void RemoveRedundantKeys ( float Tolerance,
float FirstKeyTime,
float LastKeyTime,
FFrameRate SampleRate
)

   Curves/RealCurve.h  

virtual void Reset()

 Clear all keys. Curves/RealCurve.h  

void SetDefaultValue ( float InDefaultValue
)

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

virtual void SetKeyInterpMode ( FKeyHandle KeyHandle,
ERichCurveInterpMode NewInterpMode
)

   Curves/RealCurve.h  

virtual void SetKeyValue ( FKeyHandle KeyHandle,
float NewValue,
bool bAutoSetTangents
)

 Set the value of the specified key Curves/RealCurve.h  

virtual FKeyHandle UpdateOrAddKey ( float InTime,
float InValue,
const bool bUnwindRotation,
float KeyTimeTolerance
)

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

Protected

Name Remarks Include Path Unreal Specifiers

virtual int32 GetKeyIndex ( float KeyTime,
float KeyTimeTolerance
) const

   Curves/RealCurve.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CycleTime ( float MinTime,
float MaxTime,
float& InTime,
int& CycleCount
)

   Curves/RealCurve.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page