@equinor/videx-3d
    Preparing search index...

    Type Alias OceanEllipseOptions

    OceanEllipseOptions: Omit<OceanGeometryOptions, "surfaceSegments"> & {
        depthVariation?: number;
        perimeterSegments?: number;
        radialSegments?: number;
        seed?: number;
        waterDepth?: number;
    }

    Options for createOceanEllipseBox.

    Type Declaration

    • OptionaldepthVariation?: number

      Sea-bed depth variation in meters (±) around waterDepth. With the defaults the bed varies between 100 m and 200 m. Default 50.

    • OptionalperimeterSegments?: number

      Number of segments around the perimeter. Higher values give a rounder, smoother outline. Default 96.

    • OptionalradialSegments?: number

      Number of segments from the center out to the edge (concentric rings). Higher values resolve the sea-bed depth variation more finely and give smoother wave displacement. The default 0 is auto: just enough rings to keep the radial spacing close to the perimeter spacing (so triangles stay well-shaped without an excessive count). Default 0.

    • Optionalseed?: number

      Seed for the procedural sea-bed variation. Default 0.

    • OptionalwaterDepth?: number

      Mean water depth in meters: distance from the surface (y = 0) down to the sea bed. Default 150.

    Settings