Vixen
02b45cc4
csharp
public sealed class TerrainToolSettings

What each sculpt tool does beyond what the brush already says.

Read the guide page for this →

Remarks

The parameters below the rule — [docs/plan/31 § The terrain panel]. The brush section is shared by every tool and this is what is appended under it for whichever one is held, which is both references' layout.

⚠ One object holding every tool's parameters, not one object per tool. An artist who sets the talus angle, goes to smooth a ridge and comes back expects the angle to still be there — so the settings outlive the tool selection, and [ShowIf] is what makes the panel show only the ones that apply. Per-tool objects would either lose the values or need a dictionary keyed by tool, which is the same thing spelled less clearly.

Fields and properties (38)

  • public TerrainCategory Category

    Which half of the toolset a drag belongs to.

  • public TerrainTool Tool

    Which sculpt tool a drag runs.

  • public TerrainPaintTool PaintTool

    Which paint tool a drag runs, while the category is Paint.

  • public int Target

    Which paint layer the paint tools write, or −1 for none.

  • public float Metres

    How far a stamp at full strength moves the ground, in metres.

  • public bool Clay

    Whether the tool accumulates against a plane rather than along the normal.

  • public int SmoothPasses

    How many passes of the averaging kernel one stamp runs.

  • public float FlattenTarget

    The height the tool pulls towards, in metres.

  • public bool PickTarget

    Whether the target is taken from the ground at the start of each stroke.

  • public float RampWidth

    How far the ramp reaches either side of its line, in metres.

  • public float RampFalloff

    How much of that half-width is falloff rather than flat, 0…1.

  • public float Talus

    The steepest slope that holds, as a rise in metres over one quad.

  • public float ErosionRate

    How much of the excess moves per pass, 0…1.

  • public int Iterations

    How many passes one stamp runs.

  • public float HydroRate

    How fast water moves material, 0…1.

  • public float Amplitude

    How far the noise moves the ground, in metres.

  • public int Octaves

    How many layers of detail.

  • public float Frequency

    How many samples one period of the coarsest octave spans, inverted.

  • public float Lacunarity

    How much finer each octave is than the last.

  • public float Gain

    How much quieter each octave is than the last.

  • public bool Ridged

    Whether the noise is folded about zero, which makes ridges instead of hills.

  • public int Seed

    What the noise lattice derives from.

  • public float HoleThreshold

    How much brush weight a sample needs before it becomes a hole, 0…1.

  • public int Coverage

    How much weight a stamp at full strength adds, out of 255.

  • public float TargetCoverage

    What coverage the paint Flatten tool sets, 0…1.

  • public int CoverageNoise

    How far the paint Noise tool moves the weight, out of 255.

  • public bool IsPainting

    Whether the drag is a paint stroke rather than a sculpt one.

  • public bool IsPaintFlatten

    Whether the paint Flatten rows apply.

  • public bool IsPaintNoise

    Whether the paint Noise rows apply.

  • public bool IsSculpt

    Whether the sculpt rows apply.

  • public bool IsSmooth

    Whether the smooth rows apply.

  • public bool IsFlatten

    Whether the flatten rows apply.

  • public bool IsRamp

    Whether the ramp rows apply.

  • public bool IsErosion

    Whether the erosion rows apply.

  • public bool IsHydro

    Whether the hydro rows apply.

  • public bool IsNoise

    Whether the noise rows apply.

  • public bool IsHoles

    Whether the hole rows apply.

  • public bool IsIterative

    Whether the tool runs a settable number of passes per stamp.

Methods (2)

  • public TerrainNoise ToNoise()

    The noise the Noise tool adds, as the kernel takes it.

  • public int PassesOf(TerrainTool tool)

    How many passes of the held tool one stamp runs.

Used by (8)

  • Describes_Vixen_Editor_Terrain_TerrainToolSettingsVixen.Editor.Terrain
  • SculptSessionTestsVixen.Editor.Terrain.Tests
  • TerrainEditVixen.Editor.Terrain
  • TerrainEditTestsVixen.Editor.Terrain.Tests
  • TerrainModeVixen.Editor.Terrain
  • TerrainModeTestsVixen.Editor.Terrain.Tests
  • TerrainPaintModeTestsVixen.Editor.Terrain.Tests
  • TerrainPanelTestsVixen.Editor.Terrain.Tests