@itwin/core-frontend 3.1.0-dev.8 → 3.1.2

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/TileRequestChannels.d.ts

@@ -23,10 +23,6 @@ export declare class TileRequestChannels {
      * @internal
      */
     constructor(rpcConcurrency: number | undefined, cacheMetadata: boolean);
-    /** Lazily called by [[TileAdmin]] once it can determine whether a cloud storage cache is configured.
-     * @internal
-     */
-    enableCloudStorageCache(): void;
     /** The number of registered channels. */
     get size(): number;
     /** Look up a registered channel by its name. */

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

@@ -1 +1 @@
-{"version":3,"file":"TileRequestChannels.d.ts","sourceRoot":"","sources":["../../../src/tile/TileRequestChannels.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,UAAU,EAAE,yBAAyB,EAAe,kBAAkB,EAAE,4BAA4B,EACrG,MAAM,YAAY,CAAC;AA8BpB;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B,gBAAgB;IAChB,SAAgB,cAAc,EAAE,yBAAyB,CAAC;IAC1D;;OAEG;IACH,SAAgB,kBAAkB,EAAE,kBAAkB,CAAC;IACvD,6FAA6F;IAC7F,SAAgB,eAAe,KAAK;IACpC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyC;IAEnE;;OAEG;gBACgB,cAAc,EAAE,MAAM,GAAG,SAAS,EAAE,aAAa,EAAE,OAAO;IAqB7E;;OAEG;IACI,uBAAuB,IAAI,IAAI;IAItC,yCAAyC;IACzC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,gDAAgD;IACzC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAIxD,yFAAyF;IAClF,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO;IAKhD;;OAEG;IACI,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAO7C;;;OAGG;WACW,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,MAAM;IAOvD;;;OAGG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB;IAQnD,yCAAyC;IAClC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,kBAAkB,CAAC;IAIxD;;OAEG;IACH,IAAW,cAAc,IAAI,MAAM,CAElC;IAED,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,kBAAkB;IAIjE;;OAEG;IACI,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAMnD,mDAAmD;IACnD,IAAW,UAAU,IAAI,4BAA4B,CAMpD;IAED,wCAAwC;IACjC,eAAe,IAAI,IAAI;IAK9B;;OAEG;IACI,WAAW,IAAI,IAAI;IAK1B;;OAEG;IACI,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKrD;;OAEG;IACI,UAAU,IAAI,IAAI;CAM1B"}
+{"version":3,"file":"TileRequestChannels.d.ts","sourceRoot":"","sources":["../../../src/tile/TileRequestChannels.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,UAAU,EAAE,yBAAyB,EAAe,kBAAkB,EAAE,4BAA4B,EACrG,MAAM,YAAY,CAAC;AA8BpB;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B,gBAAgB;IAChB,SAAgB,cAAc,EAAE,yBAAyB,CAAC;IAC1D;;OAEG;IACH,SAAgB,kBAAkB,EAAE,kBAAkB,CAAC;IACvD,6FAA6F;IAC7F,SAAgB,eAAe,KAAK;IACpC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyC;IAEnE;;OAEG;gBACgB,cAAc,EAAE,MAAM,GAAG,SAAS,EAAE,aAAa,EAAE,OAAO;IAsB7E,yCAAyC;IACzC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,gDAAgD;IACzC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAIxD,yFAAyF;IAClF,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO;IAKhD;;OAEG;IACI,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAO7C;;;OAGG;WACW,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,MAAM;IAOvD;;;OAGG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB;IAQnD,yCAAyC;IAClC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,kBAAkB,CAAC;IAIxD;;OAEG;IACH,IAAW,cAAc,IAAI,MAAM,CAElC;IAED,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,kBAAkB;IAIjE;;OAEG;IACI,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAMnD,mDAAmD;IACnD,IAAW,UAAU,IAAI,4BAA4B,CAMpD;IAED,wCAAwC;IACjC,eAAe,IAAI,IAAI;IAK9B;;OAEG;IACI,WAAW,IAAI,IAAI;IAK1B;;OAEG;IACI,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACI,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAKrD;;OAEG;IACI,UAAU,IAAI,IAAI;CAM1B"}

package/lib/esm/tile/TileRequestChannels.js

@@ -56,16 +56,11 @@ export class TileRequestChannels {
             concurrency: this.rpcConcurrency,
             usesHttp: undefined === rpcConcurrency,
             cacheMetadata,
+            cacheConcurrency: this.httpConcurrency,
         });
         for (const channel of this.iModelChannels)
             this.add(channel);
     }
-    /** Lazily called by [[TileAdmin]] once it can determine whether a cloud storage cache is configured.
-     * @internal
-     */
-    enableCloudStorageCache() {
-        this.add(this.iModelChannels.enableCloudStorageCache(this.httpConcurrency));
-    }
     /** The number of registered channels. */
     get size() {
         return this._channels.size;

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

@@ -1 +1 @@
-{"version":3,"file":"TileRequestChannels.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannels.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EACO,yBAAyB,EAAe,kBAAkB,EAAE,4BAA4B,GACrG,MAAM,YAAY,CAAC;AAEpB,8FAA8F;AAC9F,MAAM,sBAAuB,SAAQ,kBAAkB;IAAvD;;QACmB,cAAS,GAAG,IAAI,GAAG,EAA8B,CAAC;IAwBrE,CAAC;IAtBiB,uBAAuB,CAAC,OAAoB;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QACxC,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG;YACN,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;QAEvC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEe,oBAAoB;QAClC,KAAK,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE;YACjD,mEAAmE;YACnE,MAAM,CAAC,WAAW,CAAC,+BAA+B,EAAE,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAC5E,IAAI,CAAC,WAAW,CAAC,oBAAoB,IAAI,UAAU,CAAC,MAAM,CAAC;SAC5D;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAEe,cAAc,CAAC,MAAwB;QACrD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAY9B;;OAEG;IACH,YAAmB,cAAkC,EAAE,aAAsB;QAR7E,6FAA6F;QAC7E,oBAAe,GAAG,CAAC,CAAC;QAEnB,cAAS,GAAG,IAAI,GAAG,EAA8B,CAAC;QAMjE,IAAI,CAAC,eAAe,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI,CAAC,eAAe,CAAC;QAE9D,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;QACtD,IAAI,SAAS,KAAK,cAAc;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,sBAAsB,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;;YAEjG,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,0BAA0B,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAEpG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAyB,CAAC;YAClD,WAAW,EAAE,IAAI,CAAC,cAAc;YAChC,QAAQ,EAAE,SAAS,KAAK,cAAc;YACtC,aAAa;SACd,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc;YACvC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,uBAAuB;QAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,yCAAyC;IACzC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,gDAAgD;IACzC,GAAG,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,yFAAyF;IAClF,GAAG,CAAC,OAA2B;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,OAAO,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,OAA2B;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,CAAC,IAAI,yBAAyB,CAAC,CAAC;QAEjF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,GAAiB;QAC5C,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAErB,OAAO,GAAG,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,IAAY;QAC5B,IAAI,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO;YACV,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yCAAyC;IAClC,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,gBAAgB;IACT,oBAAoB,CAAC,IAAgB;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,WAAmB;QAC1C,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,kBAAkB,CAAC,WAAW,GAAG,WAAW,CAAC;IACpD,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,MAAM,KAAK,GAAG,IAAI,4BAA4B,EAAE,CAAC;QACjD,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wCAAwC;IACjC,eAAe;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,eAAe,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,WAAW,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,MAAwB;QAC5C,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,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 { IpcApp } from \"../IpcApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport {\r\n  IModelTile, IModelTileRequestChannels, TileRequest, TileRequestChannel, TileRequestChannelStatistics,\r\n} from \"./internal\";\r\n\r\n/** For an [[IpcApp]], allows backend element graphics requests in progress to be canceled. */\r\nclass ElementGraphicsChannel extends TileRequestChannel {\r\n  private readonly _canceled = new Map<IModelConnection, string[]>();\r\n\r\n  public override onActiveRequestCanceled(request: TileRequest): void {\r\n    const imodel = request.tile.tree.iModel;\r\n    let ids = this._canceled.get(imodel);\r\n    if (!ids)\r\n      this._canceled.set(imodel, ids = []);\r\n\r\n    ids.push(request.tile.contentId);\r\n  }\r\n\r\n  public override processCancellations(): void {\r\n    for (const [imodel, requestIds] of this._canceled) {\r\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n      IpcApp.callIpcHost(\"cancelElementGraphicsRequests\", imodel.key, requestIds);\r\n      this._statistics.totalAbortedRequests += requestIds.length;\r\n    }\r\n\r\n    this._canceled.clear();\r\n  }\r\n\r\n  public override onIModelClosed(imodel: IModelConnection): void {\r\n    this._canceled.delete(imodel);\r\n  }\r\n}\r\n\r\n/** A set of named [[TileRequestChannel]]s via which content for [[Tile]]s can be requested.\r\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\r\n * @see [[TileRequestChannels.getForHttp]] for the most typical way of obtaining or registering a channel.\r\n * @public\r\n */\r\nexport class TileRequestChannels {\r\n  /** @internal */\r\n  public readonly iModelChannels: IModelTileRequestChannels;\r\n  /** The channel over which [[TileAdmin.requestElementGraphics]] executes. If you implement a [[TiledGraphicsProvider]] or [[TileTree]] that obtains its\r\n   * content from `requestElementGraphics`, use this channel.\r\n   */\r\n  public readonly elementGraphicsRpc: TileRequestChannel;\r\n  /** The maximum number of active requests for a channel that uses HTTP to request content. */\r\n  public readonly httpConcurrency = 6;\r\n  private _rpcConcurrency: number;\r\n  private readonly _channels = new Map<string, TileRequestChannel>();\r\n\r\n  /** `rpcConcurrency` is defined if [[IpcApp.isValid]]; otherwise RPC requests are made over HTTP and use the same limits.\r\n   * @internal\r\n   */\r\n  public constructor(rpcConcurrency: number | undefined, cacheMetadata: boolean) {\r\n    this._rpcConcurrency = rpcConcurrency ?? this.httpConcurrency;\r\n\r\n    const elementGraphicsChannelName = \"itwinjs-elem-rpc\";\r\n    if (undefined !== rpcConcurrency)\r\n      this.elementGraphicsRpc = new ElementGraphicsChannel(elementGraphicsChannelName, rpcConcurrency);\r\n    else\r\n      this.elementGraphicsRpc = new TileRequestChannel(elementGraphicsChannelName, this.rpcConcurrency);\r\n\r\n    this.add(this.elementGraphicsRpc);\r\n\r\n    this.iModelChannels = new IModelTileRequestChannels({\r\n      concurrency: this.rpcConcurrency,\r\n      usesHttp: undefined === rpcConcurrency,\r\n      cacheMetadata,\r\n    });\r\n\r\n    for (const channel of this.iModelChannels)\r\n      this.add(channel);\r\n  }\r\n\r\n  /** Lazily called by [[TileAdmin]] once it can determine whether a cloud storage cache is configured.\r\n   * @internal\r\n   */\r\n  public enableCloudStorageCache(): void {\r\n    this.add(this.iModelChannels.enableCloudStorageCache(this.httpConcurrency));\r\n  }\r\n\r\n  /** The number of registered channels. */\r\n  public get size(): number {\r\n    return this._channels.size;\r\n  }\r\n\r\n  /** Look up a registered channel by its name. */\r\n  public get(name: string): TileRequestChannel | undefined {\r\n    return this._channels.get(name);\r\n  }\r\n\r\n  /** Return whether the specified channel has been registered. Primarily for debugging. */\r\n  public has(channel: TileRequestChannel): boolean {\r\n    const existing = this.get(channel.name);\r\n    return existing !== undefined && existing === channel;\r\n  }\r\n\r\n  /** Add a new channel.\r\n   * @throws Error if a channel by the same name has already been registered.\r\n   */\r\n  public add(channel: TileRequestChannel): void {\r\n    if (this.get(channel.name))\r\n      throw new Error(`Tile request channel ${channel.name} is already registered.`);\r\n\r\n    this._channels.set(channel.name, channel);\r\n  }\r\n\r\n  /** Extract the host name from a URL for use as the name of the corresponding [[TileRequestChannel]].\r\n   * @throws TypeError if `url` is a string and does not represent a valid URL.\r\n   * @see [[getForHttp]] to obtain or register a channel for the host name.\r\n   */\r\n  public static getNameFromUrl(url: URL | string): string {\r\n    if (typeof url === \"string\")\r\n      url = new URL(url);\r\n\r\n    return url.hostname;\r\n  }\r\n\r\n  /** Obtain a channel that requests content over HTTP using HTTP 1.1 limits on simultaneous connections.\r\n   * If a channel with the specified name does not already exist, it will be created and registered.\r\n   * @see [[getNameFromUrl]] to obtain a channel name corresponding to a hostname.\r\n   */\r\n  public getForHttp(name: string): TileRequestChannel {\r\n    let channel = this.get(name);\r\n    if (!channel)\r\n      this.add(channel = new TileRequestChannel(name, this.httpConcurrency));\r\n\r\n    return channel;\r\n  }\r\n\r\n  /** Iterator over all of the channels. */\r\n  public [Symbol.iterator](): Iterator<TileRequestChannel> {\r\n    return this._channels.values()[Symbol.iterator]();\r\n  }\r\n\r\n  /** The maximum number of active requests for a channel that uses an RpcInterface to satisfy its requests.\r\n   * For web-based applications, this is the same as [[httpConcurrency]], but for [[IpcApp]]s it is determined by the number of workers threads allocated by the backend.\r\n   */\r\n  public get rpcConcurrency(): number {\r\n    return this._rpcConcurrency;\r\n  }\r\n\r\n  /** @internal */\r\n  public getIModelTileChannel(tile: IModelTile): TileRequestChannel {\r\n    return this.iModelChannels.getChannelForTile(tile);\r\n  }\r\n\r\n  /** Chiefly for debugging.\r\n   * @internal\r\n   */\r\n  public setRpcConcurrency(concurrency: number): void {\r\n    this._rpcConcurrency = concurrency;\r\n    this.iModelChannels.setRpcConcurrency(concurrency);\r\n    this.elementGraphicsRpc.concurrency = concurrency;\r\n  }\r\n\r\n  /** Statistics intended primarily for debugging. */\r\n  public get statistics(): TileRequestChannelStatistics {\r\n    const stats = new TileRequestChannelStatistics();\r\n    for (const channel of this)\r\n      channel.statistics.addTo(stats);\r\n\r\n    return stats;\r\n  }\r\n\r\n  /** Reset all [[statistics]] to zero. */\r\n  public resetStatistics(): void {\r\n    for (const channel of this)\r\n      channel.resetStatistics();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processQueue]] when it is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public swapPending(): void {\r\n    for (const channel of this)\r\n      channel.swapPending();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processQueue]] when it is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public process(): void {\r\n    for (const channel of this)\r\n      channel.process();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.onIModelClosed]].\r\n   * @internal\r\n   */\r\n  public onIModelClosed(iModel: IModelConnection): void {\r\n    for (const channel of this)\r\n      channel.onIModelClosed(iModel);\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.onShutDown]].\r\n   * @internal\r\n   */\r\n  public onShutDown(): void {\r\n    for (const channel of this)\r\n      channel.cancelAndClearAll();\r\n\r\n    this._channels.clear();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TileRequestChannels.js","sourceRoot":"","sources":["../../../src/tile/TileRequestChannels.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EACO,yBAAyB,EAAe,kBAAkB,EAAE,4BAA4B,GACrG,MAAM,YAAY,CAAC;AAEpB,8FAA8F;AAC9F,MAAM,sBAAuB,SAAQ,kBAAkB;IAAvD;;QACmB,cAAS,GAAG,IAAI,GAAG,EAA8B,CAAC;IAwBrE,CAAC;IAtBiB,uBAAuB,CAAC,OAAoB;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QACxC,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG;YACN,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;QAEvC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEe,oBAAoB;QAClC,KAAK,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE;YACjD,mEAAmE;YACnE,MAAM,CAAC,WAAW,CAAC,+BAA+B,EAAE,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAC5E,IAAI,CAAC,WAAW,CAAC,oBAAoB,IAAI,UAAU,CAAC,MAAM,CAAC;SAC5D;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAEe,cAAc,CAAC,MAAwB;QACrD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAY9B;;OAEG;IACH,YAAmB,cAAkC,EAAE,aAAsB;QAR7E,6FAA6F;QAC7E,oBAAe,GAAG,CAAC,CAAC;QAEnB,cAAS,GAAG,IAAI,GAAG,EAA8B,CAAC;QAMjE,IAAI,CAAC,eAAe,GAAG,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI,CAAC,eAAe,CAAC;QAE9D,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;QACtD,IAAI,SAAS,KAAK,cAAc;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,sBAAsB,CAAC,0BAA0B,EAAE,cAAc,CAAC,CAAC;;YAEjG,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,0BAA0B,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAEpG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAyB,CAAC;YAClD,WAAW,EAAE,IAAI,CAAC,cAAc;YAChC,QAAQ,EAAE,SAAS,KAAK,cAAc;YACtC,aAAa;YACb,gBAAgB,EAAE,IAAI,CAAC,eAAe;SACvC,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc;YACvC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED,yCAAyC;IACzC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,gDAAgD;IACzC,GAAG,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,yFAAyF;IAClF,GAAG,CAAC,OAA2B;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,OAAO,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,OAA2B;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,CAAC,IAAI,yBAAyB,CAAC,CAAC;QAEjF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,GAAiB;QAC5C,IAAI,OAAO,GAAG,KAAK,QAAQ;YACzB,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAErB,OAAO,GAAG,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,IAAY;QAC5B,IAAI,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO;YACV,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yCAAyC;IAClC,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,gBAAgB;IACT,oBAAoB,CAAC,IAAgB;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,WAAmB;QAC1C,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,kBAAkB,CAAC,WAAW,GAAG,WAAW,CAAC;IACpD,CAAC;IAED,mDAAmD;IACnD,IAAW,UAAU;QACnB,MAAM,KAAK,GAAG,IAAI,4BAA4B,EAAE,CAAC;QACjD,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wCAAwC;IACjC,eAAe;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,eAAe,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,WAAW,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,MAAwB;QAC5C,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,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 { IpcApp } from \"../IpcApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport {\r\n  IModelTile, IModelTileRequestChannels, TileRequest, TileRequestChannel, TileRequestChannelStatistics,\r\n} from \"./internal\";\r\n\r\n/** For an [[IpcApp]], allows backend element graphics requests in progress to be canceled. */\r\nclass ElementGraphicsChannel extends TileRequestChannel {\r\n  private readonly _canceled = new Map<IModelConnection, string[]>();\r\n\r\n  public override onActiveRequestCanceled(request: TileRequest): void {\r\n    const imodel = request.tile.tree.iModel;\r\n    let ids = this._canceled.get(imodel);\r\n    if (!ids)\r\n      this._canceled.set(imodel, ids = []);\r\n\r\n    ids.push(request.tile.contentId);\r\n  }\r\n\r\n  public override processCancellations(): void {\r\n    for (const [imodel, requestIds] of this._canceled) {\r\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n      IpcApp.callIpcHost(\"cancelElementGraphicsRequests\", imodel.key, requestIds);\r\n      this._statistics.totalAbortedRequests += requestIds.length;\r\n    }\r\n\r\n    this._canceled.clear();\r\n  }\r\n\r\n  public override onIModelClosed(imodel: IModelConnection): void {\r\n    this._canceled.delete(imodel);\r\n  }\r\n}\r\n\r\n/** A set of named [[TileRequestChannel]]s via which content for [[Tile]]s can be requested.\r\n * @see [[TileAdmin.channels]] for the channels configured for use with the iTwin.js display system.\r\n * @see [[TileRequestChannels.getForHttp]] for the most typical way of obtaining or registering a channel.\r\n * @public\r\n */\r\nexport class TileRequestChannels {\r\n  /** @internal */\r\n  public readonly iModelChannels: IModelTileRequestChannels;\r\n  /** The channel over which [[TileAdmin.requestElementGraphics]] executes. If you implement a [[TiledGraphicsProvider]] or [[TileTree]] that obtains its\r\n   * content from `requestElementGraphics`, use this channel.\r\n   */\r\n  public readonly elementGraphicsRpc: TileRequestChannel;\r\n  /** The maximum number of active requests for a channel that uses HTTP to request content. */\r\n  public readonly httpConcurrency = 6;\r\n  private _rpcConcurrency: number;\r\n  private readonly _channels = new Map<string, TileRequestChannel>();\r\n\r\n  /** `rpcConcurrency` is defined if [[IpcApp.isValid]]; otherwise RPC requests are made over HTTP and use the same limits.\r\n   * @internal\r\n   */\r\n  public constructor(rpcConcurrency: number | undefined, cacheMetadata: boolean) {\r\n    this._rpcConcurrency = rpcConcurrency ?? this.httpConcurrency;\r\n\r\n    const elementGraphicsChannelName = \"itwinjs-elem-rpc\";\r\n    if (undefined !== rpcConcurrency)\r\n      this.elementGraphicsRpc = new ElementGraphicsChannel(elementGraphicsChannelName, rpcConcurrency);\r\n    else\r\n      this.elementGraphicsRpc = new TileRequestChannel(elementGraphicsChannelName, this.rpcConcurrency);\r\n\r\n    this.add(this.elementGraphicsRpc);\r\n\r\n    this.iModelChannels = new IModelTileRequestChannels({\r\n      concurrency: this.rpcConcurrency,\r\n      usesHttp: undefined === rpcConcurrency,\r\n      cacheMetadata,\r\n      cacheConcurrency: this.httpConcurrency,\r\n    });\r\n\r\n    for (const channel of this.iModelChannels)\r\n      this.add(channel);\r\n  }\r\n\r\n  /** The number of registered channels. */\r\n  public get size(): number {\r\n    return this._channels.size;\r\n  }\r\n\r\n  /** Look up a registered channel by its name. */\r\n  public get(name: string): TileRequestChannel | undefined {\r\n    return this._channels.get(name);\r\n  }\r\n\r\n  /** Return whether the specified channel has been registered. Primarily for debugging. */\r\n  public has(channel: TileRequestChannel): boolean {\r\n    const existing = this.get(channel.name);\r\n    return existing !== undefined && existing === channel;\r\n  }\r\n\r\n  /** Add a new channel.\r\n   * @throws Error if a channel by the same name has already been registered.\r\n   */\r\n  public add(channel: TileRequestChannel): void {\r\n    if (this.get(channel.name))\r\n      throw new Error(`Tile request channel ${channel.name} is already registered.`);\r\n\r\n    this._channels.set(channel.name, channel);\r\n  }\r\n\r\n  /** Extract the host name from a URL for use as the name of the corresponding [[TileRequestChannel]].\r\n   * @throws TypeError if `url` is a string and does not represent a valid URL.\r\n   * @see [[getForHttp]] to obtain or register a channel for the host name.\r\n   */\r\n  public static getNameFromUrl(url: URL | string): string {\r\n    if (typeof url === \"string\")\r\n      url = new URL(url);\r\n\r\n    return url.hostname;\r\n  }\r\n\r\n  /** Obtain a channel that requests content over HTTP using HTTP 1.1 limits on simultaneous connections.\r\n   * If a channel with the specified name does not already exist, it will be created and registered.\r\n   * @see [[getNameFromUrl]] to obtain a channel name corresponding to a hostname.\r\n   */\r\n  public getForHttp(name: string): TileRequestChannel {\r\n    let channel = this.get(name);\r\n    if (!channel)\r\n      this.add(channel = new TileRequestChannel(name, this.httpConcurrency));\r\n\r\n    return channel;\r\n  }\r\n\r\n  /** Iterator over all of the channels. */\r\n  public [Symbol.iterator](): Iterator<TileRequestChannel> {\r\n    return this._channels.values()[Symbol.iterator]();\r\n  }\r\n\r\n  /** The maximum number of active requests for a channel that uses an RpcInterface to satisfy its requests.\r\n   * For web-based applications, this is the same as [[httpConcurrency]], but for [[IpcApp]]s it is determined by the number of workers threads allocated by the backend.\r\n   */\r\n  public get rpcConcurrency(): number {\r\n    return this._rpcConcurrency;\r\n  }\r\n\r\n  /** @internal */\r\n  public getIModelTileChannel(tile: IModelTile): TileRequestChannel {\r\n    return this.iModelChannels.getChannelForTile(tile);\r\n  }\r\n\r\n  /** Chiefly for debugging.\r\n   * @internal\r\n   */\r\n  public setRpcConcurrency(concurrency: number): void {\r\n    this._rpcConcurrency = concurrency;\r\n    this.iModelChannels.setRpcConcurrency(concurrency);\r\n    this.elementGraphicsRpc.concurrency = concurrency;\r\n  }\r\n\r\n  /** Statistics intended primarily for debugging. */\r\n  public get statistics(): TileRequestChannelStatistics {\r\n    const stats = new TileRequestChannelStatistics();\r\n    for (const channel of this)\r\n      channel.statistics.addTo(stats);\r\n\r\n    return stats;\r\n  }\r\n\r\n  /** Reset all [[statistics]] to zero. */\r\n  public resetStatistics(): void {\r\n    for (const channel of this)\r\n      channel.resetStatistics();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processQueue]] when it is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public swapPending(): void {\r\n    for (const channel of this)\r\n      channel.swapPending();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.processQueue]] when it is about to start enqueuing new requests.\r\n   * @internal\r\n   */\r\n  public process(): void {\r\n    for (const channel of this)\r\n      channel.process();\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.onIModelClosed]].\r\n   * @internal\r\n   */\r\n  public onIModelClosed(iModel: IModelConnection): void {\r\n    for (const channel of this)\r\n      channel.onIModelClosed(iModel);\r\n  }\r\n\r\n  /** Invoked by [[TileAdmin.onShutDown]].\r\n   * @internal\r\n   */\r\n  public onShutDown(): void {\r\n    for (const channel of this)\r\n      channel.cancelAndClearAll();\r\n\r\n    this._channels.clear();\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

@@ -127,5 +127,12 @@ export class TileTree {
             dbToEcef = this.iModel.ecefLocation.getTransform();
         return dbToEcef.multiplyTransformTransform(this.iModelTransform);
     }
+    /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.
+     * The base implementation does nothing.
+     * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.
+     * @beta
+     */
+    collectTileGeometry(_collector) {
+    }
 }
 //# sourceMappingURL=TileTree.js.map

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

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

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

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

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

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

package/lib/esm/tile/TileTreeReference.js

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

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

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