Vixen
02b45cc4
csharp
public enum TerrainTool

What a drag in the viewport does to the ground.

Read the guide page for this →

Remarks

Seven sculpt tools plus holes — [docs/plan/31 § The sculpt tools]. The list is the intersection of Unreal's Landscape and Unity's Terrain, plus Ramp, which only Unreal has and which is what a level designer reaches for between two playtests.

⚠ Holes is last and is not the eighth sculpt tool. It paints a visibility bit rather than a height, so it writes TerrainHoles rather than an edit layer, and it is the one tool in the strip whose stroke a TerrainStrokeCommand cannot record — see that type's remarks. Grouping it with the seven is the references' layout and the honest ordering for an artist; treating it as one of them in code is the mistake the two storage models make visible.

Fields and properties (8)

  • Sculpt

    Raises the ground; Shift lowers it.

  • Smooth

    Averages the ground under the brush with its neighbours.

  • Flatten

    Pulls the ground towards a height picked at the start of the stroke.

  • Ramp

    A straight ramp between two picked points.

  • Erosion

    Thermal erosion: material steeper than the talus angle slides downhill.

  • Hydro

    Hydraulic erosion: channels deepen and shoulders fill.

  • Noise

    Adds fractal noise.

  • Holes

    Paints the visibility mask, so a quad can be removed for a cave mouth.

Used by (8)

  • SculptSessionTestsVixen.Editor.Terrain.Tests
  • TerrainEditVixen.Editor.Terrain
  • TerrainEditTestsVixen.Editor.Terrain.Tests
  • TerrainModeVixen.Editor.Terrain
  • TerrainModeTestsVixen.Editor.Terrain.Tests
  • TerrainPanelTestsVixen.Editor.Terrain.Tests
  • TerrainSessionTestsVixen.Editor.App.Tests
  • TerrainToolSettingsVixen.Editor.Terrain