GoogleMaps support

common/api/core-bentley.api.md

@@ -224,6 +224,12 @@ export function compareNumbersOrUndefined(lhs?: number, rhs?: number): number;
 // @public (undocumented)
 export function comparePossiblyUndefined<T>(compareDefined: (lhs: T, rhs: T) => number, lhs?: T, rhs?: T): number;
 
+// @beta (undocumented)
+export function compareSimpleArrays(lhs?: Array<number | string | boolean>, rhs?: Array<number | string | boolean>): number;
+
+// @beta (undocumented)
+export function compareSimpleTypes(lhs: number | string | boolean, rhs: number | string | boolean): number;
+
 // @public (undocumented)
 export function compareStrings(a: string, b: string): number;
 

common/api/core-common.api.md

@@ -4786,6 +4786,8 @@ export interface ImageMapLayerProps extends CommonMapLayerProps {
     // @internal (undocumented)
     modelId?: never;
     // @beta
+    properties?: MapLayerProviderProperties;
+    // @beta
     queryParams?: {
         [key: string]: string;
     };
@@ -4820,6 +4822,8 @@ export class ImageMapLayerSettings extends MapLayerSettings {
     // (undocumented)
     password?: string;
     // @beta
+    readonly properties?: MapLayerProviderProperties;
+    // @beta
     savedQueryParams?: {
         [key: string]: string;
     };
@@ -5727,6 +5731,15 @@ export interface MapLayerKey {
 // @public
 export type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;
 
+// @beta (undocumented)
+export type MapLayerProviderArrayProperty = Array<number | string | boolean>;
+
+// @beta (undocumented)
+export interface MapLayerProviderProperties {
+    // (undocumented)
+    [key: string]: number | string | boolean | MapLayerProviderArrayProperty;
+}
+
 // @public
 export abstract class MapLayerSettings {
     // @internal

common/api/core-frontend.api.md

@@ -4675,6 +4675,8 @@ export class ImageryMapLayerTreeReference extends MapLayerTileTreeReference {
 export class ImageryMapTileTree extends RealityTileTree {
     constructor(params: RealityTileTreeParams, _imageryLoader: ImageryTileLoader);
     // (undocumented)
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // @deprecated (undocumented)
     addLogoCards(cards: HTMLTableElement, vp: ScreenViewport): void;
     // (undocumented)
     cartoRectangleFromQuadId(quadId: QuadId): MapCartoRectangle;
@@ -5657,6 +5659,8 @@ export type MapLayerFormatType = typeof MapLayerFormat;
 // @beta
 export abstract class MapLayerImageryProvider {
     constructor(_settings: ImageMapLayerSettings, _usesCachedTiles: boolean);
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // @deprecated (undocumented)
     addLogoCards(_cards: HTMLTableElement, _viewport: ScreenViewport): void;
     // @internal
     protected appendCustomParams(url: string): string;
@@ -5666,6 +5670,8 @@ export abstract class MapLayerImageryProvider {
     cartoRange?: MapCartoRectangle;
     // (undocumented)
     abstract constructUrl(row: number, column: number, zoomLevel: number): Promise<string>;
+    // @internal (undocumented)
+    decorate(_context: DecorateContext): void;
     // @internal
     protected readonly defaultMaximumZoomLevel = 22;
     // @internal
@@ -5905,6 +5911,8 @@ export abstract class MapLayerTileTreeReference extends TileTreeReference {
     // (undocumented)
     canSupplyToolTip(hit: HitDetail): boolean;
     // (undocumented)
+    decorate(_context: DecorateContext): void;
+    // (undocumented)
     getToolTip(hit: HitDetail): Promise<HTMLElement | string | undefined>;
     get imageryProvider(): MapLayerImageryProvider | undefined;
     // (undocumented)
@@ -6160,6 +6168,8 @@ export class MapTileTree extends RealityTileTree {
 // @internal
 export class MapTileTreeReference extends TileTreeReference {
     constructor(settings: BackgroundMapSettings, _baseLayerSettings: BaseLayerSettings | undefined, _layerSettings: MapLayerSettings[], iModel: IModelConnection, tileUserId: number, isOverlay: boolean, _isDrape: boolean, _overrideTerrainDisplay?: CheckTerrainDisplayOverride | undefined);
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // @deprecated (undocumented)
     addLogoCards(cards: HTMLTableElement, vp: ScreenViewport): void;
     addToScene(context: SceneContext): void;
     // (undocumented)
@@ -6175,6 +6185,8 @@ export class MapTileTreeReference extends TileTreeReference {
     // (undocumented)
     protected _createGeometryTreeReference(): GeometryTileTreeReference | undefined;
     // (undocumented)
+    decorate(context: DecorateContext): void;
+    // (undocumented)
     discloseTileTrees(trees: DisclosedTileTreeSet): void;
     // (undocumented)
     forEachLayerTileTreeRef(func: (ref: TileTreeReference) => void): void;
@@ -10148,6 +10160,8 @@ export class TerrainDisplayOverrides {
 
 // @public
 export abstract class TerrainMeshProvider {
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // @deprecated (undocumented)
     addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void;
     forceTileLoad(_tile: MapTile): boolean;
     getChildHeightRange(quadId: QuadId, rectangle: MapCartoRectangle, parent: MapTile): Range1d | undefined;
@@ -11043,6 +11057,9 @@ export interface TileTreeParams {
 export abstract class TileTreeReference {
     // (undocumented)
     accumulateTransformedRange(range: Range3d, matrix: Matrix4d, frustumPlanes?: FrustumPlanes): void;
+    // @beta
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // @deprecated (undocumented)
     addLogoCards(_cards: HTMLTableElement, _vp: ScreenViewport): void;
     addToScene(context: SceneContext): void;
     canSupplyToolTip(_hit: HitDetail): boolean;

common/api/map-layers-formats.api.md

@@ -5,6 +5,7 @@
 ```ts
 
 import { ArcGISImageryProvider } from '@itwin/core-frontend';
+import { BaseMapLayerSettings } from '@itwin/core-common';
 import { BeButtonEvent } from '@itwin/core-frontend';
 import { BeEvent } from '@itwin/core-bentley';
 import { Cartographic } from '@itwin/core-common';
@@ -18,6 +19,7 @@ import { Listener } from '@itwin/core-bentley';
 import { Localization } from '@itwin/core-common';
 import { LocateFilterStatus } from '@itwin/core-frontend';
 import { LocateResponse } from '@itwin/core-frontend';
+import { MapCartoRectangle } from '@itwin/core-frontend';
 import { MapFeatureInfo } from '@itwin/core-frontend';
 import { MapFeatureInfoOptions } from '@itwin/core-frontend';
 import { MapLayerFeatureInfo } from '@itwin/core-frontend';
@@ -56,6 +58,17 @@ export class ArcGisFeatureProvider extends ArcGISImageryProvider {
     get tileSize(): number;
 }
 
+// @beta
+export interface CreateSessionOptions {
+    apiOptions?: string[];
+    language: string;
+    layerTypes?: LayerTypes[];
+    mapType: MapTypes;
+    overlay?: boolean;
+    region: string;
+    scale?: ScaleFactors;
+}
+
 // @internal (undocumented)
 export class DefaultArcGiSymbology implements FeatureDefaultSymbology {
     // (undocumented)
@@ -72,6 +85,24 @@ export class DefaultArcGiSymbology implements FeatureDefaultSymbology {
     initialize(): Promise<void>;
 }
 
+// @beta
+export const GoogleMaps: {
+    createMapLayerSettings: (name?: string, opts?: CreateSessionOptions) => ImageMapLayerSettings;
+    createBaseLayerSettings: (opts?: CreateSessionOptions) => BaseMapLayerSettings;
+};
+
+// @beta
+export interface GoogleMapsSession {
+    expiry: number;
+    imageFormat: string;
+    session: string;
+    tileHeight: number;
+    tileWidth: number;
+}
+
+// @beta (undocumented)
+export type LayerTypes = "layerRoadmap" | "layerStreetview";
+
 // @beta
 export class MapFeatureInfoTool extends PrimitiveTool {
     // (undocumented)
@@ -126,6 +157,40 @@ export interface MapLayersFormatsConfig {
     localization?: Localization;
 }
 
+// @beta (undocumented)
+export type MapTypes = "roadmap" | "satellite" | "terrain";
+
+// @beta
+export interface MaxZoomRectangle {
+    // (undocumented)
+    east: number;
+    // (undocumented)
+    maxZoom: number;
+    // (undocumented)
+    north: number;
+    // (undocumented)
+    south: number;
+    // (undocumented)
+    west: number;
+}
+
+// @beta (undocumented)
+export type ScaleFactors = "scaleFactor1x" | "scaleFactor2x" | "scaleFactor4x";
+
+// @beta
+export interface ViewportInfo {
+    copyright: string;
+    maxZoomRects: MaxZoomRectangle[];
+}
+
+// @beta
+export interface ViewportInfoRequestParams {
+    key: string;
+    rectangle: MapCartoRectangle;
+    session: string;
+    zoom: number;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

common/api/summary/core-bentley.exports.csv

@@ -25,6 +25,8 @@ public;function;compareBooleansOrUndefined
 public;function;compareNumbers
 public;function;compareNumbersOrUndefined
 public;function;comparePossiblyUndefined
+beta;function;compareSimpleArrays
+beta;function;compareSimpleTypes
 public;function;compareStrings
 public;function;compareStringsOrUndefined
 public;function;compareWithTolerance

common/api/summary/core-common.exports.csv

@@ -491,6 +491,8 @@ public;interface;MapImageryProps
 public;class;MapImagerySettings
 public;interface;MapLayerKey
 public;type;MapLayerProps
+beta;type;MapLayerProviderArrayProperty
+beta;interface;MapLayerProviderProperties
 public;class;MapLayerSettings
 public;interface;MapSubLayerProps
 public;class;MapSubLayerSettings

common/api/summary/map-layers-formats.exports.csv

@@ -1,8 +1,17 @@
 sep=;
 Release Tag;API Item Type;API Item Name
 internal;class;ArcGisFeatureProvider
+beta;interface;CreateSessionOptions
 internal;class;DefaultArcGiSymbology
+beta;const;GoogleMaps
+beta;interface;GoogleMapsSession
+beta;type;LayerTypes
 beta;class;MapFeatureInfoTool
 beta;interface;MapFeatureInfoToolData
 beta;class;MapLayersFormats
-beta;interface;MapLayersFormatsConfig
+beta;interface;MapLayersFormatsConfig
+beta;type;MapTypes
+beta;interface;MaxZoomRectangle
+beta;type;ScaleFactors
+beta;interface;ViewportInfo
+beta;interface;ViewportInfoRequestParams

common/changes/@itwin/core-bentley/MichelD-GoogleMaps_2025-02-12-19-37.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-bentley",
+      "comment": "Add `compareSimpleTypes` and `compareSimpleArrays` to compare simple data.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-bentley"
+}

common/changes/@itwin/core-common/MichelD-GoogleMaps_2025-02-12-19-37.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-common",
+      "comment": "Add new `properties` property to `ImageMapLayerSettings` class.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-common"
+}

common/changes/@itwin/core-frontend/MichelD-GoogleMaps_2025-02-12-19-37.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-frontend",
+      "comment": "Add new async `addAttributions` method  on `TileTreeReference`. Also make sure ImageryTileTree / providers are included when decorating the view.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-frontend"
+}

common/changes/@itwin/map-layers-formats/MichelD-GoogleMaps_2025-02-12-19-37.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/map-layers-formats",
+      "comment": "Added Google Maps 2D tiles support.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/map-layers-formats"
+}

core/bentley/src/Compare.ts

@@ -92,3 +92,48 @@ export function areEqualPossiblyUndefined<T, U>(t: T | undefined, u: U | undefin
   else
     return areEqual(t, u);
 }
+
+/** @beta */
+export function compareSimpleTypes(lhs: number | string | boolean, rhs: number | string | boolean): number {
+  // Make sure the types are the same
+  if (typeof lhs !== typeof rhs) {
+    return 1;
+  }
+
+  let cmp = 0;
+  // Compare actual values
+  switch (typeof lhs) {
+    case "number":
+      cmp = compareNumbers(lhs, rhs as number);
+      break;
+    case "string":
+      cmp = compareStrings(lhs, rhs as string);
+      break;
+    case "boolean":
+      cmp = compareBooleans(lhs, rhs as boolean);
+      break;
+  }
+  return cmp;
+}
+
+/** @beta */
+export function compareSimpleArrays (lhs?: Array<number | string | boolean>, rhs?: Array<number | string | boolean> ) {
+  if (undefined === lhs)
+    return undefined === rhs ? 0 : -1;
+  else if (undefined === rhs)
+    return 1;
+  else if (lhs.length === 0 && rhs.length === 0) {
+    return 0;
+  } else if (lhs.length !== rhs.length) {
+    return lhs.length - rhs.length;
+  }
+
+  let cmp = 0;
+  for (let i = 0; i < lhs.length; i++) {
+    cmp = compareSimpleTypes(lhs[i], rhs[i]);
+    if (cmp !== 0) {
+      break;
+    }
+  }
+  return cmp;
+}