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

Light Theme

Dark Theme

USkeleton

[USkeleton](API\Runtime\Engine\Animation\USkeleton) : that links between mesh and animation

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USkeleton

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Animation/Skeleton.h
Include	#include "Animation/Skeleton.h"

Syntax

class USkeleton :
    public UObject,
    public IInterface_AssetUserData,
    public IInterface_PreviewMeshProvider

Remarks

USkeleton : that links between mesh and animation

Bone hierarchy for animations
Bone/track linkup between mesh and animation
Retargetting related
Mirror table

Variables

	Name	Description
TArray< FName >	AnimationNotifies	AnimNotifiers that has been created.
FSmartNameMappi...	AnimCurveMapping	Cached ptr to the persistent AnimCurveMapping.
TMap< FName, FR...	AnimRetargetSources	Serializable retarget sources for this skeleton
TArray< UAssetU...	AssetUserData	Array of user data stored with the asset
TArray< UBlendP...	BlendProfiles	List of blend profiles available in this skeleton
TArray< struct ...	BoneTree	Skeleton bone tree - each contains name and parent index
TArray< uint16 ...	DefaultCurveUIDList	This is default curve uid list used like ref pose, as default value don't use this unless you want all curves from the skeleton FBoneContainer contains only list that is used by current LOD
TArray< FName >	ExistingMarkerNames	Cached marker sync marker names (stripped for non editor)
FGuid	Guid	Guid for skeleton
TArray< struct ...	LinkupCache	Non-serialised cache of linkups between different skeletal meshes and this Skeleton.
FOnSkeletonHier...	OnSkeletonHierarchyChanged
FPreviewAssetAt...	PreviewAttachedAssetContainer	Attached assets component for this skeleton
FReferenceSkele...	ReferenceSkeleton	Reference Skeleton
TMap< TWeakObje...	SkelMesh2LinkupCache	Runtime built mapping table between SkeletalMeshes, and LinkupCache array indices.
FSmartNameConta...	SmartNames	Container for smart name mappings.
TArray< class U...	Sockets	Array of named socket locations, set up in editor and used as a shortcut instead of specifying everything explicitly to AttachComponent in the SkeletalMeshComponent.
FGuid	VirtualBoneGuid	Guid for virtual bones.
TArray< FVirtua...	VirtualBones	Array of this skeletons virtual bones.

Constructors

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

Functions

	Name	Description
void	AccumulateCurveMetaData ( FName CurveName, bool bMaterialSet, bool bMorphtargetSet )	This is called when you know both flags - called by post serialize
void	AddNewAnimationNotify ( FName NewAnimNotifyName )	Adds a new anim notify to the cached AnimationNotifies array.
bool	AddNewVirtualBone ( const FName SourceBoneName, const FName TargetBoneName, FName& NewVirtualBoneName )
bool	AddNewVirtualBone ( const FName SourceBoneName, const FName TargetBoneName )
bool	AddSlotGroupName ( const FName& InNewGroupName )	Returns true if Group is added, false if it already exists
bool	AddSmartNameAndModify ( FName ContainerName, FName NewDisplayName, FSmartName& NewName )	Smart Name Interfaces.
int32	BuildLinkup ( const USkeletalMesh* InSkelMes... )	Build Look up between SkelMesh to BoneTree
void	CallbackRetargetSourceChanged()
void	ClearCacheData()	Clears all cache data
void	CollectAnimationNotifies ( TArray< FName >& OutNotifies )	Collect animation notifies that are referenced in all animations that use this skeleton (uses the asset registry).
void	CollectAnimationNotifies()	Collect animation notifies that are referenced in all animations that use this skeleton (uses the asset registry).
bool	ContainsSlotName ( const FName& InSlotName )
void	ConvertToFReferenceSkeleton()	Conversion function.
UBlendProfil...	CreateNewBlendProfile ( const FName& InProfileName )	Create a new blend profile with the specified name
bool	CreateReferenceSkeletonFromMesh ( const USkeletalMesh* InSkeleta..., const TArray< int32 >& RequiredRef... )	Create Reference Skeleton From the given Mesh
bool	DoesParentChainMatch ( int32 StartBoneTreeIndex, const USkeletalMesh* InSkelMes... )	Check if Parent Chain Matches between BoneTree, and SkelMesh Meaning if BoneTree has A->B->C (top to bottom) and if SkelMesh has A->C It will fail since it's missing B We ensure this chain matches to play animation properly
FAnimSlotGro...	FindAnimSlotGroup ( const FName& InGroupName )
const FAnimS...	FindAnimSlotGroup ( const FName& InGroupName )
USkeletalMes...	FindCompatibleMesh()	Find the first compatible mesh for this skeleton
int32	FindRigBoneMapping ( const FName& NodeName )
USkeletalMes...	FindSocket ( FName InSocketName )
USkeletalMes...	FindSocketAndIndex ( FName InSocketName, int32& OutIndex )
UDataAsset &...	GetAdditionalPreviewSkeletalMeshes()	Get the additional skeletal meshes we use when previewing this skeleton
uint16	GetAnimCurveUidVersion()	Return version of AnimCurveUidVersion
USkeletalMes...	GetAssetPreviewMesh ( UObject* InAsset )
UBlendProfil...	GetBlendProfile ( const FName& InProfileName )	Get the specified blend profile by name
EBoneTransla...	GetBoneTranslationRetargetingMode ( const int32 BoneTreeIdx )
int32	GetChildBones ( int32 ParentBoneIndex, TArray< int32 >& Children )	Get List of Child Bones of the ParentBoneIndex
const FCurve...	GetCurveMetaData ( const FSmartName& CurveName )	These return container of curve meta data, if you modify this container, you'll have to call REfreshCAchedAnimationCurveData to apply
FCurveMetaDa...	GetCurveMetaData ( const FSmartName& CurveName )	These return container of curve meta data, if you modify this container, you'll have to call REfreshCAchedAnimationCurveData to apply
const FCurve...	GetCurveMetaData ( const SmartName::UID_Type CurveUID )	These return container of curve meta data, if you modify this container, you'll have to call REfreshCAchedAnimationCurveData to apply
const FCurve...	GetCurveMetaData ( const FName& CurveName )	These return container of curve meta data, if you modify this container, you'll have to call REfreshCAchedAnimationCurveData to apply
FCurveMetaDa...	GetCurveMetaData ( const FName& CurveName )	These return container of curve meta data, if you modify this container, you'll have to call REfreshCAchedAnimationCurveData to apply
const TArray...	GetDefaultCurveUIDList()
const TArray...	GetExistingMarkerNames()	Get existing (seen) sync marker names for this Skeleton.
const FGuid	GetGuid()
int32	GetMappedValidNodes ( TArray< FName >& OutValidNodeNames )	This make sure it stays within the valid range
int32	GetMeshBoneIndexFromSkeletonBoneIndex ( const USkeletalMesh* InSkelMes..., const int32 SkeletonBoneIndex )	Get Reference Bone Index from Bone Tree Index
int32	GetMeshLinkupIndex ( const USkeletalMesh* InSkelMes... )	Find a mesh linkup table (mapping of skeleton bone tree indices to refpose indices) for a particular SkeletalMesh If one does not already exist, create it now.
int32	GetRawAnimationTrackIndex ( const int32 InSkeletonBoneIndex, const UAnimSequence* InAnimSeq )	Get Track index of InAnimSeq for the BoneTreeIndex of BoneTree this is slow, and it's not supposed to be used heavily
const FRefer...	GetReferenceSkeleton()	Accessor to Reference Skeleton to make data read only
const TArray...	GetRefLocalPoses ( FName RetargetSource )
FName	GetRetargetSourceForMesh ( USkeletalMesh* InMesh )	Find a retarget source for a particular skel mesh.
URig *	GetRig()
FName	GetRigBoneMapping ( const FName& NodeName )
FName	GetRigNodeNameFromBoneName ( const FName& BoneName )
int32	GetSkeletonBoneIndexFromMeshBoneIndex ( const USkeletalMesh* InSkelMes..., const int32 MeshBoneIndex )	Get Bone Tree Index from Reference Bone Index
FName	GetSlotGroupName ( const FName& InSlotName )
const TArray...	GetSlotGroups()
bool	GetSmartNameByName ( const FName& ContainerName, const FName& InName, FSmartName& OutSmartName )
bool	GetSmartNameByUID ( const FName& ContainerName, SmartName::UID_Type UID, FSmartName& OutSmartName )
const FSmart...	GetSmartNameContainer ( const FName& ContainerName )	Get or add a smartname container with the given name.
SmartName::U...	GetUIDByName ( const FName& ContainerName, const FName& Name )	Quick wrapper function for Find UID by name, if not found, it will return SmartName::MaxUID
FGuid	GetVirtualBoneGuid()
const TArray...	GetVirtualBones()	Accessor for the array of virtual bones on this skeleton
void	HandleSkeletonHierarchyChange()	Call this when the skeleton has changed to fix dependent assets
void	HandleVirtualBoneChanges()
bool	IsCompatible ( USkeleton const* InSkeleton )	Check if this skeleton may be used with other skeleton
bool	IsCompatibleMesh ( const USkeletalMesh* InSkelMes... )	Indexing naming convention
void	LoadAdditionalPreviewSkeletalMeshes()	Load any additional meshes we may have
bool	MergeAllBonesToBoneTree ( const USkeletalMesh* InSkelMes... )	Merge all Bones to BoneTrees if not exists
bool	MergeBonesToBoneTree ( const USkeletalMesh* InSkeleta..., const TArray< int32 >& RequiredRef... )	Merge Bones (RequiredBones from InSkelMesh) to BoneTrees if not exists
void	RebuildLinkup ( const USkeletalMesh* InSkelMes... )	Rebuild Look up between SkelMesh to BoneTree - this should only get called when SkelMesh is re-imported or so, where the mapping may be no longer valid
bool	RecreateBoneTree ( USkeletalMesh* InSkelMesh )	Merge has failed, then Recreate BoneTree
void	RefreshAllRetargetSources()	Refresh All Retarget Sources
void	RefreshRigConfig()	Verify if it has all latest data
void	RegisterMarkerName ( FName MarkerName )	Register a new sync marker name.
FDelegateHan...	RegisterOnRetargetSourceChanged ( const FOnRetargetSourceChanged& De... )	Registers a delegate to be called after the preview animation has been changed
void	RegisterOnSkeletonHierarchyChanged ( const FOnSkeletonHierarchyChanged&... )	Registers a delegate to be called after notification has changed
bool	RegisterSlotNode ( const FName& InSlotName )	Register a slot name. Return true if a slot was registered, false if it was already registered.
void	RemoveBonesFromSkeleton ( const TArray< FName >& BonesToRemo..., bool bRemoveChildBones )	Removes the supplied bones from the skeleton
void	RemoveLinkup ( const USkeletalMesh* InSkelMes... )	Remove Link up cache for the SkelMesh
void	RemoveMarkerName ( FName MarkerName )	Remove a sync marker name.
void	RemoveSlotGroup ( const FName& InSlotName )
void	RemoveSlotName ( const FName& InSlotName )	Edits/removes slot group data WARNING: Does not verify that the names aren't used anywhere - if it isn't checked by the caller the names will be recreated when referencing assets load again.
void	RemoveSmartnameAndModify ( FName ContainerName, SmartName::UID_Type Uid )	Removes a smartname from the specified container and modifies the skeleton.
void	RemoveSmartnamesAndModify ( FName ContainerName, const TArray< FName >& Names )	Removes smartnames from the specified container and modifies the skeleton.
void	RemoveVirtualBones ( const TArray< FName >& BonesToRemo... )
void	RenameSlotName ( const FName& OldName, const FName& NewName )
bool	RenameSmartnameAndModify ( FName ContainerName, SmartName::UID_Type Uid, FName NewName )	Renames a smartname in the specified container and modifies the skeleton return bool - Whether the rename was sucessful
void	RenameVirtualBone ( const FName OriginalBoneName, const FName NewBoneName )
void	SetAdditionalPreviewSkeletalMeshes ( UDataAsset* InPreviewCollectio... )	Set the additional skeletal meshes we use when previewing this skeleton
void	SetBoneTranslationRetargetingMode ( const int32 BoneIndex, EBoneTranslationRetargetingMode::Ty..., bool bChildrenToo )
bool	SetRigBoneMapping ( const FName& NodeName, FName BoneName )
void	SetRigConfig ( URig* Rig )
void	SetSlotGroupName ( const FName& InSlotName, const FName& InGroupName )
void	UnregisterOnRetargetSourceChanged ( FDelegateHandle Handle )	Unregisters a delegate to be called after the preview animation has been changed
void	UnregisterOnSkeletonHierarchyChanged ( void* Unregister )
void	UpdateReferencePoseFromMesh ( const USkeletalMesh* InSkelMes... )	Create RefLocalPoses from InSkelMesh.
void	UpdateRetargetSource ( const FName InName )	Update Retarget Source with given name
int32	ValidatePreviewAttachedObjects()	Makes sure all attached objects are valid and removes any that aren't.
void	VerifySmartName ( const FName& ContainerName, FSmartName& InOutSmartName )	Make sure the smart name has valid UID and so on
void	VerifySmartNames ( const FName& ContainerName, TArray< FSmartName >& InOutSmartNa... )	Make sure the smart name has valid UID and so on

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditUndo()	Called before applying a transaction to the object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AssetUserData

		Name	Description
	void	AddAssetUserData ( UAssetUserData* InUserData )
	const TArray...	GetAssetUserDataArray()
	UAssetUserDa...	GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )
	void	RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )

Overridden from IInterface_PreviewMeshProvider

	Name	Description
USkeletalMes...	GetPreviewMesh()	Get the preview mesh for this asset
USkeletalMes...	GetPreviewMesh ( bool bFindIfNotSet )	IInterface_PreviewMeshProvider interface
void	SetPreviewMesh ( USkeletalMesh* PreviewMesh, bool bMarkAsDirty )	Set the preview mesh for this asset

Typedefs

Name	Description
AnimCurveUID	Typedefs for greater smartname UID readability, add one for each smartname category.
FBoneTreeType
FOnRetargetSourceChanged
FOnRetargetSourceChangedMulticaster
FOnSkeletonHierarchyChanged
FOnSkeletonHierarchyChangedMulticaster

Constants

Name	Description
AnimCurveMappingName	Names for smartname mappings, if you're adding a new category of smartnames add a new name here.
AnimNotifyTag	Asset registry information for animation notifies.
AnimNotifyTagDelimiter
AnimTrackCurveMappingName	Names for smartname mappings, if you're adding a new category of smartnames add a new name here.
CurveNameTag	Asset registry information for animation curves.
CurveTagDelimiter
RigTag	Rig Configs

Deprecated Variables

		Name	Description
	TArray< FTransf...	RefLocalPoses_DEPRECATED	Reference skeleton poses in local space

Deprecated Functions

		Name	Description
	const TArray...	GetBoneTree()	GetBoneTree should not be called. Please use GetBoneTranslationRetargetingMode()/SetBoneTranslationRetargetingMode() functions instead

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

Take our survey

Dismiss