FCustomAttributesRuntime

Helper functionality for custom attributes animation runtime

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "Animation/CustomAttributesRuntime.h"

Syntax

struct FCustomAttributesRuntime

Remarks

Helper functionality for custom attributes animation runtime

Functions

Name Description

Public function Static

void

 

AccumulateAttributes

(
    const FStackCustomAttributes& Sour...,
    FStackCustomAttributes& OutAttribu...,
    float Weight
)

Add any new or accumulate with existing custom attributes

Public function Static

void

 

BlendAttributes

(
    const TArrayView< const FStackCusto...,
    const TArrayView< const float > Sou...,
    FStackCustomAttributes& OutAttribu...
)

Blend custom attribute values from N set of inputs

Public function Static

void

 

BlendAttributes

(
    const TArrayView< const FStackCusto...,
    const TArrayView< const float > Sou...,
    FStackCustomAttributes& OutAttribu...
)

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

Public function Static

void

 

BlendAttributes

(
    const TArrayView< const FStackCusto...,
    const TArrayView< const float > Sou...,
    const TArrayView< const int32 > Sou...,
    FStackCustomAttributes& OutAttribu...
)

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

Public function Static

void

 

BlendAttributesPerBone

(
    const FStackCustomAttributes& Sour...,
    const FStackCustomAttributes& Sour...,
    const TArrayView< const float > Wei...,
    FStackCustomAttributes& OutAttribu...
)

Blend custom attribute values from 2 inputs, using per-bone weights

Public function Static

void

 

BlendAttributesPerBoneFilter

(
    const TArrayView< const FStackCusto...,
    const TArray< FPerBoneBlendWeight >...,
    FStackCustomAttributes& OutAttribu...
)

Blend custom attribute values from N set of inputs, using bone filter pose weights

Public function Static

void

 

CopyAndRemapAttributes

(
    const FHeapCustomAttributes& Sourc...,
    FStackCustomAttributes& OutAttribu...,
    const TMap< int32, int32 >& BoneMa...,
    const FBoneContainer& RequiredBone...
)

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

Public function Static

ECustomAttri...

 

GetAttributeBlendType

(
    const FName& InName
)

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

Public function Static

void

 

GetAttributeValue

(
    const FCustomAttribute& Attribute,
    float Time,
    float& OutValue
)

Editor functionality to retrieve custom attribute values from the raw data

Public function Static

void

 

GetAttributeValue

(
    const FCustomAttribute& Attribute,
    float Time,
    int32& OutValue
)

Editor functionality to retrieve custom attribute values from the raw data

Public function Static

void

 

GetAttributeValue

(
    const FCustomAttribute& Attribute,
    float Time,
    FString& OutValue
)

Editor functionality to retrieve custom attribute values from the raw data

Public function Static

void

 

GetAttributeValue

(
    FStackCustomAttributes& OutAttribu...,
    const FCompactPoseBoneIndex& PoseB...,
    const FCustomAttribute& Attribute,
    const FAnimExtractContext& Extract...
)

Editor functionality to retrieve custom attribute values from the raw data

Public function Static

void

 

InterpolateAttributes

(
    const FHeapCustomAttributes& Sourc...,
    FHeapCustomAttributes& OutAttribut...,
    float Alpha
)

Interpolates between two sets of attributes

Public function Static

void

 

OverrideAttributes

(
    const FStackCustomAttributes& Sour...,
    FStackCustomAttributes& OutAttribu...,
    float Weight
)

Add any new or override existing custom attributes

Public function Static

void

 

SubtractAttributes

(
    const FStackCustomAttributes& Sour...,
    FStackCustomAttributes& OutAttribu...
)

Add (negated) any new or subtract from existing custom attributes
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss