UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Anim::Attributes Struct Reference

#include <AttributesRuntime.h>

Static Public Member Functions

static ENGINE_API void BlendAttributes (const TArrayView< const FStackAttributeContainer > SourceAttributes, const TArrayView< const float > SourceWeights, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributes (const TArrayView< const FStackAttributeContainer *const > SourceAttributes, const TArrayView< const float > SourceWeights, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributes (const TArrayView< const FStackAttributeContainer > SourceAttributes, const TArrayView< const float > SourceWeights, const TArrayView< const int32 > SourceWeightsIndices, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributesPerBone (const FStackAttributeContainer &SourceAttributes1, const FStackAttributeContainer &SourceAttributes2, const TArrayView< const float > WeightsOfSource2, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributesPerBone (TArrayView< const FStackAttributeContainer > SourceAttributes, TArrayView< const int32 > PerBoneInterpolationIndices, TArrayView< const FBlendSampleData > BlendSampleDataCache, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributesPerBone (TArrayView< const FStackAttributeContainer > SourceAttributes, TArrayView< const int32 > PerBoneInterpolationIndices, TArrayView< const FBlendSampleData > BlendSampleDataCache, TArrayView< const int32 > BlendSampleDataCacheIndices, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void BlendAttributesPerBoneFilter (const FStackAttributeContainer &BaseAttributes, const TArrayView< const FStackAttributeContainer > BlendAttributes, const TConstArrayView< FPerBoneBlendWeight > BoneBlendWeights, FStackAttributeContainer &OutAttributes)
 
static ENGINE_API void OverrideAttributes (const FStackAttributeContainer &SourceAttributes, FStackAttributeContainer &OutAttributes, float Weight)
 
static ENGINE_API void AccumulateAttributes (const FStackAttributeContainer &SourceAttributes, FStackAttributeContainer &OutAttributes, float Weight, EAdditiveAnimationType AdditiveType)
 
static ENGINE_API void ConvertToAdditive (const FStackAttributeContainer &BaseAttributes, FStackAttributeContainer &OutAdditiveAttributes)
 
static ENGINE_API void CopyAndRemapAttributes (const FMeshAttributeContainer &SourceAttributes, FStackAttributeContainer &OutAttributes, const TMap< int32, int32 > &BoneMapToSource, const FBoneContainer &RequiredBones)
 
static ENGINE_API void InterpolateAttributes (FMeshAttributeContainer &FromAttributes, const FMeshAttributeContainer &ToAttributes, float Alpha)
 
static ENGINE_API void MirrorAttributes (FStackAttributeContainer &Attributes, const UMirrorDataTable &MirrorDataTable, const TArray< FCompactPoseBoneIndex > &CompactPoseMirrorBones)
 
static ENGINE_API void MirrorAttributes (FStackAttributeContainer &Attributes, const UMirrorDataTable &MirrorDataTable)
 
static ENGINE_API ECustomAttributeBlendType GetAttributeBlendType (const FName &InName)
 
static ENGINE_API ECustomAttributeBlendType GetAttributeBlendType (const FAttributeId &Info)
 

Detailed Description

Helper functionality for attributes animation runtime

Member Function Documentation

◆ AccumulateAttributes()

void UE::Anim::Attributes::AccumulateAttributes ( const FStackAttributeContainer SourceAttributes,
FStackAttributeContainer OutAttributes,
float  Weight,
EAdditiveAnimationType  AdditiveType 
)
static

Add any new or accumulate with existing custom attributes

◆ BlendAttributes() [1/3]

void UE::Anim::Attributes::BlendAttributes ( const TArrayView< const FStackAttributeContainer *const >  SourceAttributes,
const TArrayView< const float SourceWeights,
FStackAttributeContainer OutAttributes 
)
static

Blend custom attribute values from N set of inputs (ptr-values)

◆ BlendAttributes() [2/3]

void UE::Anim::Attributes::BlendAttributes ( const TArrayView< const FStackAttributeContainer SourceAttributes,
const TArrayView< const float SourceWeights,
const TArrayView< const int32 SourceWeightsIndices,
FStackAttributeContainer OutAttributes 
)
static

Blend custom attribute values from N set of inputs, using input weight remapping

◆ BlendAttributes() [3/3]

void UE::Anim::Attributes::BlendAttributes ( const TArrayView< const FStackAttributeContainer SourceAttributes,
const TArrayView< const float SourceWeights,
FStackAttributeContainer OutAttributes 
)
static

Blend custom attribute values from N set of inputs

◆ BlendAttributesPerBone() [1/3]

void UE::Anim::Attributes::BlendAttributesPerBone ( const FStackAttributeContainer SourceAttributes1,
const FStackAttributeContainer SourceAttributes2,
const TArrayView< const float WeightsOfSource2,
FStackAttributeContainer OutAttributes 
)
static

◆ BlendAttributesPerBone() [2/3]

void UE::Anim::Attributes::BlendAttributesPerBone ( TArrayView< const FStackAttributeContainer SourceAttributes,
TArrayView< const int32 PerBoneInterpolationIndices,
TArrayView< const FBlendSampleData BlendSampleDataCache,
FStackAttributeContainer OutAttributes 
)
static

◆ BlendAttributesPerBone() [3/3]

void UE::Anim::Attributes::BlendAttributesPerBone ( TArrayView< const FStackAttributeContainer SourceAttributes,
TArrayView< const int32 PerBoneInterpolationIndices,
TArrayView< const FBlendSampleData BlendSampleDataCache,
TArrayView< const int32 BlendSampleDataCacheIndices,
FStackAttributeContainer OutAttributes 
)
static

◆ BlendAttributesPerBoneFilter()

void UE::Anim::Attributes::BlendAttributesPerBoneFilter ( const FStackAttributeContainer BaseAttributes,
const TArrayView< const FStackAttributeContainer BlendAttributes,
const TConstArrayView< FPerBoneBlendWeight BoneBlendWeights,
FStackAttributeContainer OutAttributes 
)
static

◆ ConvertToAdditive()

void UE::Anim::Attributes::ConvertToAdditive ( const FStackAttributeContainer BaseAttributes,
FStackAttributeContainer OutAdditiveAttributes 
)
static

Add (negated) any new or subtract from existing custom attributes

◆ CopyAndRemapAttributes()

void UE::Anim::Attributes::CopyAndRemapAttributes ( const FMeshAttributeContainer SourceAttributes,
FStackAttributeContainer OutAttributes,
const TMap< int32, int32 > &  BoneMapToSource,
const FBoneContainer RequiredBones 
)
static

Copy attributes from source, and remap the bone indices according to BoneMapToSource

◆ GetAttributeBlendType() [1/2]

ECustomAttributeBlendType UE::Anim::Attributes::GetAttributeBlendType ( const FAttributeId Info)
static

Helper functionality to retrieve the correct blend type (from UAnimationSettings) for the provided attribute info

◆ GetAttributeBlendType() [2/2]

ECustomAttributeBlendType UE::Anim::Attributes::GetAttributeBlendType ( const FName InName)
static

Helper functionality to retrieve the correct blend type (from UAnimationSettings) for the provided attribute name

◆ InterpolateAttributes()

void UE::Anim::Attributes::InterpolateAttributes ( FMeshAttributeContainer FromAttributes,
const FMeshAttributeContainer ToAttributes,
float  Alpha 
)
static

Interpolates between two sets of attributes

◆ MirrorAttributes() [1/2]

void UE::Anim::Attributes::MirrorAttributes ( FStackAttributeContainer Attributes,
const UMirrorDataTable MirrorDataTable 
)
static

◆ MirrorAttributes() [2/2]

void UE::Anim::Attributes::MirrorAttributes ( FStackAttributeContainer Attributes,
const UMirrorDataTable MirrorDataTable,
const TArray< FCompactPoseBoneIndex > &  CompactPoseMirrorBones 
)
static

Mirror (swap) attributes with the specified MirrorDataTable. Attributes are swapped using the bone mapping such that bones which are mirrored swap attributes

Pointers to attribute values

Identifier of the attribute

◆ OverrideAttributes()

void UE::Anim::Attributes::OverrideAttributes ( const FStackAttributeContainer SourceAttributes,
FStackAttributeContainer OutAttributes,
float  Weight 
)
static

Add any new or override existing custom attributes


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