Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · class

IOrreryTerrainBrushTargetV2

ExperimentalEditor only

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

Declaration

class IOrreryTerrainBrushTargetV2
Header
#include "Mode/OrreryTerrainEdExtensionV2.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

A target implements exactly one of the two interfaces. Its id lives in one namespace with V1 targets: the registry refuses a V2 target whose id a V1 target holds, and the other way round.

Note.

Game thread, editor only. The stroke is bracketed by BeginStroke and EndStroke or CancelStroke.

Functions

  • GetId

    The target's stable id, used by layers (FOrreryTerrainEdLayerDesc::BrushTarget) and tools.

  • GetDisplayName

    The name the editor's target picker shows beside the id; the id by default.

  • CanEdit

    Whether the target can be edited in World now; OutWhyNot says why not when it cannot.

  • BeginStroke

    Opens a stroke with its first dab; false refuses it.

  • ApplyDabs

    Applies the next dabs of the open stroke, in order.

  • EndStroke

    Closes the stroke and returns its undo record (null when nothing changed).

  • CancelStroke

    Abandons the open stroke and restores the ground.