Vixen
c7401864
csharp
public interface IWaterRipples

A ripple simulation's contribution, where one covers a place.

Read the guide page for this →

Remarks

⚠ Separate from the wave sum in the evaluator's signature, and the asymmetry is the point — [35 § D12](../../docs/plan/35-water.md#d12-ripples-are-a-sliding-window-height-field-and-they-are-displacement-not-geometry). The closed-form part is exact and is held to a tolerance of exact-to-the-float; the simulated part is a height field advanced a step at a time, is compared at a stated non-exact tolerance, and cannot answer "where was the surface six ticks ago" at all.

So a caller that needs the exact one — the network path, rolling back six ticks — asks for it alone, by passing nothing here. That is a decision the signature enforces rather than a convention a comment asks for.

Methods (1)

  • bool TryDisplacement(Vector2 position, out float displacement)

    How far this simulation lifts the surface at a place.

Used by (5)

  • BuoyancyVixen.Water
  • ConstantRipplesVixen.Water.Tests
  • WaterEvaluatorVixen.Water
  • WaterQueryVixen.Water
  • WaterRipplesVixen.Water