Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · class

FOrreryTerrainExtFeed

ExperimentalEditor only

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

Declaration

class FOrreryTerrainExtFeed
Header
#include "Tools/OrreryTerrainExtFeed.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Game thread, editor only.

Description

The built-in target (FOrreryTerrainSculptHeightTarget) or the stamp hold owns one. Begin resolves the listed ids in the registry: a V2 target gets every dab as an FOrreryTerrainBrushDabV2 with the mask, a V1 target gets FOrreryTerrainBrushDabV2::ToV1, the dab it always got, with no mask (a masked brush looks like a round brush to it). A splat dab is one V2 dab per used channel, each with its channel's mask; a V1 target gets one plain dab per splat dab. A target that is not in the registry, cannot edit or refuses the first dab sits that stroke out. The first dab goes to Begin only; Apply carries the rest.

Note.

Game thread, editor only. Tier 3.

Functions

  • FOrreryTerrainExtFeed (2 overloads)
  • operator=
  • SetTargetIds

    The registry ids of the extension targets to drive from the next stroke on.

  • GetTargetIds
  • HasTargets

    Whether any target is listed.

  • IsOpen

    Whether a stroke is open on at least one target.

  • Begin

    Open the listed targets with the first dab.

  • Apply

    Send the next dabs, in order, to the open targets.

  • End

    Close the open targets and keep their undo records for TakeChanges.

  • Cancel

    Abandon the open targets' strokes (they restore the ground themselves).

  • TakeChanges

    The undo records of the targets closed by End, once; null records are left out.

  • MakeDabstatic

    The V2 dab of a brush step: the V1 fields, and, when Brush names a mask, the mask the terrain holds with the angle and placement the kernel will use (FOrreryTerrainBrushBP converted by Units::ToBrush).

  • MakeSplatDabsstatic

    The V2 dabs of one splat dab: one per used channel of Splat, in channel order, each the splat step's mask (SplatSteps) with SplatStep, SplatChannel and PaintLayer set.

  • KeepRegisteredstatic

    Ids, in order and once each, that are registered brush targets (V1 or V2) now; the rest dropped.