Taos API Reference
    Preparing search index...

    Interface OceanWaterSplineFlow

    Flow derivation options for OceanWaterSpline.

    interface OceanWaterSplineFlow {
        maxSegments?: number;
        width?: number;
        baseSpeed?: number;
        slopeGain?: number;
        maxSpeed?: number;
    }
    Index

    Properties

    maxSegments?: number

    Flow segments to spend on this spline (equal-arc-length runs). Default OCEAN_MAX_FLOW_SEGMENTS.

    width?: number

    Flow channel width (m). Default spline width + 4.

    baseSpeed?: number

    Drift speed (m/s) on level runs. Default 0.5.

    slopeGain?: number

    Added speed per unit slope (drop / length). Default 20.

    maxSpeed?: number

    Speed cap (m/s). Default 2.5.