1. Epic GamesDeveloper
  3. FBoneWeights

FBoneWeights

A simple container for per-vertex influence of bones and their weights.

API > API/Runtime > API/Runtime/AnimationCore

References

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

Syntax

class FBoneWeights

Remarks

A simple container for per-vertex influence of bones and their weights.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const RangedForConstIteratorType

begin ()

  
Public function Static FBoneWeights

Blend ( const FBoneWeights& InA,
const FBoneWeights& InB,
float InBias,
const FBoneWeightsSettings& InSettings
)

 Blend two bone weights together, making sure to add in every influence from both, using the given settings.
Public function Static FBoneWeights

Blend ( const FBoneWeights& InA,
const FBoneWeights& InB,
const FBoneWeights& InC,
float InBaryX,
float InBaryY,
float InBaryZ,
const FBoneWeightsSettings& InSettings
)

 Blend three bone weights via barycentric coordinates using the given settings.
Public function Static FBoneWeights

Create ( const FBoneIndexType* InBones,
const float* InWeights,
int32 NumEntries,
const FBoneWeightsSettings& InSettings
)

 A helper to create a FBoneWeights container from separated bone index and weight arrays.
Public function Static FBoneWeights

Create ( const FBoneIndexType InBones,
const uint16 InWeights,
const FBoneWeightsSettings& InSettings
)

 A helper to create a FBoneWeights container from FSoftSkinVertex data structure.
Public function Static FBoneWeights

Create ( TBoneWeights< OtherContainerAdapter > InBoneWeights,
const FBoneWeightsSettings& InSettings
)

 A helper to create FBoneWeights container from a TBoneWeights derivative object
Public function Static FBoneWeights

Create ( TArrayView< const FBoneWeight > BoneWeights,
const FBoneWeightsSettings& InSettings
)

 A helper to create FBoneWeights container from a TArray of FBoneWeight objects.
Public function Const RangedForConstIteratorType

end ()

  
Public function Const int32

FindWeightIndexByBone ( FBoneIndexType InBoneIndex
)

 Find the bone weight corresponding to the given bone index.
Public function Const int32  
Public function Const int32

Num ()

 Return the number of bone weights in this container.
Public function bool

RemoveBoneWeight ( FBoneIndexType InBone,
const FBoneWeightsSettings& InSettings
)

 Removes a specific bone from the list of weights, re-normalizing and pruning bones, if needed.
Public function void

Renormalize ( const FBoneWeightsSettings& InSettings
)

 Force normalization of weights.
Public function void

Serialize ( FArchive& InArchive
)

  
Public function bool

SetBoneWeight ( FBoneWeight InBoneWeight,
const FBoneWeightsSettings& InSettings
)

 Set a new bone weight.
Public function bool

SetBoneWeight ( FBoneIndexType InBone,
float InWeight,
const FBoneWeightsSettings& InSettings
)

  
Public function Const TArrayView< const FBoneWeight > Returns the FBoneWeight list as an array view
Public function Const FString  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FBoneWeights& InBoneWeight
)

 Returns true if this container's values are equal to the other container's values.
Public function Const const FBoneWeight &

operator[] ( int32 Index
)

 Return the weight at index Index.
Public function Const 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.

Typedefs

Name Description
BoneWeightArrayT  
BoneWeightsTempAllocatorT  
FArrayWrapper  
RangedForConstIteratorType Ranged-based for loop compatibility but only the const version.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page