Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MeshModelingTools > Sculpting > UMeshSculptToolBase

Light Theme

Dark Theme

UMeshSculptToolBase

Base Tool for mesh sculpting tools, provides some shared functionality

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UMeshSculptToolBase

UMeshVertexSculptTool

References

Module	MeshModelingTools
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingTools/Public/Sculpting/MeshSculptToolBase.h
Include	#include "Sculpting/MeshSculptToolBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UMeshSculptToolBase : public UMeshSurfacePointTool

Remarks

Base Tool for mesh sculpting tools, provides some shared functionality

Variables

	Name	Description
UMaterialInstan...	ActiveOverrideMaterial
double	ActivePressure
UBrushStampIndi...	BrushIndicator
UMaterialInstan...	BrushIndicatorMaterial
UPreviewMesh &#...	BrushIndicatorMesh
TMap< int32, TU...	BrushOpFactories
TMap< int32, UM...	BrushOpPropSets	Brush Types
USculptBrushPro...	BrushProperties	Properties that control brush size/etc
FInterval1d	BrushRelativeSizeRange	Brush Size
FViewCameraStat...	CameraState
double	CurrentBrushFalloff
double	CurrentBrushRadius
FSculptBrushSta...	CurrentStamp
FTransform3d	CurTargetTransform	Active transformation on target mesh, includes baked scale
UWorkPlanePrope...	GizmoProperties	Properties for 3D workplane / gizmo
FSculptBrushSta...	HoverStamp
FTransform3d	InitialTargetTransform	Initial transformation on target mesh
FSculptBrushSta...	LastStamp
UTransformGizmo...	PlaneTransformGizmo	Plane gizmo
UTransformProxy...	PlaneTransformProxy
TMap< int32, TU...	SecondaryBrushOpFactories
TMap< int32, UM...	SecondaryBrushOpPropSets
UWorld *	TargetWorld
UMeshEditingVie...	ViewProperties	Display / Material

Functions

	Name	Description
void	AlignBrushToView()
void	ApplyStrokeFlowInTick()
void	CalculateBrushRadius()
FFrame3d	ComputeStampRegionPlane ( const FFrame3d& StampFrame, const TSet< int32 >& StampTriangle..., bool bIgnoreDepth, bool bViewAligned, bool bInvDistFalloff )
void	DecreaseBrushRadiusAction()
void	DecreaseBrushRadiusSmallStepAction()
void	DecreaseBrushSpeedAction()
int32	FindHitSculptMeshTriangle ( const FRay3d& LocalRay )
int32	FindHitTargetMeshTriangle ( const FRay3d& LocalRay )
TUniquePtr< ...	GetActiveBrushOp()
double	GetActivePressure()
FDynamicMesh...	GetBaseMesh()
const FDynam...	GetBaseMesh()
bool	GetBrushCanHitBackFaces()
const FFrame...	GetBrushFrameLocal()
const FFrame...	GetBrushFrameWorld()
double	GetCurrentBrushDepth()
double	GetCurrentBrushFalloff()
double	GetCurrentBrushRadius()
double	GetCurrentBrushStrength()
const FFrame...	GetCurrentStrokeReferencePlane()
bool	GetInInvertStroke()
bool	GetInSmoothingStroke()
FRay3d	GetLocalRay ( const FRay& WorldRay )
const FRay &	GetPendingStampRayWorld()
FDynamicMesh...	GetSculptMesh()
const FDynam...	GetSculptMesh()
UBaseDynamic...	GetSculptMeshComponent()	Subclass must implement this and return relevant rendering component
void	IncreaseBrushRadiusAction()
void	IncreaseBrushRadiusSmallStepAction()
void	IncreaseBrushSpeedAction()	Client currently needs to implement these...
void	InitializeBrushSizeRange ( const FAxisAlignedBox3d& TargetBou... )
void	InitializeIndicator()	Subclasses should call this to create indicator in their Setup()
void	InitializeSculptMeshComponent ( UBaseDynamicMeshComponent* Com... )	Subclass calls this to set up editing component
bool	InStroke()
bool	IsStampPending()
UPreviewMesh...	MakeDefaultIndicatorSphereMesh ( UObject* Parent, UWorld* World, int Resolution )	Creates default sphere indicator
void	NextBrushModeAction()
void	OnBeginStroke ( const FRay& WorldRay )
void	OnCompleteSetup()
void	OnEndStroke()
void	PreviousBrushModeAction()
void	RegisterBrushType ( int32 Identifier, TUniquePtr< FMeshSculptBrushOpFacto..., UMeshSculptBrushOpProps* PropS... )
void	RegisterSecondaryBrushType ( int32 Identifier, TUniquePtr< FMeshSculptBrushOpFacto..., UMeshSculptBrushOpProps* PropS... )
void	RestoreAllBrushTypeProperties ( UInteractiveTool* RestoreToToo... )
void	SaveActiveStrokeModifiers()
void	SaveAllBrushTypeProperties ( UInteractiveTool* SaveFromTool )
void	SetActivePrimaryBrushType ( int32 Identifier )
void	SetActiveSecondaryBrushType ( int32 Identifier )
void	SetPrimaryFalloffType ( EMeshSculptFalloffType Falloff )
void	SetWorld ( UWorld* World )
bool	ShowWorkPlane()
void	UpdateBrushFrameWorld ( const FVector3d& NewPosition, const FVector3d& NewNormal )
bool	UpdateBrushPositionOnActivePlane ( const FRay& WorldRay )
bool	UpdateBrushPositionOnSculptMesh ( const FRay& WorldRay, bool bFallbackToViewPlane )
bool	UpdateBrushPositionOnTargetMesh ( const FRay& WorldRay, bool bFallbackToViewPlane )
void	UpdateBrushTargetPlaneFromHit ( const FRay& WorldRay, const FHitResult& Hit )
void	UpdateColorSetting ( FLinearColor NewColor )
void	UpdateFlatShadingSetting ( bool bNewValue )
void	UpdateHoverStamp ( const FFrame3d& StampFrame )
void	UpdateImageSetting ( UTexture2D* NewImage )
void	UpdateMaterialMode ( EMeshEditingMaterialModes NewMode )
void	UpdateStrokeReferencePlaneForROI ( const FFrame3d& StampFrame, const TSet< int32 >& TriangleROI, bool bViewAligned )
void	UpdateStrokeReferencePlaneFromWorkPlane()
void	UpdateWireframeVisibility ( bool bNewValue )
void	UpdateWorkPlane()

Overridden from UMeshSurfacePointTool

	Name	Description
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )	UMeshSurfacePointTool API.
void	OnBeginDrag ( const FRay& Ray )	This function is called when the user begins a click-drag-release interaction
void	OnEndDrag ( const FRay& Ray )	This function is called when the user releases the button driving a click-drag-release interaction
void	OnUpdateDrag ( const FRay& Ray )	This function is called each frame that the user is in a click-drag-release interaction

Overridden from UInteractiveTool

	Name	Description
void	OnTick ( float DeltaTime )	Action support/system
void	RegisterActions ( FInteractiveToolActionSet& ActionS... )	Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	Register InputBehaviors, etc
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Enums

	Name	Description
	EPendingWorkPlaneUpdate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss