FInterpCurvePoint< T > Class Template Reference

#include <InterpCurvePoint.h>

Public Member Functions
	FInterpCurvePoint ()=default
	FInterpCurvePoint (const float In, const T &Out)
	FInterpCurvePoint (const float In, const T &Out, const T &InArriveTangent, const T &InLeaveTangent, const EInterpCurveMode InInterpMode)
UE_FORCEINLINE_HINT	FInterpCurvePoint (EForceInit)
UE_FORCEINLINE_HINT bool	IsCurveKey () const

Public Attributes
float	InVal
T	OutVal
T	ArriveTangent
T	LeaveTangent
TEnumAsByte< EInterpCurveMode >	InterpMode

Friends
FArchive &	operator<< (FArchive &Ar, FInterpCurvePoint &Point)
bool	operator== (const FInterpCurvePoint &Point1, const FInterpCurvePoint &Point2)
bool	operator!= (const FInterpCurvePoint &Point1, const FInterpCurvePoint &Point2)

Detailed Description

template<class T>
class FInterpCurvePoint< T >

Template for interpolation points.

Interpolation points are used for describing the shape of interpolation curves.

See also

FInterpCurve

Constructor & Destructor Documentation

FInterpCurvePoint() [1/4]

template<class T >

FInterpCurvePoint< T >::FInterpCurvePoint ( )

default

Default constructor (no initialization).

FInterpCurvePoint() [2/4]

template<class T >

FInterpCurvePoint< T >::FInterpCurvePoint ( const float  In, const T &  Out  )

inline

Constructor

Parameters

In	input value that corresponds to this key
Out	Output value of templated type

Note

uses linear interpolation

FInterpCurvePoint() [3/4]

template<class T >

FInterpCurvePoint< T >::FInterpCurvePoint ( const float  In, const T &  Out, const T &  InArriveTangent, const T &  InLeaveTangent, const EInterpCurveMode  InInterpMode  )

inline

Constructor

Parameters

In	input value that corresponds to this key
Out	Output value of templated type
InArriveTangent	Tangent of curve arriving at this point.
InLeaveTangent	Tangent of curve leaving from this point.
InInterpMode	interpolation mode to use

FInterpCurvePoint() [4/4]

template<class T >

FInterpCurvePoint< T >::FInterpCurvePoint ( EForceInit  )

inlineexplicit

Constructor which initializes all components to zero.

Parameters

EForceInit

Force init enum

Member Function Documentation

IsCurveKey()

template<class T >

UE_FORCEINLINE_HINT bool FInterpCurvePoint< T >::IsCurveKey

(

)

const

Returns

true if the key value is using a curve interp mode, otherwise false

Friends And Related Symbol Documentation

operator!=

template<class T >

bool operator!= ( const FInterpCurvePoint< T > &  Point1, const FInterpCurvePoint< T > &  Point2  )

friend

Compare inequality of two Curve Points

operator<<

template<class T >

FArchive & operator<< ( FArchive &  Ar, FInterpCurvePoint< T > &  Point  )

friend

Serializes the Curve Point.

Parameters

Ar	Reference to the serialization archive.
Point	Reference to the curve point being serialized.

Returns

Reference to the Archive after serialization.

operator==

template<class T >

bool operator== ( const FInterpCurvePoint< T > &  Point1, const FInterpCurvePoint< T > &  Point2  )

friend

Compare equality of two Curve Points

Member Data Documentation

ArriveTangent

template<class T >

T FInterpCurvePoint< T >::ArriveTangent

Tangent of curve arrive this point.

InterpMode

template<class T >

TEnumAsByte<EInterpCurveMode> FInterpCurvePoint< T >::InterpMode

Interpolation mode between this point and the next one.

See also

EInterpCurveMode

InVal

template<class T >

float FInterpCurvePoint< T >::InVal

Float input value that corresponds to this key (eg. time).

LeaveTangent

template<class T >

T FInterpCurvePoint< T >::LeaveTangent

Tangent of curve leaving this point.

OutVal

template<class T >

T FInterpCurvePoint< T >::OutVal

Output value of templated type when input is equal to InVal.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/Math/InterpCurvePoint.h