1. Epic GamesDeveloper
  3. FInterpCurve

FInterpCurve

Template for interpolation curves.

Unreal Engine C++ API Reference > Runtime > Core > Math

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Math/InterpCurve.h
Include #include "Math/InterpCurve.h"

Syntax

template<class T>  
class FInterpCurve

Remarks

Template for interpolation curves.

Variables

  Type Name Description
Public variable bool bIsLooped Specify whether the curve is looped or not
Public variable float LoopKeyOffset Specify the offset from the last point's input key corresponding to the loop point
Public variable TArray< FInterpCurvePoint< T > > Points Holds the collection of interpolation points.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function int32

AddPoint ( const float InVal,
const T& OutVal
)

 Adds a new keypoint to the InterpCurve with the supplied In and Out value.
Public function void

AutoSetTangents ( float Tension,
bool bStationaryEndpoints
)

 Automatically set the tangents on the curve based on surrounding points
Public function Const void

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

 Calculate the min/max out value that can be returned by this InterpCurve.
Public function void Clear loop key for curve
Public function Const T

Eval ( const float InVal,
const T& Default
)

 Evaluate the output for an arbitary input value.
Public function Const T

EvalDerivative ( const float InVal,
const T& Default
)

 Evaluate the derivative at a point on the curve.
Public function Const T

EvalSecondDerivative ( const float InVal,
const T& Default
)

 Evaluate the second derivative at a point on the curve.
Public function Const float

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

 Find the nearest point on spline to the given point.
Public function Const float

FindNearest ( const T& PointInSpace,
float& OutDistanceSq
)

 Find the nearest point on spline to the given point.
Public function Const float

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

 Find the nearest point (to the given point) on segment between Points[PtIdx] and Points[PtIdx+1]
Public function Const int32

GetPointIndexForInputValue ( const float InValue
)

 Finds the lower index of the two points whose input values bound the supplied input value.
Public function int32

MovePoint ( int32 PointIndex,
float NewInVal
)

 Moves a keypoint to a new In value.
Public function void

Reset ()

 Clears all keypoints from InterpCurve.
Public function void

SetLoopKey ( float InLoopKey
)

 Set loop key for curve

Deprecated Functions

  Type Name Description
Public function Const float

InaccurateFindNearest ( const T& PointInSpace,
float& OutDistanceSq
)

 Use FindNearest instead.
Public function Const float

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

 Use FindNearest instead.
Public function Const float

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

 Use FindNearestOnSegment instead.

See Also

FInterpCurvePoint

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page