Orbdale Terrain · OrbdaleTerrainEditor module · class

IOrbdaleTerrainBrushTarget

Editor only

What a brush edits.

Declaration

class IOrbdaleTerrainBrushTarget

Header: #include "Mode/OrbdaleTerrainEdExtensionV1.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.

Built in (later packages): SculptHeight, PaintLayer, GroundClass. An extension adds, for example, a snow-depth target.

Note.

Game thread, editor only. The stroke is bracketed by BeginStroke and EndStroke or CancelStroke.

GetId
The target's stable id, used by layers (FOrbdaleTerrainEdLayerDesc::BrushTarget) and tools.
CanEdit
Whether the target can be edited in World now; OutWhyNot says why not when it cannot.
BeginStroke
Opens a stroke with its first dab; false refuses it.
ApplyDabs
Applies dabs of the open stroke, in order.
EndStroke
Closes the stroke and returns its undo record (null when nothing changed).
CancelStroke
Abandons the open stroke and restores the ground.