1. Epic GamesDeveloper
  3. USkinWeightsPaintTool

USkinWeightsPaintTool

An interactive tool for painting and editing skin weights.

API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnly

An interactive tool for painting and editing skin weights.

   
Name USkinWeightsPaintTool
Type class
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/SkeletalMesh/SkinWeightsPaintTool.h
Include Path #include "SkeletalMesh/SkinWeightsPaintTool.h"

Syntax

UCLASS ()  
class USkinWeightsPaintTool :  
    public UDynamicMeshBrushTool ,  
    public ISkeletalMeshEditingInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Typedefs

Name Type Remarks Include Path
DynamicTrianglesOctree UE::Geometry::FDynamicMeshOctree3   SkeletalMesh/SkinWeightsPaintTool.h
DynamicVerticesOctree UE::Geometry::TDynamicVerticesOctree3< FDynamicMesh3 > Used to accelerate mesh queries SkeletalMesh/SkinWeightsPaintTool.h
FOnSelectionChanged TMulticastDelegate_NoParams< void > Called whenever the selection is modified SkeletalMesh/SkinWeightsPaintTool.h
FOnWeightsChanged TMulticastDelegate_NoParams< void > Called whenever the weights are modified SkeletalMesh/SkinWeightsPaintTool.h

Constants

Name Type Remarks Include Path
CopyPasteWeightsIdentifier const FString   SkeletalMesh/SkinWeightsPaintTool.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnSelectionChanged FOnSelectionChanged   SkeletalMesh/SkinWeightsPaintTool.h  
OnWeightsChanged FOnWeightsChanged   SkeletalMesh/SkinWeightsPaintTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyWeightEditsAsTransaction ( const SkinPaintTool::FMultiBoneWeightEdits& WeightEdits,
const FText& TransactionLabel
)

 "One-off" Edits: For all one-and-done edits, you can call ApplyWeightEditsAsTransaction(). SkeletalMesh/SkinWeightsPaintTool.h  

void ApplyWeightEditsWithoutTransaction ( const SkinPaintTool::FMultiBoneWeightEdits& WeightEdits
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void AverageWeights ( const float Strength
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void BeginChange ()

 HOW TO EDIT WEIGHTS WITH UNDO/REDO: SkeletalMesh/SkinWeightsPaintTool.h  

void ClampInfluences ( const int32 MaxInfluences
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void CopyWeights()

 Copy paste SkeletalMesh/SkinWeightsPaintTool.h  

void EditWeightsOnVertices ( BoneIndex Bone,
const float Value,
const int32 Iterations,
EWeightEditOperation EditOperation,
const TArray< VertexIndex >& VerticesToEdit,
const bool bShouldTransact
)

 Method to set weights directly (numeric input, for example) SkeletalMesh/SkinWeightsPaintTool.h  

void EndChange ( const FText& TransactionLabel
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void ExternalAddInfluenceToVertices ( const BoneIndex InfluenceToAdd,
const TArray< VertexIndex >& Vertices
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void ExternalRemoveInfluenceFromVertices ( const BoneIndex InfluenceToRemove,
const TArray< VertexIndex >& Vertices
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void ExternalUpdateSkinWeightLayer ( const EMeshLODIdentifier InLOD,
const FName InSkinWeightProfile
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void ExternalUpdateWeights ( const int32 BoneIndex,
const TMap< int32, float >& IndexValues
)

 Using when ToolChange is applied via Undo/Redo SkeletalMesh/SkinWeightsPaintTool.h  

UWeightToolMeshSelector * GetActiveMeshSelector()

 Get access to the currently active mesh selector (may be on the transfer source mesh) SkeletalMesh/SkinWeightsPaintTool.h  

float GetAverageWeightOnBone ( const BoneIndex InBoneIndex,
const TArray< int32 >& VertexIndices
)

 Get the average weight value of a single bone on the given vertices SkeletalMesh/SkinWeightsPaintTool.h  

FName GetBoneNameFromIndex ( BoneIndex InIndex
) const

 Convert an index to a name SkeletalMesh/SkinWeightsPaintTool.h  

BoneIndex GetCurrentBoneIndex()

 Get the currently selected bone SkeletalMesh/SkinWeightsPaintTool.h  

FCleanedEditMesh * GetCurrentCleanedEditMesh()

 Get access to the mesh description for the mesh being edited SkeletalMesh/SkinWeightsPaintTool.h  

FDynamicMesh3 * GetCurrentlyEditedDynamicMesh()

   SkeletalMesh/SkinWeightsPaintTool.h  

FMeshDescription * GetCurrentlyEditedMeshDescription()

   SkeletalMesh/SkinWeightsPaintTool.h  

void GetInfluences ( const TArray< int32 >& VertexIndices,
TArray< BoneIndex >& OutBoneIndices
)

 Get the average weight value of each influence on the given vertices SkeletalMesh/SkinWeightsPaintTool.h  

UWeightToolMeshSelector * GetMainMeshSelector()

 Get access to the mesh selector for the main mesh SkeletalMesh/SkinWeightsPaintTool.h  

UWeightToolSelectionIsolator * GetSelectionIsolator()

 Get access to the selection isolation system SkeletalMesh/SkinWeightsPaintTool.h  

UToolTargetManager * GetTargetManager()

 Get the target manager (cached from Setup) SkeletalMesh/SkinWeightsPaintTool.h  

void GetVerticesAffectedByBone ( BoneIndex IndexOfBone,
TSet< int32 >& OutVertexIndices
) const

 Get a list of vertices affected by the given bone SkeletalMesh/SkinWeightsPaintTool.h  

virtual FEditorViewportClient * GetViewportClient()

 Get the viewport this tool is operating in SkeletalMesh/SkinWeightsPaintTool.h  
Allows outside systems to access the weight data SkeletalMesh/SkinWeightsPaintTool.h  

USkinWeightsPaintToolProperties * GetWeightToolProperties()

 Get the tool properties SkeletalMesh/SkinWeightsPaintTool.h  

UWeightToolTransferManager * GetWeightTransferManager()

 Get access to the weight tranfer system SkeletalMesh/SkinWeightsPaintTool.h  

void HammerWeights()

   SkeletalMesh/SkinWeightsPaintTool.h  

bool HasActiveSelectionOnMainMesh()

 Does the main mesh have an active selection ("active" meaning the selection is currently being rendered in the view and is editable) SkeletalMesh/SkinWeightsPaintTool.h  

void Init ( const FToolBuilderState& InSceneState
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void MirrorWeights ( EAxis::Type Axis,
EMirrorDirection Direction
)

 Weight editing operations (selection based) SkeletalMesh/SkinWeightsPaintTool.h  

void NormalizeWeights()

   SkeletalMesh/SkinWeightsPaintTool.h  

void PasteWeights()

   SkeletalMesh/SkinWeightsPaintTool.h  

void PruneWeights ( const float Threshold,
const TArray< BoneIndex >& BonesToPrune
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SelectAffected()

 Select all vertices affected by the currently selected bone(s) SkeletalMesh/SkinWeightsPaintTool.h  

void SelectByInfluenceCount ( const int32 MinInfluences
) const

 Select all vertices affected by at least MinInfluences number of bones SkeletalMesh/SkinWeightsPaintTool.h  

void SetDisplayVertexColors ( bool bShowVertexColors
)

 Toggle the display of weights on the preview mesh (if false, uses the normal skeletal mesh material) SkeletalMesh/SkinWeightsPaintTool.h  

void SetFocusInViewport()

 Set focus back to viewport so that hotkeys are immediately detected while hovering SkeletalMesh/SkinWeightsPaintTool.h  

void ToggleEditingMode()

 Toggle brush / selection mode SkeletalMesh/SkinWeightsPaintTool.h  

void UpdateCurrentlyEditedMesh ( const USkeletalMeshComponent* Component,
const FDynamicMesh3& InDynamicMesh,
const FMeshDescription& InMeshDescription
)

 Call this whenever the target mesh is modified SkeletalMesh/SkinWeightsPaintTool.h  

void UpdateSelectorState()

 Update the state of the mesh selectors SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from UBaseBrushTool

Name Remarks Include Path Unreal Specifiers

virtual double EstimateMaximumTargetDimension()

   SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from UMeshSurfacePointTool

Name Remarks Include Path Unreal Specifiers

virtual bool HitTest ( const FRay& Ray,
FHitResult& OutHit
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void OnBeginDrag ( const FRay& Ray
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void OnEndDrag ( const FRay& Ray
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void OnUpdateDrag ( const FRay& Ray
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual bool HasAccept()

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual bool HasCancel()

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void Setup()

 UInteractiveTool. SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from IInteractiveToolCameraFocusAPI

Name Remarks Include Path Unreal Specifiers

virtual FBox GetWorldSpaceFocusBox()

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual bool SupportsWorldSpaceFocusBox()

 IInteractiveToolCameraFocusAPI. SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from IClickDragBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit CanBeginClickDragSequence ( const FInputDeviceRay& InPressPos
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 IClickDragBehaviorTarget implementation. SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyStamp ( const FBrushStampData& Stamp
)

   SkeletalMesh/SkinWeightsPaintTool.h  

float CalculateBrushFalloff ( float Distance
) const

 Stamp SkeletalMesh/SkinWeightsPaintTool.h  

float CalculateBrushStrengthToUse ( EWeightEditOperation EditMode
) const

   SkeletalMesh/SkinWeightsPaintTool.h  

void CalculateVertexROI ( const FBrushStampData& InStamp,
TArray< VertexIndex >& OutVertexIDs,
TArray< float >& OutVertexFalloffs
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void CreateWeightEditsForVertices ( EWeightEditOperation EditOperation,
const BoneIndex Bone,
const TArray< int32 >& VerticesToEdit,
const TArray< float >& VertexFalloffs,
const float InValue,
SkinPaintTool::FMultiBoneWeightEdits& InOutWeightEdits
)

 Generating bone weight edits to be stored in a transaction does not actually change the weight buffers SkeletalMesh/SkinWeightsPaintTool.h  

void CreateWeightEditsToRelaxVertices ( TArray< int32 > VerticesToEdit,
TArray< float > VertexFalloffs,
const float Strength,
const int32 Iterations,
SkinPaintTool::FMultiBoneWeightEdits& InOutWeightEdits
)

 Same as CreateWeightEditsForVertices() but specific to relaxation (topology aware operation) SkeletalMesh/SkinWeightsPaintTool.h  

BoneIndex GetBoneIndexFromName ( const FName BoneName
) const

   SkeletalMesh/SkinWeightsPaintTool.h  

FVector4f GetColorOfVertex ( VertexIndex InVertexIndex,
BoneIndex InBoneIndex
) const

   SkeletalMesh/SkinWeightsPaintTool.h  

void InitializeOctrees()

   SkeletalMesh/SkinWeightsPaintTool.h  

void InitializeSmoothWeightsOperator()

   SkeletalMesh/SkinWeightsPaintTool.h  

bool IsProfileValid ( const FName InProfileName
) const

   SkeletalMesh/SkinWeightsPaintTool.h  

void OnActiveLODChanged()

 Skin weight layer SkeletalMesh/SkinWeightsPaintTool.h  

void OnActiveSkinWeightProfileChanged()

   SkeletalMesh/SkinWeightsPaintTool.h  

void OnNewSkinWeightProfileChanged()

   SkeletalMesh/SkinWeightsPaintTool.h  

void UpdateCurrentBone ( const FName& BoneName
)

 Which bone are we currently painting? SkeletalMesh/SkinWeightsPaintTool.h  

void UpdateVertexColorForAllVertices()

 Vertex colors updated when switching current bone or initializing whole mesh SkeletalMesh/SkinWeightsPaintTool.h  

void UpdateVertexColorForSubsetOfVertices()

 Vertex colors updated when make sparse edits to subset of vertices SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from UDynamicMeshBrushTool

Name Remarks Include Path Unreal Specifiers

virtual void OnShutdown ( EToolShutdownType ShutdownType
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual void OnPropertyModified ( UObject* ModifiedObject,
FProperty* ModifiedProperty
)

   SkeletalMesh/SkinWeightsPaintTool.h  

virtual void OnTick ( float DeltaTime
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Overridden from ISkeletalMeshEditingInterface

Name Remarks Include Path Unreal Specifiers

virtual void HandleSkeletalMeshModified ( const TArray< FName >& InBoneNames,
const ESkeletalMeshNotifyType InNotifyType
)

   SkeletalMesh/SkinWeightsPaintTool.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AccumulateWeights ( const TArray< SkinPaintTool::VertexWeights >& AllWeights,
const TArray< VertexIndex >& VerticesToAccumulate,
TMap< BoneIndex, float >& OutWeights
)

 Sum all the weights on all bones for a given list of vertices (results we not be normalized!) SkeletalMesh/SkinWeightsPaintTool.h  

static void NormalizeWeightMap ( TMap< BoneIndex, float >& InOutWeights
)

 Given a map of BoneIndex > Weight values for a single vertex, modify the weights to sum to 1 SkeletalMesh/SkinWeightsPaintTool.h  

static void TruncateWeightMap ( TMap< BoneIndex, float >& InOutWeights
)

 HELPER functions for modifying weights SkeletalMesh/SkinWeightsPaintTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page