1. Epic GamesDeveloper
  3. USkinWeightsPaintTool

USkinWeightsPaintTool

An interactive tool for painting and editing skin weights.

API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnlyExp > API/Plugins/MeshModelingToolsEditorOnlyExp/SkeletalMesh

Inheritance Hierarchy

References

   
Module MeshModelingToolsEditorOnlyExp
Header /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnlyExp/Public/SkeletalMesh/SkinWeightsPaintTool.h
Include #include "SkeletalMesh/SkinWeightsPaintTool.h"

Syntax

UCLASS ()  
class USkinWeightsPaintTool :  
    public UDynamicMeshBrushTool ,  
    public ISkeletalMeshEditingInterface

Remarks

An interactive tool for painting and editing skin weights.

Variables

  Type Name Description
Protected variable TUniquePtr< SkinPaintTool::FMeshSkinWeightsChange > ActiveChange Storage for weight edits in the current transaction
Protected variable bool bBoneColorsToRestore  
Protected variable bool bInvertStroke  
Protected variable bool bStampPending  
Protected variable bool bVertexColorsNeedUpdated  
Protected variable FName CurrentBone  
Protected variable EMeshLODIdentifier CurrentlyEditedLOD  
Protected variable TMap< EMeshLODIdentifier, FCleanedEditMesh > EditedMeshes The currently edited mesh descriptions
Protected variable UProperty TWeakObjectPtr< USkeletalMeshEditorContextObjectBase > EditorContext Global properties stored on initialization
Protected variable FBrushStampData LastStamp  
Protected variable UProperty TObjectPtr< UWeightToolMeshSelector > MeshSelector The selection system for the main mesh
Protected variable SkinPaintTool::FSkinMirrorData MirrorData Cached mirror data
Public variable FOnSelectionChanged OnSelectionChanged  
Public variable FOnWeightsChanged OnWeightsChanged  
Protected variable TOptional< FName > PendingCurrentBone  
Protected variable UProperty TWeakObjectPtr< UPersonaEditorModeManagerContext > PersonaModeManagerContext  
Protected variable FString PreviewProfileToRestore Editor state to restore when exiting the paint tool
Protected variable TArray< BoneIndex > SelectedBoneIndices  
Protected variable TArray< FName > SelectedBoneNames  
Protected variable UProperty TObjectPtr< UWeightToolSelectionIsolator > SelectionIsolator Manages isolating a selection of the mesh
Protected variable TUniquePtr< UE::Geometry::TBoneWeightsDataSource< int32, float > > SmoothWeightsDataSource Smooth weights data source and operator.
Protected variable TUniquePtr< UE::Geometry::TSmoothBoneWeights< int32, float > > SmoothWeightsOp  
Protected variable FVector StampLocalPos  
Protected variable FBrushStampData StartStamp  
Protected variable UProperty TWeakObjectPtr< UToolTargetManager > TargetManager  
Protected variable UProperty TObjectPtr< UWeightToolTransferManager > TransferManager Manages transferring skin weights from a separate mesh
Protected variable TFuture< void > TriangleOctreeFuture  
Protected variable TUniquePtr< DynamicTrianglesOctree > TrianglesOctree  
Protected variable TArray< int32 > TrianglesToReinsert  
Protected variable int32 TriangleUnderStamp  
Protected variable TUniquePtr< DynamicVerticesOctree > VerticesOctree  
Protected variable TSet< int32 > VerticesToUpdateColor  
Protected variable SkinPaintTool::FSkinToolWeights Weights Storage of vertex weights per bone
Protected variable UProperty TObjectPtr< USkinWeightsPaintToolProperties > WeightToolProperties Tool properties

Functions

  Type Name Description
Public function 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!)
Protected function Virtual void

ApplyStamp ( const FBrushStampData& Stamp
)

  
Public function void

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

 "One-off" Edits: For all one-and-done edits, you can call ApplyWeightEditsAsTransaction().
Public function void  
Public function void

AverageWeights ( const float Strength
)

  
Public function void HOW TO EDIT WEIGHTS WITH UNDO/REDO:
Protected function Const float

CalculateBrushFalloff ( float Distance
)

 Stamp
Protected function Const float  
Protected function void

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

  
Public function void Copy paste
Protected function 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
Protected function 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)
Public function 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)
Public function void

EndChange ( const FText& TransactionLabel
)

  
Public function void

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

  
Public function void

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

  
Public function void

ExternalUpdateSkinWeightLayer ( const EMeshLODIdentifier InLOD,
const FName InSkinWeightProfile
)

  
Public function void

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

 Using when ToolChange is applied via Undo/Redo
Public function UWeightToolMeshSelector * Get access to the currently active mesh selector (may be on the transfer source mesh)
Public function float

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

 Get the average weight value of a single bone on the given vertices
Protected function Const BoneIndex

GetBoneIndexFromName ( const FName BoneName
)

  
Public function Const FName Convert an index to a name
Protected function Const FVector4f

GetColorOfVertex ( VertexIndex InVertexIndex,
BoneIndex InBoneIndex
)

  
Public function Const BoneIndex Get the currently selected bone
Public function Const FCleanedEditMesh * Get access to the mesh description for the mesh being edited
Public function Const FDynamicMesh3 *  
Public function Const FMeshDescription *  
Public function void

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

 Get the average weight value of each influence on the given vertices
Public function UWeightToolMeshSelector * Get access to the mesh selector for the main mesh
Public function Const UWeightToolSelectionIsolator * Get access to the selection isolation system
Public function Const UToolTargetManager * Get the target manager (cached from Setup)
Public function Const void

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

 Get a list of vertices affected by the given bone
Public function Const FEditorViewportClient * Get the viewport this tool is operating in
Public function SkinPaintTool::FSkinToolWeights & Allows outside systems to access the weight data
Public function Const USkinWeightsPaintToolProperties * Get the tool properties
Public function Const UWeightToolTransferManager * Get access to the weight tranfer system
Public function void  
Public function bool Does the main mesh have an active selection ("active" meaning the selection is currently being rendered in the view and is editable)
Public function void

Init ( const FToolBuilderState& InSceneState
)

  
Protected function void  
Protected function void  
Protected function Const bool

IsProfileValid ( const FName InProfileName
)

  
Public function void Weight editing operations (selection based)
Public function 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
Public function void  
Protected function void Skin weight layer
Protected function void  
Protected function void  
Public function void  
Public function void

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

  
Public function Const void Select all vertices affected by the currently selected bone(s)
Public function void

SetDisplayVertexColors ( bool bShowVertexColors
)

 Toggle the display of weights on the preview mesh (if false, uses the normal skeletal mesh material)
Public function Const void Set focus back to viewport so that hotkeys are immediately detected while hovering
Public function void Toggle brush / selection mode
Public function Static void

TruncateWeightMap ( TMap< BoneIndex, float >& InOutWeights
)

 HELPER functions for modifying weights
Protected function void

UpdateCurrentBone ( const FName& BoneName
)

 Which bone are we currently painting?
Public function void

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

 Call this whenever the target mesh is modified
Public function Const void Update the state of the mesh selectors
Protected function void Vertex colors updated when switching current bone or initializing whole mesh
Protected function void Vertex colors updated when make sparse edits to subset of vertices

Overridden from UDynamicMeshBrushTool

  Type Name Description
Protected function Virtual void

OnShutdown ( EToolShutdownType ShutdownType
)

 Subclasses can override these to customize behavior

Overridden from UBaseBrushTool

  Type Name Description
Public function Virtual double Subclasses should implement this to give an estimate of target dimension for brush size scaling

Overridden from UMeshSurfacePointTool

  Type Name Description
Public function Virtual bool

HitTest ( const FRay& Ray,
FHitResult& OutHit
)

  
Public function Virtual void

OnBeginDrag ( const FRay& Ray
)

 UMeshSurfacePointTool implementation.
Public function Virtual void

OnEndDrag ( const FRay& Ray
)

 This function is called when the user releases the button driving a click-drag-release interaction
Public function Virtual void

OnUpdateDrag ( const FRay& Ray
)

 This function is called each frame that the user is in a click-drag-release interaction

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

 Allow the Tool to do any custom screen space drawing
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual void

OnPropertyModified ( UObject* ModifiedObject,
FProperty* ModifiedProperty
)

 Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
Protected function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 UInteractiveTool.

Overridden from IInteractiveToolCameraFocusAPI

  Type Name Description
Public function Virtual FBox  
Public function Virtual bool IInteractiveToolCameraFocusAPI.

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IClickDragBehaviorTarget implementation.

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 IClickDragBehaviorTarget implementation.

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Overridden from ISkeletalMeshEditingInterface

  Type Name Description
Protected function Virtual void

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

  

Typedefs

Name Description
DynamicTrianglesOctree  
DynamicVerticesOctree Used to accelerate mesh queries
FOnSelectionChanged Called whenever the selection is modified
FOnWeightsChanged Called whenever the weights are modified

Constants

Name Description
CopyPasteWeightsIdentifier  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page