1. Epic GamesDeveloper
  3. USkeleton

USkeleton

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

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

Inheritance Hierarchy

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

Variables

  Type Name Description
Public variable TArray< FName > AnimationNotifies AnimNotifiers that has been created.
Public variable TMap< FName, FReferencePose > AnimRetargetSources Serializable retarget sources for this skeleton
Protected variable TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable TArray< TObjectPtr< UBlendProfile > > BlendProfiles List of blend profiles available in this skeleton
Protected variable TArray< struct FBoneNode > BoneTree Skeleton bone tree - each contains name and parent index
Public variable TSoftObjectPtr< USkeleton > CachedSoftObjectPtr A cached soft object pointer of this skeleton.
Protected variable TArray< TSoftObjectPtr< USkeleton > > CompatibleSkeletons The list of compatible skeletons.
Protected variable TArray< FName > ExistingMarkerNames Cached marker sync marker names (stripped for non editor)
Protected variable FGuid Guid Guid for skeleton
Public variable TArray< struct FSkeletonToMeshLinkup > LinkupCache Non-serialised cache of linkups between different skeletal meshes and this Skeleton.
Public variable FCriticalSection LinkupCacheLock Use this Lock everytime you change or access LinkupCache and SkelMesh2LinkupCache member.
Protected variable FOnSkeletonHierarchyChangedMulticaster OnSkeletonHierarchyChanged  
Public variable FPreviewAssetAttachContainer PreviewAttachedAssetContainer Attached assets component for this skeleton
Protected variable FReferenceSkeleton ReferenceSkeleton Reference Skeleton
Public variable TArray< TObjectPtr< class USkeletalMeshSocket > > 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.
Protected variable FGuid VirtualBoneGuid Guid for virtual bones.
Protected variable TArray< FVirtualBone > VirtualBones Array of this skeletons virtual bones.

Constructors

  Type Name Description
Public function  

USkeleton ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AccumulateCurveMetaData ( FName CurveName,
bool bMaterialSet,
bool bMorphtargetSet
)

 This is called when you know both flags - called by post serialize and import
Public function void

AddCompatibleSkeleton ( const USkeleton* SourceSkeleton
)

  
Public function void

AddCompatibleSkeletonSoft ( const TSoftObjectPtr< USkeleton >& SourceSkeleton
)

  
Public function bool

AddCurveMetaData ( FName CurveName
)

 Adds a curve metadata entry with the specified name
Public function void

AddNewAnimationNotify ( FName NewAnimNotifyName
)

 Adds a new anim notify to the cached AnimationNotifies array.
Public function bool

AddNewVirtualBone ( const FName SourceBoneName,
const FName TargetBoneName,
FName& NewVirtualBoneName
)

  
Public function bool

AddNewVirtualBone ( const FName SourceBoneName,
const FName TargetBoneName
)

  
Public function bool

AddSlotGroupName ( const FName& InNewGroupName
)

 Returns true if Group is added, false if it already exists
Protected function int32

BuildLinkup ( const USkinnedAsset* InSkinnedAsset
)

 Build Look up between SkinnedAsset to BoneTree
Public function void  
Public function void Clears all cache data
Public function void Collect animation notifies that are referenced in all animations that use this skeleton (uses the asset registry).
Public function Const void

CollectAnimationNotifies ( TArray< FName >& OutNotifies
)

 Collect animation notifies that are referenced in all animations that use this skeleton (uses the asset registry).
Public function Const bool

ContainsSlotName ( const FName& InSlotName
)

  
Protected function void Conversion function.
Public function UBlendProfile *

CreateNewBlendProfile ( const FName& InProfileName
)

 Create a new blend profile with the specified name
Protected function bool

CreateReferenceSkeletonFromMesh ( const USkinnedAsset* InSkinnedAsset,
const TArray< int32 >& RequiredRefBones
)

 Create Reference Skeleton From the given Mesh
Protected function Const bool

DoesParentChainMatch ( int32 StartBoneTreeIndex,
const USkinnedAsset* InSkinnedAsset
)

 Check if Parent Chain Matches between BoneTree, and SkinnedAsset Meaning if BoneTree has A->B->C (top to bottom) and if SkinnedAsset has A->C It will fail since it's missing B We ensure this chain matches to play animation properly
Public function FAnimSlotGroup *

FindAnimSlotGroup ( const FName& InGroupName
)

  
Public function Const const FAnimSlotGroup *

FindAnimSlotGroup ( const FName& InGroupName
)

  
Public function Const USkeletalMesh * Find the first compatible mesh for this skeleton
Public function Const int32

FindRigBoneMapping ( const FName& NodeName
)

  
Public function Const USkeletalMeshSocket *

FindSocket ( FName InSocketName
)

  
Public function Const USkeletalMeshSocket *

FindSocketAndIndex ( FName InSocketName,
int32& OutIndex
)

  
Public function Const void

ForEachCurveMetaData ( TFunctionRef< void(FName, const FCurveMetaData&)> InFunction
)

 Iterate over all curve metadata entries, calling InFunction on each
Public function Const UDataAsset * Get the additional skeletal meshes we use when previewing this skeleton
Public function Const uint16 Return version of AnimCurveUidVersion
Public function USkeletalMesh *  
Public function UBlendProfile *

GetBlendProfile ( const FName& InProfileName
)

 Get the specified blend profile by name
Public function Const EBoneTranslationRetargetingMode::Type

GetBoneTranslationRetargetingMode ( const int32 BoneTreeIdx,
bool bDisableRetargeting
)

  
Public function Const int32

GetChildBones ( int32 ParentBoneIndex,
TArray< int32 >& Children
)

 Get List of Child Bones of the ParentBoneIndex
Public function Const void

GetCompatibleAssets ( UClass* AssetClass,
const TCHAR* InTag,
TArray< FAssetData >& OutAssets
)

 Get compatible assets given the asset's class and skeleton tag.
Public function Const void Get all skeleton assets that are compatible with this skeleton (not just the internal list, but also reciprocally and implicitly compatible skeletons)
Public function Const const TArray< TSoftObjectPtr< USkeleton > > &  
Public function FCurveMetaData *

GetCurveMetaData ( FName CurveName
)

  
Public function Const const FCurveMetaData *

GetCurveMetaData ( FName CurveName
)

  
Public function Const void Get an array of all curve metadata names
Public function Const const TArray< FName > & Get existing (seen) sync marker names for this Skeleton.
Public function Const const FGuid

GetGuid ()

  
Public function int32

GetMappedValidNodes ( TArray< FName >& OutValidNodeNames
)

 This make sure it stays within the valid range
Public function int32

GetMeshBoneIndexFromSkeletonBoneIndex ( const USkinnedAsset* InSkinnedAsset,
const int32 SkeletonBoneIndex
)

 Get Reference Bone Index from Bone Tree Index
Public function int32

GetMeshLinkupIndex ( const USkinnedAsset* InSkinnedAsset
)

 Find a mesh linkup table (mapping of skeleton bone tree indices to refpose indices) for a particular SkinnedAsset If one does not already exist, create it now.
Public function Const int32  
Public function Const const FReferenceSkeleton & Accessor to Reference Skeleton to make data read only
Public function Const const TArray< FTransform > &

GetRefLocalPoses ( FName RetargetSource
)

 Get the local-space ref pose for the specified retarget source.
Public function Const FName Find a retarget source for a particular mesh.
Public function Const void

GetRetargetSources ( TArray< FName >& OutRetargetSources
)

 Get all the retarget source names for this skeleton.
Public function Const URig *

GetRig ()

  
Public function Const FName

GetRigBoneMapping ( const FName& NodeName
)

  
Public function Const FName

GetRigNodeNameFromBoneName ( const FName& BoneName
)

  
Public function int32

GetSkeletonBoneIndexFromMeshBoneIndex ( const USkinnedAsset* InSkinnedAsset,
const int32 MeshBoneIndex
)

 Get Bone Tree Index from Reference Bone Index
Public function Const FName

GetSlotGroupName ( const FName& InSlotName
)

  
Public function Const const TArray< FAnimSlotGroup > &  
Public function Const FGuid  
Public function Const const TArray< FVirtualBone > & Accessor for the array of virtual bones on this skeleton
Protected function void Call this when the skeleton has changed to fix dependent assets
Public function void  
Public function Const bool

IsCompatibleForEditor ( const FString& SkeletonAssetString
)

 Check if this skeleton is compatible with another skeleton asset that is identified by the string returned by AssetData(SkeletonPtr).GetExportTextName().
Public function Const bool

IsCompatibleForEditor ( const USkeleton* InSkeleton
)

 Check if animation content authored on the supplied skeleton may be played on this skeleton.
Public function Const bool

IsCompatibleForEditor ( const FAssetData& AssetData,
const TCHAR* InTag
)

 Check if this skeleton is compatible with a given other asset, if that is a skeleton.
Public function Const bool

IsCompatibleMesh ( const USkinnedAsset* InSkinnedAsset,
bool bDoParentChainCheck
)

 Indexing naming convention
Public function void Load any additional meshes we may have
Public function bool

MergeAllBonesToBoneTree ( const USkinnedAsset* InSkinnedAsset
)

 Merge all Bones to BoneTrees if not exists
Public function bool

MergeBonesToBoneTree ( const USkinnedAsset* InSkinnedAsset,
const TArray< int32 >& RequiredRefBones
)

 Merge Bones (RequiredBones from InSkinnedAsset) to BoneTrees if not exists
Public function void

RebuildLinkup ( const USkinnedAsset* InSkinnedAsset
)

 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
Public function bool

RecreateBoneTree ( USkinnedAsset* InSkinnedAsset
)

 Merge has failed, then Recreate BoneTree
Protected function void Refresh All Retarget Sources
Public function void Verify if it has all latest data
Public function void

RegisterMarkerName ( FName MarkerName
)

 Register a new sync marker name.
Public function FDelegateHandle Registers a delegate to be called after the preview animation has been changed
Public function void Registers a delegate to be called after notification has changed
Public function bool

RegisterSlotNode ( const FName& InSlotName
)

 Register a slot name. Return true if a slot was registered, false if it was already registered.
Public function void

RemoveAnimationNotify ( FName AnimNotifyName
)

 Removes an anim notify from the cached AnimationNotifies array.
Public function void

RemoveBonesFromSkeleton ( const TArray< FName >& BonesToRemove,
bool bRemoveChildBones
)

 Removes the supplied bones from the skeleton
Public function void

RemoveCompatibleSkeleton ( const USkeleton* SourceSkeleton
)

  
Public function void

RemoveCompatibleSkeleton ( const TSoftObjectPtr< USkeleton >& SourceSkeleton
)

  
Public function bool

RemoveCurveMetaData ( FName CurveName
)

 Removes a curve metadata entry for the specified name.
Public function bool Removes a group of curve metadata entries for the specified names.
Public function void

RemoveLinkup ( const USkinnedAsset* InSkinnedAsset
)

 Remove Link up cache for the SkelMesh
Public function bool

RemoveMarkerName ( FName MarkerName
)

 Remove a sync marker name.
Public function void

RemoveSlotGroup ( const FName& InSlotName
)

  
Public function 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.
Public function void

RemoveVirtualBones ( const TArray< FName >& BonesToRemove
)

  
Public function void

RenameAnimationNotify ( FName OldAnimNotifyName,
FName NewAnimNotifyName
)

 Renames an anim notify.
Public function bool

RenameCurveMetaData ( FName OldName,
FName NewName
)

 Renames a curve metadata entry. Metadata is preserved, but assigned to a different curve name.
Public function bool

RenameMarkerName ( FName InOldName,
FName InNewName
)

 Rename a sync marker name.
Public function void

RenameSlotName ( const FName& OldName,
const FName& NewName
)

  
Public function void

RenameVirtualBone ( const FName OriginalBoneName,
const FName NewBoneName
)

  
Public function void

SetAdditionalPreviewSkeletalMeshes ( UDataAsset* InPreviewCollectionAsset
)

 Set the additional skeletal meshes we use when previewing this skeleton
Public function void

SetBoneTranslationRetargetingMode ( const int32 BoneIndex,
EBoneTranslationRetargetingMode::Type NewRetargetingMode,
bool bChildrenToo
)

  
Public function bool

SetRigBoneMapping ( const FName& NodeName,
FName BoneName
)

  
Public function void

SetRigConfig ( URig* Rig
)

  
Public function void

SetSlotGroupName ( const FName& InSlotName,
const FName& InGroupName
)

  
Public function Const bool

ShouldFilterAsset ( const FAssetData& InAssetData,
const TCHAR* InTag
)

 Wrapper for !IsCompatibleForEditor, used as a convenience function for binding to FOnShouldFilterAsset in asset pickers.
Public function void Unregisters a delegate to be called after the preview animation has been changed
Public function void  
Public function void

UpdateReferencePoseFromMesh ( const USkinnedAsset* InSkinnedAsset
)

 Create RefLocalPoses from InSkinnedAsset.
Public function void

UpdateRetargetSource ( const FName InName
)

 Update Retarget Source with given name
Public function int32 Makes sure all attached objects are valid and removes any that aren't.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called before applying a transaction to the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *  
Public function Virtual void  

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const USkeletalMesh * Get the preview mesh for this asset
Public function Virtual USkeletalMesh *

GetPreviewMesh ( bool bFindIfNotSet
)

 IInterface_PreviewMeshProvider interface
Public function Virtual void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 Set the preview mesh for this asset

Classes

  Type Name Description
Public class FSmartNamesChangedEvent    

Typedefs

Name Description
AnimCurveUID DEPRECATED - no longer used.
FBoneTreeType  
FOnRetargetSourceChanged  
FOnRetargetSourceChangedMulticaster  
FOnSkeletonHierarchyChanged  
FOnSkeletonHierarchyChangedMulticaster  

Constants

Name Description
AnimCurveMapping Cached ptr to the persistent AnimCurveMapping
AnimCurveMappingName  
AnimNotifyTag Asset registry information for animation notifies.
AnimNotifyTagDelimiter  
AnimSyncMarkerTag Asset registry information for animation sync markers.
AnimSyncMarkerTagDelimiter  
AnimTrackCurveMappingName  
AreAllSkeletonsCompatibleDelegate Global compatibility delegate, used to override skeleton compatibility.
CompatibleSkeletonsNameTag Asset registry information for compatible skeletons.
CompatibleSkeletonsTagDelimiter  
CurveNameTag Asset registry information for animation curves.
CurveTagDelimiter  
DefaultCurveUIDList  
RigTag Rig Configs

Deprecated Variables

  Type Name Description
Public variable FSmartNamesChangedEvent OnSmartNamesChangedEvent This member is no longer used. Delegate registration for skeleton metadata can be handled via UAnimCurveMetaData.
Protected variable TArray< FTransform > RefLocalPoses_DEPRECATED Reference skeleton poses in local space
Public variable TMap< TWeakObjectPtr< USkeletalMesh >, int32 > SkelMesh2LinkupCache Public access to this member variable is deprecated.
Protected variable FSmartNameContainer SmartNames_DEPRECATED DEPRECATED - moved to CurveMetaData.

Deprecated Functions

  Type Name Description
Public function bool

AddSmartNameAndModify ( FName ContainerName,
FName NewDisplayName,
FSmartName& NewName
)

 Please use AddCurveMetaData.
Public function FCurveMetaData *

GetCurveMetaData ( const FSmartName& CurveName
)

 Please use GetCurveMetaData with an FName.
Public function Const const FCurveMetaData * Please use GetCurveMetaData with an FName.
Public function Const const FCurveMetaData *

GetCurveMetaData ( const FSmartName& CurveName
)

 Please use GetCurveMetaData with an FName.
Public function Const const TArray< uint16 > & This function is no longer used
Public function int32

GetRawAnimationTrackIndex ( const int32 InSkeletonBoneIndex,
const UAnimSequence* InAnimSeq
)

 GetRawAnimationTrackIndex has been deprecated, use tracks are referenced by name instead
Public function Const const FSkeletonRemapping *

GetSkeletonRemapping ( const USkeleton* SourceSkeleton
)

 Please use UE::Anim::FSkeletonRemappingRegistry::GetRemapping.
Public function Const bool

GetSmartNameByName ( const FName& ContainerName,
const FName& InName,
FSmartName& OutSmartName
)

 This function is no longer used
Public function Const bool

GetSmartNameByUID ( const FName& ContainerName,
SmartName::UID_Type UID,
FSmartName& OutSmartName
)

 This function is no longer used
Public function Const const FSmartNameMapping *

GetSmartNameContainer ( const FName& ContainerName
)

 This function is no longer used
Public function Const SmartName::UID_Type

GetUIDByName ( const FName& ContainerName,
const FName& Name
)

 This function is no longer used
Public function Const bool

IsCompatible ( const USkeleton* InSkeleton
)

 Compatibility is now an editor-only concern. Please use IsCompatibleForEditor.
Public function Const bool

IsCompatibleSkeletonByAssetData ( const FAssetData& AssetData,
const TCHAR* InTag
)

 Compatibility is now an editor-only concern. Please use IsCompatibleForEditor.
Public function Const bool

IsCompatibleSkeletonByAssetString ( const FString& SkeletonAssetString
)

 Compatibility is now an editor-only concern. Please use IsCompatibleForEditor.
Public function void Please use RemoveCurveMetaData.
Public function void

RemoveSmartnamesAndModify ( FName ContainerName,
const TArray< FName >& Names
)

 Please use RemoveCurveMetaData.
Public function bool

RenameSmartnameAndModify ( FName ContainerName,
SmartName::UID_Type Uid,
FName NewName
)

 Please use RenameCurveMetaData.
Public function void

VerifySmartName ( const FName& ContainerName,
FSmartName& InOutSmartName
)

 This function is no longer used
Public function void

VerifySmartNames ( const FName& ContainerName,
TArray< FSmartName >& InOutSmartNames
)

 This function is no longer used

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page