Orrery Terrain · OrreryTerrainEditor module · class

UOrreryTerrainBrushToolProperties

Editor only

The brush tool's settings, shared by every brush tool and kept per user.

Declaration

UCLASS(config = EditorPerProjectUserSettings)
class UOrreryTerrainBrushToolProperties : public UInteractiveToolPropertySet

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.
Derives from: UInteractiveToolPropertySet

Functions

FalloffStartFor
The falloff start a brush of Kind uses: FlattenFalloffStart for Flatten, FalloffStart for every other kind.
ActiveFalloffStart
The falloff start this tool shows and its keys change (bFlattenTool picks which).

Properties

Name	Type	Default	Meaning
`Radius_m`	`double`	`20.0`	Brush radius. `[` and `]` scale it.
`Strength`	`double`	`0.5`	Share of Step Height applied at the centre per step. Ctrl+`[` and Ctrl+`]` change it.
`StepHeight_m`	`double`	`0.5`	Height change at the centre per step at strength 1 (Sculpt; Smooth and Flatten move at most this far).
`Falloff`	`EOrreryTerrainFalloff`	`EOrreryTerrainFalloff::Smooth`	Shape of the edge.
`FalloffStart`	`double`	`0.0`	Inner share of the radius at full strength, every tool but Flatten. Ctrl+Shift+`[` and Ctrl+Shift+`]` change it.
`FlattenFalloffStart`	`double`	`0.5`	Flatten's own inner share of the radius at full strength, kept apart from the other tools' FalloffStart: a pad on steep ground needs a flat core and a long blend, a sculpt brush mostly none. Ctrl+Shift+`[` and `]` change it in the Flatten tool; each value is saved on its own, so switching tools keeps both.
`StepMode`	`EOrreryTerrainStrokeSpacing`	`EOrreryTerrainStrokeSpacing::Continuous`	How the cursor's path becomes steps.
`StepRateHz`	`double`	`30.0`	Continuous: steps per second, as the runtime sculpt component takes them.
`Spacing`	`double`	`0.25`	Spacing: distance between steps over the radius.
`FlattenTarget`	`EOrreryTerrainFlattenTarget`	`EOrreryTerrainFlattenTarget::StrokeStart`	Flatten: where the target height comes from. Ctrl+click picks a Fixed one.
`FlattenHeight_m`	`double`	`0.0`	Flatten, Fixed: the target height, world.
`FlattenDirection`	`EOrreryTerrainFlattenDirection`	`EOrreryTerrainFlattenDirection::Both`	Flatten: move the ground both ways, or only up or only down.
`bFlattenTool`	`bool`	`false`	Set by the tool: whether its kind is Flatten (shows the Flatten settings).
`bHeightTool`	`bool`	`true`	Set by the tool: whether it edits heights (shows Strength and Step Height).