FBoneContainer

This is a native transient structure.

Windows
MacOS
Linux

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

Public function

FBoneContainer()

Public function

FBoneContainer

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

Functions

Name Description

Public function Const

bool

 

BoneIsChildOf

(
    const FCompactPoseBoneIndex& BoneI...,
    const FCompactPoseBoneIndex& Paren...
)

Returns true if bone is child of for current asset.

Public function Const

bool

 

BoneIsChildOf

(
    const int32 BoneIndex,
    const int32 ParentBoneIndex
)

Returns true if bone is child of for current asset.

Public function

void

 

CacheRequiredAnimCurveUids

(
    const FCurveEvaluationOption& Curv...
)

Cache required Anim Curve Uids

Public function Const

bool

 

Contains

(
    FBoneIndexType NewIndex
)

Returns true of RequiredBonesArray contains this bone index.

Public function Const

UObject *...

 

GetAsset()

Get Asset this BoneContainer was made for.

Public function Const

const TArray...

 

GetBoneIndicesArray()

Returns Required Bone Indices Array

Public function Const

const TBitAr...

 

GetBoneSwitchArray()

Returns Bone Switch Array. BitMask for RequiredBoneIndex array.

Public function Const

FCompactPose...

 

GetCompactPoseIndexFromSkeletonIndex

(
    const int32 SkeletonIndex
)

Public function Const

const int32

 

GetCompactPoseNumBones()

Public function Const

int32

 

GetDepthBetweenBones

(
    const int32 BoneIndex,
    const int32 ParentBoneIndex
)

Get Depth between bones for current asset.

Public function Const

bool

 

GetDisableRetargeting()

True if retargeting is disabled for debugging.

Public function Const

const int32

 

GetNumBones()

Number of Bones in RefPose for current asset.

Public function Const

int32

 

GetParentBoneIndex

(
    const int32 BoneIndex
)

Get ParentBoneIndex for current Asset.

Public function Const

FCompactPose...

 

GetParentBoneIndex

(
    const FCompactPoseBoneIndex& BoneI...
)

Get ParentBoneIndex for current Asset.

Public function Const

int32

 

GetPoseBoneIndexForBoneName

(
    const FName& BoneName
)

Get BoneIndex for BoneName for current Asset.

Public function Const

TArray< int3...

 

GetPoseToSkeletonBoneIndexArray()

Const accessor to GetSkeletonToPoseBoneIndexArray().

Public function Const

const FRefer...

 

GetReferenceSkeleton()

Access to Asset's RefSkeleton.

Public function Const

const TArray...

 

GetRefPoseArray()

Pointer to RefPoseArray for current Asset.

Public function Const

const TArray...

 

GetRefPoseCompactArray()

Public function Const

const FTrans...

 

GetRefPoseTransform

(
    const FCompactPoseBoneIndex& BoneI...
)

Public function Const

const FRetar...

 

GetRetargetSourceCachedData

(
    const FName& InRetargetSource
)

Public function Const

USkeletalMes...

 

GetSkeletalMeshAsset()

Get SkeletalMesh Asset this BoneContainer was made for. Could be NULL if Asset is a Skeleton.

Public function Const

USkeleton &#...

 

GetSkeletonAsset()

Get Skeleton Asset.

Public function Const

int32

 

GetSkeletonIndex

(
    const FCompactPoseBoneIndex& BoneI...
)

Public function Const

TArray< int3...

 

GetSkeletonToPoseBoneIndexArray()

Const accessor to GetSkeletonToPoseBoneIndexArray().

Public function Const

TArray< uint...

 

GetUIDToArrayLookupTable()

Get UID To Array look up table

Public function Const

TArray< FAni...

 

GetUIDToCurveTypeLookupTable()

Get UID To curve type look up table

Public function Const

TArray< FNam...

 

GetUIDToNameLookupTable()

Get UID To Name look up table

Public function Const

const TArray...

 

GetVirtualBoneCompactPoseData()

Returns virutal bone cached data

Public function

void

 

InitializeTo

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

Initialize BoneContainer to a new Asset, RequiredBonesArray and RefPoseArray.

Public function Const

const bool

 

IsValid()

Returns true if FBoneContainer is Valid.

Public function Const

FCompactPose...

 

MakeCompactPoseIndex

(
    const FMeshPoseBoneIndex& BoneInde...
)

Public function Const

FMeshPoseBon...

 

MakeMeshPoseIndex

(
    const FCompactPoseBoneIndex& BoneI...
)

Public function

void

 

SetDisableRetargeting

(
    bool InbDisableRetargeting
)

Disable Retargeting for debugging.

Public function

void

 

SetRefPoseCompactArray

(
    const TArray< FTransform >& InRefP...
)

Public function

void

 

SetUseRAWData

(
    bool InbUseRAWData
)

Ignore compressed data and use RAW data instead, for debugging.

Public function

void

 

SetUseSourceData

(
    bool InbUseSourceData
)

Use Source data instead.

Public function Const

bool

 

ShouldUseRawData()

True if we're requesting RAW data instead of compressed data. For debugging.

Public function Const

bool

 

ShouldUseSourceData()

True if we're requesting Source data instead of RawAnimationData. For debugging.

References

Module

Engine

Header

Runtime/Engine/Public/BoneContainer.h

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