FCurveTableRowHandle Struct Reference

#include <CurveTable.h>

Public Member Functions
	FCurveTableRowHandle ()
bool	IsValid (const FString &ContextString) const
bool	IsNull () const
ENGINE_API FRealCurve *	GetCurve (const FString &ContextString, bool bWarnIfNotFound=true) const
ENGINE_API FRichCurve *	GetRichCurve (const FString &ContextString, bool bWarnIfNotFound=true) const
ENGINE_API FSimpleCurve *	GetSimpleCurve (const FString &ContextString, bool bWarnIfNotFound=true) const
float	Eval (float XValue, const FString &ContextString) const
ENGINE_API bool	Eval (float XValue, float *YValue, const FString &ContextString) const
ENGINE_API bool	operator== (const FCurveTableRowHandle &Other) const
ENGINE_API bool	operator!= (const FCurveTableRowHandle &Other) const
ENGINE_API void	PostSerialize (const FArchive &Ar)

Public Attributes
TObjectPtr< const class UCurveTable >	CurveTable
FName	RowName

Friends
uint32	GetTypeHash (const FCurveTableRowHandle &Handle)

Detailed Description

Handle to a particular row in a table.

Constructor & Destructor Documentation

FCurveTableRowHandle()

FCurveTableRowHandle::FCurveTableRowHandle ( )

inline

Member Function Documentation

Eval() [1/2]

float FCurveTableRowHandle::Eval ( float  XValue, const FString &  ContextString  ) const

inline

Evaluate the curve if it is valid

Parameters

XValue	The input X value to the curve
ContextString	A string to provide context for where this operation is being carried out

Returns

The value of the curve if valid, 0 if not

Eval() [2/2]

bool FCurveTableRowHandle::Eval	(	float	XValue,
		float *	YValue,
		const FString &	ContextString
	)		const

Evaluate the curve if it is valid

Parameters

XValue	The input X value to the curve
YValue	The output Y value from the curve
ContextString	A string to provide context for where this operation is being carried out

Returns

True if it filled out YValue with a valid number, false otherwise

GetCurve()

FRealCurve * FCurveTableRowHandle::GetCurve	(	const FString &	ContextString,
		bool	bWarnIfNotFound = true
	)		const

Get the curve straight from the row handle

GetRichCurve()

FRichCurve * FCurveTableRowHandle::GetRichCurve	(	const FString &	ContextString,
		bool	bWarnIfNotFound = true
	)		const

Get the rich curve straight from the row handle

GetSimpleCurve()

FSimpleCurve * FCurveTableRowHandle::GetSimpleCurve	(	const FString &	ContextString,
		bool	bWarnIfNotFound = true
	)		const

Get the simple curve straight from the row handle

IsNull()

bool FCurveTableRowHandle::IsNull ( ) const

inline

Returns true if this handle is specifically pointing to nothing

IsValid()

bool FCurveTableRowHandle::IsValid ( const FString &  ContextString ) const

inline

Returns true if the curve is valid

operator!=()

bool FCurveTableRowHandle::operator!=

(

const FCurveTableRowHandle &

Other

)

const

operator==()

bool FCurveTableRowHandle::operator==

(

const FCurveTableRowHandle &

Other

)

const

PostSerialize()

void FCurveTableRowHandle::PostSerialize

(

const FArchive &

Ar

)

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FCurveTableRowHandle &  Handle )

friend

Used so we can have a TMap of this struct

Member Data Documentation

CurveTable

TObjectPtr<const class UCurveTable> FCurveTableRowHandle::CurveTable

Pointer to table we want a row from

RowName

FName FCurveTableRowHandle::RowName

Name of row in the table that we want

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Engine/Classes/Engine/CurveTable.h
• Engine/Source/Runtime/Engine/Private/CurveTable.cpp