Vixen
c7401864

WaterProfilePoint

struct Core/Vixen.Water/WaterBody.cs:58
csharp
public readonly record struct WaterProfilePoint

What a body is like at one point along its spline.

Read the guide page for this →

Remarks

Unreal's four channels, because they are the right four ([35 § D6](../../docs/plan/35-water.md#d6-a-water-body-is-a-spline-and-a-profile-and-there-is-no-new-spline)) — and the fourth is the one everybody forgets until the river is silent.

Authored per control point and interpolated along the curve, so a river narrows into a gorge and widens at its mouth without being two bodies.

Fields and properties (6)

  • public float HalfWidth

    How far the channel reaches either side of the curve, in metres.

  • public float Depth

    How far below the surface the bed sits at the body's middle, in metres.

  • public float Velocity

    How fast the water moves downstream here, in metres per second.

  • public float AudioIntensity

    How loud it is here, 0…1.

  • public static WaterProfilePoint Stream

    A stream: four metres wide, one deep, moving at walking pace.

  • public static WaterProfilePoint Still

    Still water: no width of its own, two metres deep, going nowhere.

Methods (1)

Used by (17)

  • BuoyancyTestsVixen.Water.Tests
  • LakeVixen.Water.Physics.Tests
  • TypeRegistrationVixen.Rendering.Water
  • UnderwaterShapeTestsVixen.Rendering.Water.Tests
  • Vixen_Water_WaterProfilePointSerializerVixen.Water
  • WaterBodyVixen.Water
  • WaterBodyComponentVixen.Rendering.Water
  • WaterCarveTestsVixen.Water.Tests
  • WaterDebugDrawVixen.Rendering.Water
  • WaterEvaluatorTestsVixen.Water.Tests
  • WaterFieldTestsVixen.Water.Tests
  • WaterSurfaceMeshTestsVixen.Water.Tests
  • WaterZoneSystemTestsVixen.Rendering.Water.Tests
  • WaterZoneTestsVixen.Water.Tests
  • WaterBodySettingsVixen.Editor.Water
  • WaterEditVixen.Editor.Water
  • WaterEditTestsVixen.Editor.Water.Tests