Cesium Utils - v0.4.6
    Preparing search index...

    Class HybridTerrainProvider

    Provides terrain by delegating requests to different terrain providers based on geographic regions and zoom levels. This allows combining multiple terrain sources into a single seamless terrain.

    // Tile-coordinate based for precise control (multiple levels)
    const customTiles: TerrainTiles = new Map();
    customTiles.set(15, { x: [55852, 55871], y: [9556, 9575] });
    customTiles.set(16, { x: [111704, 111742], y: [19112, 19150] });

    const hybridTerrain = new HybridTerrainProvider({
      regions: [
        {
          provider: customProvider,
          tiles: customTiles,
        }
      ],
      defaultProvider: worldTerrain
    });

    viewer.terrainProvider = hybridTerrain;

    Implements

    • TerrainProvider
    Index

    Constructors

    constructor

    Properties

    _availability? _defaultProvider _errorEvent _fallbackProvider _hasVertexNormals _hasWaterMask _ready _regions _removeEventListeners _tilingScheme

    Accessors

    availability credit defaultProvider errorEvent fallbackProvider hasVertexNormals hasWaterMask ready regions tilingScheme

    Methods

    destroy getLevelMaximumGeometricError getTileDataAvailable loadTileDataAvailability requestTileGeometry

    Constructors

    Properties

    Private Optional_availability

    _availability?: TileAvailability

    Private_defaultProvider

    _defaultProvider: TerrainProvider

    Private_errorEvent

    _errorEvent: Event<ErrorEvent>

    Private_fallbackProvider

    _fallbackProvider: TerrainProvider

    This will be removed in 0.5.0.

    Private_hasVertexNormals

    _hasVertexNormals: boolean

    Private_hasWaterMask

    _hasWaterMask: boolean

    Private_ready

    _ready: boolean = false

    Private_regions

    _regions: HybridTerrainProvider.TerrainRegion[]

    Private_removeEventListeners

    _removeEventListeners: RemoveCallback[]

    Private_tilingScheme

    _tilingScheme: TilingScheme

    Accessors

    • get availability(): TileAvailability | undefined

      Gets an object that can be used to determine availability of terrain from this provider.

      Returns TileAvailability | undefined

    • get credit(): Credit

      Gets all the credits to display from registered providers when this terrain provider is active. Typically this is used to credit the source of the terrain.

      Returns Credit

    • get errorEvent(): Event<ErrorEvent>

      Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

      Returns Event<ErrorEvent>

    • get hasVertexNormals(): boolean

      Gets a value indicating whether or not the requested tiles include vertex normals.

      Returns boolean

    • get hasWaterMask(): boolean

      Gets a value indicating whether or not the provider includes a water mask. The water mask indicates which areas of the globe are water rather than land, so they can be rendered as a reflective surface with animated waves.

      Returns boolean

    • get ready(): boolean

      Gets a value indicating whether or not the provider is ready for use, or a promise that resolves when the provider becomes ready.

      Returns boolean

    • get tilingScheme(): TilingScheme

      Gets the tiling scheme used by this provider.

      Returns TilingScheme

    Methods

    • Cleans up resources used in the HybridTerrainProvider.

      This method only releases additional resources used to instantiate the HybridTerrainProvider.

      Returns void

    • Gets the maximum geometric error allowed in a tile at a given level, taken as the worst case across the default provider and all region providers. Because the hybrid provider's coverage is a composition of multiple sources, the reported error reflects the highest error any source could contribute at this level, ensuring the LOD system refines conservatively enough for all sources.

      Parameters

      • level: number

        The tile level for which to get the maximum geometric error.

      Returns number

      The maximum geometric error across all providers.

    • Determines whether data for a tile is available to be loaded. Checks the specified terrain regions first.

      Parameters

      • x: number

        The X coordinate of the tile for which to request geometry.

      • y: number

        The Y coordinate of the tile for which to request geometry.

      • level: number

        The level of the tile for which to request geometry.

      Returns boolean | undefined

      Undefined if not supported by the terrain provider, otherwise true or false.

    • Makes sure we load availability data for a tile

      Parameters

      • x: number

        The X coordinate of the tile for which to request geometry.

      • y: number

        The Y coordinate of the tile for which to request geometry.

      • level: number

        The level of the tile for which to request geometry.

      Returns Promise<void> | undefined

      Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded

    • Requests the terrain for a given tile coordinate.

      Parameters

      • x: number

        The X coordinate of the tile.

      • y: number

        The Y coordinate of the tile.

      • level: number

        The zoom level of the tile.

      • Optionalrequest: Request

        The request.

      Returns Promise<TerrainData> | undefined

      A promise for the requested terrain.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods