1. Epic GamesDeveloper
  3. FBoneContainer

FBoneContainer

This is a native transient structure.

API > API/Runtime > API/Runtime/Engine

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

  Type Name Description
Public function    
Public function  

FBoneContainer ( const TArrayView< const FBoneIndexType >& InRequiredBoneIndexArray,
const UE::Anim::FCurveFilterSettings& InCurveFilterSettings,
UObject& InAsset
)

  
Public function  

FBoneContainer ( const TArrayView< const FBoneIndexType >& InRequiredBoneIndexArray,
const FCurveEvaluationOption& CurveEvalOption,
UObject& InAsset
)

  

Functions

  Type Name Description
Public function Const bool

BoneIsChildOf ( const int32 BoneIndex,
const int32 ParentBoneIndex
)

 Returns true if bone is child of for current asset.
Public function Const bool

BoneIsChildOf ( const FCompactPoseBoneIndex& BoneIndex,
const FCompactPoseBoneIndex& ParentBoneIndex
)

 Returns true if bone is child of for current asset.
Public function void

CacheRequiredAnimCurves ( const UE::Anim::FCurveFilterSettings& InCurveFilterSettings
)

 Cache required Anim Curves
Public function void  
Public function Const bool

Contains ( FBoneIndexType NewIndex
)

 Returns true of RequiredBonesArray contains this bone index.
Public function Const void

FillWithCompactRefPose ( ArrayType& OutTransforms
)

 Fill the supplied buffer with the compact pose reference pose.
Public function Const FRangedForSupport< FCompactPoseBoneIndexIterator >  
Public function Const FRangedForReverseSupport< FCompactPoseBoneIndexReverseIterator >  
Public function Const UObject * Get Asset this BoneContainer was made for.
Public function Const const TArray< FBoneIndexType > & Returns array of the size of compact pose, mapping to mesh pose index returns Required Bone Indices Array
Public function Const const TBitArray & Returns Bone Switch Array. BitMask for RequiredBoneIndex array.
Public function Const int32 Get the LOD that we calculated required bones when regenerated
Public function Const FCompactPoseBoneIndex DEPRECATED - Ideally should use GetCompactPoseIndexFromSkeletonPoseIndex due to raw int32 here.
Public function Const FCompactPoseBoneIndex Map skeleton bone index to compact pose index
Public function Const const int32  
Public function Const const TArray< FCompactPoseBoneIndex > &  
Public function Const const UE::Anim::FCurveFilter & Get filter used for filtering by LOD/bone
Public function Const const UE::Anim::FBulkCurveFlags & Get flags to apply to curves (built from metadata)
Public function Const int32

GetDepthBetweenBones ( const int32 BoneIndex,
const int32 ParentBoneIndex
)

 Get Depth between bones for current asset.
Public function Const bool True if retargeting is disabled for debugging.
Public function Const FMeshPoseBoneIndex Map skeleton bone index to mesh index
Public function Const const int32 Number of Bones in RefPose for current asset.
Public function const FCachedSkeletonCurveMapping &

GetOrCreateCachedCurveMapping ( const FSkeletonRemapping* SkeletonRemapping
)

 Curve remapping.
Public function Const FCompactPoseBoneIndex Get ParentBoneIndex for current Asset.
Public function Const int32

GetParentBoneIndex ( const int32 BoneIndex
)

 Get ParentBoneIndex for current Asset.
Public function Const int32

GetPoseBoneIndexForBoneName ( const FName& BoneName
)

 Get BoneIndex for BoneName for current Asset.
Public function Const TArray< int32 > const & Const accessor to PoseToSkeletonBoneIndexArray.
Public function Const const FReferenceSkeleton & Access to Asset's RefSkeleton.
Public function Const const TArray< FTransform > & Pointer to RefPoseArray for current Asset.
Public function Const const FTransform &  
Public function Const const FRetargetSourceCachedData &

GetRetargetSourceCachedData ( const FName& InSourceName,
const FSkeletonRemapping& InRemapping,
const TArray< FTransform >& InRetargetTransforms
)

  
Public function Const const FRetargetSourceCachedData &

GetRetargetSourceCachedData ( const FName& InRetargetSource
)

  
Public function Const uint16 Get the serial number of this bone container.
Public function Const USkeletalMesh * Get SkeletalMesh Asset this BoneContainer was made for. Could be NULL if Asset is a Skeleton.
Public function Const USkeleton *

GetSkeletonAsset ( bool bEvenIfUnreachable
)

 Get Skeleton Asset.
Public function Const int32 DEPRECATED - Ideally should use GetSkeletonPoseIndexFromCompactPoseIndex due to raw int32 here.
Public function Const FSkeletonPoseBoneIndex Map compact bone index to skeleton index
Public function Const FSkeletonPoseBoneIndex Map mesh bone index to skeleton index
Public function Const TArray< int32 > const & Const accessor to SkeletonToPoseBoneIndexArray.
Public function Const int32  
Public function Const TArray< uint16 > const &  
Public function Const TArray< SmartName::UID_Type > const &  
Public function Const TArray< FAnimCurveType > const &  
Public function Const TArray< FName > const &  
Public function Const const TArray< FVirtualBoneCompactPoseData > & Returns virutal bone cached data
Public function void

InitializeTo ( const TArrayView< const FBoneIndexType >& InRequiredBoneIndexArray,
const FCurveEvaluationOption& CurveEvalOption,
UObject& InAsset
)

  
Public function void

InitializeTo ( const TArrayView< const FBoneIndexType >& InRequiredBoneIndexArray,
const UE::Anim::FCurveFilterSettings& InCurveFilterSettings,
UObject& InAsset
)

  
Public function Const bool Returns whether or not the skeleton index is contained in the mapping used to build this container.
Public function Const const bool

IsValid ()

 Returns true if FBoneContainer is Valid.
Public function Const FCompactPoseBoneIndexIterator  
Public function Const FCompactPoseBoneIndexReverseIterator  
Public function Const FCompactPoseBoneIndex  
Public function Const FCompactPoseBoneIndexIterator  
Public function Const FCompactPoseBoneIndexReverseIterator  
Public function Const FMeshPoseBoneIndex  
Public function void  
Public function void

Reset ()

 Resets the container and reclaims all allocated memory but preserve the serial number.
Public function void

SetDisableRetargeting ( bool InbDisableRetargeting
)

 Disable Retargeting for debugging.
Public function void

SetRefPoseOverride ( const TSharedPtr< FSkelMeshRefPoseOverride >& InRefPoseOverride
)

 Override skeleton ref pose.
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 True if we're requesting RAW data instead of compressed data. For debugging.
Public function Const bool True if we're requesting Source data instead of RawAnimationData. For debugging.

Classes

  Type Name Description
Public struct FRangedForReverseSupport    
Public struct FRangedForSupport    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page