FInterpCurvePoint< T > Class Template Reference

#include <InterpCurvePoint.h>

Collaboration diagram for FInterpCurvePoint< T >:

Public Member Functions
	FInterpCurvePoint ()
	FInterpCurvePoint (const float In, const T &Out)
	FInterpCurvePoint (const float In, const T &Out, const T &InArriveTangent, const T &InLeaveTangent, const EInterpCurveMode InInterpMode)
FORCEINLINE	FInterpCurvePoint (EForceInit)
FORCEINLINE 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

Todo

Docs: FInterpCurvePoint needs better function documentation.

Definition at line 50 of file InterpCurvePoint.h.

Constructor & Destructor Documentation

FInterpCurvePoint() [1/4]

template<class T >

FInterpCurvePoint< T >::FInterpCurvePoint ( )

inline

Default constructor (no initialization).

Definition at line 74 of file InterpCurvePoint.h.

FInterpCurvePoint() [2/4]

template<class T >

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

Constructor

Parameters

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

Note

uses linear interpolation

Definition at line 152 of file InterpCurvePoint.h.

FInterpCurvePoint() [3/4]

template<class T >

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

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

Definition at line 164 of file InterpCurvePoint.h.

FInterpCurvePoint() [4/4]

template<class T >

FORCEINLINE FInterpCurvePoint< T >::FInterpCurvePoint ( EForceInit )

explicit

Constructor which initializes all components to zero.

Parameters

EForceInit

Force init enum

Definition at line 173 of file InterpCurvePoint.h.

Member Function Documentation

IsCurveKey()

template<class T >

FORCEINLINE bool FInterpCurvePoint< T >::IsCurveKey

(

)

const

Returns

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

Definition at line 183 of file InterpCurvePoint.h.

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

Definition at line 141 of file InterpCurvePoint.h.

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.

Definition at line 118 of file InterpCurvePoint.h.

operator==

template<class T >

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

friend

Compare equality of two Curve Points

Definition at line 129 of file InterpCurvePoint.h.

Member Data Documentation

ArriveTangent

template<class T >

T FInterpCurvePoint< T >::ArriveTangent

Tangent of curve arrive this point.

Definition at line 61 of file InterpCurvePoint.h.

InterpMode

template<class T >

TEnumAsByte<EInterpCurveMode> FInterpCurvePoint< T >::InterpMode

Interpolation mode between this point and the next one.

See also

EInterpCurveMode

Definition at line 67 of file InterpCurvePoint.h.

InVal

template<class T >

float FInterpCurvePoint< T >::InVal

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

Definition at line 55 of file InterpCurvePoint.h.

LeaveTangent

template<class T >

T FInterpCurvePoint< T >::LeaveTangent

Tangent of curve leaving this point.

Definition at line 64 of file InterpCurvePoint.h.

OutVal

template<class T >

T FInterpCurvePoint< T >::OutVal

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

Definition at line 58 of file InterpCurvePoint.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Math/InterpCurvePoint.h