1. Epic GamesDeveloper
  3. UPoseAsset

UPoseAsset

Pose Asset that can be blended by weight of curves

Unreal Engine C++ API Reference > Runtime > Engine > Animation

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

  Type Name Description
Public variable FName RetargetSource Base pose to use when retargeting
Public variable TSoftObjectPtr< USkeletalMesh > RetargetSourceAsset If RetargetSource is set to Default (None), this is asset for the base pose to use when retargeting.
Public variable TArray< FTransform > RetargetSourceAssetReferencePose When using RetargetSourceAsset, use the post stored here
Public variable TObjectPtr< UAnimSequence > 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

  Type Name Description
Public function  

UPoseAsset ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddOrUpdatePose ( const FName& PoseName,
const USkeletalMeshComponent* MeshComponent,
bool bUpdateCurves
)

  
Public function FName  
Public function void

AddReferencePose ( const FName& PoseName,
const FReferenceSkeleton& ReferenceSkeleton
)

  
Public function Const bool

ContainsPose ( const FName& InPoseName
)

  
Public function bool

ConvertSpace ( bool bNewAdditivePose,
int32 NewBasePoseInde
)

  
Public function void

CreatePoseFromAnimation ( UAnimSequence* AnimSequence,
const TArray< FName >* InPoseNames
)

  
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  
Public function Const FName Returns base pose name, only valid when additive, NAME_None indicates reference pose
Public function Const FTransform

GetComponentSpaceTransform ( FName BoneName,
const TArray< FTransform >& LocalTransforms
)

 Util to return transform of a bone from the pose asset in component space, by walking up tracks in pose asset */
Public function Const const TArray< FAnimCurveBase > &  
Public function Const const TArray< FName >  
Public function Const const int32

GetCurveIndexByName ( const FName& InCurveName
)

  
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< float >

GetCurveValues ( const int32 PoseIndex
)

  
Public function Const bool

GetFullPose ( int32 PoseIndex,
TArray< FTransform >& OutTransforms
)

 Return full (local space, non additive) pose. Will do conversion if PoseAsset is Additive.
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const const TArray< FName > &  
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 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< FName > &  
Public function Static FName

GetUniquePoseName ( UPoseAsset* PoseAsset
)

  
Public function Virtual Const bool  
Public function bool

ModifyPoseName ( FName OldPoseName,
FName NewPoseName
)

  
Public function FDelegateHandle Registers a delegate to be called after the preview animation has been changed
Public function void

RemovePoseOrCurveNames ( const TArray< FName >& InNamesToRemove
)

 Remove poses or curves using the names supplied.
Public function void

RenamePose ( const FName& OriginalPoseName,
const FName& NewPoseName
)

 Renames a specific pose
Public function void

RenamePoseOrCurveName ( const FName& InOriginalName,
const FName& InNewName
)

 Rename poses or curves using the names supplied.
Public function bool

SetBasePoseName ( const FName& NewBasePoseName
)

 Set base pose index by name, NAME_None indicates reference pose - returns true if set successfully
Public function void Unregisters a delegate to be called after the preview animation has been changed
Public function void Contained poses are re-generated from the provided Animation Sequence

Overridden from UAnimationAsset

  Type Name Description
Public function Virtual bool

GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimationSequences,
bool bRecursive
)

 Retrieve all animations that are used by this asset
Public function Virtual Const bool Return true if this is valid additive animation false otherwise
Protected function Virtual void

RemapTracksToNewSkeleton ( USkeleton* NewSkeleton,
bool bConvertSpaces
)

  
Public function Virtual void Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

  Type Name Description
Public function Virtual Const void 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 Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FOnPoseListChanged  
FOnPoseListChangedMulticaster  

Deprecated Functions

  Type Name Description
Public function void

AddOrUpdatePose ( const FSmartName& PoseName,
const USkeletalMeshComponent* MeshComponent,
bool bUpdateCurves
)

 Please use AddOrUpdatePose that takes a FName.
Public function bool

AddOrUpdatePoseWithUniqueName ( const USkeletalMeshComponent* MeshComponent,
FSmartName* OutPoseName
)

 Please use AddPoseWithUniqueName.
Public function void

AddReferencePose ( const FSmartName& PoseName,
const FReferenceSkeleton& ReferenceSkeleton
)

 Please use AddReferencePose that takes a FName.
Public function Const bool

ContainsPose ( const FSmartName& InPoseName
)

 Please use ContainsPose that takes a FName.
Public function void

CreatePoseFromAnimation ( UAnimSequence* AnimSequence,
const TArray< FSmartName >* InPoseNames
)

 Please use CreatePoseFromAnimation that takes a ptr to an array of FNames.
Public function Const bool

GetAnimationPose ( FCompactPose& OutPose,
FBlendedCurve& OutCurve,
const FAnimExtractContext& ExtractionContext
)

 Use GetAnimationPose with other signature
Public function Const bool

GetAnimationPose ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext
)

 Use GetAnimationPose with other signature
Public function Const void

GetBaseAnimationPose ( FAnimationPoseData& OutAnimationPoseData
)

 Use GetBaseAnimationPose with other signature
Public function Const void Use GetBaseAnimationPose with other signature
Public function Const const TArray< FSmartName > Please use GetCurveFNames.
Public function Const const TArray< FSmartName > Please use GetPoseFNames.
Public function Static FName

GetUniquePoseName ( const USkeleton* Skeleton
)

 Please use GetUniquePoseName scoped to this pose asset.
Public function Static FSmartName Please use GetUniquePoseName.
Public function bool

ModifyPoseName ( FName OldPoseName,
FName NewPoseName,
const SmartName::UID_Type* NewUID
)

 Please use ModifyPoseName that does not take a UID.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.
Public function void

RemoveSmartNames ( const TArray< FName >& InNamesToRemove
)

 Please use RemovePoseOrCurveNames.
Public function void

RenameSmartName ( const FName& InOriginalName,
const FName& InNewName
)

 Please use RenamePoseOrCurveName.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page