UPoseAsset

Pose Asset that can be blended by weight of curves

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Animation/PoseAsset.h"

Syntax

class UPoseAsset : public UAnimationAsset

Remarks

Pose Asset that can be blended by weight of curves

Variables

Name Description

Public variable

FName

 

RetargetSource

Base pose to use when retargeting

Public variable

TSoftObjectPtr<...

 

RetargetSourceAsset

If RetargetSource is set to Default (None), this is asset for the base pose to use when retargeting.

Public variable

TArray< FTransf...

 

RetargetSourceAssetReferencePose

When using RetargetSourceAsset, use the post stored here

Public variable

TObjectPtr< UAn...

 

SourceAnimation

Public variable

FGuid

 

SourceAnimationRawDataGUID

GUID cached when the contained poses were last updated according to SourceAnimation - used to keep track of out-of-date/sync data

Constructors

Name Description

Public function

UPoseAsset

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddOrUpdatePose

(
    const FSmartName& PoseName,
    USkeletalMeshComponent* MeshCo...,
    bool bUpdateCurves
)

Public function

bool

 

AddOrUpdatePoseWithUniqueName

(
    USkeletalMeshComponent* MeshCo...,
    FSmartName* OutPoseName
)

Public function Const

bool

 

ContainsPose

(
    const FName& InPoseName
)

Public function Const

bool

 

ContainsPose

(
    const FSmartName& InPoseName
)

Public function

bool

 

ConvertSpace

(
    bool bNewAdditivePose,
    int32 NewBasePoseInde
)

Public function

void

 

CreatePoseFromAnimation

(
    UAnimSequence* AnimSequence,
    const TArray< FSmartName >* In...
)

Public function

int32

 

DeleteCurves

(
    TArray< FName > CurveNamesToDelete
)

Public function

int32

 

DeletePoses

(
    TArray< FName > PoseNamesToDelete
)

Public function Const

void

 

GetAnimationCurveOnly

(
    TArray< FName >& InCurveNames,
    TArray< float >& InCurveValues,
    TArray< FName >& OutCurveNames,
    TArray< float >& OutCurveValues
)

This is utility function that just cares by names to be used by live link this isn't fast.

Public function Const

int32

 

GetBasePoseIndex()

Public function Const

const TArray...

 

GetCurveData()

Public function Const

const int32

 

GetCurveIndexByName

(
    const FName& InCurveName
)

Public function Const

const TArray...

 

GetCurveNames()

Public function Const

bool

 

GetCurveValue

(
    const int32 PoseIndex,
    const int32 CurveIndex,
    float& OutValue
)

Return value of a curve for a particular pose

Public function Const

const TArray...

 

GetCurveValues

(
    const int32 PoseIndex
)

Public function Const

bool

 

GetFullPose

(
    int32 PoseIndex,
    TArray< FTransform >& OutTransform...
)

Return full (local space, non additive) pose. Will do conversion if PoseAsset is Additive.

Public function Const

int32

 

GetNumCurves()

Public function Const

int32

 

GetNumPoses()

Public function Const

int32

 

GetNumTracks()

Public function Const

const int32

 

GetPoseIndexByName

(
    const FName& InBasePoseName
)

Public function Const

const FName

 

GetPoseNameByIndex

(
    int32 InBasePoseIndex
)

Public function Const

void

 

GetPoseNames

(
    TArray< FName >& PoseNames
)

Returns the name of all contained poses

Public function Const

const TArray...

 

GetPoseNames()

Public function Const

const int32

 

GetTrackIndexByName

(
    const FName& InTrackName
)

Find index of a track with a given bone name. Returns INDEX_NONE if not found.

Public function Const

const TArray...

 

GetTrackNames()

Public function Virtual Const

bool

 

HasRootMotion()

Public function

bool

 

ModifyPoseName

(
    FName OldPoseName,
    FName NewPoseName,
    const SmartName::UID_Type* New...
)

Public function

FDelegateHan...

 

RegisterOnPoseListChanged

(
    const FOnPoseListChanged& Delegate
)

Registers a delegate to be called after the preview animation has been changed

Public function

void

 

RemoveSmartNames

(
    const TArray< FName >& InNamesToRe...
)

Remove poses or curves using the smart names supplied.

Public function

void

 

RenamePose

(
    const FName& OriginalPoseName,
    const FName& NewPoseName
)

Renames a specific pose

Public function

void

 

RenameSmartName

(
    const FName& InOriginalName,
    const FName& InNewName
)

Rename the smart names used by this Pose Asset.

Public function

void

 

UnregisterOnPoseListChanged

(
    FDelegateHandle Handle
)

Unregisters a delegate to be called after the preview animation has been changed

Public function

void

 

UpdatePoseFromAnimation

(
    UAnimSequence* AnimSequence
)

Contained poses are re-generated from the provided Animation Sequence

Overridden from UAnimationAsset

Name Description

Public function Virtual

bool

 

GetAllAnimationSequencesReferred

(
    TArray< UAnimationAsset* >& A...,
    bool bRecursive
)

Retrieve all animations that are used by this asset

Public function Virtual Const

bool

 

IsValidAdditive()

Return true if this is valid additive animation false otherwise

Protected function Virtual

void

 

RemapTracksToNewSkeleton

(
    USkeleton* NewSkeleton,
    bool bConvertSpaces
)

Public function Virtual

void

 

ReplaceReferredAnimations

(
    const TMap< UAnimationAsset*, ...
)

Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

Name Description

Public function Virtual Const

void

 

GetAssetRegistryTags

(
    TArray< FAssetRegistryTag >& OutTa...
)

Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Public function Virtual Const

bool

 

IsPostLoadThreadSafe()

Called during async load to determine if PostLoad can be called on the loading thread.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

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

Public function Virtual

void

 

PreSave

(
    FObjectPreSaveContext SaveContext
)

Presave function.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Typedefs

Deprecated Functions

Name Description

Public function Const

bool

 

GetAnimationPose

(
    FCompactPose& OutPose,
    FBlendedCurve& OutCurve,
    const FAnimExtractContext& Extract...
)

Use GetAnimationPose with other signature

Public function Const

bool

 

GetAnimationPose

(
    FAnimationPoseData& OutAnimationPo...,
    const FAnimExtractContext& Extract...
)

Use GetAnimationPose with other signature

Public function Const

void

 

GetBaseAnimationPose

(
    FCompactPose& OutPose,
    FBlendedCurve& OutCurve
)

Use GetBaseAnimationPose with other signature

Public function Const

void

 

GetBaseAnimationPose

(
    FAnimationPoseData& OutAnimationPo...
)

Use GetBaseAnimationPose with other signature

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform* TargetP...
)

Use version that takes FObjectPreSaveContext instead.