UOrbdaleTerrainBrushTool

Declaration

UCLASS()
class UOrbdaleTerrainBrushTool : public UInteractiveTool, public IClickDragBehaviorTarget, public IHoverBehaviorTarget

Header

#include "Tools/OrbdaleTerrainBrushTool.h"

Module

PublicDependencyModuleNames.Add("OrbdaleTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.

Stability

Stable: changes within a major version only add.

Thread

Game thread, editor only.

Derives from

UInteractiveTool, IClickDragBehaviorTarget, IHoverBehaviorTarget

Description

Types

• EAction enum

  Action ids of the hotkeys (RegisterActions).

  RadiusDown, RadiusUp, StrengthDown, StrengthUp, FalloffDown, FalloffUp, AngleDown, AngleUp, AngleFineDown, AngleFineUp

Functions

• Init
• Setup
• Shutdown
• OnTick
• Render
• DrawHUD
• RegisterActions
• OnPropertyModified
• CanBeginClickDragSequence
• OnClickPress
• OnClickDrag
• OnClickRelease
• OnTerminateDragSequence
• OnUpdateModifierState
• BeginHoverSequenceHitTest
• OnBeginHover
• OnUpdateHover
• OnEndHover
• FinishStroke

  Close an open stroke now and append its transaction: before an undo, a tool switch or the terrain going away.

• IsStrokeOpen

  Whether a stroke is open (dragging, or released and waiting for ground).

• SetExtensionTargets

  Registry ids of extension brush targets (V1 or V2) that the next strokes also drive: V2 targets receive the mask and each dab's resolved angle, V1 targets the plain dab.

• SetCursorAt

  Put the brush at Location_cm (world cm, Z ignored; the ground's height is taken) as if the cursor hovered there: for captures and scripted strokes, without a viewport.

• PressAt

  Scripted press, drag to Location_cm and release (captures, scripted strokes): the same path as the mouse.

• DragTo
• ReleaseStroke
• GetKind
• GetProperties
• IsPaintTool

  Whether this is a paint tool (kind Paint): GetPaintProperties is set.

• GetPaintProperties
• GetMaskProperties

  The brush mask settings: Disc or a brush asset, and how each dab turns it.

• GetContourCache

  The contour cache of the mask preview: GetComputeCount says how often a contour was traced.

• GetPreviewContour

  The contour segments drawn this frame, world cm (pairs of points); empty without a strength mask.

• GetPreviewColor

  The colour the preview draws this frame, before the red of unloaded or refused ground.

• IsPreviewDashed

  Whether the brush ring is dashed this frame (Holes).

• GetTarget
• GetHudLines

  The HUD's lines as drawn this frame: for tests and captures.

• MakeBrushSettingsstatic

  The target settings a brush of Kind takes from the tool's property sets: the one conversion the tool and the editor library (UOrbdaleTerrainEditorLibrary) share, so a scripted stroke is the tool's stroke.

• RegisterMaskstatic

  Register Mask's brush asset with Terrain, so a stroke may name it; Disc needs nothing.

• TurnMask

  Turn the brush mask by Delta degrees, as the comma and period keys do.

• CanPaintstatic

  Whether the project's author limits let a paint tool write what Paint names (holes, the ground class, a layer the layer table has).

Properties