@cesium/engine 2.3.0 → 2.4.0

package/Source/Scene/createGooglePhotorealistic3DTileset.js

@@ -0,0 +1,53 @@
+import Cesium3DTileset from "./Cesium3DTileset.js";
+import defaultValue from "../Core/defaultValue.js";
+import defined from "../Core/defined.js";
+import GoogleMaps from "../Core/GoogleMaps.js";
+import Resource from "../Core/Resource.js";
+
+/**
+ * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D Tiles tileset.
+ *
+ * @function
+ *
+ * @param {string} [key=GoogleMaps.defaultApiKey] Your API key to access Google Photorealistic 3D Tiles. See {@link https://developers.google.com/maps/documentation/javascript/get-api-key} for instructions on how to create your own key.
+ * @param {Cesium3DTileset.ConstructorOptions} [options] An object describing initialization options.
+ * @returns {Promise<Cesium3DTileset>}
+ *
+ * @see GoogleMaps
+ *
+ * @example
+ * Cesium.GoogleMaps.defaultApiKey = "your-api-key";
+ *
+ * const viewer = new Cesium.Viewer("cesiumContainer");
+ *
+ * try {
+ *   const tileset = await Cesium.createGooglePhotorealistic3DTileset();
+ *   viewer.scene.primitives.add(tileset));
+ * } catch (error) {
+ *   console.log(`Error creating tileset: ${error}`);
+ * }
+ */
+async function createGooglePhotorealistic3DTileset(key, options) {
+  key = defaultValue(key, GoogleMaps.defaultApiKey);
+
+  let credits;
+  const credit = GoogleMaps.getDefaultApiKeyCredit(key);
+  if (defined(credit)) {
+    credits = [credit];
+  }
+
+  options = defaultValue(options, {});
+  options.showCreditsOnScreen = true;
+
+  const resource = new Resource({
+    url: `${GoogleMaps.mapTilesApiEndpoint}3dtiles/root.json`,
+    queryParameters: {
+      key: key,
+    },
+    credits: credits,
+  });
+
+  return Cesium3DTileset.fromUrl(resource, options);
+}
+
+export default createGooglePhotorealistic3DTileset;

package/index.d.ts

@@ -7613,6 +7613,24 @@ export class GoogleEarthEnterpriseTerrainProvider {
     loadTileDataAvailability(x: number, y: number, level: number): undefined;
 }
 
+/**
+ * Default settings for accessing the Google Maps API.
+ * <br/>
+ * An API key is only required if you are using any Google Maps APIs, such as {@link createGooglePhotorealistic3DTileset}.
+ * A default key is provided for evaluation purposes only.
+ * Follow instructions for managing API keys for the Google Maps Platform at {@link https://developers.google.com/maps/documentation/embed/get-api-key}
+ */
+export namespace GoogleMaps {
+    /**
+     * Gets or sets the default Google Maps API key.
+     */
+    var defaultApiKey: string;
+    /**
+     * Gets or sets the default Google Map Tiles API endpoint.
+     */
+    var mapTilesApiEndpoint: string | Resource;
+}
+
 /**
  * Represents a Gregorian date in a more precise format than the JavaScript Date object.
  * In addition to submillisecond precision, this object can also represent leap seconds.
@@ -40709,7 +40727,7 @@ export class ScreenSpaceCameraController {
      */
     lookEventTypes: CameraEventType | any[] | undefined;
     /**
-     * The minimum height the camera must be before picking the terrain instead of the ellipsoid.
+     * The minimum height the camera must be before picking the terrain or scene content instead of the ellipsoid.
      */
     minimumPickingTerrainHeight: number;
     /**
@@ -43244,6 +43262,24 @@ export function createElevationBandMaterial(options: {
     layers: createElevationBandMaterialBand[];
 }): Material;
 
+/**
+ * Creates a {@link Cesium3DTileset} instance for the Google Photorealistic 3D Tiles tileset.
+ * @example
+ * Cesium.GoogleMaps.defaultApiKey = "your-api-key";
+ *
+ * const viewer = new Cesium.Viewer("cesiumContainer");
+ *
+ * try {
+ *   const tileset = await Cesium.createGooglePhotorealistic3DTileset();
+ *   viewer.scene.primitives.add(tileset));
+ * } catch (error) {
+ *   console.log(`Error creating tileset: ${error}`);
+ * }
+ * @param [key = GoogleMaps.defaultApiKey] - Your API key to access Google Photorealistic 3D Tiles. See {@link https://developers.google.com/maps/documentation/javascript/get-api-key} for instructions on how to create your own key.
+ * @param [options] - An object describing initialization options.
+ */
+export function createGooglePhotorealistic3DTileset(key?: string, options?: Cesium3DTileset.ConstructorOptions): Promise<Cesium3DTileset>;
+
 /**
  * Creates a {@link Cesium3DTileset} instance for the
  * {@link https://cesium.com/content/cesium-osm-buildings/|Cesium OSM Buildings}