1. Epic GamesDeveloper
  3. FSimpleCurve

FSimpleCurve

A rich, editable float curve

API > API/Runtime > API/Runtime/Engine

A rich, editable float curve

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

Syntax

USTRUCT ()  
struct FSimpleCurve : public FRealCurve

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FSimpleCurve()

   Curves/SimpleCurve.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
InterpMode TEnumAsByte< ERichCurveInterpMode > Interpolation mode between this key and the next Curves/SimpleCurve.h  
Keys TArray< FSimpleCurveKey > Sorted array of keys Curves/SimpleCurve.h
  • EditAnywhere
  • EditFixedSize
  • Category="Curve"
  • Meta=(EditFixedOrder)

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< FSimpleCurveKey > & GetConstRefOfKeys()

 Gets a const reference of the keys, so indices and handles can't be meddled with Curves/SimpleCurve.h  

TArray< FSimpleCurveKey > GetCopyOfKeys()

 Gets a copy of the keys, so indices and handles can't be meddled with Curves/SimpleCurve.h  

FSimpleCurveKey GetFirstKey()

 Quick accessors for the first and last keys Curves/SimpleCurve.h  

FSimpleCurveKey * GetFirstMatchingKey ( const TArray< FKeyHandle >& KeyHandles
)

 Get the first key that matches any of the given key handles. Curves/SimpleCurve.h  
Functions for getting keys based on handles Curves/SimpleCurve.h  

FSimpleCurveKey GetKey ( FKeyHandle KeyHandle
) const

   Curves/SimpleCurve.h  
Get the interp mode used for keys in this curve Curves/SimpleCurve.h  

TArray< FSimpleCurveKey >::TConstIterator GetKeyIterator()

 Const iterator for the keys, so the indices and handles stay valid Curves/SimpleCurve.h  

FSimpleCurveKey GetLastKey()

   Curves/SimpleCurve.h  

void SetKeyInterpMode ( ERichCurveInterpMode NewInterpMode
)

   Curves/SimpleCurve.h  

void SetKeys ( const TArray< FSimpleCurveKey >& InKeys
)

 Sets the keys with the keys.Expects that the keys are already sorted. Curves/SimpleCurve.h  

Overridden from FRealCurve

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/SimpleCurve.h  

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

   Curves/SimpleCurve.h  

virtual void BakeCurve ( float SampleRate
)

 Bake curve given the sample rate Curves/SimpleCurve.h  

virtual void DeleteKey ( FKeyHandle KeyHandle
)

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

virtual float Eval ( float InTime,
float InDefaultValue
) const

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

virtual ERichCurveInterpMode GetKeyInterpMode ( FKeyHandle KeyHandle
) const

 Get the interp mode of the specified key Curves/SimpleCurve.h  

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

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

virtual float GetKeyValue ( FKeyHandle KeyHandle
) const

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

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

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

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

 Get range of output values. Curves/SimpleCurve.h  

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

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

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

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

virtual void RemoveRedundantKeys ( float Tolerance,
FFrameRate SampleRate
)

 Remove redundant keys, comparing against Tolerance Curves/SimpleCurve.h  

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

   Curves/SimpleCurve.h  

virtual void Reset()

 Clear all keys. Curves/SimpleCurve.h  

virtual void SetKeyInterpMode ( FKeyHandle,
ERichCurveInterpMode NewInterpMode
)

 Set the interp mode used for keys in this curve Curves/SimpleCurve.h  

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

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

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

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

Overridden from FIndexedCurve

Name Remarks Include Path Unreal Specifiers

virtual FIndexedCurve * Duplicate()

 Allocates a duplicate of the curve Curves/SimpleCurve.h  

virtual float GetKeyTime ( FKeyHandle KeyHandle
) const

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

virtual int32 GetNumKeys()

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

virtual void SetKeyTime ( FKeyHandle KeyHandle,
float NewTime
)

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

Protected

Overridden from FRealCurve

Name Remarks Include Path Unreal Specifiers

virtual int32 GetKeyIndex ( float KeyTime,
float KeyTimeTolerance
) const

   Curves/SimpleCurve.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FSimpleCurve& Curve
) const

 Determine if two SimpleCurves are the same Curves/SimpleCurve.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page