Cesium3DTilesetTraversal.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. import defined from "../Core/defined.js";
  2. import DeveloperError from "../Core/DeveloperError.js";
  3. import Intersect from "../Core/Intersect.js";
  4. import Cesium3DTileOptimizationHint from "./Cesium3DTileOptimizationHint.js";
  5. import Cesium3DTileRefine from "./Cesium3DTileRefine.js";
  6. /**
  7. * Traverses a {@link Cesium3DTileset} to determine which tiles to load and render.
  8. * This type describes an interface and is not intended to be instantiated directly.
  9. *
  10. * @alias Cesium3DTilesetTraversal
  11. * @constructor
  12. * @abstract
  13. *
  14. * @see Cesium3DTilesetBaseTraversal
  15. * @see Cesium3DTilesetSkipTraversal
  16. * @see Cesium3DTilesetMostDetailedTraversal
  17. *
  18. * @private
  19. */
  20. function Cesium3DTilesetTraversal() {}
  21. /**
  22. * Traverses a {@link Cesium3DTileset} to determine which tiles to load and render.
  23. *
  24. * @private
  25. * @param {Cesium3DTileset} tileset
  26. * @param {FrameState} frameState
  27. */
  28. Cesium3DTilesetTraversal.selectTiles = function (tileset, frameState) {
  29. DeveloperError.throwInstantiationError();
  30. };
  31. /**
  32. * Sort by farthest child first since this is going on a stack
  33. *
  34. * @private
  35. * @param {Cesium3DTile} a
  36. * @param {Cesium3DTile} b
  37. * @returns {number}
  38. */
  39. Cesium3DTilesetTraversal.sortChildrenByDistanceToCamera = function (a, b) {
  40. if (b._distanceToCamera === 0 && a._distanceToCamera === 0) {
  41. return b._centerZDepth - a._centerZDepth;
  42. }
  43. return b._distanceToCamera - a._distanceToCamera;
  44. };
  45. /**
  46. * Determine if a tile can and should be traversed for children tiles that
  47. * would contribute to rendering the current view
  48. *
  49. * @private
  50. * @param {Cesium3DTile} tile
  51. * @returns {boolean}
  52. */
  53. Cesium3DTilesetTraversal.canTraverse = function (tile) {
  54. if (tile.children.length === 0) {
  55. return false;
  56. }
  57. if (tile.hasTilesetContent || tile.hasImplicitContent) {
  58. // Traverse external tileset to visit its root tile
  59. // Don't traverse if the subtree is expired because it will be destroyed
  60. return !tile.contentExpired;
  61. }
  62. return tile._screenSpaceError > tile.tileset._maximumScreenSpaceError;
  63. };
  64. /**
  65. * Mark a tile as selected, and add it to the tileset's list of selected tiles
  66. *
  67. * @private
  68. * @param {Cesium3DTile} tile
  69. * @param {FrameState} frameState
  70. */
  71. Cesium3DTilesetTraversal.selectTile = function (tile, frameState) {
  72. if (tile.contentVisibility(frameState) === Intersect.OUTSIDE) {
  73. return;
  74. }
  75. const { content, tileset } = tile;
  76. if (content.featurePropertiesDirty) {
  77. // A feature's property in this tile changed, the tile needs to be re-styled.
  78. content.featurePropertiesDirty = false;
  79. tile.lastStyleTime = 0; // Force applying the style to this tile
  80. tileset._selectedTilesToStyle.push(tile);
  81. } else if (tile._selectedFrame < frameState.frameNumber - 1) {
  82. // Tile is newly selected; it is selected this frame, but was not selected last frame.
  83. tileset._selectedTilesToStyle.push(tile);
  84. }
  85. tile._selectedFrame = frameState.frameNumber;
  86. tileset._selectedTiles.push(tile);
  87. };
  88. /**
  89. * @private
  90. * @param {Cesium3DTile} tile
  91. * @param {FrameState} frameState
  92. */
  93. Cesium3DTilesetTraversal.visitTile = function (tile, frameState) {
  94. ++tile.tileset._statistics.visited;
  95. tile._visitedFrame = frameState.frameNumber;
  96. };
  97. /**
  98. * @private
  99. * @param {Cesium3DTile} tile
  100. * @param {FrameState} frameState
  101. */
  102. Cesium3DTilesetTraversal.touchTile = function (tile, frameState) {
  103. if (tile._touchedFrame === frameState.frameNumber) {
  104. // Prevents another pass from touching the frame again
  105. return;
  106. }
  107. tile.tileset._cache.touch(tile);
  108. tile._touchedFrame = frameState.frameNumber;
  109. };
  110. /**
  111. * Add a tile to the list of requested tiles, if appropriate
  112. *
  113. * @private
  114. * @param {Cesium3DTile} tile
  115. * @param {FrameState} frameState
  116. */
  117. Cesium3DTilesetTraversal.loadTile = function (tile, frameState) {
  118. const { tileset } = tile;
  119. if (
  120. tile._requestedFrame === frameState.frameNumber ||
  121. (!tile.hasUnloadedRenderableContent && !tile.contentExpired)
  122. ) {
  123. return;
  124. }
  125. if (!isOnScreenLongEnough(tile, frameState)) {
  126. return;
  127. }
  128. const cameraHasNotStoppedMovingLongEnough =
  129. frameState.camera.timeSinceMoved < tileset.foveatedTimeDelay;
  130. if (tile.priorityDeferred && cameraHasNotStoppedMovingLongEnough) {
  131. return;
  132. }
  133. tile._requestedFrame = frameState.frameNumber;
  134. tileset._requestedTiles.push(tile);
  135. };
  136. /**
  137. * Prevent unnecessary loads while camera is moving by getting the ratio of travel distance to tile size.
  138. *
  139. * @private
  140. * @param {Cesium3DTile} tile
  141. * @param {FrameState} frameState
  142. * @returns {boolean}
  143. */
  144. function isOnScreenLongEnough(tile, frameState) {
  145. const { tileset } = tile;
  146. if (!tileset._cullRequestsWhileMoving) {
  147. return true;
  148. }
  149. const {
  150. positionWCDeltaMagnitude,
  151. positionWCDeltaMagnitudeLastFrame,
  152. } = frameState.camera;
  153. const deltaMagnitude =
  154. positionWCDeltaMagnitude !== 0.0
  155. ? positionWCDeltaMagnitude
  156. : positionWCDeltaMagnitudeLastFrame;
  157. // How do n frames of this movement compare to the tile's physical size.
  158. const diameter = Math.max(tile.boundingSphere.radius * 2.0, 1.0);
  159. const movementRatio =
  160. (tileset.cullRequestsWhileMovingMultiplier * deltaMagnitude) / diameter;
  161. return movementRatio < 1.0;
  162. }
  163. /**
  164. * Reset some of the tile's flags and re-evaluate visibility and priority
  165. *
  166. * @private
  167. * @param {Cesium3DTile} tile
  168. * @param {FrameState} frameState
  169. */
  170. Cesium3DTilesetTraversal.updateTile = function (tile, frameState) {
  171. updateTileVisibility(tile, frameState);
  172. tile.updateExpiration();
  173. tile._wasMinPriorityChild = false;
  174. tile._priorityHolder = tile;
  175. updateMinimumMaximumPriority(tile);
  176. // SkipLOD
  177. tile._shouldSelect = false;
  178. tile._finalResolution = true;
  179. };
  180. /**
  181. * @private
  182. * @param {Cesium3DTile} tile
  183. * @param {FrameState} frameState
  184. */
  185. function updateTileVisibility(tile, frameState) {
  186. tile.updateVisibility(frameState);
  187. if (!tile.isVisible) {
  188. return;
  189. }
  190. const hasChildren = tile.children.length > 0;
  191. if ((tile.hasTilesetContent || tile.hasImplicitContent) && hasChildren) {
  192. // Use the root tile's visibility instead of this tile's visibility.
  193. // The root tile may be culled by the children bounds optimization in which
  194. // case this tile should also be culled.
  195. const child = tile.children[0];
  196. updateTileVisibility(child, frameState);
  197. tile._visible = child._visible;
  198. return;
  199. }
  200. if (meetsScreenSpaceErrorEarly(tile, frameState)) {
  201. tile._visible = false;
  202. return;
  203. }
  204. // Optimization - if none of the tile's children are visible then this tile isn't visible
  205. const replace = tile.refine === Cesium3DTileRefine.REPLACE;
  206. const useOptimization =
  207. tile._optimChildrenWithinParent ===
  208. Cesium3DTileOptimizationHint.USE_OPTIMIZATION;
  209. if (replace && useOptimization && hasChildren) {
  210. if (!anyChildrenVisible(tile, frameState)) {
  211. ++tile.tileset._statistics.numberOfTilesCulledWithChildrenUnion;
  212. tile._visible = false;
  213. return;
  214. }
  215. }
  216. }
  217. /**
  218. * @private
  219. * @param {Cesium3DTile} tile
  220. * @param {FrameState} frameState
  221. * @returns {boolean}
  222. */
  223. function meetsScreenSpaceErrorEarly(tile, frameState) {
  224. const { parent, tileset } = tile;
  225. if (
  226. !defined(parent) ||
  227. parent.hasTilesetContent ||
  228. parent.hasImplicitContent ||
  229. parent.refine !== Cesium3DTileRefine.ADD
  230. ) {
  231. return false;
  232. }
  233. // Use parent's geometric error with child's box to see if the tile already meet the SSE
  234. return (
  235. tile.getScreenSpaceError(frameState, true) <=
  236. tileset._maximumScreenSpaceError
  237. );
  238. }
  239. /**
  240. * @private
  241. * @param {Cesium3DTile} tile
  242. * @param {FrameState} frameState
  243. * @returns {boolean}
  244. */
  245. function anyChildrenVisible(tile, frameState) {
  246. let anyVisible = false;
  247. const children = tile.children;
  248. for (let i = 0; i < children.length; ++i) {
  249. const child = children[i];
  250. child.updateVisibility(frameState);
  251. anyVisible = anyVisible || child.isVisible;
  252. }
  253. return anyVisible;
  254. }
  255. /**
  256. * @private
  257. * @param {Cesium3DTile} tile
  258. */
  259. function updateMinimumMaximumPriority(tile) {
  260. const minimumPriority = tile.tileset._minimumPriority;
  261. const maximumPriority = tile.tileset._maximumPriority;
  262. const priorityHolder = tile._priorityHolder;
  263. maximumPriority.distance = Math.max(
  264. priorityHolder._distanceToCamera,
  265. maximumPriority.distance
  266. );
  267. minimumPriority.distance = Math.min(
  268. priorityHolder._distanceToCamera,
  269. minimumPriority.distance
  270. );
  271. maximumPriority.depth = Math.max(tile._depth, maximumPriority.depth);
  272. minimumPriority.depth = Math.min(tile._depth, minimumPriority.depth);
  273. maximumPriority.foveatedFactor = Math.max(
  274. priorityHolder._foveatedFactor,
  275. maximumPriority.foveatedFactor
  276. );
  277. minimumPriority.foveatedFactor = Math.min(
  278. priorityHolder._foveatedFactor,
  279. minimumPriority.foveatedFactor
  280. );
  281. maximumPriority.reverseScreenSpaceError = Math.max(
  282. tile._priorityReverseScreenSpaceError,
  283. maximumPriority.reverseScreenSpaceError
  284. );
  285. minimumPriority.reverseScreenSpaceError = Math.min(
  286. tile._priorityReverseScreenSpaceError,
  287. minimumPriority.reverseScreenSpaceError
  288. );
  289. }
  290. export default Cesium3DTilesetTraversal;