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

Light Theme

Dark Theme

FBoneContainer

This is a native transient structure.

Choose your operating system:

Windows

macOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/BoneContainer.h
Include	#include "BoneContainer.h"

Syntax

struct FBoneContainer

Remarks

This is a native transient structure. Contains:

BoneIndicesArray: Array of RequiredBoneIndices for Current Asset. In increasing order. Mapping to current Array of Transforms (Pose).
BoneSwitchArray: Size of current Skeleton. true if Bone is contained in RequiredBones array, false otherwise.

Constructors

	Name	Description
	FBoneContainer()
	FBoneContainer ( const TArray< FBoneIndexType >& In..., const FCurveEvaluationOption& Curv..., UObject& InAsset )

Functions

	Name	Description
bool	BoneIsChildOf ( const int32 BoneIndex, const int32 ParentBoneIndex )	Returns true if bone is child of for current asset.
bool	BoneIsChildOf ( const FCompactPoseBoneIndex& BoneI..., const FCompactPoseBoneIndex& Paren... )	Returns true if bone is child of for current asset.
void	CacheRequiredAnimCurveUids ( const FCurveEvaluationOption& Curv... )	Cache required Anim Curve Uids
bool	Contains ( FBoneIndexType NewIndex )	Returns true of RequiredBonesArray contains this bone index.
void	FillWithCompactRefPose ( ArrayType& OutTransforms )	Fill the supplied buffer with the compact pose reference pose.
FRangedForSu...	ForEachCompactPoseBoneIndex()
FRangedForRe...	ForEachCompactPoseBoneIndexReverse()
UObject *...	GetAsset()	Get Asset this BoneContainer was made for.
const TArray...	GetBoneIndicesArray()	Returns array of the size of compact pose, mapping to mesh pose index returns Required Bone Indices Array
const TBitAr...	GetBoneSwitchArray()	Returns Bone Switch Array. BitMask for RequiredBoneIndex array.
int32	GetCalculatedForLOD()	Get the LOD that we calculated required bones when regenerated
FCompactPose...	GetCompactPoseIndexFromSkeletonIndex ( const int32 SkeletonIndex )	DEPRECATED - Ideally should use GetCompactPoseIndexFromSkeletonPoseIndex due to raw int32 here.
FCompactPose...	GetCompactPoseIndexFromSkeletonPoseIndex ( const FSkeletonPoseBoneIndex& Skel... )	Map skeleton bone index to compact pose index
const int32	GetCompactPoseNumBones()
const TArray...	GetCompactPoseParentBoneArray()
int32	GetDepthBetweenBones ( const int32 BoneIndex, const int32 ParentBoneIndex )	Get Depth between bones for current asset.
bool	GetDisableRetargeting()	True if retargeting is disabled for debugging.
FMeshPoseBon...	GetMeshPoseIndexFromSkeletonPoseIndex ( const FSkeletonPoseBoneIndex& Skel... )	Map skeleton bone index to mesh index
const int32	GetNumBones()	Number of Bones in RefPose for current asset.
const FCache...	GetOrCreateCachedCurveMapping ( const FSkeletonRemapping* Skel... )	Curve remapping.
FCompactPose...	GetParentBoneIndex ( const FCompactPoseBoneIndex& BoneI... )	Get ParentBoneIndex for current Asset.
int32	GetParentBoneIndex ( const int32 BoneIndex )	Get ParentBoneIndex for current Asset.
int32	GetPoseBoneIndexForBoneName ( const FName& BoneName )	Get BoneIndex for BoneName for current Asset.
const FRefer...	GetReferenceSkeleton()	Access to Asset's RefSkeleton.
const TArray...	GetRefPoseArray()	Pointer to RefPoseArray for current Asset.
const FTrans...	GetRefPoseTransform ( const FCompactPoseBoneIndex& BoneI... )
const FRetar...	GetRetargetSourceCachedData ( const FName& InSourceName, const TArray< FTransform >& InReta... )
const FRetar...	GetRetargetSourceCachedData ( const FName& InRetargetSource )
uint16	GetSerialNumber()	Get the serial number of this bone container.
USkeletalMes...	GetSkeletalMeshAsset()	Get SkeletalMesh Asset this BoneContainer was made for. Could be NULL if Asset is a Skeleton.
USkeleton &#...	GetSkeletonAsset()	Get Skeleton Asset.
int32	GetSkeletonIndex ( const FCompactPoseBoneIndex& BoneI... )	DEPRECATED - Ideally should use GetSkeletonPoseIndexFromCompactPoseIndex due to raw int32 here.
FSkeletonPos...	GetSkeletonPoseIndexFromCompactPoseIndex ( const FCompactPoseBoneIndex& BoneI... )	Map compact bone index to skeleton index
FSkeletonPos...	GetSkeletonPoseIndexFromMeshPoseIndex ( const FMeshPoseBoneIndex& MeshInde... )	Map mesh bone index to skeleton index
int32	GetUIDToArrayIndexLookupTableValidCount()	Returns the number of valid entries in the GetUIDToArrayLookupTable result array
TArray< uint...	GetUIDToArrayLookupTable()	Get UID To Array look up table
TArray< Smar...	GetUIDToArrayLookupTableBackup()	Get the array that maps UIDs to array indexes.
const TArray...	GetVirtualBoneCompactPoseData()	Returns virutal bone cached data
void	InitializeTo ( const TArray< FBoneIndexType >& In..., const FCurveEvaluationOption& Curv..., UObject& InAsset )	Initialize BoneContainer to a new Asset, RequiredBonesArray and RefPoseArray.
const bool	IsValid()	Returns true if FBoneContainer is Valid.
FCompactPose...	MakeBeginIter()
FCompactPose...	MakeBeginIterReverse()
FCompactPose...	MakeCompactPoseIndex ( const FMeshPoseBoneIndex& BoneInde... )
FCompactPose...	MakeEndIter()
FCompactPose...	MakeEndIterReverse()
FMeshPoseBon...	MakeMeshPoseIndex ( const FCompactPoseBoneIndex& BoneI... )
void	MarkAllCachedCurveMappingsDirty()
void	SetDisableRetargeting ( bool InbDisableRetargeting )	Disable Retargeting for debugging.
void	SetRefPoseOverride ( const TSharedPtr< FSkelMeshRefPoseO... )	Override skeleton ref pose.
void	SetUseRAWData ( bool InbUseRAWData )	Ignore compressed data and use RAW data instead, for debugging.
void	SetUseSourceData ( bool InbUseSourceData )	Use Source data instead.
bool	ShouldUseRawData()	True if we're requesting RAW data instead of compressed data. For debugging.
bool	ShouldUseSourceData()	True if we're requesting Source data instead of RawAnimationData. For debugging.

Classes

	Name	Description
	FRangedForReverseSupport
	FRangedForSupport

Deprecated Functions

	Name	Description
TArray< int3...	GetPoseToSkeletonBoneIndexArray()	Please use GetSkeletonPoseIndexFromMeshPoseIndex
TArray< int3...	GetSkeletonToPoseBoneIndexArray()	Please use GetMeshPoseIndexFromSkeletonPoseIndex
TArray< FAni...	GetUIDToCurveTypeLookupTable()	GetUIDToCurveTypeLookupTable is deprecated, please access from the SmartNameMapping directly via GetSkeletonAsset()->GetSmartNameContainer(USkeleton::AnimCurveMappingName)
TArray< FNam...	GetUIDToNameLookupTable()	GetUIDToNameLookupTable is deprecated, please access from the SmartNameMapping directly via GetSkeletonAsset()->GetSmartNameContainer(USkeleton::AnimCurveMappingName)