Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

FOrreryTerrainFeatures::

MakeCorridor

A corridor feature from Blueprint corridor parameters.

Declaration

static bool MakeCorridor(const FOrreryTerrainCorridorBP& Corridor, const OrreryTerrain::Native::FContractFrame& Frame,
                         const OrreryTerrain::Native::FGroundQuery* Ground, OrreryTerrain::Native::FFeature& OutFeature,
                         FString* OutReason = nullptr);
Header
#include "OrreryTerrainFeatures.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Any thread; the inputs are values. (the rule of FOrreryTerrainFeatures)

Description

The polyline is resampled evenly in plan, every StationSpacing at most, with the formation interpolated or taken from the natural ground under each station. Keep-out runs become station ranges (sorted, merged); an opening is built where a run asks for one.

Parameters

NameTypeDefaultMeaning
Corridorconst FOrreryTerrainCorridorBP&—

Parameters; Points needs at least two distinct points in plan.

Frameconst OrreryTerrain::Native::FContractFrame&—

The terrain's contract frame.

Groundconst OrreryTerrain::Native::FGroundQuery*—

The snapshot to read for GroundPlusOffset; may be null for FromPoints.

OutFeatureOrreryTerrain::Native::FFeature&—

Receives the feature (Id 0).

OutReasonFString*nullptr

Why false was returned.

Returns

false for a degenerate polyline, or ground that is not there under a GroundPlusOffset station.