1. Epic GamesDeveloper
  3. FBoneWeight

FBoneWeight

API > API/Runtime > API/Runtime/AnimationCore

References

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

Syntax

class FBoneWeight

Constructors

  Type Name Description
Public function   Default constructor. NOTE: The values are uninitialized.
Public function  

FBoneWeight ( FBoneIndexType InBoneIndex,
uint8 InWeight
)

 A constructor for old-style bone weights where the weight was stored as an unsigned eight bit integer.
Public function  

FBoneWeight ( FBoneIndexType InBoneIndex,
uint16 InRawWeight
)

 A constructor for bone weights where the weight is stored as an unsigned sixteen bit integer.
Public function  

FBoneWeight ( FBoneIndexType InBoneIndex,
float InWeight
)

 A constructor for bone weights which converts the weight from a float value in the [0-1] range.

Functions

  Type Name Description
Public function Static bool A standard predicate we use for sorting by weight, in a descending order of weights
Public function Static FBoneWeight

FromInt32 ( int32 InBoneWeight
)

 Converts an int32 to an FBoneWeight object and returns it.
Public function Const FBoneIndexType Returns the bone stored index.
Public function Static constexpr FBoneIndexType The maximum raw weight value for a bone influence.
Public function Const uint16 Returns the stored weight in the container's raw format, avoiding floating point conversion.
Public function Const uint32 Returns a hash value from the bone weight values
Public function Const float Returns the stored weight value as a float in the [0-1] range.
Public function void

Serialize ( FArchive& InArchive
)

  
Public function void

SetBoneIndex ( FBoneIndexType InBoneIndex
)

 Set the bone stored index.
Public function void

SetRawWeight ( const uint16 InRawWeight
)

 Set the stored weight in the raw format. This avoids any floating point conversion.
Public function void

SetWeight ( float InWeight
)

 Set stored weight as a float.
Public function Const int32

ToInt32 ()

 Returns the contents of this object as an int32.
Public function Const FString A helper function to return a human-readable version of the bone weight.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FBoneWeight& InBoneWeight
)

 Returns true if this object's bone weight values are not equal to the other container's values.
Public function Const bool

operator== ( const FBoneWeight& InBoneWeight
)

 Returns true if this object's bone weight values are equal to the other container's values.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page