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&40;&41;  
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  
Protected variable bool bInvertStroke  
Protected variable bool bSmoothStroke  
Protected variable bool bStampPending  
Protected variable bool bVisibleWeightsValid  
Protected variable FName CurrentBone  
Protected variable TUniquePtr< FMeshDescription > EditedMesh The currently edited mesh description
Protected variable UProperty TWeakObjectPtr< USkeletalMeshEditorContextObjectBase > EditorContext  
Protected variable FBrushStampData LastStamp  
Protected variable TUniquePtr< UE::Geometry::FDynamicMeshAABBTree3 > MeshSpatial  
Protected variable SkinPaintTool::FSkinMirrorData MirrorData Cached mirror data
Protected variable TOptional< FName > PendingCurrentBone  
Protected variable UProperty TObjectPtr< UPolygonSelectionMechanic > PolygonSelectionMechanic Polygon selection mechanic
Protected variable TArray< BoneIndex > SelectedBoneIndices  
Protected variable TArray< FName > SelectedBoneNames  
Protected variable TUniquePtr< UE::Geometry::FTriangleGroupTopology > SelectionTopology  
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 TFuture< void > TriangleOctreeFuture  
Protected variable UE::Geometry::FDynamicMeshOctree3 TrianglesOctree  
Protected variable TArray< int32 > TrianglesToReinsert  
Protected variable int32 TriangleUnderStamp  
Protected variable UE::Geometry::TDynamicVerticesOctree3< FDynamicMesh3 > VerticesOctree Used to accelerate mesh queries
Protected variable SkinPaintTool::FSkinToolWeights Weights Storage of vertex weights per bone
Protected variable UProperty TObjectPtr< USkinWeightsPaintToolProperties > WeightToolProperties Tool properties

Functions

  Type Name Description
Protected function Virtual void

ApplyStamp ( const FBrushStampData& Stamp
)

  
Protected function void

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

 Used to apply manual weight modifications (not from the brush)
Public function void  
Protected function void Weight editing transactions
Protected function Const float

CalculateBrushFalloff ( float Distance
)

 Stamp
Protected function Const float  
Protected function void

CalculateVertexROI ( const FBrushStampData& Stamp,
TArray< VertexIndex >& VertexIDs,
TArray< float >& VertexFalloffs
)

  
Protected function void

EditWeightOnVertices ( EWeightEditOperation EditOperation,
const TArray< int32 >& VerticesToEdit,
const TArray< float >& VertexFalloffs,
const float UseStrength,
SkinPaintTool::FMultiBoneWeightEdits& InOutWeightEdits
)

 Modify vertex weights according to the specified operation, generating bone weight edits to be stored in a transaction
Protected function TUniquePtr< SkinPaintTool::FMeshSkinWeightsChange >  
Public function void

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

  
Public function void

FloodWeights ( const float Weight,
const EWeightEditOperation FloodMode
)

  
Protected function Const BoneIndex

GetBoneIndexFromName ( const FName BoneName
)

  
Protected function Const void

GetVerticesToEdit ( TArray< VertexIndex >& OutVertexIndices
)

 Determines the set of vertices to operate on, using selection as the priority
Public function void

Init ( const FToolBuilderState& InSceneState
)

  
Public function void Weight editing operations (selection based)
Public function void  
Protected function void  
Public function void

PruneWeights ( const float Threshold
)

  
Protected function void

RelaxWeightOnVertices ( TArray< int32 > VerticesToEdit,
TArray< float > VertexFalloffs,
const float UseStrength,
SkinPaintTool::FMultiBoneWeightEdits& InOutWeightEdits
)

 Same as EditWeightOfVertices() but specific to relaxation (topology aware operation)
Public function void Toggle brush / selection mode
Protected function void

UpdateCurrentBone ( const FName& BoneName
)

 Which bone are we currently painting?
Protected function void Vertex colors updated when switching current bone or editing weights
Protected function Const FVector4f

WeightToColor ( float Value
)

  

Overridden from UDynamicMeshBrushTool

  Type Name Description
Protected function Virtual void

OnShutdown ( EToolShutdownType ShutdownType
)

 Subclasses can override these to customize behavior

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* PropertySet,
FProperty* Property
)

 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 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
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page