UBlendProfile

A blend profile is a set of per-bone scales that can be used in transitions and blend lists to tweak the weights of specific bones.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Animation/BlendProfile.h"

Syntax

class UBlendProfile :
    public UObject,
    public IInterpolationIndexProvider

Remarks

A blend profile is a set of per-bone scales that can be used in transitions and blend lists to tweak the weights of specific bones. The scales are applied to the normal weight for that bone

Variables

Name Description

Public variable

EBlendProfileMo...

 

Mode

Blend Profile Mode. Read EBlendProfileMode for more details.

Public variable

TObjectPtr< USk...

 

OwningSkeleton

The skeleton that owns this profile.

Public variable

TArray< FBlendP...

 

ProfileEntries

List of blend scale entries.

Constructors

Name Description

Public function

UBlendProfile()

Functions

Name Description

Public function Static

float

 

CalculateBoneWeight

(
    float BoneFactor,
    EBlendProfileMode Mode,
    const FAlphaBlend& BlendInfo,
    float BlendStartAlpha,
    float MainWeight,
    bool bInverse
)

Calculate the blend weight for a given bone.

Public function Const

void

 

FillBoneScalesArray

(
    TArray< float >& OutBoneBlendProfi...,
    const FBoneContainer& BoneContaine...
)

Resize and fill an array of floats with the bone factor values.

Public function Const

float

 

GetBoneBlendScale

(
    const FName& InBoneName
)

Get the set blend scale for the specified bone, will return 1.0f if no entry was found (no scale).

Public function Const

float

 

GetBoneBlendScale

(
    int32 InBoneIdx
)

Get the set blend scale for the specified bone, will return 1.0f if no entry was found (no scale)

Public function Virtual Const

float

 

GetDefaultBlendScale()

Default value of entries. Default values are not saved.

Public function Const

float

 

GetEntryBlendScale

(
    const int32 InEntryIdx
)

Get the blend scale stored in a specific entry.

Public function Const

int32

 

GetEntryIndex

(
    const FName& BoneName
)

Get the index of the entry for the specified bone

Public function Const

int32

 

GetEntryIndex

(
    const FSkeletonPoseBoneIndex InBone...
)

Get the index of the entry for the specified bone

Public function Const

EBlendProfil...

 

GetMode()

Public function Const

int32

 

GetNumBlendEntries()

Get the number of entries in the profile (an entry is any blend scale that isn't 1.0f)

Public function Const

bool

 

IsBlendMask()

Public function

void

 

RemoveEntry

(
    int32 InBoneIdx
)

Removes the entry for the specified bone index (does nothing if it doesn't exist)

Public function

void

 

SetBoneBlendScale

(
    int32 InBoneIdx,
    float InScale,
    bool bRecurse,
    bool bCreate
)

Set the blend scale for a specific bone

Public function

void

 

SetBoneBlendScale

(
    const FName& InBoneName,
    float InScale,
    bool bRecurse,
    bool bCreate
)

Set the blend scale for a specific bone

Public function

void

 

UpdateBoneWeights

(
    FBlendSampleData& InOutCurrentData,
    const FAlphaBlend& BlendInfo,
    float BlendStartAlpha,
    float MainWeight,
    bool bInverse
)

Update all the bone weights for some provided FBlendSampleData.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsSafeForRootSet()

UObject.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Overridden from IInterpolationIndexProvider

Name Description

Public function Virtual Const

int32

 

GetPerBoneInterpolationIndex

(
    const FCompactPoseBoneIndex& InCom...,
    const FBoneContainer& BoneContaine...,
    const IInterpolationIndexProvider::...
)

IInterpolationIndexProvider.

Deprecated Functions

Name Description

Public function Const

int32

 

GetEntryIndex

(
    const int32 InBoneIdx
)

Please use the overload that takes a skeleton bone index