FIndexedCurve Struct Reference

#include <IndexedCurve.h>

Inheritance diagram for FIndexedCurve:

Public Member Functions
	FIndexedCurve ()
virtual	~FIndexedCurve ()
ENGINE_API int32	GetIndexSafe (FKeyHandle KeyHandle) const
TArray< FKeyHandle >::TConstIterator	GetKeyHandleIterator () const
ENGINE_API bool	IsKeyHandleValid (FKeyHandle KeyHandle) const
FKeyHandle	GetFirstKeyHandle () const
FKeyHandle	GetLastKeyHandle () const
ENGINE_API FKeyHandle	GetNextKey (FKeyHandle KeyHandle) const
ENGINE_API FKeyHandle	GetPreviousKey (FKeyHandle KeyHandle) const
ENGINE_API void	ShiftCurve (float DeltaTime)
ENGINE_API void	ShiftCurve (float DeltaTime, const TSet< FKeyHandle > &KeyHandles)
ENGINE_API void	ScaleCurve (float ScaleOrigin, float ScaleFactor)
ENGINE_API void	ScaleCurve (float ScaleOrigin, float ScaleFactor, const TSet< FKeyHandle > &KeyHandles)

Public Attributes
virtual int32	GetNumKeys () const PURE_VIRTUAL(FIndexedCurve
virtual void virtual SetKeyTime(FKeyHandle KeyHandle, float NewTime) PURE_VIRTUAL(FIndexedCurve float	GetKeyTime (FKeyHandle KeyHandle) const PURE_VIRTUAL(FIndexedCurve
virtual FIndexedCurve *	Duplicate () const PURE_VIRTUAL(FIndexedCurve

Protected Member Functions
void	EnsureAllIndicesHaveHandles () const
void	EnsureIndexHasAHandle (int32 KeyIndex) const
const int32 *	FindIndex (FKeyHandle KeyHandle) const
ENGINE_API int32	GetIndex (FKeyHandle KeyHandle) const
ENGINE_API FKeyHandle	GetKeyHandle (int32 KeyIndex) const

Protected Attributes
FKeyHandleMap	KeyHandlesToIndices

Detailed Description

A curve base class which enables key handles to index lookups.

Constructor & Destructor Documentation

FIndexedCurve()

FIndexedCurve::FIndexedCurve ( )

inline

Default constructor.

~FIndexedCurve()

virtual FIndexedCurve::~FIndexedCurve ( )

inlinevirtual

Member Function Documentation

EnsureAllIndicesHaveHandles()

void FIndexedCurve::EnsureAllIndicesHaveHandles ( ) const

inlineprotected

Makes sure our handles are all valid and correct.

EnsureIndexHasAHandle()

void FIndexedCurve::EnsureIndexHasAHandle ( int32  KeyIndex ) const

inlineprotected

FindIndex()

const int32 * FIndexedCurve::FindIndex ( FKeyHandle  KeyHandle ) const

inlineprotected

Gets the index of a handle .

GetFirstKeyHandle()

FKeyHandle FIndexedCurve::GetFirstKeyHandle ( ) const

inline

Gets the key handle for the first key in the curve

GetIndex()

int32 FIndexedCurve::GetIndex ( FKeyHandle  KeyHandle ) const

protected

Gets the index of a handle.

GetIndexSafe()

int32 FIndexedCurve::GetIndexSafe

(

FKeyHandle

KeyHandle

)

const

Gets the index of a handle, checks if the key handle is valid first.

GetKeyHandle()

FKeyHandle FIndexedCurve::GetKeyHandle ( int32  KeyIndex ) const

protected

Internal tool to get a handle from an index.

GetKeyHandleIterator()

TArray< FKeyHandle >::TConstIterator FIndexedCurve::GetKeyHandleIterator ( ) const

inline

Const iterator for the handles.

GetLastKeyHandle()

FKeyHandle FIndexedCurve::GetLastKeyHandle ( ) const

inline

Gets the key handle for the last key in the curve

GetNextKey()

FKeyHandle FIndexedCurve::GetNextKey

(

FKeyHandle

KeyHandle

)

const

Get the next key given the key handle

GetPreviousKey()

FKeyHandle FIndexedCurve::GetPreviousKey

(

FKeyHandle

KeyHandle

)

const

Get the previous key given the key handle

IsKeyHandleValid()

bool FIndexedCurve::IsKeyHandleValid

(

FKeyHandle

KeyHandle

)

const

Checks to see if the key handle is valid for this curve.

ScaleCurve() [1/2]

void FIndexedCurve::ScaleCurve	(	float	ScaleOrigin,
		float	ScaleFactor
	)

Scales all keys about an origin, preserving order

ScaleCurve() [2/2]

void FIndexedCurve::ScaleCurve	(	float	ScaleOrigin,
		float	ScaleFactor,
		const TSet< FKeyHandle > &	KeyHandles
	)

ShiftCurve() [1/2]

void FIndexedCurve::ShiftCurve

(

float

DeltaTime

)

Shifts all keys forwards or backwards in time by an even amount, preserving order

ShiftCurve() [2/2]

void FIndexedCurve::ShiftCurve	(	float	DeltaTime,
		const TSet< FKeyHandle > &	KeyHandles
	)

Member Data Documentation

Duplicate

virtual FIndexedCurve* FIndexedCurve::Duplicate() const PURE_VIRTUAL(FIndexedCurve

Allocates a duplicate of the curve

GetKeyTime

virtual void virtual SetKeyTime (FKeyHandle KeyHandle, float NewTime) PURE_VIRTUAL(FIndexedCurve float FIndexedCurve::GetKeyTime(FKeyHandle KeyHandle) const PURE_VIRTUAL(FIndexedCurve

Move a key to a new time. This may change the index of the key, so the new key index is returned. Get the time for the Key with the specified index.

GetNumKeys

virtual int32 FIndexedCurve::GetNumKeys() const PURE_VIRTUAL(FIndexedCurve

Get number of keys in curve.

KeyHandlesToIndices

FKeyHandleMap FIndexedCurve::KeyHandlesToIndices

mutableprotected

Map of which key handles go to which indices.

---

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

• Engine/Source/Runtime/Engine/Classes/Curves/IndexedCurve.h
• Engine/Source/Runtime/Engine/Private/Curves/IndexedCurve.cpp