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

    Type Alias OceanGeometryOptions

    Options shared by the ocean geometry builders.

    type OceanGeometryOptions = {
        origin?: Vec2;
        rotation?: number;
        size?: number | Vec2;
        surfaceSegments?: number | Vec2;
    }
    Index

    Properties

    origin? rotation? size? surfaceSegments?

    Properties

    origin?: Vec2

    Center offset in world X/Z (meters). Default [0, 0].

    rotation?: number

    Orientation in degrees, rotating the geometry about the +Y axis around origin (counter-clockwise viewed from above). Default 0.

    size?: number | Vec2

    Horizontal extent in world units (meters): a single number for a square, or [width (X), length (Z)]. Default 100000 (100 km).

    surfaceSegments?: number | Vec2

    Water-surface tessellation: a single number for both axes, or [X, Z]. The default 0 uses the fewest triangles needed to fill the footprint outline (a flat surface needs no interior grid — the waves are shaded per-pixel). A positive value lays down a regular subdivision grid, which only matters when vertex displacement is enabled. Default 0.

    Settings

    On This Page

    Properties