@itwin/core-frontend 5.11.0-dev.9 → 5.11.0

package/lib/cjs/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,sDAAmF;AAGnF,oEAAgF;AAChF,4CAAyC;AAMzC;;;;GAIG;AACH,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,kCAAlB,kBAAkB,QAS7B;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAsB,QAAQ;IACpB,WAAW,GAAG,KAAK,CAAC;IAC5B,gBAAgB;IACN,aAAa,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IAC5C,gBAAgB;IACN,WAAW,CAAoB;IACzB,MAAM,CAAmB;IACzC,yFAAyF;IACzE,eAAe,CAAY;IAC3C,2FAA2F;IAC3E,EAAE,CAAS;IAC3B;;;OAGG;IACa,OAAO,CAAa;IACpC,qIAAqI;IACrH,cAAc,CAAa;IAC3C,gBAAgB;IAChB,IAAW,YAAY,KAAuB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACzD,aAAa,CAAmB;IACjD,0FAA0F;IAC1E,YAAY,CAAuB;IAYnD,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;IAElE,gBAAgB;IAChB,IAAW,YAAY,KAAuC,OAAO,SAAS,CAAC,CAAC,CAAC;IAEjF,kBAAkB;IAClB,YAAsB,MAAsB;QAC1C,IAAI,CAAC,aAAa,GAAG,0BAAW,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,qBAAS,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAC1E,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,IAAkB;QACnC,IAAI,CAAC,aAAa,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,qBAAS,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACtG,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,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAA,sBAAO,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,qGAAqG;IAC9F,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,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,CAAC;YACX,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAA,4DAAoC,EAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,QAAQ,GAAG,QAAQ,EAAE,OAAO,EAAE,CAAC;QACjC,CAAC;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;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CAAC,QAAyC,IAAkB,CAAC;IAClG;;;;OAIG;IACI,0BAA0B,KAAU,CAAC;CAC7C;AAzKD,4BAyKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\n\nimport { BeDuration, BeTimePoint, dispose, Id64String } from \"@itwin/core-bentley\";\nimport { Matrix4d, Range3d, Transform } from \"@itwin/core-geometry\";\nimport { ElementAlignedBox3d, FrustumPlanes, RenderSchedule, ViewFlagOverrides } from \"@itwin/core-common\";\nimport { calculateEcefToDbTransformAtLocation } from \"../BackgroundMapGeometry\";\nimport { IModelApp } from \"../IModelApp\";\nimport { IModelConnection } from \"../IModelConnection\";\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\nimport { RenderMemory } from \"../render/RenderMemory\";\nimport { LayerTileTreeHandler, Tile, TileDrawArgs, TileGeometryCollector, TileLoadPriority, TileTreeParams } from \"./internal\";\n\n/** Describes the current state of a [[TileTree]]. TileTrees are loaded asynchronously and may be unloaded after a period of disuse.\n * @see [[TileTreeOwner]].\n * @public\n * @extensions\n */\nexport enum TileTreeLoadStatus {\n  /** No attempt to load the tile tree has yet been made. */\n  NotLoaded,\n  /** The tile tree is in the process of being loaded. */\n  Loading,\n  /** The tile tree has been successfully loaded. */\n  Loaded,\n  /** An attempt to load the tile tree failed. */\n  NotFound,\n}\n\n/** A hierarchical level-of-detail tree of [3d Tiles](https://github.com/CesiumGS/3d-tiles) to be rendered in a [[Viewport]].\n * Tile trees originate from a variety of sources:\n *  - Each [[GeometricModelState]] can supply its graphics as a tile tree;\n *  - A [[DisplayStyleState]]'s map settings or reality models;\n *  - [ViewAttachment]($backend)s in a [[SheetModelState]];\n *  - [[TiledGraphicsProvider]]s associated with a viewport.\n *\n * The same TileTree can be displayed in any number of viewports using multiple [[TileTreeReference]]s.\n * A TileTree's lifetime is managed by a [[TileTreeOwner]].\n *\n * @note Some methods carry a warning that they should **not** be overridden by subclasses; typically a protected method exists that can be\n * overridden instead to customize the behavior. For example, [[selectTiles]] should not be overridden; instead, override the[[_selectTiles]] method\n * that it calls.\n * @public\n * @extensions\n */\nexport abstract class TileTree {\n  private _isDisposed = false;\n  /** @internal */\n  protected _lastSelected = BeTimePoint.now();\n  /** @internal */\n  protected _clipVolume?: RenderClipVolume;\n  public readonly iModel: IModelConnection;\n  /** Transform from this tile tree's coordinate space to the iModel's coordinate space. */\n  public readonly iModelTransform: Transform;\n  /** Uniquely identifies this tree among all other tile trees associated with the iModel. */\n  public readonly id: string;\n  /** A 64-bit identifier for this tile tree, unique  within the context of its [[IModelConnection]].\n   * For a tile tree associated with a [[GeometricModelState]], this is the Id of the model. Other types of tile trees\n   * typically use a transient Id obtained from [[IModelConnection.transientIds]].\n   */\n  public readonly modelId: Id64String;\n  /** The length of time after which tiles belonging to this tree are considered elegible for disposal if they are no longer in use. */\n  public readonly expirationTime: BeDuration;\n  /** @internal */\n  public get loadPriority(): TileLoadPriority { return this._loadPriority; }\n  private readonly _loadPriority: TileLoadPriority;\n  /** Optional tight bounding box around the entire contents of all of this tree's tiles. */\n  public readonly contentRange?: ElementAlignedBox3d;\n\n  /** The lowest-resolution tile in this tree. */\n  public abstract get rootTile(): Tile;\n  /** True if this tile tree contains 3d graphics. */\n  public abstract get is3d(): boolean;\n  /** Returns the maximum depth of this tree, if any. */\n  public abstract get maxDepth(): number | undefined;\n\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. */\n  public abstract get viewFlagOverrides(): ViewFlagOverrides;\n\n  /** True if this tile tree has no bounds - e.g., a tile tree representing a globe is unbounded. */\n  public get isContentUnbounded(): boolean {\n    return false;\n  }\n\n  /** Implement this method to select tiles of appropriate resolution. */\n  protected abstract _selectTiles(args: TileDrawArgs): Tile[];\n\n  /** Produce graphics of appropriate resolution to be drawn in a [[Viewport]]. */\n  public abstract draw(args: TileDrawArgs): void;\n\n  /** Discard tiles and/or tile contents, presumably based on a least-recently-used and/or least-likely-to-be-needed criterion. */\n  public abstract prune(): void;\n\n  /** True if this tile tree contains 2d graphics. */\n  public get is2d(): boolean { return !this.is3d; }\n  /** @internal */\n  public get isPointCloud(): boolean { return false; }\n  /** @internal */\n  public get clipVolume(): RenderClipVolume | undefined { return this._clipVolume; }\n\n  /** The volume of space occupied by this tile tree. */\n  public get range(): ElementAlignedBox3d { return this.rootTile.range; }\n  /** The most recent time at which tiles [[selectTiles]] was called. */\n  public get lastSelectedTime(): BeTimePoint { return this._lastSelected; }\n  /** True if a tile and its child tiles should not be drawn simultaneously.\n   * Default: true.\n   */\n  public get parentsAndChildrenExclusive(): boolean { return true; }\n\n  /** @internal */\n  public get layerHandler(): LayerTileTreeHandler | undefined { return undefined; }\n\n  /** Constructor */\n  protected constructor(params: TileTreeParams) {\n    this._lastSelected = BeTimePoint.now();\n    this.iModel = params.iModel;\n    this.iModelTransform = params.location;\n    this._clipVolume = params.clipVolume;\n    this.modelId = params.modelId;\n    this.id = params.id;\n    this.contentRange = params.contentRange;\n\n    const admin = IModelApp.tileAdmin;\n    this._loadPriority = params.priority;\n    this.expirationTime = params.expirationTime ?? admin.tileExpirationTime;\n  }\n\n  /** Selects tiles of appropriate resolution for some purpose like drawing to the screen, producing a shadow map, etc.\n   * @note Do **not** override this method. Implement [[_selectTiles]].\n   */\n  public selectTiles(args: TileDrawArgs): Tile[] {\n    this._lastSelected = BeTimePoint.now();\n    const tiles = this._selectTiles(args);\n    IModelApp.tileAdmin.addTilesForUser(args.context.viewport, tiles, args.readyTiles, args.touchedTiles);\n    args.processSelectedTiles(tiles);\n    return tiles;\n  }\n\n  /** True if [[dispose]] has been called on this tile tree. */\n  public get isDisposed(): boolean { return this._isDisposed; }\n\n  /** Dispose of this tree and any resources owned by it. This is typically invoked by a [[TileTreeOwner]]. */\n  public [Symbol.dispose](): void {\n    if (this.isDisposed)\n      return;\n\n    this._isDisposed = true;\n    dispose(this.rootTile);\n  }\n\n  /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [Symbol.dispose] instead. */\n  public dispose() {\n    this[Symbol.dispose]();\n  }\n\n  /** @internal */\n  public collectStatistics(stats: RenderMemory.Statistics): void {\n    this.rootTile.collectStatistics(stats);\n  }\n\n  /** Returns the number of [[Tile]]s currently in memory belonging to this tree, primarily for debugging. */\n  public countTiles(): number {\n    return 1 + this.rootTile.countDescendants();\n  }\n\n  /** @internal */\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, location: Transform, frustumPlanes?: FrustumPlanes): void {\n    this.rootTile.extendRangeForContent(range, matrix, location, frustumPlanes);\n  }\n\n  /**\n   * Return the transform from the tile tree's coordinate space to [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates.\n   * If a geographic coordinate system is present then this transform will be calculated at the tile tree center.\n   * @beta\n   */\n  public async getEcefTransform(): Promise<Transform | undefined> {\n    if (!this.iModel.ecefLocation)\n      return undefined;\n\n    let dbToEcef: Transform | undefined;\n    const range = this.contentRange ? this.contentRange : this.range;\n    const center = range.localXYZToWorld(.5, .5, .5);\n    if (center) {\n      this.iModelTransform.multiplyPoint3d(center, center);\n      const ecefToDb = await calculateEcefToDbTransformAtLocation(center, this.iModel);\n      dbToEcef = ecefToDb?.inverse();\n    }\n    if (!dbToEcef)\n      dbToEcef = this.iModel.ecefLocation.getTransform();\n\n    return dbToEcef.multiplyTransformTransform(this.iModelTransform);\n  }\n\n  /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.\n   * The base implementation does nothing.\n   * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.\n   * @beta\n   */\n  public collectTileGeometry(_collector: TileGeometryCollector): void {\n  }\n\n  /**\n   * Invoked when a schedule script is edited.\n   * Override to handle updates for affected elements or timelines.\n   *\n   * @internal\n   */\n  public async onScheduleEditingChanged(_changes: RenderSchedule.EditingChanges[]): Promise<void> {}\n  /**\n   * Invoked when a schedule script is committed during editing.\n   * Override in specific tile tree types to handle the change.\n   * @internal\n   */\n  public onScheduleEditingCommitted(): void {}\n}\n\n"]}
+{"version":3,"file":"TileTree.js","sourceRoot":"","sources":["../../../src/tile/TileTree.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmF;AAGnF,oEAAgF;AAChF,4CAAyC;AAMzC;;;;GAIG;AACH,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,kCAAlB,kBAAkB,QAS7B;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAsB,QAAQ;IACpB,WAAW,GAAG,KAAK,CAAC;IAC5B,gBAAgB;IACN,aAAa,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;IAC5C,gBAAgB;IACN,WAAW,CAAoB;IACzB,MAAM,CAAmB;IACzC,yFAAyF;IACzE,eAAe,CAAY;IAC3C,2FAA2F;IAC3E,EAAE,CAAS;IAC3B;;;OAGG;IACa,OAAO,CAAa;IACpC,qIAAqI;IACrH,cAAc,CAAa;IAC3C,gBAAgB;IAChB,IAAW,YAAY,KAAuB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACzD,aAAa,CAAmB;IACjD,0FAA0F;IAC1E,YAAY,CAAuB;IAYnD,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;IAElE,gBAAgB;IAChB,IAAW,YAAY,KAAuC,OAAO,SAAS,CAAC,CAAC,CAAC;IAEjF,kBAAkB;IAClB,YAAsB,MAAsB;QAC1C,IAAI,CAAC,aAAa,GAAG,0BAAW,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,qBAAS,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAC1E,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,IAAkB;QACnC,IAAI,CAAC,aAAa,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,qBAAS,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACtG,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,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAA,sBAAO,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,iGAAiG;IAC1F,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,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,CAAC;YACX,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAA,4DAAoC,EAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,QAAQ,GAAG,QAAQ,EAAE,OAAO,EAAE,CAAC;QACjC,CAAC;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;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CAAC,QAAyC,IAAkB,CAAC;IAClG;;;;OAIG;IACI,0BAA0B,KAAU,CAAC;CAC7C;AAzKD,4BAyKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\n\nimport { BeDuration, BeTimePoint, dispose, Id64String } from \"@itwin/core-bentley\";\nimport { Matrix4d, Range3d, Transform } from \"@itwin/core-geometry\";\nimport { ElementAlignedBox3d, FrustumPlanes, RenderSchedule, ViewFlagOverrides } from \"@itwin/core-common\";\nimport { calculateEcefToDbTransformAtLocation } from \"../BackgroundMapGeometry\";\nimport { IModelApp } from \"../IModelApp\";\nimport { IModelConnection } from \"../IModelConnection\";\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\nimport { RenderMemory } from \"../render/RenderMemory\";\nimport { LayerTileTreeHandler, Tile, TileDrawArgs, TileGeometryCollector, TileLoadPriority, TileTreeParams } from \"./internal\";\n\n/** Describes the current state of a [[TileTree]]. TileTrees are loaded asynchronously and may be unloaded after a period of disuse.\n * @see [[TileTreeOwner]].\n * @public\n * @extensions\n */\nexport enum TileTreeLoadStatus {\n  /** No attempt to load the tile tree has yet been made. */\n  NotLoaded,\n  /** The tile tree is in the process of being loaded. */\n  Loading,\n  /** The tile tree has been successfully loaded. */\n  Loaded,\n  /** An attempt to load the tile tree failed. */\n  NotFound,\n}\n\n/** A hierarchical level-of-detail tree of [3d Tiles](https://github.com/CesiumGS/3d-tiles) to be rendered in a [[Viewport]].\n * Tile trees originate from a variety of sources:\n *  - Each [[GeometricModelState]] can supply its graphics as a tile tree;\n *  - A [[DisplayStyleState]]'s map settings or reality models;\n *  - [ViewAttachment]($backend)s in a [[SheetModelState]];\n *  - [[TiledGraphicsProvider]]s associated with a viewport.\n *\n * The same TileTree can be displayed in any number of viewports using multiple [[TileTreeReference]]s.\n * A TileTree's lifetime is managed by a [[TileTreeOwner]].\n *\n * @note Some methods carry a warning that they should **not** be overridden by subclasses; typically a protected method exists that can be\n * overridden instead to customize the behavior. For example, [[selectTiles]] should not be overridden; instead, override the[[_selectTiles]] method\n * that it calls.\n * @public\n * @extensions\n */\nexport abstract class TileTree {\n  private _isDisposed = false;\n  /** @internal */\n  protected _lastSelected = BeTimePoint.now();\n  /** @internal */\n  protected _clipVolume?: RenderClipVolume;\n  public readonly iModel: IModelConnection;\n  /** Transform from this tile tree's coordinate space to the iModel's coordinate space. */\n  public readonly iModelTransform: Transform;\n  /** Uniquely identifies this tree among all other tile trees associated with the iModel. */\n  public readonly id: string;\n  /** A 64-bit identifier for this tile tree, unique  within the context of its [[IModelConnection]].\n   * For a tile tree associated with a [[GeometricModelState]], this is the Id of the model. Other types of tile trees\n   * typically use a transient Id obtained from [[IModelConnection.transientIds]].\n   */\n  public readonly modelId: Id64String;\n  /** The length of time after which tiles belonging to this tree are considered elegible for disposal if they are no longer in use. */\n  public readonly expirationTime: BeDuration;\n  /** @internal */\n  public get loadPriority(): TileLoadPriority { return this._loadPriority; }\n  private readonly _loadPriority: TileLoadPriority;\n  /** Optional tight bounding box around the entire contents of all of this tree's tiles. */\n  public readonly contentRange?: ElementAlignedBox3d;\n\n  /** The lowest-resolution tile in this tree. */\n  public abstract get rootTile(): Tile;\n  /** True if this tile tree contains 3d graphics. */\n  public abstract get is3d(): boolean;\n  /** Returns the maximum depth of this tree, if any. */\n  public abstract get maxDepth(): number | undefined;\n\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. */\n  public abstract get viewFlagOverrides(): ViewFlagOverrides;\n\n  /** True if this tile tree has no bounds - e.g., a tile tree representing a globe is unbounded. */\n  public get isContentUnbounded(): boolean {\n    return false;\n  }\n\n  /** Implement this method to select tiles of appropriate resolution. */\n  protected abstract _selectTiles(args: TileDrawArgs): Tile[];\n\n  /** Produce graphics of appropriate resolution to be drawn in a [[Viewport]]. */\n  public abstract draw(args: TileDrawArgs): void;\n\n  /** Discard tiles and/or tile contents, presumably based on a least-recently-used and/or least-likely-to-be-needed criterion. */\n  public abstract prune(): void;\n\n  /** True if this tile tree contains 2d graphics. */\n  public get is2d(): boolean { return !this.is3d; }\n  /** @internal */\n  public get isPointCloud(): boolean { return false; }\n  /** @internal */\n  public get clipVolume(): RenderClipVolume | undefined { return this._clipVolume; }\n\n  /** The volume of space occupied by this tile tree. */\n  public get range(): ElementAlignedBox3d { return this.rootTile.range; }\n  /** The most recent time at which tiles [[selectTiles]] was called. */\n  public get lastSelectedTime(): BeTimePoint { return this._lastSelected; }\n  /** True if a tile and its child tiles should not be drawn simultaneously.\n   * Default: true.\n   */\n  public get parentsAndChildrenExclusive(): boolean { return true; }\n\n  /** @internal */\n  public get layerHandler(): LayerTileTreeHandler | undefined { return undefined; }\n\n  /** Constructor */\n  protected constructor(params: TileTreeParams) {\n    this._lastSelected = BeTimePoint.now();\n    this.iModel = params.iModel;\n    this.iModelTransform = params.location;\n    this._clipVolume = params.clipVolume;\n    this.modelId = params.modelId;\n    this.id = params.id;\n    this.contentRange = params.contentRange;\n\n    const admin = IModelApp.tileAdmin;\n    this._loadPriority = params.priority;\n    this.expirationTime = params.expirationTime ?? admin.tileExpirationTime;\n  }\n\n  /** Selects tiles of appropriate resolution for some purpose like drawing to the screen, producing a shadow map, etc.\n   * @note Do **not** override this method. Implement [[_selectTiles]].\n   */\n  public selectTiles(args: TileDrawArgs): Tile[] {\n    this._lastSelected = BeTimePoint.now();\n    const tiles = this._selectTiles(args);\n    IModelApp.tileAdmin.addTilesForUser(args.context.viewport, tiles, args.readyTiles, args.touchedTiles);\n    args.processSelectedTiles(tiles);\n    return tiles;\n  }\n\n  /** True if [[dispose]] has been called on this tile tree. */\n  public get isDisposed(): boolean { return this._isDisposed; }\n\n  /** Dispose of this tree and any resources owned by it. This is typically invoked by a [[TileTreeOwner]]. */\n  public [Symbol.dispose](): void {\n    if (this.isDisposed)\n      return;\n\n    this._isDisposed = true;\n    dispose(this.rootTile);\n  }\n\n  /** @deprecated in 5.0 - might be removed in next major version. Use [Symbol.dispose] instead. */\n  public dispose() {\n    this[Symbol.dispose]();\n  }\n\n  /** @internal */\n  public collectStatistics(stats: RenderMemory.Statistics): void {\n    this.rootTile.collectStatistics(stats);\n  }\n\n  /** Returns the number of [[Tile]]s currently in memory belonging to this tree, primarily for debugging. */\n  public countTiles(): number {\n    return 1 + this.rootTile.countDescendants();\n  }\n\n  /** @internal */\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, location: Transform, frustumPlanes?: FrustumPlanes): void {\n    this.rootTile.extendRangeForContent(range, matrix, location, frustumPlanes);\n  }\n\n  /**\n   * Return the transform from the tile tree's coordinate space to [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates.\n   * If a geographic coordinate system is present then this transform will be calculated at the tile tree center.\n   * @beta\n   */\n  public async getEcefTransform(): Promise<Transform | undefined> {\n    if (!this.iModel.ecefLocation)\n      return undefined;\n\n    let dbToEcef: Transform | undefined;\n    const range = this.contentRange ? this.contentRange : this.range;\n    const center = range.localXYZToWorld(.5, .5, .5);\n    if (center) {\n      this.iModelTransform.multiplyPoint3d(center, center);\n      const ecefToDb = await calculateEcefToDbTransformAtLocation(center, this.iModel);\n      dbToEcef = ecefToDb?.inverse();\n    }\n    if (!dbToEcef)\n      dbToEcef = this.iModel.ecefLocation.getTransform();\n\n    return dbToEcef.multiplyTransformTransform(this.iModelTransform);\n  }\n\n  /** Populate [[TileGeometryCollector.polyfaces]] with geometry obtained from this tile tree's tiles satisfying the collector's criteria.\n   * The base implementation does nothing.\n   * @see [[TileTreeReference.createGeometryTreeReference]] to attempt to create a TileTree that can collect geometry.\n   * @beta\n   */\n  public collectTileGeometry(_collector: TileGeometryCollector): void {\n  }\n\n  /**\n   * Invoked when a schedule script is edited.\n   * Override to handle updates for affected elements or timelines.\n   *\n   * @internal\n   */\n  public async onScheduleEditingChanged(_changes: RenderSchedule.EditingChanges[]): Promise<void> {}\n  /**\n   * Invoked when a schedule script is committed during editing.\n   * Override in specific tile tree types to handle the change.\n   * @internal\n   */\n  public onScheduleEditingCommitted(): void {}\n}\n\n"]}

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

@@ -133,7 +133,7 @@ export declare abstract class TileTreeReference {
      * @beta
      */
     get planarClipMaskPriority(): number;
-    /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */
+    /** @deprecated in 5.0 - might be removed in next major version. Use [addAttributions] instead. */
     addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void;
     /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div.
      * @beta

package/lib/cjs/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,EACL,oBAAoB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,YAAY,EAAE,qBAAqB,EAAE,QAAQ,EAAsB,aAAa,EACzM,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,oBAAY,eAAe;IACzB,wDAAwD;IACxD,aAAa,IAAI;IACjB,2CAA2C;IAC3C,KAAK,IAAI;IACT,+CAA+C;IAC/C,OAAO,IAAI;CACZ;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAiB;IACrC,uJAAuJ;IACvJ,aAAoB,SAAS,IAAI,aAAa,CAAC;IAE/C;;OAEG;IACI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACI,cAAc;IAErB;;;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;;;;OAIG;IACU,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAEnF;;;OAGG;IACI,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAIjD,uIAAuI;IAChI,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAI/F;;OAEG;IACU,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAE7H;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAEhD;;OAEG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM1C,mEAAmE;IAC5D,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;IAsBtE,YAAY;IACL,sBAAsB,IAAI,SAAS,GAAG,SAAS;IAEtD,gBAAgB;IAChB,SAAS,CAAC,2BAA2B,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAG1E,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAI7D;;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,sGAAsG;IAC/F,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAExE;;MAEE;IACW,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxF;;;OAGG;IACH,SAAS,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE,gCAAgC,GAAG,yBAAyB,GAAG,SAAS;IAI1H;OACG;IACI,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAExE;OACG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI;IAatE;;;;OAIG;IACI,2BAA2B,CAAC,OAAO,CAAC,EAAE,gCAAgC,GAAG,yBAAyB,GAAG,SAAS;IAWrH;;;;;;;;;;;;;;OAcG;WACW,uBAAuB,CAAC,IAAI,EAAE,yBAAyB,GAAG,iBAAiB;CAG1F;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B"}
+{"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,qBAAqB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,YAAY,EAAE,qBAAqB,EAAE,QAAQ,EAAsB,aAAa,EACzM,MAAM,YAAY,CAAC;AAEpB;;;GAGG;AACH,oBAAY,eAAe;IACzB,wDAAwD;IACxD,aAAa,IAAI;IACjB,2CAA2C;IAC3C,KAAK,IAAI;IACT,+CAA+C;IAC/C,OAAO,IAAI;CACZ;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAiB;IACrC,uJAAuJ;IACvJ,aAAoB,SAAS,IAAI,aAAa,CAAC;IAE/C;;OAEG;IACI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACI,cAAc;IAErB;;;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;;;;OAIG;IACU,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAEnF;;;OAGG;IACI,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAIjD,uIAAuI;IAChI,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAI/F;;OAEG;IACU,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAE7H;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAEhD;;OAEG;IACI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM1C,mEAAmE;IAC5D,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;IAsBtE,YAAY;IACL,sBAAsB,IAAI,SAAS,GAAG,SAAS;IAEtD,gBAAgB;IAChB,SAAS,CAAC,2BAA2B,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAG1E,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS;IAI7D;;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,kGAAkG;IAC3F,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAExE;;MAEE;IACW,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxF;;;OAGG;IACH,SAAS,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE,gCAAgC,GAAG,yBAAyB,GAAG,SAAS;IAI1H;OACG;IACI,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC;IAExE;OACG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI;IAatE;;;;OAIG;IACI,2BAA2B,CAAC,OAAO,CAAC,EAAE,gCAAgC,GAAG,yBAAyB,GAAG,SAAS;IAWrH;;;;;;;;;;;;;;OAcG;WACW,uBAAuB,CAAC,IAAI,EAAE,yBAAyB,GAAG,iBAAiB;CAG1F;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B"}

package/lib/cjs/tile/TileTreeReference.js

@@ -223,7 +223,7 @@ class TileTreeReference /* implements RenderMemory.Consumer */ {
      * @beta
      */
     get planarClipMaskPriority() { return core_common_1.PlanarClipMaskPriority.DesignModel; }
-    /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */
+    /** @deprecated in 5.0 - might be removed in next major version. Use [addAttributions] instead. */
     addLogoCards(_cards, _vp) { }
     /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div.
      * @beta

package/lib/cjs/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,sDAA0D;AAC1D,wDAA6E;AAC7E,oDAA0J;AAO1J,yCAEoB;AAEpB;;;GAGG;AACH,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,+BAAf,eAAe,QAO1B;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAiB,CAAC,sCAAsC;IAI5E;;OAEG;IACI,iBAAiB,CAAW;IAEnC;;OAEG;IACI,cAAc,KAAI,CAAC;IAE1B;;;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;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,IAAe,IAA+C,OAAO,SAAS,CAAC,CAAC,CAAC;IAEzG;;;OAGG;IACI,gBAAgB,CAAC,IAAe;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uIAAuI;IAChI,iBAAiB,CAAC,GAAc;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,IAAe,EAAE,QAAgC,IAAiD,OAAO,SAAS,CAAC,CAAC,CAAC;IAEpJ;;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,mEAAmE;IAC5D,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,CAAC;YAClC,KAAK,6BAAkB,CAAC,SAAS,CAAC;YAClC,KAAK,6BAAkB,CAAC,OAAO;gBAC7B,OAAO,KAAK,CAAC;YACf,KAAK,6BAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,CAAC,iCAAiC;YAChD,KAAK,6BAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC;QACnC,CAAC;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,uBAAY,CAAC;YACtB,OAAO;YACP,IAAI;YACJ,GAAG,EAAE,0BAAW,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;YAChE,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YACtC,mBAAmB,EAAE,IAAI,CAAC,sBAAsB,EAAE;SACnD,CAAC,CAAC;IACL,CAAC;IAED,YAAY;IACL,sBAAsB,KAA4B,OAAO,SAAS,CAAC,CAAC,CAAC;IAE5E,gBAAgB;IACN,2BAA2B,CAAC,KAAe;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,gBAAgB;IACN,cAAc,CAAC,KAAe;QACtC,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,uBAAO,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,oCAAsB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F,sGAAsG;IAC/F,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;IAE5E;;MAEE;IACK,KAAK,CAAC,eAAe,CAAC,KAAuB,EAAE,EAAkB;QACtE,4DAA4D;QAC5D,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACO,4BAA4B,CAAC,QAA2C;QAChF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;OACG;IACI,mBAAmB,CAA8C;IAExE;OACG;IACO,oBAAoB,CAAC,SAAgC;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YAClC,KAAK,6BAAkB,CAAC,MAAM;gBAC5B,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,6BAAkB,CAAC,OAAO;gBAC7B,SAAS,CAAC,WAAW,EAAE,CAAC;gBACxB,MAAM;QACV,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,OAA0C;QAC3E,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,0KAA0K;YAC1K,MAAM,GAAG,GAAG,IAAiC,CAAC;YAC9C,GAAG,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAC;YACnD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,uBAAuB,CAAC,IAA+B;QACnE,OAAO,IAAA,6CAAkC,EAAC,IAAI,CAAC,CAAC;IAClD,CAAC;CACF;AAvSD,8CAuSC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\n\nimport { assert, BeTimePoint } from \"@itwin/core-bentley\";\nimport { Matrix4d, Range1d, Range3d, Transform } from \"@itwin/core-geometry\";\nimport { ElementAlignedBox3d, FeatureAppearanceProvider, FrustumPlanes, HiddenLine, PlanarClipMaskPriority, ViewFlagOverrides } from \"@itwin/core-common\";\nimport { HitDetail } from \"../HitDetail\";\nimport { FeatureSymbology } from \"../render/FeatureSymbology\";\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\nimport { RenderMemory } from \"../render/RenderMemory\";\nimport { DecorateContext, SceneContext } from \"../ViewContext\";\nimport { ScreenViewport } from \"../Viewport\";\nimport {\n  DisclosedTileTreeSet, GeometryTileTreeReference, MapFeatureInfoOptions, MapLayerFeatureInfo, RenderGraphicTileTreeArgs, TileDrawArgs, TileGeometryCollector, TileTree, TileTreeLoadStatus, TileTreeOwner, tileTreeReferenceFromRenderGraphic,\n} from \"./internal\";\n\n/** Describes the type of graphics produced by a [[TileTreeReference]].\n * @public\n * @extensions\n */\nexport enum TileGraphicType {\n  /** Rendered behind all other geometry without depth. */\n  BackgroundMap = 0,\n  /** Rendered with normal scene graphics. */\n  Scene = 1,\n  /** Rendered in front of all other geometry. */\n  Overlay = 2,\n}\n\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\n * way of the tree's [[TileTreeOwner]].\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,\n * as a result of changing the RenderMode, or animation settings, or classification settings, etc.\n * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].\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\n * differing levels of transparency.\n * @see [[TiledGraphicsProvider]] to supply custom [[TileTreeReference]]s to be drawn within a [[Viewport]].\n * @public\n * @extensions\n */\nexport abstract class TileTreeReference /* implements RenderMemory.Consumer */ {\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. */\n  public abstract get treeOwner(): TileTreeOwner;\n\n  /** If set to true, tile geometry will be reprojected using the tile's reprojection transform when geometry is collected from the referenced TileTree.\n   * @internal\n   */\n  public reprojectGeometry?: boolean;\n\n  /** Force a new tree owner / tile tree to be created for the current tile tree reference\n   * @internal\n   */\n  public resetTreeOwner() {}\n\n  /** Disclose *all* TileTrees use by this reference. This may include things like map tiles used for draping on terrain.\n   * Override this and call super if you have such auxiliary trees.\n   * @note Any tree *NOT* disclosed becomes a candidate for *purging* (being unloaded from memory along with all of its tiles and graphics).\n   */\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree)\n      trees.add(tree);\n  }\n\n  /** Adds this reference's graphics to the scene. By default this invokes [[draw]]. */\n  public addToScene(context: SceneContext): void {\n    const args = this.createDrawArgs(context);\n    if (undefined !== args)\n      this.draw(args);\n  }\n\n  /** Adds this reference's graphics to the scene. By default this invokes [[TileTree.draw]] on the referenced TileTree, if it is loaded. */\n  public draw(args: TileDrawArgs): void {\n    args.tree.draw(args);\n  }\n\n  /** Return a tooltip describing the hit, or `undefined` if no tooltip can be supplied.\n   * If you override this method, make sure to check that `hit` represents an entity belonging to your tile tree, e.g., by checking `hit.modelId` and `hit.sourceId`.\n   * If you *don't* override this method, override [[canSupplyToolTip]] to return false.\n   * Callers who want to obtain a tooltip should prefer [[getToolTipPromise]].\n   */\n  public async getToolTip(_hit: HitDetail): Promise<HTMLElement | string | undefined> { return undefined; }\n\n  /** Return whether this TileTreeReference can supply a tooltip describing the entity represented by the specified hit.\n   * [[getToolTipPromise]] calls [[getToolTip]] if and only if `canSupplyToolTip` returns `true`.\n   * If your tile tree never supplies tooltips, override this to return `false`.\n   */\n  public canSupplyToolTip(_hit: HitDetail): boolean {\n    return true;\n  }\n\n  /** Obtain a tooltip describing the specified `hit`, or `undefined` if this tile tree reference cannot supply a tooltip for the hit. */\n  public getToolTipPromise(hit: HitDetail): Promise<HTMLElement | string | undefined> | undefined {\n    return this.canSupplyToolTip(hit) ? this.getToolTip(hit).catch(() => undefined) : undefined;\n  }\n\n  /** Optionally return a MapLayerFeatureInfo object describing the hit.].\n   * @alpha\n   */\n  public async getMapFeatureInfo(_hit: HitDetail, _options?: MapFeatureInfoOptions): Promise<MapLayerFeatureInfo[] | undefined>  { return undefined; }\n\n  /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.\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.\n   */\n  public decorate(_context: DecorateContext): void { }\n\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.\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.\n   */\n  public unionFitRange(union: Range3d): void {\n    const contentRange = this.computeWorldContentRange();\n    if (!contentRange.isNull)\n      union.extendRange(contentRange);\n  }\n\n  /** Record graphics memory consumed by this tile tree reference. */\n  public collectStatistics(stats: RenderMemory.Statistics): void {\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree)\n      tree.collectStatistics(stats);\n  }\n\n  /** Return true if the tile tree is fully loaded and ready to draw.\n   * The default implementation returns true if the tile tree loading process completed (whether it resulted in success or failure).\n   * @note Do *not* override this property - override [[_isLoadingComplete]] instead..\n   * @public\n   */\n  public get isLoadingComplete(): boolean {\n    switch (this.treeOwner.loadStatus) {\n      case TileTreeLoadStatus.NotLoaded:\n      case TileTreeLoadStatus.Loading:\n        return false;\n      case TileTreeLoadStatus.NotFound:\n        return true; // we tried, and failed, to load.\n      case TileTreeLoadStatus.Loaded:\n        return this._isLoadingComplete;\n    }\n  }\n\n  /** Override if additional asynchronous loading is required after the tile tree is successfully loaded, to indicate when that loading has completed.\n   * @public\n   */\n  protected get _isLoadingComplete(): boolean {\n    return true;\n  }\n\n  /** Create context for drawing the tile tree, if it is ready for drawing.\n   * TileTreeReferences can override individual portions of the context, e.g. apply their own transform.\n   * Returns undefined if, e.g., the tile tree is not yet loaded.\n   */\n  public createDrawArgs(context: SceneContext): TileDrawArgs | undefined {\n    const tree = this.treeOwner.load();\n    if (undefined === tree)\n      return undefined;\n\n    return new TileDrawArgs({\n      context,\n      tree,\n      now: BeTimePoint.now(),\n      location: this.computeTransform(tree),\n      viewFlagOverrides: this.getViewFlagOverrides(tree),\n      clipVolume: this.getClipVolume(tree),\n      parentsAndChildrenExclusive: tree.parentsAndChildrenExclusive,\n      symbologyOverrides: this.getSymbologyOverrides(tree),\n      appearanceProvider: this.getAppearanceProvider(tree),\n      hiddenLineSettings: this.getHiddenLineSettings(tree),\n      animationTransformNodeId: this.getAnimationTransformNodeId(tree),\n      groupNodeId: this.getGroupNodeId(tree),\n      transformFromIModel: this.getTransformFromIModel(),\n    });\n  }\n\n  /** @beta */\n  public getTransformFromIModel(): Transform | undefined { return undefined; }\n\n  /** @internal */\n  protected getAnimationTransformNodeId(_tree: TileTree): number | undefined {\n    return undefined;\n  }\n  /** @internal */\n  protected getGroupNodeId(_tree: TileTree): number | undefined {\n    return undefined;\n  }\n\n  /** Supply transform from this tile tree reference's location to iModel coordinate space.\n   * @returns undefined if the TileTree is not yet loaded.\n   */\n  public getLocation(): Transform | undefined {\n    const tree = this.treeOwner.load();\n    return undefined !== tree ? this.computeTransform(tree) : undefined;\n  }\n\n  /** Compute a transform from this tile tree reference's coordinate space to the [[IModelConnection]]'s coordinate space. */\n  protected computeTransform(tree: TileTree): Transform {\n    return tree.iModelTransform.clone();\n  }\n\n  /** Compute the range of this tile tree's contents in world coordinates.\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.\n   */\n  public computeWorldContentRange(): ElementAlignedBox3d {\n    const range = new Range3d();\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree && !tree.rootTile.contentRange.isNull)\n      this.computeTransform(tree).multiplyRange(tree.rootTile.contentRange, range);\n\n    return range;\n  }\n\n  /** Return the clip volume applied to this reference's tile tree, if any. */\n  protected getClipVolume(tree: TileTree): RenderClipVolume | undefined {\n    return tree.clipVolume;\n  }\n\n  /** Supply overrides that should be applied to the [[ViewState]]'s [ViewFlags]($common) when drawing this tile tree reference. */\n  protected getViewFlagOverrides(tree: TileTree): ViewFlagOverrides {\n    return tree.viewFlagOverrides;\n  }\n\n  /** Return overrides that *replace* any defined for the view. */\n  protected getSymbologyOverrides(_tree: TileTree): FeatureSymbology.Overrides | undefined {\n    return undefined;\n  }\n\n  /** Return a provider that can supplement the view's symbology overrides. */\n  protected getAppearanceProvider(_tree: TileTree): FeatureAppearanceProvider | undefined {\n    return undefined;\n  }\n\n  /** Return hidden line settings to replace those defined for the view. */\n  protected getHiddenLineSettings(_tree: TileTree): HiddenLine.Settings | undefined {\n    return undefined;\n  }\n\n  /* Extend range to include transformed range of this tile tree.\n   * @internal\n   */\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, frustumPlanes?: FrustumPlanes) {\n    const tree = this.treeOwner.tileTree;\n    if (undefined === tree)\n      return;\n\n    const location = this.computeTransform(tree);\n    tree.accumulateTransformedRange(range, matrix, location, frustumPlanes);\n  }\n\n  /** @internal */\n  public getTerrainHeight(_terrainHeights: Range1d): void { }\n\n  /** Return whether the geometry exposed by this tile tree reference should cast shadows on other geometry. */\n  public get castsShadows(): boolean {\n    return true;\n  }\n\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 */\n  public get isGlobal(): boolean { return false; }\n\n  /** The [PlanarClipMaskPriority]($common) of this tile tree used to determine which tile trees contribute to a clip mask when\n   * using [PlanarClipMaskMode.Priority]($common).\n   * @beta\n   */\n  public get planarClipMaskPriority(): number { return PlanarClipMaskPriority.DesignModel; }\n\n  /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\n\n  /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div.\n   * @beta\n  */\n  public async addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return Promise.resolve(this.addLogoCards(cards, vp));\n  }\n\n  /** Create a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]].\n   * Return `undefined` if geometry collection is not supported.\n   * @see [[createGeometryTreeReference]].\n   */\n  protected _createGeometryTreeReference(_options?: GeometryTileTreeReferenceOptions): GeometryTileTreeReference | undefined {\n    return undefined;\n  }\n\n  /** If defined, supplies the implementation of [[GeometryTileTreeReference.collectTileGeometry]].\n   */\n  public collectTileGeometry?: (collector: TileGeometryCollector) => void;\n\n  /** A function that can be assigned to [[collectTileGeometry]] to enable geometry collection for references to tile trees that support geometry collection.\n   */\n  protected _collectTileGeometry(collector: TileGeometryCollector): void {\n    const tree = this.treeOwner.load();\n    switch (this.treeOwner.loadStatus) {\n      case TileTreeLoadStatus.Loaded:\n        assert(undefined !== tree);\n        tree.collectTileGeometry(collector);\n        break;\n      case TileTreeLoadStatus.Loading:\n        collector.markLoading();\n        break;\n    }\n  }\n\n  /** Obtain a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]], or\n   * undefined if geometry collection is not supported.\n   * Currently, only terrain and reality model tiles support geometry collection.\n   * @note Do not override this method - override [[_createGeometryTreeReference]] instead.\n   */\n  public createGeometryTreeReference(options?: GeometryTileTreeReferenceOptions): GeometryTileTreeReference | undefined {\n    if (this.collectTileGeometry) {\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.\n      const ref = this as GeometryTileTreeReference;\n      ref.reprojectGeometry = options?.reprojectGeometry;\n      return ref;\n    }\n\n    return this._createGeometryTreeReference(options);\n  }\n\n  /** Create a [[TileTreeReference]] that displays a pre-defined [[RenderGraphic]].\n   * The reference can be used to add dynamic content to a [[Viewport]]'s scene as a [[TiledGraphicsProvider]], as in the following example:\n   * ```ts\n   * [[include:TileTreeReference_createFromRenderGraphic]]\n   *```\n   * Or, it can be used as a [[DynamicSpatialClassifier]] to contextualize a reality model, like so:\n   * ```ts\n   * [[include:TileTreeReference_DynamicClassifier]]\n   * ```\n   * It can also be used to mask out portions of the background map or terrain via [PlanarClipMaskSettings]($common), as shown below:\n   * ```ts\n   * [[include:TileTreeReference_DynamicClipMask]]\n   * ```\n   * @beta\n   */\n  public static createFromRenderGraphic(args: RenderGraphicTileTreeArgs): TileTreeReference {\n    return tileTreeReferenceFromRenderGraphic(args);\n  }\n}\n\n/** Options for creating a [[GeometryTileTreeReference]].\n * @public\n */\nexport interface GeometryTileTreeReferenceOptions {\n  /** If set to true, tile geometry will be reprojected using the tile's reprojection transform when geometry is collected from the referenced TileTree.\n   * Currently only applies to point clouds, reality meshes, and terrain.\n   * @beta\n   */\n  reprojectGeometry?: boolean;\n}\n"]}
+{"version":3,"file":"TileTreeReference.js","sourceRoot":"","sources":["../../../src/tile/TileTreeReference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0D;AAC1D,wDAA6E;AAC7E,oDAA0J;AAO1J,yCAEoB;AAEpB;;;GAGG;AACH,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,+BAAf,eAAe,QAO1B;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAiB,CAAC,sCAAsC;IAI5E;;OAEG;IACI,iBAAiB,CAAW;IAEnC;;OAEG;IACI,cAAc,KAAI,CAAC;IAE1B;;;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;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,IAAe,IAA+C,OAAO,SAAS,CAAC,CAAC,CAAC;IAEzG;;;OAGG;IACI,gBAAgB,CAAC,IAAe;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uIAAuI;IAChI,iBAAiB,CAAC,GAAc;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,IAAe,EAAE,QAAgC,IAAiD,OAAO,SAAS,CAAC,CAAC,CAAC;IAEpJ;;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,mEAAmE;IAC5D,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,CAAC;YAClC,KAAK,6BAAkB,CAAC,SAAS,CAAC;YAClC,KAAK,6BAAkB,CAAC,OAAO;gBAC7B,OAAO,KAAK,CAAC;YACf,KAAK,6BAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,CAAC,iCAAiC;YAChD,KAAK,6BAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC;QACnC,CAAC;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,uBAAY,CAAC;YACtB,OAAO;YACP,IAAI;YACJ,GAAG,EAAE,0BAAW,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;YAChE,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YACtC,mBAAmB,EAAE,IAAI,CAAC,sBAAsB,EAAE;SACnD,CAAC,CAAC;IACL,CAAC;IAED,YAAY;IACL,sBAAsB,KAA4B,OAAO,SAAS,CAAC,CAAC,CAAC;IAE5E,gBAAgB;IACN,2BAA2B,CAAC,KAAe;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,gBAAgB;IACN,cAAc,CAAC,KAAe;QACtC,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,uBAAO,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,oCAAsB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F,kGAAkG;IAC3F,YAAY,CAAC,MAAwB,EAAE,GAAmB,IAAU,CAAC;IAE5E;;MAEE;IACK,KAAK,CAAC,eAAe,CAAC,KAAuB,EAAE,EAAkB;QACtE,4DAA4D;QAC5D,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACO,4BAA4B,CAAC,QAA2C;QAChF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;OACG;IACI,mBAAmB,CAA8C;IAExE;OACG;IACO,oBAAoB,CAAC,SAAgC;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YAClC,KAAK,6BAAkB,CAAC,MAAM;gBAC5B,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,CAAC;gBAC3B,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,6BAAkB,CAAC,OAAO;gBAC7B,SAAS,CAAC,WAAW,EAAE,CAAC;gBACxB,MAAM;QACV,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,OAA0C;QAC3E,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,0KAA0K;YAC1K,MAAM,GAAG,GAAG,IAAiC,CAAC;YAC9C,GAAG,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAC;YACnD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,uBAAuB,CAAC,IAA+B;QACnE,OAAO,IAAA,6CAAkC,EAAC,IAAI,CAAC,CAAC;IAClD,CAAC;CACF;AAvSD,8CAuSC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tiles\n */\n\nimport { assert, BeTimePoint } from \"@itwin/core-bentley\";\nimport { Matrix4d, Range1d, Range3d, Transform } from \"@itwin/core-geometry\";\nimport { ElementAlignedBox3d, FeatureAppearanceProvider, FrustumPlanes, HiddenLine, PlanarClipMaskPriority, ViewFlagOverrides } from \"@itwin/core-common\";\nimport { HitDetail } from \"../HitDetail\";\nimport { FeatureSymbology } from \"../render/FeatureSymbology\";\nimport { RenderClipVolume } from \"../render/RenderClipVolume\";\nimport { RenderMemory } from \"../render/RenderMemory\";\nimport { DecorateContext, SceneContext } from \"../ViewContext\";\nimport { ScreenViewport } from \"../Viewport\";\nimport {\n  DisclosedTileTreeSet, GeometryTileTreeReference, MapFeatureInfoOptions, MapLayerFeatureInfo, RenderGraphicTileTreeArgs, TileDrawArgs, TileGeometryCollector, TileTree, TileTreeLoadStatus, TileTreeOwner, tileTreeReferenceFromRenderGraphic,\n} from \"./internal\";\n\n/** Describes the type of graphics produced by a [[TileTreeReference]].\n * @public\n * @extensions\n */\nexport enum TileGraphicType {\n  /** Rendered behind all other geometry without depth. */\n  BackgroundMap = 0,\n  /** Rendered with normal scene graphics. */\n  Scene = 1,\n  /** Rendered in front of all other geometry. */\n  Overlay = 2,\n}\n\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\n * way of the tree's [[TileTreeOwner]].\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,\n * as a result of changing the RenderMode, or animation settings, or classification settings, etc.\n * A reference to a TileTree is typically associated with a [[ViewState]], a [[DisplayStyleState]], or a [[Viewport]].\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\n * differing levels of transparency.\n * @see [[TiledGraphicsProvider]] to supply custom [[TileTreeReference]]s to be drawn within a [[Viewport]].\n * @public\n * @extensions\n */\nexport abstract class TileTreeReference /* implements RenderMemory.Consumer */ {\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. */\n  public abstract get treeOwner(): TileTreeOwner;\n\n  /** If set to true, tile geometry will be reprojected using the tile's reprojection transform when geometry is collected from the referenced TileTree.\n   * @internal\n   */\n  public reprojectGeometry?: boolean;\n\n  /** Force a new tree owner / tile tree to be created for the current tile tree reference\n   * @internal\n   */\n  public resetTreeOwner() {}\n\n  /** Disclose *all* TileTrees use by this reference. This may include things like map tiles used for draping on terrain.\n   * Override this and call super if you have such auxiliary trees.\n   * @note Any tree *NOT* disclosed becomes a candidate for *purging* (being unloaded from memory along with all of its tiles and graphics).\n   */\n  public discloseTileTrees(trees: DisclosedTileTreeSet): void {\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree)\n      trees.add(tree);\n  }\n\n  /** Adds this reference's graphics to the scene. By default this invokes [[draw]]. */\n  public addToScene(context: SceneContext): void {\n    const args = this.createDrawArgs(context);\n    if (undefined !== args)\n      this.draw(args);\n  }\n\n  /** Adds this reference's graphics to the scene. By default this invokes [[TileTree.draw]] on the referenced TileTree, if it is loaded. */\n  public draw(args: TileDrawArgs): void {\n    args.tree.draw(args);\n  }\n\n  /** Return a tooltip describing the hit, or `undefined` if no tooltip can be supplied.\n   * If you override this method, make sure to check that `hit` represents an entity belonging to your tile tree, e.g., by checking `hit.modelId` and `hit.sourceId`.\n   * If you *don't* override this method, override [[canSupplyToolTip]] to return false.\n   * Callers who want to obtain a tooltip should prefer [[getToolTipPromise]].\n   */\n  public async getToolTip(_hit: HitDetail): Promise<HTMLElement | string | undefined> { return undefined; }\n\n  /** Return whether this TileTreeReference can supply a tooltip describing the entity represented by the specified hit.\n   * [[getToolTipPromise]] calls [[getToolTip]] if and only if `canSupplyToolTip` returns `true`.\n   * If your tile tree never supplies tooltips, override this to return `false`.\n   */\n  public canSupplyToolTip(_hit: HitDetail): boolean {\n    return true;\n  }\n\n  /** Obtain a tooltip describing the specified `hit`, or `undefined` if this tile tree reference cannot supply a tooltip for the hit. */\n  public getToolTipPromise(hit: HitDetail): Promise<HTMLElement | string | undefined> | undefined {\n    return this.canSupplyToolTip(hit) ? this.getToolTip(hit).catch(() => undefined) : undefined;\n  }\n\n  /** Optionally return a MapLayerFeatureInfo object describing the hit.].\n   * @alpha\n   */\n  public async getMapFeatureInfo(_hit: HitDetail, _options?: MapFeatureInfoOptions): Promise<MapLayerFeatureInfo[] | undefined>  { return undefined; }\n\n  /** Optionally add any decorations specific to this reference. For example, map tile trees may add a logo image and/or copyright attributions.\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.\n   */\n  public decorate(_context: DecorateContext): void { }\n\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.\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.\n   */\n  public unionFitRange(union: Range3d): void {\n    const contentRange = this.computeWorldContentRange();\n    if (!contentRange.isNull)\n      union.extendRange(contentRange);\n  }\n\n  /** Record graphics memory consumed by this tile tree reference. */\n  public collectStatistics(stats: RenderMemory.Statistics): void {\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree)\n      tree.collectStatistics(stats);\n  }\n\n  /** Return true if the tile tree is fully loaded and ready to draw.\n   * The default implementation returns true if the tile tree loading process completed (whether it resulted in success or failure).\n   * @note Do *not* override this property - override [[_isLoadingComplete]] instead..\n   * @public\n   */\n  public get isLoadingComplete(): boolean {\n    switch (this.treeOwner.loadStatus) {\n      case TileTreeLoadStatus.NotLoaded:\n      case TileTreeLoadStatus.Loading:\n        return false;\n      case TileTreeLoadStatus.NotFound:\n        return true; // we tried, and failed, to load.\n      case TileTreeLoadStatus.Loaded:\n        return this._isLoadingComplete;\n    }\n  }\n\n  /** Override if additional asynchronous loading is required after the tile tree is successfully loaded, to indicate when that loading has completed.\n   * @public\n   */\n  protected get _isLoadingComplete(): boolean {\n    return true;\n  }\n\n  /** Create context for drawing the tile tree, if it is ready for drawing.\n   * TileTreeReferences can override individual portions of the context, e.g. apply their own transform.\n   * Returns undefined if, e.g., the tile tree is not yet loaded.\n   */\n  public createDrawArgs(context: SceneContext): TileDrawArgs | undefined {\n    const tree = this.treeOwner.load();\n    if (undefined === tree)\n      return undefined;\n\n    return new TileDrawArgs({\n      context,\n      tree,\n      now: BeTimePoint.now(),\n      location: this.computeTransform(tree),\n      viewFlagOverrides: this.getViewFlagOverrides(tree),\n      clipVolume: this.getClipVolume(tree),\n      parentsAndChildrenExclusive: tree.parentsAndChildrenExclusive,\n      symbologyOverrides: this.getSymbologyOverrides(tree),\n      appearanceProvider: this.getAppearanceProvider(tree),\n      hiddenLineSettings: this.getHiddenLineSettings(tree),\n      animationTransformNodeId: this.getAnimationTransformNodeId(tree),\n      groupNodeId: this.getGroupNodeId(tree),\n      transformFromIModel: this.getTransformFromIModel(),\n    });\n  }\n\n  /** @beta */\n  public getTransformFromIModel(): Transform | undefined { return undefined; }\n\n  /** @internal */\n  protected getAnimationTransformNodeId(_tree: TileTree): number | undefined {\n    return undefined;\n  }\n  /** @internal */\n  protected getGroupNodeId(_tree: TileTree): number | undefined {\n    return undefined;\n  }\n\n  /** Supply transform from this tile tree reference's location to iModel coordinate space.\n   * @returns undefined if the TileTree is not yet loaded.\n   */\n  public getLocation(): Transform | undefined {\n    const tree = this.treeOwner.load();\n    return undefined !== tree ? this.computeTransform(tree) : undefined;\n  }\n\n  /** Compute a transform from this tile tree reference's coordinate space to the [[IModelConnection]]'s coordinate space. */\n  protected computeTransform(tree: TileTree): Transform {\n    return tree.iModelTransform.clone();\n  }\n\n  /** Compute the range of this tile tree's contents in world coordinates.\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.\n   */\n  public computeWorldContentRange(): ElementAlignedBox3d {\n    const range = new Range3d();\n    const tree = this.treeOwner.tileTree;\n    if (undefined !== tree && !tree.rootTile.contentRange.isNull)\n      this.computeTransform(tree).multiplyRange(tree.rootTile.contentRange, range);\n\n    return range;\n  }\n\n  /** Return the clip volume applied to this reference's tile tree, if any. */\n  protected getClipVolume(tree: TileTree): RenderClipVolume | undefined {\n    return tree.clipVolume;\n  }\n\n  /** Supply overrides that should be applied to the [[ViewState]]'s [ViewFlags]($common) when drawing this tile tree reference. */\n  protected getViewFlagOverrides(tree: TileTree): ViewFlagOverrides {\n    return tree.viewFlagOverrides;\n  }\n\n  /** Return overrides that *replace* any defined for the view. */\n  protected getSymbologyOverrides(_tree: TileTree): FeatureSymbology.Overrides | undefined {\n    return undefined;\n  }\n\n  /** Return a provider that can supplement the view's symbology overrides. */\n  protected getAppearanceProvider(_tree: TileTree): FeatureAppearanceProvider | undefined {\n    return undefined;\n  }\n\n  /** Return hidden line settings to replace those defined for the view. */\n  protected getHiddenLineSettings(_tree: TileTree): HiddenLine.Settings | undefined {\n    return undefined;\n  }\n\n  /* Extend range to include transformed range of this tile tree.\n   * @internal\n   */\n  public accumulateTransformedRange(range: Range3d, matrix: Matrix4d, frustumPlanes?: FrustumPlanes) {\n    const tree = this.treeOwner.tileTree;\n    if (undefined === tree)\n      return;\n\n    const location = this.computeTransform(tree);\n    tree.accumulateTransformedRange(range, matrix, location, frustumPlanes);\n  }\n\n  /** @internal */\n  public getTerrainHeight(_terrainHeights: Range1d): void { }\n\n  /** Return whether the geometry exposed by this tile tree reference should cast shadows on other geometry. */\n  public get castsShadows(): boolean {\n    return true;\n  }\n\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 */\n  public get isGlobal(): boolean { return false; }\n\n  /** The [PlanarClipMaskPriority]($common) of this tile tree used to determine which tile trees contribute to a clip mask when\n   * using [PlanarClipMaskMode.Priority]($common).\n   * @beta\n   */\n  public get planarClipMaskPriority(): number { return PlanarClipMaskPriority.DesignModel; }\n\n  /** @deprecated in 5.0 - might be removed in next major version. Use [addAttributions] instead. */\n  public addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void { }\n\n  /** Add attribution logo cards for the tile tree source logo cards to the viewport's logo div.\n   * @beta\n  */\n  public async addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return Promise.resolve(this.addLogoCards(cards, vp));\n  }\n\n  /** Create a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]].\n   * Return `undefined` if geometry collection is not supported.\n   * @see [[createGeometryTreeReference]].\n   */\n  protected _createGeometryTreeReference(_options?: GeometryTileTreeReferenceOptions): GeometryTileTreeReference | undefined {\n    return undefined;\n  }\n\n  /** If defined, supplies the implementation of [[GeometryTileTreeReference.collectTileGeometry]].\n   */\n  public collectTileGeometry?: (collector: TileGeometryCollector) => void;\n\n  /** A function that can be assigned to [[collectTileGeometry]] to enable geometry collection for references to tile trees that support geometry collection.\n   */\n  protected _collectTileGeometry(collector: TileGeometryCollector): void {\n    const tree = this.treeOwner.load();\n    switch (this.treeOwner.loadStatus) {\n      case TileTreeLoadStatus.Loaded:\n        assert(undefined !== tree);\n        tree.collectTileGeometry(collector);\n        break;\n      case TileTreeLoadStatus.Loading:\n        collector.markLoading();\n        break;\n    }\n  }\n\n  /** Obtain a tile tree reference equivalent to this one that also supplies an implementation of [[GeometryTileTreeReference.collectTileGeometry]], or\n   * undefined if geometry collection is not supported.\n   * Currently, only terrain and reality model tiles support geometry collection.\n   * @note Do not override this method - override [[_createGeometryTreeReference]] instead.\n   */\n  public createGeometryTreeReference(options?: GeometryTileTreeReferenceOptions): GeometryTileTreeReference | undefined {\n    if (this.collectTileGeometry) {\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.\n      const ref = this as GeometryTileTreeReference;\n      ref.reprojectGeometry = options?.reprojectGeometry;\n      return ref;\n    }\n\n    return this._createGeometryTreeReference(options);\n  }\n\n  /** Create a [[TileTreeReference]] that displays a pre-defined [[RenderGraphic]].\n   * The reference can be used to add dynamic content to a [[Viewport]]'s scene as a [[TiledGraphicsProvider]], as in the following example:\n   * ```ts\n   * [[include:TileTreeReference_createFromRenderGraphic]]\n   *```\n   * Or, it can be used as a [[DynamicSpatialClassifier]] to contextualize a reality model, like so:\n   * ```ts\n   * [[include:TileTreeReference_DynamicClassifier]]\n   * ```\n   * It can also be used to mask out portions of the background map or terrain via [PlanarClipMaskSettings]($common), as shown below:\n   * ```ts\n   * [[include:TileTreeReference_DynamicClipMask]]\n   * ```\n   * @beta\n   */\n  public static createFromRenderGraphic(args: RenderGraphicTileTreeArgs): TileTreeReference {\n    return tileTreeReferenceFromRenderGraphic(args);\n  }\n}\n\n/** Options for creating a [[GeometryTileTreeReference]].\n * @public\n */\nexport interface GeometryTileTreeReferenceOptions {\n  /** If set to true, tile geometry will be reprojected using the tile's reprojection transform when geometry is collected from the referenced TileTree.\n   * Currently only applies to point clouds, reality meshes, and terrain.\n   * @beta\n   */\n  reprojectGeometry?: boolean;\n}\n"]}

package/lib/cjs/tile/map/BingElevation.d.ts

@@ -6,6 +6,9 @@ import { Point3d, Range1d, Range2d } from "@itwin/core-geometry";
  * passed to [[IModelApp.startup]].
  * @public
  * @extensions
+ * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Provide an [[ElevationProvider]] and [[GeoidProvider]] implementation via [[IModelAppOptions.geospatialProviders]].
+ * @note This class structurally satisfies both [[ElevationProvider]] and [[GeoidProvider]] but does not use an explicit
+ * `implements` clause because api-extractor forbids `@public` classes from referencing `@beta` interfaces (ae-incompatible-release-tags).
  */
 export declare class BingElevationProvider {
     private _heightRangeRequestTemplate;
@@ -17,25 +20,34 @@ export declare class BingElevationProvider {
      * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then the sea level height id returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).
      * @public
      */
-    getHeight(carto: Cartographic, geodetic?: boolean): Promise<any>;
+    getHeight(carto: Cartographic, geodetic?: boolean): Promise<number>;
     /** Returns 256 elevations in the specified range - 16 rows and 16 columns.
      * The elevations are ordered starting with the southwest corner, then proceeding west to east and south to north.
      * @beta
      */
     getHeights(range: Range2d): Promise<number[] | undefined>;
-    /** @internal */
+    /** Return the offset from geodetic height to sea level height at the given cartographic location.
+     * @note Satisfies [[GeoidProvider]] structurally.
+     * @internal
+     */
+    getGeodeticToSeaLevelOffset(carto: Cartographic): Promise<number>;
+    /** @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use the Cartographic overload instead.
+     * @internal
+     */
     getGeodeticToSeaLevelOffset(point: Point3d, iModel: IModelConnection): Promise<number>;
     /** Get the height (altitude) at a given iModel coordinate.  The height is geodetic (WGS84 ellipsoid)
-     * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).
-     *
+     * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5').
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use [[ElevationProvider.getHeight]] via [[IModelApp.elevationProvider]] instead.
      * @public
      */
     getHeightValue(point: Point3d, iModel: IModelConnection, geodetic?: boolean): Promise<number>;
     /** Get the height (altitude) range for a given iModel project extents. The height values are  geodetic (WGS84 ellipsoid).
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightRange]] function instead.
      * @public
      */
     getHeightRange(iModel: IModelConnection): Promise<Range1d>;
     /** Get the average height (altitude) for a given iModel project extents.  The height values are geodetic (WGS84 ellipsoid).
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightAverage]] function instead.
      * @public
      */
     getHeightAverage(iModel: IModelConnection): Promise<number>;

package/lib/cjs/tile/map/BingElevation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BingElevation.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/BingElevation.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIjE;;;;;GAKG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,2BAA2B,CAAS;IAC5C,OAAO,CAAC,8BAA8B,CAAS;IAC/C,OAAO,CAAC,0BAA0B,CAAS;IAE3C,cAAc;;IAiBd;;;OAGG;IACU,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,UAAO;IAiB3D;;;OAGG;IACU,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;IAYtE,gBAAgB;IACH,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAanG;;;;OAIG;IACU,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,UAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvG;;OAEG;IACU,cAAc,CAAC,MAAM,EAAE,gBAAgB;IAepD;;OAEG;IACU,gBAAgB,CAAC,MAAM,EAAE,gBAAgB;CAiBvD"}
+{"version":3,"file":"BingElevation.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/BingElevation.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIjE;;;;;;;;GAQG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,2BAA2B,CAAS;IAC5C,OAAO,CAAC,8BAA8B,CAAS;IAC/C,OAAO,CAAC,0BAA0B,CAAS;IAE3C,cAAc;;IAkBd;;;OAGG;IACU,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,UAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAiB7E;;;OAGG;IACU,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;IAYtE;;;OAGG;IACU,2BAA2B,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9E;;OAEG;IACU,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnG;;;;OAIG;IACU,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,UAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvG;;;OAGG;IACU,cAAc,CAAC,MAAM,EAAE,gBAAgB;IAepD;;;OAGG;IACU,gBAAgB,CAAC,MAAM,EAAE,gBAAgB;CAiBvD"}

package/lib/cjs/tile/map/BingElevation.js

@@ -10,6 +10,7 @@ exports.BingElevationProvider = void 0;
  */
 const Request_1 = require("../../request/Request");
 const IModelApp_1 = require("../../IModelApp");
+const core_common_1 = require("@itwin/core-common");
 const core_geometry_1 = require("@itwin/core-geometry");
 // cspell:ignore atae qdng uyzv auje sealevel
 /** Provides an interface to the [Bing Maps elevation services](https://docs.microsoft.com/en-us/bingmaps/rest-services/elevations/).
@@ -17,6 +18,9 @@ const core_geometry_1 = require("@itwin/core-geometry");
  * passed to [[IModelApp.startup]].
  * @public
  * @extensions
+ * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Provide an [[ElevationProvider]] and [[GeoidProvider]] implementation via [[IModelAppOptions.geospatialProviders]].
+ * @note This class structurally satisfies both [[ElevationProvider]] and [[GeoidProvider]] but does not use an explicit
+ * `implements` clause because api-extractor forbids `@public` classes from referencing `@beta` interfaces (ae-incompatible-release-tags).
  */
 class BingElevationProvider {
     _heightRangeRequestTemplate;
@@ -25,8 +29,9 @@ class BingElevationProvider {
     /** @public */
     constructor() {
         let bingKey = "";
+        // eslint-disable-next-line @typescript-eslint/no-deprecated -- this deprecated class reads from the deprecated BingMaps key by design
         if (IModelApp_1.IModelApp.mapLayerFormatRegistry.configOptions.BingMaps)
-            bingKey = IModelApp_1.IModelApp.mapLayerFormatRegistry.configOptions.BingMaps.value;
+            bingKey = IModelApp_1.IModelApp.mapLayerFormatRegistry.configOptions.BingMaps.value; // eslint-disable-line @typescript-eslint/no-deprecated
         this._heightRangeRequestTemplate =
             "https://dev.virtualearth.net/REST/v1/Elevation/Bounds?bounds={boundingBox}&rows=16&cols=16&heights=ellipsoid&key={BingMapsAPIKey}"
                 .replace("{BingMapsAPIKey}", bingKey);
@@ -70,11 +75,14 @@ class BingElevationProvider {
             return undefined;
         }
     }
-    /** @internal */
-    async getGeodeticToSeaLevelOffset(point, iModel) {
-        const carto = iModel.spatialToCartographicFromEcef(point);
-        if (carto === undefined)
-            return 0.0;
+    async getGeodeticToSeaLevelOffset(pointOrCarto, iModel) {
+        let carto;
+        if (pointOrCarto instanceof core_common_1.Cartographic) {
+            carto = pointOrCarto;
+        }
+        else {
+            carto = iModel.spatialToCartographicFromEcef(pointOrCarto);
+        }
         const requestUrl = this._seaLevelOffsetRequestTemplate.replace("{points}", `${carto.latitudeDegrees},${carto.longitudeDegrees}`);
         try {
             const tileResponseBody = await (0, Request_1.request)(requestUrl, "json");
@@ -85,14 +93,15 @@ class BingElevationProvider {
         }
     }
     /** Get the height (altitude) at a given iModel coordinate.  The height is geodetic (WGS84 ellipsoid)
-     * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).
-     *
+     * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5').
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use [[ElevationProvider.getHeight]] via [[IModelApp.elevationProvider]] instead.
      * @public
      */
     async getHeightValue(point, iModel, geodetic = true) {
         return this.getHeight(iModel.spatialToCartographicFromEcef(point), geodetic);
     }
     /** Get the height (altitude) range for a given iModel project extents. The height values are  geodetic (WGS84 ellipsoid).
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightRange]] function instead.
      * @public
      */
     async getHeightRange(iModel) {
@@ -108,6 +117,7 @@ class BingElevationProvider {
         return heights ? core_geometry_1.Range1d.createArray(heights) : core_geometry_1.Range1d.createNull();
     }
     /** Get the average height (altitude) for a given iModel project extents.  The height values are geodetic (WGS84 ellipsoid).
+     * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightAverage]] function instead.
      * @public
      */
     async getHeightAverage(iModel) {

package/lib/cjs/tile/map/BingElevation.js.map

@@ -1 +1 @@
-{"version":3,"file":"BingElevation.js","sourceRoot":"","sources":["../../../../src/tile/map/BingElevation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,mDAAgD;AAChD,+CAA4C;AAG5C,wDAAiE;AAEjE,6CAA6C;AAE7C;;;;;GAKG;AACH,MAAa,qBAAqB;IACxB,2BAA2B,CAAS;IACpC,8BAA8B,CAAS;IACvC,0BAA0B,CAAS;IAE3C,cAAc;IACd;QACE,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,qBAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,QAAQ;YACzD,OAAO,GAAG,qBAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;QAE1E,IAAI,CAAC,2BAA2B;YAC9B,mIAAmI;iBAChI,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,8BAA8B;YACjC,8FAA8F;iBAC3F,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,0BAA0B;YAC7B,4GAA4G;iBACzG,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,KAAmB,EAAE,QAAQ,GAAG,IAAI;QACzD,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QAEb,MAAM,UAAU,GACd,IAAI,CAAC,0BAA0B;aAC5B,OAAO,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;aACzE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,KAAc;QACpC,MAAM,WAAW,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACpF,MAAM,UAAU,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAE1F,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,2BAA2B,CAAC,KAAc,EAAE,MAAwB;QAC/E,MAAM,KAAK,GAAG,MAAM,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,GAAG,CAAC;QAEb,MAAM,UAAU,GAAG,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACjI,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,KAAc,EAAE,MAAwB,EAAE,QAAQ,GAAG,IAAI;QACnF,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,MAAwB;QAClD,MAAM,YAAY,GAAG,uBAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5C,mCAAmC;QACnC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,MAAM,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAC3D,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,CAAC,CAAC,uBAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,uBAAO,CAAC,UAAU,EAAE,CAAC;IACvE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAwB;QACpD,MAAM,YAAY,GAAG,uBAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,MAAM,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAC3D,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;YAC7B,OAAO,CAAC,CAAC;QAEX,IAAI,KAAK,GAAG,GAAG,CAAC;QAChB,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,KAAK,IAAI,MAAM,CAAC;QAElB,OAAO,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAChC,CAAC;CACF;AAxHD,sDAwHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Tiles\n */\nimport { request } from \"../../request/Request\";\nimport { IModelApp } from \"../../IModelApp\";\nimport { IModelConnection } from \"../../IModelConnection\";\nimport { Cartographic } from \"@itwin/core-common\";\nimport { Point3d, Range1d, Range2d } from \"@itwin/core-geometry\";\n\n// cspell:ignore atae qdng uyzv auje sealevel\n\n/** Provides an interface to the [Bing Maps elevation services](https://docs.microsoft.com/en-us/bingmaps/rest-services/elevations/).\n * Use of these services requires an API key to be supplied via [[MapLayerOptions.BingMaps]] in the [[IModelAppOptions.mapLayerOptions]]\n * passed to [[IModelApp.startup]].\n * @public\n * @extensions\n */\nexport class BingElevationProvider {\n  private _heightRangeRequestTemplate: string;\n  private _seaLevelOffsetRequestTemplate: string;\n  private _heightListRequestTemplate: string;\n\n  /** @public */\n  constructor() {\n    let bingKey = \"\";\n    if (IModelApp.mapLayerFormatRegistry.configOptions.BingMaps)\n      bingKey = IModelApp.mapLayerFormatRegistry.configOptions.BingMaps.value;\n\n    this._heightRangeRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/Bounds?bounds={boundingBox}&rows=16&cols=16&heights=ellipsoid&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n    this._seaLevelOffsetRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/SeaLevel?points={points}&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n    this._heightListRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/List?points={points}&heights={heights}&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n  }\n\n  /** Return the height (altitude) at a given cartographic location.\n   * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then the sea level height id returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).\n   * @public\n   */\n  public async getHeight(carto: Cartographic, geodetic = true) {\n    if (undefined === carto)\n      return 0.0;\n\n    const requestUrl =\n      this._heightListRequestTemplate\n        .replace(\"{points}\", `${carto.latitudeDegrees},${carto.longitudeDegrees}`)\n        .replace(\"{heights}\", geodetic ? \"ellipsoid\" : \"sealevel\");\n\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].elevations[0];\n    } catch {\n      return 0.0;\n    }\n  }\n\n  /** Returns 256 elevations in the specified range - 16 rows and 16 columns.\n   * The elevations are ordered starting with the southwest corner, then proceeding west to east and south to north.\n   * @beta\n   */\n  public async getHeights(range: Range2d): Promise<number[] | undefined> {\n    const boundingBox = `${range.low.y},${range.low.x},${range.high.y},${range.high.x}`;\n    const requestUrl = this._heightRangeRequestTemplate.replace(\"{boundingBox}\", boundingBox);\n\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].elevations;\n    } catch {\n      return undefined;\n    }\n  }\n\n  /** @internal */\n  public async getGeodeticToSeaLevelOffset(point: Point3d, iModel: IModelConnection): Promise<number> {\n    const carto = iModel.spatialToCartographicFromEcef(point);\n    if (carto === undefined)\n      return 0.0;\n\n    const requestUrl = this._seaLevelOffsetRequestTemplate.replace(\"{points}\", `${carto.latitudeDegrees},${carto.longitudeDegrees}`);\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].offsets[0];\n    } catch {\n      return 0.0;\n    }\n  }\n  /** Get the height (altitude) at a given iModel coordinate.  The height is geodetic (WGS84 ellipsoid)\n   * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).\n   *\n   * @public\n   */\n  public async getHeightValue(point: Point3d, iModel: IModelConnection, geodetic = true): Promise<number> {\n    return this.getHeight(iModel.spatialToCartographicFromEcef(point), geodetic);\n  }\n\n  /** Get the height (altitude) range for a given iModel project extents. The height values are  geodetic (WGS84 ellipsoid).\n   * @public\n   */\n  public async getHeightRange(iModel: IModelConnection) {\n    const latLongRange = Range2d.createNull();\n    const range = iModel.projectExtents.clone();\n\n    // Expand for project surroundings.\n    range.expandInPlace(1000);\n    for (const corner of range.corners()) {\n      const carto = iModel.spatialToCartographicFromEcef(corner);\n      latLongRange.extendXY(carto.longitudeDegrees, carto.latitudeDegrees);\n    }\n\n    const heights = await this.getHeights(latLongRange);\n    return heights ? Range1d.createArray(heights) : Range1d.createNull();\n  }\n\n  /** Get the average height (altitude) for a given iModel project extents.  The height values are geodetic (WGS84 ellipsoid).\n   * @public\n   */\n  public async getHeightAverage(iModel: IModelConnection) {\n    const latLongRange = Range2d.createNull();\n    for (const corner of iModel.projectExtents.corners()) {\n      const carto = iModel.spatialToCartographicFromEcef(corner);\n      latLongRange.extendXY(carto.longitudeDegrees, carto.latitudeDegrees);\n    }\n\n    const heights = await this.getHeights(latLongRange);\n    if (!heights || !heights.length)\n      return 0;\n\n    let total = 0.0;\n    for (const height of heights)\n      total += height;\n\n    return total / heights.length;\n  }\n}\n"]}
+{"version":3,"file":"BingElevation.js","sourceRoot":"","sources":["../../../../src/tile/map/BingElevation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,mDAAgD;AAChD,+CAA4C;AAE5C,oDAAkD;AAClD,wDAAiE;AAEjE,6CAA6C;AAE7C;;;;;;;;GAQG;AACH,MAAa,qBAAqB;IACxB,2BAA2B,CAAS;IACpC,8BAA8B,CAAS;IACvC,0BAA0B,CAAS;IAE3C,cAAc;IACd;QACE,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,sIAAsI;QACtI,IAAI,qBAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,QAAQ;YACzD,OAAO,GAAG,qBAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,uDAAuD;QAElI,IAAI,CAAC,2BAA2B;YAC9B,mIAAmI;iBAChI,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,8BAA8B;YACjC,8FAA8F;iBAC3F,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,0BAA0B;YAC7B,4GAA4G;iBACzG,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,KAAmB,EAAE,QAAQ,GAAG,IAAI;QACzD,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QAEb,MAAM,UAAU,GACd,IAAI,CAAC,0BAA0B;aAC5B,OAAO,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;aACzE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,KAAc;QACpC,MAAM,WAAW,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACpF,MAAM,UAAU,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAE1F,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAWM,KAAK,CAAC,2BAA2B,CAAC,YAAoC,EAAE,MAAyB;QACtG,IAAI,KAAmB,CAAC;QACxB,IAAI,YAAY,YAAY,0BAAY,EAAE,CAAC;YACzC,KAAK,GAAG,YAAY,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,MAAO,CAAC,6BAA6B,CAAC,YAAY,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACjI,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,IAAA,iBAAO,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,OAAO,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,KAAc,EAAE,MAAwB,EAAE,QAAQ,GAAG,IAAI;QACnF,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAC,MAAwB;QAClD,MAAM,YAAY,GAAG,uBAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5C,mCAAmC;QACnC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,MAAM,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAC3D,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,CAAC,CAAC,uBAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,uBAAO,CAAC,UAAU,EAAE,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAwB;QACpD,MAAM,YAAY,GAAG,uBAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,MAAM,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAC3D,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;YAC7B,OAAO,CAAC,CAAC;QAEX,IAAI,KAAK,GAAG,GAAG,CAAC;QAChB,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,KAAK,IAAI,MAAM,CAAC;QAElB,OAAO,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAChC,CAAC;CACF;AAtID,sDAsIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Tiles\n */\nimport { request } from \"../../request/Request\";\nimport { IModelApp } from \"../../IModelApp\";\nimport { IModelConnection } from \"../../IModelConnection\";\nimport { Cartographic } from \"@itwin/core-common\";\nimport { Point3d, Range1d, Range2d } from \"@itwin/core-geometry\";\n\n// cspell:ignore atae qdng uyzv auje sealevel\n\n/** Provides an interface to the [Bing Maps elevation services](https://docs.microsoft.com/en-us/bingmaps/rest-services/elevations/).\n * Use of these services requires an API key to be supplied via [[MapLayerOptions.BingMaps]] in the [[IModelAppOptions.mapLayerOptions]]\n * passed to [[IModelApp.startup]].\n * @public\n * @extensions\n * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Provide an [[ElevationProvider]] and [[GeoidProvider]] implementation via [[IModelAppOptions.geospatialProviders]].\n * @note This class structurally satisfies both [[ElevationProvider]] and [[GeoidProvider]] but does not use an explicit\n * `implements` clause because api-extractor forbids `@public` classes from referencing `@beta` interfaces (ae-incompatible-release-tags).\n */\nexport class BingElevationProvider {\n  private _heightRangeRequestTemplate: string;\n  private _seaLevelOffsetRequestTemplate: string;\n  private _heightListRequestTemplate: string;\n\n  /** @public */\n  constructor() {\n    let bingKey = \"\";\n    // eslint-disable-next-line @typescript-eslint/no-deprecated -- this deprecated class reads from the deprecated BingMaps key by design\n    if (IModelApp.mapLayerFormatRegistry.configOptions.BingMaps)\n      bingKey = IModelApp.mapLayerFormatRegistry.configOptions.BingMaps.value; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    this._heightRangeRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/Bounds?bounds={boundingBox}&rows=16&cols=16&heights=ellipsoid&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n    this._seaLevelOffsetRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/SeaLevel?points={points}&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n    this._heightListRequestTemplate =\n      \"https://dev.virtualearth.net/REST/v1/Elevation/List?points={points}&heights={heights}&key={BingMapsAPIKey}\"\n        .replace(\"{BingMapsAPIKey}\", bingKey);\n  }\n\n  /** Return the height (altitude) at a given cartographic location.\n   * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then the sea level height id returned using the Earth Gravitational Model 2008 (EGM2008 2.5’).\n   * @public\n   */\n  public async getHeight(carto: Cartographic, geodetic = true): Promise<number> {\n    if (undefined === carto)\n      return 0.0;\n\n    const requestUrl =\n      this._heightListRequestTemplate\n        .replace(\"{points}\", `${carto.latitudeDegrees},${carto.longitudeDegrees}`)\n        .replace(\"{heights}\", geodetic ? \"ellipsoid\" : \"sealevel\");\n\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].elevations[0];\n    } catch {\n      return 0.0;\n    }\n  }\n\n  /** Returns 256 elevations in the specified range - 16 rows and 16 columns.\n   * The elevations are ordered starting with the southwest corner, then proceeding west to east and south to north.\n   * @beta\n   */\n  public async getHeights(range: Range2d): Promise<number[] | undefined> {\n    const boundingBox = `${range.low.y},${range.low.x},${range.high.y},${range.high.x}`;\n    const requestUrl = this._heightRangeRequestTemplate.replace(\"{boundingBox}\", boundingBox);\n\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].elevations;\n    } catch {\n      return undefined;\n    }\n  }\n\n  /** Return the offset from geodetic height to sea level height at the given cartographic location.\n   * @note Satisfies [[GeoidProvider]] structurally.\n   * @internal\n   */\n  public async getGeodeticToSeaLevelOffset(carto: Cartographic): Promise<number>;\n  /** @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use the Cartographic overload instead.\n   * @internal\n   */\n  public async getGeodeticToSeaLevelOffset(point: Point3d, iModel: IModelConnection): Promise<number>;\n  public async getGeodeticToSeaLevelOffset(pointOrCarto: Point3d | Cartographic, iModel?: IModelConnection): Promise<number> {\n    let carto: Cartographic;\n    if (pointOrCarto instanceof Cartographic) {\n      carto = pointOrCarto;\n    } else {\n      carto = iModel!.spatialToCartographicFromEcef(pointOrCarto);\n    }\n\n    const requestUrl = this._seaLevelOffsetRequestTemplate.replace(\"{points}\", `${carto.latitudeDegrees},${carto.longitudeDegrees}`);\n    try {\n      const tileResponseBody = await request(requestUrl, \"json\");\n      return tileResponseBody.resourceSets[0].resources[0].offsets[0];\n    } catch {\n      return 0.0;\n    }\n  }\n  /** Get the height (altitude) at a given iModel coordinate.  The height is geodetic (WGS84 ellipsoid)\n   * If geodetic is true (the default) then height is returned in the Ellipsoidal WGS84 datum.  If geodetic is false then sea level height is returned using the Earth Gravitational Model 2008 (EGM2008 2.5').\n   * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use [[ElevationProvider.getHeight]] via [[IModelApp.elevationProvider]] instead.\n   * @public\n   */\n  public async getHeightValue(point: Point3d, iModel: IModelConnection, geodetic = true): Promise<number> {\n    return this.getHeight(iModel.spatialToCartographicFromEcef(point), geodetic);\n  }\n\n  /** Get the height (altitude) range for a given iModel project extents. The height values are  geodetic (WGS84 ellipsoid).\n   * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightRange]] function instead.\n   * @public\n   */\n  public async getHeightRange(iModel: IModelConnection) {\n    const latLongRange = Range2d.createNull();\n    const range = iModel.projectExtents.clone();\n\n    // Expand for project surroundings.\n    range.expandInPlace(1000);\n    for (const corner of range.corners()) {\n      const carto = iModel.spatialToCartographicFromEcef(corner);\n      latLongRange.extendXY(carto.longitudeDegrees, carto.latitudeDegrees);\n    }\n\n    const heights = await this.getHeights(latLongRange);\n    return heights ? Range1d.createArray(heights) : Range1d.createNull();\n  }\n\n  /** Get the average height (altitude) for a given iModel project extents.  The height values are geodetic (WGS84 ellipsoid).\n   * @deprecated in 5.11.0 - will not be removed until after 2027-07-03. Use standalone [[getHeightAverage]] function instead.\n   * @public\n   */\n  public async getHeightAverage(iModel: IModelConnection) {\n    const latLongRange = Range2d.createNull();\n    for (const corner of iModel.projectExtents.corners()) {\n      const carto = iModel.spatialToCartographicFromEcef(corner);\n      latLongRange.extendXY(carto.longitudeDegrees, carto.latitudeDegrees);\n    }\n\n    const heights = await this.getHeights(latLongRange);\n    if (!heights || !heights.length)\n      return 0;\n\n    let total = 0.0;\n    for (const height of heights)\n      total += height;\n\n    return total / heights.length;\n  }\n}\n"]}

package/lib/cjs/tile/map/CesiumTerrainProvider.d.ts

@@ -1,10 +1,25 @@
+/** @packageDocumentation
+ * @module Tiles
+ */
+import { BeDuration } from "@itwin/core-bentley";
+import { CesiumAccessClient } from "../../CesiumAccessClient";
 import { TerrainMeshProvider, TerrainMeshProviderOptions } from "../internal";
-/** Return the URL for a Cesium ion asset from its asset ID and request Key.
+/** Return the URL for a Cesium Ion asset from its asset ID and request Key.
  * @public
  */
 export declare function getCesiumAssetUrl(osmAssetId: number, requestKey: string): string;
 /** @internal */
 export declare function getCesiumOSMBuildingsUrl(): string | undefined;
+/** Returns the registered [[CesiumAccessClient]], or a default [[CesiumIonClient]] if none is registered.
+ * @internal
+ */
+export declare function getCesiumAccessClient(): CesiumAccessClient;
+/** Compute when to next re-resolve a Cesium access token. Honors the endpoint's `expiresAt` when it is a valid
+ * future time, but guards against an invalid (NaN) date - which would otherwise disable refresh entirely - and
+ * against a past/imminent expiry that would re-resolve the endpoint on essentially every tile read.
+ * @internal
+ */
+export declare function computeCesiumTokenTimeoutInterval(expiresAt: Date | undefined): BeDuration;
 /** @internal */
 export declare function getCesiumAccessTokenAndEndpointUrl(assetId: string, requestKey?: string): Promise<{
     token?: string;

package/lib/cjs/tile/map/CesiumTerrainProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CesiumTerrainProvider.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/CesiumTerrainProvider.ts"],"names":[],"mappings":"AAgBA,OAAO,EACwF,mBAAmB,EAChH,0BAA0B,EAC3B,MAAM,aAAa,CAAC;AAUrB;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAEhF;AAED,gBAAgB;AAChB,wBAAgB,wBAAwB,IAAI,MAAM,GAAG,SAAS,CAM7D;AAED,gBAAgB;AAChB,wBAAsB,kCAAkC,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBxI;AAaD,gBAAgB;AAChB,wBAAsB,wBAAwB,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAiDzH"}
+{"version":3,"file":"CesiumTerrainProvider.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/CesiumTerrainProvider.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,EAAU,UAAU,EAAgE,MAAM,qBAAqB,CAAC;AAMvH,OAAO,EAAE,kBAAkB,EAAuB,MAAM,0BAA0B,CAAC;AAGnF,OAAO,EACwF,mBAAmB,EAChH,0BAA0B,EAC3B,MAAM,aAAa,CAAC;AAUrB;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAEhF;AAED,gBAAgB;AAChB,wBAAgB,wBAAwB,IAAI,MAAM,GAAG,SAAS,CAK7D;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,kBAAkB,CAE1D;AAKD;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,SAAS,EAAE,IAAI,GAAG,SAAS,GAAG,UAAU,CASzF;AAED,gBAAgB;AAChB,wBAAsB,kCAAkC,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBxI;AAaD,gBAAgB;AAChB,wBAAsB,wBAAwB,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAsDzH"}

package/lib/cjs/tile/map/CesiumTerrainProvider.js

@@ -6,6 +6,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCesiumAssetUrl = getCesiumAssetUrl;
 exports.getCesiumOSMBuildingsUrl = getCesiumOSMBuildingsUrl;
+exports.getCesiumAccessClient = getCesiumAccessClient;
+exports.computeCesiumTokenTimeoutInterval = computeCesiumTokenTimeoutInterval;
 exports.getCesiumAccessTokenAndEndpointUrl = getCesiumAccessTokenAndEndpointUrl;
 exports.getCesiumTerrainProvider = getCesiumTerrainProvider;
 /** @packageDocumentation
@@ -27,7 +29,7 @@ var QuantizedMeshExtensionIds;
     QuantizedMeshExtensionIds[QuantizedMeshExtensionIds["WaterMask"] = 2] = "WaterMask";
     QuantizedMeshExtensionIds[QuantizedMeshExtensionIds["Metadata"] = 4] = "Metadata";
 })(QuantizedMeshExtensionIds || (QuantizedMeshExtensionIds = {}));
-/** Return the URL for a Cesium ion asset from its asset ID and request Key.
+/** Return the URL for a Cesium Ion asset from its asset ID and request Key.
  * @public
  */
 function getCesiumAssetUrl(osmAssetId, requestKey) {
@@ -35,10 +37,30 @@ function getCesiumAssetUrl(osmAssetId, requestKey) {
 }
 /** @internal */
 function getCesiumOSMBuildingsUrl() {
-    const key = IModelApp_1.IModelApp.tileAdmin.cesiumIonKey;
-    if (undefined === key)
+    if (!IModelApp_1.IModelApp.tileAdmin.canAccessCesium)
         return undefined;
-    return getCesiumAssetUrl(+core_common_1.CesiumIonAssetId.OSMBuildings, key);
+    return getCesiumAssetUrl(+core_common_1.CesiumIonAssetId.OSMBuildings, "");
+}
+/** Returns the registered [[CesiumAccessClient]], or a default [[CesiumIonClient]] if none is registered.
+ * @internal
+ */
+function getCesiumAccessClient() {
+    return IModelApp_1.IModelApp.tileAdmin.cesiumAccess ?? new CesiumIonClient();
+}
+const cesiumTokenTimeoutInterval = core_bentley_1.BeDuration.fromSeconds(60 * 30); // Request a new access token every 30 minutes...
+const cesiumMinTokenTimeoutInterval = core_bentley_1.BeDuration.fromSeconds(60); // ...but never re-resolve more often than once per minute.
+/** Compute when to next re-resolve a Cesium access token. Honors the endpoint's `expiresAt` when it is a valid
+ * future time, but guards against an invalid (NaN) date - which would otherwise disable refresh entirely - and
+ * against a past/imminent expiry that would re-resolve the endpoint on essentially every tile read.
+ * @internal
+ */
+function computeCesiumTokenTimeoutInterval(expiresAt) {
+    if (undefined === expiresAt)
+        return cesiumTokenTimeoutInterval;
+    const remainingMs = expiresAt.getTime() - Date.now();
+    if (!Number.isFinite(remainingMs))
+        return cesiumTokenTimeoutInterval;
+    return core_bentley_1.BeDuration.fromMilliseconds(Math.max(remainingMs, cesiumMinTokenTimeoutInterval.milliseconds));
 }
 /** @internal */
 async function getCesiumAccessTokenAndEndpointUrl(assetId, requestKey) {
@@ -72,15 +94,19 @@ function notifyTerrainError(detailedDescription) {
 }
 /** @internal */
 async function getCesiumTerrainProvider(opts) {
-    const accessTokenAndEndpointUrl = await getCesiumAccessTokenAndEndpointUrl(opts.dataSource || core_common_1.CesiumTerrainAssetId.Default);
-    if (!accessTokenAndEndpointUrl.token || !accessTokenAndEndpointUrl.url) {
+    const assetId = opts.dataSource || core_common_1.CesiumTerrainAssetId.Default;
+    const client = getCesiumAccessClient();
+    const endpoint = await client.getAssetEndpoint(assetId, opts.iTwinId);
+    if (!endpoint) {
         notifyTerrainError(IModelApp_1.IModelApp.localization.getLocalizedString(`iModelJs:BackgroundMap.MissingCesiumToken`));
         return undefined;
     }
+    // Resource paths (layer.json, tiles) are appended directly to the base URL, so ensure it ends with a slash.
+    const baseUrl = endpoint.url.endsWith("/") ? endpoint.url : `${endpoint.url}/`;
     let layers;
     try {
-        const layerRequestOptions = { headers: { authorization: `Bearer ${accessTokenAndEndpointUrl.token}` } };
-        const layerUrl = `${accessTokenAndEndpointUrl.url}layer.json`;
+        const layerRequestOptions = { headers: { authorization: `Bearer ${endpoint.accessToken}` } };
+        const layerUrl = `${baseUrl}layer.json`;
         layers = await (0, Request_1.request)(layerUrl, "json", layerRequestOptions);
     }
     catch {
@@ -109,12 +135,12 @@ async function getCesiumTerrainProvider(opts) {
             }
         }
     }
-    let tileUrlTemplate = accessTokenAndEndpointUrl.url + layers.tiles[0].replace("{version}", layers.version);
+    let tileUrlTemplate = baseUrl + layers.tiles[0].replace("{version}", layers.version);
     if (opts.wantNormals)
         tileUrlTemplate = tileUrlTemplate.replace("?", "?extensions=octvertexnormals-watermask-metadata&");
     const maxDepth = core_bentley_1.JsonUtils.asInt(layers.maxzoom, 19);
     // TBD -- When we have  an API extract the heights for the project from the terrain tiles - for use temporary Bing elevation.
-    return new CesiumTerrainProvider(opts, accessTokenAndEndpointUrl.token, tileUrlTemplate, maxDepth, tilingScheme, tileAvailability, layers.metadataAvailability);
+    return new CesiumTerrainProvider(opts, endpoint.accessToken, endpoint.expiresAt, tileUrlTemplate, maxDepth, tilingScheme, tileAvailability, layers.metadataAvailability);
 }
 function zigZagDecode(value) {
     return (value >> 1) ^ (-(value & 1));
@@ -149,19 +175,19 @@ class CesiumTerrainProvider extends internal_1.TerrainMeshProvider {
     _metaDataAvailableLevel;
     _exaggeration;
     _assetId;
+    _iTwinId;
     static _scratchQPoint2d = core_common_1.QPoint2d.fromScalars(0, 0);
     static _scratchPoint2d = core_geometry_1.Point2d.createZero();
     static _scratchPoint = core_geometry_1.Point3d.createZero();
     static _scratchNormal = core_geometry_1.Vector3d.createZero();
     static _scratchHeightRange = core_geometry_1.Range1d.createNull();
-    static _tokenTimeoutInterval = core_bentley_1.BeDuration.fromSeconds(60 * 30); // Request a new access token every 30 minutes...
     _tokenTimeOut;
     forceTileLoad(tile) {
         // Force loading of the metadata availability tiles as these are required for determining the availability of descendants.
         const mapTile = tile;
         return undefined !== this._metaDataAvailableLevel && mapTile.quadId.level === this._metaDataAvailableLevel && !mapTile.everLoaded;
     }
-    constructor(opts, accessToken, tileUrlTemplate, maxDepth, tilingScheme, tileAvailability, metaDataAvailableLevel) {
+    constructor(opts, accessToken, expiresAt, tileUrlTemplate, maxDepth, tilingScheme, tileAvailability, metaDataAvailableLevel) {
         super();
         this._wantSkirts = opts.wantSkirts;
         this._exaggeration = opts.exaggeration;
@@ -172,9 +198,10 @@ class CesiumTerrainProvider extends internal_1.TerrainMeshProvider {
         this._tileAvailability = tileAvailability;
         this._metaDataAvailableLevel = metaDataAvailableLevel;
         this._assetId = opts.dataSource || core_common_1.CesiumTerrainAssetId.Default;
-        this._tokenTimeOut = core_bentley_1.BeTimePoint.now().plus(CesiumTerrainProvider._tokenTimeoutInterval);
+        this._iTwinId = opts.iTwinId;
+        this._tokenTimeOut = core_bentley_1.BeTimePoint.now().plus(computeCesiumTokenTimeoutInterval(expiresAt));
     }
-    /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */
+    /** @deprecated in 5.0 - might be removed in next major version. Use [addAttributions] instead. */
     addLogoCards(cards) {
         if (cards.dataset.cesiumIonLogoCard)
             return;
@@ -218,11 +245,12 @@ class CesiumTerrainProvider extends internal_1.TerrainMeshProvider {
         // ###TODO why does he update the access token when reading the mesh instead of when requesting it?
         // This function only returns undefined if it fails to acquire token - but it doesn't need the token...
         if (core_bentley_1.BeTimePoint.now().milliseconds > this._tokenTimeOut.milliseconds) {
-            const accessTokenAndEndpointUrl = await getCesiumAccessTokenAndEndpointUrl(this._assetId);
-            if (!accessTokenAndEndpointUrl.token || args.isCanceled())
+            const client = getCesiumAccessClient();
+            const endpoint = await client.getAssetEndpoint(this._assetId, this._iTwinId);
+            if (!endpoint || args.isCanceled())
                 return undefined;
-            this._accessToken = accessTokenAndEndpointUrl.token;
-            this._tokenTimeOut = core_bentley_1.BeTimePoint.now().plus(CesiumTerrainProvider._tokenTimeoutInterval);
+            this._accessToken = endpoint.accessToken;
+            this._tokenTimeOut = core_bentley_1.BeTimePoint.now().plus(computeCesiumTokenTimeoutInterval(endpoint.expiresAt));
         }
         const { data, tile } = args;
         (0, core_bentley_1.assert)(data instanceof Uint8Array);
@@ -409,4 +437,16 @@ class CesiumTerrainProvider extends internal_1.TerrainMeshProvider {
         return undefined === heightRange ? parentRange : heightRange;
     }
 }
+/** Default [[CesiumAccessClient]] that authenticates directly with Cesium Ion using [[TileAdmin.cesiumIonKey]].
+ * This is used when no custom [[CesiumAccessClient]] is registered via [[TileAdmin.Props.cesiumAccess]].
+ * @internal
+ */
+class CesiumIonClient {
+    async getAssetEndpoint(assetId, _iTwinId) {
+        const result = await getCesiumAccessTokenAndEndpointUrl(assetId);
+        if (!result.token || !result.url)
+            return undefined;
+        return { accessToken: result.token, url: result.url };
+    }
+}
 //# sourceMappingURL=CesiumTerrainProvider.js.map