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 > Runtime > InteractiveToolsFramework > BaseTools > UBaseBrushTool

Light Theme

Dark Theme

UBaseBrushTool

[UBaseBrushTool](API\Runtime\InteractiveToolsFramework\BaseTools\UBaseBrushTool) implements standard brush-style functionality for an InteractiveTool.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UBaseBrushTool

UDynamicMeshBrushTool

UMeshSelectionTool

UEditMeshMaterialsTool

UShapeSprayTool

UMeshTexturePaintingTool

UMeshVertexPaintingTool

	UMeshColorPaintingTool
	UMeshWeightPaintingTool

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseTools/BaseBrushTool.h
Include	#include "BaseTools/BaseBrushTool.h"

Syntax

class UBaseBrushTool : public UMeshSurfacePointTool

Remarks

UBaseBrushTool implements standard brush-style functionality for an InteractiveTool. This includes: 1) brush radius property set with dimension-relative brush sizing and default brush radius hotkeys 2) brush indicator visualization 3) tracking of last brush stamp location via .LastBrushStamp FProperty 4) status of brush stroke via .bInBrushStroke FProperty

Variables

	Name	Description
bool	bInBrushStroke	Set to true by Tool if user is currently in an active brush stroke
UBrushBasePrope...	BrushProperties	Properties that control brush size/etc
TInterval< floa...	BrushRelativeSizeRange
UBrushStampIndi...	BrushStampIndicator	Brush Indicator support
double	CurrentBrushRadius
FBrushStampData	LastBrushStamp	Position of brush at last update (both during stroke and during Hover)
TSoftClassPtr< ...	PropertyClass

Constructors

	Name	Description
	UBaseBrushTool()

Functions

	Name	Description
void	DecreaseBrushFalloffAction()
void	DecreaseBrushSizeAction()
void	DecreaseBrushStrengthAction()
double	EstimateMaximumTargetDimension()	Subclasses should implement this to give an estimate of target dimension for brush size scaling
void	IncreaseBrushFalloffAction()
void	IncreaseBrushSizeAction()
void	IncreaseBrushStrengthAction()
bool	IsInBrushStroke()
void	RecalculateBrushRadius()
void	SetupBrushStampIndicator()
void	ShutdownBrushStampIndicator()
void	UpdateBrushStampIndicator()

Overridden from UMeshSurfacePointTool

	Name	Description
void	OnBeginDrag ( const FRay& Ray )	UMeshSurfacePointTool implementation
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	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
	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