@itwin/core-frontend 4.5.0-dev.2 → 4.5.0-dev.21

package/lib/esm/tile/map/TerrainMeshProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainMeshProvider.js","sourceRoot":"","sources":["../../../../src/tile/map/TerrainMeshProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAqD5E;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,mBAAmB;IAWvC;;;OAGG;IACI,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;IAE5E;;;OAGG;IACI,eAAe,CAAC,OAAe;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAKD;;;OAGG;IACI,mBAAmB,CAAC,MAAc,EAAE,SAA4B,EAAE,MAAe;QACtF,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;IAC3J,CAAC;IAKD;;;OAGG;IACI,aAAa,CAAC,KAAc,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;CAChE","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { Range1d } from \"@itwin/core-geometry\";\r\nimport { ApproximateTerrainHeights } from \"../../ApproximateTerrainHeights\";\r\nimport { ScreenViewport } from \"../../Viewport\";\r\nimport { RealityMeshParams } from \"../../render/RealityMeshParams\";\r\nimport {\r\n  MapCartoRectangle, MapTile, MapTilingScheme, QuadId,\r\n} from \"../internal\";\r\n\r\n/** Options supplied to [[TerrainProvider.createTerrainMeshProvider]] to construct a [[TerrainMeshProvider]].\r\n * @public\r\n */\r\nexport interface TerrainMeshProviderOptions {\r\n  /** A scale factor to be applied to the height of the terrain meshes.\r\n   * @see [TerrainSettings.exaggeration]($common).\r\n   */\r\n  exaggeration: number;\r\n  /** If true, the meshes should include \"skirts\" around their edges.\r\n   * Skirts add new geometry to each of the four sides of a tile, extending downward. This helps to hide small cracks between adjacent tiles.\r\n   * However, if transparency is applied to the terrain then, rather than hiding slight imperfections, the skirts themselves become visible.\r\n   * So skirts are only requested when the terrain is displayed without transparency.\r\n   *\r\n   * A [[TerrainMeshProvider]] can ignore the request for skirts if it considers the risk of visible cracks acceptable.\r\n   */\r\n  wantSkirts: boolean;\r\n  /** If true, each vertex of the terrain meshes should include a normal vector. Normals are requested when lighting or [ThematicDisplay]($common) are applied\r\n   * to the terrain.\r\n   *\r\n   * A [[TerrainmeshProvider can ignore the request to produce normals, but doing so will prevent lighting and thematic display from applying to its terrain meshes.\r\n   */\r\n  wantNormals: boolean;\r\n}\r\n\r\n/** Arguments supplied to [[TerrainMeshProvider.requestMeshData]].\r\n * @public\r\n */\r\nexport interface RequestMeshDataArgs {\r\n  /** The tile for which the terrain mesh is being requested. */\r\n  tile: MapTile;\r\n  /** Returns true if the request has been cancelled. Check this after performing an asynchronous action, and abort `requestMeshData` if it returns true. */\r\n  isCanceled(): boolean;\r\n}\r\n\r\n/** Arguments supplied to [[TerrainMeshProvider.readMesh]].\r\n * @public\r\n */\r\nexport interface ReadMeshArgs {\r\n  /** The mesh data obtained from [[TerrainMeshProvider.requestMeshData]]. */\r\n  data: any;\r\n  /** The tile for which the terrain mesh is being generated. */\r\n  tile: MapTile;\r\n  /** Returns true if the request has been cancelled. Check this after performing an asynchronous action, and abort `readMesh` if it returns true. */\r\n  isCanceled(): boolean;\r\n}\r\n\r\n/** Provides 3d meshes representing terrain for display in a [[Viewport]].\r\n * Each mesh represents the terrain within a rectangular region of the Earth associated with a [[MapTile]].\r\n * The display system drapes background map imagery onto these meshes.\r\n * `TerrainMeshProvider`s are obtained from [[TerrainProvider]]s.\r\n * @note A terrain mesh provider is expected to produce terrain for all areas of the globe. If it lacks terrain data for an area of the globe,\r\n * it might choose to fall back to producing smooth terrain using an [[EllipsoidTerrainProvider]].\r\n * @see [[EllipsoidTerrainProvider]] for an example implementation that provides smooth terrain meshes.\r\n * @see [BingTerrainMeshProvider](https://github.com/iTwin/itwinjs-core/blob/master/test-apps/display-test-app/src/frontend/BingTerrainProvider.ts) for an example\r\n * implementation that produces 3d terrain meshes from elevations provided by [[BingElevationProvider]].\r\n * @public\r\n */\r\nexport abstract class TerrainMeshProvider {\r\n  /** Obtain a representation of the terrain for a specific [[MapTile]]. The result will subsequently be supplied to [[readMesh]] to produce the mesh.\r\n   * Return `undefined` if no mesh data could be obtained.\r\n   */\r\n  public abstract requestMeshData(args: RequestMeshDataArgs): Promise<any>;\r\n\r\n  /** Convert the terrain data supplied by [[requestMeshData]] into a terrain mesh.\r\n   * @see [[RealityMeshParamsBuilder]] to simplify the process of creating the mesh.\r\n   */\r\n  public abstract readMesh(args: ReadMeshArgs): Promise<RealityMeshParams | undefined>;\r\n\r\n  /** Add attribution logo cards for the terrain data supplied by this provider to the [[Viewport]]'s logo div.\r\n   * For example, a provider that produces meshes from [Bing Maps](https://docs.microsoft.com/en-us/bingmaps/rest-services/elevations/) would be required to\r\n   * disclose any copyrighted data used in the production of those meshes.\r\n   */\r\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\r\n\r\n  /** Return whether terrain data can be obtained for the [[MapTile]] specified by `quadId`. If it returns false, a terrain mesh will instead be produced for\r\n   * that tile by up-sampling the terrain mesh provided by its parent tile.\r\n   * The default implementation returns `true`.\r\n   */\r\n  public isTileAvailable(_quadId: QuadId): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Returns the maximum level of detail of the terrain meshes. */\r\n  public abstract get maxDepth(): number;\r\n\r\n  /** Returns the minimum and maximum elevation of the terrain within the specified region of the Earth.\r\n   * This range is used for culling terrain meshes that do not intersect the view frustum.\r\n   * The default implementation uses a fast approximation.\r\n   */\r\n  public getChildHeightRange(quadId: QuadId, rectangle: MapCartoRectangle, parent: MapTile): Range1d | undefined {\r\n    return (quadId.level < ApproximateTerrainHeights.maxLevel) ? ApproximateTerrainHeights.instance.getMinimumMaximumHeights(rectangle) : parent.heightRange;\r\n  }\r\n\r\n  /** The tiling scheme used by this provider to convert between tile coordinates and geodetic coordinates. */\r\n  public abstract get tilingScheme(): MapTilingScheme;\r\n\r\n  /** Returns true if the specified tile should always be loaded. Some tiles contain required metadata and hence should always be loaded.\r\n   * For example, a parent tile might contain information about the availability or height ranges of its child tiles that can be used to\r\n   * implement [[isTileAvailable]] or [[getChildHeightRange]], respectively.\r\n   */\r\n  public forceTileLoad(_tile: MapTile): boolean { return false; }\r\n}\r\n"]}
+{"version":3,"file":"TerrainMeshProvider.js","sourceRoot":"","sources":["../../../../src/tile/map/TerrainMeshProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAuD5E;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,mBAAmB;IAWvC;;;OAGG;IACI,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;IAE5E;;;OAGG;IACI,eAAe,CAAC,OAAe;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAKD;;;OAGG;IACI,mBAAmB,CAAC,MAAc,EAAE,SAA4B,EAAE,MAAe;QACtF,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;IAC3J,CAAC;IAKD;;;OAGG;IACI,aAAa,CAAC,KAAc,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;CAChE","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { Range1d } from \"@itwin/core-geometry\";\r\nimport { ApproximateTerrainHeights } from \"../../ApproximateTerrainHeights\";\r\nimport { ScreenViewport } from \"../../Viewport\";\r\nimport { RealityMeshParams } from \"../../render/RealityMeshParams\";\r\nimport {\r\n  MapCartoRectangle, MapTile, MapTilingScheme, QuadId,\r\n} from \"../internal\";\r\n\r\n/** Options supplied to [[TerrainProvider.createTerrainMeshProvider]] to construct a [[TerrainMeshProvider]].\r\n * @public\r\n */\r\nexport interface TerrainMeshProviderOptions {\r\n  /** A scale factor to be applied to the height of the terrain meshes.\r\n   * @see [TerrainSettings.exaggeration]($common).\r\n   */\r\n  exaggeration: number;\r\n  /** If true, the meshes should include \"skirts\" around their edges.\r\n   * Skirts add new geometry to each of the four sides of a tile, extending downward. This helps to hide small cracks between adjacent tiles.\r\n   * However, if transparency is applied to the terrain then, rather than hiding slight imperfections, the skirts themselves become visible.\r\n   * So skirts are only requested when the terrain is displayed without transparency.\r\n   *\r\n   * A [[TerrainMeshProvider]] can ignore the request for skirts if it considers the risk of visible cracks acceptable.\r\n   */\r\n  wantSkirts: boolean;\r\n  /** If true, each vertex of the terrain meshes should include a normal vector. Normals are requested when lighting or [ThematicDisplay]($common) are applied\r\n   * to the terrain.\r\n   *\r\n   * A [[TerrainmeshProvider can ignore the request to produce normals, but doing so will prevent lighting and thematic display from applying to its terrain meshes.\r\n   */\r\n  wantNormals: boolean;\r\n  /** Optionally identifies a specific terrain data source supplied by the [[TerrainMeshProvider]]. */\r\n  dataSource?: string;\r\n}\r\n\r\n/** Arguments supplied to [[TerrainMeshProvider.requestMeshData]].\r\n * @public\r\n */\r\nexport interface RequestMeshDataArgs {\r\n  /** The tile for which the terrain mesh is being requested. */\r\n  tile: MapTile;\r\n  /** Returns true if the request has been cancelled. Check this after performing an asynchronous action, and abort `requestMeshData` if it returns true. */\r\n  isCanceled(): boolean;\r\n}\r\n\r\n/** Arguments supplied to [[TerrainMeshProvider.readMesh]].\r\n * @public\r\n */\r\nexport interface ReadMeshArgs {\r\n  /** The mesh data obtained from [[TerrainMeshProvider.requestMeshData]]. */\r\n  data: any;\r\n  /** The tile for which the terrain mesh is being generated. */\r\n  tile: MapTile;\r\n  /** Returns true if the request has been cancelled. Check this after performing an asynchronous action, and abort `readMesh` if it returns true. */\r\n  isCanceled(): boolean;\r\n}\r\n\r\n/** Provides 3d meshes representing terrain for display in a [[Viewport]].\r\n * Each mesh represents the terrain within a rectangular region of the Earth associated with a [[MapTile]].\r\n * The display system drapes background map imagery onto these meshes.\r\n * `TerrainMeshProvider`s are obtained from [[TerrainProvider]]s.\r\n * @note A terrain mesh provider is expected to produce terrain for all areas of the globe. If it lacks terrain data for an area of the globe,\r\n * it might choose to fall back to producing smooth terrain using an [[EllipsoidTerrainProvider]].\r\n * @see [[EllipsoidTerrainProvider]] for an example implementation that provides smooth terrain meshes.\r\n * @see [BingTerrainMeshProvider](https://github.com/iTwin/itwinjs-core/blob/master/test-apps/display-test-app/src/frontend/BingTerrainProvider.ts) for an example\r\n * implementation that produces 3d terrain meshes from elevations provided by [[BingElevationProvider]].\r\n * @public\r\n */\r\nexport abstract class TerrainMeshProvider {\r\n  /** Obtain a representation of the terrain for a specific [[MapTile]]. The result will subsequently be supplied to [[readMesh]] to produce the mesh.\r\n   * Return `undefined` if no mesh data could be obtained.\r\n   */\r\n  public abstract requestMeshData(args: RequestMeshDataArgs): Promise<any>;\r\n\r\n  /** Convert the terrain data supplied by [[requestMeshData]] into a terrain mesh.\r\n   * @see [[RealityMeshParamsBuilder]] to simplify the process of creating the mesh.\r\n   */\r\n  public abstract readMesh(args: ReadMeshArgs): Promise<RealityMeshParams | undefined>;\r\n\r\n  /** Add attribution logo cards for the terrain data supplied by this provider to the [[Viewport]]'s logo div.\r\n   * For example, a provider that produces meshes from [Bing Maps](https://docs.microsoft.com/en-us/bingmaps/rest-services/elevations/) would be required to\r\n   * disclose any copyrighted data used in the production of those meshes.\r\n   */\r\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\r\n\r\n  /** Return whether terrain data can be obtained for the [[MapTile]] specified by `quadId`. If it returns false, a terrain mesh will instead be produced for\r\n   * that tile by up-sampling the terrain mesh provided by its parent tile.\r\n   * The default implementation returns `true`.\r\n   */\r\n  public isTileAvailable(_quadId: QuadId): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Returns the maximum level of detail of the terrain meshes. */\r\n  public abstract get maxDepth(): number;\r\n\r\n  /** Returns the minimum and maximum elevation of the terrain within the specified region of the Earth.\r\n   * This range is used for culling terrain meshes that do not intersect the view frustum.\r\n   * The default implementation uses a fast approximation.\r\n   */\r\n  public getChildHeightRange(quadId: QuadId, rectangle: MapCartoRectangle, parent: MapTile): Range1d | undefined {\r\n    return (quadId.level < ApproximateTerrainHeights.maxLevel) ? ApproximateTerrainHeights.instance.getMinimumMaximumHeights(rectangle) : parent.heightRange;\r\n  }\r\n\r\n  /** The tiling scheme used by this provider to convert between tile coordinates and geodetic coordinates. */\r\n  public abstract get tilingScheme(): MapTilingScheme;\r\n\r\n  /** Returns true if the specified tile should always be loaded. Some tiles contain required metadata and hence should always be loaded.\r\n   * For example, a parent tile might contain information about the availability or height ranges of its child tiles that can be used to\r\n   * implement [[isTileAvailable]] or [[getChildHeightRange]], respectively.\r\n   */\r\n  public forceTileLoad(_tile: MapTile): boolean { return false; }\r\n}\r\n"]}

package/lib/public/locales/en/iModelJs.json

@@ -37,7 +37,8 @@
   },
   "BackgroundMap": {
     "MapBoxCopyright": "© Mapbox, © OpenStreetMap contributors",
-    "CesiumWorldTerrainAttribution": "Cesium World Terrain: Data available from the U.S. Geological Survey, © CGIAR-CSI, Produced using Copernicus data and information funded by the European Union - EU-DEM layers, Data available from Land Information New Zealand, Data available from data.gov.uk, Data courtesy Geoscience Australia",
+    "CesiumWorldTerrainAttribution": "Cesium World Terrain: Data available from the U.S. Geological Survey, © CGIAR-CSI, Produced using Copernicus data and information funded by the European Union - EU-DEM layers, Data available from Land Information New Zealand, Data available from data.gov.uk, Data courtesy Geoscience Australia.",
+    "CesiumBathymetryAttribution": "GEBCO_2023 Grid: GEBCO Compilation Group (2023) GEBCO 2023 Grid (doi:10.5285/f98b053b-0cbc-6c23-e053-6c86abc0af7b).\nHigh-resolution depth model for the Great Barrier Reef - 30 m: Portions CC BY 4.0 from Beaman, R.J. 2017.\nHigh-resolution depth model for the Great Barrier Reef - 30 m. Geoscience Australia, Canberra.\nswissBATHY3D: ©swisstopo.",
     "OpenStreetMapContributors": "contributors",
     "CannotObtainTerrain": "Terrain is unavailable",
     "MissingCesiumToken": "The application must be configured with a valid Cesium ION access key to obtain 3d terrain data."