Support Google Photorealistic 3D Tiles in iTwin.js

common/api/core-frontend.api.md

@@ -3764,9 +3764,15 @@ export function getCesiumAssetUrl(osmAssetId: number, requestKey: string): strin
 // @public
 export function getCompressedJpegFromCanvas(canvas: HTMLCanvasElement, maxBytes?: number, minCompressionQuality?: number): string | undefined;
 
+// @internal
+export function getCopyrights(vp: ScreenViewport): Map<string, number>;
+
 // @internal (undocumented)
 export function getFrustumPlaneIntersectionDepthRange(frustum: Frustum, plane: Plane3dByOriginAndUnitNormal): Range1d;
 
+// @beta
+export function getGooglePhotorealistic3DTilesURL(): string;
+
 // @public
 export function getImageSourceFormatForMimeType(mimeType: string): ImageSourceFormat | undefined;
 
@@ -4075,6 +4081,8 @@ export interface GltfReaderArgs {
 
 // @internal
 export interface GltfReaderResult extends TileContent {
+    // (undocumented)
+    copyright?: string;
     // (undocumented)
     range?: AxisAlignedBox3d;
     // (undocumented)
@@ -4095,6 +4103,15 @@ export interface GLTimerResult {
     nanoseconds: number;
 }
 
+// @internal
+export class GoogleMapsDecorator implements Decorator {
+    constructor(showCreditsOnScreen?: boolean);
+    activate(mapType: GoogleMapsMapTypes): Promise<boolean>;
+    decorate: (context: DecorateContext) => void;
+    // (undocumented)
+    readonly logo: LogoDecoration;
+}
+
 // @public
 export type GpuMemoryLimit = "none" | "default" | "aggressive" | "relaxed" | number;
 
@@ -4876,7 +4893,7 @@ export class IModelApp {
     static queryRenderCompatibility(): WebGLRenderCompatibilityInfo;
     // @beta
     static get realityDataAccess(): RealityDataAccess | undefined;
-    // @alpha
+    // @beta
     static get realityDataSourceProviders(): RealityDataSourceProviderRegistry;
     // @internal
     static registerEntityState(classFullName: string, classType: typeof EntityState): void;
@@ -5620,6 +5637,20 @@ export enum LockedStates {
     Y_BM = 2
 }
 
+// @internal
+export class LogoDecoration implements CanvasDecoration {
+    // (undocumented)
+    activate(sprite: Sprite): Promise<boolean>;
+    // (undocumented)
+    decorate(context: DecorateContext): void;
+    drawDecoration(ctx: CanvasRenderingContext2D): void;
+    get isLoaded(): boolean;
+    moveToLowerLeftCorner(context: DecorateContext): boolean;
+    set offset(offset: Point3d | undefined);
+    get offset(): Point3d | undefined;
+    readonly position: Point3d;
+}
+
 // @public
 export class LookAndMoveTool extends ViewManip {
     constructor(vp: ScreenViewport, oneShot?: boolean, isDraggingRequired?: boolean);
@@ -8115,14 +8146,39 @@ export namespace RealityDataSource {
     export function createOrbitGtBlobPropsFromKey(rdSourceKey: RealityDataSourceKey): OrbitGtBlobProps | undefined;
     // @alpha
     export function fromKey(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;
+    // @alpha
+    export function setBaseUrl(id: string): void;
 }
 
-// @alpha
+// @beta
+export class RealityDataSourceGP3DTProvider implements RealityDataSourceProvider {
+    constructor(options: RealityDataSourceGP3DTProviderOptions);
+    // (undocumented)
+    addAttributions(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
+    // (undocumented)
+    createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;
+    // (undocumented)
+    decorate(_context: DecorateContext): void;
+    initialize(): Promise<boolean>;
+    readonly useCachedDecorations = true;
+}
+
+// @beta
+export interface RealityDataSourceGP3DTProviderOptions {
+    apiKey?: string;
+    getAuthToken?: () => Promise<string | undefined>;
+    showCreditsOnScreen?: boolean;
+}
+
+// @beta
 export interface RealityDataSourceProvider {
+    addAttributions?(cards: HTMLTableElement, vp: ScreenViewport): Promise<void>;
     createRealityDataSource(key: RealityDataSourceKey, iTwinId: GuidString | undefined): Promise<RealityDataSource | undefined>;
+    decorate?(_context: DecorateContext): void;
+    useCachedDecorations?: true | undefined;
 }
 
-// @alpha
+// @beta
 export class RealityDataSourceProviderRegistry {
     // @internal
     constructor();
@@ -8217,6 +8273,10 @@ export class RealityTile extends Tile {
     // @internal (undocumented)
     computeVisibilityFactor(args: TileDrawArgs): number;
     // @internal (undocumented)
+    get copyright(): string | undefined;
+    // @internal (undocumented)
+    protected _copyright?: string;
+    // @internal (undocumented)
     disposeContents(): void;
     // @internal (undocumented)
     protected forceSelectRealityTile(): boolean;

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

@@ -224,7 +224,9 @@ internal;interface;GetAttachmentViewportArgs
 public;function;getCenteredViewRect
 public;function;getCesiumAssetUrl
 public;function;getCompressedJpegFromCanvas
+internal;function;getCopyrights
 internal;function;getFrustumPlaneIntersectionDepthRange
+beta;function;getGooglePhotorealistic3DTilesURL
 public;function;getImageSourceFormatForMimeType
 public;function;getImageSourceMimeType
 public;interface;GetPixelDataWorldPointArgs
@@ -241,6 +243,7 @@ internal;interface;GltfReaderArgs
 internal;interface;GltfReaderResult
 beta;interface;GltfTemplate
 internal;interface;GLTimerResult
+internal;class;GoogleMapsDecorator
 public;type;GpuMemoryLimit
 public;interface;GpuMemoryLimits
 public;class;GraphicalEditingScope
@@ -346,6 +349,7 @@ public;enum;LocateFilterStatus
 public;class;LocateOptions
 public;class;LocateResponse
 internal;enum;LockedStates
+internal;class;LogoDecoration
 public;class;LookAndMoveTool
 public;interface;LookAtArgs
 public;interface;LookAtOrthoArgs
@@ -507,8 +511,11 @@ alpha;function;createKeyFromBlobUrl
 alpha;function;createKeyFromOrbitGtBlobProps
 alpha;function;createOrbitGtBlobPropsFromKey
 alpha;function;fromKey
-alpha;interface;RealityDataSourceProvider
-alpha;class;RealityDataSourceProviderRegistry
+alpha;function;setBaseUrl
+beta;class;RealityDataSourceGP3DTProvider
+beta;interface;RealityDataSourceGP3DTProviderOptions
+beta;interface;RealityDataSourceProvider
+beta;class;RealityDataSourceProviderRegistry
 public;interface;RealityMeshParams
 public;namespace;RealityMeshParams
 internal;function;fromGltfMesh

common/changes/@itwin/core-common/google-3d-tiles_2025-05-29-15-10.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-common",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-common"
+}

common/changes/@itwin/core-frontend/google-3d-tiles_2025-05-21-15-03.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-frontend",
+      "comment": "Support Google Photorealistic 3D Tiles.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-frontend"
+}

common/changes/@itwin/map-layers-formats/google-3d-tiles_2025-05-21-21-05.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/map-layers-formats",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/map-layers-formats"
+}

core/common/src/ContextRealityModel.ts

@@ -28,22 +28,22 @@ export interface OrbitGtBlobProps {
  */
 export enum RealityDataProvider {
   /**
-   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.tilesetUrl property.
-   * It was use to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
-   * You should use other mode when possible
+   * This is the legacy mode where the access to the 3d tiles is hardcoded in ContextRealityModelProps.tilesetUrl property.
+   * It was used to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
+   * You should use other modes when possible
    * @see [[RealityDataSource.createKeyFromUrl]] that will try to detect provider from an URL
    */
   TilesetUrl = "TilesetUrl",
   /**
-   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.OrbitGtBlob property.
-   * It was use to support OrbitPointCloud (OPC) from other server than ContextShare
-   * You should use other mode when possible
+   * This is the legacy mode where the access to the 3d tiles is hardcoded in ContextRealityModelProps.OrbitGtBlob property.
+   * It was used to support OrbitPointCloud (OPC) from other server than ContextShare
+   * You should use other modes when possible
    * @see [[RealityDataSource.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL
    */
   OrbitGtBlob = "OrbitGtBlob",
   /**
-   * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or  OPC storage format
-   * This provider support all type of 3dTile storage fomat and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC
+   * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or OPC storage format
+   * This provider supports all types of 3dTile storage format and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC
    * @see [[RealityDataFormat]].
    */
   ContextShare = "ContextShare",

core/frontend/package.json

@@ -82,7 +82,9 @@
     "vitest": "^3.0.6",
     "vite-multiple-assets": "^1.3.1",
     "vite-plugin-static-copy": "2.2.0",
-    "webpack": "^5.97.1"
+    "webpack": "^5.97.1",
+    "sinon": "^17.0.2",
+    "@types/sinon": "^17.0.2"
   },
   "//dependencies": [
     "NOTE: these dependencies should be only for things that DO NOT APPEAR IN THE API",