Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · member function

UOrreryTerrainBrushTool::

MakeBrushSettings

Editor only

The target settings a brush of Kind takes from the tool's property sets: the one conversion the tool and the editor library (UOrreryTerrainEditorLibrary) share, so a scripted stroke is the tool's stroke.

Declaration

static FOrreryTerrainSculptBrushSettings MakeBrushSettings(EOrreryTerrainBrushKind BrushKind, const UOrreryTerrainBrushToolProperties& Props,
	const UOrreryTerrainPaintProperties* Paint, const FVector& StrokeStart_cm, const UOrreryTerrainBrushMaskProperties* Mask = nullptr);
Header
#include "Tools/OrreryTerrainBrushTool.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Stable: changes within a major version only add.
Thread
Game thread, editor only. (the rule of UOrreryTerrainBrushTool)

Parameters

NameTypeDefaultMeaning
BrushKindEOrreryTerrainBrushKind—

The tool's kind: Raise, Smooth, Flatten, or Paint for the paint tools.

Propsconst UOrreryTerrainBrushToolProperties&—

Radius, falloff, step height and the Flatten settings.

Paintconst UOrreryTerrainPaintProperties*—

The paint settings of a paint tool (its LayerSet resolves the layer name); null otherwise.

StrokeStart_cmconst FVector&—

The ground under the press, world cm: the Flatten target of a StrokeStart flatten.

Maskconst UOrreryTerrainBrushMaskProperties*nullptr

The brush mask settings; null or Disc gives the round brush. The mask must be registered with the terrain before the stroke (RegisterMask).