Interface OceanFlowSettings

Procedural horizontal flow driving surface-detail advection.

interface OceanFlowSettings {
    uniformDir?: { x: number; z: number };
    vortices?: readonly OceanFlowVortex[];
    segments?: readonly OceanFlowSegment[];
}

Index

Properties

uniformDir? vortices? segments?

Properties

`Optional`uniformDir

uniformDir?: { x: number; z: number }

Uniform current velocity (m/s) — a river/tide. Omit for none.

`Optional`vortices

vortices?: readonly OceanFlowVortex[]

Up to OCEAN_MAX_FLOW_VORTICES swirls (whirlpools/eddies).

`Optional`segments

segments?: readonly OceanFlowSegment[]

Up to OCEAN_MAX_FLOW_SEGMENTS directed line currents (rivers).