TerrainSplineSettings

Remarks

A mutable settings object beside the immutable TerrainSplineProfile, for TerrainBrushSettings's reason: a deformation has to be the same profile from one end of the road to the other, so what a panel edits and what a regeneration is run with are two objects and ToProfile is where they meet.

⚠ The two side falloffs are separate, and that is not symmetry pedantry. A road cut into a hillside has a cutting on the uphill side and an embankment on the downhill one, and one number for both makes every mountain road look like it was laid on a plain.

⚠ Splines write a reserved layer and the brush refuses it. The layer is regenerated wholesale from the roads, so anything sculpted into it would be erased the next time any road moved — which is why LayerName names a layer rather than offering the stack.

Fields and properties (14)

• public const float MinimumHalfWidth

  The narrowest road worth deforming for, in metres of half-width.

• public const float MaximumHalfWidth

  And the widest a panel offers.

• public float HalfWidth

  How far the flat part reaches from the centre line, in metres.

• public float FalloffLeft

  How far the ground blends back to itself on the left, in metres.

• public float FalloffRight

  And on the right.

• public float Strength

  How much of the way to the road's own height the ground is pulled, 0…1.

• public float Depth

  How far below the curve the surface sits, in metres.

• public string LayerName

  Which reserved layer the deformation is written to.

• public int PaintTarget

  Which paint target the road's surface is painted into, or −1 for none.

• public float MeshSpacing

  How far apart meshes are placed along the road, in metres. Zero places none.

• public string Mesh

  What is placed at each of those points, by asset name. Empty places nothing.

• public float Reach

  How far from the centre line a road reaches at all, on its wider side.

• public bool Paints

  Whether the road paints the ground under it as well as shaping it.

• public bool Places

  Whether it places meshes along its length.

Methods (1)

• public TerrainSplineProfile ToProfile()

  What a deformation of these settings is.

Used by (3)

• Describes_Vixen_Editor_Terrain_TerrainSplineSettingsVixen.Editor.Terrain
• TerrainModuleVixen.Editor.Terrain
• TerrainPanelTestsVixen.Editor.App.Tests