Documentation / scene / SurfacePointHit

Interface: SurfacePointHit

Defined in: libs/scene/src/scene/water.ts:51

One evaluated point of a water surface, in world space.

A flat record rather than the Vector3s the public entry point writes into, because the internal batch path allocates one of these per probe per frame and a probe set can be large. nx/ny/nz are only filled when the caller asked for normals; otherwise they stay at the straight-up default.

Properties

x

x: number

Defined in: libs/scene/src/scene/water.ts:53

World X of the displaced surface.

---

y

y: number

Defined in: libs/scene/src/scene/water.ts:55

World Y of the displaced surface.

---

z

z: number

Defined in: libs/scene/src/scene/water.ts:57

World Z of the displaced surface.

---

nx

nx: number

Defined in: libs/scene/src/scene/water.ts:59

X component of the surface normal.

---

ny

ny: number

Defined in: libs/scene/src/scene/water.ts:61

Y component of the surface normal.

---

nz

nz: number

Defined in: libs/scene/src/scene/water.ts:63

Z component of the surface normal.