Documentation / scene / BuoyancyVolumeOptions

Interface: BuoyancyVolumeOptions

Defined in: libs/scene/src/utility/buoyancy.ts:28

Options for BuoyancyVolume.

Extended by

• FloatingBodyOptions

Properties

size

size: Vector3

Defined in: libs/scene/src/utility/buoyancy.ts:30

Full extents of the hull in metres, in its local axes.

---

mass?

optional mass?: number

Defined in: libs/scene/src/utility/buoyancy.ts:35

Mass in kilograms. Sets the lift the fully submerged hull produces; the float height does not depend on it. Defaults to 1000.

---

submergedFraction?

optional submergedFraction?: number

Defined in: libs/scene/src/utility/buoyancy.ts:40

Share of the hull's height below the waterline at rest, which is its density relative to water. Lower floats higher. Defaults to 0.5.

---

probeColumns?

optional probeColumns?: number

Defined in: libs/scene/src/utility/buoyancy.ts:42

Probes across the local X axis. Defaults to 3.

---

probeRows?

optional probeRows?: number

Defined in: libs/scene/src/utility/buoyancy.ts:44

Probes across the local Z axis. Defaults to 3.

---

probeLayers?

optional probeLayers?: number

Defined in: libs/scene/src/utility/buoyancy.ts:46

Probes up the local Y axis. Defaults to 3.

---

gravity?

optional gravity?: number

Defined in: libs/scene/src/utility/buoyancy.ts:48

Gravity in metres per second squared. Defaults to STANDARD_GRAVITY.