Documentation / scene / WaterSurfaceSamplerOptions

Interface: WaterSurfaceSamplerOptions

Defined in: libs/scene/src/scene/water_surface_sampler.ts:23

Options for WaterSurfaceSampler.

Properties

spacing?

optional spacing?: number

Defined in: libs/scene/src/scene/water_surface_sampler.ts:25

Lattice cell size in world metres. Defaults to 6.

---

cols?

optional cols?: number

Defined in: libs/scene/src/scene/water_surface_sampler.ts:27

Lattice columns, along X. Defaults to 24.

---

rows?

optional rows?: number

Defined in: libs/scene/src/scene/water_surface_sampler.ts:29

Lattice rows, along Z. Defaults to 24.

---

updateHz?

optional updateHz?: number

Defined in: libs/scene/src/scene/water_surface_sampler.ts:34

Upper bound on the query rate in hertz. The achieved rate is the lower of this and what a batch costs. Defaults to 30.

---

timeConstant?

optional timeConstant?: number

Defined in: libs/scene/src/scene/water_surface_sampler.ts:40

Seconds for the reported height to close most of the gap to a new measurement. Lower is tighter to the wave, higher is heavier. Defaults to 0.25.