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

Light Theme

Dark Theme

FReferenceSkeleton

Reference Skeleton

Windows

MacOS

Linux

References

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

Syntax

struct FReferenceSkeleton

Remarks

Reference Skeleton

Variables

		Name	Description
	friend	FReferenceSkeletonModifier

Constructors

	Name	Description
	FReferenceSkeleton ( bool bInOnlyOneRootAllowed )

Functions

	Name	Description
bool	BoneIsChildOf ( const int32 ChildBoneIndex, const int32 ParentBoneIndex )
void	Empty ( int32 Size )
void	EnsureParentsExist ( TArray< FBoneIndexType >& InOutBon... )	Ensure parent exists in the given input sorted array.
void	EnsureParentsExistAndSort ( TArray< FBoneIndexType >& InOutBon... )	Ensure parent exists in the given input array.
int32	FindBoneIndex ( const FName& BoneName )	Find Bone Index from BoneName. Precache as much as possible in speed critical sections!
int32	FindRawBoneIndex ( const FName& BoneName )	Find Bone Index from BoneName. Precache as much as possible in speed critical sections!
FName	GetBoneName ( const int32 BoneIndex )
SIZE_T	GetDataSize()
int32	GetDepthBetweenBones ( const int32 BoneIndex, const int32 ParentBoneIndex )	Returns # of Depth from BoneIndex to ParentBoneIndex This will return 0 if BoneIndex == ParentBoneIndex; This will return -1 if BoneIndex isn't child of ParentBoneIndex
int32	GetDirectChildBones ( int32 ParentBoneIndex, TArray< int32 >& Children )	Very slow search function for all children
int32	GetNum()	Returns number of bones in Skeleton.
int32	GetParentIndex ( const int32 BoneIndex )
int32	GetRawBoneNum()	Returns number of raw bones in Skeleton. These are the original bones of the asset
int32	GetRawParentIndex ( const int32 BoneIndex )
const TArray...	GetRawRefBoneInfo()	Accessor to private data. Raw relates to original asset. Const so it can't be changed recklessly.
const TArray...	GetRawRefBonePose()	Accessor to private data. Raw relates to original asset. Const so it can't be changed recklessly.
const TArray...	GetRefBoneInfo()	Accessor to private data.
const TArray...	GetRefBonePose()	Accessor to private data.
const TArray...	GetRequiredVirtualBones()
const TArray...	GetVirtualBoneRefData()
bool	IsValidIndex ( int32 Index )
bool	IsValidRawIndex ( int32 Index )
void	RebuildNameToIndexMap()
void	RebuildRefSkeleton ( const USkeleton* Skeleton, bool bRebuildNameMap )
TArray< int3...	RemoveBonesByName ( USkeleton* Skeleton, const TArray< FName >& BonesToRemo... )	Removes the supplied bones from the skeleton, unless they have children that aren't also going to be removed
void	RemoveDuplicateBones ( const UObject* Requester, TArray< FBoneIndexType >& Duplicat... )

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

Take our survey

Dismiss