@loaders.gl/tiles 4.4.5 → 5.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. package/LICENSE +14 -3
  2. package/README.md +110 -1
  3. package/dist/dist.dev.js +6588 -2057
  4. package/dist/dist.min.js +1 -1
  5. package/dist/image-set.d.ts +94 -0
  6. package/dist/image-set.d.ts.map +1 -0
  7. package/dist/image-set.js +243 -0
  8. package/dist/image-set.js.map +1 -0
  9. package/dist/index.cjs +6872 -2160
  10. package/dist/index.cjs.map +3 -4
  11. package/dist/index.d.ts +33 -9
  12. package/dist/index.d.ts.map +1 -1
  13. package/dist/index.js +18 -8
  14. package/dist/index.js.map +1 -1
  15. package/dist/point-cloud/point-cloud-tile.d.ts +47 -0
  16. package/dist/point-cloud/point-cloud-tile.d.ts.map +1 -0
  17. package/dist/point-cloud/point-cloud-tile.js +70 -0
  18. package/dist/point-cloud/point-cloud-tile.js.map +1 -0
  19. package/dist/point-cloud/point-cloud-tileset.d.ts +131 -0
  20. package/dist/point-cloud/point-cloud-tileset.d.ts.map +1 -0
  21. package/dist/point-cloud/point-cloud-tileset.js +510 -0
  22. package/dist/point-cloud/point-cloud-tileset.js.map +1 -0
  23. package/dist/point-cloud/types.d.ts +64 -0
  24. package/dist/point-cloud/types.d.ts.map +1 -0
  25. package/dist/point-cloud/types.js +5 -0
  26. package/dist/point-cloud/types.js.map +1 -0
  27. package/dist/raster-set.d.ts +113 -0
  28. package/dist/raster-set.d.ts.map +1 -0
  29. package/dist/raster-set.js +274 -0
  30. package/dist/raster-set.js.map +1 -0
  31. package/dist/tileset-2d/adapter.d.ts +38 -0
  32. package/dist/tileset-2d/adapter.d.ts.map +1 -0
  33. package/dist/tileset-2d/adapter.js +5 -0
  34. package/dist/tileset-2d/adapter.js.map +1 -0
  35. package/dist/tileset-2d/index.d.ts +7 -0
  36. package/dist/tileset-2d/index.d.ts.map +1 -0
  37. package/dist/tileset-2d/index.js +6 -0
  38. package/dist/tileset-2d/index.js.map +1 -0
  39. package/dist/tileset-2d/tile-2d-header.d.ts +68 -0
  40. package/dist/tileset-2d/tile-2d-header.d.ts.map +1 -0
  41. package/dist/tileset-2d/tile-2d-header.js +181 -0
  42. package/dist/tileset-2d/tile-2d-header.js.map +1 -0
  43. package/dist/tileset-2d/tileset-2d.d.ts +201 -0
  44. package/dist/tileset-2d/tileset-2d.d.ts.map +1 -0
  45. package/dist/tileset-2d/tileset-2d.js +532 -0
  46. package/dist/tileset-2d/tileset-2d.js.map +1 -0
  47. package/dist/tileset-2d/types.d.ts +44 -0
  48. package/dist/tileset-2d/types.d.ts.map +1 -0
  49. package/dist/tileset-2d/types.js +5 -0
  50. package/dist/tileset-2d/types.js.map +1 -0
  51. package/dist/tileset-2d.d.ts +2 -0
  52. package/dist/tileset-2d.d.ts.map +1 -0
  53. package/dist/tileset-2d.js +5 -0
  54. package/dist/tileset-2d.js.map +1 -0
  55. package/dist/tileset-3d/common/indexed-archive-tileset-source.d.ts +60 -0
  56. package/dist/tileset-3d/common/indexed-archive-tileset-source.d.ts.map +1 -0
  57. package/dist/tileset-3d/common/indexed-archive-tileset-source.js +125 -0
  58. package/dist/tileset-3d/common/indexed-archive-tileset-source.js.map +1 -0
  59. package/dist/{tileset → tileset-3d/common}/tile-3d.d.ts +133 -29
  60. package/dist/tileset-3d/common/tile-3d.d.ts.map +1 -0
  61. package/dist/{tileset → tileset-3d/common}/tile-3d.js +282 -77
  62. package/dist/tileset-3d/common/tile-3d.js.map +1 -0
  63. package/dist/tileset-3d/common/tileset-3d.d.ts +317 -0
  64. package/dist/tileset-3d/common/tileset-3d.d.ts.map +1 -0
  65. package/dist/tileset-3d/common/tileset-3d.js +807 -0
  66. package/dist/tileset-3d/common/tileset-3d.js.map +1 -0
  67. package/dist/tileset-3d/common/tileset-cache.d.ts +29 -0
  68. package/dist/tileset-3d/common/tileset-cache.d.ts.map +1 -0
  69. package/dist/{tileset → tileset-3d/common}/tileset-cache.js +12 -4
  70. package/dist/tileset-3d/common/tileset-cache.js.map +1 -0
  71. package/dist/tileset-3d/common/tileset-source.d.ts +204 -0
  72. package/dist/tileset-3d/common/tileset-source.d.ts.map +1 -0
  73. package/dist/tileset-3d/common/tileset-source.js +17 -0
  74. package/dist/tileset-3d/common/tileset-source.js.map +1 -0
  75. package/dist/{tileset → tileset-3d/common}/tileset-traverser.d.ts +15 -2
  76. package/dist/tileset-3d/common/tileset-traverser.d.ts.map +1 -0
  77. package/dist/{tileset → tileset-3d/common}/tileset-traverser.js +30 -3
  78. package/dist/tileset-3d/common/tileset-traverser.js.map +1 -0
  79. package/dist/tileset-3d/format-3d-tiles/implicit-tiling.d.ts +111 -0
  80. package/dist/tileset-3d/format-3d-tiles/implicit-tiling.d.ts.map +1 -0
  81. package/dist/tileset-3d/format-3d-tiles/implicit-tiling.js +340 -0
  82. package/dist/tileset-3d/format-3d-tiles/implicit-tiling.js.map +1 -0
  83. package/dist/tileset-3d/format-3d-tiles/tiles-3d-source.d.ts +189 -0
  84. package/dist/tileset-3d/format-3d-tiles/tiles-3d-source.d.ts.map +1 -0
  85. package/dist/tileset-3d/format-3d-tiles/tiles-3d-source.js +510 -0
  86. package/dist/tileset-3d/format-3d-tiles/tiles-3d-source.js.map +1 -0
  87. package/dist/tileset-3d/format-3d-tiles/tileset-3d-traverser.d.ts +43 -0
  88. package/dist/tileset-3d/format-3d-tiles/tileset-3d-traverser.d.ts.map +1 -0
  89. package/dist/tileset-3d/format-3d-tiles/tileset-3d-traverser.js +119 -0
  90. package/dist/tileset-3d/format-3d-tiles/tileset-3d-traverser.js.map +1 -0
  91. package/dist/tileset-3d/format-i3s/i3s-pending-tiles-register.d.ts.map +1 -0
  92. package/dist/{tileset → tileset-3d}/format-i3s/i3s-pending-tiles-register.js +3 -0
  93. package/dist/tileset-3d/format-i3s/i3s-pending-tiles-register.js.map +1 -0
  94. package/dist/tileset-3d/format-i3s/i3s-source.d.ts +99 -0
  95. package/dist/tileset-3d/format-i3s/i3s-source.d.ts.map +1 -0
  96. package/dist/tileset-3d/format-i3s/i3s-source.js +299 -0
  97. package/dist/tileset-3d/format-i3s/i3s-source.js.map +1 -0
  98. package/dist/tileset-3d/format-i3s/i3s-tile-manager.d.ts.map +1 -0
  99. package/dist/{tileset → tileset-3d}/format-i3s/i3s-tile-manager.js +5 -2
  100. package/dist/tileset-3d/format-i3s/i3s-tile-manager.js.map +1 -0
  101. package/dist/{tileset → tileset-3d}/format-i3s/i3s-tileset-traverser.d.ts +2 -2
  102. package/dist/tileset-3d/format-i3s/i3s-tileset-traverser.d.ts.map +1 -0
  103. package/dist/{tileset → tileset-3d}/format-i3s/i3s-tileset-traverser.js +17 -23
  104. package/dist/tileset-3d/format-i3s/i3s-tileset-traverser.js.map +1 -0
  105. package/dist/{tileset → tileset-3d}/helpers/3d-tiles-options.d.ts +1 -1
  106. package/dist/tileset-3d/helpers/3d-tiles-options.d.ts.map +1 -0
  107. package/dist/{tileset → tileset-3d}/helpers/3d-tiles-options.js +3 -0
  108. package/dist/tileset-3d/helpers/3d-tiles-options.js.map +1 -0
  109. package/dist/tileset-3d/helpers/bounding-volume.d.ts.map +1 -0
  110. package/dist/{tileset → tileset-3d}/helpers/bounding-volume.js +1 -0
  111. package/dist/tileset-3d/helpers/bounding-volume.js.map +1 -0
  112. package/dist/tileset-3d/helpers/frame-state.d.ts +86 -0
  113. package/dist/tileset-3d/helpers/frame-state.d.ts.map +1 -0
  114. package/dist/{tileset → tileset-3d}/helpers/frame-state.js +84 -9
  115. package/dist/tileset-3d/helpers/frame-state.js.map +1 -0
  116. package/dist/{tileset → tileset-3d}/helpers/i3s-lod.d.ts +1 -1
  117. package/dist/tileset-3d/helpers/i3s-lod.d.ts.map +1 -0
  118. package/dist/{tileset → tileset-3d}/helpers/i3s-lod.js +1 -1
  119. package/dist/tileset-3d/helpers/i3s-lod.js.map +1 -0
  120. package/dist/tileset-3d/helpers/tiles-3d-lod.d.ts +72 -0
  121. package/dist/tileset-3d/helpers/tiles-3d-lod.d.ts.map +1 -0
  122. package/dist/tileset-3d/helpers/tiles-3d-lod.js +257 -0
  123. package/dist/tileset-3d/helpers/tiles-3d-lod.js.map +1 -0
  124. package/dist/tileset-3d/helpers/tiles-3d-request-priority.d.ts +134 -0
  125. package/dist/tileset-3d/helpers/tiles-3d-request-priority.d.ts.map +1 -0
  126. package/dist/tileset-3d/helpers/tiles-3d-request-priority.js +179 -0
  127. package/dist/tileset-3d/helpers/tiles-3d-request-priority.js.map +1 -0
  128. package/dist/{tileset → tileset-3d}/helpers/transform-utils.d.ts +1 -1
  129. package/dist/tileset-3d/helpers/transform-utils.d.ts.map +1 -0
  130. package/dist/tileset-3d/helpers/transform-utils.js.map +1 -0
  131. package/dist/tileset-3d/helpers/zoom.d.ts.map +1 -0
  132. package/dist/tileset-3d/helpers/zoom.js.map +1 -0
  133. package/dist/types.d.ts +9 -0
  134. package/dist/types.d.ts.map +1 -1
  135. package/dist/types.js +3 -0
  136. package/dist/types.js.map +1 -1
  137. package/dist/utils/doubly-linked-list.d.ts.map +1 -1
  138. package/dist/utils/doubly-linked-list.js +1 -0
  139. package/dist/utils/doubly-linked-list.js.map +1 -1
  140. package/dist/utils/managed-array.d.ts.map +1 -1
  141. package/dist/utils/managed-array.js +1 -0
  142. package/dist/utils/managed-array.js.map +1 -1
  143. package/package.json +7 -6
  144. package/src/image-set.ts +328 -0
  145. package/src/index.ts +99 -9
  146. package/src/point-cloud/point-cloud-tile.ts +80 -0
  147. package/src/point-cloud/point-cloud-tileset.ts +713 -0
  148. package/src/point-cloud/types.ts +82 -0
  149. package/src/raster-set.ts +412 -0
  150. package/src/tileset-2d/adapter.ts +47 -0
  151. package/src/tileset-2d/index.ts +33 -0
  152. package/src/tileset-2d/tile-2d-header.ts +224 -0
  153. package/src/tileset-2d/tileset-2d.ts +716 -0
  154. package/src/tileset-2d/types.ts +39 -0
  155. package/src/tileset-2d.ts +5 -0
  156. package/src/tileset-3d/common/indexed-archive-tileset-source.ts +205 -0
  157. package/src/{tileset → tileset-3d/common}/tile-3d.ts +348 -93
  158. package/src/tileset-3d/common/tileset-3d.ts +1087 -0
  159. package/src/{tileset → tileset-3d/common}/tileset-cache.ts +16 -8
  160. package/src/tileset-3d/common/tileset-source.ts +255 -0
  161. package/src/{tileset → tileset-3d/common}/tileset-traverser.ts +32 -4
  162. package/src/tileset-3d/format-3d-tiles/implicit-tiling.ts +534 -0
  163. package/src/tileset-3d/format-3d-tiles/tiles-3d-source.ts +632 -0
  164. package/src/tileset-3d/format-3d-tiles/tileset-3d-traverser.ts +140 -0
  165. package/src/{tileset → tileset-3d}/format-i3s/i3s-pending-tiles-register.ts +4 -0
  166. package/src/tileset-3d/format-i3s/i3s-source.ts +366 -0
  167. package/src/{tileset → tileset-3d}/format-i3s/i3s-tile-manager.ts +6 -2
  168. package/src/{tileset → tileset-3d}/format-i3s/i3s-tileset-traverser.ts +19 -24
  169. package/src/{tileset → tileset-3d}/helpers/3d-tiles-options.ts +5 -1
  170. package/src/{tileset → tileset-3d}/helpers/bounding-volume.ts +2 -0
  171. package/src/tileset-3d/helpers/frame-state.ts +311 -0
  172. package/src/{tileset → tileset-3d}/helpers/i3s-lod.ts +2 -2
  173. package/src/tileset-3d/helpers/tiles-3d-lod.ts +370 -0
  174. package/src/tileset-3d/helpers/tiles-3d-request-priority.ts +301 -0
  175. package/src/{tileset → tileset-3d}/helpers/transform-utils.ts +1 -1
  176. package/src/types.ts +13 -0
  177. package/src/utils/doubly-linked-list.ts +2 -0
  178. package/src/utils/managed-array.ts +2 -0
  179. package/dist/tileset/format-3d-tiles/tileset-3d-traverser.d.ts +0 -7
  180. package/dist/tileset/format-3d-tiles/tileset-3d-traverser.d.ts.map +0 -1
  181. package/dist/tileset/format-3d-tiles/tileset-3d-traverser.js +0 -53
  182. package/dist/tileset/format-3d-tiles/tileset-3d-traverser.js.map +0 -1
  183. package/dist/tileset/format-i3s/i3s-pending-tiles-register.d.ts.map +0 -1
  184. package/dist/tileset/format-i3s/i3s-pending-tiles-register.js.map +0 -1
  185. package/dist/tileset/format-i3s/i3s-tile-manager.d.ts.map +0 -1
  186. package/dist/tileset/format-i3s/i3s-tile-manager.js.map +0 -1
  187. package/dist/tileset/format-i3s/i3s-tileset-traverser.d.ts.map +0 -1
  188. package/dist/tileset/format-i3s/i3s-tileset-traverser.js.map +0 -1
  189. package/dist/tileset/helpers/3d-tiles-options.d.ts.map +0 -1
  190. package/dist/tileset/helpers/3d-tiles-options.js.map +0 -1
  191. package/dist/tileset/helpers/bounding-volume.d.ts.map +0 -1
  192. package/dist/tileset/helpers/bounding-volume.js.map +0 -1
  193. package/dist/tileset/helpers/frame-state.d.ts +0 -28
  194. package/dist/tileset/helpers/frame-state.d.ts.map +0 -1
  195. package/dist/tileset/helpers/frame-state.js.map +0 -1
  196. package/dist/tileset/helpers/i3s-lod.d.ts.map +0 -1
  197. package/dist/tileset/helpers/i3s-lod.js.map +0 -1
  198. package/dist/tileset/helpers/tiles-3d-lod.d.ts +0 -8
  199. package/dist/tileset/helpers/tiles-3d-lod.d.ts.map +0 -1
  200. package/dist/tileset/helpers/tiles-3d-lod.js +0 -113
  201. package/dist/tileset/helpers/tiles-3d-lod.js.map +0 -1
  202. package/dist/tileset/helpers/transform-utils.d.ts.map +0 -1
  203. package/dist/tileset/helpers/transform-utils.js.map +0 -1
  204. package/dist/tileset/helpers/zoom.d.ts.map +0 -1
  205. package/dist/tileset/helpers/zoom.js.map +0 -1
  206. package/dist/tileset/tile-3d.d.ts.map +0 -1
  207. package/dist/tileset/tile-3d.js.map +0 -1
  208. package/dist/tileset/tileset-3d.d.ts +0 -284
  209. package/dist/tileset/tileset-3d.d.ts.map +0 -1
  210. package/dist/tileset/tileset-3d.js +0 -814
  211. package/dist/tileset/tileset-3d.js.map +0 -1
  212. package/dist/tileset/tileset-cache.d.ts +0 -19
  213. package/dist/tileset/tileset-cache.d.ts.map +0 -1
  214. package/dist/tileset/tileset-cache.js.map +0 -1
  215. package/dist/tileset/tileset-traverser.d.ts.map +0 -1
  216. package/dist/tileset/tileset-traverser.js.map +0 -1
  217. package/src/tileset/format-3d-tiles/tileset-3d-traverser.ts +0 -63
  218. package/src/tileset/helpers/frame-state.ts +0 -183
  219. package/src/tileset/helpers/tiles-3d-lod.ts +0 -149
  220. package/src/tileset/tileset-3d.ts +0 -1037
  221. /package/dist/{tileset → tileset-3d}/format-i3s/i3s-pending-tiles-register.d.ts +0 -0
  222. /package/dist/{tileset → tileset-3d}/format-i3s/i3s-tile-manager.d.ts +0 -0
  223. /package/dist/{tileset → tileset-3d}/helpers/bounding-volume.d.ts +0 -0
  224. /package/dist/{tileset → tileset-3d}/helpers/transform-utils.js +0 -0
  225. /package/dist/{tileset → tileset-3d}/helpers/zoom.d.ts +0 -0
  226. /package/dist/{tileset → tileset-3d}/helpers/zoom.js +0 -0
  227. /package/src/{tileset → tileset-3d}/helpers/zoom.ts +0 -0
@@ -1,1037 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- // Copyright (c) vis.gl contributors
3
-
4
- // This file is derived from the Cesium code base under Apache 2 license
5
- // See LICENSE.md and https://github.com/AnalyticalGraphicsInc/cesium/blob/master/LICENSE.md
6
-
7
- import {Matrix4, Vector3} from '@math.gl/core';
8
- import {Ellipsoid} from '@math.gl/geospatial';
9
- import {Stats} from '@probe.gl/stats';
10
- import {RequestScheduler, path, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
11
- import {TilesetCache} from './tileset-cache';
12
- import {calculateTransformProps} from './helpers/transform-utils';
13
- import {FrameState, getFrameState, limitSelectedTiles} from './helpers/frame-state';
14
- import {getZoomFromBoundingVolume, getZoomFromExtent, getZoomFromFullExtent} from './helpers/zoom';
15
-
16
- import type {GeospatialViewport, Viewport} from '../types';
17
- import {Tile3D} from './tile-3d';
18
- import {TILESET_TYPE} from '../constants';
19
-
20
- import {TilesetTraverser} from './tileset-traverser';
21
-
22
- // TODO - these should be moved into their respective modules
23
- import {Tileset3DTraverser} from './format-3d-tiles/tileset-3d-traverser';
24
- import {I3STilesetTraverser} from './format-i3s/i3s-tileset-traverser';
25
-
26
- export type TilesetJSON = any;
27
-
28
- /*
29
- export type TilesetJSON = {
30
- loader;
31
- // could be 3d tiles, i3s
32
- type: 'I3S' | '3DTILES';
33
- /** The url to the top level tileset JSON file. *
34
- url: string;
35
- basePath?: string;
36
- // Geometric error when the tree is not rendered at all
37
- lodMetricType: string;
38
- lodMetricValue: number;
39
- root: {
40
- refine: string;
41
- [key: string]: unknown;
42
- },
43
- [key: string]: unknown;
44
- };
45
- */
46
-
47
- export type Tileset3DProps = {
48
- // loading
49
- throttleRequests?: boolean;
50
- maxRequests?: number;
51
- loadOptions?: LoaderOptions;
52
- loadTiles?: boolean;
53
- basePath?: string;
54
- maximumMemoryUsage?: number;
55
- memoryCacheOverflow?: number;
56
- maximumTilesSelected?: number;
57
- debounceTime?: number;
58
-
59
- // Metadata
60
- description?: string;
61
- attributions?: string[];
62
-
63
- // Transforms
64
- ellipsoid?: object;
65
- modelMatrix?: Matrix4;
66
-
67
- // Traversal
68
- maximumScreenSpaceError?: number;
69
- memoryAdjustedScreenSpaceError?: boolean;
70
- viewportTraversersMap?: any;
71
- updateTransforms?: boolean;
72
- viewDistanceScale?: number;
73
-
74
- // Callbacks
75
- onTileLoad?: (tile: Tile3D) => any;
76
- onTileUnload?: (tile: Tile3D) => any;
77
- onTileError?: (tile: Tile3D, message: string, url: string) => any;
78
- contentLoader?: (tile: Tile3D) => Promise<void>;
79
- onTraversalComplete?: (selectedTiles: Tile3D[]) => Tile3D[];
80
- onUpdate?: () => void;
81
- };
82
-
83
- type Props = {
84
- description: string;
85
- ellipsoid: object;
86
- /** A 4x4 transformation matrix this transforms the entire tileset. */
87
- modelMatrix: Matrix4;
88
- /** Set to false to disable network request throttling */
89
- throttleRequests: boolean;
90
- /** Number of simultaneous requsts, if throttleRequests is true */
91
- maxRequests: number;
92
- /* Maximum amount of GPU memory (in MB) that may be used to cache tiles. */
93
- maximumMemoryUsage: number;
94
- /* The maximum additional memory (in MB) to allow for cache headroom before adjusting the screen spacer error */
95
- memoryCacheOverflow: number;
96
- /** Maximum number limit of tiles selected for show. 0 means no limit */
97
- maximumTilesSelected: number;
98
- /** Delay time before the tileset traversal. It prevents traversal requests spam.*/
99
- debounceTime: number;
100
- /** Callback. Indicates this a tile's content was loaded */
101
- onTileLoad: (tile: Tile3D) => void;
102
- /** Callback. Indicates this a tile's content was unloaded (cache full) */
103
- onTileUnload: (tile: Tile3D) => void;
104
- /** Callback. Indicates this a tile's content failed to load */
105
- onTileError: (tile: Tile3D, message: string, url: string) => void;
106
- /** Callback. Allows post-process selectedTiles right after traversal. */
107
- onTraversalComplete: (selectedTiles: Tile3D[]) => Tile3D[];
108
- /** Callback. Called when the set of selected tiles changes. */
109
- onUpdate: () => void;
110
- /** The maximum screen space error used to drive level of detail refinement. */
111
- maximumScreenSpaceError: number;
112
- /** Whether to adjust the maximum screen space error to comply with the maximum memory limitation */
113
- memoryAdjustedScreenSpaceError: boolean;
114
- viewportTraversersMap: Record<string, any> | null;
115
- attributions: string[];
116
- loadTiles: boolean;
117
- loadOptions: LoaderOptions;
118
- updateTransforms: boolean;
119
- /** View distance scale modifier */
120
- viewDistanceScale: number;
121
- basePath: string;
122
- /** Optional async tile content loader */
123
- contentLoader?: (tile: Tile3D) => Promise<void>;
124
- /** @todo I3S specific knowledge should be moved to I3S module */
125
- i3s: Record<string, any>;
126
- };
127
-
128
- const DEFAULT_PROPS: Props = {
129
- description: '',
130
- ellipsoid: Ellipsoid.WGS84,
131
- modelMatrix: new Matrix4(),
132
- throttleRequests: true,
133
- maxRequests: 64,
134
- /** Default memory values optimized for viewing mesh-based 3D Tiles on both mobile and desktop devices */
135
- maximumMemoryUsage: 32,
136
- memoryCacheOverflow: 1,
137
- maximumTilesSelected: 0,
138
- debounceTime: 0,
139
- onTileLoad: () => {},
140
- onTileUnload: () => {},
141
- onTileError: () => {},
142
- onTraversalComplete: (selectedTiles: Tile3D[]) => selectedTiles,
143
- onUpdate: () => {},
144
- contentLoader: undefined,
145
- viewDistanceScale: 1.0,
146
- maximumScreenSpaceError: 8,
147
- memoryAdjustedScreenSpaceError: false,
148
- loadTiles: true,
149
- updateTransforms: true,
150
- viewportTraversersMap: null,
151
- loadOptions: {fetch: {}},
152
- attributions: [],
153
- basePath: '',
154
- i3s: {}
155
- };
156
-
157
- // Tracked Stats
158
- const TILES_TOTAL = 'Tiles In Tileset(s)';
159
- const TILES_IN_MEMORY = 'Tiles In Memory';
160
- const TILES_IN_VIEW = 'Tiles In View';
161
- const TILES_RENDERABLE = 'Tiles To Render';
162
- const TILES_LOADED = 'Tiles Loaded';
163
- const TILES_LOADING = 'Tiles Loading';
164
- const TILES_UNLOADED = 'Tiles Unloaded';
165
- const TILES_LOAD_FAILED = 'Failed Tile Loads';
166
- const POINTS_COUNT = 'Points/Vertices';
167
- const TILES_GPU_MEMORY = 'Tile Memory Use';
168
- const MAXIMUM_SSE = 'Maximum Screen Space Error';
169
-
170
- /**
171
- * The Tileset loading and rendering flow is as below,
172
- * A rendered (i.e. deck.gl `Tile3DLayer`) triggers `tileset.update()` after a `tileset` is loaded
173
- * `tileset` starts traversing the tile tree and update `requestTiles` (tiles of which content need
174
- * to be fetched) and `selectedTiles` (tiles ready for rendering under the current viewport).
175
- * `Tile3DLayer` will update rendering based on `selectedTiles`.
176
- * `Tile3DLayer` also listens to `onTileLoad` callback and trigger another round of `update and then traversal`
177
- * when new tiles are loaded.
178
-
179
- * As I3S tileset have stored `tileHeader` file (metadata) and tile content files (geometry, texture, ...) separately.
180
- * During each traversal, it issues `tilHeader` requests if that `tileHeader` is not yet fetched,
181
- * after the tile header is fulfilled, it will resume the traversal starting from the tile just fetched (not root).
182
-
183
- * Tile3DLayer
184
- * |
185
- * await load(tileset)
186
- * |
187
- * tileset.update()
188
- * | async load tileHeader
189
- * tileset.traverse() -------------------------- Queued
190
- * | resume traversal after fetched |
191
- * |----------------------------------------|
192
- * |
193
- * | async load tile content
194
- * tilset.requestedTiles ----------------------------- RequestScheduler
195
- * |
196
- * tilset.selectedTiles (ready for rendering) |
197
- * | Listen to |
198
- * Tile3DLayer ----------- onTileLoad ----------------------|
199
- * | | notify new tile is available
200
- * updateLayers |
201
- * tileset.update // trigger another round of update
202
- */
203
- export class Tileset3D {
204
- // props: Tileset3DProps;
205
- options: Props;
206
- loadOptions: LoaderOptions;
207
-
208
- type: TILESET_TYPE;
209
- tileset: TilesetJSON;
210
- loader: LoaderWithParser;
211
- url: string;
212
- basePath: string;
213
- modelMatrix: Matrix4;
214
- ellipsoid: any;
215
- lodMetricType: string;
216
- lodMetricValue: number;
217
- refine: string;
218
- root: Tile3D | null = null;
219
- roots: Record<string, Tile3D> = {};
220
- /** @todo any->unknown */
221
- asset: Record<string, any> = {};
222
-
223
- // Metadata for the entire tileset
224
- description: string = '';
225
- properties: any;
226
-
227
- extras: any = null;
228
- attributions: any = {};
229
- credits: any = {};
230
-
231
- stats: Stats;
232
-
233
- /** flags that contain information about data types in nested tiles */
234
- contentFormats = {draco: false, meshopt: false, dds: false, ktx2: false};
235
-
236
- // view props
237
- cartographicCenter: Vector3 | null = null;
238
- cartesianCenter: Vector3 | null = null;
239
- zoom: number = 1;
240
- boundingVolume: any = null;
241
-
242
- /** Updated based on the camera position and direction */
243
- dynamicScreenSpaceErrorComputedDensity: number = 0.0;
244
-
245
- // METRICS
246
-
247
- /**
248
- * The maximum amount of GPU memory (in MB) that may be used to cache tiles
249
- * Tiles not in view are unloaded to enforce private
250
- */
251
- maximumMemoryUsage: number = 32;
252
-
253
- /** The total amount of GPU memory in bytes used by the tileset. */
254
- gpuMemoryUsageInBytes: number = 0;
255
-
256
- /**
257
- * If loading the level of detail required by maximumScreenSpaceError
258
- * results in the memory usage exceeding maximumMemoryUsage (GPU), level of detail refinement
259
- * will instead use this (larger) adjusted screen space error to achieve the
260
- * best possible visual quality within the available memory.
261
- */
262
- memoryAdjustedScreenSpaceError: number = 0.0;
263
-
264
- private _cacheBytes: number = 0;
265
- private _cacheOverflowBytes: number = 0;
266
-
267
- /** Update tracker. increase in each update cycle. */
268
- _frameNumber: number = 0;
269
- private _queryParams: Record<string, string> = {};
270
- private _extensionsUsed: string[] = [];
271
- private _tiles: Record<string, Tile3D> = {};
272
-
273
- /** counter for tracking tiles requests */
274
- private _pendingCount: number = 0;
275
-
276
- /** Hold traversal results */
277
- selectedTiles: Tile3D[] = [];
278
-
279
- // TRAVERSAL
280
- traverseCounter: number = 0;
281
- geometricError: number = 0;
282
- private lastUpdatedVieports: Viewport[] | Viewport | null = null;
283
- private _requestedTiles: Tile3D[] = [];
284
- private _emptyTiles: Tile3D[] = [];
285
- private frameStateData: any = {};
286
-
287
- _traverser: TilesetTraverser;
288
- _cache = new TilesetCache();
289
- _requestScheduler: RequestScheduler;
290
-
291
- /** Tile IDs held visible during transitions until replacements have drawn */
292
- private _heldTiles: Set<string> = new Set();
293
-
294
- // Promise tracking
295
- private updatePromise: Promise<number> | null = null;
296
- tilesetInitializationPromise: Promise<void>;
297
-
298
- /**
299
- * Create a new Tileset3D
300
- * @param json
301
- * @param props
302
- */
303
- // eslint-disable-next-line max-statements
304
- constructor(tileset: TilesetJSON, options?: Tileset3DProps) {
305
- // PUBLIC MEMBERS
306
- this.options = {...DEFAULT_PROPS, ...options};
307
- // raw data
308
- this.tileset = tileset;
309
- this.loader = tileset.loader;
310
- // could be 3d tiles, i3s
311
- this.type = tileset.type;
312
- // The url to a tileset JSON file.
313
- this.url = tileset.url;
314
- this.basePath = tileset.basePath || path.dirname(this.url);
315
- this.modelMatrix = this.options.modelMatrix;
316
- this.ellipsoid = this.options.ellipsoid;
317
-
318
- // Geometric error when the tree is not rendered at all
319
- this.lodMetricType = tileset.lodMetricType;
320
- this.lodMetricValue = tileset.lodMetricValue;
321
- this.refine = tileset.root.refine;
322
-
323
- this.loadOptions = this.options.loadOptions || {};
324
-
325
- // TRAVERSAL
326
- this._traverser = this._initializeTraverser();
327
- this._requestScheduler = new RequestScheduler({
328
- throttleRequests: this.options.throttleRequests,
329
- maxRequests: this.options.maxRequests
330
- });
331
-
332
- this.memoryAdjustedScreenSpaceError = this.options.maximumScreenSpaceError;
333
- this._cacheBytes = this.options.maximumMemoryUsage * 1024 * 1024;
334
- this._cacheOverflowBytes = this.options.memoryCacheOverflow * 1024 * 1024;
335
-
336
- // METRICS
337
- // The total amount of GPU memory in bytes used by the tileset.
338
- this.stats = new Stats({id: this.url});
339
- this._initializeStats();
340
-
341
- this.tilesetInitializationPromise = this._initializeTileSet(tileset);
342
- }
343
-
344
- /** Release resources */
345
- destroy(): void {
346
- this._destroy();
347
- }
348
-
349
- /** Is the tileset loaded (update needs to have been called at least once) */
350
- isLoaded(): boolean {
351
- // Check that `_frameNumber !== 0` which means that update was called at least once
352
- return this._pendingCount === 0 && this._frameNumber !== 0 && this._requestedTiles.length === 0;
353
- }
354
-
355
- get tiles(): object[] {
356
- return Object.values(this._tiles);
357
- }
358
-
359
- get frameNumber(): number {
360
- return this._frameNumber;
361
- }
362
-
363
- get queryParams(): string {
364
- return new URLSearchParams(this._queryParams).toString();
365
- }
366
-
367
- setProps(props: Tileset3DProps): void {
368
- this.options = {...this.options, ...props};
369
- }
370
-
371
- /** @deprecated */
372
- // setOptions(options: Tileset3DProps): void {
373
- // this.options = {...this.options, ...options};
374
- // }
375
-
376
- /**
377
- * Return a loadable tile url for a specific tile subpath
378
- * @param tilePath a tile subpath
379
- */
380
- getTileUrl(tilePath: string): string {
381
- const isDataUrl = tilePath.startsWith('data:');
382
- if (isDataUrl) {
383
- return tilePath;
384
- }
385
-
386
- let tileUrl = tilePath;
387
- if (this.queryParams.length) {
388
- tileUrl = `${tilePath}${tilePath.includes('?') ? '&' : '?'}${this.queryParams}`;
389
- }
390
- return tileUrl;
391
- }
392
-
393
- // TODO CESIUM specific
394
- hasExtension(extensionName: string): boolean {
395
- return Boolean(this._extensionsUsed.indexOf(extensionName) > -1);
396
- }
397
-
398
- /**
399
- * Update visible tiles relying on a list of viewports
400
- * @param viewports - list of viewports
401
- * @deprecated
402
- */
403
- update(viewports: Viewport[] | Viewport | null = null) {
404
- // eslint-disable-next-line @typescript-eslint/no-floating-promises
405
- this.tilesetInitializationPromise.then(() => {
406
- if (!viewports && this.lastUpdatedVieports) {
407
- viewports = this.lastUpdatedVieports;
408
- } else {
409
- this.lastUpdatedVieports = viewports;
410
- }
411
- if (viewports) {
412
- this.doUpdate(viewports);
413
- }
414
- });
415
- }
416
-
417
- /**
418
- * Update visible tiles relying on a list of viewports.
419
- * Do it with debounce delay to prevent update spam
420
- * @param viewports viewports
421
- * @returns Promise of new frameNumber
422
- */
423
- async selectTiles(viewports: Viewport[] | Viewport | null = null): Promise<number> {
424
- await this.tilesetInitializationPromise;
425
- if (viewports) {
426
- this.lastUpdatedVieports = viewports;
427
- }
428
- if (!this.updatePromise) {
429
- this.updatePromise = new Promise<number>((resolve) => {
430
- setTimeout(() => {
431
- if (this.lastUpdatedVieports) {
432
- this.doUpdate(this.lastUpdatedVieports);
433
- }
434
- resolve(this._frameNumber);
435
- this.updatePromise = null;
436
- }, this.options.debounceTime);
437
- });
438
- }
439
- return this.updatePromise;
440
- }
441
-
442
- adjustScreenSpaceError(): void {
443
- if (this.gpuMemoryUsageInBytes < this._cacheBytes) {
444
- this.memoryAdjustedScreenSpaceError = Math.max(
445
- this.memoryAdjustedScreenSpaceError / 1.02,
446
- this.options.maximumScreenSpaceError
447
- );
448
- } else if (this.gpuMemoryUsageInBytes > this._cacheBytes + this._cacheOverflowBytes) {
449
- this.memoryAdjustedScreenSpaceError *= 1.02;
450
- }
451
- }
452
- /**
453
- * Update visible tiles relying on a list of viewports
454
- * @param viewports viewports
455
- */
456
- // eslint-disable-next-line max-statements, complexity
457
- private doUpdate(viewports: Viewport[] | Viewport): void {
458
- if ('loadTiles' in this.options && !this.options.loadTiles) {
459
- return;
460
- }
461
- if (this.traverseCounter > 0) {
462
- return;
463
- }
464
- const preparedViewports = viewports instanceof Array ? viewports : [viewports];
465
-
466
- this._cache.reset();
467
- this._frameNumber++;
468
- this.traverseCounter = preparedViewports.length;
469
- const viewportsToTraverse: string[] = [];
470
- // First loop to decrement traverseCounter
471
- for (const viewport of preparedViewports) {
472
- const id = viewport.id;
473
- if (this._needTraverse(id)) {
474
- viewportsToTraverse.push(id);
475
- } else {
476
- this.traverseCounter--;
477
- }
478
- }
479
-
480
- // Second loop to traverse
481
- for (const viewport of preparedViewports) {
482
- const id = viewport.id;
483
- if (!this.roots[id]) {
484
- this.roots[id] = this._initializeTileHeaders(this.tileset, null);
485
- }
486
-
487
- if (!viewportsToTraverse.includes(id)) {
488
- continue; // eslint-disable-line no-continue
489
- }
490
- const frameState = getFrameState(viewport as GeospatialViewport, this._frameNumber);
491
- this._traverser.traverse(this.roots[id], frameState, this.options);
492
- }
493
- }
494
-
495
- /**
496
- * Check if traversal is needed for particular viewport
497
- * @param {string} viewportId - id of a viewport
498
- * @return {boolean}
499
- */
500
- _needTraverse(viewportId: string): boolean {
501
- let traverserId = viewportId;
502
- if (this.options.viewportTraversersMap) {
503
- traverserId = this.options.viewportTraversersMap[viewportId];
504
- }
505
- if (traverserId !== viewportId) {
506
- return false;
507
- }
508
-
509
- return true;
510
- }
511
-
512
- /**
513
- * The callback to post-process tiles after traversal procedure
514
- * @param frameState - frame state for tile culling
515
- */
516
- _onTraversalEnd(frameState: FrameState): void {
517
- const id = frameState.viewport.id;
518
- if (!this.frameStateData[id]) {
519
- this.frameStateData[id] = {selectedTiles: [], _requestedTiles: [], _emptyTiles: []};
520
- }
521
- const currentFrameStateData = this.frameStateData[id];
522
- const selectedTiles = Object.values(this._traverser.selectedTiles);
523
- const [filteredSelectedTiles, unselectedTiles] = limitSelectedTiles(
524
- selectedTiles,
525
- frameState,
526
- this.options.maximumTilesSelected
527
- );
528
- currentFrameStateData.selectedTiles = filteredSelectedTiles;
529
- for (const tile of unselectedTiles) {
530
- tile.unselect();
531
- }
532
-
533
- currentFrameStateData._requestedTiles = Object.values(this._traverser.requestedTiles);
534
- currentFrameStateData._emptyTiles = Object.values(this._traverser.emptyTiles);
535
-
536
- this.traverseCounter--;
537
- if (this.traverseCounter > 0) {
538
- return;
539
- }
540
-
541
- this._updateTiles();
542
- }
543
-
544
- /**
545
- * Update tiles relying on data from all traversers
546
- */
547
- _updateTiles(): void {
548
- const previousSelectedTiles = this.selectedTiles;
549
- this.selectedTiles = [];
550
- this._requestedTiles = [];
551
- this._emptyTiles = [];
552
-
553
- for (const frameStateKey in this.frameStateData) {
554
- const frameStateDataValue = this.frameStateData[frameStateKey];
555
- this.selectedTiles = this.selectedTiles.concat(frameStateDataValue.selectedTiles);
556
- this._requestedTiles = this._requestedTiles.concat(frameStateDataValue._requestedTiles);
557
- this._emptyTiles = this._emptyTiles.concat(frameStateDataValue._emptyTiles);
558
- }
559
-
560
- this.selectedTiles = this.options.onTraversalComplete(this.selectedTiles);
561
-
562
- // Transition hold: keep recently-deselected tiles visible until all their
563
- // replacements have been drawn by the renderer (e.g. deck.gl).
564
- // Without this, there are single-frame flashes during REPLACE refinement transitions.
565
- const selectedIds = new Set(this.selectedTiles.map((t) => t.id));
566
- const hasUndrawnTiles = this.selectedTiles.some((t) => !t.tileDrawn);
567
-
568
- // Keep recently-deselected tiles visible while new tiles haven't drawn yet
569
- let heldBackCount = 0;
570
- if (hasUndrawnTiles) {
571
- for (const tileId of selectedIds) {
572
- this._heldTiles.add(tileId);
573
- }
574
- for (const tileId of this._heldTiles) {
575
- // Skip tiles that are already selected
576
- if (selectedIds.has(tileId)) continue; // eslint-disable-line no-continue
577
-
578
- // Keep tiles previously drawn selected
579
- const tile = this._tiles[tileId];
580
- if (tile && tile.contentAvailable) {
581
- tile._selectedFrame = this._frameNumber;
582
- this.selectedTiles.push(tile);
583
- heldBackCount++;
584
- } else {
585
- this._heldTiles.delete(tileId);
586
- }
587
- }
588
- } else {
589
- // Store current selected ids for next frame
590
- this._heldTiles = selectedIds;
591
- }
592
-
593
- if (heldBackCount > 0) {
594
- // Schedule another update so that once all replacement tiles
595
- // have drawn, the held tiles get released
596
- setTimeout(() => {
597
- this.selectTiles();
598
- }, 0);
599
- }
600
-
601
- for (const tile of this.selectedTiles) {
602
- this._tiles[tile.id] = tile;
603
- }
604
-
605
- this._loadTiles();
606
- this._unloadTiles();
607
- this._updateStats();
608
-
609
- if (this._tilesChanged(previousSelectedTiles, this.selectedTiles)) {
610
- this.options.onUpdate();
611
- }
612
- }
613
-
614
- _tilesChanged(oldSelectedTiles: Tile3D[], selectedTiles: Tile3D[]): boolean {
615
- if (oldSelectedTiles.length !== selectedTiles.length) {
616
- return true;
617
- }
618
- const set1 = new Set(oldSelectedTiles.map((t) => t.id));
619
- const set2 = new Set(selectedTiles.map((t) => t.id));
620
- let changed = oldSelectedTiles.filter((x) => !set2.has(x.id)).length > 0;
621
- changed = changed || selectedTiles.filter((x) => !set1.has(x.id)).length > 0;
622
- return changed;
623
- }
624
-
625
- _loadTiles(): void {
626
- // Sort requests by priority before making any requests.
627
- // This makes it less likely this requests will be cancelled after being issued.
628
- this._requestedTiles.sort((a, b) => a._priority - b._priority);
629
- for (const tile of this._requestedTiles) {
630
- if (tile.contentUnloaded) {
631
- // eslint-disable-next-line @typescript-eslint/no-floating-promises
632
- this._loadTile(tile);
633
- }
634
- }
635
- }
636
-
637
- _unloadTiles(): void {
638
- // unload tiles from cache when hit maximumMemoryUsage
639
- this._cache.unloadTiles(this, (tileset, tile) => tileset._unloadTile(tile));
640
- }
641
-
642
- _updateStats(): void {
643
- let tilesRenderable = 0;
644
- let pointsRenderable = 0;
645
- for (const tile of this.selectedTiles) {
646
- if (tile.contentAvailable && tile.content) {
647
- tilesRenderable++;
648
- if (tile.content.pointCount) {
649
- pointsRenderable += tile.content.pointCount;
650
- } else {
651
- // Calculate vertices for non point cloud tiles.
652
- pointsRenderable += tile.content.vertexCount;
653
- }
654
- }
655
- }
656
-
657
- this.stats.get(TILES_IN_VIEW).count = this.selectedTiles.length;
658
- this.stats.get(TILES_RENDERABLE).count = tilesRenderable;
659
- this.stats.get(POINTS_COUNT).count = pointsRenderable;
660
- this.stats.get(MAXIMUM_SSE).count = this.memoryAdjustedScreenSpaceError;
661
- }
662
-
663
- async _initializeTileSet(tilesetJson: TilesetJSON): Promise<void> {
664
- if (this.type === TILESET_TYPE.I3S) {
665
- this.calculateViewPropsI3S();
666
- tilesetJson.root = await tilesetJson.root;
667
- }
668
- this.root = this._initializeTileHeaders(tilesetJson, null);
669
-
670
- if (this.type === TILESET_TYPE.TILES3D) {
671
- this._initializeTiles3DTileset(tilesetJson);
672
- this.calculateViewPropsTiles3D();
673
- }
674
-
675
- if (this.type === TILESET_TYPE.I3S) {
676
- this._initializeI3STileset();
677
- }
678
- }
679
-
680
- /**
681
- * Called during initialize Tileset to initialize the tileset's cartographic center (longitude, latitude) and zoom.
682
- * These metrics help apps center view on tileset
683
- * For I3S there is extent (<1.8 version) or fullExtent (>=1.8 version) to calculate view props
684
- * @returns
685
- */
686
- private calculateViewPropsI3S(): void {
687
- // for I3S 1.8 try to calculate with fullExtent
688
- const fullExtent = this.tileset.fullExtent;
689
- if (fullExtent) {
690
- const {xmin, xmax, ymin, ymax, zmin, zmax} = fullExtent;
691
- this.cartographicCenter = new Vector3(
692
- xmin + (xmax - xmin) / 2,
693
- ymin + (ymax - ymin) / 2,
694
- zmin + (zmax - zmin) / 2
695
- );
696
- this.cartesianCenter = new Vector3();
697
- Ellipsoid.WGS84.cartographicToCartesian(this.cartographicCenter, this.cartesianCenter);
698
- this.zoom = getZoomFromFullExtent(fullExtent, this.cartographicCenter, this.cartesianCenter);
699
- return;
700
- }
701
- // for I3S 1.6-1.7 try to calculate with extent
702
- const extent = this.tileset.store?.extent;
703
- if (extent) {
704
- const [xmin, ymin, xmax, ymax] = extent;
705
- this.cartographicCenter = new Vector3(xmin + (xmax - xmin) / 2, ymin + (ymax - ymin) / 2, 0);
706
- this.cartesianCenter = new Vector3();
707
- Ellipsoid.WGS84.cartographicToCartesian(this.cartographicCenter, this.cartesianCenter);
708
- this.zoom = getZoomFromExtent(extent, this.cartographicCenter, this.cartesianCenter);
709
- return;
710
- }
711
- // eslint-disable-next-line no-console
712
- console.warn('Extent is not defined in the tileset header');
713
- this.cartographicCenter = new Vector3();
714
- this.zoom = 1;
715
- return;
716
- }
717
-
718
- /**
719
- * Called during initialize Tileset to initialize the tileset's cartographic center (longitude, latitude) and zoom.
720
- * These metrics help apps center view on tileset.
721
- * For 3DTiles the root tile data is used to calculate view props.
722
- * @returns
723
- */
724
- private calculateViewPropsTiles3D() {
725
- const root = this.root as Tile3D;
726
- const {center} = root.boundingVolume;
727
- // TODO - handle all cases
728
- if (!center) {
729
- // eslint-disable-next-line no-console
730
- console.warn('center was not pre-calculated for the root tile');
731
- this.cartographicCenter = new Vector3();
732
- this.zoom = 1;
733
- return;
734
- }
735
-
736
- // cartographic coordinates are undefined at the center of the ellipsoid
737
- if (center[0] !== 0 || center[1] !== 0 || center[2] !== 0) {
738
- this.cartographicCenter = new Vector3();
739
- Ellipsoid.WGS84.cartesianToCartographic(center, this.cartographicCenter);
740
- } else {
741
- this.cartographicCenter = new Vector3(0, 0, -Ellipsoid.WGS84.radii[0]);
742
- }
743
- this.cartesianCenter = center;
744
- this.zoom = getZoomFromBoundingVolume(root.boundingVolume, this.cartographicCenter);
745
- }
746
-
747
- _initializeStats() {
748
- this.stats.get(TILES_TOTAL);
749
- this.stats.get(TILES_LOADING);
750
- this.stats.get(TILES_IN_MEMORY);
751
- this.stats.get(TILES_IN_VIEW);
752
- this.stats.get(TILES_RENDERABLE);
753
- this.stats.get(TILES_LOADED);
754
- this.stats.get(TILES_UNLOADED);
755
- this.stats.get(TILES_LOAD_FAILED);
756
- this.stats.get(POINTS_COUNT);
757
- this.stats.get(TILES_GPU_MEMORY, 'memory');
758
- this.stats.get(MAXIMUM_SSE);
759
- }
760
-
761
- // Installs the main tileset JSON file or a tileset JSON file referenced from a tile.
762
- // eslint-disable-next-line max-statements
763
- _initializeTileHeaders(tilesetJson: TilesetJSON, parentTileHeader?: any) {
764
- // A tileset JSON file referenced from a tile may exist in a different directory than the root tileset.
765
- // Get the basePath relative to the external tileset.
766
- const rootTile = new Tile3D(this, tilesetJson.root, parentTileHeader); // resource
767
-
768
- // If there is a parentTileHeader, add the root of the currently loading tileset
769
- // to parentTileHeader's children, and update its depth.
770
- if (parentTileHeader) {
771
- parentTileHeader.children.push(rootTile);
772
- rootTile.depth = parentTileHeader.depth + 1;
773
- }
774
-
775
- // 3DTiles knows the hierarchy beforehand
776
- if (this.type === TILESET_TYPE.TILES3D) {
777
- const stack: Tile3D[] = [];
778
- stack.push(rootTile);
779
-
780
- while (stack.length > 0) {
781
- const tile = stack.pop() as Tile3D;
782
- this.stats.get(TILES_TOTAL).incrementCount();
783
- const children = tile.header.children || [];
784
- for (const childHeader of children) {
785
- const childTile = new Tile3D(this, childHeader, tile);
786
-
787
- // Special handling for Google
788
- // A session key must be used for all tile requests
789
- if (childTile.contentUrl?.includes('?session=')) {
790
- const url = new URL(childTile.contentUrl);
791
- const session = url.searchParams.get('session');
792
- // eslint-disable-next-line max-depth
793
- if (session) {
794
- this._queryParams.session = session;
795
- }
796
- }
797
-
798
- tile.children.push(childTile);
799
- childTile.depth = tile.depth + 1;
800
- stack.push(childTile);
801
- }
802
- }
803
- }
804
-
805
- return rootTile;
806
- }
807
-
808
- _initializeTraverser(): TilesetTraverser {
809
- let TraverserClass;
810
- const type = this.type;
811
- switch (type) {
812
- case TILESET_TYPE.TILES3D:
813
- TraverserClass = Tileset3DTraverser;
814
- break;
815
- case TILESET_TYPE.I3S:
816
- TraverserClass = I3STilesetTraverser;
817
- break;
818
- default:
819
- TraverserClass = TilesetTraverser;
820
- }
821
-
822
- return new TraverserClass({
823
- basePath: this.basePath,
824
- onTraversalEnd: this._onTraversalEnd.bind(this)
825
- });
826
- }
827
-
828
- _destroyTileHeaders(parentTile: Tile3D): void {
829
- this._destroySubtree(parentTile);
830
- }
831
-
832
- async _loadTile(tile: Tile3D): Promise<void> {
833
- let loaded;
834
- try {
835
- this._onStartTileLoading();
836
- loaded = await tile.loadContent();
837
- } catch (error: unknown) {
838
- this._onTileLoadError(tile, error instanceof Error ? error : new Error('load failed'));
839
- } finally {
840
- this._onEndTileLoading();
841
- this._onTileLoad(tile, loaded);
842
- }
843
- }
844
-
845
- _onTileLoadError(tile: Tile3D, error: Error): void {
846
- this.stats.get(TILES_LOAD_FAILED).incrementCount();
847
-
848
- const message = error.message || error.toString();
849
- const url = tile.url;
850
- // TODO - Allow for probe log to be injected instead of console?
851
- console.error(`A 3D tile failed to load: ${tile.url} ${message}`); // eslint-disable-line
852
- this.options.onTileError(tile, message, url);
853
- }
854
-
855
- _onTileLoad(tile: Tile3D, loaded: boolean): void {
856
- if (!loaded) {
857
- return;
858
- }
859
-
860
- if (this.type === TILESET_TYPE.I3S) {
861
- // We can't calculate tiles total in I3S in advance so we calculate it dynamically.
862
- const nodesInNodePages = this.tileset?.nodePagesTile?.nodesInNodePages || 0;
863
- this.stats.get(TILES_TOTAL).reset();
864
- this.stats.get(TILES_TOTAL).addCount(nodesInNodePages);
865
- }
866
-
867
- // add coordinateOrigin and modelMatrix to tile
868
- if (tile && tile.content) {
869
- calculateTransformProps(tile, tile.content);
870
- }
871
-
872
- this.updateContentTypes(tile);
873
- this._addTileToCache(tile);
874
- this.options.onTileLoad(tile);
875
- }
876
-
877
- /**
878
- * Update information about data types in nested tiles
879
- * @param tile instance of a nested Tile3D
880
- */
881
- private updateContentTypes(tile: Tile3D) {
882
- if (this.type === TILESET_TYPE.I3S) {
883
- if (tile.header.isDracoGeometry) {
884
- this.contentFormats.draco = true;
885
- }
886
- switch (tile.header.textureFormat) {
887
- case 'dds':
888
- this.contentFormats.dds = true;
889
- break;
890
- case 'ktx2':
891
- this.contentFormats.ktx2 = true;
892
- break;
893
- default:
894
- }
895
- } else if (this.type === TILESET_TYPE.TILES3D) {
896
- const {extensionsRemoved = []} = tile.content?.gltf || {};
897
- if (extensionsRemoved.includes('KHR_draco_mesh_compression')) {
898
- this.contentFormats.draco = true;
899
- }
900
- if (extensionsRemoved.includes('EXT_meshopt_compression')) {
901
- this.contentFormats.meshopt = true;
902
- }
903
- if (extensionsRemoved.includes('KHR_texture_basisu')) {
904
- this.contentFormats.ktx2 = true;
905
- }
906
- }
907
- }
908
-
909
- _onStartTileLoading() {
910
- this._pendingCount++;
911
- this.stats.get(TILES_LOADING).incrementCount();
912
- }
913
-
914
- _onEndTileLoading() {
915
- this._pendingCount--;
916
- this.stats.get(TILES_LOADING).decrementCount();
917
- }
918
-
919
- _addTileToCache(tile: Tile3D) {
920
- this._cache.add(this, tile, (tileset) => tileset._updateCacheStats(tile));
921
- }
922
-
923
- _updateCacheStats(tile) {
924
- this.stats.get(TILES_LOADED).incrementCount();
925
- this.stats.get(TILES_IN_MEMORY).incrementCount();
926
-
927
- // TODO: Calculate GPU memory usage statistics for a tile.
928
- this.gpuMemoryUsageInBytes += tile.gpuMemoryUsageInBytes || 0;
929
-
930
- this.stats.get(TILES_GPU_MEMORY).count = this.gpuMemoryUsageInBytes;
931
-
932
- // Adjust SSE based on cache limits
933
- if (this.options.memoryAdjustedScreenSpaceError) {
934
- this.adjustScreenSpaceError();
935
- }
936
- }
937
-
938
- _unloadTile(tile) {
939
- this.gpuMemoryUsageInBytes -= tile.gpuMemoryUsageInBytes || 0;
940
-
941
- this.stats.get(TILES_IN_MEMORY).decrementCount();
942
- this.stats.get(TILES_UNLOADED).incrementCount();
943
- this.stats.get(TILES_GPU_MEMORY).count = this.gpuMemoryUsageInBytes;
944
-
945
- this.options.onTileUnload(tile);
946
- tile.unloadContent();
947
- }
948
-
949
- // Traverse the tree and destroy all tiles
950
- _destroy() {
951
- const stack: Tile3D[] = [];
952
-
953
- if (this.root) {
954
- stack.push(this.root);
955
- }
956
-
957
- while (stack.length > 0) {
958
- const tile: Tile3D = stack.pop() as Tile3D;
959
-
960
- for (const child of tile.children) {
961
- stack.push(child);
962
- }
963
-
964
- this._destroyTile(tile);
965
- }
966
- this.root = null;
967
- }
968
-
969
- // Traverse the tree and destroy all sub tiles
970
- _destroySubtree(tile) {
971
- const root = tile;
972
- const stack: Tile3D[] = [];
973
- stack.push(root);
974
- while (stack.length > 0) {
975
- tile = stack.pop();
976
- for (const child of tile.children) {
977
- stack.push(child);
978
- }
979
- if (tile !== root) {
980
- this._destroyTile(tile);
981
- }
982
- }
983
- root.children = [];
984
- }
985
-
986
- _destroyTile(tile) {
987
- this._cache.unloadTile(this, tile);
988
- this._unloadTile(tile);
989
- tile.destroy();
990
- }
991
-
992
- _initializeTiles3DTileset(tilesetJson) {
993
- if (tilesetJson.queryString) {
994
- const searchParams = new URLSearchParams(tilesetJson.queryString);
995
- const queryParams = Object.fromEntries(searchParams.entries());
996
- this._queryParams = {...this._queryParams, ...queryParams};
997
- }
998
-
999
- this.asset = tilesetJson.asset;
1000
- if (!this.asset) {
1001
- throw new Error('Tileset must have an asset property.');
1002
- }
1003
- if (
1004
- this.asset.version !== '0.0' &&
1005
- this.asset.version !== '1.0' &&
1006
- this.asset.version !== '1.1'
1007
- ) {
1008
- throw new Error('The tileset must be 3D Tiles version either 0.0 or 1.0 or 1.1.');
1009
- }
1010
-
1011
- // Note: `asset.tilesetVersion` is version of the tileset itself (not the version of the 3D TILES standard)
1012
- // We add this version as a `v=1.0` query param to fetch the right version and not get an older cached version
1013
- if ('tilesetVersion' in this.asset) {
1014
- this._queryParams.v = this.asset.tilesetVersion;
1015
- }
1016
-
1017
- // TODO - ion resources have a credits property we can use for additional attribution.
1018
- this.credits = {
1019
- attributions: this.options.attributions || []
1020
- };
1021
- this.description = this.options.description || '';
1022
-
1023
- // Gets the tileset's properties dictionary object, which contains metadata about per-feature properties.
1024
- this.properties = tilesetJson.properties;
1025
- this.geometricError = tilesetJson.geometricError;
1026
- this._extensionsUsed = tilesetJson.extensionsUsed || [];
1027
- // Returns the extras property at the top of the tileset JSON (application specific metadata).
1028
- this.extras = tilesetJson.extras;
1029
- }
1030
-
1031
- _initializeI3STileset() {
1032
- const i3sOptions = this.loadOptions.i3s;
1033
- if (i3sOptions && typeof i3sOptions === 'object' && 'token' in i3sOptions) {
1034
- this._queryParams.token = (i3sOptions as Record<string, unknown>).token as string;
1035
- }
1036
- }
1037
- }