Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerrainTileLayerStyle

Configuration style for a 3D terrain tile layer.

This class controls the visual appearance of terrain tiles, including vertical exaggeration, lighting, material properties, and sky background color.

It implements the LayerStyle interface and can be passed to the style field of TerrainTileLayerOptions.

Hierarchy

  • TerrainTileLayerStyle

Implements

Index

Constructors

Constructors

constructor

  • Creates a new instance of TerrainTileLayerStyle.

    Parameters

    • Default value style: { backgroundColor?: LayerStyle["backgroundColor"]; exaggeration?: number; light?: (AmbientLight | DirectionalLight)[]; material?: Material; skyColor?: LayerStyle["skyColor"] } = {}

      Optional configuration object for terrain style parameters.

      • Optional backgroundColor?: LayerStyle["backgroundColor"]

        Defines the background color of the terrain layer, shown when terrain data is not fully loaded.

      • Optional exaggeration?: number

        Elevation scale multiplier applied during rendering. This visually scales the terrain heights (e.g. 1 = real scale, 2 = double vertical exaggeration).

        Also known as "vertical exaggeration". Has no effect on the actual height data.

        defaultvalue

        1

      • Optional light?: (AmbientLight | DirectionalLight)[]

        Lights to illuminate the terrain surface.

        Can include ambient and directional lights to control shading effects. If omitted, a default terrain light setup is used, which is just a simple ambient light (no directional lights).

      • Optional material?: Material

        Material properties applied to the terrain mesh.

        This defines visual attributes such as color, shading, or roughness, depending on the renderer's material model.

      • Optional skyColor?: LayerStyle["skyColor"]

        Defines the sky color of the map LayerStyle.skyColor

    Returns TerrainTileLayerStyle

Generated using TypeDoc