Taos API Reference
    Preparing search index...

    Class HeightField

    A normalized [0, 1] height field over a world-space rect, sampled bilinearly. Row-major width × height samples; texel (0, 0) sits at (originX, originZ) and texel (width-1, height-1) at (originX + extentX, originZ + extentZ) — the same mapping the page-gen shader uses when it samples the heightmap texture with a clamping sampler.

    Index

    Constructors

    Properties

    width: number
    height: number
    originX: number
    originZ: number
    extentX: number
    extentZ: number

    Methods

    • Whether the world XZ point lies inside the mapped rect.

      Parameters

      • x: number
      • z: number

      Returns boolean

    • Bilinear normalized height at a world XZ point, or null outside the rect (callers substitute their floor height — mirroring the page-gen shader's floor_height behavior outside the heightmap rect).

      Parameters

      • x: number
      • z: number

      Returns number | null