Taos API Reference
    Preparing search index...

    Interface OceanFlowVortex

    A procedural flow vortex — a swirl of tangential water velocity around a world XZ center (a whirlpool, an eddy).

    interface OceanFlowVortex {
        x: number;
        z: number;
        strength: number;
        radius: number;
        funnelDepth?: number;
        eyeRadius?: number;
        spiralAmp?: number;
        spiralArms?: number;
    }
    Index

    Properties

    x z strength radius funnelDepth? eyeRadius? spiralAmp? spiralArms?

    Properties

    x: number

    Vortex center, world X.

    z: number

    Vortex center, world Z.

    strength: number

    Peak tangential speed (m/s) near the center; positive = CCW seen from above, negative = CW. Falls off linearly to 0 at radius.

    radius: number

    Influence radius (m).

    funnelDepth?: number

    Central bowl depression depth (m) — the whirlpool's dip in the water surface: a smooth (1 - (r/radius)²)² bowl, deepest at the center, easing to 0 at radius. The swirl itself comes from the tangential current advecting the wave crests, not from carved geometry. Default 0 (flat, current only).

    eyeRadius?: number

    Calm-eye radius (m) at the vortex center — the tangential current ramps up from 0 across this radius so a whirlpool keeps a dark, foam-free core (Crest's eye-radius proportion). Default 0 (no eye, flow peaks at the center).

    spiralAmp?: number

    Spiral-arm amplitude (m) — rotating log-spiral ridges carved into the bowl (vertical heightfield, never overhangs) that spin with the current and give the drain its visible swirl. Default 0 (plain bowl).

    spiralArms?: number

    Number of spiral arms. Default 2.

    Settings

    Member Visibility

    On This Page

    Properties