ShallowWaterSimulation

Class in WaveHarmonic.Crest.ShallowWater, WaveHarmonic.Crest.ShallowWater

Runs a shallow water simulation at global sea level in a domain around its transform, and injects the results of the simulation into the water data.

Members

Properties

AdditionalWater	Adds meters of additional water into the simulation domain on initialization.
BlendDepthRange	Affects depth-based blending of the simulation and animated waves (m).
BlendPushUpStrength	The intensity at which waves inject water into the simulation.
BlurMaskIterations	Filters the mask.
BlurShapeForRender	Filters the shape prior to rendering to smooth out sharp features.
CourantNumber	Stability measure - limits velocities. Default 0.5.
CullDistance	Disable simulation if viewpoint is more than this distance outside simulation domain.
CullTransitionSpeed	The speed of the transition to its culled state.
Depth	The depth of the water in the shallow water simulation (m).
DrainWaterAtBoundaries	Rate at which to remove water at the boundaries of the domain.
DynamicSeabed	Recompute ground heights every frame.
EnableDistanceCulling	Disable simulation when viewpoint far from domain.
FlowStrength	Multiplies flow output to scale when injecting.
FlowTexture	The baked texture for flow.
FoamStrength	Multiplies foam output to scale when injecting.
FoamTexture	The baked texture for foam.
Friction	Friction applied to water to prevent dampen velocities.
InjectFlow	Add the resulting flow velocities to the water system.
InjectFoam	Add the resulting foam to the water system.
InjectShape	Add the resulting shape to the water system.
LevelTexture	The baked texture for water level.
MaximumDisplacementVertical	Inform water how much this input will displace the water surface vertically.
MaximumResolution	Maximum resolution of simulation grid.
Mode	Whether to use the baked textures.
OvershootReductionStrength	Overshoot is artifacts where the water will spike sharply.
PaddingWidth	Adds padding so that simulation edge can overlap with height inputs without causing a seam (m).
PlaceAtSeaLevel	Places the simulation at sea level.
Preset	Preconfigures the simulation for a specific use case.
SampleDepthProbeDirectly	Whether to sample the Depth Probe directly.
TexelSize	Simulation resolution - width of simulation grid cell (m).
TimeStep	Time step used for simulation (s).
WaterEdgeMargin	Adds a margin around the water level to prevent water from degenerating at a distance and prevents water wall creep (px).
WaterEdgeMarginBakedWidth	Same as Margin Width but for baking only.
WaterEdgeMarginWidth	Width of the margin.
Width	The width of the simulation area (m).

Methods

ResetSimulation

Resets the simulation. Needs to be called after certain property changes.