Taos API Reference
    Preparing search index...

    Interface WaveInputRippleSpec

    interface WaveInputRippleSpec {
        position: { x: number; z: number };
        wavelength: number;
        amplitude: number;
        radius: number;
        speed?: number;
        phase?: number;
        steepness?: number;
    }
    Index

    Properties

    position wavelength amplitude radius speed? phase? steepness?

    Properties

    position: { x: number; z: number }

    World XZ center of the ripple.

    wavelength: number

    Wave-length of the ring spacing. Picks the LOD.

    amplitude: number

    Peak vertical displacement at the center.

    radius: number

    Radial extent — Gaussian envelope decays to ≈ 5% here.

    speed?: number

    Propagation speed of the rings (world units per second). Default: deep-water dispersion velocity √(g·k)/k = √(g·λ / 2π).

    phase?: number

    Constant phase offset (radians). Useful to de-correlate multiple ripples at the same location.

    steepness?: number

    Lateral chop, [0, 1]. 0 = pure vertical; 1 = aggressive radial chop.

    Settings

    Member Visibility

    On This Page

    Properties