Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > UPoseAsset

Light Theme

Dark Theme

UPoseAsset

Pose Asset that can be blended by weight of curves

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UPoseAsset

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
	FName	RetargetSource	Base pose to use when retargeting
	UAnimSequence &...	SourceAnimation

Constructors

	Name	Description
	UPoseAsset ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AddOrUpdatePoseWithUniqueName ( USkeletalMeshComponent* MeshCo..., FSmartName* OutPoseName )
bool	ContainsPose ( const FSmartName& InPoseName )
bool	ContainsPose ( const FName& InPoseName )
bool	ConvertSpace ( bool bNewAdditivePose, int32 NewBasePoseInde )
void	CreatePoseFromAnimation ( UAnimSequence* AnimSequence, const TArray< FSmartName >* In... )
int32	DeleteCurves ( TArray< FName > CurveNamesToDelete )
int32	DeletePoses ( TArray< FName > PoseNamesToDelete )
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.
bool	GetAnimationPose ( FCompactPose& OutPose, FBlendedCurve& OutCurve, const FAnimExtractContext& Extract... )	Get Animation Pose from one pose of PoseIndex and with PoseWeight This returns OutPose and OutCurve of one pose of PoseIndex with PoseWeight
void	GetBaseAnimationPose ( FCompactPose& OutPose, FBlendedCurve& OutCurve )
int32	GetBasePoseIndex()
const TArray...	GetCurveData()
const int32	GetCurveIndexByName ( const FName& InCurveName )
const TArray...	GetCurveNames()
bool	GetCurveValue ( const int32 PoseIndex, const int32 CurveIndex, float& OutValue )	Return value of a curve for a particular pose
const TArray...	GetCurveValues ( const int32 PoseIndex )
bool	GetFullPose ( int32 PoseIndex, TArray< FTransform >& OutTransform... )	Return full (local space, non additive) pose. Will do conversion if PoseAsset is Additive.
int32	GetNumCurves()
int32	GetNumPoses()
int32	GetNumTracks()
const int32	GetPoseIndexByName ( const FName& InBasePoseName )
const FName	GetPoseNameByIndex ( int32 InBasePoseIndex )
const TArray...	GetPoseNames()
const int32	GetTrackIndexByName ( const FName& InTrackName )	Find index of a track with a given bone name. Returns INDEX_NONE if not found.
const TArray...	GetTrackNames()
bool	HasRootMotion()
bool	ModifyPoseName ( FName OldPoseName, FName NewPoseName, const SmartName::UID_Type* New... )
FDelegateHan...	RegisterOnPoseListChanged ( const FOnPoseListChanged& Delegate )	Registers a delegate to be called after the preview animation has been changed
void	RemoveSmartNames ( const TArray< FName >& InNamesToRe... )	Remove poses or curves using the smart names supplied.
void	RenameSmartName ( const FName& InOriginalName, const FName& InNewName )	Rename the smart names used by this Pose Asset.
void	UnregisterOnPoseListChanged ( FDelegateHandle Handle )	Unregisters a delegate to be called after the preview animation has been changed
void	UpdatePoseFromAnimation ( UAnimSequence* AnimSequence )

Overridden from UAnimationAsset

	Name	Description
bool	GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& A..., bool bRecursive )	Retrieve all animations that are used by this asset
bool	IsValidAdditive()	Return true if this is valid additive animation false otherwise
void	RemapTracksToNewSkeleton ( USkeleton* NewSkeleton, bool bConvertSpaces )
void	ReplaceReferredAnimations ( const TMap< UAnimationAsset*, ... )	Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

	Name	Description
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
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FOnPoseListChanged
FOnPoseListChangedMulticaster

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss