Vixen
feb85697
csharp
public sealed class WaterDebugFlags

One set of water's six debug switches, owned by whoever reads it.

Read the guide page for this →

Remarks

An object rather than six statics, so a host can have more than one. Process is the set the console verbs flip and a game draws from; an editor module owns one per session and hands it to Flags, because the test harness opens several editors in one process and a static flag was a checkbox ticked in one of them and drawn in all of them.

⚠ A class and not a record struct, because the reader holds it across frames: a presenter that copied the switches once would draw whatever they were when it copied.

Fields and properties (7)

  • public bool ShowTiles

    Patch bounds, coloured by body kind, with the LOD level as a label.

  • public bool ShowLod

    The morph bands as rings, which is where a pop is diagnosed.

  • public bool ShowInfo

    The info field's four channels as an overlay, individually.

  • public bool ShowFlow

    Flow vectors on the surface, and the spline velocity arrows.

  • public bool ShowBuoyancy

    Pontoons, their submerged fraction, and the forces as arrows.

  • public bool ShowRipples

    The ripple window's bounds and the injection count against the budget.

  • public bool Any

    Whether anything is being drawn at all — the single branch a renderer takes.

Methods (1)

  • public void Reset()

    Switches every one of them off.

Used by (6)

  • WaterDebugVixen.Rendering.Water
  • WaterDebugDrawVixen.Rendering.Water
  • WaterDebugDrawTestsVixen.Rendering.Water.Tests
  • WaterModuleVixen.Editor.Water
  • WaterModuleReachTestsVixen.Editor.App.Tests
  • WaterPresenterVixen.Editor.App