Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrain module · member function

FOrbdaleTerrainFeatures::

MakeCorridor

A corridor feature from Blueprint corridor parameters.

Declaration

static bool MakeCorridor(const FOrbdaleTerrainCorridorBP& Corridor, const OrbdaleTerrain::Native::FContractFrame& Frame,
                         const OrbdaleTerrain::Native::FGroundQuery* Ground, OrbdaleTerrain::Native::FFeature& OutFeature,
                         FString* OutReason = nullptr);
Header
#include "OrbdaleTerrainFeatures.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrain"); 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 FOrbdaleTerrainFeatures)

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 FOrbdaleTerrainCorridorBP&—

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

Frameconst OrbdaleTerrain::Native::FContractFrame&—

The terrain's contract frame.

Groundconst OrbdaleTerrain::Native::FGroundQuery*—

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

OutFeatureOrbdaleTerrain::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.