FluidSample

record in OpalScript

Detached sample of committed liquid at one world point; does not expose particle arrays.

Properties

Member	Description
FluidSample.Present	Coverage is at least 0.4 at this point.
FluidSample.Coverage	Approximate kernel occupancy from 0 to 1; not a volume fraction or measured depth.
FluidSample.VelocityX	Locally weighted horizontal water velocity in pixels per second.
FluidSample.VelocityY	Locally weighted vertical water velocity in pixels per second (down positive).
FluidSample.Speed	Magnitude of the weighted water velocity.

See also

• Fluid2D
• Scripts
• Scripting API