OrreryTerrainEditor

How UOrreryTerrainBake::BakeAuthoring bakes.

What a bake did, or why it refused.

Bakes a terrain's authoring layer into a new tile store.

UnrealEditor-Cmd <project> -run=OrreryTerrainBake -Map=<maps> [-Check] [-MaxResidentTiles=N] [-Workers=N]

What the heightmap import asks when the heightmap has no sidecar to say it: the scale and the extent (Tier 3, editor only).

What the GeoTIFF import asks: how much to thin, and the placement a file without georeferencing lacks (Tier 3, editor only).

Create a terrain tile store from a 16-bit PNG or RAW16 heightmap, picked from the Content Browser's Add menu.

Import a GeoTIFF DEM dropped into the Content Browser as a terrain tile store.

The ground an editor edit started from, which the follow measures every instance against.

What the follow of the last editor edit did: for the tests, the captures and the cost measurement.

Makes placed foliage, instanced meshes tagged OrreryTerrain.Follow and actors with a Terrain Ground Follow component follow the terrain mode's edits in an editor world (UOrreryTerrainFollowSubsystem covers game and PIE worlds).

One brush dab handed to a brush target, in world space.

What a brush edits.

A tool the mode lists in a palette.

An action (a button that runs code rather than starting a tool): Bake, New, a climate spin-up.

What a layer in the layer panel is.

A row in the layer panel, listed in composition order.

What an extension returns.

One brush dab handed to a V2 brush target, in world space: the V1 fields, plus the brush mask and how the kernel places it.

What a V2 brush target edits: IOrreryTerrainBrushTarget with dabs that carry the mask.

What a V2 extension returns.

Editor mode "Terrain (Orrery)".

A palette (a group of buttons) of the mode's toolbar.

Where the mode's palettes, tools, actions, layers and brush targets come from.

Settings of one DEM import: the heightmap import's (mip depth, memory budget, compression) and the DEM's own.

What a DEM import did, or why it refused.

Imports GeoTIFF DEMs into a tile store (editor only).

The brush tools of the editor mode's palette, by their tool ids.

One brush stroke as a script states it: the tool, its settings as the tool's details panel shows them, and the cursor's path over the ground.

What ApplyEditorStroke did.

What PlacePlate or PlaceCorridor did.

What NewTerrain did.

The terrain editor's scripting API (Python: unreal.OrreryTerrainEditorLibrary).

The mode's per-user settings, saved to EditorPerProjectUserSettings when the mode exits and loaded when it is entered.

What the cook does with a map that still holds an unbaked authoring layer.

Project Settings, Plugins, Orrery Terrain Editor.

What the importer reads besides the heights.

The sidecar of a heightmap, decoded and checked.

Settings of one import.

What an import did, or why it refused.

Imports a 16-bit heightmap and its sidecar into a tile store (editor only).

Hook the map check (AOrreryTerrainActor::OnCheckForErrors) and the cook save (FCoreUObjectDelegates::OnObjectPreSave).

Remove the hooks.

Report a terrain actor whose source is a tile store imported from a Landscape that changed since, to the MapCheck log as a warning (Landscape not loaded: an info line, nothing can be said).

Log a LogOrreryTerrainShell warning when the store was imported from a Landscape that has changed since.

Editor-side importers for terrain source assets (Tier 3, editor only).

What an importer's scripting entry returns.

Settings of one Landscape import.

The height error of the level-0 tiles that share one sample shift, against the exact decode of the Landscape.

What a Landscape import did, or why it refused.

Imports a Landscape into a tile store (editor only): the final heightmap exactly, and optionally the paint layers.

Editor-time creation of terrain material wrappers (Tier 3, editor only).

The editor's authoring sync: the live terrain of an editor world is the truth, and its authoring asset catches up at four moments: the asset's own save, the map's save, PIE start and a terrain re-create (Material, Source, undo of a recreate property).

What the spline feature subsystem has done since its counters were last reset: for tests and the HUD.

Keeps the spline features of the editor world in step with their splines.

Where a masked brush writes.

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

The Stamp tool's mask settings: the brush tools' settings, saved in a config section of their own, so the stamp's angle, footprint and import options and the brush tools' never replace each other.

One button of the brush palette.

The content folder whose brush sets the palette lists first: the plugin's starter set goes there.

The brush sets the palette lists, in order: every UOrreryTerrainBrushSet under kStarterFolder (by name), then Project Settings > Orrery Terrain Editor > Brush Sets in their order; missing and repeated sets are skipped.

The palette's buttons: Disc first, then each set's baked brushes in order (an unbaked or repeated brush skipped), then Current when it is in no set (a brush picked or imported elsewhere).

The palette's splat buttons, after the brushes: each set's Splats in order (a null, repeated or unbaked splat is skipped), then Current when it is in no set (a splat picked elsewhere).

Pick Splat (null: none) in Props as a palette button does: the brush is cleared and the change is announced as a details edit.

Pick Brush (null: Disc) in Props as a palette button does: the angle becomes the asset's default angle and the change is announced as a details edit (PostEditChangeProperty), so the tool sees it.

One row of the extension target picker.

The registered extension brush targets (V1 and V2), by id: the picker's rows.

Pick or unpick the extension target Id in Props as a picker checkbox does: ids no longer registered are dropped from the list, and the change is announced as a details edit (PostEditChangeProperty), so the tool sees it.

What Import bakes.

The options a tool's mask settings ask Import for; Usage is Height in the Stamp tool.

Make a brush asset of Texture through the asset's own bake (it reads the texture's source, never its platform data).

The first texture selected in the Content Browser (or in the editor's object selection), or null.

Import: bake a new brush asset of the selected texture beside it (BM_<Texture>, a unique name), dirty and not saved.

A 64 × 64 grey thumbnail of Brush's mask (the disc for null), made once per mask and kept until Shutdown; null before Startup.

Register the details customization that shows the palette, and keep the thumbnails.

Drives a brush target from a cursor timeline: the stepper turns the cursor into steps, each step becomes one dab.

Where Flatten takes its target height.

What a paint tool writes.

The paint tools' settings (Paint, Ground class, Holes), kept per user.

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

Builds the brush tool of one kind.

One class for every brush: a click-drag stroke on the analytic ground, with a preview ring and a HUD.

Sends the dabs of a stroke or stamp to the extension brush targets the author listed, and keeps their undo records.

Where an FOrreryTerrainFeaturePlacement stands.

Commit an editor feature (an add, or a replace in place when its Id is set) or remove one, as soon as the terrain can take it, without blocking.

Which feature tool a builder makes.

Where a plate's top height comes from.

Where a corridor's centreline comes from.

The Plate tool's settings, kept per user.

The Corridor tool's settings, kept per user.

The feature list: every feature the editor authored (owner domain 'TSED'), and the one selected.

The selected feature's parameters.

Builds one feature tool.

What the feature tools share: clicks and hovers on the analytic ground (RaycastGround), the HUD, and committing or removing a feature as one editor transaction (AppendChange of an FOrreryTerrainFeatureChange on the terrain actor, never EmitObjectChange, so the edit outlives the tool).

Plate: click the polygon's vertices on the ground; Enter commits, Backspace takes the last vertex back, Esc cancels.

Corridor: two clicks give a straight centreline (the third click starts again), or Use Selected Spline samples the selected actor's spline.

Features: lists the features the editor authored, highlights the selected one (picked in the list or by a click on its footprint), replaces it with edited parameters or removes it.

The 50 % contour of strength masks, by marching squares on a 64 × 64 level of the mask (its own level 0 below that), turned and mirrored as a dab samples it, cached per mask, angle, mirror and aspect.

The ghost of a height stamp before it is placed: EvaluateStampPreview's Side × Side grid of the stamp's result over the ground sampled at StampPreviewPoint, in world cm.

What the preview panel shows before anything is created.

What Create did.

One source kind of Manage, New: Flat, Procedural, Heightmap, DEM, and Landscape.

The registered source kinds.

The preview for the properties' kind.

Create a terrain in World, or replace the source of the world's terrain (one terrain per world).

Register Flat, Procedural, Heightmap, DEM and Landscape; called by the module at startup.

Unregister them; called at shutdown.

The fields of Manage, New.

Builds the New tool.

Manage, New.

What the target applies with every dab, beside the dab's own position, radius and strength.

Ground answers around a brush, for the stroke start and the preview.

Edits the sculpt layer (heights, paint layers, the ground class and holes) through the subsystem's stroke calls, under the editor session.

Where an FOrreryTerrainStampHold stands.

Apply one height stamp when the terrain can take all of it, without blocking, as exactly one undo record.

One build of a stamp's wire ghost (built on a worker thread): EvaluateStampPreview's 65 × 65 grid of the stamp's result over the ground sampled at StampPreviewPoint, which cuts, and the lines the tool draws.

One build of a stamp's preview: the post-aligned grid of StampPreviewPostGridWithin, its ground, the stamp's result there (EvaluateStampPreviewPosts: on every vertex the millimetres the stamp writes to that post), the mesh drawn from it, and the wire ghost from the same ground snapshot.

Draws a FOrreryTerrainStampMesh: a translucent, lit, vertex-coloured triangle list in the world (material 0), and its cut cells again through the ground (material 1), never selectable, casting no shadow and colliding with nothing.

The Stamp tool's preview: asks a worker for a FOrreryTerrainStampMesh and its FOrreryTerrainStampWire when the stamp or the ground changes, shows each finished mesh on a transient actor's UOrreryTerrainStampPreviewComponent and keeps the wire for the tool to draw.

Where a stamp's base height comes from.

The Stamp tool's settings, kept per user.

Builds the Stamp tool.

Places height stamps (EBrushKind::Stamp) of the brush mask picked in the palette.

How a stroke's cursor samples become brush steps.

What the stepper needs to know about the stroke it steps.

Turns a timeline of cursor positions into brush step positions.