@itwin/core-frontend 3.1.0-dev.7 → 3.1.1

package/lib/esm/tile/TileTree.d.ts

@@ -7,7 +7,7 @@ import { ElementAlignedBox3d, FrustumPlanes, ViewFlagOverrides } from "@itwin/co
 import { IModelConnection } from "../IModelConnection";
 import { RenderClipVolume } from "../render/RenderClipVolume";
 import { RenderMemory } from "../render/RenderMemory";
-import { Tile, TileDrawArgs, TileLoadPriority, TileTreeParams } from "./internal";
+import { Tile, TileDrawArgs, TileGeometryCollector, TileLoadPriority, TileTreeParams } from "./internal";
 /** Describes the current state of a [[TileTree]]. TileTrees are loaded asynchronously and may be unloaded after a period of disuse.
  * @see [[TileTreeOwner]].
  * @public
@@ -112,5 +112,11 @@ export declare abstract class TileTree {
      * @beta
      */
     getEcefTransform(): Promise<Transform | undefined>;
+    /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.
+     * The base implementation does nothing.
+     * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.
+     * @beta
+     */
+    collectTileGeometry(_collector: TileGeometryCollector): void;
 }
 //# sourceMappingURL=TileTree.d.ts.map

package/lib/esm/tile/TileTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TileTree.d.ts","sourceRoot":"","sources":["../../../src/tile/TileTree.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAW,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAG3F,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAElF;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,0DAA0D;IAC1D,SAAS,IAAA;IACT,uDAAuD;IACvD,OAAO,IAAA;IACP,kDAAkD;IAClD,MAAM,IAAA;IACN,+CAA+C;IAC/C,QAAQ,IAAA;CACT;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,QAAQ;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,gBAAgB;IAChB,SAAS,CAAC,aAAa,cAAqB;IAC5C,gBAAgB;IAChB,SAAS,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IACzC,SAAgB,MAAM,EAAE,gBAAgB,CAAC;IACzC,yFAAyF;IACzF,SAAgB,eAAe,EAAE,SAAS,CAAC;IAC3C,2FAA2F;IAC3F,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,qIAAqI;IACrI,SAAgB,cAAc,EAAE,UAAU,CAAC;IAC3C,gBAAgB;IAChB,IAAW,YAAY,IAAI,gBAAgB,CAA+B;IAC1E,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmB;IACjD,0FAA0F;IAC1F,SAAgB,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnD,+CAA+C;IAC/C,aAAoB,QAAQ,IAAI,IAAI,CAAC;IACrC,mDAAmD;IACnD,aAAoB,IAAI,IAAI,OAAO,CAAC;IACpC,sDAAsD;IACtD,aAAoB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;IAEnD,oKAAoK;IACpK,aAAoB,iBAAiB,IAAI,iBAAiB,CAAC;IAE3D,kGAAkG;IAClG,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IAED,uEAAuE;IACvE,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE;IAE3D,gFAAgF;aAChE,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAE9C,gIAAgI;aAChH,KAAK,IAAI,IAAI;IAE7B,mDAAmD;IACnD,IAAW,IAAI,IAAI,OAAO,CAAuB;IACjD,gBAAgB;IAChB,IAAW,YAAY,IAAI,OAAO,CAAkB;IACpD,gBAAgB;IAChB,IAAW,UAAU,IAAI,gBAAgB,GAAG,SAAS,CAA6B;IAElF,sDAAsD;IACtD,IAAW,KAAK,IAAI,mBAAmB,CAAgC;IACvE,sEAAsE;IACtE,IAAW,gBAAgB,IAAI,WAAW,CAA+B;IACzE;;OAEG;IACH,IAAW,2BAA2B,IAAI,OAAO,CAAiB;IAElE,kBAAkB;IAClB,SAAS,aAAa,MAAM,EAAE,cAAc;IAc5C;;OAEG;IACI,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE;IAQ9C,6DAA6D;IAC7D,IAAW,UAAU,IAAI,OAAO,CAA6B;IAE7D,4GAA4G;IACrG,OAAO,IAAI,IAAI;IAQtB,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAI9D,2GAA2G;IACpG,UAAU,IAAI,MAAM;IAI3B,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI;IAI7H;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;CAiBhE"}
+{"version":3,"file":"TileTree.d.ts","sourceRoot":"","sources":["../../../src/tile/TileTree.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAW,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAG3F,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEzG;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,0DAA0D;IAC1D,SAAS,IAAA;IACT,uDAAuD;IACvD,OAAO,IAAA;IACP,kDAAkD;IAClD,MAAM,IAAA;IACN,+CAA+C;IAC/C,QAAQ,IAAA;CACT;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,QAAQ;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,gBAAgB;IAChB,SAAS,CAAC,aAAa,cAAqB;IAC5C,gBAAgB;IAChB,SAAS,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IACzC,SAAgB,MAAM,EAAE,gBAAgB,CAAC;IACzC,yFAAyF;IACzF,SAAgB,eAAe,EAAE,SAAS,CAAC;IAC3C,2FAA2F;IAC3F,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,qIAAqI;IACrI,SAAgB,cAAc,EAAE,UAAU,CAAC;IAC3C,gBAAgB;IAChB,IAAW,YAAY,IAAI,gBAAgB,CAA+B;IAC1E,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmB;IACjD,0FAA0F;IAC1F,SAAgB,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnD,+CAA+C;IAC/C,aAAoB,QAAQ,IAAI,IAAI,CAAC;IACrC,mDAAmD;IACnD,aAAoB,IAAI,IAAI,OAAO,CAAC;IACpC,sDAAsD;IACtD,aAAoB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;IAEnD,oKAAoK;IACpK,aAAoB,iBAAiB,IAAI,iBAAiB,CAAC;IAE3D,kGAAkG;IAClG,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IAED,uEAAuE;IACvE,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE;IAE3D,gFAAgF;aAChE,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAE9C,gIAAgI;aAChH,KAAK,IAAI,IAAI;IAE7B,mDAAmD;IACnD,IAAW,IAAI,IAAI,OAAO,CAAuB;IACjD,gBAAgB;IAChB,IAAW,YAAY,IAAI,OAAO,CAAkB;IACpD,gBAAgB;IAChB,IAAW,UAAU,IAAI,gBAAgB,GAAG,SAAS,CAA6B;IAElF,sDAAsD;IACtD,IAAW,KAAK,IAAI,mBAAmB,CAAgC;IACvE,sEAAsE;IACtE,IAAW,gBAAgB,IAAI,WAAW,CAA+B;IACzE;;OAEG;IACH,IAAW,2BAA2B,IAAI,OAAO,CAAiB;IAElE,kBAAkB;IAClB,SAAS,aAAa,MAAM,EAAE,cAAc;IAc5C;;OAEG;IACI,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,EAAE;IAQ9C,6DAA6D;IAC7D,IAAW,UAAU,IAAI,OAAO,CAA6B;IAE7D,4GAA4G;IACrG,OAAO,IAAI,IAAI;IAQtB,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAI9D,2GAA2G;IACpG,UAAU,IAAI,MAAM;IAI3B,gBAAgB;IACT,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,IAAI;IAI7H;;;;OAIG;IACU,gBAAgB,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAkB/D;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,qBAAqB,GAAG,IAAI;CAEpE"}

package/lib/esm/tile/TileTree.js

@@ -82,7 +82,7 @@ export class TileTree {
     selectTiles(args) {
         this._lastSelected = BeTimePoint.now();
         const tiles = this._selectTiles(args);
-        IModelApp.tileAdmin.addTilesForViewport(args.context.viewport, tiles, args.readyTiles);
+        IModelApp.tileAdmin.addTilesForUser(args.context.viewport, tiles, args.readyTiles);
         args.processSelectedTiles(tiles);
         return tiles;
     }
@@ -127,5 +127,12 @@ export class TileTree {
             dbToEcef = this.iModel.ecefLocation.getTransform();
         return dbToEcef.multiplyTransformTransform(this.iModelTransform);
     }
+    /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.
+     * The base implementation does nothing.
+     * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.
+     * @beta
+     */
+    collectTileGeometry(_collector) {
+    }
 }
 //# sourceMappingURL=TileTree.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TileTree.js","sourceRoot":"","sources":["../../../src/tile/TileTree.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,WAAW,EAAE,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAGnF,OAAO,EAAE,oCAAoC,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAMzC;;;GAGG;AACH,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,0DAA0D;IAC1D,qEAAS,CAAA;IACT,uDAAuD;IACvD,iEAAO,CAAA;IACP,kDAAkD;IAClD,+DAAM,CAAA;IACN,+CAA+C;IAC/C,mEAAQ,CAAA;AACV,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,QAAQ;IAgE5B,kBAAkB;IAClB,YAAsB,MAAsB;;QAhEpC,gBAAW,GAAG,KAAK,CAAC;QAC5B,gBAAgB;QACN,kBAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QA+D1C,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAExC,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,cAAc,mCAAI,KAAK,CAAC,kBAAkB,CAAC;IAC1E,CAAC;IA3DD,gBAAgB;IAChB,IAAW,YAAY,KAAuB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAe1E,kGAAkG;IAClG,IAAW,kBAAkB;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAWD,mDAAmD;IACnD,IAAW,IAAI,KAAc,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,gBAAgB;IAChB,IAAW,YAAY,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACpD,gBAAgB;IAChB,IAAW,UAAU,KAAmC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAElF,sDAAsD;IACtD,IAAW,KAAK,KAA0B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,sEAAsE;IACtE,IAAW,gBAAgB,KAAkB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACzE;;OAEG;IACH,IAAW,2BAA2B,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAiBlE;;OAEG;IACI,WAAW,CAAC,IAAkB;QACnC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,SAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACvF,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6DAA6D;IAC7D,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,4GAA4G;IACrG,OAAO;QACZ,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,2GAA2G;IACpG,UAAU;QACf,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAc,EAAE,MAAgB,EAAE,QAAmB,EAAE,aAA6B;QACpH,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY;YAC3B,OAAO,SAAS,CAAC;QAEnB,IAAI,QAA+B,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACjE,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,MAAM,oCAAoC,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,QAAQ,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,CAAC;SAChC;QACD,IAAI,CAAC,QAAQ;YACX,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QAErD,OAAO,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { BeDuration, BeTimePoint, dispose, Id64String } from \"@itwin/core-bentley\";\r\nimport { Matrix4d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, FrustumPlanes, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { calculateEcefToDbTransformAtLocation } from \"../BackgroundMapGeometry\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\r\nimport { RenderMemory } from \"../render/RenderMemory\";\r\nimport { Tile, TileDrawArgs, TileLoadPriority, TileTreeParams } from \"./internal\";\r\n\r\n/** Describes the current state of a [[TileTree]]. TileTrees are loaded asynchronously and may be unloaded after a period of disuse.\r\n * @see [[TileTreeOwner]].\r\n * @public\r\n */\r\nexport enum TileTreeLoadStatus {\r\n  /** No attempt to load the tile tree has yet been made. */\r\n  NotLoaded,\r\n  /** The tile tree is in the process of being loaded. */\r\n  Loading,\r\n  /** The tile tree has been successfully loaded. */\r\n  Loaded,\r\n  /** An attempt to load the tile tree failed. */\r\n  NotFound,\r\n}\r\n\r\n/** A hierarchical level-of-detail tree of [3d Tiles](https://github.com/CesiumGS/3d-tiles) to be rendered in a [[Viewport]].\r\n * Tile trees originate from a variety of sources:\r\n *  - Each [[GeometricModelState]] can supply its graphics as a tile tree;\r\n *  - A [[DisplayStyleState]]'s map settings or reality models;\r\n *  - [ViewAttachment]($backend)s in a [[SheetModelState]];\r\n *  - [[TiledGraphicsProvider]]s associated with a viewport.\r\n *\r\n * The same TileTree can be displayed in any number of viewports using multiple [[TileTreeReference]]s.\r\n * A TileTree's lifetime is managed by a [[TileTreeOwner]].\r\n *\r\n * @note Some methods carry a warning that they should **not** be overridden by subclasses; typically a protected method exists that can be\r\n * overridden instead to customize the behavior. For example, [[selectTiles]] should not be overridden; instead, override the[[_selectTiles]] method\r\n * that it calls.\r\n * @public\r\n */\r\nexport abstract class TileTree {\r\n  private _isDisposed = false;\r\n  /** @internal */\r\n  protected _lastSelected = BeTimePoint.now();\r\n  /** @internal */\r\n  protected _clipVolume?: RenderClipVolume;\r\n  public readonly iModel: IModelConnection;\r\n  /** Transform from this tile tree's coordinate space to the iModel's coordinate space. */\r\n  public readonly iModelTransform: Transform;\r\n  /** Uniquely identifies this tree among all other tile trees associated with the iModel. */\r\n  public readonly id: string;\r\n  /** A 64-bit identifier for this tile tree, unique  within the context of its [[IModelConnection]].\r\n   * For a tile tree associated with a [[GeometricModelState]], this is the Id of the model. Other types of tile trees\r\n   * typically use a transient Id obtained from [[IModelConnection.transientIds]].\r\n   */\r\n  public readonly modelId: Id64String;\r\n  /** The length of time after which tiles belonging to this tree are considered elegible for disposal if they are no longer in use. */\r\n  public readonly expirationTime: BeDuration;\r\n  /** @internal */\r\n  public get loadPriority(): TileLoadPriority { return this._loadPriority; }\r\n  private readonly _loadPriority: TileLoadPriority;\r\n  /** Optional tight bounding box around the entire contents of all of this tree's tiles. */\r\n  public readonly contentRange?: ElementAlignedBox3d;\r\n\r\n  /** The lowest-resolution tile in this tree. */\r\n  public abstract get rootTile(): Tile;\r\n  /** True if this tile tree contains 3d graphics. */\r\n  public abstract get is3d(): boolean;\r\n  /** Returns the maximum depth of this tree, if any. */\r\n  public abstract get maxDepth(): number | undefined;\r\n\r\n  /** The overrides that should be applied to the view's [ViewFlags]($common) when this tile tree is drawn. Can be overridden by individual [[TileTreeReference]]s. */\r\n  public abstract get viewFlagOverrides(): ViewFlagOverrides;\r\n\r\n  /** True if this tile tree has no bounds - e.g., a tile tree representing a globe is unbounded. */\r\n  public get isContentUnbounded(): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Implement this method to select tiles of appropriate resolution. */\r\n  protected abstract _selectTiles(args: TileDrawArgs): Tile[];\r\n\r\n  /** Produce graphics of appropriate resolution to be drawn in a [[Viewport]]. */\r\n  public abstract draw(args: TileDrawArgs): void;\r\n\r\n  /** Discard tiles and/or tile contents, presumably based on a least-recently-used and/or least-likely-to-be-needed criterion. */\r\n  public abstract prune(): void;\r\n\r\n  /** True if this tile tree contains 2d graphics. */\r\n  public get is2d(): boolean { return !this.is3d; }\r\n  /** @internal */\r\n  public get isPointCloud(): boolean { return false; }\r\n  /** @internal */\r\n  public get clipVolume(): RenderClipVolume | undefined { return this._clipVolume; }\r\n\r\n  /** The volume of space occupied by this tile tree. */\r\n  public get range(): ElementAlignedBox3d { return this.rootTile.range; }\r\n  /** The most recent time at which tiles [[selectTiles]] was called. */\r\n  public get lastSelectedTime(): BeTimePoint { return this._lastSelected; }\r\n  /** True if a tile and its child tiles should not be drawn simultaneously.\r\n   * Default: true.\r\n   */\r\n  public get parentsAndChildrenExclusive(): boolean { return true; }\r\n\r\n  /** Constructor */\r\n  protected constructor(params: TileTreeParams) {\r\n    this._lastSelected = BeTimePoint.now();\r\n    this.iModel = params.iModel;\r\n    this.iModelTransform = params.location;\r\n    this._clipVolume = params.clipVolume;\r\n    this.modelId = params.modelId;\r\n    this.id = params.id;\r\n    this.contentRange = params.contentRange;\r\n\r\n    const admin = IModelApp.tileAdmin;\r\n    this._loadPriority = params.priority;\r\n    this.expirationTime = params.expirationTime ?? admin.tileExpirationTime;\r\n  }\r\n\r\n  /** Selects tiles of appropriate resolution for some purpose like drawing to the screen, producing a shadow map, etc.\r\n   * @note Do **not** override this method. Implement [[_selectTiles]].\r\n   */\r\n  public selectTiles(args: TileDrawArgs): Tile[] {\r\n    this._lastSelected = BeTimePoint.now();\r\n    const tiles = this._selectTiles(args);\r\n    IModelApp.tileAdmin.addTilesForViewport(args.context.viewport, tiles, args.readyTiles);\r\n    args.processSelectedTiles(tiles);\r\n    return tiles;\r\n  }\r\n\r\n  /** True if [[dispose]] has been called on this tile tree. */\r\n  public get isDisposed(): boolean { return this._isDisposed; }\r\n\r\n  /** Dispose of this tree and any resources owned by it. This is typically invoked by a [[TileTreeOwner]]. */\r\n  public dispose(): void {\r\n    if (this.isDisposed)\r\n      return;\r\n\r\n    this._isDisposed = true;\r\n    dispose(this.rootTile);\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    this.rootTile.collectStatistics(stats);\r\n  }\r\n\r\n  /** Returns the number of [[Tile]]s currently in memory belonging to this tree, primarily for debugging. */\r\n  public countTiles(): number {\r\n    return 1 + this.rootTile.countDescendants();\r\n  }\r\n\r\n  /** @internal */\r\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, location: Transform, frustumPlanes?: FrustumPlanes): void {\r\n    this.rootTile.extendRangeForContent(range, matrix, location, frustumPlanes);\r\n  }\r\n\r\n  /**\r\n   * Return the transform from the tile tree's coordinate space to [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates.\r\n   * If a geographic coordinate system is present then this transform will be calculated at the tile tree center.\r\n   * @beta\r\n   */\r\n  public async getEcefTransform(): Promise<Transform | undefined> {\r\n    if (!this.iModel.ecefLocation)\r\n      return undefined;\r\n\r\n    let dbToEcef: Transform | undefined;\r\n    const range = this.contentRange ? this.contentRange : this.range;\r\n    const center = range.localXYZToWorld(.5, .5, .5);\r\n    if (center) {\r\n      this.iModelTransform.multiplyPoint3d(center, center);\r\n      const ecefToDb = await calculateEcefToDbTransformAtLocation(center, this.iModel);\r\n      dbToEcef = ecefToDb?.inverse();\r\n    }\r\n    if (!dbToEcef)\r\n      dbToEcef = this.iModel.ecefLocation.getTransform();\r\n\r\n    return dbToEcef.multiplyTransformTransform(this.iModelTransform);\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"TileTree.js","sourceRoot":"","sources":["../../../src/tile/TileTree.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,WAAW,EAAE,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAGnF,OAAO,EAAE,oCAAoC,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAMzC;;;GAGG;AACH,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,0DAA0D;IAC1D,qEAAS,CAAA;IACT,uDAAuD;IACvD,iEAAO,CAAA;IACP,kDAAkD;IAClD,+DAAM,CAAA;IACN,+CAA+C;IAC/C,mEAAQ,CAAA;AACV,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,QAAQ;IAgE5B,kBAAkB;IAClB,YAAsB,MAAsB;;QAhEpC,gBAAW,GAAG,KAAK,CAAC;QAC5B,gBAAgB;QACN,kBAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QA+D1C,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAExC,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,cAAc,mCAAI,KAAK,CAAC,kBAAkB,CAAC;IAC1E,CAAC;IA3DD,gBAAgB;IAChB,IAAW,YAAY,KAAuB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAe1E,kGAAkG;IAClG,IAAW,kBAAkB;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAWD,mDAAmD;IACnD,IAAW,IAAI,KAAc,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,gBAAgB;IAChB,IAAW,YAAY,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACpD,gBAAgB;IAChB,IAAW,UAAU,KAAmC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAElF,sDAAsD;IACtD,IAAW,KAAK,KAA0B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,sEAAsE;IACtE,IAAW,gBAAgB,KAAkB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACzE;;OAEG;IACH,IAAW,2BAA2B,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAiBlE;;OAEG;IACI,WAAW,CAAC,IAAkB;QACnC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6DAA6D;IAC7D,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,4GAA4G;IACrG,OAAO;QACZ,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,2GAA2G;IACpG,UAAU;QACf,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,0BAA0B,CAAC,KAAc,EAAE,MAAgB,EAAE,QAAmB,EAAE,aAA6B;QACpH,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY;YAC3B,OAAO,SAAS,CAAC;QAEnB,IAAI,QAA+B,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACjE,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,MAAM,oCAAoC,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,QAAQ,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,CAAC;SAChC;QACD,IAAI,CAAC,QAAQ;YACX,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QAErD,OAAO,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAiC;IAC5D,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { BeDuration, BeTimePoint, dispose, Id64String } from \"@itwin/core-bentley\";\r\nimport { Matrix4d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, FrustumPlanes, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { calculateEcefToDbTransformAtLocation } from \"../BackgroundMapGeometry\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\r\nimport { RenderMemory } from \"../render/RenderMemory\";\r\nimport { Tile, TileDrawArgs, TileGeometryCollector, TileLoadPriority, TileTreeParams } from \"./internal\";\r\n\r\n/** Describes the current state of a [[TileTree]]. TileTrees are loaded asynchronously and may be unloaded after a period of disuse.\r\n * @see [[TileTreeOwner]].\r\n * @public\r\n */\r\nexport enum TileTreeLoadStatus {\r\n  /** No attempt to load the tile tree has yet been made. */\r\n  NotLoaded,\r\n  /** The tile tree is in the process of being loaded. */\r\n  Loading,\r\n  /** The tile tree has been successfully loaded. */\r\n  Loaded,\r\n  /** An attempt to load the tile tree failed. */\r\n  NotFound,\r\n}\r\n\r\n/** A hierarchical level-of-detail tree of [3d Tiles](https://github.com/CesiumGS/3d-tiles) to be rendered in a [[Viewport]].\r\n * Tile trees originate from a variety of sources:\r\n *  - Each [[GeometricModelState]] can supply its graphics as a tile tree;\r\n *  - A [[DisplayStyleState]]'s map settings or reality models;\r\n *  - [ViewAttachment]($backend)s in a [[SheetModelState]];\r\n *  - [[TiledGraphicsProvider]]s associated with a viewport.\r\n *\r\n * The same TileTree can be displayed in any number of viewports using multiple [[TileTreeReference]]s.\r\n * A TileTree's lifetime is managed by a [[TileTreeOwner]].\r\n *\r\n * @note Some methods carry a warning that they should **not** be overridden by subclasses; typically a protected method exists that can be\r\n * overridden instead to customize the behavior. For example, [[selectTiles]] should not be overridden; instead, override the[[_selectTiles]] method\r\n * that it calls.\r\n * @public\r\n */\r\nexport abstract class TileTree {\r\n  private _isDisposed = false;\r\n  /** @internal */\r\n  protected _lastSelected = BeTimePoint.now();\r\n  /** @internal */\r\n  protected _clipVolume?: RenderClipVolume;\r\n  public readonly iModel: IModelConnection;\r\n  /** Transform from this tile tree's coordinate space to the iModel's coordinate space. */\r\n  public readonly iModelTransform: Transform;\r\n  /** Uniquely identifies this tree among all other tile trees associated with the iModel. */\r\n  public readonly id: string;\r\n  /** A 64-bit identifier for this tile tree, unique  within the context of its [[IModelConnection]].\r\n   * For a tile tree associated with a [[GeometricModelState]], this is the Id of the model. Other types of tile trees\r\n   * typically use a transient Id obtained from [[IModelConnection.transientIds]].\r\n   */\r\n  public readonly modelId: Id64String;\r\n  /** The length of time after which tiles belonging to this tree are considered elegible for disposal if they are no longer in use. */\r\n  public readonly expirationTime: BeDuration;\r\n  /** @internal */\r\n  public get loadPriority(): TileLoadPriority { return this._loadPriority; }\r\n  private readonly _loadPriority: TileLoadPriority;\r\n  /** Optional tight bounding box around the entire contents of all of this tree's tiles. */\r\n  public readonly contentRange?: ElementAlignedBox3d;\r\n\r\n  /** The lowest-resolution tile in this tree. */\r\n  public abstract get rootTile(): Tile;\r\n  /** True if this tile tree contains 3d graphics. */\r\n  public abstract get is3d(): boolean;\r\n  /** Returns the maximum depth of this tree, if any. */\r\n  public abstract get maxDepth(): number | undefined;\r\n\r\n  /** The overrides that should be applied to the view's [ViewFlags]($common) when this tile tree is drawn. Can be overridden by individual [[TileTreeReference]]s. */\r\n  public abstract get viewFlagOverrides(): ViewFlagOverrides;\r\n\r\n  /** True if this tile tree has no bounds - e.g., a tile tree representing a globe is unbounded. */\r\n  public get isContentUnbounded(): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Implement this method to select tiles of appropriate resolution. */\r\n  protected abstract _selectTiles(args: TileDrawArgs): Tile[];\r\n\r\n  /** Produce graphics of appropriate resolution to be drawn in a [[Viewport]]. */\r\n  public abstract draw(args: TileDrawArgs): void;\r\n\r\n  /** Discard tiles and/or tile contents, presumably based on a least-recently-used and/or least-likely-to-be-needed criterion. */\r\n  public abstract prune(): void;\r\n\r\n  /** True if this tile tree contains 2d graphics. */\r\n  public get is2d(): boolean { return !this.is3d; }\r\n  /** @internal */\r\n  public get isPointCloud(): boolean { return false; }\r\n  /** @internal */\r\n  public get clipVolume(): RenderClipVolume | undefined { return this._clipVolume; }\r\n\r\n  /** The volume of space occupied by this tile tree. */\r\n  public get range(): ElementAlignedBox3d { return this.rootTile.range; }\r\n  /** The most recent time at which tiles [[selectTiles]] was called. */\r\n  public get lastSelectedTime(): BeTimePoint { return this._lastSelected; }\r\n  /** True if a tile and its child tiles should not be drawn simultaneously.\r\n   * Default: true.\r\n   */\r\n  public get parentsAndChildrenExclusive(): boolean { return true; }\r\n\r\n  /** Constructor */\r\n  protected constructor(params: TileTreeParams) {\r\n    this._lastSelected = BeTimePoint.now();\r\n    this.iModel = params.iModel;\r\n    this.iModelTransform = params.location;\r\n    this._clipVolume = params.clipVolume;\r\n    this.modelId = params.modelId;\r\n    this.id = params.id;\r\n    this.contentRange = params.contentRange;\r\n\r\n    const admin = IModelApp.tileAdmin;\r\n    this._loadPriority = params.priority;\r\n    this.expirationTime = params.expirationTime ?? admin.tileExpirationTime;\r\n  }\r\n\r\n  /** Selects tiles of appropriate resolution for some purpose like drawing to the screen, producing a shadow map, etc.\r\n   * @note Do **not** override this method. Implement [[_selectTiles]].\r\n   */\r\n  public selectTiles(args: TileDrawArgs): Tile[] {\r\n    this._lastSelected = BeTimePoint.now();\r\n    const tiles = this._selectTiles(args);\r\n    IModelApp.tileAdmin.addTilesForUser(args.context.viewport, tiles, args.readyTiles);\r\n    args.processSelectedTiles(tiles);\r\n    return tiles;\r\n  }\r\n\r\n  /** True if [[dispose]] has been called on this tile tree. */\r\n  public get isDisposed(): boolean { return this._isDisposed; }\r\n\r\n  /** Dispose of this tree and any resources owned by it. This is typically invoked by a [[TileTreeOwner]]. */\r\n  public dispose(): void {\r\n    if (this.isDisposed)\r\n      return;\r\n\r\n    this._isDisposed = true;\r\n    dispose(this.rootTile);\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    this.rootTile.collectStatistics(stats);\r\n  }\r\n\r\n  /** Returns the number of [[Tile]]s currently in memory belonging to this tree, primarily for debugging. */\r\n  public countTiles(): number {\r\n    return 1 + this.rootTile.countDescendants();\r\n  }\r\n\r\n  /** @internal */\r\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, location: Transform, frustumPlanes?: FrustumPlanes): void {\r\n    this.rootTile.extendRangeForContent(range, matrix, location, frustumPlanes);\r\n  }\r\n\r\n  /**\r\n   * Return the transform from the tile tree's coordinate space to [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates.\r\n   * If a geographic coordinate system is present then this transform will be calculated at the tile tree center.\r\n   * @beta\r\n   */\r\n  public async getEcefTransform(): Promise<Transform | undefined> {\r\n    if (!this.iModel.ecefLocation)\r\n      return undefined;\r\n\r\n    let dbToEcef: Transform | undefined;\r\n    const range = this.contentRange ? this.contentRange : this.range;\r\n    const center = range.localXYZToWorld(.5, .5, .5);\r\n    if (center) {\r\n      this.iModelTransform.multiplyPoint3d(center, center);\r\n      const ecefToDb = await calculateEcefToDbTransformAtLocation(center, this.iModel);\r\n      dbToEcef = ecefToDb?.inverse();\r\n    }\r\n    if (!dbToEcef)\r\n      dbToEcef = this.iModel.ecefLocation.getTransform();\r\n\r\n    return dbToEcef.multiplyTransformTransform(this.iModelTransform);\r\n  }\r\n\r\n  /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.\r\n   * The base implementation does nothing.\r\n   * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.\r\n   * @beta\r\n   */\r\n  public collectTileGeometry(_collector: TileGeometryCollector): void {\r\n  }\r\n}\r\n\r\n"]}

package/lib/esm/tile/TileTreeReference.d.ts

@@ -9,7 +9,7 @@ import { RenderClipVolume } from "../render/RenderClipVolume";
 import { RenderMemory } from "../render/RenderMemory";
 import { DecorateContext, SceneContext } from "../ViewContext";
 import { ScreenViewport } from "../Viewport";
-import { DisclosedTileTreeSet, TileDrawArgs, TileTree, TileTreeOwner } from "./internal";
+import { DisclosedTileTreeSet, GeometryTileTreeReference, MapLayerFeatureInfo, TileDrawArgs, TileGeometryCollector, TileTree, TileTreeOwner } from "./internal";
 /** Describes the type of graphics produced by a [[TileTreeReference]].
  * @public
  */
@@ -22,7 +22,7 @@ export declare enum TileGraphicType {
     Overlay = 2
 }
 /** A reference to a [[TileTree]] suitable for drawing within a [[Viewport]]. The reference does not *own* its tile tree - it merely refers to it by
- * way of the tree [[TileTreeOwner]].
+ * way of the tree's [[TileTreeOwner]].
  * The specific [[TileTree]] referenced by this object may change based on the current state of the Viewport in which it is drawn - for example,
  * as a result of changing the RenderMode, or animation settings, or classification settings, etc.
  * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].
@@ -45,6 +45,10 @@ export declare abstract class TileTreeReference {
     draw(args: TileDrawArgs): void;
     /** Optionally return a tooltip describing the hit. */
     getToolTip(_hit: HitDetail): Promise<HTMLElement | string | undefined>;
+    /** Optionally return a MapLayerFeatureInfo object describing the hit.].
+     * @alpha
+     */
+    getMapFeatureInfo(_hit: HitDetail): Promise<MapLayerFeatureInfo[] | undefined>;
     /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.
      * @note This is currently only invoked for background maps and TiledGraphicsProviders - others have no decorations, but if they did implement this it would not be called.
      */
@@ -106,5 +110,26 @@ export declare abstract class TileTreeReference {
     get planarclipMaskPriority(): number;
     /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div. */
     addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void;
+    /** Create a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]].
+     * Return `undefined` if geometry collection is not supported.
+     * @see [[createGeometryTreeReference]].
+     * @beta
+     */
+    protected _createGeometryTreeReference(): GeometryTileTreeReference | undefined;
+    /** If defined, supplies the implementation of [[GeometryTileTreeReference.collectTileGeometry]].
+     * @beta
+     */
+    collectTileGeometry?: (collector: TileGeometryCollector) => void;
+    /** A function that can be assigned to [[collectTileGeometry]] to enable geometry collection for references to tile trees that support geometry collection.
+     * @beta
+     */
+    protected _collectTileGeometry(collector: TileGeometryCollector): void;
+    /** Obtain a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]], or
+     * undefined if geometry collection is not supported.
+     * Currently, only terrain and reality model tiles support geometry collection.
+     * @note Do not override this method - override [[_createGeometryTreeReference]] instead.
+     * @beta
+     */
+    createGeometryTreeReference(): GeometryTileTreeReference | undefined;
 }
 //# sourceMappingURL=TileTreeReference.d.ts.map

package/lib/esm/tile/TileTreeReference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TileTreeReference.d.ts","sourceRoot":"","sources":["../../../src/tile/TileTreeReference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,aAAa,EAAE,UAAU,EAA0B,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC1J,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,QAAQ,EAAsB,aAAa,EAAE,MAAM,YAAY,CAAC;AAE7G;;GAEG;AACH,oBAAY,eAAe;IACzB,wDAAwD;IACxD,aAAa,IAAI;IACjB,2CAA2C;IAC3C,KAAK,IAAI;IACT,+CAA+C;IAC/C,OAAO,IAAI;CACZ;AAED;;;;;;;;;GASG;AACH,8BAAsB,iBAAiB;IACrC,uJAAuJ;IACvJ,aAAoB,SAAS,IAAI,aAAa,CAAC;IAE/C;;;OAGG;IACI,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAM3D,qFAAqF;IAC9E,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAM9C,0IAA0I;IACnI,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrC,sDAAsD;IACzC,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAEnF;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAEhD;;OAEG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM1C,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAM9D;;;;OAIG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAUtC;IAED;;OAEG;IACH,SAAS,KAAK,kBAAkB,IAAI,OAAO,CAE1C;IAED;;;OAGG;IACI,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;IAoBtE,gBAAgB;IAChB,SAAS,CAAC,2BAA2B,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAI1E;;OAEG;IACI,WAAW,IAAI,SAAS,GAAG,SAAS;IAK3C,2HAA2H;IAC3H,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS;IAIrD;;OAEG;IACI,wBAAwB,IAAI,mBAAmB;IAStD,4EAA4E;IAC5E,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,gBAAgB,GAAG,SAAS;IAIrE,iIAAiI;IACjI,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAiB;IAIjE,gEAAgE;IAChE,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,gBAAgB,CAAC,SAAS,GAAG,SAAS;IAIxF,4EAA4E;IAC5E,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,yBAAyB,GAAG,SAAS;IAIvF,yEAAyE;IACzE,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,CAAC,QAAQ,GAAG,SAAS;IAO1E,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,EAAE,aAAa;IASjG,gBAAgB;IACT,gBAAgB,CAAC,eAAe,EAAE,OAAO,GAAG,IAAI;IAEvD,6GAA6G;IAC7G,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED,iKAAiK;IACjK,IAAW,QAAQ,IAAI,OAAO,CAAkB;IAEhD;;;OAGG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAA+C;IAE1F,iGAAiG;IAC1F,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;CACzE"}
+{"version":3,"file":"TileTreeReference.d.ts","sourceRoot":"","sources":["../../../src/tile/TileTreeReference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,aAAa,EAAE,UAAU,EAA0B,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC1J,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,oBAAoB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,YAAY,EAAE,qBAAqB,EAAE,QAAQ,EAAsB,aAAa,EACvJ,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,oBAAY,eAAe;IACzB,wDAAwD;IACxD,aAAa,IAAI;IACjB,2CAA2C;IAC3C,KAAK,IAAI;IACT,+CAA+C;IAC/C,OAAO,IAAI;CACZ;AAED;;;;;;;;;GASG;AACH,8BAAsB,iBAAiB;IACrC,uJAAuJ;IACvJ,aAAoB,SAAS,IAAI,aAAa,CAAC;IAE/C;;;OAGG;IACI,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAM3D,qFAAqF;IAC9E,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAM9C,0IAA0I;IACnI,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrC,sDAAsD;IACzC,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAEnF;;OAEG;IACU,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAE3F;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAEhD;;OAEG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM1C,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAM9D;;;;OAIG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAUtC;IAED;;OAEG;IACH,SAAS,KAAK,kBAAkB,IAAI,OAAO,CAE1C;IAED;;;OAGG;IACI,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;IAoBtE,gBAAgB;IAChB,SAAS,CAAC,2BAA2B,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAI1E;;OAEG;IACI,WAAW,IAAI,SAAS,GAAG,SAAS;IAK3C,2HAA2H;IAC3H,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS;IAIrD;;OAEG;IACI,wBAAwB,IAAI,mBAAmB;IAStD,4EAA4E;IAC5E,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,gBAAgB,GAAG,SAAS;IAIrE,iIAAiI;IACjI,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAiB;IAIjE,gEAAgE;IAChE,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,gBAAgB,CAAC,SAAS,GAAG,SAAS;IAIxF,4EAA4E;IAC5E,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,yBAAyB,GAAG,SAAS;IAIvF,yEAAyE;IACzE,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,CAAC,QAAQ,GAAG,SAAS;IAO1E,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,EAAE,aAAa;IASjG,gBAAgB;IACT,gBAAgB,CAAC,eAAe,EAAE,OAAO,GAAG,IAAI;IAEvD,6GAA6G;IAC7G,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED,iKAAiK;IACjK,IAAW,QAAQ,IAAI,OAAO,CAAkB;IAEhD;;;OAGG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAA+C;IAE1F,iGAAiG;IAC1F,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAExE;;;;OAIG;IACH,SAAS,CAAC,4BAA4B,IAAI,yBAAyB,GAAG,SAAS;IAI/E;;OAEG;IACI,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAExE;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI;IAatE;;;;;OAKG;IACI,2BAA2B,IAAI,yBAAyB,GAAG,SAAS;CAQ5E"}

package/lib/esm/tile/TileTreeReference.js

@@ -5,10 +5,10 @@
 /** @packageDocumentation
  * @module Tiles
  */
-import { BeTimePoint } from "@itwin/core-bentley";
+import { assert, BeTimePoint } from "@itwin/core-bentley";
 import { Range3d } from "@itwin/core-geometry";
 import { PlanarClipMaskPriority } from "@itwin/core-common";
-import { TileDrawArgs, TileTreeLoadStatus } from "./internal";
+import { TileDrawArgs, TileTreeLoadStatus, } from "./internal";
 /** Describes the type of graphics produced by a [[TileTreeReference]].
  * @public
  */
@@ -22,7 +22,7 @@ export var TileGraphicType;
     TileGraphicType[TileGraphicType["Overlay"] = 2] = "Overlay";
 })(TileGraphicType || (TileGraphicType = {}));
 /** A reference to a [[TileTree]] suitable for drawing within a [[Viewport]]. The reference does not *own* its tile tree - it merely refers to it by
- * way of the tree [[TileTreeOwner]].
+ * way of the tree's [[TileTreeOwner]].
  * The specific [[TileTree]] referenced by this object may change based on the current state of the Viewport in which it is drawn - for example,
  * as a result of changing the RenderMode, or animation settings, or classification settings, etc.
  * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].
@@ -53,6 +53,10 @@ export class TileTreeReference /* implements RenderMemory.Consumer */ {
     }
     /** Optionally return a tooltip describing the hit. */
     async getToolTip(_hit) { return undefined; }
+    /** Optionally return a MapLayerFeatureInfo object describing the hit.].
+     * @alpha
+     */
+    async getMapFeatureInfo(_hit) { return undefined; }
     /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.
      * @note This is currently only invoked for background maps and TiledGraphicsProviders - others have no decorations, but if they did implement this it would not be called.
      */
@@ -185,5 +189,41 @@ export class TileTreeReference /* implements RenderMemory.Consumer */ {
     get planarclipMaskPriority() { return PlanarClipMaskPriority.DesignModel; }
     /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div. */
     addLogoCards(_cards, _vp) { }
+    /** Create a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]].
+     * Return `undefined` if geometry collection is not supported.
+     * @see [[createGeometryTreeReference]].
+     * @beta
+     */
+    _createGeometryTreeReference() {
+        return undefined;
+    }
+    /** A function that can be assigned to [[collectTileGeometry]] to enable geometry collection for references to tile trees that support geometry collection.
+     * @beta
+     */
+    _collectTileGeometry(collector) {
+        const tree = this.treeOwner.load();
+        switch (this.treeOwner.loadStatus) {
+            case TileTreeLoadStatus.Loaded:
+                assert(undefined !== tree);
+                tree.collectTileGeometry(collector);
+                break;
+            case TileTreeLoadStatus.Loading:
+                collector.markLoading();
+                break;
+        }
+    }
+    /** Obtain a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]], or
+     * undefined if geometry collection is not supported.
+     * Currently, only terrain and reality model tiles support geometry collection.
+     * @note Do not override this method - override [[_createGeometryTreeReference]] instead.
+     * @beta
+     */
+    createGeometryTreeReference() {
+        if (this.collectTileGeometry) {
+            // Unclear why compiler doesn't detect that `this` satisfies the GeometryTileTreeReference interface...it must be looking only at the types, not this particular instance.
+            return this;
+        }
+        return this._createGeometryTreeReference();
+    }
 }
 //# sourceMappingURL=TileTreeReference.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TileTreeReference.js","sourceRoot":"","sources":["../../../src/tile/TileTreeReference.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAqB,OAAO,EAAa,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAA6E,sBAAsB,EAAqB,MAAM,oBAAoB,CAAC;AAO1J,OAAO,EAAwB,YAAY,EAAY,kBAAkB,EAAiB,MAAM,YAAY,CAAC;AAE7G;;GAEG;AACH,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wDAAwD;IACxD,uEAAiB,CAAA;IACjB,2CAA2C;IAC3C,uDAAS,CAAA;IACT,+CAA+C;IAC/C,2DAAW,CAAA;AACb,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B;AAED;;;;;;;;;GASG;AACH,MAAM,OAAgB,iBAAiB,CAAC,sCAAsC;IAI5E;;;OAGG;IACI,iBAAiB,CAAC,KAA2B;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,qFAAqF;IAC9E,UAAU,CAAC,OAAqB;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,0IAA0I;IACnI,IAAI,CAAC,IAAkB;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,sDAAsD;IAC/C,KAAK,CAAC,UAAU,CAAC,IAAe,IAA+C,OAAO,SAAS,CAAC,CAAC,CAAC;IAEzG;;OAEG;IACI,QAAQ,CAAC,QAAyB,IAAU,CAAC;IAEpD;;OAEG;IACI,aAAa,CAAC,KAAc;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACrD,IAAI,CAAC,YAAY,CAAC,MAAM;YACtB,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAW,iBAAiB;QAC1B,QAAQ,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;YACjC,KAAK,kBAAkB,CAAC,SAAS,CAAC;YAClC,KAAK,kBAAkB,CAAC,OAAO;gBAC7B,OAAO,KAAK,CAAC;YACf,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,CAAC,iCAAiC;YAChD,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC;SAClC;IACH,CAAC;IAED;;OAEG;IACH,IAAc,kBAAkB;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,OAAqB;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,YAAY,CAAC;YACtB,OAAO;YACP,IAAI;YACJ,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE;YACtB,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YACrC,iBAAiB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAClD,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACpC,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;YAC7D,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,wBAAwB,EAAE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC;SACjE,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACN,2BAA2B,CAAC,KAAe;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,CAAC;IAED,2HAA2H;IACjH,gBAAgB,CAAC,IAAc;QACvC,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,wBAAwB;QAC7B,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM;YAC1D,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAE/E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IAClE,aAAa,CAAC,IAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,iIAAiI;IACvH,oBAAoB,CAAC,IAAc;QAC3C,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,gEAAgE;IACtD,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,4EAA4E;IAClE,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IAC/D,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,0BAA0B,CAAC,KAAc,EAAE,MAAgB,EAAE,aAA6B;QAC/F,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO;QAET,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,eAAwB,IAAU,CAAC;IAE3D,6GAA6G;IAC7G,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iKAAiK;IACjK,IAAW,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEhD;;;OAGG;IACH,IAAW,sBAAsB,KAAa,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F,iGAAiG;IAC1F,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;CAC7E","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { BeTimePoint } from \"@itwin/core-bentley\";\r\nimport { Matrix4d, Range1d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, FeatureAppearanceProvider, FrustumPlanes, HiddenLine, PlanarClipMaskPriority, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { HitDetail } from \"../HitDetail\";\r\nimport { FeatureSymbology } from \"../render/FeatureSymbology\";\r\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\r\nimport { RenderMemory } from \"../render/RenderMemory\";\r\nimport { DecorateContext, SceneContext } from \"../ViewContext\";\r\nimport { ScreenViewport } from \"../Viewport\";\r\nimport { DisclosedTileTreeSet, TileDrawArgs, TileTree, TileTreeLoadStatus, TileTreeOwner } from \"./internal\";\r\n\r\n/** Describes the type of graphics produced by a [[TileTreeReference]].\r\n * @public\r\n */\r\nexport enum TileGraphicType {\r\n  /** Rendered behind all other geometry without depth. */\r\n  BackgroundMap = 0,\r\n  /** Rendered with normal scene graphics. */\r\n  Scene = 1,\r\n  /** Rendered in front of all other geometry. */\r\n  Overlay = 2,\r\n}\r\n\r\n/** A reference to a [[TileTree]] suitable for drawing within a [[Viewport]]. The reference does not *own* its tile tree - it merely refers to it by\r\n * way of the tree [[TileTreeOwner]].\r\n * The specific [[TileTree]] referenced by this object may change based on the current state of the Viewport in which it is drawn - for example,\r\n * as a result of changing the RenderMode, or animation settings, or classification settings, etc.\r\n * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].\r\n * Multiple TileTreeReferences can refer to the same TileTree with different parameters and logic - for example, the same background map tiles can be displayed in two viewports with\r\n * differing levels of transparency.\r\n * @see [[TiledGraphicsProvider]] to supply custom [[TileTreeReference]]s to be drawn within a [[Viewport]].\r\n * @public\r\n */\r\nexport abstract class TileTreeReference /* implements RenderMemory.Consumer */ {\r\n  /** The owner of the currently-referenced [[TileTree]]. Do not store a direct reference to it, because it may change or become disposed at any time. */\r\n  public abstract get treeOwner(): TileTreeOwner;\r\n\r\n  /** Disclose *all* TileTrees use by this reference. This may include things like map tiles used for draping on terrain.\r\n   * Override this and call super if you have such auxiliary trees.\r\n   * @note Any tree *NOT* disclosed becomes a candidate for *purging* (being unloaded from memory along with all of its tiles and graphics).\r\n   */\r\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree)\r\n      trees.add(tree);\r\n  }\r\n\r\n  /** Adds this reference's graphics to the scene. By default this invokes [[draw]]. */\r\n  public addToScene(context: SceneContext): void {\r\n    const args = this.createDrawArgs(context);\r\n    if (undefined !== args)\r\n      this.draw(args);\r\n  }\r\n\r\n  /** Adds this reference's graphics to the scene. By default this invokes [[TileTree.draw]] on the referenced TileTree, if it is loaded. */\r\n  public draw(args: TileDrawArgs): void {\r\n    args.tree.draw(args);\r\n  }\r\n\r\n  /** Optionally return a tooltip describing the hit. */\r\n  public async getToolTip(_hit: HitDetail): Promise<HTMLElement | string | undefined> { return undefined; }\r\n\r\n  /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.\r\n   * @note This is currently only invoked for background maps and TiledGraphicsProviders - others have no decorations, but if they did implement this it would not be called.\r\n   */\r\n  public decorate(_context: DecorateContext): void { }\r\n\r\n  /** Unions this reference's range with the supplied range to help compute a volume in world space for fitting a viewport to its contents.\r\n   * Override this function if a reference's range should not be included in the fit range, or a range different from its tile tree's range should be used.\r\n   */\r\n  public unionFitRange(union: Range3d): void {\r\n    const contentRange = this.computeWorldContentRange();\r\n    if (!contentRange.isNull)\r\n      union.extendRange(contentRange);\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree)\r\n      tree.collectStatistics(stats);\r\n  }\r\n\r\n  /** Return true if the tile tree is fully loaded and ready to draw.\r\n   * The default implementation returns true if the tile tree loading process completed (whether it resulted in success or failure).\r\n   * @note Do *not* override this property - override [[_isLoadingComplete]] instead..\r\n   * @public\r\n   */\r\n  public get isLoadingComplete(): boolean {\r\n    switch (this.treeOwner.loadStatus) {\r\n      case TileTreeLoadStatus.NotLoaded:\r\n      case TileTreeLoadStatus.Loading:\r\n        return false;\r\n      case TileTreeLoadStatus.NotFound:\r\n        return true; // we tried, and failed, to load.\r\n      case TileTreeLoadStatus.Loaded:\r\n        return this._isLoadingComplete;\r\n    }\r\n  }\r\n\r\n  /** Override if additional asynchronous loading is required after the tile tree is successfully loaded, to indicate when that loading has completed.\r\n   * @public\r\n   */\r\n  protected get _isLoadingComplete(): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Create context for drawing the tile tree, if it is ready for drawing.\r\n   * TileTreeReferences can override individual portions of the context, e.g. apply their own transform.\r\n   * Returns undefined if, e.g., the tile tree is not yet loaded.\r\n   */\r\n  public createDrawArgs(context: SceneContext): TileDrawArgs | undefined {\r\n    const tree = this.treeOwner.load();\r\n    if (undefined === tree)\r\n      return undefined;\r\n\r\n    return new TileDrawArgs({\r\n      context,\r\n      tree,\r\n      now: BeTimePoint.now(),\r\n      location: this.computeTransform(tree),\r\n      viewFlagOverrides: this.getViewFlagOverrides(tree),\r\n      clipVolume: this.getClipVolume(tree),\r\n      parentsAndChildrenExclusive: tree.parentsAndChildrenExclusive,\r\n      symbologyOverrides: this.getSymbologyOverrides(tree),\r\n      appearanceProvider: this.getAppearanceProvider(tree),\r\n      hiddenLineSettings: this.getHiddenLineSettings(tree),\r\n      animationTransformNodeId: this.getAnimationTransformNodeId(tree),\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  protected getAnimationTransformNodeId(_tree: TileTree): number | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Supply transform from this tile tree reference's location to iModel coordinate space.\r\n   * @returns undefined if the TileTree is not yet loaded.\r\n   */\r\n  public getLocation(): Transform | undefined {\r\n    const tree = this.treeOwner.load();\r\n    return undefined !== tree ? this.computeTransform(tree) : undefined;\r\n  }\r\n\r\n  /** Compute a transform from this tile tree reference's coordinate space to the [[IModelConnection]]'s coordinate space. */\r\n  protected computeTransform(tree: TileTree): Transform {\r\n    return tree.iModelTransform.clone();\r\n  }\r\n\r\n  /** Compute the range of this tile tree's contents in world coordinates.\r\n   * @returns The content range in world coodinates, or a null range if the tile tree is not loaded or has a null content range.\r\n   */\r\n  public computeWorldContentRange(): ElementAlignedBox3d {\r\n    const range = new Range3d();\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree && !tree.rootTile.contentRange.isNull)\r\n      this.computeTransform(tree).multiplyRange(tree.rootTile.contentRange, range);\r\n\r\n    return range;\r\n  }\r\n\r\n  /** Return the clip volume applied to this reference's tile tree, if any. */\r\n  protected getClipVolume(tree: TileTree): RenderClipVolume | undefined {\r\n    return tree.clipVolume;\r\n  }\r\n\r\n  /** Supply overrides that should be applied to the [[ViewState]]'s [ViewFlags]($common) when drawing this tile tree reference. */\r\n  protected getViewFlagOverrides(tree: TileTree): ViewFlagOverrides {\r\n    return tree.viewFlagOverrides;\r\n  }\r\n\r\n  /** Return overrides that *replace* any defined for the view. */\r\n  protected getSymbologyOverrides(_tree: TileTree): FeatureSymbology.Overrides | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Return a provider that can supplement the view's symbology overrides. */\r\n  protected getAppearanceProvider(_tree: TileTree): FeatureAppearanceProvider | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Return hidden line settings to replace those defined for the view. */\r\n  protected getHiddenLineSettings(_tree: TileTree): HiddenLine.Settings | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /* Extend range to include transformed range of this tile tree.\r\n   * @internal\r\n   */\r\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, frustumPlanes?: FrustumPlanes) {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined === tree)\r\n      return;\r\n\r\n    const location = this.computeTransform(tree);\r\n    tree.accumulateTransformedRange(range, matrix, location, frustumPlanes);\r\n  }\r\n\r\n  /** @internal */\r\n  public getTerrainHeight(_terrainHeights: Range1d): void { }\r\n\r\n  /** Return whether the geometry exposed by this tile tree reference should cast shadows on other geometry. */\r\n  public get castsShadows(): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Return whether this reference has global coverage.  Mapping data is global and some non-primary models such as the OSM building layer have global coverage */\r\n  public get isGlobal(): boolean { return false; }\r\n\r\n  /**  Return the clip mask priority for this model - models will be clipped by any other viewed model with a higher proirity.\r\n   * BIM models have highest prioirty and are never clipped.\r\n   * @alpha\r\n   */\r\n  public get planarclipMaskPriority(): number { return PlanarClipMaskPriority.DesignModel; }\r\n\r\n  /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div. */\r\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\r\n}\r\n"]}
+{"version":3,"file":"TileTreeReference.js","sourceRoot":"","sources":["../../../src/tile/TileTreeReference.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAqB,OAAO,EAAa,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAA6E,sBAAsB,EAAqB,MAAM,oBAAoB,CAAC;AAO1J,OAAO,EACiE,YAAY,EAAmC,kBAAkB,GACxI,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wDAAwD;IACxD,uEAAiB,CAAA;IACjB,2CAA2C;IAC3C,uDAAS,CAAA;IACT,+CAA+C;IAC/C,2DAAW,CAAA;AACb,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B;AAED;;;;;;;;;GASG;AACH,MAAM,OAAgB,iBAAiB,CAAC,sCAAsC;IAI5E;;;OAGG;IACI,iBAAiB,CAAC,KAA2B;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,qFAAqF;IAC9E,UAAU,CAAC,OAAqB;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,0IAA0I;IACnI,IAAI,CAAC,IAAkB;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,sDAAsD;IAC/C,KAAK,CAAC,UAAU,CAAC,IAAe,IAA+C,OAAO,SAAS,CAAC,CAAC,CAAC;IAEzG;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,IAAe,IAAiD,OAAO,SAAS,CAAC,CAAC,CAAC;IAElH;;OAEG;IACI,QAAQ,CAAC,QAAyB,IAAU,CAAC;IAEpD;;OAEG;IACI,aAAa,CAAC,KAAc;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACrD,IAAI,CAAC,YAAY,CAAC,MAAM;YACtB,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAW,iBAAiB;QAC1B,QAAQ,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;YACjC,KAAK,kBAAkB,CAAC,SAAS,CAAC;YAClC,KAAK,kBAAkB,CAAC,OAAO;gBAC7B,OAAO,KAAK,CAAC;YACf,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,CAAC,iCAAiC;YAChD,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC;SAClC;IACH,CAAC;IAED;;OAEG;IACH,IAAc,kBAAkB;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,OAAqB;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,YAAY,CAAC;YACtB,OAAO;YACP,IAAI;YACJ,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE;YACtB,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YACrC,iBAAiB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAClD,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACpC,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;YAC7D,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACpD,wBAAwB,EAAE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC;SACjE,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACN,2BAA2B,CAAC,KAAe;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,CAAC;IAED,2HAA2H;IACjH,gBAAgB,CAAC,IAAc;QACvC,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,wBAAwB;QAC7B,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM;YAC1D,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAE/E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IAClE,aAAa,CAAC,IAAc;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,iIAAiI;IACvH,oBAAoB,CAAC,IAAc;QAC3C,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,gEAAgE;IACtD,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,4EAA4E;IAClE,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,yEAAyE;IAC/D,qBAAqB,CAAC,KAAe;QAC7C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,0BAA0B,CAAC,KAAc,EAAE,MAAgB,EAAE,aAA6B;QAC/F,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO;QAET,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,gBAAgB;IACT,gBAAgB,CAAC,eAAwB,IAAU,CAAC;IAE3D,6GAA6G;IAC7G,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iKAAiK;IACjK,IAAW,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEhD;;;OAGG;IACH,IAAW,sBAAsB,KAAa,OAAO,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F,iGAAiG;IAC1F,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;IAE5E;;;;OAIG;IACO,4BAA4B;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IAOD;;OAEG;IACO,oBAAoB,CAAC,SAAgC;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;YACjC,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,kBAAkB,CAAC,OAAO;gBAC7B,SAAS,CAAC,WAAW,EAAE,CAAC;gBACxB,MAAM;SACT;IACH,CAAC;IAED;;;;;OAKG;IACI,2BAA2B;QAChC,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5B,0KAA0K;YAC1K,OAAO,IAAiC,CAAC;SAC1C;QAED,OAAO,IAAI,CAAC,4BAA4B,EAAE,CAAC;IAC7C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { assert, BeTimePoint } from \"@itwin/core-bentley\";\r\nimport { Matrix4d, Range1d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, FeatureAppearanceProvider, FrustumPlanes, HiddenLine, PlanarClipMaskPriority, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { HitDetail } from \"../HitDetail\";\r\nimport { FeatureSymbology } from \"../render/FeatureSymbology\";\r\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\r\nimport { RenderMemory } from \"../render/RenderMemory\";\r\nimport { DecorateContext, SceneContext } from \"../ViewContext\";\r\nimport { ScreenViewport } from \"../Viewport\";\r\nimport {\r\n  DisclosedTileTreeSet, GeometryTileTreeReference, MapLayerFeatureInfo, TileDrawArgs, TileGeometryCollector, TileTree, TileTreeLoadStatus, TileTreeOwner,\r\n} from \"./internal\";\r\n\r\n/** Describes the type of graphics produced by a [[TileTreeReference]].\r\n * @public\r\n */\r\nexport enum TileGraphicType {\r\n  /** Rendered behind all other geometry without depth. */\r\n  BackgroundMap = 0,\r\n  /** Rendered with normal scene graphics. */\r\n  Scene = 1,\r\n  /** Rendered in front of all other geometry. */\r\n  Overlay = 2,\r\n}\r\n\r\n/** A reference to a [[TileTree]] suitable for drawing within a [[Viewport]]. The reference does not *own* its tile tree - it merely refers to it by\r\n * way of the tree's [[TileTreeOwner]].\r\n * The specific [[TileTree]] referenced by this object may change based on the current state of the Viewport in which it is drawn - for example,\r\n * as a result of changing the RenderMode, or animation settings, or classification settings, etc.\r\n * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].\r\n * Multiple TileTreeReferences can refer to the same TileTree with different parameters and logic - for example, the same background map tiles can be displayed in two viewports with\r\n * differing levels of transparency.\r\n * @see [[TiledGraphicsProvider]] to supply custom [[TileTreeReference]]s to be drawn within a [[Viewport]].\r\n * @public\r\n */\r\nexport abstract class TileTreeReference /* implements RenderMemory.Consumer */ {\r\n  /** The owner of the currently-referenced [[TileTree]]. Do not store a direct reference to it, because it may change or become disposed at any time. */\r\n  public abstract get treeOwner(): TileTreeOwner;\r\n\r\n  /** Disclose *all* TileTrees use by this reference. This may include things like map tiles used for draping on terrain.\r\n   * Override this and call super if you have such auxiliary trees.\r\n   * @note Any tree *NOT* disclosed becomes a candidate for *purging* (being unloaded from memory along with all of its tiles and graphics).\r\n   */\r\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree)\r\n      trees.add(tree);\r\n  }\r\n\r\n  /** Adds this reference's graphics to the scene. By default this invokes [[draw]]. */\r\n  public addToScene(context: SceneContext): void {\r\n    const args = this.createDrawArgs(context);\r\n    if (undefined !== args)\r\n      this.draw(args);\r\n  }\r\n\r\n  /** Adds this reference's graphics to the scene. By default this invokes [[TileTree.draw]] on the referenced TileTree, if it is loaded. */\r\n  public draw(args: TileDrawArgs): void {\r\n    args.tree.draw(args);\r\n  }\r\n\r\n  /** Optionally return a tooltip describing the hit. */\r\n  public async getToolTip(_hit: HitDetail): Promise<HTMLElement | string | undefined> { return undefined; }\r\n\r\n  /** Optionally return a MapLayerFeatureInfo object describing the hit.].\r\n   * @alpha\r\n   */\r\n  public async getMapFeatureInfo(_hit: HitDetail): Promise<MapLayerFeatureInfo[] | undefined>  { return undefined; }\r\n\r\n  /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.\r\n   * @note This is currently only invoked for background maps and TiledGraphicsProviders - others have no decorations, but if they did implement this it would not be called.\r\n   */\r\n  public decorate(_context: DecorateContext): void { }\r\n\r\n  /** Unions this reference's range with the supplied range to help compute a volume in world space for fitting a viewport to its contents.\r\n   * Override this function if a reference's range should not be included in the fit range, or a range different from its tile tree's range should be used.\r\n   */\r\n  public unionFitRange(union: Range3d): void {\r\n    const contentRange = this.computeWorldContentRange();\r\n    if (!contentRange.isNull)\r\n      union.extendRange(contentRange);\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree)\r\n      tree.collectStatistics(stats);\r\n  }\r\n\r\n  /** Return true if the tile tree is fully loaded and ready to draw.\r\n   * The default implementation returns true if the tile tree loading process completed (whether it resulted in success or failure).\r\n   * @note Do *not* override this property - override [[_isLoadingComplete]] instead..\r\n   * @public\r\n   */\r\n  public get isLoadingComplete(): boolean {\r\n    switch (this.treeOwner.loadStatus) {\r\n      case TileTreeLoadStatus.NotLoaded:\r\n      case TileTreeLoadStatus.Loading:\r\n        return false;\r\n      case TileTreeLoadStatus.NotFound:\r\n        return true; // we tried, and failed, to load.\r\n      case TileTreeLoadStatus.Loaded:\r\n        return this._isLoadingComplete;\r\n    }\r\n  }\r\n\r\n  /** Override if additional asynchronous loading is required after the tile tree is successfully loaded, to indicate when that loading has completed.\r\n   * @public\r\n   */\r\n  protected get _isLoadingComplete(): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Create context for drawing the tile tree, if it is ready for drawing.\r\n   * TileTreeReferences can override individual portions of the context, e.g. apply their own transform.\r\n   * Returns undefined if, e.g., the tile tree is not yet loaded.\r\n   */\r\n  public createDrawArgs(context: SceneContext): TileDrawArgs | undefined {\r\n    const tree = this.treeOwner.load();\r\n    if (undefined === tree)\r\n      return undefined;\r\n\r\n    return new TileDrawArgs({\r\n      context,\r\n      tree,\r\n      now: BeTimePoint.now(),\r\n      location: this.computeTransform(tree),\r\n      viewFlagOverrides: this.getViewFlagOverrides(tree),\r\n      clipVolume: this.getClipVolume(tree),\r\n      parentsAndChildrenExclusive: tree.parentsAndChildrenExclusive,\r\n      symbologyOverrides: this.getSymbologyOverrides(tree),\r\n      appearanceProvider: this.getAppearanceProvider(tree),\r\n      hiddenLineSettings: this.getHiddenLineSettings(tree),\r\n      animationTransformNodeId: this.getAnimationTransformNodeId(tree),\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  protected getAnimationTransformNodeId(_tree: TileTree): number | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Supply transform from this tile tree reference's location to iModel coordinate space.\r\n   * @returns undefined if the TileTree is not yet loaded.\r\n   */\r\n  public getLocation(): Transform | undefined {\r\n    const tree = this.treeOwner.load();\r\n    return undefined !== tree ? this.computeTransform(tree) : undefined;\r\n  }\r\n\r\n  /** Compute a transform from this tile tree reference's coordinate space to the [[IModelConnection]]'s coordinate space. */\r\n  protected computeTransform(tree: TileTree): Transform {\r\n    return tree.iModelTransform.clone();\r\n  }\r\n\r\n  /** Compute the range of this tile tree's contents in world coordinates.\r\n   * @returns The content range in world coodinates, or a null range if the tile tree is not loaded or has a null content range.\r\n   */\r\n  public computeWorldContentRange(): ElementAlignedBox3d {\r\n    const range = new Range3d();\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined !== tree && !tree.rootTile.contentRange.isNull)\r\n      this.computeTransform(tree).multiplyRange(tree.rootTile.contentRange, range);\r\n\r\n    return range;\r\n  }\r\n\r\n  /** Return the clip volume applied to this reference's tile tree, if any. */\r\n  protected getClipVolume(tree: TileTree): RenderClipVolume | undefined {\r\n    return tree.clipVolume;\r\n  }\r\n\r\n  /** Supply overrides that should be applied to the [[ViewState]]'s [ViewFlags]($common) when drawing this tile tree reference. */\r\n  protected getViewFlagOverrides(tree: TileTree): ViewFlagOverrides {\r\n    return tree.viewFlagOverrides;\r\n  }\r\n\r\n  /** Return overrides that *replace* any defined for the view. */\r\n  protected getSymbologyOverrides(_tree: TileTree): FeatureSymbology.Overrides | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Return a provider that can supplement the view's symbology overrides. */\r\n  protected getAppearanceProvider(_tree: TileTree): FeatureAppearanceProvider | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** Return hidden line settings to replace those defined for the view. */\r\n  protected getHiddenLineSettings(_tree: TileTree): HiddenLine.Settings | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /* Extend range to include transformed range of this tile tree.\r\n   * @internal\r\n   */\r\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, frustumPlanes?: FrustumPlanes) {\r\n    const tree = this.treeOwner.tileTree;\r\n    if (undefined === tree)\r\n      return;\r\n\r\n    const location = this.computeTransform(tree);\r\n    tree.accumulateTransformedRange(range, matrix, location, frustumPlanes);\r\n  }\r\n\r\n  /** @internal */\r\n  public getTerrainHeight(_terrainHeights: Range1d): void { }\r\n\r\n  /** Return whether the geometry exposed by this tile tree reference should cast shadows on other geometry. */\r\n  public get castsShadows(): boolean {\r\n    return true;\r\n  }\r\n\r\n  /** Return whether this reference has global coverage.  Mapping data is global and some non-primary models such as the OSM building layer have global coverage */\r\n  public get isGlobal(): boolean { return false; }\r\n\r\n  /**  Return the clip mask priority for this model - models will be clipped by any other viewed model with a higher proirity.\r\n   * BIM models have highest prioirty and are never clipped.\r\n   * @alpha\r\n   */\r\n  public get planarclipMaskPriority(): number { return PlanarClipMaskPriority.DesignModel; }\r\n\r\n  /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div. */\r\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\r\n\r\n  /** Create a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]].\r\n   * Return `undefined` if geometry collection is not supported.\r\n   * @see [[createGeometryTreeReference]].\r\n   * @beta\r\n   */\r\n  protected _createGeometryTreeReference(): GeometryTileTreeReference | undefined {\r\n    return undefined;\r\n  }\r\n\r\n  /** If defined, supplies the implementation of [[GeometryTileTreeReference.collectTileGeometry]].\r\n   * @beta\r\n   */\r\n  public collectTileGeometry?: (collector: TileGeometryCollector) => void;\r\n\r\n  /** A function that can be assigned to [[collectTileGeometry]] to enable geometry collection for references to tile trees that support geometry collection.\r\n   * @beta\r\n   */\r\n  protected _collectTileGeometry(collector: TileGeometryCollector): void {\r\n    const tree = this.treeOwner.load();\r\n    switch (this.treeOwner.loadStatus) {\r\n      case TileTreeLoadStatus.Loaded:\r\n        assert(undefined !== tree);\r\n        tree.collectTileGeometry(collector);\r\n        break;\r\n      case TileTreeLoadStatus.Loading:\r\n        collector.markLoading();\r\n        break;\r\n    }\r\n  }\r\n\r\n  /** Obtain a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]], or\r\n   * undefined if geometry collection is not supported.\r\n   * Currently, only terrain and reality model tiles support geometry collection.\r\n   * @note Do not override this method - override [[_createGeometryTreeReference]] instead.\r\n   * @beta\r\n   */\r\n  public createGeometryTreeReference(): GeometryTileTreeReference | undefined {\r\n    if (this.collectTileGeometry) {\r\n      // Unclear why compiler doesn't detect that `this` satisfies the GeometryTileTreeReference interface...it must be looking only at the types, not this particular instance.\r\n      return this as GeometryTileTreeReference;\r\n    }\r\n\r\n    return this._createGeometryTreeReference();\r\n  }\r\n}\r\n"]}

package/lib/esm/tile/TileUsageMarker.d.ts

@@ -2,22 +2,22 @@
  * @module Tiles
  */
 import { BeTimePoint } from "@itwin/core-bentley";
-import { Viewport } from "../Viewport";
-/** A marker associated with a [[Tile]] to track usage of that tile by any number of viewports.
+import { TileUser } from "./internal";
+/** A marker associated with a [[Tile]] to track usage of that tile by any number of [[TileUser]]s.
  * The marker tracks:
- *  - the set of [[Viewport]]s in which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and
- *  - the most recent time at which any viewport declared its use of the tile.
- * The marker is used to allow tiles to be discarded after they become disused by any viewport, via [[Tile.prune]].
+ *  - the set of [[TileUser]]s by which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and
+ *  - the most recent time at which any tile user declared its use of the tile.
+ * The marker is used to allow tiles to be discarded after they become disused by any tile user, via [[Tile.prune]].
  * @see [[Tile.usageMarker]].
  * @public
  */
 export declare class TileUsageMarker {
     private _timePoint;
-    /** Constructs a usage marker with its timepoint set to the current time and its set of viewports empty. */
+    /** Constructs a usage marker with its timepoint set to the current time and its set of [[TileUser]]s empty. */
     constructor();
-    /** Returns true if this tile is currently in use by no viewports and its timestamp pre-dates `expirationTime`. */
+    /** Returns true if this tile is currently in use by no [[TileUser]]s and its timestamp pre-dates `expirationTime`. */
     isExpired(expirationTime: BeTimePoint): boolean;
-    /** Updates the timestamp to the specified time and marks the tile as being in use by the specified viewport. */
-    mark(vp: Viewport, time: BeTimePoint): void;
+    /** Updates the timestamp to the specified time and marks the tile as being in use by the specified [[TileUser]]. */
+    mark(user: TileUser, time: BeTimePoint): void;
 }
 //# sourceMappingURL=TileUsageMarker.d.ts.map

package/lib/esm/tile/TileUsageMarker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TileUsageMarker.d.ts","sourceRoot":"","sources":["../../../src/tile/TileUsageMarker.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;;;;GAOG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,UAAU,CAAqB;IAEvC,2GAA2G;;IAI3G,kHAAkH;IAC3G,SAAS,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO;IAItD,gHAAgH;IACzG,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,GAAG,IAAI;CAInD"}
+{"version":3,"file":"TileUsageMarker.d.ts","sourceRoot":"","sources":["../../../src/tile/TileUsageMarker.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;GAOG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,UAAU,CAAqB;IAEvC,+GAA+G;;IAI/G,sHAAsH;IAC/G,SAAS,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO;IAItD,oHAAoH;IAC7G,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,GAAG,IAAI;CAIrD"}

package/lib/esm/tile/TileUsageMarker.js

@@ -7,27 +7,27 @@
  */
 import { BeTimePoint } from "@itwin/core-bentley";
 import { IModelApp } from "../IModelApp";
-/** A marker associated with a [[Tile]] to track usage of that tile by any number of viewports.
+/** A marker associated with a [[Tile]] to track usage of that tile by any number of [[TileUser]]s.
  * The marker tracks:
- *  - the set of [[Viewport]]s in which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and
- *  - the most recent time at which any viewport declared its use of the tile.
- * The marker is used to allow tiles to be discarded after they become disused by any viewport, via [[Tile.prune]].
+ *  - the set of [[TileUser]]s by which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and
+ *  - the most recent time at which any tile user declared its use of the tile.
+ * The marker is used to allow tiles to be discarded after they become disused by any tile user, via [[Tile.prune]].
  * @see [[Tile.usageMarker]].
  * @public
  */
 export class TileUsageMarker {
-    /** Constructs a usage marker with its timepoint set to the current time and its set of viewports empty. */
+    /** Constructs a usage marker with its timepoint set to the current time and its set of [[TileUser]]s empty. */
     constructor() {
         this._timePoint = BeTimePoint.now();
     }
-    /** Returns true if this tile is currently in use by no viewports and its timestamp pre-dates `expirationTime`. */
+    /** Returns true if this tile is currently in use by no [[TileUser]]s and its timestamp pre-dates `expirationTime`. */
     isExpired(expirationTime) {
         return this._timePoint.before(expirationTime) && !IModelApp.tileAdmin.isTileInUse(this);
     }
-    /** Updates the timestamp to the specified time and marks the tile as being in use by the specified viewport. */
-    mark(vp, time) {
+    /** Updates the timestamp to the specified time and marks the tile as being in use by the specified [[TileUser]]. */
+    mark(user, time) {
         this._timePoint = time;
-        IModelApp.tileAdmin.markTileUsedByViewport(this, vp);
+        IModelApp.tileAdmin.markTileUsed(this, user);
     }
 }
 //# sourceMappingURL=TileUsageMarker.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"TileUsageMarker.js","sourceRoot":"","sources":["../../../src/tile/TileUsageMarker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;;;;;;GAOG;AACH,MAAM,OAAO,eAAe;IAG1B,2GAA2G;IAC3G;QAHQ,eAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAIvC,CAAC;IAED,kHAAkH;IAC3G,SAAS,CAAC,cAA2B;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED,gHAAgH;IACzG,IAAI,CAAC,EAAY,EAAE,IAAiB;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,SAAS,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { BeTimePoint } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { Viewport } from \"../Viewport\";\r\n\r\n/** A marker associated with a [[Tile]] to track usage of that tile by any number of viewports.\r\n * The marker tracks:\r\n *  - the set of [[Viewport]]s in which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and\r\n *  - the most recent time at which any viewport declared its use of the tile.\r\n * The marker is used to allow tiles to be discarded after they become disused by any viewport, via [[Tile.prune]].\r\n * @see [[Tile.usageMarker]].\r\n * @public\r\n */\r\nexport class TileUsageMarker {\r\n  private _timePoint = BeTimePoint.now();\r\n\r\n  /** Constructs a usage marker with its timepoint set to the current time and its set of viewports empty. */\r\n  public constructor() {\r\n  }\r\n\r\n  /** Returns true if this tile is currently in use by no viewports and its timestamp pre-dates `expirationTime`. */\r\n  public isExpired(expirationTime: BeTimePoint): boolean {\r\n    return this._timePoint.before(expirationTime) && !IModelApp.tileAdmin.isTileInUse(this);\r\n  }\r\n\r\n  /** Updates the timestamp to the specified time and marks the tile as being in use by the specified viewport. */\r\n  public mark(vp: Viewport, time: BeTimePoint): void {\r\n    this._timePoint = time;\r\n    IModelApp.tileAdmin.markTileUsedByViewport(this, vp);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TileUsageMarker.js","sourceRoot":"","sources":["../../../src/tile/TileUsageMarker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;;;;;;GAOG;AACH,MAAM,OAAO,eAAe;IAG1B,+GAA+G;IAC/G;QAHQ,eAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAIvC,CAAC;IAED,sHAAsH;IAC/G,SAAS,CAAC,cAA2B;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED,oHAAoH;IAC7G,IAAI,CAAC,IAAc,EAAE,IAAiB;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { BeTimePoint } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { TileUser } from \"./internal\";\r\n\r\n/** A marker associated with a [[Tile]] to track usage of that tile by any number of [[TileUser]]s.\r\n * The marker tracks:\r\n *  - the set of [[TileUser]]s by which the tile is in use for some purpose (displayed, preloaded, requested, selected for shadow map, etc); and\r\n *  - the most recent time at which any tile user declared its use of the tile.\r\n * The marker is used to allow tiles to be discarded after they become disused by any tile user, via [[Tile.prune]].\r\n * @see [[Tile.usageMarker]].\r\n * @public\r\n */\r\nexport class TileUsageMarker {\r\n  private _timePoint = BeTimePoint.now();\r\n\r\n  /** Constructs a usage marker with its timepoint set to the current time and its set of [[TileUser]]s empty. */\r\n  public constructor() {\r\n  }\r\n\r\n  /** Returns true if this tile is currently in use by no [[TileUser]]s and its timestamp pre-dates `expirationTime`. */\r\n  public isExpired(expirationTime: BeTimePoint): boolean {\r\n    return this._timePoint.before(expirationTime) && !IModelApp.tileAdmin.isTileInUse(this);\r\n  }\r\n\r\n  /** Updates the timestamp to the specified time and marks the tile as being in use by the specified [[TileUser]]. */\r\n  public mark(user: TileUser, time: BeTimePoint): void {\r\n    this._timePoint = time;\r\n    IModelApp.tileAdmin.markTileUsed(this, user);\r\n  }\r\n}\r\n"]}

package/lib/esm/tile/TileUser.d.ts

@@ -0,0 +1,33 @@
+/** @packageDocumentation
+ * @module Tiles
+ */
+import { IModelConnection } from "../IModelConnection";
+import { Viewport } from "../Viewport";
+import { DisclosedTileTreeSet, TileRequest } from "./internal";
+/** Represents some object that makes use of [[Tile]]s in some way - e.g., by requesting and/or displaying their contents, querying their geometry, etc.
+ * Each [[Tile]] keeps track of its users via its [[TileUsageMarker]]. A tile with no users is eligible to be discarded view [[Tile.prune]].
+ * Every [[Viewport]] is a tile user. It is occasionally useful to have a tile user that is **not** a viewport.
+ * Every TileUser is identified by an integer Id that is unique among all extant TileUsers. This Id **must** be obtained via [[TileUser.generateId]].
+ * Every TileUser must be registered with [[IModelApp.tileAdmin]] before use via [[TileAdmin.registerUser]] and unregistered via [[TileAdmin.forgetUser]] after
+ * it ceases using tiles.
+ * @public
+ */
+export interface TileUser {
+    /** A unique integer identifying this user amongst all extant users. This Id **must** be obtained via [[TIleUser.generateId]]. */
+    readonly tileUserId: number;
+    /** The iModel with which the user is associated. */
+    readonly iModel: IModelConnection;
+    /** Disclose all tile trees currently in use by this user. Any tile tree not disclosed by any user becomes eligible for garbage collection. */
+    readonly discloseTileTrees: (trees: DisclosedTileTreeSet) => void;
+    /** An optional function invoked when a [[TileRequest]] associated with a [[Tile]] in use by this user changes state - e.g., when the request completes, fails, or
+     * is cancelled. For example, a [[Viewport]] responds to such events by invalidating its scene.
+     */
+    readonly onRequestStateChanged?: (req: TileRequest) => void;
+}
+/** @public */
+export declare namespace TileUser {
+    function generateId(): number;
+    /** Iterate the subset of `users` that are [[Viewport]]s. */
+    function viewportsFromUsers(users: Iterable<TileUser>): Iterable<Viewport>;
+}
+//# sourceMappingURL=TileUser.d.ts.map

package/lib/esm/tile/TileUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileUser.d.ts","sourceRoot":"","sources":["../../../src/tile/TileUser.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,iIAAiI;IACjI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC,8IAA8I;IAC9I,QAAQ,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAClE;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,CAAC;CAC7D;AAID,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB,SAAgB,UAAU,IAAI,MAAM,CAEnC;IAED,4DAA4D;IAC5D,SAAkB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAIlF;CACF"}

package/lib/esm/tile/TileUser.js

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tiles
+ */
+import { Viewport } from "../Viewport";
+let nextUserId = 1;
+/** @public */
+export var TileUser;
+(function (TileUser) {
+    function generateId() {
+        return nextUserId++;
+    }
+    TileUser.generateId = generateId;
+    /** Iterate the subset of `users` that are [[Viewport]]s. */
+    function* viewportsFromUsers(users) {
+        for (const user of users)
+            if (user instanceof Viewport)
+                yield user;
+    }
+    TileUser.viewportsFromUsers = viewportsFromUsers;
+})(TileUser || (TileUser = {}));
+//# sourceMappingURL=TileUser.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileUser.js","sourceRoot":"","sources":["../../../src/tile/TileUser.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAwBvC,IAAI,UAAU,GAAG,CAAC,CAAC;AAEnB,cAAc;AACd,MAAM,KAAW,QAAQ,CAWxB;AAXD,WAAiB,QAAQ;IACvB,SAAgB,UAAU;QACxB,OAAO,UAAU,EAAE,CAAC;IACtB,CAAC;IAFe,mBAAU,aAEzB,CAAA;IAED,4DAA4D;IAC5D,QAAgB,CAAC,CAAC,kBAAkB,CAAC,KAAyB;QAC5D,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,IAAI,YAAY,QAAQ;gBAC1B,MAAM,IAAI,CAAC;IACjB,CAAC;IAJiB,2BAAkB,qBAInC,CAAA;AACH,CAAC,EAXgB,QAAQ,KAAR,QAAQ,QAWxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tiles\r\n */\r\n\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { DisclosedTileTreeSet, TileRequest } from \"./internal\";\r\n\r\n/** Represents some object that makes use of [[Tile]]s in some way - e.g., by requesting and/or displaying their contents, querying their geometry, etc.\r\n * Each [[Tile]] keeps track of its users via its [[TileUsageMarker]]. A tile with no users is eligible to be discarded view [[Tile.prune]].\r\n * Every [[Viewport]] is a tile user. It is occasionally useful to have a tile user that is **not** a viewport.\r\n * Every TileUser is identified by an integer Id that is unique among all extant TileUsers. This Id **must** be obtained via [[TileUser.generateId]].\r\n * Every TileUser must be registered with [[IModelApp.tileAdmin]] before use via [[TileAdmin.registerUser]] and unregistered via [[TileAdmin.forgetUser]] after\r\n * it ceases using tiles.\r\n * @public\r\n */\r\nexport interface TileUser {\r\n  /** A unique integer identifying this user amongst all extant users. This Id **must** be obtained via [[TIleUser.generateId]]. */\r\n  readonly tileUserId: number;\r\n  /** The iModel with which the user is associated. */\r\n  readonly iModel: IModelConnection;\r\n  /** Disclose all tile trees currently in use by this user. Any tile tree not disclosed by any user becomes eligible for garbage collection. */\r\n  readonly discloseTileTrees: (trees: DisclosedTileTreeSet) => void;\r\n  /** An optional function invoked when a [[TileRequest]] associated with a [[Tile]] in use by this user changes state - e.g., when the request completes, fails, or\r\n   * is cancelled. For example, a [[Viewport]] responds to such events by invalidating its scene.\r\n   */\r\n  readonly onRequestStateChanged?: (req: TileRequest) => void;\r\n}\r\n\r\nlet nextUserId = 1;\r\n\r\n/** @public */\r\nexport namespace TileUser {\r\n  export function generateId(): number {\r\n    return nextUserId++;\r\n  }\r\n\r\n  /** Iterate the subset of `users` that are [[Viewport]]s. */\r\n  export function * viewportsFromUsers(users: Iterable<TileUser>): Iterable<Viewport> {\r\n    for (const user of users)\r\n      if (user instanceof Viewport)\r\n        yield user;\r\n  }\r\n}\r\n"]}

package/lib/esm/tile/TileUserSet.d.ts

@@ -0,0 +1,28 @@
+/** @packageDocumentation
+ * @module Utils
+ */
+import { ReadonlySortedArray } from "@itwin/core-bentley";
+import { TileUser } from "./internal";
+/** An immutable set of [[TileUser]]s wherein uniqueness is determined by each TileUser's unique integer identifier.
+ * @see [[UniqueTileUserSets]].
+ * @internal
+ */
+export declare class ReadonlyTileUserSet extends ReadonlySortedArray<TileUser> {
+    constructor(user?: TileUser);
+}
+/** Maintains a set of [[TileUserSets]] designed to minimize duplication.
+ * For example, the tile request scheduler needs to associate with each [[TileRequest]] the set of [[TileUser]]s awaiting the request's response.
+ * Using UniqueTileUserSets ensures all tiles requested by the same user use the same TileUserSet object.
+ * Additionally, whenever a user is unregistered there is no need to track down every associated tile request - the user can just be removed from the TileUserSets managed by this object.
+ * The TileUserSets managed by this object should be treated as immutable - "adding" a user to an existing set should be done using [[getTileUserSet]].
+ * @internal
+ */
+export declare class UniqueTileUserSets {
+    private readonly _sets;
+    getTileUserSet(user: TileUser, users?: ReadonlyTileUserSet): ReadonlyTileUserSet;
+    clearAll(): void;
+    clear(): void;
+    remove(user: TileUser): void;
+    static get emptySet(): ReadonlyTileUserSet;
+}
+//# sourceMappingURL=TileUserSet.d.ts.map

package/lib/esm/tile/TileUserSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileUserSet.d.ts","sourceRoot":"","sources":["../../../src/tile/TileUserSet.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAe,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;gBACjD,IAAI,CAAC,EAAE,QAAQ;CAKnC;AAwFD;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwB;IAEvC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAIhF,QAAQ,IAAI,IAAI;IAIhB,KAAK,IAAI,IAAI;IAIb,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAInC,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;CACF"}