1. Epic GamesDeveloper
  3. TAttributeContainer

TAttributeContainer

Runtime container for Animation[Attributes](API\Runtime\Engine\Animation\Attributes), providing a [TMap](API\Runtime\Core\Containers\TMap) like interface.

Unreal Engine C++ API Reference > Runtime > Engine > Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AttributesContainer.h
Include #include "Animation/AttributesContainer.h"

Syntax

template<class BoneIndexType, typename InAllocator>  
struct TAttributeContainer

Remarks

Runtime container for AnimationAttributes, providing a TMap like interface. Used in FStack

Variables

  Type Name Description
Protected variable TArray< TArray< FAttributeId > > AttributeIdentifiers  
Protected variable TArray< TArray< int32 > > UniqueTypedBoneIndices Unique bone indices for all contained entries of a specific attribute type
Protected variable TArray< TWeakObjectPtr< UScriptStruct > > UniqueTypes  
Protected variable TArray< TArray< TWrappedAttribute< InAllocator > > > Values  

Functions

  Type Name Description
Public function uint8 *

Add ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Adds a new attribute type/value entry for the specified InScriptType.
Public function AttributeType *

Add ( const FAttributeId& InAttributeId,
const AttributeType& Attribute
)

 Adds a new attribute type/value entry of the specified underlying AttributeType.
Public function Const bool Returns whether or not any this container contains any entries
Public function void

CopyFrom ( const TAttributeContainer< BoneIndexType, OtherAllocator >& Other
)

 Copies all contained data from another Container instance using another memory allocator
Public function void

CopyFrom ( const TAttributeContainer< OtherBoneIndexType, OtherAllocator >& Other,
const FBoneContainer& BoneContainer
)

  
Public function void

CopyFrom ( const TAttributeContainer< BoneIndexType, InAllocator >& Other
)

 Copies all contained data from another Container instance using the same memory allocator
Public function void

Empty ()

 Cleans out all contained entries and types
Public function Const const uint8 *

Find ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry for the specified InScriptType.
Public function uint8 *

Find ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry for the specified InScriptType.
Public function Const const AttributeType *

Find ( const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry of the specified AttributeType.
Public function AttributeType *

Find ( const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry of the specified AttributeType.
Public function Const const AttributeType &

FindChecked ( const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry of the specified AttributeType.
Public function AttributeType &

FindChecked ( const FAttributeId& InAttributeId
)

 Tries to find a attribute type/value entry of the specified AttributeType.
Public function uint8 *

FindOrAdd ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Adds, if not yet existing, a new attribute type/value entry for the specified InScriptType.
Public function AttributeType *

FindOrAdd ( const FAttributeId& InAttributeId
)

 Adds, if not yet existing, a new attribute type/value entry of the specified AttributeType.
Protected function int32

FindOrAddTypeIndex ( const UScriptStruct* InScriptStruct
)

 Find or add a new root-level entry for the provided attribute data type, returning the index into the arrays representing the type
Public function Const int32

FindTypeIndex ( const UScriptStruct* InScriptStruct
)

  
Public function Const bool

GetAllKeyNames ( TArray< FName, ArrayAllocator >& OutAttributeKeyNames
)

 Populate out parameter OutAttributeKeyNames for all contained attribute key names
Public function Const const TArray< FAttributeId > &

GetKeys ( int32 TypeIndex
)

  
Protected function TArray< FAttributeId > &

GetKeysInternal ( int32 TypeIndex
)

  
Public function Const const TArray< int32 > &

GetUniqueTypedBoneIndices ( int32 TypeIndex
)

  
Public function Const const TArray< TWeakObjectPtr< UScriptStruct > > &  
Public function Const const TArray< TWrappedAttribute< InAllocator > > &

GetValues ( int32 TypeIndex
)

  
Protected function TArray< TWrappedAttribute< InAllocator > > &

GetValuesInternal ( int32 TypeIndex
)

  
Public function Const int32

IndexOfByKey ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Tries to find and return the indedx of a attribute type/value entry of the specified AttributeType.
Public function Const int32

IndexOfByKey ( const FAttributeId& InAttributeId
)

 Tries to find and return the indedx of a attribute type/value entry of the specified AttributeType.
Public function void

MoveFrom ( TAttributeContainer< BoneIndexType, InAllocator >& Other
)

 Moves all contained data from another Container instance, once moved the other Container instance data is invalid
Public function Const int32

Num ()

  
Public function bool

Remove ( const FAttributeId& InAttributeId
)

 Removes, if existing, an attribute type/value entry of the specified AttributeType.
Public function bool

Remove ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Removes, if existing, an attribute type/value entry for the specified InScriptType.
Public function bool Removes all, if existing, an attribute type/value entries of the specified AttributeType.
Public function bool

RemoveAll ( const UScriptStruct* InScriptStruct,
const FAttributeId& InAttributeId
)

 Removes all, if existing, an attribute type/value entries for the specified InScriptType.

Operators

  Type Name Description
Public function bool

operator!= ( const TAttributeContainer< BoneIndexType, InAllocator >& Other
)

  

Deprecated Functions

  Type Name Description
Public function int32

AddBoneAttribute ( const BoneIndexType& BoneIndex,
const FName& AttributeName,
ECustomAttributeBlendType BlendType,
const DataType& Value
)

 Deprecated behaviour, see new API
Public function int32

AddBoneAttribute ( const FAttributeId& AttributeInfo,
const DataType& Value
)

 Deprecated behaviour, see new API
Public function Const bool

ContainsBoneAttribute ( uint32 BoneAttributeHash,
int32 BoneIndexInt
)

 Deprecated behaviour, see new API
Public function Const const TArray< FAttributeId > & Deprecated behaviour, see new API
Public function Const bool

GetBoneAttribute ( const BoneIndexType& BoneIndex,
const FName& AttributeName,
DataType& OutValue
)

 Deprecated behaviour, see new API
Public function Const const TArray< int32 > & Deprecated behaviour, see new API
Public function TArray< DataType > & Deprecated behaviour, see new API
Public function Const const TArray< DataType, InAllocator > & Deprecated behaviour, see new API
Public function Const int32

IndexOfBoneAttribute ( uint32 BoneAttributeHash,
int32 BoneIndexInt
)

 Deprecated behaviour, see new API

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page