public readonly record struct WaterAttenuationHow a sea state attenuates as the ground rises to meet it.
Remarks
⚠ In the evaluator and not in the material ([§ D7](../../docs/plan/35-water.md#d7-waves-are-a-spectrum-summed-as-gerstner-and-the-fft-is-deferred-with-arithmetic)). A wave whose amplitude does not fall off as the ground rises produces a crest that intersects the beach; every project that hits it solves the visible half in a material, and then discovers that buoyancy is still using the unattenuated height and a boat in the shallows is bobbing through the sand.
Unreal exposes the same number per body as Wave Attenuation Water Depth. It is here instead because it belongs where everything else about the surface is.
Fields and properties (2)
public float DepthThe depth at which waves are at their full height. Shallower than this they are damped, and at zero depth they are gone.
public static WaterAttenuation DefaultFull height by two metres of depth, which is a beach rather than a harbour wall.
Methods (2)
public WaterAttenuation(float Depth)How a sea state attenuates as the ground rises to meet it.
public float At(float depth)How much of its amplitude a wave keeps at a depth, 0…1.
Used by (14)
- BuoyancyTestsVixen.Water.Tests
- UnderwaterShapeVixen.Rendering.Water
- WaterEvaluatorVixen.Water
- WaterEvaluatorTestsVixen.Water.Tests
- WaterMeshRendererVixen.Rendering.Water
- WaterQueryVixen.Water
- WaterRippleTestsVixen.Water.Tests
- WaterSurfaceMeshVixen.Water
- WaterSurfaceMeshTestsVixen.Water.Tests
- WaterSurfaceSeamDeviceTestsVixen.Graphics.Golden.Tests
- WaterWaveTestsVixen.Water.Tests
- WaterZoneStateVixen.Water
- WaterZoneSystemVixen.Rendering.Water
- WaterPresenterVixen.Editor.App