USkinWeightsPaintToolProperties

Container for properties displayed in Details panel while using [USkinWeightsPaintTool](API\Plugins\MeshModelingToolsEditorOnly\USkinWeightsPaintTool).

API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnly

Container for properties displayed in Details panel while using USkinWeightsPaintTool.

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

Syntax

UCLASS (MinimalAPI, Config=EditorSettings)  
class USkinWeightsPaintToolProperties : public UBrushBaseProperties

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USkinWeightsPaintToolProperties()

   SkeletalMesh/SkinWeightsPaintTool.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AddStrength float   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
AverageStrength float   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
BrushConfigAdd FSkinWeightBrushConfig   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
BrushConfigMultiply FSkinWeightBrushConfig   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
BrushConfigRelax FSkinWeightBrushConfig   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
BrushConfigReplace FSkinWeightBrushConfig   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
BrushConfigs TMap< EWeightEditOperation, FSkinWeightBrushConfig * >   SkeletalMesh/SkinWeightsPaintTool.h  
BrushMode EWeightEditOperation Custom brush modes and falloff types SkeletalMesh/SkinWeightsPaintTool.h
  • Config
bShowGroupBoundaries bool Show polygroup boundary edges in the viewport. SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Config
  • Category=MeshDisplay
bShowNewProfileName bool New profile properties SkeletalMesh/SkinWeightsPaintTool.h
  • Meta=(TransientToolProperty)
bSyncBrushRadiusAcrossModes bool   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
ClampSelectValue int32   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
ClampValue int32   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
ColorMode EWeightColorMode Weight color properties SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Config
  • Category=MeshDisplay
ColorRamp TArray< FLinearColor >   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="Use LinearColorRamp instead.")
ComponentSelectionMode EComponentSelectionMode Are we selecting vertices, edges or faces SkeletalMesh/SkinWeightsPaintTool.h
  • Config
DirectEditState FDirectEditWeightState The state of the direct weight editing tools (mode buttons + slider) SkeletalMesh/SkinWeightsPaintTool.h  
EditCondition     SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category=SkinWeightLayer
  • Meta=(TransientToolProperty, DisplayName="New Profile Name", EditCondition=bShowNewProfileName, HideEditConditionToggle, NoResetToDefault)
EditingMode EWeightEditMode Brush vs selection modes SkeletalMesh/SkinWeightsPaintTool.h
  • Config
GroupBoundaryColor FColor Color of polygroup boundary edges. SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Config
  • Category=MeshDisplay
GroupBoundaryThickness float Thickness multiplier for polygroup boundary edges. SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Config
  • Category=MeshDisplay
HideEditConditionToggle     SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category=SkinWeightLayer
  • Meta=(TransientToolProperty, DisplayName="New Profile Name", EditCondition=bShowNewProfileName, HideEditConditionToggle, NoResetToDefault)
LinearColorRamp FLinearColorRamp   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Config
  • Category=MeshDisplay
  • Meta=(EditCondition="ColorMode==EWeightColorMode::Ramp", EditConditionHides)
LockedBoneNames TArray< FName > Persisted form of USkinWeightsPaintTool::LockedBoneIndices. SkeletalMesh/SkinWeightsPaintTool.h  
MeshSelectMode EMeshTransferOption   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Transient
  • Category="WeightTransfer"
MirrorAxis TEnumAsByte< EAxis::Type > Weight editing arguments SkeletalMesh/SkinWeightsPaintTool.h
  • Config
MirrorDirection EMirrorDirection   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
NewSkinWeightProfile NoResetToDefault FName   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category=SkinWeightLayer
  • Meta=(TransientToolProperty, DisplayName="New Profile Name", EditCondition=bShowNewProfileName, HideEditConditionToggle, NoResetToDefault)
PriorBrushMode EWeightEditOperation   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
PropertySetCacheIdentifier FString Cache key for the per-mesh RestoreProperties/SaveProperties round-trip; populated at Setup from the skeletal mesh asset path. SkeletalMesh/SkinWeightsPaintTool.h  
PruneValue float   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
RelaxBrushAdvancedConfig FSkinWeightRelaxBrushAdvancedConfig   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
RelaxStrength float   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
ReplaceValue float   SkeletalMesh/SkinWeightsPaintTool.h
  • Config
SkinWeightProfileOption FName   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category=SkinWeightLayer
  • Meta=(DisplayName="Active Profile", GetOptions=GetTargetSkinWeightProfilesFunc)
SourceLOD FName   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category="WeightTransfer"
  • Meta=(GetOptions=GetSourceLODsFunc)
SourcePreviewOffset FTransform   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Transient
  • Category="WeightTransfer"
SourceSkeletalMesh TWeakObjectPtr< USkeletalMesh > Transfer SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Transient
  • Category="WeightTransfer"
SourceSkinWeightProfile FName   SkeletalMesh/SkinWeightsPaintTool.h
  • EditAnywhere
  • Category="WeightTransfer"
  • Meta=(DisplayName="Source Profile", GetOptions=GetSourceSkinWeightProfilesFunc)
WeightTool TObjectPtr< USkinWeightsPaintTool > Pointer back to paint tool SkeletalMesh/SkinWeightsPaintTool.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CustomVersion ESkinWeightsPaintToolPropertiesCustomVersion Defines a fully custom version stored in the UInteractiveToolPropertySet system. SkeletalMesh/SkinWeightsPaintTool.h
  • Config

Functions

Public

Name Remarks Include Path Unreal Specifiers

FSkinWeightBrushConfig & GetBrushConfig()

 Save/restore user specified settings for each tool mode SkeletalMesh/SkinWeightsPaintTool.h  

FName GetDesiredSkinWeightProfileForTool()

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetBrushMode ( EWeightEditOperation InBrushMode
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetColorMode ( EWeightColorMode InColorMode
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetComponentMode ( EComponentSelectionMode InComponentMode
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetComponentSelectionMode ( const EComponentSelectionMode InComponentMode,
const bool bInConvertSelection
)

 Sets the component selection mode SkeletalMesh/SkinWeightsPaintTool.h  

void SetFalloffMode ( EWeightBrushFalloffMode InFalloffMode
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetSharedFalloffMode ( EWeightBrushFalloffMode InFalloffMode
)

   SkeletalMesh/SkinWeightsPaintTool.h  

void SetSharedRadius ( float InRadius
)

 Radius and FalloffMode behave as shared brush state across all brush modes (matching the sculpt tool's pattern). SkeletalMesh/SkinWeightsPaintTool.h  

Public Virtual

Overridden from UInteractiveToolPropertySet

Name Remarks Include Path Unreal Specifiers

virtual void RestoreProperties ( UInteractiveTool* RestoreToTool,
const FString& CacheIdentifier
)

   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