Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrainEditor module · member function

UOrbdaleTerrainBrushTool::

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 (UOrbdaleTerrainEditorLibrary) share, so a scripted stroke is the tool's stroke.

Declaration

static FOrbdaleTerrainSculptBrushSettings MakeBrushSettings(EOrbdaleTerrainBrushKind BrushKind, const UOrbdaleTerrainBrushToolProperties& Props,
	const UOrbdaleTerrainPaintProperties* Paint, const FVector& StrokeStart_cm, const UOrbdaleTerrainBrushMaskProperties* Mask = nullptr);
Header
#include "Tools/OrbdaleTerrainBrushTool.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrainEditor"); 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 UOrbdaleTerrainBrushTool)

Parameters

NameTypeDefaultMeaning
BrushKindEOrbdaleTerrainBrushKind—

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

Propsconst UOrbdaleTerrainBrushToolProperties&—

Radius, falloff, step height and the Flatten settings.

Paintconst UOrbdaleTerrainPaintProperties*—

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 UOrbdaleTerrainBrushMaskProperties*nullptr

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