threejs-worldgen
    Preparing search index...

    Class Site

    The ground under a settlement, sampled once on a regular grid so the whole generator (roads, lots, terrain flattening) reads cheap bilinear lookups instead of the full world noise. Pure data: build it from a world frame with Site.fromFrame, or from any SiteFn (tests do).

    Index
    • Allocates an unsampled grid of count × count samples, cell metres apart, from (minX, minZ).

      Parameters

      • minX: number
      • minZ: number
      • cell: number
      • count: number

      Returns Site

    cell: number

    Grid spacing, metres.

    count: number

    Samples per side.

    heights: Float32Array

    Heights, row-major (z rows of x samples).

    minX: number

    West edge (min x) of the grid.

    minZ: number

    North edge (min z) of the grid.

    water: Float32Array

    Water surface per sample, NaN where dry.

    • True if (x, z) lies inside the sampled area.

      Parameters

      • x: number
      • z: number

      Returns boolean

    • Height gradient (dh/dx, dh/dz) by central differences over one cell.

      Parameters

      • x: number
      • z: number
      • out: [number, number] = ...

      Returns [number, number]

    • Bilinear terrain height (clamped to the grid).

      Parameters

      • x: number
      • z: number

      Returns number

    • Slope (rise / run).

      Parameters

      • x: number
      • z: number

      Returns number

    • Highest water surface among the four surrounding samples, or NaN if all are dry.

      Parameters

      • x: number
      • z: number

      Returns number

    • True where the ground is under water (more than half of the surrounding samples are wet).

      Parameters

      • x: number
      • z: number

      Returns boolean

    • A square grid centred on (cx, cz) reaching radius metres out, cell metres apart (unsampled).

      Parameters

      • cx: number
      • cz: number
      • radius: number
      • cell: number

      Returns Site

    • Builds and fills a grid from a world frame.

      Parameters

      • frame: LocalFrame
      • cx: number
      • cz: number
      • radius: number
      • cell: number

      Returns Site