Unreal Engine 4 Documentation > Unreal Engine API Reference > Runtime > Engine > FBoneContainer

FBoneContainer

This is a native transient structure.

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 >& InRequiredBoneIndexArray, const FCurveEvaluationOption& CurveEvalOption, UObject& InAsset )

Functions

	Name	Description
bool	BoneIsChildOf ( const FCompactPoseBoneIndex& BoneIndex, const FCompactPoseBoneIndex& ParentBoneIndex )	Returns true if bone is child of for current asset.
bool	BoneIsChildOf ( const int32 BoneIndex, const int32 ParentBoneIndex )	Returns true if bone is child of for current asset.
void	CacheRequiredAnimCurveUids ( const FCurveEvaluationOption& CurveEvalOption )	Cache required Anim Curve Uids
bool	Contains ( FBoneIndexType NewIndex )	Returns true of RequiredBonesArray contains this bone index.
UObject *	GetAsset()	Get Asset this BoneContainer was made for.
const TArray< FBoneIndexType > &	GetBoneIndicesArray()	Returns Required Bone Indices Array
const TBitArray &	GetBoneSwitchArray()	Returns Bone Switch Array. BitMask for RequiredBoneIndex array.
FCompactPoseBoneIndex	GetCompactPoseIndexFromSkeletonIndex ( const int32 SkeletonIndex )
const int32	GetCompactPoseNumBones()
int32	GetDepthBetweenBones ( const int32 BoneIndex, const int32 ParentBoneIndex )	Get Depth between bones for current asset.
bool	GetDisableRetargeting()	True if retargeting is disabled for debugging.
const int32	GetNumBones()	Number of Bones in RefPose for current asset.
int32	GetParentBoneIndex ( const int32 BoneIndex )	Get ParentBoneIndex for current Asset.
FCompactPoseBoneIndex	GetParentBoneIndex ( const FCompactPoseBoneIndex& BoneIndex )	Get ParentBoneIndex for current Asset.
int32	GetPoseBoneIndexForBoneName ( const FName& BoneName )	Get BoneIndex for BoneName for current Asset.
TArray< int32 > const &	GetPoseToSkeletonBoneIndexArray()	Const accessor to GetSkeletonToPoseBoneIndexArray().
const FReferenceSkeleton &	GetReferenceSkeleton()	Access to Asset's RefSkeleton.
const TArray< FTransform > &	GetRefPoseArray()	Pointer to RefPoseArray for current Asset.
const TArray< FTransform > &	GetRefPoseCompactArray()
const FTransform &	GetRefPoseTransform ( const FCompactPoseBoneIndex& BoneIndex )
const FRetargetSourceCachedData &	GetRetargetSourceCachedData ( const FName& InRetargetSource )
USkeletalMesh *	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& BoneIndex )
TArray< int32 > const &	GetSkeletonToPoseBoneIndexArray()	Const accessor to GetSkeletonToPoseBoneIndexArray().
TArray< uint16 > const &	GetUIDToArrayLookupTable()	Get UID To Array look up table
TArray< FAnimCurveType > const &	GetUIDToCurveTypeLookupTable()	Get UID To curve type look up table
TArray< FName > const &	GetUIDToNameLookupTable()	Get UID To Name look up table
const TArray< FVirtualBoneCompactPoseData > &	GetVirtualBoneCompactPoseData()	Returns virutal bone cached data
void	InitializeTo ( const TArray< FBoneIndexType >& InRequiredBoneIndexArray, const FCurveEvaluationOption& CurveEvalOption, UObject& InAsset )	Initialize BoneContainer to a new Asset, RequiredBonesArray and RefPoseArray.
const bool	IsValid()	Returns true if FBoneContainer is Valid.
FCompactPoseBoneIndex	MakeCompactPoseIndex ( const FMeshPoseBoneIndex& BoneIndex )
FMeshPoseBoneIndex	MakeMeshPoseIndex ( const FCompactPoseBoneIndex& BoneIndex )
void	SetDisableRetargeting ( bool InbDisableRetargeting )	Disable Retargeting for debugging.
void	SetRefPoseCompactArray ( const TArray< FTransform >& InRefPoseCompactArray )
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.

Select Skin

Light

Dark