UE::Anim::TNamedValueArray< InAllocatorType, InElementType > Struct Template Reference

#include <NamedValueArray.h>

Inheritance diagram for UE::Anim::TNamedValueArray< InAllocatorType, InElementType >:

Classes
struct	FElementSortPredicate

Public Types
typedef InAllocatorType	AllocatorType
typedef InElementType	ElementType

Public Member Functions
template<typename... ArgTypes>
void	Add (ArgTypes &&... Args)
void	AppendNames (TConstArrayView< FName > InNameArray)
void	AppendNames (std::initializer_list< const FName > InInputArgs)
void	Empty ()
void	Reserve (int32 InNumElements)
bool	HasElement (FName InName) const
template<typename PredicateType >
void	ForEachElement (PredicateType InPredicate) const
int32	Num () const
int32	Max () const
void	Shrink ()

Protected Member Functions
void	SortElementsIfRequired () const
void	CheckSorted () const
void	CheckDuplicates () const
int32	IndexOf (FName InName) const
const ElementType *	Find (FName InName) const
ElementType *	Find (FName InName)

Protected Attributes
TArray< ElementType, AllocatorType >	Elements
bool	bSorted = false

Friends
struct	FNamedValueArrayUtils

Detailed Description

template<typename InAllocatorType, typename InElementType>
struct UE::Anim::TNamedValueArray< InAllocatorType, InElementType >

Container of lazily-sorted name/value pairs. Used to perform efficient merge operations. Assumes that InElementType has an accessible member: FName Name.

Member Typedef Documentation

AllocatorType

template<typename InAllocatorType , typename InElementType >

typedef InAllocatorType UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::AllocatorType

ElementType

template<typename InAllocatorType , typename InElementType >

typedef InElementType UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::ElementType

Member Function Documentation

Add()

template<typename InAllocatorType , typename InElementType >

template<typename... ArgTypes>

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Add ( ArgTypes &&...  Args )

inline

Add a named element. Note that this should only really be used when building a fresh value array, as using this during runtime can introduce duplicate values. Asserts in debug builds if duplicate values are present

AppendNames() [1/2]

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::AppendNames ( std::initializer_list< const FName >  InInputArgs )

inline

Add an array of named elements. Note that this should only really be used when building a fresh array, as using this during runtime can introduce duplicate values. Asserts in debug builds if duplicate values are present

AppendNames() [2/2]

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::AppendNames ( TConstArrayView< FName >  InNameArray )

inline

Add an array of named elements. Note that this should only really be used when building a fresh array, as using this during runtime can introduce duplicate values. Asserts in debug builds if duplicate values are present

CheckDuplicates()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::CheckDuplicates ( ) const

inlineprotected

CheckSorted()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::CheckSorted ( ) const

inlineprotected

Empty()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Empty ( )

inline

Reset the internal allocations

Find() [1/2]

template<typename InAllocatorType , typename InElementType >

ElementType * UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Find ( FName  InName )

inlineprotected

Finds the element with the specified name

Find() [2/2]

template<typename InAllocatorType , typename InElementType >

const ElementType * UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Find ( FName  InName ) const

inlineprotected

Finds the element with the specified name (const)

ForEachElement()

template<typename InAllocatorType , typename InElementType >

template<typename PredicateType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::ForEachElement ( PredicateType  InPredicate ) const

inline

Iterate over each element calling InPredicate for each. Predicate: (const ElementType&) -> void

HasElement()

template<typename InAllocatorType , typename InElementType >

bool UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::HasElement ( FName  InName ) const

inline

Check whether an element is present for the supplied name Note that this performs a binary search per-call.

Parameters

InName

the name of the element to check

Returns

true if an element with the supplied name is present

IndexOf()

template<typename InAllocatorType , typename InElementType >

int32 UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::IndexOf ( FName  InName ) const

inlineprotected

Finds index of the element with the specified name, disregarding enabled state

Max()

template<typename InAllocatorType , typename InElementType >

int32 UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Max ( ) const

inline

Returns

the max number of elements reserved in the array

Num()

template<typename InAllocatorType , typename InElementType >

int32 UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Num ( ) const

inline

Returns

the number of elements

Reserve()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Reserve ( int32  InNumElements )

inline

Reserves memory for InNumElements

Shrink()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Shrink ( )

inline

Compacts the memory for the elements based on what was actually used

SortElementsIfRequired()

template<typename InAllocatorType , typename InElementType >

void UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::SortElementsIfRequired ( ) const

inlineprotected

Friends And Related Symbol Documentation

FNamedValueArrayUtils

template<typename InAllocatorType , typename InElementType >

friend struct FNamedValueArrayUtils

friend

Member Data Documentation

bSorted

template<typename InAllocatorType , typename InElementType >

bool UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::bSorted = false

mutableprotected

Elements

template<typename InAllocatorType , typename InElementType >

TArray<ElementType, AllocatorType> UE::Anim::TNamedValueArray< InAllocatorType, InElementType >::Elements

mutableprotected

---

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

• Engine/Source/Runtime/Engine/Public/Animation/NamedValueArray.h