UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
UE::AnimationCore::FBoneWeightsSettings Class Reference

#include <BoneWeights.h>

Public Member Functions

 FBoneWeightsSettings ()=default
 
FBoneWeightsSettings & SetNormalizeType (EBoneWeightNormalizeType InNormalizeType)
 
EBoneWeightNormalizeType GetNormalizeType () const
 
FBoneWeightsSettings & SetMaxWeightCount (int32 InMaxWeightCount)
 
int32 GetMaxWeightCount () const
 
FBoneWeightsSettings & SetWeightThreshold (float InWeightThreshold)
 
float GetWeightThreshold () const
 
uint16 GetRawWeightThreshold () const
 
void SetDefaultBoneIndex (FBoneIndexType InBoneIndex)
 
FBoneIndexType GetDefaultBoneIndex () const
 
void ClearDefaultBoneIndex ()
 
bool HasDefaultBoneIndex () const
 
void SetBlendZeroInfluence (bool bInBlendZeroInfluence)
 
bool GetBlendZeroInfluence () const
 

Constructor & Destructor Documentation

◆ FBoneWeightsSettings()

UE::AnimationCore::FBoneWeightsSettings::FBoneWeightsSettings ( )
default

Member Function Documentation

◆ ClearDefaultBoneIndex()

void UE::AnimationCore::FBoneWeightsSettings::ClearDefaultBoneIndex ( )
inline

Clears the default bone index. This allows bone weights arrays to be empty if no weights are set.

◆ GetBlendZeroInfluence()

bool UE::AnimationCore::FBoneWeightsSettings::GetBlendZeroInfluence ( ) const
inline

Return true if bones with no influence are considered to have a zero weight during the blend calculation.

◆ GetDefaultBoneIndex()

FBoneIndexType UE::AnimationCore::FBoneWeightsSettings::GetDefaultBoneIndex ( ) const
inline

Returns the current default bone index to set if no weights were set. If no default bone index has been set, then this value is undefined. Call HasDefaultBoneIndex to check

◆ GetMaxWeightCount()

int32 UE::AnimationCore::FBoneWeightsSettings::GetMaxWeightCount ( ) const
inline

Returns the maximum number of weights for these settings

◆ GetNormalizeType()

EBoneWeightNormalizeType UE::AnimationCore::FBoneWeightsSettings::GetNormalizeType ( ) const
inline

Returns the current normalization type for these settings

◆ GetRawWeightThreshold()

uint16 UE::AnimationCore::FBoneWeightsSettings::GetRawWeightThreshold ( ) const
inline

Returns the raw weight threshold. This is the value used internally for weight computation.

◆ GetWeightThreshold()

float UE::AnimationCore::FBoneWeightsSettings::GetWeightThreshold ( ) const
inline

Returns the weight threshold as a float value between (0, 1].

◆ HasDefaultBoneIndex()

bool UE::AnimationCore::FBoneWeightsSettings::HasDefaultBoneIndex ( ) const
inline

Returns true if a default bone index should be applied in the absence of other weights.

◆ SetBlendZeroInfluence()

void UE::AnimationCore::FBoneWeightsSettings::SetBlendZeroInfluence ( bool  bInBlendZeroInfluence)
inline

Set the way we treat the bones with zero influence during the blend. If true, we assume all bones with no influence have a zero weight (default) and participate in the blend calculation. If false, we ignore the bone during the blend.

◆ SetDefaultBoneIndex()

void UE::AnimationCore::FBoneWeightsSettings::SetDefaultBoneIndex ( FBoneIndexType  InBoneIndex)
inline

Set the default bone index to use if no weights were set. This can be used to ensure that there's always a valid weight applied to a skinned vertex.

◆ SetMaxWeightCount()

FBoneWeightsSettings & UE::AnimationCore::FBoneWeightsSettings::SetMaxWeightCount ( int32  InMaxWeightCount)
inline

Sets the maximum number of weights that can be applied to a single FBoneWeights object. When weights are added, the smallest weights, past this limit, are dropped.

◆ SetNormalizeType()

FBoneWeightsSettings & UE::AnimationCore::FBoneWeightsSettings::SetNormalizeType ( EBoneWeightNormalizeType  InNormalizeType)
inline

Set the normalization type when manipulating the weight values in FBoneWeights

◆ SetWeightThreshold()

FBoneWeightsSettings & UE::AnimationCore::FBoneWeightsSettings::SetWeightThreshold ( float  InWeightThreshold)
inline

Sets the minimum influence allowed. Any bone weight value below this threshold value is discarded. The threshold value is clamped to the half-closed interval (0, 1] since weight values of zero indicate no influence at all and are ignored completely. By default, all non-zero weights are allowed.

The documentation for this class was generated from the following file: