Class MartiniTerrainProvider

StaticfromResources

• fromResources(
      resources: MaybePromiseArray<
          Resource
          | { id: string; resource: Resource },
      >,
      providerOptions?: Options,
  ): Promise<MartiniTerrainProvider>

• Constructs new MartiniTerrainProvider with preconstructed CogResources

  Parameters

  • resources: MaybePromiseArray<Resource | { id: string; resource: Resource }>

    An array of CogResources. The type is a little confusing on TypeDoc; It's an array of constructed CogResources or Promises to them, which can be put inside Promise.all if desired
  • providerOptions: Options = {}

    Since the resources are constructed individually, outside of the provider, these options are not shared with the resources. However, each resource.tileSize must match for the Martini algorithm to work.

  Returns Promise<MartiniTerrainProvider>

  Promise of new MariniTerrainProvider with resources

  Example

  If for any reason you'd like to pre-construct the CogResource(s), you can use this constructor to then create the MartiniTerrainProvider from those resources.

  import { CogResource, MartiniTerrainProvider } from '@landrush/martini-terrain-provider'
  const tileSize = 257 // must be shared amonst Provider & all resources
  const resources = [
    'https://server/cog-0-0.tif',
    'https://server/cog-0-1.tif',
    'https://server/cog-1-0.tif',
    'https://server/cog-1-1.tif'
  ].map(url => CogResource.fromSource(url, { ...resourceOptions, tileSize }))
  const terrainProvider = MartiniTerrainProvider.fromResources(resources, { ...providerOptions, tileSize })
  Copy

  See

  CogResource.fromSource

StaticfromSources

• fromSources(
      sources: (
          | GeoTIFF
          | GeoTiffSource
          | { id: string; source: GeoTIFF | GeoTiffSource }
      )[],
      options?: Options,
  ): Promise<MartiniTerrainProvider>

• Constructs new MartiniTerrainProvider with CogResources created from the GeoTIFF sources. The sources can be URLs, but also allows local/prefetched COG resources, such as from a File or ArrayBuffer

  Parameters

  • sources: (GeoTIFF | GeoTiffSource | { id: string; source: GeoTIFF | GeoTiffSource })[]

    GeoTIFF object (from geotiff.js) or a compatible source
  • options: Options = {}

    Customizable MartiniTerrainProvider settings. tileSize & ellipsoid are also passed to the newly created CogResources

  Returns Promise<MartiniTerrainProvider>

  Promise of new MariniTerrainProvider with resources created from the given sources

  Example

  If you have Cloud-Optimized GeoTIFF data (either a URL or prefetched, like a File or ArrayBuffer), you can pass it directly to this constructor and have the Provider create the necessary CogResource(s)

  import { MartiniTerrainProvider } from '@landrush/martini-terrain-provider'
  const terrainProvider = new MartiniTerrainProvider.fromSources([
    'https://server/cog-0-0.tif',
    'https://server/cog-0-1.tif'
  ], { ...options })
  Copy

_errorAtMinZoom

Readonlyavailability

Readonlycredit

ellipsoid

ReadonlyerrorEvent

ReadonlyhasVertexNormals

ReadonlyhasWaterMask

maxWorkers

minError

minZoomLevel

ready

readyPromise

stitchToBackupTile

terrainExaggeration

tileSize

ReadonlytilingScheme

backupTerrainProvider

• get backupTerrainProvider(): undefined | TerrainProvider

• Returns undefined | TerrainProvider

• set backupTerrainProvider(terrainProvider: undefined | TerrainProvider): void

• Parameters

  • terrainProvider: undefined | TerrainProvider

  Returns void

maxZoom

• get maxZoom(): number

• Returns number

resources

• get resources(): Resource[]

• Returns Resource[]

addResource

• addResource(resource: Resource | Promise<Resource>, id?: string): Promise<void>

• Parameters

  • resource: Resource | Promise<Resource>
  • id: string = ...

  Returns Promise<void>

findResourcesAtPosition

• findResourcesAtPosition(
      position: Cartographic,
  ): undefined | Resource | Resource[]

• Parameters

  • position: Cartographic

  Returns undefined | Resource | Resource[]

getLevelMaximumGeometricError

• getLevelMaximumGeometricError(level: number): number

• Gets the maximum geometric error allowed in a tile at a given level.

  Parameters

  • level: number

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

  Returns number

  The maximum geometric error.

getResource

• getResource(id: string): undefined | Resource

• Parameters

  • id: string

  Returns undefined | Resource

getTileDataAvailable

• getTileDataAvailable(x: number, y: number, z: number): undefined | boolean

• Checks a tile (from x, y, z coordinates) for resources existing within the tile bounds, otherwise calls this._backupTerrainProvider.getTileDataAvailable(x,y,z)

  Parameters

  • x: number

    X coordinate for tile requesting geometry
  • y: number

    Y coordinate for tile requesting geometry
  • z: number

    Level of tile requesting geometry

  Returns undefined | boolean

  boolean indicating availability, or undefined if loading

loadTileDataAvailability

• loadTileDataAvailability(x: number, y: number, level: number): Promise<void>

• 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 if nothing need to be loaded (if no backupTerrainProvider), or a Promise that resolves when all required tiles are loaded

removeResource

• removeResource(id: string): void

• Parameters

  • id: string

  Returns void

requestTileGeometry

• requestTileGeometry(
      x: number,
      y: number,
      z: number,
      req?: Request,
  ): undefined | Promise<TerrainData>

• Requests the geometry for a given tile.

  Parameters

  • x: number

    X coordinate for tile requesting geometry
  • y: number

    Y coordinate for tile requesting geometry
  • z: number

    Level of tile requesting geometry
  • Optionalreq: Request

    Request object. Intended for internal use only

  Returns undefined | Promise<TerrainData>

  Promise for requested geometry, or undefined (indicating too many pending requests)

  See

  Cesium.TerrainProvider#requestTileGeometry

setBackupTerrainProvider

• setBackupTerrainProvider(
      terrainProvider: undefined | TerrainProvider | Promise<TerrainProvider>,
  ): Promise<void>

• Parameters

  • terrainProvider: undefined | TerrainProvider | Promise<TerrainProvider>

  Returns Promise<void>