Navigation
API > API/Runtime > API/Runtime/AnimationCore
A simple container for per-vertex influence of bones and their weights.
| Name | FBoneWeights |
| Type | class |
| Header File | /Engine/Source/Runtime/AnimationCore/Public/BoneWeights.h |
| Include Path | #include "BoneWeights.h" |
Syntax
class FBoneWeights
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBoneWeights() |
BoneWeights.h |
Structs
| Name | Remarks |
|---|---|
| TArrayAdapter |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BoneWeightArrayT | TArray< FBoneWeight, BoneWeightsTempAllocatorT > | BoneWeights.h | |
| BoneWeightsTempAllocatorT | TInlineAllocator< MaxInlineBoneWeightCount > | BoneWeights.h | |
| FArrayWrapper | TBoneWeights< TArrayAdapter< BoneWeightArrayT > > | BoneWeights.h | |
| RangedForConstIteratorType | BoneWeightArrayT::RangedForConstIteratorType | Ranged-based for loop compatibility but only the const version. | BoneWeights.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoneWeights | BoneWeightArrayT | List of bone weights, in order of descending weight. | BoneWeights.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
RangedForConstIteratorType begin() |
BoneWeights.h | ||
RangedForConstIteratorType end() |
BoneWeights.h | ||
int32 FindWeightIndexByBone
(
FBoneIndexType InBoneIndex |
Find the bone weight corresponding to the given bone index. | BoneWeights.h | |
int32 GetTypeHash() |
BoneWeights.h | ||
int32 Num() |
Return the number of bone weights in this container. | BoneWeights.h | |
bool RemoveBoneWeight
(
FBoneIndexType InBone, |
Removes a specific bone from the list of weights, re-normalizing and pruning bones, if needed. | BoneWeights.h | |
void Renormalize
(
const FBoneWeightsSettings& InSettings |
Force normalization of weights. | BoneWeights.h | |
void Serialize
(
FArchive& InArchive |
BoneWeights.h | ||
bool SetBoneWeight
(
FBoneWeight InBoneWeight, |
Set a new bone weight. | BoneWeights.h | |
bool SetBoneWeight
(
FBoneIndexType InBone, |
BoneWeights.h | ||
TArrayView< const FBoneWeight > ToArrayView() |
Returns the FBoneWeight list as an array view | BoneWeights.h | |
FString ToString() |
BoneWeights.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FBoneWeights Blend
(
const FBoneWeights& InA, |
Blend two bone weights together, making sure to add in every influence from both, using the given settings. | BoneWeights.h | |
static FBoneWeights Blend
(
const FBoneWeights& InA, |
Blend three bone weights via barycentric coordinates using the given settings. | BoneWeights.h | |
static FBoneWeights Create
(
const FBoneIndexType* InBones, |
A helper to create a FBoneWeights container from separated bone index and weight arrays. | BoneWeights.h | |
static FBoneWeights Create
(
const FBoneIndexType InBones, |
A helper to create a FBoneWeights container from FSoftSkinVertex data structure. | BoneWeights.h | |
static FBoneWeights Create
(
TBoneWeights< OtherContainerAdapter > InBoneWeights, |
A helper to create FBoneWeights container from a TBoneWeights derivative object | BoneWeights.h | |
static FBoneWeights Create
(
TArrayView< const FBoneWeight > BoneWeights, |
A helper to create FBoneWeights container from a TArray of FBoneWeight objects. | BoneWeights.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FBoneWeights& InBoneWeight |
Returns true if this container's values are equal to the other container's values. | BoneWeights.h | |
const FBoneWeight & operator[]
(
int32 Index |
Return the weight at index Index. | BoneWeights.h | |
bool operator==
(
const FBoneWeights& InBoneWeight |
Returns true if all of this container's values and count are equal to the other container's values and count. | BoneWeights.h |