1. Epic GamesDeveloper
  3. FInterpCurve

FInterpCurve

Template for interpolation curves.

API > API/Runtime > API/Runtime/Core

Template for interpolation curves.

   
Name FInterpCurve
Type class
Header File /Engine/Source/Runtime/Core/Public/Math/InterpCurve.h
Include Path #include "Math/InterpCurve.h"

Syntax

template<class T>  
class FInterpCurve

Derived Classes

FInterpCurve derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FInterpCurve()

 Default constructor. Math/InterpCurve.h  

Typedefs

Name Type Remarks Include Path
ElementType T   Math/InterpCurve.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsLooped bool Specify whether the curve is looped or not Math/InterpCurve.h  
LoopKeyOffset float Specify the offset from the last point's input key corresponding to the loop point Math/InterpCurve.h  
Points TArray< FInterpCurvePoint< T > > Holds the collection of interpolation points. Math/InterpCurve.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddPoint ( const float InVal,
const T& OutVal
)

 Adds a new keypoint to the InterpCurve with the supplied In and Out value. Math/InterpCurve.h  

void AutoSetTangents ( float Tension,
bool bStationaryEndpoints
)

 Automatically set the tangents on the curve based on surrounding points Math/InterpCurve.h  

void CalcBounds ( T& OutMin,
T& OutMax,
const T& Default
) const

 Calculate the min/max out value that can be returned by this InterpCurve. Math/InterpCurve.h  

void ClearLoopKey()

 Clear loop key for curve Math/InterpCurve.h  

T Eval ( const float InVal,
const T& Default
) const

 Evaluate the output for an arbitrary input value. Math/InterpCurve.h  

T EvalDerivative ( const float InVal,
const T& Default
) const

 Evaluate the derivative at a point on the curve. Math/InterpCurve.h  

T EvalSecondDerivative ( const float InVal,
const T& Default
) const

 Evaluate the second derivative at a point on the curve. Math/InterpCurve.h  

float FindNearest ( const T& PointInSpace,
float& OutDistanceSq,
float& OutSegment
) const

 Find the nearest point on spline to the given point. Math/InterpCurve.h  

float FindNearest ( const T& PointInSpace,
float& OutDistanceSq
) const

 Find the nearest point on spline to the given point. Math/InterpCurve.h  

float FindNearestOnSegment ( const T& PointInSpace,
int32 PtIdx,
float& OutSquaredDistance
) const

 Find the nearest point (to the given point) on segment between Points[PtIdx] and Points[PtIdx+1] Math/InterpCurve.h  

FFloatInterval GetKeyInterval()

 Returns the interval of key for the curve points Math/InterpCurve.h  

int32 GetPointIndexForInputValue ( const float InValue
) const

 Finds the lower index of the two points whose input values bound the supplied input value. Math/InterpCurve.h  

float InaccurateFindNearest ( const T& PointInSpace,
float& OutDistanceSq
) const

   Math/InterpCurve.h  

float InaccurateFindNearest ( const T& PointInSpace,
float& OutDistanceSq,
float& OutSegment
) const

   Math/InterpCurve.h  

float InaccurateFindNearestOnSegment ( const T& PointInSpace,
int32 PtIdx,
float& OutSquaredDistance
) const

   Math/InterpCurve.h  

int32 MovePoint ( int32 PointIndex,
float NewInVal
)

 Moves a keypoint to a new In value. Math/InterpCurve.h  

void Reset()

 Clears all keypoints from InterpCurve. Math/InterpCurve.h  

void SetLoopKey ( float InLoopKey
)

 Set loop key for curve Math/InterpCurve.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page