ArcGISTiledElevationTerrainProvider.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828
  1. import Cartesian2 from "./Cartesian2.js";
  2. import Check from "./Check.js";
  3. import Credit from "./Credit.js";
  4. import defaultValue from "./defaultValue.js";
  5. import defined from "./defined.js";
  6. import deprecationWarning from "./deprecationWarning.js";
  7. import Ellipsoid from "./Ellipsoid.js";
  8. import Event from "./Event.js";
  9. import GeographicTilingScheme from "./GeographicTilingScheme.js";
  10. import HeightmapEncoding from "./HeightmapEncoding.js";
  11. import HeightmapTerrainData from "./HeightmapTerrainData.js";
  12. import Rectangle from "./Rectangle.js";
  13. import Request from "./Request.js";
  14. import RequestState from "./RequestState.js";
  15. import RequestType from "./RequestType.js";
  16. import Resource from "./Resource.js";
  17. import RuntimeError from "./RuntimeError.js";
  18. import TerrainProvider from "./TerrainProvider.js";
  19. import TileAvailability from "./TileAvailability.js";
  20. import TileProviderError from "./TileProviderError.js";
  21. import WebMercatorTilingScheme from "./WebMercatorTilingScheme.js";
  22. const ALL_CHILDREN = 15;
  23. /**
  24. * @typedef {Object} ArcGISTiledElevationTerrainProvider.ConstructorOptions
  25. *
  26. * Initialization options for the ArcGISTiledElevationTerrainProvider constructor
  27. *
  28. * @property {string} [token] The authorization token to use to connect to the service.
  29. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified,
  30. * this parameter is ignored and the tiling scheme's ellipsoid is used instead.
  31. * If neither parameter is specified, the WGS84 ellipsoid is used.
  32. * @property {Resource|string|Promise<Resource>|Promise<string>} [url] The URL of the ArcGIS ImageServer service. Deprecated.
  33. */
  34. /**
  35. * Used to track creation details while fetching initial metadata
  36. *
  37. * @constructor
  38. * @private
  39. *
  40. * @param {ArcGISTiledElevationTerrainProvider.ConstructorOptions} [options] An object describing initialization options.
  41. */
  42. function TerrainProviderBuilder(options) {
  43. this.ellipsoid = defaultValue(options.ellipsoid, Ellipsoid.WGS84);
  44. this.credit = undefined;
  45. this.tilingScheme = undefined;
  46. this.height = undefined;
  47. this.width = undefined;
  48. this.encoding = undefined;
  49. this.lodCount = undefined;
  50. this.hasAvailability = false;
  51. this.tilesAvailable = undefined;
  52. this.tilesAvailabilityLoaded = undefined;
  53. this.levelZeroMaximumGeometricError = undefined;
  54. this.terrainDataStructure = undefined;
  55. }
  56. /**
  57. * Complete ArcGISTiledElevationTerrainProvider creation based on builder values.
  58. *
  59. * @private
  60. *
  61. * @param {ArcGISTiledElevationTerrainProvider} provider
  62. */
  63. TerrainProviderBuilder.prototype.build = function (provider) {
  64. provider._credit = this.credit;
  65. provider._tilingScheme = this.tilingScheme;
  66. provider._height = this.height;
  67. provider._width = this.width;
  68. provider._encoding = this.encoding;
  69. provider._lodCount = this.lodCount;
  70. provider._hasAvailability = this.hasAvailability;
  71. provider._tilesAvailable = this.tilesAvailable;
  72. provider._tilesAvailabilityLoaded = this.tilesAvailabilityLoaded;
  73. provider._levelZeroMaximumGeometricError = this.levelZeroMaximumGeometricError;
  74. provider._terrainDataStructure = this.terrainDataStructure;
  75. provider._ready = true;
  76. };
  77. function parseMetadataSuccess(terrainProviderBuilder, metadata) {
  78. const copyrightText = metadata.copyrightText;
  79. if (defined(copyrightText)) {
  80. terrainProviderBuilder.credit = new Credit(copyrightText);
  81. }
  82. const spatialReference = metadata.spatialReference;
  83. const wkid = defaultValue(spatialReference.latestWkid, spatialReference.wkid);
  84. const extent = metadata.extent;
  85. const tilingSchemeOptions = {
  86. ellipsoid: terrainProviderBuilder.ellipsoid,
  87. };
  88. if (wkid === 4326) {
  89. tilingSchemeOptions.rectangle = Rectangle.fromDegrees(
  90. extent.xmin,
  91. extent.ymin,
  92. extent.xmax,
  93. extent.ymax
  94. );
  95. terrainProviderBuilder.tilingScheme = new GeographicTilingScheme(
  96. tilingSchemeOptions
  97. );
  98. } else if (wkid === 3857) {
  99. // Clamp extent to EPSG 3857 bounds
  100. const epsg3857Bounds =
  101. Math.PI * terrainProviderBuilder.ellipsoid.maximumRadius;
  102. if (metadata.extent.xmax > epsg3857Bounds) {
  103. metadata.extent.xmax = epsg3857Bounds;
  104. }
  105. if (metadata.extent.ymax > epsg3857Bounds) {
  106. metadata.extent.ymax = epsg3857Bounds;
  107. }
  108. if (metadata.extent.xmin < -epsg3857Bounds) {
  109. metadata.extent.xmin = -epsg3857Bounds;
  110. }
  111. if (metadata.extent.ymin < -epsg3857Bounds) {
  112. metadata.extent.ymin = -epsg3857Bounds;
  113. }
  114. tilingSchemeOptions.rectangleSouthwestInMeters = new Cartesian2(
  115. extent.xmin,
  116. extent.ymin
  117. );
  118. tilingSchemeOptions.rectangleNortheastInMeters = new Cartesian2(
  119. extent.xmax,
  120. extent.ymax
  121. );
  122. terrainProviderBuilder.tilingScheme = new WebMercatorTilingScheme(
  123. tilingSchemeOptions
  124. );
  125. } else {
  126. throw new RuntimeError("Invalid spatial reference");
  127. }
  128. const tileInfo = metadata.tileInfo;
  129. if (!defined(tileInfo)) {
  130. throw new RuntimeError("tileInfo is required");
  131. }
  132. terrainProviderBuilder.width = tileInfo.rows + 1;
  133. terrainProviderBuilder.height = tileInfo.cols + 1;
  134. terrainProviderBuilder.encoding =
  135. tileInfo.format === "LERC"
  136. ? HeightmapEncoding.LERC
  137. : HeightmapEncoding.NONE;
  138. terrainProviderBuilder.lodCount = tileInfo.lods.length - 1;
  139. const hasAvailability = (terrainProviderBuilder.hasAvailability =
  140. metadata.capabilities.indexOf("Tilemap") !== -1);
  141. if (hasAvailability) {
  142. terrainProviderBuilder.tilesAvailable = new TileAvailability(
  143. terrainProviderBuilder.tilingScheme,
  144. terrainProviderBuilder.lodCount
  145. );
  146. terrainProviderBuilder.tilesAvailable.addAvailableTileRange(
  147. 0,
  148. 0,
  149. 0,
  150. terrainProviderBuilder.tilingScheme.getNumberOfXTilesAtLevel(0),
  151. terrainProviderBuilder.tilingScheme.getNumberOfYTilesAtLevel(0)
  152. );
  153. terrainProviderBuilder.tilesAvailabilityLoaded = new TileAvailability(
  154. terrainProviderBuilder.tilingScheme,
  155. terrainProviderBuilder.lodCount
  156. );
  157. }
  158. terrainProviderBuilder.levelZeroMaximumGeometricError = TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap(
  159. terrainProviderBuilder.tilingScheme.ellipsoid,
  160. terrainProviderBuilder.width,
  161. terrainProviderBuilder.tilingScheme.getNumberOfXTilesAtLevel(0)
  162. );
  163. if (metadata.bandCount > 1) {
  164. console.log(
  165. "ArcGISTiledElevationTerrainProvider: Terrain data has more than 1 band. Using the first one."
  166. );
  167. }
  168. if (defined(metadata.minValues) && defined(metadata.maxValues)) {
  169. terrainProviderBuilder.terrainDataStructure = {
  170. elementMultiplier: 1.0,
  171. lowestEncodedHeight: metadata.minValues[0],
  172. highestEncodedHeight: metadata.maxValues[0],
  173. };
  174. } else {
  175. terrainProviderBuilder.terrainDataStructure = {
  176. elementMultiplier: 1.0,
  177. };
  178. }
  179. }
  180. async function requestMetadata(
  181. terrainProviderBuilder,
  182. metadataResource,
  183. provider
  184. ) {
  185. try {
  186. const metadata = await metadataResource.fetchJson();
  187. parseMetadataSuccess(terrainProviderBuilder, metadata);
  188. } catch (error) {
  189. const message = `An error occurred while accessing ${metadataResource}.`;
  190. TileProviderError.reportError(
  191. undefined,
  192. provider,
  193. defined(provider) ? provider._errorEvent : undefined,
  194. message
  195. );
  196. throw error;
  197. }
  198. }
  199. /**
  200. * <div class="notice">
  201. * To construct a CesiumTerrainProvider, call {@link ArcGISTiledElevationTerrainProvider.fromUrl}. Do not call the constructor directly.
  202. * </div>
  203. *
  204. * A {@link TerrainProvider} that produces terrain geometry by tessellating height maps
  205. * retrieved from Elevation Tiles of an an ArcGIS ImageService.
  206. *
  207. * @alias ArcGISTiledElevationTerrainProvider
  208. * @constructor
  209. *
  210. * @param {CesiumTerrainProvider.ConstructorOptions} [options] A url or an object describing initialization options
  211. *
  212. * @example
  213. * const terrainProvider = await Cesium.ArcGISTiledElevationTerrainProvider.fromUrl("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer", {
  214. * token: "KED1aF_I4UzXOHy3BnhwyBHU4l5oY6rO6walkmHoYqGp4XyIWUd5YZUC1ZrLAzvV40pR6gBXQayh0eFA8m6vPg.."
  215. * });
  216. * viewer.terrainProvider = terrainProvider;
  217. *
  218. * @see TerrainProvider
  219. */
  220. function ArcGISTiledElevationTerrainProvider(options) {
  221. options = defaultValue(options, defaultValue.EMPTY_OBJECT);
  222. this._resource = undefined;
  223. this._credit = undefined;
  224. this._tilingScheme = undefined;
  225. this._levelZeroMaximumGeometricError = undefined;
  226. this._maxLevel = undefined;
  227. this._terrainDataStructure = undefined;
  228. this._width = undefined;
  229. this._height = undefined;
  230. this._encoding = undefined;
  231. this._lodCount = undefined;
  232. const token = options.token;
  233. this._hasAvailability = false;
  234. this._tilesAvailable = undefined;
  235. this._tilesAvailabilityLoaded = undefined;
  236. this._availableCache = {};
  237. this._ready = false;
  238. this._errorEvent = new Event();
  239. if (defined(options.url)) {
  240. deprecationWarning(
  241. "ArcGISTiledElevationTerrainProvider options.url",
  242. "options.url was deprecated in CesiumJS 1.104. It will be in CesiumJS 1.107. Use ArcGISTiledElevationTerrainProvider.fromUrl instead."
  243. );
  244. const that = this;
  245. const terrainProviderBuilder = new TerrainProviderBuilder(options);
  246. this._readyPromise = Promise.resolve(options.url).then(async function (
  247. url
  248. ) {
  249. let resource = Resource.createIfNeeded(url);
  250. resource.appendForwardSlash();
  251. if (defined(token)) {
  252. resource = resource.getDerivedResource({
  253. queryParameters: {
  254. token: token,
  255. },
  256. });
  257. }
  258. that._resource = resource;
  259. const metadataResource = resource.getDerivedResource({
  260. queryParameters: {
  261. f: "pjson",
  262. },
  263. });
  264. await requestMetadata(terrainProviderBuilder, metadataResource, that);
  265. terrainProviderBuilder.build(that);
  266. return true;
  267. });
  268. }
  269. }
  270. Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, {
  271. /**
  272. * Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing
  273. * to the event, you will be notified of the error and can potentially recover from it. Event listeners
  274. * are passed an instance of {@link TileProviderError}.
  275. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  276. * @type {Event}
  277. * @readonly
  278. */
  279. errorEvent: {
  280. get: function () {
  281. return this._errorEvent;
  282. },
  283. },
  284. /**
  285. * Gets the credit to display when this terrain provider is active. Typically this is used to credit
  286. * the source of the terrain.
  287. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  288. * @type {Credit}
  289. * @readonly
  290. */
  291. credit: {
  292. get: function () {
  293. return this._credit;
  294. },
  295. },
  296. /**
  297. * Gets the tiling scheme used by this provider.
  298. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  299. * @type {GeographicTilingScheme}
  300. * @readonly
  301. */
  302. tilingScheme: {
  303. get: function () {
  304. return this._tilingScheme;
  305. },
  306. },
  307. /**
  308. * Gets a value indicating whether or not the provider is ready for use.
  309. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  310. * @type {boolean}
  311. * @readonly
  312. * @deprecated
  313. */
  314. ready: {
  315. get: function () {
  316. deprecationWarning(
  317. "ArcGISTiledElevationTerrainProvider.ready",
  318. "ArcGISTiledElevationTerrainProvider.ready was deprecated in CesiumJS 1.104. It will be in CesiumJS 1.107. Use ArcGISTiledElevationTerrainProvider.fromUrl instead."
  319. );
  320. return this._ready;
  321. },
  322. },
  323. /**
  324. * Gets a promise that resolves to true when the provider is ready for use.
  325. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  326. * @type {Promise<boolean>}
  327. * @readonly
  328. * @deprecated
  329. */
  330. readyPromise: {
  331. get: function () {
  332. deprecationWarning(
  333. "ArcGISTiledElevationTerrainProvider.readyPromise",
  334. "ArcGISTiledElevationTerrainProvider.readyPromise was deprecated in CesiumJS 1.104. It will be in CesiumJS 1.107. Use ArcGISTiledElevationTerrainProvider.fromUrl instead."
  335. );
  336. return this._readyPromise;
  337. },
  338. },
  339. /**
  340. * Gets a value indicating whether or not the provider includes a water mask. The water mask
  341. * indicates which areas of the globe are water rather than land, so they can be rendered
  342. * as a reflective surface with animated waves.
  343. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  344. * @type {boolean}
  345. * @readonly
  346. */
  347. hasWaterMask: {
  348. get: function () {
  349. return false;
  350. },
  351. },
  352. /**
  353. * Gets a value indicating whether or not the requested tiles include vertex normals.
  354. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  355. * @type {boolean}
  356. * @readonly
  357. */
  358. hasVertexNormals: {
  359. get: function () {
  360. return false;
  361. },
  362. },
  363. /**
  364. * Gets an object that can be used to determine availability of terrain from this provider, such as
  365. * at points and in rectangles. This property may be undefined if availability
  366. * information is not available.
  367. * @memberof ArcGISTiledElevationTerrainProvider.prototype
  368. * @type {TileAvailability}
  369. * @readonly
  370. */
  371. availability: {
  372. get: function () {
  373. return this._tilesAvailable;
  374. },
  375. },
  376. });
  377. /**
  378. * Creates a {@link TerrainProvider} that produces terrain geometry by tessellating height maps
  379. * retrieved from Elevation Tiles of an an ArcGIS ImageService.
  380. *
  381. * @param {Resource|String|Promise<Resource>|Promise<String>} url The URL of the ArcGIS ImageServer service.
  382. * @param {ArcGISTiledElevationTerrainProvider.ConstructorOptions} [options] A url or an object describing initialization options.
  383. * @returns {Promise<ArcGISTiledElevationTerrainProvider>}
  384. *
  385. * @example
  386. * const terrainProvider = await Cesium.ArcGISTiledElevationTerrainProvider.fromUrl("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer", {
  387. * token: "KED1aF_I4UzXOHy3BnhwyBHU4l5oY6rO6walkmHoYqGp4XyIWUd5YZUC1ZrLAzvV40pR6gBXQayh0eFA8m6vPg.."
  388. * });
  389. * viewer.terrainProvider = terrainProvider;
  390. *
  391. * @exception {RuntimeError} metadata specifies invalid spatial reference
  392. * @exception {RuntimeError} metadata does not specify tileInfo
  393. */
  394. ArcGISTiledElevationTerrainProvider.fromUrl = async function (url, options) {
  395. //>>includeStart('debug', pragmas.debug);
  396. Check.defined("url", url);
  397. //>>includeEnd('debug');
  398. options = defaultValue(options, defaultValue.EMPTY_OBJECT);
  399. url = await Promise.resolve(url);
  400. let resource = Resource.createIfNeeded(url);
  401. resource.appendForwardSlash();
  402. if (defined(options.token)) {
  403. resource = resource.getDerivedResource({
  404. queryParameters: {
  405. token: options.token,
  406. },
  407. });
  408. }
  409. const metadataResource = resource.getDerivedResource({
  410. queryParameters: {
  411. f: "pjson",
  412. },
  413. });
  414. const terrainProviderBuilder = new TerrainProviderBuilder(options);
  415. await requestMetadata(terrainProviderBuilder, metadataResource);
  416. const provider = new ArcGISTiledElevationTerrainProvider(options);
  417. terrainProviderBuilder.build(provider);
  418. provider._resource = resource;
  419. return provider;
  420. };
  421. /**
  422. * Requests the geometry for a given tile. The result includes terrain
  423. * data and indicates that all child tiles are available.
  424. *
  425. * @param {number} x The X coordinate of the tile for which to request geometry.
  426. * @param {number} y The Y coordinate of the tile for which to request geometry.
  427. * @param {number} level The level of the tile for which to request geometry.
  428. * @param {Request} [request] The request object. Intended for internal use only.
  429. * @returns {Promise<TerrainData>|undefined} A promise for the requested geometry. If this method
  430. * returns undefined instead of a promise, it is an indication that too many requests are already
  431. * pending and the request will be retried later.
  432. */
  433. ArcGISTiledElevationTerrainProvider.prototype.requestTileGeometry = function (
  434. x,
  435. y,
  436. level,
  437. request
  438. ) {
  439. const tileResource = this._resource.getDerivedResource({
  440. url: `tile/${level}/${y}/${x}`,
  441. request: request,
  442. });
  443. const hasAvailability = this._hasAvailability;
  444. let availabilityPromise = Promise.resolve(true);
  445. let availabilityRequest;
  446. if (
  447. hasAvailability &&
  448. !defined(isTileAvailable(this, level + 1, x * 2, y * 2))
  449. ) {
  450. // We need to load child availability
  451. const availabilityResult = requestAvailability(
  452. this,
  453. level + 1,
  454. x * 2,
  455. y * 2
  456. );
  457. availabilityPromise = availabilityResult.promise;
  458. availabilityRequest = availabilityResult.request;
  459. }
  460. const promise = tileResource.fetchArrayBuffer();
  461. if (!defined(promise) || !defined(availabilityPromise)) {
  462. return undefined;
  463. }
  464. const that = this;
  465. const tilesAvailable = this._tilesAvailable;
  466. return Promise.all([promise, availabilityPromise])
  467. .then(function (result) {
  468. return new HeightmapTerrainData({
  469. buffer: result[0],
  470. width: that._width,
  471. height: that._height,
  472. childTileMask: hasAvailability
  473. ? tilesAvailable.computeChildMaskForTile(level, x, y)
  474. : ALL_CHILDREN,
  475. structure: that._terrainDataStructure,
  476. encoding: that._encoding,
  477. });
  478. })
  479. .catch(function (error) {
  480. if (
  481. defined(availabilityRequest) &&
  482. availabilityRequest.state === RequestState.CANCELLED
  483. ) {
  484. request.cancel();
  485. // Don't reject the promise till the request is actually cancelled
  486. // Otherwise it will think the request failed, but it didn't.
  487. return request.deferred.promise.finally(function () {
  488. request.state = RequestState.CANCELLED;
  489. return Promise.reject(error);
  490. });
  491. }
  492. return Promise.reject(error);
  493. });
  494. };
  495. function isTileAvailable(that, level, x, y) {
  496. if (!that._hasAvailability) {
  497. return undefined;
  498. }
  499. const tilesAvailabilityLoaded = that._tilesAvailabilityLoaded;
  500. const tilesAvailable = that._tilesAvailable;
  501. if (level > that._lodCount) {
  502. return false;
  503. }
  504. // Check if tiles are known to be available
  505. if (tilesAvailable.isTileAvailable(level, x, y)) {
  506. return true;
  507. }
  508. // or to not be available
  509. if (tilesAvailabilityLoaded.isTileAvailable(level, x, y)) {
  510. return false;
  511. }
  512. return undefined;
  513. }
  514. /**
  515. * Gets the maximum geometric error allowed in a tile at a given level.
  516. *
  517. * @param {number} level The tile level for which to get the maximum geometric error.
  518. * @returns {number} The maximum geometric error.
  519. */
  520. ArcGISTiledElevationTerrainProvider.prototype.getLevelMaximumGeometricError = function (
  521. level
  522. ) {
  523. return this._levelZeroMaximumGeometricError / (1 << level);
  524. };
  525. /**
  526. * Determines whether data for a tile is available to be loaded.
  527. *
  528. * @param {number} x The X coordinate of the tile for which to request geometry.
  529. * @param {number} y The Y coordinate of the tile for which to request geometry.
  530. * @param {number} level The level of the tile for which to request geometry.
  531. * @returns {boolean|undefined} Undefined if not supported, otherwise true or false.
  532. */
  533. ArcGISTiledElevationTerrainProvider.prototype.getTileDataAvailable = function (
  534. x,
  535. y,
  536. level
  537. ) {
  538. if (!this._hasAvailability) {
  539. return undefined;
  540. }
  541. const result = isTileAvailable(this, level, x, y);
  542. if (defined(result)) {
  543. return result;
  544. }
  545. requestAvailability(this, level, x, y);
  546. return undefined;
  547. };
  548. /**
  549. * Makes sure we load availability data for a tile
  550. *
  551. * @param {number} x The X coordinate of the tile for which to request geometry.
  552. * @param {number} y The Y coordinate of the tile for which to request geometry.
  553. * @param {number} level The level of the tile for which to request geometry.
  554. * @returns {undefined} This provider does not support loading availability.
  555. */
  556. ArcGISTiledElevationTerrainProvider.prototype.loadTileDataAvailability = function (
  557. x,
  558. y,
  559. level
  560. ) {
  561. return undefined;
  562. };
  563. function findRange(origin, width, height, data) {
  564. const endCol = width - 1;
  565. const endRow = height - 1;
  566. const value = data[origin.y * width + origin.x];
  567. const endingIndices = [];
  568. const range = {
  569. startX: origin.x,
  570. startY: origin.y,
  571. endX: 0,
  572. endY: 0,
  573. };
  574. const corner = new Cartesian2(origin.x + 1, origin.y + 1);
  575. let doneX = false;
  576. let doneY = false;
  577. while (!(doneX && doneY)) {
  578. // We want to use the original value when checking Y,
  579. // so get it before it possibly gets incremented
  580. let endX = corner.x;
  581. // If we no longer move in the Y direction we need to check the corner tile in X pass
  582. const endY = doneY ? corner.y + 1 : corner.y;
  583. // Check X range
  584. if (!doneX) {
  585. for (let y = origin.y; y < endY; ++y) {
  586. if (data[y * width + corner.x] !== value) {
  587. doneX = true;
  588. break;
  589. }
  590. }
  591. if (doneX) {
  592. endingIndices.push(new Cartesian2(corner.x, origin.y));
  593. // Use the last good column so we can continue with Y
  594. --corner.x;
  595. --endX;
  596. range.endX = corner.x;
  597. } else if (corner.x === endCol) {
  598. range.endX = corner.x;
  599. doneX = true;
  600. } else {
  601. ++corner.x;
  602. }
  603. }
  604. // Check Y range - The corner tile is checked here
  605. if (!doneY) {
  606. const col = corner.y * width;
  607. for (let x = origin.x; x <= endX; ++x) {
  608. if (data[col + x] !== value) {
  609. doneY = true;
  610. break;
  611. }
  612. }
  613. if (doneY) {
  614. endingIndices.push(new Cartesian2(origin.x, corner.y));
  615. // Use the last good row so we can continue with X
  616. --corner.y;
  617. range.endY = corner.y;
  618. } else if (corner.y === endRow) {
  619. range.endY = corner.y;
  620. doneY = true;
  621. } else {
  622. ++corner.y;
  623. }
  624. }
  625. }
  626. return {
  627. endingIndices: endingIndices,
  628. range: range,
  629. value: value,
  630. };
  631. }
  632. function computeAvailability(x, y, width, height, data) {
  633. const ranges = [];
  634. const singleValue = data.every(function (val) {
  635. return val === data[0];
  636. });
  637. if (singleValue) {
  638. if (data[0] === 1) {
  639. ranges.push({
  640. startX: x,
  641. startY: y,
  642. endX: x + width - 1,
  643. endY: y + height - 1,
  644. });
  645. }
  646. return ranges;
  647. }
  648. let positions = [new Cartesian2(0, 0)];
  649. while (positions.length > 0) {
  650. const origin = positions.pop();
  651. const result = findRange(origin, width, height, data);
  652. if (result.value === 1) {
  653. // Convert range into the array into global tile coordinates
  654. const range = result.range;
  655. range.startX += x;
  656. range.endX += x;
  657. range.startY += y;
  658. range.endY += y;
  659. ranges.push(range);
  660. }
  661. const endingIndices = result.endingIndices;
  662. if (endingIndices.length > 0) {
  663. positions = positions.concat(endingIndices);
  664. }
  665. }
  666. return ranges;
  667. }
  668. function requestAvailability(that, level, x, y) {
  669. if (!that._hasAvailability) {
  670. return {};
  671. }
  672. // Fetch 128x128 availability list, so we make the minimum amount of requests
  673. const xOffset = Math.floor(x / 128) * 128;
  674. const yOffset = Math.floor(y / 128) * 128;
  675. const dim = Math.min(1 << level, 128);
  676. const url = `tilemap/${level}/${yOffset}/${xOffset}/${dim}/${dim}`;
  677. const availableCache = that._availableCache;
  678. if (defined(availableCache[url])) {
  679. return availableCache[url];
  680. }
  681. const request = new Request({
  682. throttle: false,
  683. throttleByServer: true,
  684. type: RequestType.TERRAIN,
  685. });
  686. const tilemapResource = that._resource.getDerivedResource({
  687. url: url,
  688. request: request,
  689. });
  690. let promise = tilemapResource.fetchJson();
  691. if (!defined(promise)) {
  692. return {};
  693. }
  694. promise = promise.then(function (result) {
  695. const available = computeAvailability(
  696. xOffset,
  697. yOffset,
  698. dim,
  699. dim,
  700. result.data
  701. );
  702. // Mark whole area as having availability loaded
  703. that._tilesAvailabilityLoaded.addAvailableTileRange(
  704. level,
  705. xOffset,
  706. yOffset,
  707. xOffset + dim,
  708. yOffset + dim
  709. );
  710. const tilesAvailable = that._tilesAvailable;
  711. for (let i = 0; i < available.length; ++i) {
  712. const range = available[i];
  713. tilesAvailable.addAvailableTileRange(
  714. level,
  715. range.startX,
  716. range.startY,
  717. range.endX,
  718. range.endY
  719. );
  720. }
  721. // Conveniently return availability of original tile
  722. return isTileAvailable(that, level, x, y);
  723. });
  724. availableCache[url] = {
  725. promise: promise,
  726. request: request,
  727. };
  728. promise = promise.finally(function (result) {
  729. delete availableCache[url];
  730. return result;
  731. });
  732. return {
  733. promise: promise,
  734. request: request,
  735. };
  736. }
  737. export default ArcGISTiledElevationTerrainProvider;