@itwin/core-frontend 3.1.0-dev.7 → 3.2.0-dev.1

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

@@ -0,0 +1,80 @@
+/** @packageDocumentation
+ * @module Tiles
+ */
+import { Polyface, Range3d, Transform } from "@itwin/core-geometry";
+import { Tile, TileTreeReference, TileUser } from "./internal";
+/** Enumerates the statuses returned by [[TileGeometryCollector.collectTile]].
+ * - "accept": The tile's geometry should be collected.
+ * - "reject": The tile's geometry (and that of all of its child tiles) should be omitted.
+ * - "continue": The tile's geometry should be omitted, but that of its child tiles should be evaluated for collection.
+ * @beta
+ */
+export declare type CollectTileStatus = "accept" | "reject" | "continue";
+/** Options for creating a [[TileGeometryCollector]].
+ * @beta
+ */
+export interface TileGeometryCollectorOptions {
+    /** The chord tolerance in meters describing the minimum level of detail desired of the tile geometry. */
+    chordTolerance: number;
+    /** The volume in which to collect tiles. Geometry of tiles that do not intersect this volume will not be collected. */
+    range: Range3d;
+    /** The [[TileUser]] that will make use of the tiles. */
+    user: TileUser;
+    /** An optional transform to be applied to the tile ranges before testing intersection with [[range]]. Typically this is obtained from [[TileTree.iModelTransform]]. */
+    transform?: Transform;
+}
+/** Collects geoemtry from a [[GeometryTileTreeReference]] within a specified volume at a specified level of detail.
+ * Subclasses can refine the collection criterion.
+ * The tile geometry is obtained asynchronously, so successive collections over multiple frames may be required before all of the geometry
+ * is collected.
+ * @beta
+ */
+export declare class TileGeometryCollector {
+    /** The list of accumulated polyfaces, populated during [[GeometryTileTreeReference.collectTileGeometry]].
+     * The polyfaces belong to the [[Tile]]s - they should not be modified.
+     * If [[isAllGeometryLoaded]] is `false`, then this list is incomplete - another geometry collection should be performed with a new collector on a subsequent frame.
+     */
+    readonly polyfaces: Polyface[];
+    private readonly _missing;
+    private _loading;
+    /** The options used to construct this collector. */
+    protected readonly _options: TileGeometryCollectorOptions;
+    /** Create a new collector. */
+    constructor(options: TileGeometryCollectorOptions);
+    /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeoemtry]] to indicate that further loading is required before
+     * the collection can be completed.
+     * This will cause [[isAllGeometryLoaded]] to return `false`.
+     */
+    markLoading(): void;
+    /** Enqueues requests to obtain the content of any tiles whose content is required to complete the geometry collection.
+     * @see [[isAllGeometryLoaded]] to determine if geometry collection is complete.
+     */
+    requestMissingTiles(): void;
+    /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeometry]] to indicate that the specified tile's content must be loaded
+     * before geometry collection can be completed.
+     * This will cause [[isAllGeometryLoaded]] to return `false`.
+     */
+    addMissingTile(tile: Tile): void;
+    /** Returns true if [[polyfaces]] has been fully populated with all the geometry satisfying this collector's criteria.
+     * If it returns false, another collection using a new collector should be performed on a subsequent frame to load more geometry.
+     */
+    get isAllGeometryLoaded(): boolean;
+    /** Determine whether to collect the specified tile's geometry, reject it, or to evaluate the geometry of its child tiles for collection.
+     * This base implementation makes that determination based on the collector's range and chord tolerance. Subclasses should typically call `super.collectTile` and, if
+     * it returns "accept" or "continue", apply their own criteria to the tile.
+     */
+    collectTile(tile: Tile): CollectTileStatus;
+}
+/** A [[TileTreeReference]] that can supply geometry in the form of [Polyface]($core-geometry)s from [[Tile]]s belonging to its [[TileTree]] and satisfying the criteria defined
+ * by a [[TileGeometryCollector]].
+ * Use [[TileTreeReference.createGeometryTreeReference]] to obtain a GeometryTileTreeReference from an existing TileTreeReference.
+ * @beta
+ */
+export interface GeometryTileTreeReference extends TileTreeReference {
+    /** Populate [[TileGeometryCollector.polyfaces]] with geometry satisfying `collector`'s criteria.
+     * Because tile geometry is obtained asynchronously, successive collections over multiple frames may be required before the list of polyfaces is fully populated.
+     * @see [[TileGeometryCollector.isAllGeometryLoaded]] to determine if the list of polyfaces is fully populated.
+     */
+    collectTileGeometry: (collector: TileGeometryCollector) => void;
+}
+//# sourceMappingURL=TileGeometryCollector.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileGeometryCollector.d.ts","sourceRoot":"","sources":["../../../src/tile/TileGeometryCollector.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EACL,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAClC,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,oBAAY,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,yGAAyG;IACzG,cAAc,EAAE,MAAM,CAAC;IACvB,uHAAuH;IACvH,KAAK,EAAE,OAAO,CAAC;IACf,wDAAwD;IACxD,IAAI,EAAE,QAAQ,CAAC;IACf,uKAAuK;IACvK,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB;IAChC;;;OAGG;IACH,SAAgB,SAAS,EAAE,QAAQ,EAAE,CAAM;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAS;IACzB,oDAAoD;IACpD,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,4BAA4B,CAAC;IAE1D,8BAA8B;gBACX,OAAO,EAAE,4BAA4B;IAIxD;;;OAGG;IACI,WAAW,IAAI,IAAI;IAI1B;;OAEG;IACI,mBAAmB,IAAI,IAAI;IAIlC;;;OAGG;IACI,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIvC;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED;;;OAGG;IACI,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,iBAAiB;CAWlD;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE;;;OAGG;IACH,mBAAmB,EAAE,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACjE"}

package/lib/esm/tile/TileGeometryCollector.js

@@ -0,0 +1,67 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { IModelApp } from "../IModelApp";
+/** Collects geoemtry from a [[GeometryTileTreeReference]] within a specified volume at a specified level of detail.
+ * Subclasses can refine the collection criterion.
+ * The tile geometry is obtained asynchronously, so successive collections over multiple frames may be required before all of the geometry
+ * is collected.
+ * @beta
+ */
+export class TileGeometryCollector {
+    /** Create a new collector. */
+    constructor(options) {
+        /** The list of accumulated polyfaces, populated during [[GeometryTileTreeReference.collectTileGeometry]].
+         * The polyfaces belong to the [[Tile]]s - they should not be modified.
+         * If [[isAllGeometryLoaded]] is `false`, then this list is incomplete - another geometry collection should be performed with a new collector on a subsequent frame.
+         */
+        this.polyfaces = [];
+        this._missing = new Set();
+        this._loading = false;
+        this._options = options;
+    }
+    /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeoemtry]] to indicate that further loading is required before
+     * the collection can be completed.
+     * This will cause [[isAllGeometryLoaded]] to return `false`.
+     */
+    markLoading() {
+        this._loading = true;
+    }
+    /** Enqueues requests to obtain the content of any tiles whose content is required to complete the geometry collection.
+     * @see [[isAllGeometryLoaded]] to determine if geometry collection is complete.
+     */
+    requestMissingTiles() {
+        IModelApp.tileAdmin.requestTiles(this._options.user, this._missing);
+    }
+    /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeometry]] to indicate that the specified tile's content must be loaded
+     * before geometry collection can be completed.
+     * This will cause [[isAllGeometryLoaded]] to return `false`.
+     */
+    addMissingTile(tile) {
+        this._missing.add(tile);
+    }
+    /** Returns true if [[polyfaces]] has been fully populated with all the geometry satisfying this collector's criteria.
+     * If it returns false, another collection using a new collector should be performed on a subsequent frame to load more geometry.
+     */
+    get isAllGeometryLoaded() {
+        return !this._loading && this._missing.size === 0;
+    }
+    /** Determine whether to collect the specified tile's geometry, reject it, or to evaluate the geometry of its child tiles for collection.
+     * This base implementation makes that determination based on the collector's range and chord tolerance. Subclasses should typically call `super.collectTile` and, if
+     * it returns "accept" or "continue", apply their own criteria to the tile.
+     */
+    collectTile(tile) {
+        const range = this._options.transform ? this._options.transform.multiplyRange(tile.range) : tile.range;
+        if (!range.intersectsRange(this._options.range))
+            return "reject";
+        if (tile.maximumSize === 0 || !tile.isDisplayable)
+            return "continue";
+        const tolerance = tile.radius / tile.maximumSize;
+        return tolerance < this._options.chordTolerance ? "accept" : "continue";
+    }
+}
+//# sourceMappingURL=TileGeometryCollector.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TileGeometryCollector.js","sourceRoot":"","sources":["../../../src/tile/TileGeometryCollector.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AA2BzC;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAWhC,8BAA8B;IAC9B,YAAmB,OAAqC;QAXxD;;;WAGG;QACa,cAAS,GAAe,EAAE,CAAC;QAC1B,aAAQ,GAAG,IAAI,GAAG,EAAQ,CAAC;QACpC,aAAQ,GAAG,KAAK,CAAC;QAMvB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,mBAAmB;QACxB,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,IAAU;QAC9B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,IAAU;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QACvG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC7C,OAAO,QAAQ,CAAC;QAElB,IAAI,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa;YAC/C,OAAO,UAAU,CAAC;QAEpB,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC;QACjD,OAAO,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC;IAC1E,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 { Polyface, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport {\r\n  Tile, TileTreeReference, TileUser,\r\n} from \"./internal\";\r\n\r\n/** Enumerates the statuses returned by [[TileGeometryCollector.collectTile]].\r\n * - \"accept\": The tile's geometry should be collected.\r\n * - \"reject\": The tile's geometry (and that of all of its child tiles) should be omitted.\r\n * - \"continue\": The tile's geometry should be omitted, but that of its child tiles should be evaluated for collection.\r\n * @beta\r\n */\r\nexport type CollectTileStatus = \"accept\" | \"reject\" | \"continue\";\r\n\r\n/** Options for creating a [[TileGeometryCollector]].\r\n * @beta\r\n */\r\nexport interface TileGeometryCollectorOptions {\r\n  /** The chord tolerance in meters describing the minimum level of detail desired of the tile geometry. */\r\n  chordTolerance: number;\r\n  /** The volume in which to collect tiles. Geometry of tiles that do not intersect this volume will not be collected. */\r\n  range: Range3d;\r\n  /** The [[TileUser]] that will make use of the tiles. */\r\n  user: TileUser;\r\n  /** An optional transform to be applied to the tile ranges before testing intersection with [[range]]. Typically this is obtained from [[TileTree.iModelTransform]]. */\r\n  transform?: Transform;\r\n}\r\n\r\n/** Collects geoemtry from a [[GeometryTileTreeReference]] within a specified volume at a specified level of detail.\r\n * Subclasses can refine the collection criterion.\r\n * The tile geometry is obtained asynchronously, so successive collections over multiple frames may be required before all of the geometry\r\n * is collected.\r\n * @beta\r\n */\r\nexport class TileGeometryCollector {\r\n  /** The list of accumulated polyfaces, populated during [[GeometryTileTreeReference.collectTileGeometry]].\r\n   * The polyfaces belong to the [[Tile]]s - they should not be modified.\r\n   * If [[isAllGeometryLoaded]] is `false`, then this list is incomplete - another geometry collection should be performed with a new collector on a subsequent frame.\r\n   */\r\n  public readonly polyfaces: Polyface[] = [];\r\n  private readonly _missing = new Set<Tile>();\r\n  private _loading = false;\r\n  /** The options used to construct this collector. */\r\n  protected readonly _options: TileGeometryCollectorOptions;\r\n\r\n  /** Create a new collector. */\r\n  public constructor(options: TileGeometryCollectorOptions) {\r\n    this._options = options;\r\n  }\r\n\r\n  /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeoemtry]] to indicate that further loading is required before\r\n   * the collection can be completed.\r\n   * This will cause [[isAllGeometryLoaded]] to return `false`.\r\n   */\r\n  public markLoading(): void {\r\n    this._loading = true;\r\n  }\r\n\r\n  /** Enqueues requests to obtain the content of any tiles whose content is required to complete the geometry collection.\r\n   * @see [[isAllGeometryLoaded]] to determine if geometry collection is complete.\r\n   */\r\n  public requestMissingTiles(): void {\r\n    IModelApp.tileAdmin.requestTiles(this._options.user, this._missing);\r\n  }\r\n\r\n  /** Allows an implementation of [[GeometryTileTreeReference.collectTileGeometry]] to indicate that the specified tile's content must be loaded\r\n   * before geometry collection can be completed.\r\n   * This will cause [[isAllGeometryLoaded]] to return `false`.\r\n   */\r\n  public addMissingTile(tile: Tile): void {\r\n    this._missing.add(tile);\r\n  }\r\n\r\n  /** Returns true if [[polyfaces]] has been fully populated with all the geometry satisfying this collector's criteria.\r\n   * If it returns false, another collection using a new collector should be performed on a subsequent frame to load more geometry.\r\n   */\r\n  public get isAllGeometryLoaded(): boolean {\r\n    return !this._loading && this._missing.size === 0;\r\n  }\r\n\r\n  /** Determine whether to collect the specified tile's geometry, reject it, or to evaluate the geometry of its child tiles for collection.\r\n   * This base implementation makes that determination based on the collector's range and chord tolerance. Subclasses should typically call `super.collectTile` and, if\r\n   * it returns \"accept\" or \"continue\", apply their own criteria to the tile.\r\n   */\r\n  public collectTile(tile: Tile): CollectTileStatus {\r\n    const range = this._options.transform ? this._options.transform.multiplyRange(tile.range) : tile.range;\r\n    if (!range.intersectsRange(this._options.range))\r\n      return \"reject\";\r\n\r\n    if (tile.maximumSize === 0 || !tile.isDisplayable)\r\n      return \"continue\";\r\n\r\n    const tolerance = tile.radius / tile.maximumSize;\r\n    return tolerance < this._options.chordTolerance ? \"accept\" : \"continue\";\r\n  }\r\n}\r\n\r\n/** A [[TileTreeReference]] that can supply geometry in the form of [Polyface]($core-geometry)s from [[Tile]]s belonging to its [[TileTree]] and satisfying the criteria defined\r\n * by a [[TileGeometryCollector]].\r\n * Use [[TileTreeReference.createGeometryTreeReference]] to obtain a GeometryTileTreeReference from an existing TileTreeReference.\r\n * @beta\r\n */\r\nexport interface GeometryTileTreeReference extends TileTreeReference {\r\n  /** Populate [[TileGeometryCollector.polyfaces]] with geometry satisfying `collector`'s criteria.\r\n   * Because tile geometry is obtained asynchronously, successive collections over multiple frames may be required before the list of polyfaces is fully populated.\r\n   * @see [[TileGeometryCollector.isAllGeometryLoaded]] to determine if the list of polyfaces is fully populated.\r\n   */\r\n  collectTileGeometry: (collector: TileGeometryCollector) => void;\r\n}\r\n"]}

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

@@ -3,8 +3,7 @@
  */
 import { ImageSource } from "@itwin/core-common";
 import { Viewport } from "../Viewport";
-import { ReadonlyViewportSet } from "../ViewportSet";
-import { Tile, TileContent, TileRequestChannel, TileTree } from "./internal";
+import { ReadonlyTileUserSet, Tile, TileContent, TileRequestChannel, TileTree, TileUser } from "./internal";
 /** Represents a pending or active request to load the contents of a [[Tile]]. The request coordinates with the [[Tile.requestContent]] to obtain the raw content and
  * [[Tile.readContent]] to convert the result into a [[RenderGraphic]]. TileRequests are created internally as needed; it is never necessary or useful for external code to create them.
  * @public
@@ -14,13 +13,17 @@ export declare class TileRequest {
     readonly tile: Tile;
     /** The channel via which the request will be executed. */
     readonly channel: TileRequestChannel;
-    /** The set of [[Viewport]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no viewport cares about it. */
-    viewports: ReadonlyViewportSet;
+    /** The set of [[TileUser]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no user cares about it.
+     * @internal
+     */
+    users: ReadonlyTileUserSet;
     private _state;
     /** Determines the order in which pending requests are pulled off the queue to become active. A tile with a lower priority value takes precedence over one with a higher value. */
     priority: number;
     /** Constructor */
-    constructor(tile: Tile, vp: Viewport);
+    constructor(tile: Tile, user: TileUser);
+    /** The set of [[Viewport]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no user cares about it. */
+    get viewports(): Iterable<Viewport>;
     /** The request's current state. */
     get state(): TileRequest.State;
     /** True if the request has been enqueued but not yet dispatched. */
@@ -29,10 +32,10 @@ export declare class TileRequest {
     get isCanceled(): boolean;
     /** The tile tree to which the requested [[Tile]] belongs. */
     get tree(): TileTree;
-    /** Indicate that the specified viewport is awaiting the result of this request.
+    /** Indicate that the specified user is awaiting the result of this request.
      * @internal
      */
-    addViewport(vp: Viewport): void;
+    addUser(user: TileUser): void;
     /** Transition the request from "queued" to "active", kicking off a series of asynchronous operations usually beginning with an http request, and -
      * if the request is not subsequently canceled - resulting in either a successfully-loaded Tile, or a failed ("not found") Tile.
      * @internal
@@ -42,9 +45,9 @@ export declare class TileRequest {
      * @internal
      */
     cancel(): void;
-    /** Invalidates the scene of each [[Viewport]] interested in this request - typically because the request succeeded, failed, or was canceled. */
+    /** Invalidates the scene of each [[TileUser]] interested in this request - typically because the request succeeded, failed, or was canceled. */
     private notify;
-    /** Invalidates the scene of each [[Viewport]] interested in this request and clears the set of interested viewports. */
+    /** Invalidates the scene of each [[TileUser]] interested in this request and clears the set of interested users. */
     private notifyAndClear;
     private setFailed;
     /** Invoked when the raw tile content becomes available, to convert it into a tile graphic. */

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

@@ -1 +1 @@
-{"version":3,"file":"TileRequest.d.ts","sourceRoot":"","sources":["../../../src/tile/TileRequest.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE7E;;;GAGG;AACH,qBAAa,WAAW;IACtB,kHAAkH;IAClH,SAAgB,IAAI,EAAE,IAAI,CAAC;IAC3B,0DAA0D;IAC1D,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAC5C,kKAAkK;IAC3J,SAAS,EAAE,mBAAmB,CAAC;IACtC,OAAO,CAAC,MAAM,CAAoB;IAClC,kLAAkL;IAC3K,QAAQ,SAAK;IAEpB,kBAAkB;gBACC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ;IAO3C,mCAAmC;IACnC,IAAW,KAAK,IAAI,WAAW,CAAC,KAAK,CAAwB;IAE7D,oEAAoE;IACpE,IAAW,QAAQ,YAAuD;IAE1E,6CAA6C;IAC7C,IAAW,UAAU,IAAI,OAAO,CAW/B;IAED,6DAA6D;IAC7D,IAAW,IAAI,IAAI,QAAQ,CAA2B;IAEtD;;OAEG;IACI,WAAW,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;IAItC;;;OAGG;IACU,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0ChE;;OAEG;IACI,MAAM,IAAI,IAAI;IAQrB,gJAAgJ;IAChJ,OAAO,CAAC,MAAM;IAId,wHAAwH;IACxH,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,SAAS;IAOjB,8FAA8F;YAChF,cAAc;CAmC7B;AAED,cAAc;AACd,yBAAiB,WAAW,CAAC;IAC3B;;;;OAIG;IACH,KAAY,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,GAAG;QAAE,OAAO,EAAE,WAAW,CAAA;KAAE,GAAG,SAAS,CAAC;IAE9G;;OAEG;IACH,KAAY,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;IAEpD;;;OAGG;IACH,KAAY,KAAK;QACf,gEAAgE;QAChE,MAAM,IAAA;QACN,qEAAqE;QACrE,UAAU,IAAA;QACV,mGAAmG;QACnG,OAAO,IAAA;QACP,0EAA0E;QAC1E,SAAS,IAAA;QACT,0GAA0G;QAC1G,MAAM,IAAA;KACP;CACF"}
+{"version":3,"file":"TileRequest.d.ts","sourceRoot":"","sources":["../../../src/tile/TileRequest.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE5G;;;GAGG;AACH,qBAAa,WAAW;IACtB,kHAAkH;IAClH,SAAgB,IAAI,EAAE,IAAI,CAAC;IAC3B,0DAA0D;IAC1D,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAC5C;;OAEG;IACI,KAAK,EAAE,mBAAmB,CAAC;IAClC,OAAO,CAAC,MAAM,CAAoB;IAClC,kLAAkL;IAC3K,QAAQ,SAAK;IAEpB,kBAAkB;gBACC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ;IAO7C,8JAA8J;IAC9J,IAAW,SAAS,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAEzC;IAED,mCAAmC;IACnC,IAAW,KAAK,IAAI,WAAW,CAAC,KAAK,CAAwB;IAE7D,oEAAoE;IACpE,IAAW,QAAQ,YAAuD;IAE1E,6CAA6C;IAC7C,IAAW,UAAU,IAAI,OAAO,CAW/B;IAED,6DAA6D;IAC7D,IAAW,IAAI,IAAI,QAAQ,CAA2B;IAEtD;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAIpC;;;OAGG;IACU,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0ChE;;OAEG;IACI,MAAM,IAAI,IAAI;IAQrB,gJAAgJ;IAChJ,OAAO,CAAC,MAAM;IAOd,oHAAoH;IACpH,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,SAAS;IAOjB,8FAA8F;YAChF,cAAc;CAmC7B;AAED,cAAc;AACd,yBAAiB,WAAW,CAAC;IAC3B;;;;OAIG;IACH,KAAY,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,GAAG;QAAE,OAAO,EAAE,WAAW,CAAA;KAAE,GAAG,SAAS,CAAC;IAE9G;;OAEG;IACH,KAAY,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;IAEpD;;;OAGG;IACH,KAAY,KAAK;QACf,gEAAgE;QAChE,MAAM,IAAA;QACN,qEAAqE;QACrE,UAAU,IAAA;QACV,mGAAmG;QACnG,OAAO,IAAA;QACP,0EAA0E;QAC1E,SAAS,IAAA;QACT,0GAA0G;QAC1G,MAAM,IAAA;KACP;CACF"}

package/lib/esm/tile/TileRequest.js

@@ -8,19 +8,24 @@
 import { assert, base64StringToUint8Array, IModelStatus } from "@itwin/core-bentley";
 import { ImageSource } from "@itwin/core-common";
 import { IModelApp } from "../IModelApp";
+import { TileUser } from "./internal";
 /** Represents a pending or active request to load the contents of a [[Tile]]. The request coordinates with the [[Tile.requestContent]] to obtain the raw content and
  * [[Tile.readContent]] to convert the result into a [[RenderGraphic]]. TileRequests are created internally as needed; it is never necessary or useful for external code to create them.
  * @public
  */
 export class TileRequest {
     /** Constructor */
-    constructor(tile, vp) {
+    constructor(tile, user) {
         /** Determines the order in which pending requests are pulled off the queue to become active. A tile with a lower priority value takes precedence over one with a higher value. */
         this.priority = 0;
         this._state = TileRequest.State.Queued;
         this.tile = tile;
         this.channel = tile.channel;
-        this.viewports = IModelApp.tileAdmin.getViewportSetForRequest(vp);
+        this.users = IModelApp.tileAdmin.getTileUserSetForRequest(user);
+    }
+    /** The set of [[Viewport]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no user cares about it. */
+    get viewports() {
+        return TileUser.viewportsFromUsers(this.users);
     }
     /** The request's current state. */
     get state() { return this._state; }
@@ -34,16 +39,16 @@ export class TileRequest {
         // After we've received the raw tile data, always finish processing it - otherwise tile may end up in limbo (and producing tile content should be faster than re-requesting raw data).
         if (TileRequest.State.Loading === this._state)
             return false;
-        // If no viewport cares about this tile any more, we're canceled.
-        return this.viewports.isEmpty;
+        // If no user cares about this tile any more, we're canceled.
+        return this.users.isEmpty;
     }
     /** The tile tree to which the requested [[Tile]] belongs. */
     get tree() { return this.tile.tree; }
-    /** Indicate that the specified viewport is awaiting the result of this request.
+    /** Indicate that the specified user is awaiting the result of this request.
      * @internal
      */
-    addViewport(vp) {
-        this.viewports = IModelApp.tileAdmin.getViewportSetForRequest(vp, this.viewports);
+    addUser(user) {
+        this.users = IModelApp.tileAdmin.getTileUserSetForRequest(user, this.users);
     }
     /** Transition the request from "queued" to "active", kicking off a series of asynchronous operations usually beginning with an http request, and -
      * if the request is not subsequently canceled - resulting in either a successfully-loaded Tile, or a failed ("not found") Tile.
@@ -95,14 +100,17 @@ export class TileRequest {
             this.channel.onActiveRequestCanceled(this);
         this._state = TileRequest.State.Failed;
     }
-    /** Invalidates the scene of each [[Viewport]] interested in this request - typically because the request succeeded, failed, or was canceled. */
+    /** Invalidates the scene of each [[TileUser]] interested in this request - typically because the request succeeded, failed, or was canceled. */
     notify() {
-        this.viewports.forEach((vp) => vp.invalidateScene());
+        this.users.forEach((user) => {
+            if (user.onRequestStateChanged)
+                user.onRequestStateChanged(this);
+        });
     }
-    /** Invalidates the scene of each [[Viewport]] interested in this request and clears the set of interested viewports. */
+    /** Invalidates the scene of each [[TileUser]] interested in this request and clears the set of interested users. */
     notifyAndClear() {
         this.notify();
-        this.viewports = IModelApp.tileAdmin.emptyViewportSet;
+        this.users = IModelApp.tileAdmin.emptyTileUserSet;
         this.tile.request = undefined;
     }
     setFailed() {

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

@@ -1 +1 @@
-{"version":3,"file":"TileRequest.js","sourceRoot":"","sources":["../../../src/tile/TileRequest.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAKzC;;;GAGG;AACH,MAAM,OAAO,WAAW;IAWtB,kBAAkB;IAClB,YAAmB,IAAU,EAAE,EAAY;QAJ3C,kLAAkL;QAC3K,aAAQ,GAAG,CAAC,CAAC;QAIlB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,mCAAmC;IACnC,IAAW,KAAK,KAAwB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7D,oEAAoE;IACpE,IAAW,QAAQ,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1E,6CAA6C;IAC7C,IAAW,UAAU;QACnB,2CAA2C;QAC3C,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU;YACnC,OAAO,IAAI,CAAC;QAEd,sLAAsL;QACtL,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,MAAM;YAC3C,OAAO,KAAK,CAAC;QAEf,iEAAiE;QACjE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,6DAA6D;IAC7D,IAAW,IAAI,KAAe,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACI,WAAW,CAAC,EAAY;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,wBAAwB,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACpF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CAAC,cAA0B;QAC9C,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;QAC3C,IAAI,QAAQ,CAAC;QACb,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI;YACF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/E,WAAW,GAAG,IAAI,CAAC;YAEnB,sDAAsD;YACtD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;SACzC;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC,aAAa,EAAE;gBACrE,sEAAsE;gBACtE,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;gBACvC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;aAC9B;iBAAM;gBACL,gCAAgC;gBAChC,IAAI,CAAC,SAAS,EAAE,CAAC;aAClB;SACF;QAED,qDAAqD;QACrD,cAAc,EAAE,CAAC;QAEjB,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU;YACjC,OAAO;QAET,IAAI,SAAS,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YAC5D,2GAA2G;YAC3G,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACvC,OAAO;SACR;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM;QACX,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,WAAW,CAAC,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM;YAC9C,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;IACzC,CAAC;IAED,gJAAgJ;IACxI,MAAM;QACZ,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,wHAAwH;IAChH,cAAc;QACpB,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAChC,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IAC/B,CAAC;IAED,8FAA8F;IACtF,KAAK,CAAC,cAAc,CAAC,QAA8B;QACzD,IAAI,OAAgC,CAAC;QACrC,IAAI,IAA0C,CAAC;QAC/C,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,IAAI,OAAO,QAAQ,KAAK,QAAQ;gBAC9B,IAAI,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;iBACvC,IAAI,QAAQ,YAAY,UAAU,IAAI,QAAQ,YAAY,WAAW;gBACxE,IAAI,GAAG,QAAQ,CAAC;iBACb,IAAI,QAAQ,YAAY,WAAW;gBACtC,IAAI,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC;iBAC7B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,CAAC,OAAO;gBACrE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;SAC9B;QAED,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE;YACrB,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO;SACR;QAED,IAAI;YACF,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBAC3B,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3F,IAAI,IAAI,CAAC,UAAU;oBACjB,OAAO;aACV;YAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACnD;QAAC,OAAO,IAAI,EAAE;YACb,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,cAAc;AACd,WAAiB,WAAW;IAa1B;;;OAGG;IACH,IAAY,KAWX;IAXD,WAAY,KAAK;QACf,gEAAgE;QAChE,qCAAM,CAAA;QACN,qEAAqE;QACrE,6CAAU,CAAA;QACV,mGAAmG;QACnG,uCAAO,CAAA;QACP,0EAA0E;QAC1E,2CAAS,CAAA;QACT,0GAA0G;QAC1G,qCAAM,CAAA;IACR,CAAC,EAXW,KAAK,GAAL,iBAAK,KAAL,iBAAK,QAWhB;AACH,CAAC,EA7BgB,WAAW,KAAX,WAAW,QA6B3B","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, base64StringToUint8Array, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { ImageSource } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { ReadonlyViewportSet } from \"../ViewportSet\";\r\nimport { Tile, TileContent, TileRequestChannel, TileTree } from \"./internal\";\r\n\r\n/** Represents a pending or active request to load the contents of a [[Tile]]. The request coordinates with the [[Tile.requestContent]] to obtain the raw content and\r\n * [[Tile.readContent]] to convert the result into a [[RenderGraphic]]. TileRequests are created internally as needed; it is never necessary or useful for external code to create them.\r\n * @public\r\n */\r\nexport class TileRequest {\r\n  /** The requested tile. While the request is pending or active, `tile.request` points back to this TileRequest. */\r\n  public readonly tile: Tile;\r\n  /** The channel via which the request will be executed. */\r\n  public readonly channel: TileRequestChannel;\r\n  /** The set of [[Viewport]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no viewport cares about it. */\r\n  public viewports: ReadonlyViewportSet;\r\n  private _state: TileRequest.State;\r\n  /** Determines the order in which pending requests are pulled off the queue to become active. A tile with a lower priority value takes precedence over one with a higher value. */\r\n  public priority = 0;\r\n\r\n  /** Constructor */\r\n  public constructor(tile: Tile, vp: Viewport) {\r\n    this._state = TileRequest.State.Queued;\r\n    this.tile = tile;\r\n    this.channel = tile.channel;\r\n    this.viewports = IModelApp.tileAdmin.getViewportSetForRequest(vp);\r\n  }\r\n\r\n  /** The request's current state. */\r\n  public get state(): TileRequest.State { return this._state; }\r\n\r\n  /** True if the request has been enqueued but not yet dispatched. */\r\n  public get isQueued() { return TileRequest.State.Queued === this._state; }\r\n\r\n  /** True if the request has been canceled. */\r\n  public get isCanceled(): boolean {\r\n    // If iModel was closed, cancel immediately\r\n    if (this.tile.iModel.tiles.isDisposed)\r\n      return true;\r\n\r\n    // After we've received the raw tile data, always finish processing it - otherwise tile may end up in limbo (and producing tile content should be faster than re-requesting raw data).\r\n    if (TileRequest.State.Loading === this._state)\r\n      return false;\r\n\r\n    // If no viewport cares about this tile any more, we're canceled.\r\n    return this.viewports.isEmpty;\r\n  }\r\n\r\n  /** The tile tree to which the requested [[Tile]] belongs. */\r\n  public get tree(): TileTree { return this.tile.tree; }\r\n\r\n  /** Indicate that the specified viewport is awaiting the result of this request.\r\n   * @internal\r\n   */\r\n  public addViewport(vp: Viewport): void {\r\n    this.viewports = IModelApp.tileAdmin.getViewportSetForRequest(vp, this.viewports);\r\n  }\r\n\r\n  /** Transition the request from \"queued\" to \"active\", kicking off a series of asynchronous operations usually beginning with an http request, and -\r\n   * if the request is not subsequently canceled - resulting in either a successfully-loaded Tile, or a failed (\"not found\") Tile.\r\n   * @internal\r\n   */\r\n  public async dispatch(onHttpResponse: () => void): Promise<void> {\r\n    if (this.isCanceled)\r\n      return;\r\n\r\n    assert(this._state === TileRequest.State.Queued);\r\n    this._state = TileRequest.State.Dispatched;\r\n    let response;\r\n    let gotResponse = false;\r\n    try {\r\n      response = await this.channel.requestContent(this.tile, () => this.isCanceled);\r\n      gotResponse = true;\r\n\r\n      // Set this now, so our `isCanceled` check can see it.\r\n      this._state = TileRequest.State.Loading;\r\n    } catch (err: any) {\r\n      if (err.errorNumber && err.errorNumber === IModelStatus.ServerTimeout) {\r\n        // Invalidate scene - if tile is re-selected, it will be re-requested.\r\n        this.notifyAndClear();\r\n        this._state = TileRequest.State.Failed;\r\n        this.channel.recordTimeout();\r\n      } else {\r\n        // Unknown error - not retryable\r\n        this.setFailed();\r\n      }\r\n    }\r\n\r\n    // Notify caller that we have finished http activity.\r\n    onHttpResponse();\r\n\r\n    if (!gotResponse || this.isCanceled)\r\n      return;\r\n\r\n    if (undefined === response && this.channel.onNoContent(this)) {\r\n      // Invalidate scene - if tile is re-selected, it will be re-requested - presumably via a different channel.\r\n      this.notifyAndClear();\r\n      this._state = TileRequest.State.Failed;\r\n      return;\r\n    }\r\n\r\n    return this.handleResponse(response);\r\n  }\r\n\r\n  /** Cancels this request. This leaves the associated Tile's state untouched.\r\n   * @internal\r\n   */\r\n  public cancel(): void {\r\n    this.notifyAndClear();\r\n    if (TileRequest.State.Dispatched === this._state)\r\n      this.channel.onActiveRequestCanceled(this);\r\n\r\n    this._state = TileRequest.State.Failed;\r\n  }\r\n\r\n  /** Invalidates the scene of each [[Viewport]] interested in this request - typically because the request succeeded, failed, or was canceled. */\r\n  private notify(): void {\r\n    this.viewports.forEach((vp) => vp.invalidateScene());\r\n  }\r\n\r\n  /** Invalidates the scene of each [[Viewport]] interested in this request and clears the set of interested viewports. */\r\n  private notifyAndClear(): void {\r\n    this.notify();\r\n    this.viewports = IModelApp.tileAdmin.emptyViewportSet;\r\n    this.tile.request = undefined;\r\n  }\r\n\r\n  private setFailed() {\r\n    this.notifyAndClear();\r\n    this._state = TileRequest.State.Failed;\r\n    this.tile.setNotFound();\r\n    this.channel.recordFailure();\r\n  }\r\n\r\n  /** Invoked when the raw tile content becomes available, to convert it into a tile graphic. */\r\n  private async handleResponse(response: TileRequest.Response): Promise<void> {\r\n    let content: TileContent | undefined;\r\n    let data: TileRequest.ResponseData | undefined;\r\n    if (undefined !== response) {\r\n      if (typeof response === \"string\")\r\n        data = base64StringToUint8Array(response);\r\n      else if (response instanceof Uint8Array || response instanceof ImageSource)\r\n        data = response;\r\n      else if (response instanceof ArrayBuffer)\r\n        data = new Uint8Array(response);\r\n      else if (typeof response === \"object\" && undefined !== response.content)\r\n        content = response.content;\r\n    }\r\n\r\n    if (!content && !data) {\r\n      this.setFailed();\r\n      return;\r\n    }\r\n\r\n    try {\r\n      if (!content) {\r\n        assert(undefined !== data);\r\n        content = await this.tile.readContent(data, IModelApp.renderSystem, () => this.isCanceled);\r\n        if (this.isCanceled)\r\n          return;\r\n      }\r\n\r\n      this._state = TileRequest.State.Completed;\r\n      this.tile.setContent(content);\r\n      this.notifyAndClear();\r\n      this.channel.recordCompletion(this.tile, content);\r\n    } catch (_err) {\r\n      this.setFailed();\r\n    }\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TileRequest { // eslint-disable-line no-redeclare\r\n  /** The type of a raw response to a request for tile content. Processed upon receipt into a [[TileRequest.Response]] type.\r\n   * [[Tile.requestContent]] produces a response of this type; it is then converted to a [[Tile.ResponseData]] from which [[Tile.readContent]]\r\n   * can produce a [[RenderGraphic]].\r\n   * @public\r\n   */\r\n  export type Response = Uint8Array | ArrayBuffer | string | ImageSource | { content: TileContent } | undefined;\r\n\r\n  /** The input to [[Tile.readContent]], to be converted into a [[RenderGraphic]].\r\n   * @public\r\n   */\r\n  export type ResponseData = Uint8Array | ImageSource;\r\n\r\n  /** The states through which a [[TileRequest]] proceeds. During the first 3 states, the [[Tile]]'s `request` member is defined,\r\n   * and its [[Tile.LoadStatus]] is computed based on the state of its request.\r\n   *@ public\r\n   */\r\n  export enum State {\r\n    /** Initial state. Request is pending but not yet dispatched. */\r\n    Queued,\r\n    /** Follows `Queued` when request begins to be actively processed. */\r\n    Dispatched,\r\n    /** Follows `Dispatched` when the response to the request is being converted into tile graphics. */\r\n    Loading,\r\n    /** Follows `Loading` when tile graphic has successfully been produced. */\r\n    Completed,\r\n    /** Follows any state in which an error prevents progression, or during which the request was canceled. */\r\n    Failed,\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TileRequest.js","sourceRoot":"","sources":["../../../src/tile/TileRequest.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAwE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE5G;;;GAGG;AACH,MAAM,OAAO,WAAW;IAatB,kBAAkB;IAClB,YAAmB,IAAU,EAAE,IAAc;QAJ7C,kLAAkL;QAC3K,aAAQ,GAAG,CAAC,CAAC;QAIlB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,8JAA8J;IAC9J,IAAW,SAAS;QAClB,OAAO,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,mCAAmC;IACnC,IAAW,KAAK,KAAwB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7D,oEAAoE;IACpE,IAAW,QAAQ,KAAK,OAAO,WAAW,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1E,6CAA6C;IAC7C,IAAW,UAAU;QACnB,2CAA2C;QAC3C,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU;YACnC,OAAO,IAAI,CAAC;QAEd,sLAAsL;QACtL,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,MAAM;YAC3C,OAAO,KAAK,CAAC;QAEf,6DAA6D;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,6DAA6D;IAC7D,IAAW,IAAI,KAAe,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACI,OAAO,CAAC,IAAc;QAC3B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CAAC,cAA0B;QAC9C,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC;QAC3C,IAAI,QAAQ,CAAC;QACb,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI;YACF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/E,WAAW,GAAG,IAAI,CAAC;YAEnB,sDAAsD;YACtD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;SACzC;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC,aAAa,EAAE;gBACrE,sEAAsE;gBACtE,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;gBACvC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;aAC9B;iBAAM;gBACL,gCAAgC;gBAChC,IAAI,CAAC,SAAS,EAAE,CAAC;aAClB;SACF;QAED,qDAAqD;QACrD,cAAc,EAAE,CAAC;QAEjB,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU;YACjC,OAAO;QAET,IAAI,SAAS,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YAC5D,2GAA2G;YAC3G,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACvC,OAAO;SACR;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM;QACX,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,WAAW,CAAC,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM;YAC9C,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;IACzC,CAAC;IAED,gJAAgJ;IACxI,MAAM;QACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,IAAI,IAAI,CAAC,qBAAqB;gBAC5B,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oHAAoH;IAC5G,cAAc;QACpB,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAChC,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IAC/B,CAAC;IAED,8FAA8F;IACtF,KAAK,CAAC,cAAc,CAAC,QAA8B;QACzD,IAAI,OAAgC,CAAC;QACrC,IAAI,IAA0C,CAAC;QAC/C,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,IAAI,OAAO,QAAQ,KAAK,QAAQ;gBAC9B,IAAI,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;iBACvC,IAAI,QAAQ,YAAY,UAAU,IAAI,QAAQ,YAAY,WAAW;gBACxE,IAAI,GAAG,QAAQ,CAAC;iBACb,IAAI,QAAQ,YAAY,WAAW;gBACtC,IAAI,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC;iBAC7B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,SAAS,KAAK,QAAQ,CAAC,OAAO;gBACrE,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;SAC9B;QAED,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE;YACrB,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO;SACR;QAED,IAAI;YACF,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBAC3B,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3F,IAAI,IAAI,CAAC,UAAU;oBACjB,OAAO;aACV;YAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACnD;QAAC,OAAO,IAAI,EAAE;YACb,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;IACH,CAAC;CACF;AAED,cAAc;AACd,WAAiB,WAAW;IAa1B;;;OAGG;IACH,IAAY,KAWX;IAXD,WAAY,KAAK;QACf,gEAAgE;QAChE,qCAAM,CAAA;QACN,qEAAqE;QACrE,6CAAU,CAAA;QACV,mGAAmG;QACnG,uCAAO,CAAA;QACP,0EAA0E;QAC1E,2CAAS,CAAA;QACT,0GAA0G;QAC1G,qCAAM,CAAA;IACR,CAAC,EAXW,KAAK,GAAL,iBAAK,KAAL,iBAAK,QAWhB;AACH,CAAC,EA7BgB,WAAW,KAAX,WAAW,QA6B3B","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, base64StringToUint8Array, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { ImageSource } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"../IModelApp\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { ReadonlyTileUserSet, Tile, TileContent, TileRequestChannel, TileTree, TileUser } from \"./internal\";\r\n\r\n/** Represents a pending or active request to load the contents of a [[Tile]]. The request coordinates with the [[Tile.requestContent]] to obtain the raw content and\r\n * [[Tile.readContent]] to convert the result into a [[RenderGraphic]]. TileRequests are created internally as needed; it is never necessary or useful for external code to create them.\r\n * @public\r\n */\r\nexport class TileRequest {\r\n  /** The requested tile. While the request is pending or active, `tile.request` points back to this TileRequest. */\r\n  public readonly tile: Tile;\r\n  /** The channel via which the request will be executed. */\r\n  public readonly channel: TileRequestChannel;\r\n  /** The set of [[TileUser]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no user cares about it.\r\n   * @internal\r\n   */\r\n  public users: ReadonlyTileUserSet;\r\n  private _state: TileRequest.State;\r\n  /** Determines the order in which pending requests are pulled off the queue to become active. A tile with a lower priority value takes precedence over one with a higher value. */\r\n  public priority = 0;\r\n\r\n  /** Constructor */\r\n  public constructor(tile: Tile, user: TileUser) {\r\n    this._state = TileRequest.State.Queued;\r\n    this.tile = tile;\r\n    this.channel = tile.channel;\r\n    this.users = IModelApp.tileAdmin.getTileUserSetForRequest(user);\r\n  }\r\n\r\n  /** The set of [[Viewport]]s that are awaiting the result of this request. When this becomes empty, the request is canceled because no user cares about it. */\r\n  public get viewports(): Iterable<Viewport> {\r\n    return TileUser.viewportsFromUsers(this.users);\r\n  }\r\n\r\n  /** The request's current state. */\r\n  public get state(): TileRequest.State { return this._state; }\r\n\r\n  /** True if the request has been enqueued but not yet dispatched. */\r\n  public get isQueued() { return TileRequest.State.Queued === this._state; }\r\n\r\n  /** True if the request has been canceled. */\r\n  public get isCanceled(): boolean {\r\n    // If iModel was closed, cancel immediately\r\n    if (this.tile.iModel.tiles.isDisposed)\r\n      return true;\r\n\r\n    // After we've received the raw tile data, always finish processing it - otherwise tile may end up in limbo (and producing tile content should be faster than re-requesting raw data).\r\n    if (TileRequest.State.Loading === this._state)\r\n      return false;\r\n\r\n    // If no user cares about this tile any more, we're canceled.\r\n    return this.users.isEmpty;\r\n  }\r\n\r\n  /** The tile tree to which the requested [[Tile]] belongs. */\r\n  public get tree(): TileTree { return this.tile.tree; }\r\n\r\n  /** Indicate that the specified user is awaiting the result of this request.\r\n   * @internal\r\n   */\r\n  public addUser(user: TileUser): void {\r\n    this.users = IModelApp.tileAdmin.getTileUserSetForRequest(user, this.users);\r\n  }\r\n\r\n  /** Transition the request from \"queued\" to \"active\", kicking off a series of asynchronous operations usually beginning with an http request, and -\r\n   * if the request is not subsequently canceled - resulting in either a successfully-loaded Tile, or a failed (\"not found\") Tile.\r\n   * @internal\r\n   */\r\n  public async dispatch(onHttpResponse: () => void): Promise<void> {\r\n    if (this.isCanceled)\r\n      return;\r\n\r\n    assert(this._state === TileRequest.State.Queued);\r\n    this._state = TileRequest.State.Dispatched;\r\n    let response;\r\n    let gotResponse = false;\r\n    try {\r\n      response = await this.channel.requestContent(this.tile, () => this.isCanceled);\r\n      gotResponse = true;\r\n\r\n      // Set this now, so our `isCanceled` check can see it.\r\n      this._state = TileRequest.State.Loading;\r\n    } catch (err: any) {\r\n      if (err.errorNumber && err.errorNumber === IModelStatus.ServerTimeout) {\r\n        // Invalidate scene - if tile is re-selected, it will be re-requested.\r\n        this.notifyAndClear();\r\n        this._state = TileRequest.State.Failed;\r\n        this.channel.recordTimeout();\r\n      } else {\r\n        // Unknown error - not retryable\r\n        this.setFailed();\r\n      }\r\n    }\r\n\r\n    // Notify caller that we have finished http activity.\r\n    onHttpResponse();\r\n\r\n    if (!gotResponse || this.isCanceled)\r\n      return;\r\n\r\n    if (undefined === response && this.channel.onNoContent(this)) {\r\n      // Invalidate scene - if tile is re-selected, it will be re-requested - presumably via a different channel.\r\n      this.notifyAndClear();\r\n      this._state = TileRequest.State.Failed;\r\n      return;\r\n    }\r\n\r\n    return this.handleResponse(response);\r\n  }\r\n\r\n  /** Cancels this request. This leaves the associated Tile's state untouched.\r\n   * @internal\r\n   */\r\n  public cancel(): void {\r\n    this.notifyAndClear();\r\n    if (TileRequest.State.Dispatched === this._state)\r\n      this.channel.onActiveRequestCanceled(this);\r\n\r\n    this._state = TileRequest.State.Failed;\r\n  }\r\n\r\n  /** Invalidates the scene of each [[TileUser]] interested in this request - typically because the request succeeded, failed, or was canceled. */\r\n  private notify(): void {\r\n    this.users.forEach((user) => {\r\n      if (user.onRequestStateChanged)\r\n        user.onRequestStateChanged(this);\r\n    });\r\n  }\r\n\r\n  /** Invalidates the scene of each [[TileUser]] interested in this request and clears the set of interested users. */\r\n  private notifyAndClear(): void {\r\n    this.notify();\r\n    this.users = IModelApp.tileAdmin.emptyTileUserSet;\r\n    this.tile.request = undefined;\r\n  }\r\n\r\n  private setFailed() {\r\n    this.notifyAndClear();\r\n    this._state = TileRequest.State.Failed;\r\n    this.tile.setNotFound();\r\n    this.channel.recordFailure();\r\n  }\r\n\r\n  /** Invoked when the raw tile content becomes available, to convert it into a tile graphic. */\r\n  private async handleResponse(response: TileRequest.Response): Promise<void> {\r\n    let content: TileContent | undefined;\r\n    let data: TileRequest.ResponseData | undefined;\r\n    if (undefined !== response) {\r\n      if (typeof response === \"string\")\r\n        data = base64StringToUint8Array(response);\r\n      else if (response instanceof Uint8Array || response instanceof ImageSource)\r\n        data = response;\r\n      else if (response instanceof ArrayBuffer)\r\n        data = new Uint8Array(response);\r\n      else if (typeof response === \"object\" && undefined !== response.content)\r\n        content = response.content;\r\n    }\r\n\r\n    if (!content && !data) {\r\n      this.setFailed();\r\n      return;\r\n    }\r\n\r\n    try {\r\n      if (!content) {\r\n        assert(undefined !== data);\r\n        content = await this.tile.readContent(data, IModelApp.renderSystem, () => this.isCanceled);\r\n        if (this.isCanceled)\r\n          return;\r\n      }\r\n\r\n      this._state = TileRequest.State.Completed;\r\n      this.tile.setContent(content);\r\n      this.notifyAndClear();\r\n      this.channel.recordCompletion(this.tile, content);\r\n    } catch (_err) {\r\n      this.setFailed();\r\n    }\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TileRequest { // eslint-disable-line no-redeclare\r\n  /** The type of a raw response to a request for tile content. Processed upon receipt into a [[TileRequest.Response]] type.\r\n   * [[Tile.requestContent]] produces a response of this type; it is then converted to a [[Tile.ResponseData]] from which [[Tile.readContent]]\r\n   * can produce a [[RenderGraphic]].\r\n   * @public\r\n   */\r\n  export type Response = Uint8Array | ArrayBuffer | string | ImageSource | { content: TileContent } | undefined;\r\n\r\n  /** The input to [[Tile.readContent]], to be converted into a [[RenderGraphic]].\r\n   * @public\r\n   */\r\n  export type ResponseData = Uint8Array | ImageSource;\r\n\r\n  /** The states through which a [[TileRequest]] proceeds. During the first 3 states, the [[Tile]]'s `request` member is defined,\r\n   * and its [[Tile.LoadStatus]] is computed based on the state of its request.\r\n   *@ public\r\n   */\r\n  export enum State {\r\n    /** Initial state. Request is pending but not yet dispatched. */\r\n    Queued,\r\n    /** Follows `Queued` when request begins to be actively processed. */\r\n    Dispatched,\r\n    /** Follows `Dispatched` when the response to the request is being converted into tile graphics. */\r\n    Loading,\r\n    /** Follows `Loading` when tile graphic has successfully been produced. */\r\n    Completed,\r\n    /** Follows any state in which an error prevents progression, or during which the request was canceled. */\r\n    Failed,\r\n  }\r\n}\r\n"]}

package/lib/esm/tile/TileRequestChannel.js

@@ -163,18 +163,18 @@ export class TileRequestChannel {
         this._statistics.numCanceled = 0;
         // Recompute priority of each request.
         for (const pending of this._pending)
-            pending.priority = pending.tile.computeLoadPriority(pending.viewports);
+            pending.priority = pending.tile.computeLoadPriority(pending.viewports, pending.users);
         // Sort pending requests by priority.
         this._pending.sort();
         // Cancel any previously pending requests that are no longer needed.
         for (const queued of this._previouslyPending)
-            if (queued.viewports.isEmpty)
+            if (queued.users.isEmpty)
                 this.cancel(queued);
         this._previouslyPending.clear();
         // Cancel any active requests that are no longer needed.
         // NB: Do NOT remove them from the active set until their http activity has completed.
         for (const active of this._active)
-            if (active.viewports.isEmpty)
+            if (active.users.isEmpty)
                 this.cancel(active);
         // Batch-cancel running requests.
         this.processCancellations();

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

@@ -1 +1 @@
-{"version":3,"file":"TileRequestChannel.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAI5D,MAAM,gBAAiB,SAAQ,aAA0B;IACvD;QACE,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YACrE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,4BAA4B;IAAzC;QACE,uEAAuE;QAChE,uBAAkB,GAAG,CAAC,CAAC;QAC9B,8EAA8E;QACvE,sBAAiB,GAAG,CAAC,CAAC;QAC7B,qEAAqE;QAC9D,gBAAW,GAAG,CAAC,CAAC;QACvB,kEAAkE;QAC3D,2BAAsB,GAAG,CAAC,CAAC;QAClC,+DAA+D;QACxD,wBAAmB,GAAG,CAAC,CAAC;QAC/B,kEAAkE;QAC3D,0BAAqB,GAAG,CAAC,CAAC;QACjC;;WAEG;QACI,oBAAe,GAAG,CAAC,CAAC;QAC3B;;WAEG;QACI,4BAAuB,GAAG,CAAC,CAAC;QACnC,+JAA+J;QACxJ,qBAAgB,GAAG,CAAC,CAAC;QAC5B,4EAA4E;QACrE,4BAAuB,GAAG,CAAC,CAAC;QACnC,+HAA+H;QACxH,yBAAoB,GAAG,CAAC,CAAC;IAclC,CAAC;IAZC,gBAAgB;IACT,KAAK,CAAC,KAAmC;QAC9C,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,EAAE,mCAAmC;YAChE,MAAM,GAAG,GAAG,QAA8C,CAAC;YAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,gDAAgD;gBAChD,MAAM,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACtC,KAAK,CAAC,GAAG,CAAY,IAAI,GAAG,CAAC;aAC/B;SACF;IACH,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAc7B;;;;OAIG;IACH,YAAmB,IAAY,EAAE,WAAmB;QAfpD,8CAA8C;QAC3B,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAClC,uBAAkB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAC1C,gBAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;QAYzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,GAAW;QAChC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,oFAAoF;IACpF,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,yEAAyE;IACzE,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,oFAAoF;IACpF,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,IAAI,CAAC,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,0DAA0D;IACnD,eAAe;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAU,EAAE,OAAoB;QACtD,EAAE,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC;QAC1C,IAAI,IAAI,CAAC,OAAO;YACd,EAAE,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;aAChC,IAAI,CAAC,IAAI,CAAC,aAAa;YAC1B,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAE7C,IAAI,IAAI,CAAC,eAAe;YACtB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAoB;QAChC,MAAM,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC;QAEjC,sCAAsC;QACtC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;YACjC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEzE,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErB,oEAAoE;QACpE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,kBAAkB;YAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO;gBAC1B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAEhC,wDAAwD;QACxD,sFAAsF;QACtF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO;gBAC1B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,iCAAiC;QACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,sDAAsD;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO;gBACV,MAAM;YAER,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SACxB;IACH,CAAC;IAED;;OAEG;IACI,iBAAiB;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ;YAChC,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAqB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,QAAqB,IAAU,CAAC;IAE/D;;OAEG;IACI,oBAAoB,KAAW,CAAC;IAEvC,2FAA2F;IACpF,cAAc,CAAC,OAAyB,IAAU,CAAC;IAE1D,qHAAqH;IAC9G,KAAK,CAAC,cAAc,CAAC,IAAU,EAAE,UAAyB;QAC/D,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAoB;QACrC,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,EAAE;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAoB;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,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, PriorityQueue } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Tile, TileContent, TileRequest } from \"./internal\";\r\n\r\nclass TileRequestQueue extends PriorityQueue<TileRequest> {\r\n  public constructor() {\r\n    super((lhs, rhs) => {\r\n      const diff = lhs.tile.tree.loadPriority - rhs.tile.tree.loadPriority;\r\n      return 0 !== diff ? diff : lhs.priority - rhs.priority;\r\n    });\r\n  }\r\n}\r\n\r\n/** Statistics regarding the current and cumulative state of one or more [[TileRequestChannel]]s. Useful for monitoring performance and diagnosing problems.\r\n * @see [[TileRequestChannel.statistics]] for a specific channel's statistics.\r\n * @see [[TileRequestChannels.statistics]] for statistics from all channels.\r\n * @see [[TileAdmin.statistics]] for additional statistics.\r\n * @public\r\n */\r\nexport class TileRequestChannelStatistics {\r\n  /** The number of queued requests that have not yet been dispatched. */\r\n  public numPendingRequests = 0;\r\n  /** The number of requests that have been dispatched but not yet completed. */\r\n  public numActiveRequests = 0;\r\n  /** The number of requests canceled during the most recent update. */\r\n  public numCanceled = 0;\r\n  /** The total number of completed requests during this session. */\r\n  public totalCompletedRequests = 0;\r\n  /** The total number of failed requests during this session. */\r\n  public totalFailedRequests = 0;\r\n  /** The total number of timed-out requests during this session. */\r\n  public totalTimedOutRequests = 0;\r\n  /** The total number of completed requests during this session which produced an empty tile.\r\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalUndisplayableTiles]].\r\n   */\r\n  public totalEmptyTiles = 0;\r\n  /** The total number of completed requests during this session that produced an undisplayable tile.\r\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalEmptyTiles]].\r\n   */\r\n  public totalUndisplayableTiles = 0;\r\n  /** The total number of tiles whose contents were not found in cloud storage cache and therefore resulted in a backend request to generate the tile content. */\r\n  public totalCacheMisses = 0;\r\n  /** The total number of tiles for which content requests were dispatched. */\r\n  public totalDispatchedRequests = 0;\r\n  /** The total number of tiles for which content requests were dispatched and then canceled on the backend before completion. */\r\n  public totalAbortedRequests = 0;\r\n\r\n  /** @internal */\r\n  public addTo(stats: TileRequestChannelStatistics): void {\r\n    for (const propName in this) { // eslint-disable-line guard-for-in\r\n      const key = propName as keyof TileRequestChannelStatistics;\r\n      const val = this[key];\r\n      if (typeof val === \"number\") {\r\n        // This type guard ought to suffice but doesn't.\r\n        assert(typeof stats[key] === \"number\");\r\n        (stats[key] as number) += val;\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/** A channel over which requests for tile content can be made. The channel may request content over HTTP, calls to the backend via IPC or RPC, or any other method like generating the content\r\n * on the frontend. The channel consists of a queue of pending requests and a set of \"active\" requests (dispatched and awaiting a response). Incoming requests are placed onto the queue. Requests are popped of the queue in order of priority and dispatched, until the maximum number of simultaneously-active requests is reached.\r\n * The maximum number of active requests depends on the transport mechanism. For HTTP 1.1, browsers impose a limit of 6 simultaneous connections to a given domain, so ideally each unique domain will use its own unique channel with a limit of 6 active requests. Even for requests satisfied entirely by the frontend, imposing a limit is important for throttling the amount of work done at one time, especially because as the user navigates the view, tiles that were previously requested may no longer be of interest and we shouldn't waste resources producing their content.\r\n * A channel must be registered with [[TileRequestChannels]] and must have a unique name among all registered channels.\r\n * @see [[TileRequestChannels.getForHttp]] to obtain (and register if not already registered) an HTTP-based channel.\r\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\r\n * @see [[Tile.channel]] to specify the channel to be used to request a given tile's content.\r\n * @public\r\n */\r\nexport class TileRequestChannel {\r\n  /** The channel's name. It must be unique among all registered [[TileRequestChannels]]. */\r\n  public readonly name: string;\r\n  private _concurrency: number;\r\n  /** Protected strictly for tests. @internal */\r\n  protected readonly _active = new Set<TileRequest>();\r\n  private _pending = new TileRequestQueue();\r\n  private _previouslyPending = new TileRequestQueue();\r\n  protected _statistics = new TileRequestChannelStatistics();\r\n  /** Callback invoked by recordCompletion. See IModelTileMetadataCacheChannel.\r\n   * @internal\r\n   */\r\n  public contentCallback?: (tile: Tile, content: TileContent) => void;\r\n\r\n  /** Create a new channel.\r\n   * @param name The unique name of the channel.\r\n   * @param concurrency The maximum number of requests that can be dispatched and awaiting a response at any given time. Requests beyond this maximum are enqueued for deferred dispatch.\r\n   * @see [[TileRequestChannels.getForHttp]] to create an HTTP-based channel.\r\n   */\r\n  public constructor(name: string, concurrency: number) {\r\n    this.name = name;\r\n    this._concurrency = concurrency;\r\n  }\r\n\r\n  /** The maximum number of active requests. This is generally only modified for debugging purposes.\r\n   * @note When reducing `concurrency`, the number of active requests ([[numActive]]) will only decrease to the new value after a sufficient number of dispatched requests are resolved.\r\n   */\r\n  public get concurrency(): number {\r\n    return this._concurrency;\r\n  }\r\n  public set concurrency(max: number) {\r\n    this._concurrency = max;\r\n  }\r\n\r\n  /** The number of requests that have been dispatched and are awaiting a response. */\r\n  public get numActive(): number {\r\n    return this._active.size;\r\n  }\r\n\r\n  /** The number of requests that have been enqueued for later dispatch. */\r\n  public get numPending(): number {\r\n    return this._pending.length;\r\n  }\r\n\r\n  /** The total number of requests in this channel, whether dispatched or enqueued. */\r\n  public get size(): number {\r\n    return this.numActive + this.numPending;\r\n  }\r\n\r\n  /** Statistics intended primarily for debugging. */\r\n  public get statistics(): Readonly<TileRequestChannelStatistics> {\r\n    this._statistics.numPendingRequests = this.numPending;\r\n    this._statistics.numActiveRequests = this.numActive;\r\n    return this._statistics;\r\n  }\r\n\r\n  /** Reset all of this channel's [[statistics]] to zero. */\r\n  public resetStatistics(): void {\r\n    this._statistics = new TileRequestChannelStatistics();\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] when a request times out.\r\n   * @internal\r\n   */\r\n  public recordTimeout(): void {\r\n    ++this._statistics.totalTimedOutRequests;\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] when a request fails to produce a response.\r\n   * @internal\r\n   */\r\n  public recordFailure(): void {\r\n    ++this._statistics.totalFailedRequests;\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] after a request completes.\r\n   * @internal\r\n   */\r\n  public recordCompletion(tile: Tile, content: TileContent): void {\r\n    ++this._statistics.totalCompletedRequests;\r\n    if (tile.isEmpty)\r\n      ++this._statistics.totalEmptyTiles;\r\n    else if (!tile.isDisplayable)\r\n      ++this._statistics.totalUndisplayableTiles;\r\n\r\n    if (this.contentCallback)\r\n      this.contentCallback(tile, content);\r\n  }\r\n\r\n  /** Invoked by [[TileRequestChannels.swapPending]] when [[TileAdmin]] is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public swapPending(): void {\r\n    const previouslyPending = this._pending;\r\n    this._pending = this._previouslyPending;\r\n    this._previouslyPending = previouslyPending;\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processRequests]] to enqueue a request. Ordering is ignored - the queue will be re-sorted later.\r\n   * @internal\r\n   */\r\n  public append(request: TileRequest): void {\r\n    assert(request.channel === this);\r\n    this._pending.append(request);\r\n  }\r\n\r\n  /** Invoked by [[TileRequestChannels.process]] to process the active and pending requests.\r\n   * @internal\r\n   */\r\n  public process(): void {\r\n    this._statistics.numCanceled = 0;\r\n\r\n    // Recompute priority of each request.\r\n    for (const pending of this._pending)\r\n      pending.priority = pending.tile.computeLoadPriority(pending.viewports);\r\n\r\n    // Sort pending requests by priority.\r\n    this._pending.sort();\r\n\r\n    // Cancel any previously pending requests that are no longer needed.\r\n    for (const queued of this._previouslyPending)\r\n      if (queued.viewports.isEmpty)\r\n        this.cancel(queued);\r\n\r\n    this._previouslyPending.clear();\r\n\r\n    // Cancel any active requests that are no longer needed.\r\n    // NB: Do NOT remove them from the active set until their http activity has completed.\r\n    for (const active of this._active)\r\n      if (active.viewports.isEmpty)\r\n        this.cancel(active);\r\n\r\n    // Batch-cancel running requests.\r\n    this.processCancellations();\r\n\r\n    // Dispatch requests from the queue up to our maximum.\r\n    while (this._active.size < this._concurrency) {\r\n      const request = this._pending.pop();\r\n      if (!request)\r\n        break;\r\n\r\n      this.dispatch(request);\r\n    }\r\n  }\r\n\r\n  /** Cancel all active and queued requests and clear the active set and queue.\r\n   * @internal\r\n   */\r\n  public cancelAndClearAll(): void {\r\n    for (const active of this._active)\r\n      active.cancel();\r\n\r\n    for (const queued of this._pending)\r\n      queued.cancel();\r\n\r\n    this._active.clear();\r\n    this._pending.clear();\r\n  }\r\n\r\n  /** Invoked when [[Tile.requestContent]] returns `undefined`. Return true if the request can be retried, e.g., via different channel.\r\n   * If so, the tile will remain marked as \"not loaded\" and, if re-selected for display, a new [[TileRequest]] will be enqueued for it.\r\n   * Otherwise, the tile will be marked as \"failed to load\" and no further requests will be made for its content.\r\n   * The default implementation always returns `false`.\r\n   */\r\n  public onNoContent(_request: TileRequest): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Invoked when a request that was previously dispatched is canceled before a response is received.\r\n   * Some channels accumulate such requests for later cancellation in [[processCancellations]].\r\n   */\r\n  public onActiveRequestCanceled(_request: TileRequest): void { }\r\n\r\n  /** Invoked to do any additional work to cancel tiles accumulated by [[onActiveRequestCanceled]]. For example, a channel that requests tile content\r\n   * over IPC may signal to the tile generation process that it should cease generating content for those tiles.\r\n   */\r\n  public processCancellations(): void { }\r\n\r\n  /** Invoked when an iModel is closed, to clean up any state associated with that iModel. */\r\n  public onIModelClosed(_iModel: IModelConnection): void { }\r\n\r\n  /** Request content for the specified tile. The default implementation simply forwards to [[Tile.requestContent]]. */\r\n  public async requestContent(tile: Tile, isCanceled: () => boolean): Promise<TileRequest.Response> {\r\n    return tile.requestContent(isCanceled);\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected dispatch(request: TileRequest): void {\r\n    ++this._statistics.totalDispatchedRequests;\r\n    this._active.add(request);\r\n    request.dispatch(() => {\r\n      this.dropActiveRequest(request);\r\n    }).catch((_) => {\r\n      //\r\n    });\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected cancel(request: TileRequest): void {\r\n    request.cancel();\r\n    ++this._statistics.numCanceled;\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected dropActiveRequest(request: TileRequest): void {\r\n    assert(this._active.has(request) || request.isCanceled);\r\n    this._active.delete(request);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TileRequestChannel.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAI5D,MAAM,gBAAiB,SAAQ,aAA0B;IACvD;QACE,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YACrE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,4BAA4B;IAAzC;QACE,uEAAuE;QAChE,uBAAkB,GAAG,CAAC,CAAC;QAC9B,8EAA8E;QACvE,sBAAiB,GAAG,CAAC,CAAC;QAC7B,qEAAqE;QAC9D,gBAAW,GAAG,CAAC,CAAC;QACvB,kEAAkE;QAC3D,2BAAsB,GAAG,CAAC,CAAC;QAClC,+DAA+D;QACxD,wBAAmB,GAAG,CAAC,CAAC;QAC/B,kEAAkE;QAC3D,0BAAqB,GAAG,CAAC,CAAC;QACjC;;WAEG;QACI,oBAAe,GAAG,CAAC,CAAC;QAC3B;;WAEG;QACI,4BAAuB,GAAG,CAAC,CAAC;QACnC,+JAA+J;QACxJ,qBAAgB,GAAG,CAAC,CAAC;QAC5B,4EAA4E;QACrE,4BAAuB,GAAG,CAAC,CAAC;QACnC,+HAA+H;QACxH,yBAAoB,GAAG,CAAC,CAAC;IAclC,CAAC;IAZC,gBAAgB;IACT,KAAK,CAAC,KAAmC;QAC9C,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,EAAE,mCAAmC;YAChE,MAAM,GAAG,GAAG,QAA8C,CAAC;YAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,gDAAgD;gBAChD,MAAM,CAAC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;gBACtC,KAAK,CAAC,GAAG,CAAY,IAAI,GAAG,CAAC;aAC/B;SACF;IACH,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAc7B;;;;OAIG;IACH,YAAmB,IAAY,EAAE,WAAmB;QAfpD,8CAA8C;QAC3B,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAC5C,aAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAClC,uBAAkB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAC1C,gBAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;QAYzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,GAAW;QAChC,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;IAC1B,CAAC;IAED,oFAAoF;IACpF,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,yEAAyE;IACzE,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,oFAAoF;IACpF,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,IAAI,CAAC,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,0DAA0D;IACnD,eAAe;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,EAAE,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAU,EAAE,OAAoB;QACtD,EAAE,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC;QAC1C,IAAI,IAAI,CAAC,OAAO;YACd,EAAE,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;aAChC,IAAI,CAAC,IAAI,CAAC,aAAa;YAC1B,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAE7C,IAAI,IAAI,CAAC,eAAe;YACtB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAoB;QAChC,MAAM,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC;QAEjC,sCAAsC;QACtC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;YACjC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAExF,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErB,oEAAoE;QACpE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,kBAAkB;YAC1C,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAEhC,wDAAwD;QACxD,sFAAsF;QACtF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO;gBACtB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExB,iCAAiC;QACjC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,sDAAsD;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO;gBACV,MAAM;YAER,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SACxB;IACH,CAAC;IAED;;OAEG;IACI,iBAAiB;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAC/B,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ;YAChC,MAAM,CAAC,MAAM,EAAE,CAAC;QAElB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAqB;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,QAAqB,IAAU,CAAC;IAE/D;;OAEG;IACI,oBAAoB,KAAW,CAAC;IAEvC,2FAA2F;IACpF,cAAc,CAAC,OAAyB,IAAU,CAAC;IAE1D,qHAAqH;IAC9G,KAAK,CAAC,cAAc,CAAC,IAAU,EAAE,UAAyB;QAC/D,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAoB;QACrC,EAAE,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,EAAE;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,OAAoB;QACnC,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,OAAoB;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,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, PriorityQueue } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Tile, TileContent, TileRequest } from \"./internal\";\r\n\r\nclass TileRequestQueue extends PriorityQueue<TileRequest> {\r\n  public constructor() {\r\n    super((lhs, rhs) => {\r\n      const diff = lhs.tile.tree.loadPriority - rhs.tile.tree.loadPriority;\r\n      return 0 !== diff ? diff : lhs.priority - rhs.priority;\r\n    });\r\n  }\r\n}\r\n\r\n/** Statistics regarding the current and cumulative state of one or more [[TileRequestChannel]]s. Useful for monitoring performance and diagnosing problems.\r\n * @see [[TileRequestChannel.statistics]] for a specific channel's statistics.\r\n * @see [[TileRequestChannels.statistics]] for statistics from all channels.\r\n * @see [[TileAdmin.statistics]] for additional statistics.\r\n * @public\r\n */\r\nexport class TileRequestChannelStatistics {\r\n  /** The number of queued requests that have not yet been dispatched. */\r\n  public numPendingRequests = 0;\r\n  /** The number of requests that have been dispatched but not yet completed. */\r\n  public numActiveRequests = 0;\r\n  /** The number of requests canceled during the most recent update. */\r\n  public numCanceled = 0;\r\n  /** The total number of completed requests during this session. */\r\n  public totalCompletedRequests = 0;\r\n  /** The total number of failed requests during this session. */\r\n  public totalFailedRequests = 0;\r\n  /** The total number of timed-out requests during this session. */\r\n  public totalTimedOutRequests = 0;\r\n  /** The total number of completed requests during this session which produced an empty tile.\r\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalUndisplayableTiles]].\r\n   */\r\n  public totalEmptyTiles = 0;\r\n  /** The total number of completed requests during this session that produced an undisplayable tile.\r\n   * These tiles also contribute to [[totalCompletedRequests]], but not to [[totalEmptyTiles]].\r\n   */\r\n  public totalUndisplayableTiles = 0;\r\n  /** The total number of tiles whose contents were not found in cloud storage cache and therefore resulted in a backend request to generate the tile content. */\r\n  public totalCacheMisses = 0;\r\n  /** The total number of tiles for which content requests were dispatched. */\r\n  public totalDispatchedRequests = 0;\r\n  /** The total number of tiles for which content requests were dispatched and then canceled on the backend before completion. */\r\n  public totalAbortedRequests = 0;\r\n\r\n  /** @internal */\r\n  public addTo(stats: TileRequestChannelStatistics): void {\r\n    for (const propName in this) { // eslint-disable-line guard-for-in\r\n      const key = propName as keyof TileRequestChannelStatistics;\r\n      const val = this[key];\r\n      if (typeof val === \"number\") {\r\n        // This type guard ought to suffice but doesn't.\r\n        assert(typeof stats[key] === \"number\");\r\n        (stats[key] as number) += val;\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/** A channel over which requests for tile content can be made. The channel may request content over HTTP, calls to the backend via IPC or RPC, or any other method like generating the content\r\n * on the frontend. The channel consists of a queue of pending requests and a set of \"active\" requests (dispatched and awaiting a response). Incoming requests are placed onto the queue. Requests are popped of the queue in order of priority and dispatched, until the maximum number of simultaneously-active requests is reached.\r\n * The maximum number of active requests depends on the transport mechanism. For HTTP 1.1, browsers impose a limit of 6 simultaneous connections to a given domain, so ideally each unique domain will use its own unique channel with a limit of 6 active requests. Even for requests satisfied entirely by the frontend, imposing a limit is important for throttling the amount of work done at one time, especially because as the user navigates the view, tiles that were previously requested may no longer be of interest and we shouldn't waste resources producing their content.\r\n * A channel must be registered with [[TileRequestChannels]] and must have a unique name among all registered channels.\r\n * @see [[TileRequestChannels.getForHttp]] to obtain (and register if not already registered) an HTTP-based channel.\r\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\r\n * @see [[Tile.channel]] to specify the channel to be used to request a given tile's content.\r\n * @public\r\n */\r\nexport class TileRequestChannel {\r\n  /** The channel's name. It must be unique among all registered [[TileRequestChannels]]. */\r\n  public readonly name: string;\r\n  private _concurrency: number;\r\n  /** Protected strictly for tests. @internal */\r\n  protected readonly _active = new Set<TileRequest>();\r\n  private _pending = new TileRequestQueue();\r\n  private _previouslyPending = new TileRequestQueue();\r\n  protected _statistics = new TileRequestChannelStatistics();\r\n  /** Callback invoked by recordCompletion. See IModelTileMetadataCacheChannel.\r\n   * @internal\r\n   */\r\n  public contentCallback?: (tile: Tile, content: TileContent) => void;\r\n\r\n  /** Create a new channel.\r\n   * @param name The unique name of the channel.\r\n   * @param concurrency The maximum number of requests that can be dispatched and awaiting a response at any given time. Requests beyond this maximum are enqueued for deferred dispatch.\r\n   * @see [[TileRequestChannels.getForHttp]] to create an HTTP-based channel.\r\n   */\r\n  public constructor(name: string, concurrency: number) {\r\n    this.name = name;\r\n    this._concurrency = concurrency;\r\n  }\r\n\r\n  /** The maximum number of active requests. This is generally only modified for debugging purposes.\r\n   * @note When reducing `concurrency`, the number of active requests ([[numActive]]) will only decrease to the new value after a sufficient number of dispatched requests are resolved.\r\n   */\r\n  public get concurrency(): number {\r\n    return this._concurrency;\r\n  }\r\n  public set concurrency(max: number) {\r\n    this._concurrency = max;\r\n  }\r\n\r\n  /** The number of requests that have been dispatched and are awaiting a response. */\r\n  public get numActive(): number {\r\n    return this._active.size;\r\n  }\r\n\r\n  /** The number of requests that have been enqueued for later dispatch. */\r\n  public get numPending(): number {\r\n    return this._pending.length;\r\n  }\r\n\r\n  /** The total number of requests in this channel, whether dispatched or enqueued. */\r\n  public get size(): number {\r\n    return this.numActive + this.numPending;\r\n  }\r\n\r\n  /** Statistics intended primarily for debugging. */\r\n  public get statistics(): Readonly<TileRequestChannelStatistics> {\r\n    this._statistics.numPendingRequests = this.numPending;\r\n    this._statistics.numActiveRequests = this.numActive;\r\n    return this._statistics;\r\n  }\r\n\r\n  /** Reset all of this channel's [[statistics]] to zero. */\r\n  public resetStatistics(): void {\r\n    this._statistics = new TileRequestChannelStatistics();\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] when a request times out.\r\n   * @internal\r\n   */\r\n  public recordTimeout(): void {\r\n    ++this._statistics.totalTimedOutRequests;\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] when a request fails to produce a response.\r\n   * @internal\r\n   */\r\n  public recordFailure(): void {\r\n    ++this._statistics.totalFailedRequests;\r\n  }\r\n\r\n  /** Invoked by [[TileRequest]] after a request completes.\r\n   * @internal\r\n   */\r\n  public recordCompletion(tile: Tile, content: TileContent): void {\r\n    ++this._statistics.totalCompletedRequests;\r\n    if (tile.isEmpty)\r\n      ++this._statistics.totalEmptyTiles;\r\n    else if (!tile.isDisplayable)\r\n      ++this._statistics.totalUndisplayableTiles;\r\n\r\n    if (this.contentCallback)\r\n      this.contentCallback(tile, content);\r\n  }\r\n\r\n  /** Invoked by [[TileRequestChannels.swapPending]] when [[TileAdmin]] is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public swapPending(): void {\r\n    const previouslyPending = this._pending;\r\n    this._pending = this._previouslyPending;\r\n    this._previouslyPending = previouslyPending;\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processRequests]] to enqueue a request. Ordering is ignored - the queue will be re-sorted later.\r\n   * @internal\r\n   */\r\n  public append(request: TileRequest): void {\r\n    assert(request.channel === this);\r\n    this._pending.append(request);\r\n  }\r\n\r\n  /** Invoked by [[TileRequestChannels.process]] to process the active and pending requests.\r\n   * @internal\r\n   */\r\n  public process(): void {\r\n    this._statistics.numCanceled = 0;\r\n\r\n    // Recompute priority of each request.\r\n    for (const pending of this._pending)\r\n      pending.priority = pending.tile.computeLoadPriority(pending.viewports, pending.users);\r\n\r\n    // Sort pending requests by priority.\r\n    this._pending.sort();\r\n\r\n    // Cancel any previously pending requests that are no longer needed.\r\n    for (const queued of this._previouslyPending)\r\n      if (queued.users.isEmpty)\r\n        this.cancel(queued);\r\n\r\n    this._previouslyPending.clear();\r\n\r\n    // Cancel any active requests that are no longer needed.\r\n    // NB: Do NOT remove them from the active set until their http activity has completed.\r\n    for (const active of this._active)\r\n      if (active.users.isEmpty)\r\n        this.cancel(active);\r\n\r\n    // Batch-cancel running requests.\r\n    this.processCancellations();\r\n\r\n    // Dispatch requests from the queue up to our maximum.\r\n    while (this._active.size < this._concurrency) {\r\n      const request = this._pending.pop();\r\n      if (!request)\r\n        break;\r\n\r\n      this.dispatch(request);\r\n    }\r\n  }\r\n\r\n  /** Cancel all active and queued requests and clear the active set and queue.\r\n   * @internal\r\n   */\r\n  public cancelAndClearAll(): void {\r\n    for (const active of this._active)\r\n      active.cancel();\r\n\r\n    for (const queued of this._pending)\r\n      queued.cancel();\r\n\r\n    this._active.clear();\r\n    this._pending.clear();\r\n  }\r\n\r\n  /** Invoked when [[Tile.requestContent]] returns `undefined`. Return true if the request can be retried, e.g., via different channel.\r\n   * If so, the tile will remain marked as \"not loaded\" and, if re-selected for display, a new [[TileRequest]] will be enqueued for it.\r\n   * Otherwise, the tile will be marked as \"failed to load\" and no further requests will be made for its content.\r\n   * The default implementation always returns `false`.\r\n   */\r\n  public onNoContent(_request: TileRequest): boolean {\r\n    return false;\r\n  }\r\n\r\n  /** Invoked when a request that was previously dispatched is canceled before a response is received.\r\n   * Some channels accumulate such requests for later cancellation in [[processCancellations]].\r\n   */\r\n  public onActiveRequestCanceled(_request: TileRequest): void { }\r\n\r\n  /** Invoked to do any additional work to cancel tiles accumulated by [[onActiveRequestCanceled]]. For example, a channel that requests tile content\r\n   * over IPC may signal to the tile generation process that it should cease generating content for those tiles.\r\n   */\r\n  public processCancellations(): void { }\r\n\r\n  /** Invoked when an iModel is closed, to clean up any state associated with that iModel. */\r\n  public onIModelClosed(_iModel: IModelConnection): void { }\r\n\r\n  /** Request content for the specified tile. The default implementation simply forwards to [[Tile.requestContent]]. */\r\n  public async requestContent(tile: Tile, isCanceled: () => boolean): Promise<TileRequest.Response> {\r\n    return tile.requestContent(isCanceled);\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected dispatch(request: TileRequest): void {\r\n    ++this._statistics.totalDispatchedRequests;\r\n    this._active.add(request);\r\n    request.dispatch(() => {\r\n      this.dropActiveRequest(request);\r\n    }).catch((_) => {\r\n      //\r\n    });\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected cancel(request: TileRequest): void {\r\n    request.cancel();\r\n    ++this._statistics.numCanceled;\r\n  }\r\n\r\n  /** Protected only for tests - do not override.\r\n   * @internal\r\n   */\r\n  protected dropActiveRequest(request: TileRequest): void {\r\n    assert(this._active.has(request) || request.isCanceled);\r\n    this._active.delete(request);\r\n  }\r\n}\r\n"]}

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