TBaseCustomAttributes

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/CustomAttributesRuntime.h

Include

#include "Animation/CustomAttributesRuntime.h"

Syntax

template<class BoneIndexType, typename InAllocator>
struct TBaseCustomAttributes

Variables

Name Description

Protected variable

TArray< FCustom...

 

AttributeInfos

Information for each stored custom attribute.

Protected variable

TArray< float, ...

 

FloatValues

Attribute typed value arrays.

Protected variable

TArray< int32, ...

 

IntValues

Protected variable

TArray< FString...

 

StringValues

Protected variable

TArray< int32, ...

 

UniqueTypedBoneIndices

Contains the uniquely added bone indices, on a per-type basis (could make this a non-per-type array and index into it from BoneIndices, would add some cost for runtime evaluation to retrieve unique bone indices per type)

Functions

Name Description

Public function

int32

 

AddBoneAttribute

(
    const FCustomAttributeInfo& Attrib...,
    const DataType& Value
)

Public function

int32

 

AddBoneAttribute

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

Public function Const

bool

 

ContainsBoneAttribute

(
    uint32 BoneAttributeHash,
    int32 BoneIndexInt
)

Public function Const

bool

 

ContainsData()

Public function

void

 

CopyFrom

(
    const TBaseCustomAttributes< BoneIn...
)

Public function

void

 

CopyFrom

(
    const TBaseCustomAttributes< BoneIn...
)

Public function

void

 

Empty()

Public function Const

const TArray...

 

GetAttributeInfo()

Public function Const

bool

 

GetBoneAttribute

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

Protected function Static

constexpr in...

 

GetIndexForType()

Public function Const

const TArray...

 

GetUniqueBoneIndices()

Public function

TArray< Data...

 

GetValuesArray()

Retrieve the typed array containing individual attribute values

Public function Const

const TArray...

 

GetValuesArray()

Protected function Const

void

 

GetValuesArray_Internal

(
    const TArray< int32, InAllocator > ...
)

Protected function

void

 

GetValuesArray_Internal

(
    TArray< float, InAllocator >*&...
)

Internal type array getters, used to retrieve by-reference array in the public API.

Protected function

void

 

GetValuesArray_Internal

(
    TArray< int32, InAllocator >*&...
)

Protected function

void

 

GetValuesArray_Internal

(
    TArray< FString, InAllocator >*...
)

Protected function Const

void

 

GetValuesArray_Internal

(
    const TArray< float, InAllocator > ...
)

Protected function Const

void

 

GetValuesArray_Internal

(
    const TArray< FString, InAllocator ...
)

Public function Const

int32

 

IndexOfBoneAttribute

(
    uint32 BoneAttributeHash,
    int32 BoneIndexInt
)

Public function

void

 

MoveFrom

(
    TBaseCustomAttributes< BoneIndexTyp...
)

Once moved, source is invalid

Operators

Name Description

Public function

bool

 

operator!=

(
    const TBaseCustomAttributes< BoneIn...
)

Constants

Name

Description

NumSupportedDataTypes

Number of, and explicit types which are currently supported.

SupportedTypes

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss