1. Epic GamesDeveloper
  3. Attributes

Attributes

Helper functionality for attributes animation runtime

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Animation/AttributesRuntime.h
Include #include "Animation/AttributesRuntime.h"

Syntax

struct Attributes

Remarks

Helper functionality for attributes animation runtime

Functions

  Type Name Description
Public function Static void

AccumulateAttributes ( const FStackAttributeContainer& SourceAttributes,
FStackAttributeContainer& OutAttributes,
float Weight,
EAdditiveAnimationType AdditiveType
)

 Add any new or accumulate with existing custom attributes
Public function Static void

BlendAttributes ( const TArrayView< const FStackAttributeContainer*const > SourceAttributes,
const TArrayView< const float > SourceWeights,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs (ptr-values)
Public function Static void

BlendAttributes ( const TArrayView< const FStackAttributeContainer > SourceAttributes,
const TArrayView< const float > SourceWeights,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs
Public function Static void

BlendAttributes ( const TArrayView< const FStackAttributeContainer > SourceAttributes,
const TArrayView< const float > SourceWeights,
const TArrayView< const int32 > SourceWeightsIndices,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs, using input weight remapping
Public function Static void

BlendAttributesPerBone ( const FStackAttributeContainer& SourceAttributes1,
const FStackAttributeContainer& SourceAttributes2,
const TArrayView< const float > WeightsOfSource2,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from 2 inputs, using per-bone weights
Public function Static void

BlendAttributesPerBone ( TArrayView< const FStackAttributeContainer > SourceAttributes,
TArrayView< const int32 > PerBoneInterpolationIndices,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs, using N number of blend samples
Public function Static void

BlendAttributesPerBone ( TArrayView< const FStackAttributeContainer > SourceAttributes,
TArrayView< const int32 > PerBoneInterpolationIndices,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
TArrayView< const int32 > BlendSampleDataCacheIndices,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs, using N number of blend samples
Public function Static void

BlendAttributesPerBoneFilter ( const FStackAttributeContainer& BaseAttributes,
const TArrayView< const FStackAttributeContainer > BlendAttributes,
const TArray< FPerBoneBlendWeight >& BoneBlendWeights,
FStackAttributeContainer& OutAttributes
)

 Blend custom attribute values from N set of inputs, using bone filter pose weights
Public function Static void

ConvertToAdditive ( const FStackAttributeContainer& BaseAttributes,
FStackAttributeContainer& OutAdditiveAttributes
)

 Add (negated) any new or subtract from existing custom attributes
Public function Static void

CopyAndRemapAttributes ( const FMeshAttributeContainer& SourceAttributes,
FStackAttributeContainer& OutAttributes,
const TMap< int32, int32 >& BoneMapToSource,
const FBoneContainer& RequiredBones
)

 Copy attributes from source, and remap the bone indices according to BoneMapToSource
Public function Static ECustomAttributeBlendType

GetAttributeBlendType ( const FName& InName
)

 Helper functionality to retrieve the correct blend type (from UAnimationSettings) for the provided attribute name
Public function Static ECustomAttributeBlendType Helper functionality to retrieve the correct blend type (from UAnimationSettings) for the provided attribute info
Public function Static void

GetAttributeValue ( FStackAttributeContainer& OutAttributes,
const FCompactPoseBoneIndex& PoseBoneIndex,
const FAnimatedBoneAttribute& Attribute,
double CurrentTime
)

  
Public function Static void

InterpolateAttributes ( FMeshAttributeContainer& FromAttributes,
const FMeshAttributeContainer& ToAttributes,
float Alpha
)

 Interpolates between two sets of attributes
Public function Static void

MirrorAttributes ( FStackAttributeContainer& Attributes,
const UMirrorDataTable& MirrorDataTable,
const TArray< FCompactPoseBoneIndex >& CompactPoseMirrorBones
)

 Mirror (swap) attributes with the specified MirrorDataTable.
Public function Static void

OverrideAttributes ( const FStackAttributeContainer& SourceAttributes,
FStackAttributeContainer& OutAttributes,
float Weight
)

 Add any new or override existing custom attributes

Deprecated Functions

  Type Name Description
Public function Static void

GetAttributeValue ( FStackAttributeContainer& OutAttributes,
const FCompactPoseBoneIndex& PoseBoneIndex,
const FAnimatedBoneAttribute& Attribute,
const FAnimExtractContext& ExtractionContext
)

 GetAttributeValue with signature using FAnimExtractContext is deprecated use other version instead
Public function Static void

MirrorAttributes ( FStackAttributeContainer& Attributes,
const UMirrorDataTable& MirrorDataTable
)

 MirrorAttributes has been deprecated, use other signature instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page