Orrery Terrain · OrreryTerrainEditor module · class

UOrreryTerrainBrushMaskProperties

Editor only

The brush mask a brush, paint or Stamp tool applies, kept per user and shared by those tools.

Declaration

UCLASS(config = EditorPerProjectUserSettings)
class UOrreryTerrainBrushMaskProperties : public UInteractiveToolPropertySet

Header: #include "Tools/OrreryTerrainBrushPalette.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.
Derives from: UInteractiveToolPropertySet

Description

The palette in the details panel sets Brush (Disc is none); the rest shapes each dab as the runtime component does (UOrreryTerrainSculptComponent::ResolveMaskAngle), so an editor stroke turns its dabs as a player's would. The tool registers the brush's mask with the terrain when a stroke or stamp begins: the terrain's registry is never saved.

Note.

Game thread, editor only. Tier 3.

Functions

GetBrushAsset
The brush asset, loaded; null for Disc or a brush that no longer exists.
HasMask
Whether a baked mask is chosen.
GetSplatAsset
The splat asset, loaded; null when none is picked or it no longer exists.
HasSplat
Whether a splat is picked in a Paint tool and baked with at least one channel that has a layer.
GetSplatWarning
The warning for the picked splat, or empty: a splat with no layer assigned to any channel paints nothing, and one that is not baked is not usable.
GetWarning
The row under the palette: the splat warning in a Paint tool, else the Stamp tool's precision warning.
GetPickedExtensionTargets
ExtensionTargets that are registered brush targets now, in order and once each: what a stroke or stamp drives.
IsSquare
Whether the footprint is the mask's square.
TurnBy
Turn the angle by Delta degrees, wrapped to 0 to 360.
GetPrecisionWarning
The low-precision warning of the Stamp tool's mask (PrecisionWarning), empty in the brush and paint tools.
PrecisionWarningstatic
Why a mask is too coarse for a height stamp, or empty: 8-bit samples terrace (a 500 m mountain climbs in 2 m steps), the mask's own or its source texture's, and a sample wider than 4 m on the ground shows facets in the lighting .

Properties

Name	Type	Default	Meaning
`Brush`	`TSoftObjectPtr<UOrreryTerrainBrushAsset>`	—	The brush mask; none is the round brush (Disc). Pick one in the palette above. Each tool keeps its pick for the editor session; it is not saved, so a mask picked in an earlier session never changes a stroke unseen.
`Splat`	`TSoftObjectPtr<UOrreryTerrainSplatAsset>`	—	The splat brush; none paints with Brush. Pick one in the palette of the Paint tool: a drag then lays the splat (up to four paint layers from one picture) under one undo. A splat and a brush exclude each other: picking one clears the other. Like Brush it is kept for the editor session and never saved (no Config), so an asset picked in an earlier session never changes a stroke unseen.
`ExtensionTargets`	`TArray<FName>`	—	The registry ids of the extension brush targets (V1 or V2) the tool drives beside the ground; empty by default. The picker under the palette sets it. It is kept for the editor session and never saved (no Config): an id from an earlier session may not exist now, and a target that unregisters drops out of every stroke, so a stale id changes nothing.
`Angle_deg`	`double`	`0.0`	The mask's angle, degrees from +X toward +Y (a yaw). `,` and `.` turn it by 15 degrees, Ctrl+wheel by 5.
`RotationMode`	`EOrreryTerrainMaskRotation`	`EOrreryTerrainMaskRotation::Fixed`	How each dab of a stroke turns the mask: the angle above, the direction of travel plus it, or it plus a random turn.
`AngleJitter_deg`	`double`	`180.0`	Random: each dab turns up to this far either way, drawn from the stroke and step numbers (never a clock).
`bMirror`	`bool`	`false`	Mirror the mask left to right before it turns.
`Footprint`	`EOrreryTerrainMaskFootprint`	`EOrreryTerrainMaskFootprint::Disc`	The round disc, which clips the mask, or the mask's own square turned with it.
`ImportChannel`	`EOrreryTerrainBrushChannel`	`EOrreryTerrainBrushChannel::Luminance`	Import: the channel of the selected texture that becomes the mask.
`bImportInvert`	`bool`	`false`	Import: replace each sample with its complement (a dark-on-light image).
`ImportSide`	`int32`	`0`	Import: samples a side, rounded to a power of two from 8 to 2048; 0 is 256 for a strength mask and 1024 for a height stamp's.
`bImport16Bit`	`bool`	`false`	Import: 16 bits a sample. A height stamp needs them (8 bits terrace); a strength mask does well with 8.
`bStampTool`	`bool`	`false`	Set by the tool: the Stamp tool (a height shape: no rotation mode, the low-precision warning).
`bPaintTool`	`bool`	`false`	Set by the Paint tool: splat brushes can be picked (the palette lists them, Splat shows).
`StampRadius_m`	`double`	`0.0`	Set by the Stamp tool: the stamp's radius, metres, which the low-precision warning reads.
`kCoarseSample_m`	`double`	`4.0`	The ground width of a height sample above which PrecisionWarning warns, metres.