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

Light Theme

Dark Theme

UDynamicMeshSculptTool

Dynamic Mesh Sculpt Tool Class

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UDynamicMeshSculptTool

References

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

Syntax

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

Remarks

Dynamic Mesh Sculpt Tool Class

Variables

	Name	Description
USculptBrushPro...	BrushProperties	Properties that control brush size/etc
UFixedPlaneBrus...	GizmoProperties
UPlaneBrushProp...	PlaneBrushProperties
UBrushRemeshPro...	RemeshProperties	Properties that control dynamic remeshing
USculptMaxBrush...	SculptMaxBrushProperties
UBrushSculptPro...	SculptProperties	Properties that control sculpting
UMeshEditingVie...	ViewProperties

Constructors

	Name	Description
	UDynamicMeshSculptTool()

Functions

		Name	Description
	void	DecreaseBrushFalloffAction()
	void	DecreaseBrushRadiusAction()
	void	DecreaseBrushRadiusSmallStepAction()
	void	DecreaseBrushSpeedAction()
	bool	GetEnableRemeshing()
	void	IncreaseBrushFalloffAction()
	void	IncreaseBrushRadiusAction()
	void	IncreaseBrushRadiusSmallStepAction()
	void	IncreaseBrushSpeedAction()
	void	NextBrushModeAction()
	void	NextHistoryBrushModeAction()
	void	PreviousBrushModeAction()
	void	PreviousHistoryBrushModeAction()
	void	SetEnableRemeshing ( bool bEnable )
	void	SetWorld ( UWorld* World )

Overridden from UMeshSurfacePointTool

	Name	Description
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )
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
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnPropertyModified ( UObject* PropertySet, FProperty* Property )	Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
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
void	Tick ( float DeltaTime )	Allow the Tool to do any necessary processing on Tick

Overridden from IHoverBehaviorTarget

		Name	Description
	FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	Do hover hit-test
	bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

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