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 > MeshModelingToolsEditorOnly > UShapeSprayTool

Light Theme

Dark Theme

UShapeSprayTool

[UShapeSprayTool](API\Plugins\MeshModelingToolsEditorOnly\UShapeSprayTool) is a brush-based tool that generates random points on the target surface within the brush radius, and then creates small meshes at those points.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UBaseBrushTool

UDynamicMeshBrushTool

UShapeSprayTool

References

Module	MeshModelingToolsEditorOnly
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/ShapeSprayTool.h
Include	#include "ShapeSprayTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient)
class UShapeSprayTool : public UDynamicMeshBrushTool

Remarks

UShapeSprayTool is a brush-based tool that generates random points on the target surface within the brush radius, and then creates small meshes at those points. The accumulated meshes are appended and can be emitted as a new StaticMeshComponent on Accept.

Variables

	Name	Description
USimpleDynamicM...	AccumMeshComponent	Small meshes are accumulated here
IToolsContextAs...	AssetAPI
FRandomStream	Random
UShapeSprayTool...	Settings
FDynamicMesh3	ShapeMesh
UWorld *	TargetWorld
TArray< int >	VertexMap

Constructors

	Name	Description
	UShapeSprayTool()

Functions

		Name	Description
	void	EmitResult()
	void	SetAssetAPI ( IToolsContextAssetAPI* AssetAP... )
	void	SetWorld ( UWorld* World )
	void	SplatShape ( const FFrame3d& LocalFrame, double Scale, FDynamicMesh3* TargetMesh )
	void	UpdateShapeMesh()

Overridden from UMeshSurfacePointTool

	Name	Description
void	OnBeginDrag ( const FRay& Ray )	UMeshSurfacePointTool API.
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	Setup()	Register InputBehaviors, etc
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

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

Take our survey

Dismiss