FBrushToolRadius | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MeshModelingTools

FBrushToolRadius is used to define the size of 3D "brushes" used in (eg) sculpting tools. The brush size can be defined in various ways.


Name	FBrushToolRadius
Type	struct
Header File	/Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/Sculpting/MeshSculptToolBase.h
Include Path	#include "Sculpting/MeshSculptToolBase.h"

Syntax

USTRUCT ()  
struct FBrushToolRadius

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bEnablePressureSensitivity	bool		Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush Meta=(EditCondition="bToolSupportsPressureSensitivity")
bToolSupportsPressureSensitivity	bool		Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush
ClampMax			Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush AdvancedDisplay Meta=(EditCondition="SizeType == EBrushToolSizeType::Adaptive", DisplayName="Size", UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="10.0")
ClampMin			Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush AdvancedDisplay Meta=(EditCondition="SizeType == EBrushToolSizeType::Adaptive", DisplayName="Size", UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="10.0")
DisplayName		Adaptive brush size is used to interpolate between an object-specific minimum and maximum brush size	Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush AdvancedDisplay Meta=(EditCondition="SizeType == EBrushToolSizeType::Adaptive", DisplayName="Size", UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="10.0")
SizeType	EBrushToolSizeType	Specify the type of brush size currently in use	Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush
UIMax			Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush AdvancedDisplay Meta=(EditCondition="SizeType == EBrushToolSizeType::Adaptive", DisplayName="Size", UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="10.0")
UIMin			Sculpting/MeshSculptToolBase.h	EditAnywhere Category=Brush AdvancedDisplay Meta=(EditCondition="SizeType == EBrushToolSizeType::Adaptive", DisplayName="Size", UIMin="0.0", UIMax="1.0", ClampMin="0.0", ClampMax="10.0")
WorldSizeRange	TInterval< float >	WorldSizeRange defines the min/max dimensions for Adaptive brush size	Sculpting/MeshSculptToolBase.h

Functions

Public

Name	Remarks	Include Path
void DecreaseRadius ( bool bSmallStep )	Decrease the current radius dimension by a fixed step (or a smaller fixed step)	Sculpting/MeshSculptToolBase.h
float GetWorldRadius()	Return the set/calculated world-space radius for the current settings	Sculpting/MeshSculptToolBase.h
void IncreaseRadius ( bool bSmallStep )	Increase the current radius dimension by a fixed step (or a smaller fixed step)	Sculpting/MeshSculptToolBase.h
void InitializeWorldSizeRange ( TInterval< float > Range, bool bValidateWorldRadius )	Util functions Set the WorldSizeRange value and optionally clamp the WorldRadius based on this new range	Sculpting/MeshSculptToolBase.h

Navigation

Syntax

Variables

Public

Functions

Public