FKeyHandleLookupTable Struct Reference

#include <KeyHandle.h>

Inheritance diagram for FKeyHandleLookupTable:

Public Member Functions
ENGINE_API int32	GetIndex (FKeyHandle KeyHandle)
ENGINE_API FKeyHandle	FindOrAddKeyHandle (int32 Index)
ENGINE_API void	MoveHandle (int32 OldIndex, int32 NewIndex)
ENGINE_API FKeyHandle	AllocateHandle (int32 Index)
ENGINE_API void	DeallocateHandle (int32 Index)
ENGINE_API void	ReplaceHandle (int32 Index, FKeyHandle HandleToReplace)
ENGINE_API void	Reset ()
ENGINE_API bool	Serialize (FArchive &Ar)

Friends
FArchive &	operator<< (FArchive &Ar, FKeyHandleLookupTable &P)

Detailed Description

Lookup table that maps key handles to indices in an external data structure Maintains a map of key handle to last known index, and an array of optional key handles that's used to validate map entries.

Member Function Documentation

AllocateHandle()

FKeyHandle FKeyHandleLookupTable::AllocateHandle

(

int32

Index

)

Allocate a new handle for the specified index

Parameters

Index

The index to associate a handle with

Returns

A new key handle that corresponds to the specified index

DeallocateHandle()

void FKeyHandleLookupTable::DeallocateHandle

(

int32

Index

)

Deallocate the specified index

Parameters

Index

The index to invalidate a handle for

FindOrAddKeyHandle()

FKeyHandle FKeyHandleLookupTable::FindOrAddKeyHandle

(

int32

Index

)

Attempt to find the handle for the specified index, or allocate a new one if it doesn't have one

Parameters

Index

The index to find or allocate a handle for

Returns

A valid key handle for the specified index

GetIndex()

int32 FKeyHandleLookupTable::GetIndex

(

FKeyHandle

KeyHandle

)

Get the index that corresponds to the specified key handle

Parameters

KeyHandle

The key handle to retrieve an up to date index for

Returns

The index that corresponds to this key handle, or INDEX_NONE if the key handle is invalid

MoveHandle()

void FKeyHandleLookupTable::MoveHandle	(	int32	OldIndex,
		int32	NewIndex
	)

Move the specified handle from its previous index, to its new index

Parameters

OldIndex	The previous index of the handle
NewIndex	The new index of the handle

ReplaceHandle()

void FKeyHandleLookupTable::ReplaceHandle	(	int32	Index,
		FKeyHandle	HandleToReplace
	)

Replaces the key handle at Index with HandleToReplace.

Parameters

Index	The index at which to replace the handle
HandleToReplace	The key handle to set at the index. Fails if this handle already is in the table.

Reset()

void FKeyHandleLookupTable::Reset

(

)

Reset this lookup table, forgetting all key handles and indices

Serialize()

bool FKeyHandleLookupTable::Serialize

(

FArchive &

Ar

)

ICPPStructOps implementation

Friends And Related Symbol Documentation

operator<<

FArchive & operator<< ( FArchive &  Ar, FKeyHandleLookupTable &  P  )

friend

---

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

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