WaterFieldSample

Remarks

⚠ Depth is Depth and is computed, never stored — [§ D3](../../docs/plan/35-water.md#d3-the-water-info-texture-is-the-interchange-and-it-is-a-zone-render). Storing it would be a third number that can disagree with the two it came from, and the frame it disagrees on is the one where the shoreline is in a different place for the material than for the wave attenuation.

Fields and properties (6)

• public float Coverage

  How much water is here at all, 0…1.

• public float SurfaceHeight

  Where the surface is, in world units.

• public Vector2 Flow

  How fast it moves, in metres per second, on the ground plane.

• public float GroundHeight

  Where the ground under it is, in world units.

• public float Depth

  How deep the water is, in metres. Never negative.

• public static WaterFieldSample None

  Nothing at all.

Methods (1)

• public WaterFieldSample(float Coverage, float SurfaceHeight, Vector2 Flow, float GroundHeight)

  What a field says about one place.

Used by (10)

• WaterDebugDrawVixen.Rendering.Water
• WaterEvaluatorVixen.Water
• WaterFieldVixen.Water
• WaterFieldPyramidVixen.Water
• WaterFieldTestsVixen.Water.Tests
• WaterInfoTextureVixen.Rendering.Water
• WaterSurfaceMeshVixen.Water
• WaterZoneSystemTestsVixen.Rendering.Water.Tests
• WaterZoneTestsVixen.Water.Tests
• WaterPresenterVixen.Editor.App