1. Epic GamesDeveloper
  3. FBoneWeight

FBoneWeight

API > API/Runtime > API/Runtime/AnimationCore

   
Name FBoneWeight
Type class
Header File /Engine/Source/Runtime/AnimationCore/Public/BoneWeights.h
Include Path #include "BoneWeights.h"

Syntax

class FBoneWeight

Constructors

Name Remarks Include Path Unreal Specifiers

FBoneWeight ( FBoneIndexType InBoneIndex,
uint8 InWeight
)

 A constructor for old-style bone weights where the weight was stored as an unsigned eight bit integer. BoneWeights.h  
Default constructor. NOTE: The values are uninitialized. BoneWeights.h  

FBoneWeight ( FBoneIndexType InBoneIndex,
uint16 InRawWeight
)

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

FBoneWeight ( FBoneIndexType InBoneIndex,
float InWeight
)

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

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BoneIndex FBoneIndexType   BoneWeights.h  
RawWeight uint16   BoneWeights.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FBoneIndexType GetBoneIndex()

 Returns the bone stored index. BoneWeights.h  

uint16 GetRawWeight()

 Returns the stored weight in the container's raw format, avoiding floating point conversion. BoneWeights.h  

uint32 GetTypeHash()

 Returns a hash value from the bone weight values BoneWeights.h  

float GetWeight()

 Returns the stored weight value as a float in the [0-1] range. BoneWeights.h  

void Serialize ( FArchive& InArchive
)

   BoneWeights.h  

void SetBoneIndex ( FBoneIndexType InBoneIndex
)

 Set the bone stored index. BoneWeights.h  

void SetRawWeight ( const uint16 InRawWeight
)

 Set the stored weight in the raw format. This avoids any floating point conversion. BoneWeights.h  

void SetWeight ( float InWeight
)

 Set stored weight as a float. BoneWeights.h  

int32 ToInt32()

 Returns the contents of this object as an int32. BoneWeights.h  

FString ToString()

 A helper function to return a human-readable version of the bone weight. BoneWeights.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool DescSortByWeightPredicate ( const FBoneWeight& A,
const FBoneWeight& B
)

 A standard predicate we use for sorting by weight, in a descending order of weights BoneWeights.h  

static FBoneWeight FromInt32 ( int32 InBoneWeight
)

 Converts an int32 to an FBoneWeight object and returns it. BoneWeights.h  

static uint16 GetMaxRawWeight()

 The maximum raw weight value for a bone influence. BoneWeights.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FBoneWeight& InBoneWeight
) const

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

bool operator== ( const FBoneWeight& InBoneWeight
) const

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page