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

UMeshVertexSculptTool

Mesh Vertex Sculpt Tool Class

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UMeshSculptToolBase

UMeshVertexSculptTool

References

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

Syntax

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

Remarks

Mesh Vertex Sculpt Tool Class

Variables

	Name	Description
TSet< int32 >	AccumulatedTriangleROI
FMeshVertexChan...	ActiveVertexChange
FDynamicMesh3	BaseMesh
TArray< int32 >	BaseMeshIndexBuffer
TFunction< bool...	BaseMeshQueryFunc
FDynamicMeshOct...	BaseMeshSpatial
bool	bCachedFreezeTarget
bool	bTargetDirty
bool	bUndoUpdatePending
USimpleDynamicM...	DynamicMeshComponent
TArray< int >	NormalsBuffer
FDynamicMeshOct...	Octree
FDelegateHandle	OnDynamicMeshComponentChangedHandle
EMeshVertexScul...	PendingStampType
TArray< FVector...	ROIPositionBuffer
double	SculptMaxFixedHeight
UVertexBrushScu...	SculptProperties	Properties that control sculpting
TSet< int >	TriangleROI
TFuture< bool >	UndoNormalsFuture
TFuture< bool >	UndoUpdateBaseMeshFuture
TFuture< bool >	UndoUpdateOctreeFuture
TArray< int >	VertexROI
TSet< int >	VertexSetBuffer

Functions

	Name	Description
void	ApplyStamp()
void	BeginChange()
void	EndChange()
bool	GetBaseMeshNearest ( int32 VertexID, const FVector3d& Position, double SearchRadius, FVector3d& TargetPosOut, FVector3d& TargetNormalOut )
void	OnDynamicMeshComponentChanged ( USimpleDynamicMeshComponent* C..., const FMeshVertexChange* Chang..., bool bRevert )	Realtime visualization
void	SyncMeshWithPositionBuffer ( FDynamicMesh3* Mesh )
void	UpdateBaseMesh ( const TSet< int32 >* TriangleR... )
bool	UpdateBrushPosition ( const FRay& WorldRay )
void	UpdateBrushType ( EMeshVertexSculptBrushType BrushTyp... )
void	UpdateROI ( const FVector3d& BrushPos )
bool	UpdateStampPosition ( const FRay& WorldRay )
void	WaitForPendingUndoRedo()

Overridden from UMeshSculptToolBase

	Name	Description
void	DecreaseBrushSpeedAction()
int32	FindHitSculptMeshTriangle ( const FRay3d& LocalRay )
int32	FindHitTargetMeshTriangle ( const FRay3d& LocalRay )
FDynamicMesh...	GetBaseMesh()
const FDynam...	GetBaseMesh()
UBaseDynamic...	GetSculptMeshComponent()	UMeshSculptToolBase API.
void	IncreaseBrushSpeedAction()	Client currently needs to implement these...
void	OnBeginStroke ( const FRay& WorldRay )
void	OnEndStroke()
bool	ShowWorkPlane()

Overridden from UInteractiveTool

	Name	Description
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	OnTick ( float DeltaTime )	Action support/system
void	Setup()	Register InputBehaviors, etc
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Overridden from IHoverBehaviorTarget

		Name	Description
	bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

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

Take our survey

Dismiss