public sealed class TerrainCreateSettingsThe create and manage section of the terrain panel.
Remarks
[docs/plan/31 § The terrain panel], as a settings object rather than as dialog code. Every row is an [Inspector] member of a [DataContract] type, which is [20 § B6]'s bargain for world settings and is what makes the form testable without a window.
⚠ The tile size is offered in quads and stored in samples. An artist reads "63 / 127 / 255", because that is what both references call it and because it is the number of quads a section spans; Jolt requires a power-of-two sample count and rejects anything else by returning nothing at all. The two differ by one and the form is where the translation happens, once — see [§ D2].
Fields and properties (11)
public static IReadOnlyList<int> TileQuadChoicesThe tile sizes the form offers, in quads.
public int TileSamplesHow many samples a tile spans, along each axis. A power of two.
public int TilesXHow many tiles across.
public int TilesZHow many tiles deep.
public float MetresPerQuadHow far apart two samples are, in metres.
public float MinHeightThe lowest height the terrain can hold, in metres.
public float MaxHeightAnd the highest.
public float BaseHeightWhat the ground starts at, in metres.
public TerrainDescription DescriptionWhat the form describes.
public TerrainFacts FactsWhat it costs, as the form is being filled in.
public bool IsValidWhether the form can be submitted.
Methods (4)
public string? Validate()Why the form cannot be submitted, or if it can.
public Terrain Build()Builds the terrain the form describes.
public static TerrainCreateSettings Of(Terrain terrain)Fills the form in from a terrain that already exists, for the manage section.
public string? Consequence(Terrain terrain)What applying the form to an existing terrain would do to it.
Used by (6)
- Describes_Vixen_Editor_Terrain_TerrainCreateSettingsVixen.Editor.Terrain
- SculptSessionTestsVixen.Editor.Terrain.Tests
- TerrainModeVixen.Editor.Terrain
- TerrainModeTestsVixen.Editor.Terrain.Tests
- TerrainModuleVixen.Editor.Terrain
- TerrainPanelTestsVixen.Editor.Terrain.Tests