USkinWeightModifier

Navigation

API > API/Plugins > API/Plugins/SkeletalMeshModifiers

Inheritance Hierarchy

• UObjectBase
• UObjectBaseUtility
• UObject
• USkinWeightModifier

References

Syntax

UCLASS&40;BlueprintType&41;  
class USkinWeightModifier : public UObject  
Copy full snippet

UCLASS&40;BlueprintType&41; class USkinWeightModifier : public UObject

Remarks

API used to modify skin weights on a Skeletal Mesh asset.

To use:

Instantiate an instance of USkinWeightModifier

Call "SetSkeletalMesh(MyMeshAsset)", passing in the skeletal mesh you want to edit weights on

Use Get/Set weights functions, and Normalize/Prune to edit the weights as desired

When ready to commit to the asset, call CommitWeightsToSkeletalMesh() and save the asset if desired

This API can be used from C++, Blueprint or Python. Here is a sample usage of the API in Python:

import unreal

create a weight modifier for a given skeletal mesh

skel_mesh = unreal.EditorAssetLibrary().load_asset("/Game/Characters/Wolf/Meshes/SK_Wolf") weight_modifier = unreal.SkinWeightModifier() weight_modifier.set_skeletal_mesh(skel_mesh)

get weight of vertex 1234

vertex_weights = weight_modifier.get_vertex_weights(1234) print(vertex_weights)

remove neck2 as an influence on this vertex

vertex_weights.pop("neck2") weight_modifier.set_vertex_weights(vertex_weights, True) print(vertex_weights)

commit change to the skeletal mesh

weight_modifier.commit_weights_to_skeletal_mesh()

OUTPUT: {"head": 0.6, "neck1": 0.3, "neck2": 0.1} {"head": 0.6, "neck1": 0.3}

In Python, the per-vertex weights are stored as a dictionary mapping Bone Names to float weight values.

The "SetVertexWeights()" function expects the same data structure. You can add/remove/edit influences as needed. The SetVertexWeights() function does not normalize the weights. So you can make multiple modifications and call NormalizeVertexWeights() or NormalizeAllWeights() as desired.

The PruneVertexWeights() and EnforceMaxInfluences() functions can be used to trim small influences and clamp the total number of influences per vertex as needed.

Note that it is not required to normalize the weights by calling any of the normalize functions. Or manually before calling SetVertexWeights(). Committing the weights to the skeletal mesh will always enforce normalization.

Though it may be useful to normalize while editing.

Functions

Constants