1. Epic GamesDeveloper
  3. FSkinToolWeights

FSkinToolWeights

Intermediate storage of the weight maps for duration of tool

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

References

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

Syntax

struct FSkinToolWeights

Remarks

Intermediate storage of the weight maps for duration of tool

Variables

  Type Name Description
Public variable TArray< VertexWeights > CurrentWeights  
Public variable FSkinToolDeformer Deformer Update deformation when vertex weights are modified
Public variable TArray< bool > IsBoneWeighted Record which bones have any weight assigned to them
Public variable TArray< float > MaxFalloffPerVertexThisStroke Record the current maximum amount of falloff applied to each vertex during the current stroke values range from 0-1, this allows brushes to sweep over the same vertex, and apply only the maximum amount of modification (add/replace/relax etc) that was encountered for the duration of the stroke.
Public variable TArray< VertexWeights > PreChangeWeights Double-buffer of the entire weight matrix (stored sparsely for fast deformation) "Pre" is state of weights at stroke start "Current" is state of weights during stroke When stroke is over, PreChangeWeights are synchronized with CurrentWeights
Public variable FName Profile Which skin profile is currently edited

Functions

  Type Name Description
Public function void

AddNewInfluenceToVertex ( const VertexIndex VertexID,
const BoneIndex BoneIndex,
const float Weight,
TArray< VertexWeights >& InOutVertexWeights
)

  
Public function void  
Public function void  
Public function void

CreateWeightEditForVertex ( const int32 BoneIndex,
const int32 VertexId,
float NewWeightValue,
FMultiBoneWeightEdits& WeightEdits
)

 Applies an edit to a single vertex weight on a single bone, then normalizes the remaining weights while keeping the edited weight intact (ie, adapts OTHER influences to achieve normalization)
Public function Static void

FillWeightEdit ( const int32 BoneIndex,
const int32 VertexID,
const float NewWeight,
const TArray< VertexWeights >& InVertexWeights
)

  
Public function BoneIndex  
Public function Static float

GetWeightOfBoneOnVertex ( const int32 BoneIndex,
const int32 VertexID,
const TArray< VertexWeights >& InVertexWeights
)

  
Public function void

InitializeSkinWeights ( const USkeletalMeshComponent* SkeletalMeshComponent,
const FMeshDescription* Mesh
)

 Copy the initial weight values from the skeletal mesh
Public function void

RemoveInfluenceFromVertex ( const VertexIndex VertexID,
const BoneIndex BoneID,
TArray< VertexWeights >& InOutVertexWeights
)

  
Public function float

SetCurrentFalloffAndGetMaxFalloffThisStroke ( int32 VertexID,
float CurrentStrength
)

  
Public function void

SetWeightOfBoneOnVertex ( const int32 BoneIndex,
const int32 VertexID,
const float Weight,
TArray< VertexWeights >& InOutVertexData
)

  
Public function void Some weight editing operations are RELATIVE to existing weights before the change started (Multiply, Add etc) these "existing weights" are stored in the PreChangeWeights buffer PreChange and Current buffers must be synchronized after a transaction
Public function void

UpdateIsBoneWeighted ( BoneIndex BoneToUpdate
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page