FBoneReference

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/BoneContainer.h

Include

#include "BoneContainer.h"

Syntax

struct FBoneReference

Variables

Name Description

Public variable

int32: 31

 

BoneIndex

Cached bone index for run time - right now bone index of skeleton

Public variable

FName

 

BoneName

Name of bone to control. This is the main bone chain to modify from.

Public variable

uint32: 1

 

bUseSkeletonIndex

Change this to Bitfield if we have more than one bool This specifies whether or not this indices is mesh or skeleton

Public variable

FCompactPoseBon...

 

CachedCompactPoseIndex

Constructors

Name Description

Public function

FBoneReference()

Public function

FBoneReference

(
    const FName& InBoneName
)

Functions

Name Description

Public function Const

FCompactPose...

 

GetCompactPoseIndex

(
    const FBoneContainer& RequiredBone...
)

Public function Const

FMeshPoseBon...

 

GetMeshPoseIndex

(
    const FBoneContainer& RequiredBone...
)

Public function Const

bool

 

HasValidSetup()

Return true if it has valid set up

Public function

bool

 

Initialize

(
    const FBoneContainer& RequiredBone...
)

Initialize Bone Reference, return TRUE if success, otherwise, return false

Public function

bool

 

Initialize

(
    const USkeleton* Skeleton
)

Only used by blendspace 'PerBoneBlend'.

Public function

void

 

InvalidateCachedBoneIndex()

Public function Const

bool

 

IsValidToEvaluate()

Return true if has valid compact index. This will return invalid if you're using skeleton index

Public function Const

bool

 

IsValidToEvaluate

(
    const FBoneContainer& RequiredBone...
)

Return true if has valid index, and required bones contain it

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FBoneReference& Other
)

Deprecated Functions

Name Description

Public function Const

bool

 

IsValid

(
    const FBoneContainer& RequiredBone...
)

Please use IsValidToEvaluate instead

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback