Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · class

UOrreryTerrainCorridorToolProperties

Editor only

The Corridor tool's settings, kept per user.

Declaration

UCLASS(config = EditorPerProjectUserSettings)
class UOrreryTerrainCorridorToolProperties : public UInteractiveToolPropertySet
Header
#include "Tools/OrreryTerrainFeatureTools.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

Description

Lengths are metres; crossfall percent; batters horizontal per vertical.

Functions

  • UseSelectedSpline

    Take the centreline from the first spline of the selected actor.

  • Commit

    Place the corridor (Enter).

  • Cancel

    Drop the centreline (Esc).

Properties

NameTypeDefaultMeaning
PathEOrreryTerrainCorridorPathEOrreryTerrainCorridorPath::TwoPoints

Where the centreline comes from.

FormationSourceEOrreryTerrainFormationSourceEOrreryTerrainFormationSource::FromPoints

Where the formation height comes from: the centreline's Z (the clicked ground or the spline), or the ground plus Formation Offset.

FormationOffset_mdouble0.0

Ground Plus Offset: the formation above the natural ground.

HalfWidthLeft_mdouble3.0

Formation band left of the direction of travel.

HalfWidthRight_mdouble3.0

Formation band right of it.

CrossfallPercentdouble0.0

Cross slope of the formation, percent; positive raises the left edge.

StationSpacing_mdouble1.0

Distance between stations along the centreline (the terrain takes at most 2 m).

FillHVdouble1.5

Embankment slope, horizontal per vertical.

CutHVdouble1.5

Cutting slope, horizontal per vertical.

KeepOutTArray<FOrreryTerrainKeepOutBP>—

Runs left untouched (a bridge, a tunnel bore), as distances along the centreline in cm; an end may get a tunnel opening.

ToolTWeakObjectPtr<UOrreryTerrainCorridorTool>——