@itwin/core-frontend 3.6.0-dev.8 → 4.0.0-dev.10

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

@@ -11,7 +11,27 @@ import { FeatureSymbology } from "../../render/FeatureSymbology";
 import { RenderPlanarClassifier } from "../../render/RenderPlanarClassifier";
 import { SceneContext } from "../../ViewContext";
 import { ScreenViewport } from "../../Viewport";
-import { DisclosedTileTreeSet, GeometryTileTreeReference, ImageryMapLayerTreeReference, ImageryMapTileTree, MapCartoRectangle, MapLayerFeatureInfo, MapLayerTileTreeReference, MapTile, MapTileLoader, MapTilingScheme, ModelMapLayerTileTreeReference, QuadId, RealityTile, RealityTileTree, RealityTileTreeParams, Tile, TileDrawArgs, TileParams, TileTree, TileTreeOwner, TileTreeReference } from "../internal";
+import { DisclosedTileTreeSet, GeometryTileTreeReference, ImageryMapLayerTreeReference, ImageryMapTileTree, ImageryTileTreeState, MapCartoRectangle, MapLayerFeatureInfo, MapLayerTileTreeReference, MapTile, MapTileLoader, MapTilingScheme, ModelMapLayerTileTreeReference, QuadId, RealityTile, RealityTileTree, RealityTileTreeParams, Tile, TileDrawArgs, TileParams, TileTree, TileTreeOwner, TileTreeReference } from "../internal";
+/** Utility interface that ties an imagery tile tree to its corresponding map-layer settings object.
+ * @internal
+ */
+interface MapLayerTreeSetting {
+    tree: ImageryMapTileTree;
+    settings: MapLayerSettings;
+    baseImageryLayer: boolean;
+}
+/** Map tile tree scale range visibility values.
+ * @beta */
+export declare enum MapTileTreeScaleRangeVisibility {
+    /** state is currently unknown (i.e. never been displayed)  */
+    Unknown = 0,
+    /** all currently selected tree tiles are visible (i.e within the scale range)  */
+    Visible = 1,
+    /** all currently selected tree tiles are hidden (i.e outside the scale range)  */
+    Hidden = 2,
+    /** currently selected tree tiles are partially visible (i.e some tiles are within the scale range, and some are outside.) */
+    Partial = 3
+}
 /** A [quad tree](https://en.wikipedia.org/wiki/Quadtree) consisting of [[MapTile]]s representing the map imagery draped onto the surface of the Earth.
  * A `MapTileTree` enables display of a globe or planar map with [map imagery](https://en.wikipedia.org/wiki/Tiled_web_map) obtained from any number of sources, such as
  * [Bing](https://learn.microsoft.com/en-us/bingmaps/), [OpenStreetMap](https://wiki.openstreetmap.org/wiki/API), and [GIS servers](https://wiki.openstreetmap.org/wiki/API).
@@ -59,8 +79,9 @@ export declare class MapTileTree extends RealityTileTree {
     /** @internal */
     produceGeometry?: boolean;
     /** @internal */
-    imageryTrees: ImageryMapTileTree[];
+    layerImageryTrees: MapLayerTreeSetting[];
     private _layerSettings;
+    private _imageryTreeState;
     private _modelIdToIndex;
     /** @internal */
     layerClassifiers: Map<number, RenderPlanarClassifier>;
@@ -68,10 +89,20 @@ export declare class MapTileTree extends RealityTileTree {
     constructor(params: RealityTileTreeParams, ecefToDb: Transform, bimElevationBias: number, geodeticOffset: number, sourceTilingScheme: MapTilingScheme, id: MapTreeId, applyTerrain: boolean);
     /** @internal */
     get parentsAndChildrenExclusive(): boolean;
+    /** Return the imagery tile tree state of matching the provided imagery tree id.
+     * @internal
+     */
+    getImageryTreeState(imageryTreeId: string): ImageryTileTreeState | undefined;
+    /** Return a cloned dictionary of the imagery tile tree states
+     * @internal
+     */
+    cloneImageryTreeState(): Map<string, ImageryTileTreeState>;
     /** @internal */
     tileFromQuadId(quadId: QuadId): MapTile | undefined;
-    /** @internal */
-    addImageryLayer(tree: ImageryMapTileTree, settings: MapLayerSettings, index: number): void;
+    /** Add a new imagery tile tree / map-layer settings pair and initialize the imagery tile tree state.
+     * @internal
+     */
+    addImageryLayer(tree: ImageryMapTileTree, settings: MapLayerSettings, index: number, baseImageryLayer: boolean): void;
     /** @internal */
     addModelLayer(layerTreeRef: ModelMapLayerTileTreeReference, context: SceneContext): void;
     /** @internal */
@@ -125,6 +156,11 @@ export declare class MapTileTree extends RealityTileTree {
      * @internal
      */
     getPlanarChildCorners(tile: MapTile, columnCount: number, rowCount: number, resolve: (childCorners: Point3d[][]) => void): void;
+    /** Scan the list of currently selected reality tiles, and fire the viewport's 'onMapLayerScaleRangeVisibilityChanged ' event
+     * if any scale range visibility change is detected for one more map-layer definition.
+     * @internal
+     */
+    reportTileVisibility(args: TileDrawArgs, selected: RealityTile[]): void;
     /** @internal */
     getFractionalTileCorners(quadId: QuadId): Point3d[];
     /** @internal */
@@ -191,6 +227,10 @@ export declare class MapTileTreeReference extends TileTreeReference {
     get useDepthBuffer(): boolean;
     get treeOwner(): TileTreeOwner;
     getLayerImageryTreeRef(index: number): MapLayerTileTreeReference | undefined;
+    /** Return the map-layer scale range visibility for the provided map-layer index.
+   * @internal
+   */
+    getMapLayerScaleRangeVisibility(index: number): MapTileTreeScaleRangeVisibility;
     initializeLayers(context: SceneContext): boolean;
     /** Adds this reference's graphics to the scene. By default this invokes [[TileTree.drawScene]] on the referenced TileTree, if it is loaded. */
     addToScene(context: SceneContext): void;

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

@@ -1 +1 @@
-{"version":3,"file":"MapTileTree.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/MapTileTree.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpL,OAAO,EACL,qBAAqB,EAAE,iBAAiB,EAAgB,QAAQ,EAAqC,SAAS,EAAE,gBAAgB,EACjI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACwB,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAC9G,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAG1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAC+E,oBAAoB,EAA4B,yBAAyB,EAClI,4BAA4B,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,mBAAmB,EACnH,yBAAyB,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,8BAA8B,EAAmB,MAAM,EAC3H,WAAW,EAAuB,eAAe,EAAE,qBAAqB,EAA8B,IAAI,EAAE,YAAY,EAAoB,UAAU,EAAE,QAAQ,EAC5I,aAAa,EAAE,iBAAiB,EACrD,MAAM,aAAa,CAAC;AAOrB;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,gBAAgB;IACT,QAAQ,EAAE,SAAS,CAAC;IAC3B,gBAAgB;IACT,gBAAgB,EAAE,MAAM,CAAC;IAChC,gBAAgB;IACT,cAAc,EAAE,MAAM,CAAC;IAC9B,gBAAgB;IACT,kBAAkB,EAAE,eAAe,CAAC;IAC3C,gBAAgB;IAChB,OAAO,CAAC,qBAAqB,CAAY;IACzC,gBAAgB;IACT,cAAc,EAAE,SAAS,CAAC;IACjC,gBAAgB;IACT,iBAAiB,EAAE,SAAS,CAAC;IACpC,gBAAgB;IACT,iBAAiB,EAAE,SAAS,CAAC;IACpC,sEAAsE;IACtE,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,gBAAgB;IACT,WAAW,EAAE,OAAO,CAAC;IAC5B,gBAAgB;IAChB,OAAO,CAAC,qBAAqB,CAAkB;IAC/C,gBAAgB;IACT,cAAc,EAAE,OAAO,CAAC;IAC/B,gBAAgB;IACT,SAAS,EAAE,OAAO,CAAC;IAC1B,gBAAgB;IACT,mBAAmB,EAAE,MAAM,CAAC;IACnC,gBAAgB;IACT,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B,gBAAgB;IACT,eAAe,EAAE,OAAO,CAAC;IAChC,gBAAgB;IACT,cAAc,EAAE,OAAO,CAAC;IAC/B,gBAAgB;IACT,eAAe,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB;IACT,YAAY,EAAE,kBAAkB,EAAE,CAAM;IAC/C,OAAO,CAAC,cAAc,CAA2C;IACjE,OAAO,CAAC,eAAe,CAAiC;IACxD,gBAAgB;IACT,gBAAgB,sCAA6C;IAEpE,gBAAgB;gBACJ,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAC9G,kBAAkB,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO;IA+C3E,gBAAgB;IAChB,IAAoB,2BAA2B,YAI9C;IAED,gBAAgB;IACT,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI1D,gBAAgB;IACT,eAAe,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM;IAM1F,gBAAgB;IACT,aAAa,CAAC,YAAY,EAAE,8BAA8B,EAAE,OAAO,EAAE,YAAY;IAMxF,gBAAgB;cACG,yBAAyB,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE;IAU7F,gBAAgB;IACT,+BAA+B;IAOtC,gBAAgB;IAChB,IAAoB,aAAa,YAEhC;IAED,gBAAgB;IAChB,IAAoB,QAAQ,WAK3B;IAED,gBAAgB;IACT,iBAAiB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAUjM,gBAAgB;IACT,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO;IAInL,gBAAgB;IACT,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAI9G,gBAAgB;IACT,WAAW;IAIlB;;OAEG;IACH,OAAc,oBAAoB,SAAK;IACvC,gBAAgB;IAChB,OAAc,oBAAoB,SAAK;IACvC,gBAAgB;IAChB,OAAc,mBAAmB,SAAK;IACtC,gBAAgB;IAChB,IAAW,SAAS,kBAA2C;IAE/D,gBAAgB;IACA,mBAAmB,CAAC,YAAY,EAAE,YAAY;IAK9D,gBAAgB;IACT,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWjD,gBAAgB;IACA,mBAAmB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWxD,gBAAgB;IACT,aAAa,CAAC,SAAS,EAAE,iBAAiB,GAAG,KAAK,EAAE,GAAG,SAAS;IAiBvE,gBAAgB;IACT,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAInD,OAAO,CAAC,kCAAkC;IAoB1C,OAAO,CAAC,6BAA6B;IAYrC,gBAAgB;IACT,0BAA0B,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GAAG,SAAS;IAiB7F;;;OAGG;IACU,qBAAqB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBhE,OAAO,CAAC,MAAM,CAAC,aAAa,CAA6B;IAEzD;;;OAGG;IACI,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;IA4C/H,gBAAgB;IACT,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAS1D,gBAAgB;IACT,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB;IAI1D,gBAAgB;IACT,aAAa,CAAC,aAAa,EAAE,UAAU;IAK9C,gBAAgB;IACT,oBAAoB,CAAC,aAAa,EAAE,UAAU,GAAG,MAAM;CAK/D;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA+ID,gBAAgB;AAChB,aAAK,2BAA2B,GAAG,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAE7E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB;IAavD,OAAO,CAAC,kBAAkB;IAC1B,OAAO,CAAC,cAAc;IAGf,SAAS,EAAE,OAAO;IACzB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,uBAAuB,CAAC;IAlBlC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAwB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,yBAAyB,CAAS;IAC1C,OAAO,CAAC,UAAU,CAAC,CAAW;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsD;IAClF,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,mBAAmB,CAAyC;IACpE,OAAO,CAAC,eAAe,CAAC,CAAsB;gBAG5C,QAAQ,EAAE,qBAAqB,EACvB,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,EACjD,cAAc,EAAE,gBAAgB,EAAE,EAC1C,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,MAAM,EACX,SAAS,EAAE,OAAO,EACjB,QAAQ,EAAE,OAAO,EACjB,uBAAuB,CAAC,yCAA6B;IA8B/D,IAAoB,QAAQ,YAAmB;IAC/C,IAAW,SAAS,IAAI,QAAQ,GAAG,SAAS,CAA4B;IACxE,IAAoB,sBAAsB,IAAI,MAAM,CAAiD;cAElF,4BAA4B,IAAI,yBAAyB,GAAG,SAAS;IAYxF,wEAAwE;IACxD,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IACpD,IAAW,QAAQ,IAAI,qBAAqB,CAA2B;IACvE,IAAW,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,EAGlD;IACM,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB;IA0BhE,IAAW,aAAa,IAAI,gBAAgB,EAAE,CAE7C;IAEM,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,EAAE;IAalD,WAAW;IAMlB,IAAoB,YAAY,YAE/B;IAED,cAAuB,kBAAkB,IAAI,OAAO,CAOnD;IACD,IAAW,cAAc,YAExB;IAED,IAAW,SAAS,IAAI,aAAa,CAsCpC;IACM,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS;IAM5E,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO;IAkCvD,+IAA+I;IAC/H,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IA4BvC,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;cAS5D,oBAAoB,CAAC,KAAK,EAAE,QAAQ;cAIpC,qBAAqB,CAAC,KAAK,EAAE,QAAQ;IAIxC,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAU7D,2BAA2B,CAAC,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,GAAG,4BAA4B,GAAG,SAAS;IAY/H,qBAAqB,CAAC,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,GAAG,gBAAgB,GAAG,SAAS;YAMtG,qBAAqB;IA8Cb,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAkCrE,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IA0BnG,kCAAkC;IAClB,YAAY,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAahF;AAED;;GAEG;AACH,wBAAsB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,oBAiBtE"}
+{"version":3,"file":"MapTileTree.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/MapTileTree.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpL,OAAO,EACL,qBAAqB,EAAE,iBAAiB,EAAgB,QAAQ,EAAqC,SAAS,EAAE,gBAAgB,EACjI,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACwB,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAC9G,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAG1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAgC,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAC+E,oBAAoB,EAA4B,yBAAyB,EAClI,4BAA4B,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,OAAO,EAC7K,aAAa,EAAE,eAAe,EAAE,8BAA8B,EAAmB,MAAM,EACvF,WAAW,EAAuB,eAAe,EAAE,qBAAqB,EAA8B,IAAI,EAAE,YAAY,EAAoB,UAAU,EAAE,QAAQ,EAC5I,aAAa,EAAE,iBAAiB,EACrD,MAAM,aAAa,CAAC;AAOrB;;GAEG;AACH,UAAU,mBAAmB;IAC3B,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;WACW;AACX,oBAAY,+BAA+B;IACzC,8DAA8D;IAC9D,OAAO,IAAI;IAEX,kFAAkF;IAClF,OAAO,IAAA;IAEP,kFAAkF;IAClF,MAAM,IAAA;IAEN,6HAA6H;IAC7H,OAAO,IAAA;CACR;AAED;;;;;;;;GAQG;AAEH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,gBAAgB;IACT,QAAQ,EAAE,SAAS,CAAC;IAC3B,gBAAgB;IACT,gBAAgB,EAAE,MAAM,CAAC;IAChC,gBAAgB;IACT,cAAc,EAAE,MAAM,CAAC;IAC9B,gBAAgB;IACT,kBAAkB,EAAE,eAAe,CAAC;IAC3C,gBAAgB;IAChB,OAAO,CAAC,qBAAqB,CAAY;IACzC,gBAAgB;IACT,cAAc,EAAE,SAAS,CAAC;IACjC,gBAAgB;IACT,iBAAiB,EAAE,SAAS,CAAC;IACpC,gBAAgB;IACT,iBAAiB,EAAE,SAAS,CAAC;IACpC,sEAAsE;IACtE,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,gBAAgB;IACT,WAAW,EAAE,OAAO,CAAC;IAC5B,gBAAgB;IAChB,OAAO,CAAC,qBAAqB,CAAkB;IAC/C,gBAAgB;IACT,cAAc,EAAE,OAAO,CAAC;IAC/B,gBAAgB;IACT,SAAS,EAAE,OAAO,CAAC;IAC1B,gBAAgB;IACT,mBAAmB,EAAE,MAAM,CAAC;IACnC,gBAAgB;IACT,SAAS,CAAC,EAAE,QAAQ,CAAC;IAC5B,gBAAgB;IACT,eAAe,EAAE,OAAO,CAAC;IAChC,gBAAgB;IACT,cAAc,EAAE,OAAO,CAAC;IAC/B,gBAAgB;IACT,eAAe,CAAC,EAAE,OAAO,CAAC;IACjC,gBAAgB;IACT,iBAAiB,EAAE,mBAAmB,EAAE,CAAM;IACrD,OAAO,CAAC,cAAc,CAA2C;IACjE,OAAO,CAAC,iBAAiB,CAA+C;IACxE,OAAO,CAAC,eAAe,CAAiC;IACxD,gBAAgB;IACT,gBAAgB,sCAA6C;IAEpE,gBAAgB;gBACJ,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAC9G,kBAAkB,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO;IA+C3E,gBAAgB;IAChB,IAAoB,2BAA2B,YAI9C;IAED;;OAEG;IACI,mBAAmB,CAAC,aAAa,EAAE,MAAM;IAIhD;;OAEG;IACI,qBAAqB;IAQ5B,gBAAgB;IACT,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI1D;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO;IAQrH,gBAAgB;IACT,aAAa,CAAC,YAAY,EAAE,8BAA8B,EAAE,OAAO,EAAE,YAAY;IAMxF,gBAAgB;cACG,yBAAyB,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE;IAU7F,gBAAgB;IACT,+BAA+B;IAOtC,gBAAgB;IAChB,IAAoB,aAAa,YAEhC;IAED,gBAAgB;IAChB,IAAoB,QAAQ,WAK3B;IAED,gBAAgB;IACT,iBAAiB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAUjM,gBAAgB;IACT,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO;IAInL,gBAAgB;IACT,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAI9G,gBAAgB;IACT,WAAW;IAIlB;;OAEG;IACH,OAAc,oBAAoB,SAAK;IACvC,gBAAgB;IAChB,OAAc,oBAAoB,SAAK;IACvC,gBAAgB;IAChB,OAAc,mBAAmB,SAAK;IACtC,gBAAgB;IAChB,IAAW,SAAS,kBAA2C;IAE/D,gBAAgB;IACA,mBAAmB,CAAC,YAAY,EAAE,YAAY;IAK9D,gBAAgB;IACT,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWjD,gBAAgB;IACA,mBAAmB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWxD,gBAAgB;IACT,aAAa,CAAC,SAAS,EAAE,iBAAiB,GAAG,KAAK,EAAE,GAAG,SAAS;IAiBvE,gBAAgB;IACT,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAInD,OAAO,CAAC,kCAAkC;IAoB1C,OAAO,CAAC,6BAA6B;IAYrC,gBAAgB;IACT,0BAA0B,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GAAG,SAAS;IAiB7F;;;OAGG;IACU,qBAAqB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBhE,OAAO,CAAC,MAAM,CAAC,aAAa,CAA6B;IAEzD;;;OAGG;IACI,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;IA4C/H;;;OAGG;IACa,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE;IA6EhF,gBAAgB;IACT,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAS1D,gBAAgB;IACT,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB;IAI1D,gBAAgB;IACT,aAAa,CAAC,aAAa,EAAE,UAAU;IAK9C,gBAAgB;IACT,oBAAoB,CAAC,aAAa,EAAE,UAAU,GAAG,MAAM;CAK/D;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA+ID,gBAAgB;AAChB,aAAK,2BAA2B,GAAG,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAE7E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB;IAavD,OAAO,CAAC,kBAAkB;IAC1B,OAAO,CAAC,cAAc;IAGf,SAAS,EAAE,OAAO;IACzB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,uBAAuB,CAAC;IAlBlC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAwB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,yBAAyB,CAAS;IAC1C,OAAO,CAAC,UAAU,CAAC,CAAW;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsD;IAClF,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,mBAAmB,CAAyC;IACpE,OAAO,CAAC,eAAe,CAAC,CAAsB;gBAG5C,QAAQ,EAAE,qBAAqB,EACvB,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,EACjD,cAAc,EAAE,gBAAgB,EAAE,EAC1C,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,MAAM,EACX,SAAS,EAAE,OAAO,EACjB,QAAQ,EAAE,OAAO,EACjB,uBAAuB,CAAC,yCAA6B;IA8B/D,IAAoB,QAAQ,YAAmB;IAC/C,IAAW,SAAS,IAAI,QAAQ,GAAG,SAAS,CAA4B;IACxE,IAAoB,sBAAsB,IAAI,MAAM,CAAiD;cAElF,4BAA4B,IAAI,yBAAyB,GAAG,SAAS;IAYxF,wEAAwE;IACxD,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IACpD,IAAW,QAAQ,IAAI,qBAAqB,CAA2B;IACvE,IAAW,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,EAGlD;IACM,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB;IA0BhE,IAAW,aAAa,IAAI,gBAAgB,EAAE,CAE7C;IAEM,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,EAAE;IAalD,WAAW;IAMlB,IAAoB,YAAY,YAE/B;IAED,cAAuB,kBAAkB,IAAI,OAAO,CAOnD;IACD,IAAW,cAAc,YAExB;IAED,IAAW,SAAS,IAAI,aAAa,CAsCpC;IACM,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS;IAMnF;;KAEC;IACM,+BAA+B,CAAC,KAAK,EAAE,MAAM,GAAG,+BAA+B;IAc/E,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO;IAsCvD,+IAA+I;IAC/H,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IA4BvC,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;cAS5D,oBAAoB,CAAC,KAAK,EAAE,QAAQ;cAIpC,qBAAqB,CAAC,KAAK,EAAE,QAAQ;IAIxC,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAU7D,2BAA2B,CAAC,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,GAAG,4BAA4B,GAAG,SAAS;IAY/H,qBAAqB,CAAC,cAAc,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,GAAG,gBAAgB,GAAG,SAAS;YAMtG,qBAAqB;IA8Cb,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IAkCrE,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC;IA0BnG,kCAAkC;IAClB,YAAY,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,IAAI;CAahF;AAED;;GAEG;AACH,wBAAsB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,oBAiBtE"}

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

@@ -7,7 +7,7 @@
  * @module Tiles
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGcsConverterAvailable = exports.MapTileTreeReference = exports.MapTileTree = void 0;
+exports.getGcsConverterAvailable = exports.MapTileTreeReference = exports.MapTileTree = exports.MapTileTreeScaleRangeVisibility = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const core_geometry_1 = require("@itwin/core-geometry");
@@ -20,6 +20,19 @@ const scratchPoint = core_geometry_1.Point3d.create();
 const scratchCorners = [core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero(), core_geometry_1.Point3d.createZero()];
 const scratchCorner = core_geometry_1.Point3d.createZero();
 const scratchZNormal = core_geometry_1.Vector3d.create(0, 0, 1);
+/** Map tile tree scale range visibility values.
+ * @beta */
+var MapTileTreeScaleRangeVisibility;
+(function (MapTileTreeScaleRangeVisibility) {
+    /** state is currently unknown (i.e. never been displayed)  */
+    MapTileTreeScaleRangeVisibility[MapTileTreeScaleRangeVisibility["Unknown"] = 0] = "Unknown";
+    /** all currently selected tree tiles are visible (i.e within the scale range)  */
+    MapTileTreeScaleRangeVisibility[MapTileTreeScaleRangeVisibility["Visible"] = 1] = "Visible";
+    /** all currently selected tree tiles are hidden (i.e outside the scale range)  */
+    MapTileTreeScaleRangeVisibility[MapTileTreeScaleRangeVisibility["Hidden"] = 2] = "Hidden";
+    /** currently selected tree tiles are partially visible (i.e some tiles are within the scale range, and some are outside.) */
+    MapTileTreeScaleRangeVisibility[MapTileTreeScaleRangeVisibility["Partial"] = 3] = "Partial";
+})(MapTileTreeScaleRangeVisibility = exports.MapTileTreeScaleRangeVisibility || (exports.MapTileTreeScaleRangeVisibility = {}));
 /** A [quad tree](https://en.wikipedia.org/wiki/Quadtree) consisting of [[MapTile]]s representing the map imagery draped onto the surface of the Earth.
  * A `MapTileTree` enables display of a globe or planar map with [map imagery](https://en.wikipedia.org/wiki/Tiled_web_map) obtained from any number of sources, such as
  * [Bing](https://learn.microsoft.com/en-us/bingmaps/), [OpenStreetMap](https://wiki.openstreetmap.org/wiki/API), and [GIS servers](https://wiki.openstreetmap.org/wiki/API).
@@ -34,8 +47,9 @@ class MapTileTree extends internal_1.RealityTileTree {
     constructor(params, ecefToDb, bimElevationBias, geodeticOffset, sourceTilingScheme, id, applyTerrain) {
         super(params);
         /** @internal */
-        this.imageryTrees = [];
+        this.layerImageryTrees = [];
         this._layerSettings = new Map();
+        this._imageryTreeState = new Map();
         this._modelIdToIndex = new Map();
         /** @internal */
         this.layerClassifiers = new Map();
@@ -84,14 +98,34 @@ class MapTileTree extends internal_1.RealityTileTree {
         // by depth so that painters algorithm will approximate correct depth display.
         return this.useDepthBuffer ? this.loader.parentsAndChildrenExclusive : false;
     }
+    /** Return the imagery tile tree state of matching the provided imagery tree id.
+     * @internal
+     */
+    getImageryTreeState(imageryTreeId) {
+        return this._imageryTreeState.get(imageryTreeId);
+    }
+    /** Return a cloned dictionary of the imagery tile tree states
+     * @internal
+     */
+    cloneImageryTreeState() {
+        const clone = new Map();
+        for (const [treeId, state] of this._imageryTreeState) {
+            clone.set(treeId, state.clone());
+        }
+        return clone;
+    }
     /** @internal */
     tileFromQuadId(quadId) {
         return this._rootTile.tileFromQuadId(quadId);
     }
-    /** @internal */
-    addImageryLayer(tree, settings, index) {
-        this.imageryTrees.push(tree);
+    /** Add a new imagery tile tree / map-layer settings pair and initialize the imagery tile tree state.
+     * @internal
+     */
+    addImageryLayer(tree, settings, index, baseImageryLayer) {
+        this.layerImageryTrees.push({ tree, settings, baseImageryLayer });
         this._layerSettings.set(tree.modelId, settings);
+        if (!this._imageryTreeState.has(tree.modelId))
+            this._imageryTreeState.set(tree.modelId, new internal_1.ImageryTileTreeState());
         this._modelIdToIndex.set(tree.modelId, index);
     }
     /** @internal */
@@ -110,7 +144,7 @@ class MapTileTree extends internal_1.RealityTileTree {
     }
     /** @internal */
     clearImageryTreesAndClassifiers() {
-        this.imageryTrees.length = 0;
+        this.layerImageryTrees.length = 0;
         this._layerSettings.clear();
         this._modelIdToIndex.clear();
         this.layerClassifiers.clear();
@@ -123,7 +157,7 @@ class MapTileTree extends internal_1.RealityTileTree {
     get maxDepth() {
         var _a;
         let maxDepth = this.loader.maxDepth;
-        (_a = this.imageryTrees) === null || _a === void 0 ? void 0 : _a.forEach((imageryTree) => maxDepth = Math.max(maxDepth, imageryTree.maxDepth));
+        (_a = this.layerImageryTrees) === null || _a === void 0 ? void 0 : _a.forEach((layerImageryTree) => maxDepth = Math.max(maxDepth, layerImageryTree.tree.maxDepth));
         return maxDepth;
     }
     /** @internal */
@@ -311,6 +345,71 @@ class MapTileTree extends internal_1.RealityTileTree {
             resolveCorners(gridPoints);
         }
     }
+    /** Scan the list of currently selected reality tiles, and fire the viewport's 'onMapLayerScaleRangeVisibilityChanged ' event
+     * if any scale range visibility change is detected for one more map-layer definition.
+     * @internal
+     */
+    reportTileVisibility(args, selected) {
+        const debugControl = args.context.target.debugControl;
+        const layersVisibilityBefore = this.cloneImageryTreeState();
+        const changes = new Array();
+        if (!layersVisibilityBefore)
+            return;
+        for (const [treeId] of layersVisibilityBefore) {
+            const treeVisibility = this.getImageryTreeState(treeId);
+            if (treeVisibility) {
+                treeVisibility.reset();
+            }
+        }
+        for (const selectedTile of selected) {
+            if (selectedTile instanceof internal_1.MapTile) {
+                let selectedImageryTiles = selectedTile.imageryTiles;
+                if (selectedTile.hiddenImageryTiles) {
+                    selectedImageryTiles = selectedImageryTiles ? [...selectedImageryTiles, ...selectedTile.hiddenImageryTiles] : selectedTile.hiddenImageryTiles;
+                }
+                const leafTiles = selectedTile.highResolutionReplacementTiles;
+                if (leafTiles) {
+                    for (const tile of leafTiles) {
+                        const treeState = this.getImageryTreeState(tile.tree.id);
+                        treeState === null || treeState === void 0 ? void 0 : treeState.setScaleRangeVisibility(false);
+                    }
+                }
+                if (selectedImageryTiles) {
+                    for (const selectedImageryTile of selectedImageryTiles) {
+                        const treeState = this.getImageryTreeState(selectedImageryTile.tree.id);
+                        if (treeState) {
+                            if (selectedImageryTile.isOutOfLodRange) {
+                                treeState.setScaleRangeVisibility(false);
+                            }
+                            else {
+                                treeState.setScaleRangeVisibility(true);
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        for (const [treeId, prevState] of layersVisibilityBefore) {
+            const newState = this.getImageryTreeState(treeId);
+            if (newState) {
+                const prevVisibility = prevState.getScaleRangeVisibility();
+                const visibility = newState.getScaleRangeVisibility();
+                if (prevVisibility !== visibility) {
+                    if (debugControl && debugControl.logRealityTiles) {
+                        // eslint-disable-next-line no-console
+                        console.log(`ImageryTileTree '${treeId}' changed prev state: '${MapTileTreeScaleRangeVisibility[prevVisibility]}' new state: '${MapTileTreeScaleRangeVisibility[visibility]}'`);
+                    }
+                    const mapLayersIndexes = args.context.viewport.getMapLayerIndexesFromIds(this.id, treeId);
+                    for (const index of mapLayersIndexes) {
+                        changes.push({ index: index.index, isOverlay: index.isOverlay, visibility });
+                    }
+                }
+            }
+        }
+        if (changes.length !== 0) {
+            args.context.viewport.onMapLayerScaleRangeVisibilityChanged.raiseEvent(changes);
+        }
+    }
     /** @internal */
     getFractionalTileCorners(quadId) {
         const corners = [];
@@ -435,7 +534,7 @@ class MapTreeSupplier {
     async createTileTree(id, iModel) {
         let bimElevationBias = 0, terrainProvider, geodeticOffset = 0;
         let applyTerrain = id.applyTerrain;
-        const modelId = iModel.transientIds.next;
+        const modelId = iModel.transientIds.getNext();
         const gcsConverterAvailable = await getGcsConverterAvailable(iModel);
         const terrainOpts = {
             wantSkirts: id.wantSkirts,
@@ -627,11 +726,28 @@ class MapTileTreeReference extends internal_1.TileTreeReference {
         const treeIndex = index + baseLayerIndex;
         return index < 0 || treeIndex >= this._layerTrees.length ? undefined : this._layerTrees[treeIndex];
     }
+    /** Return the map-layer scale range visibility for the provided map-layer index.
+   * @internal
+   */
+    getMapLayerScaleRangeVisibility(index) {
+        var _a;
+        const tree = this.treeOwner.tileTree;
+        if (undefined !== tree) {
+            const tileTreeRef = this.getLayerImageryTreeRef(index);
+            const treeId = (_a = tileTreeRef === null || tileTreeRef === void 0 ? void 0 : tileTreeRef.treeOwner.tileTree) === null || _a === void 0 ? void 0 : _a.id;
+            if (treeId !== undefined) {
+                const treeState = tree.getImageryTreeState(treeId);
+                if (treeState !== undefined)
+                    return treeState.getScaleRangeVisibility();
+            }
+        }
+        return MapTileTreeScaleRangeVisibility.Unknown;
+    }
     initializeLayers(context) {
         const tree = this.treeOwner.load();
         if (undefined === tree)
             return false; // Not loaded yet.
-        tree.imageryTrees.length = 0;
+        tree.layerImageryTrees.length = 0;
         if (0 === this._layerTrees.length)
             return !this.isOverlay;
         let treeIndex = this._layerTrees.length - 1;
@@ -643,12 +759,16 @@ class MapTileTreeReference extends internal_1.TileTreeReference {
         }
         for (; treeIndex < this._layerTrees.length; treeIndex++) {
             const layerTreeRef = this._layerTrees[treeIndex];
-            if (layerTreeRef && internal_1.TileTreeLoadStatus.NotFound !== layerTreeRef.treeOwner.loadStatus && layerTreeRef.layerSettings.visible && !layerTreeRef.layerSettings.allSubLayersInvisible) {
+            // Load tile tree for each configured layer.
+            // Note: Non-visible layer are also added to allow proper tile tree scale range visibility reporting.
+            if (layerTreeRef && internal_1.TileTreeLoadStatus.NotFound !== layerTreeRef.treeOwner.loadStatus
+                && !layerTreeRef.layerSettings.allSubLayersInvisible) {
                 const layerTree = layerTreeRef.treeOwner.load();
                 if (undefined === layerTree)
                     return false; // Not loaded yet.
+                const baseImageryLayer = this._baseImageryLayerIncluded && (treeIndex === 0);
                 if (layerTree instanceof internal_1.ImageryMapTileTree) {
-                    tree.addImageryLayer(layerTree, layerTreeRef.layerSettings, treeIndex);
+                    tree.addImageryLayer(layerTree, layerTreeRef.layerSettings, treeIndex, baseImageryLayer);
                 }
                 else if (layerTreeRef instanceof internal_1.ModelMapLayerTileTreeReference)
                     tree.addModelLayer(layerTreeRef, context);