@itwin/core-common 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/Atmosphere.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Atmosphere = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+const core_bentley_1 = require("@itwin/core-bentley");
+/** Namespace containing types controlling how atmospheric scattering should be rendered.
+ * @beta
+ * The techniques used to render the atmosphere approximate the physical behavior of light when interacting with particles in the air (Rayleigh Scattering and Mie Scattering)
+ * Presently, only Rayleigh Scattering is implemented here
+ *
+ * In a nutshell, this implementation samples atmospheric density along rays cast from the view and uses the samples to simulate the scattering of light toward the camera.
+ * The amount of light scattered toward the camera is dependent on the amount of light scattered away from its original path from the sun, so rays must also be cast from the sample points to the sun.
+ *
+ * The effect can be computed on vertices (the default for the background map) and fragments (the default for the skybox, which is a ViewportQuad).
+ * All coordinates are in view space.
+ *
+ * This implementation is adapted from equations outlined in "Display of Clouds Taking into Account Multiple Anisotropic Scattering and Sky Light", Nishita et al. 1993
+ *   which are further refined for use in GPU shaders in "Photorealistic Real-Time Outdoor Light Scattering", Hoffman and Preetham 2002.
+ * These sources are also compiled in Chapter 16 of NVIDIA's "GPU Gems 2", which can be found online here:
+ *   https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering
+ *
+ * This implementation is also highly inspired by Sebastian Lague's Solar System project: https://github.com/SebLague/Solar-System/ and video: https://www.youtube.com/watch?v=DxfEbulyFcY
+ *   along with this ShaderToy replica: https://www.shadertoy.com/view/fltXD2.
+ * Both of which are inspired by this Nvidia article on atmospheric scattering: https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering.
+ */
+var Atmosphere;
+(function (Atmosphere) {
+    var _a;
+    /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */
+    class Wavelengths {
+        /** Constructs from red, green, and blue wavelength values.
+         * @param r Wavelength value for red
+         * @param g Wavelength value for green
+         * @param b Wavelength value for blue
+         */
+        constructor(props) {
+            this.r = Math.max(0, props.r);
+            this.g = Math.max(0, props.g);
+            this.b = Math.max(0, props.b);
+        }
+        equals(other) {
+            return this.r === other.r && this.g === other.g && this.b === other.b;
+        }
+        toJSON() {
+            return { r: this.r, g: this.g, b: this.b };
+        }
+        static fromJSON(json) {
+            let r = 0;
+            let g = 0;
+            let b = 0;
+            if (undefined !== json) {
+                if (typeof json.r === "number")
+                    r = json.r;
+                if (typeof json.g === "number")
+                    g = json.g;
+                if (typeof json.b === "number")
+                    b = json.b;
+            }
+            return new Wavelengths({ r, g, b });
+        }
+    }
+    Atmosphere.Wavelengths = Wavelengths;
+    /** Describes the properties with which the atmospheric scattering effect should be drawn. Theses properties correspond to a physics-based approximation of atmospheric scattering phenomenons. */
+    class Settings {
+        equals(other) {
+            if (this.atmosphereHeightAboveEarth !== other.atmosphereHeightAboveEarth)
+                return false;
+            if (this.exposure !== other.exposure)
+                return false;
+            if (this.densityFalloff !== other.densityFalloff)
+                return false;
+            if (this.depthBelowEarthForMaxDensity !== other.depthBelowEarthForMaxDensity)
+                return false;
+            if (this.numViewRaySamples !== other.numViewRaySamples)
+                return false;
+            if (this.numSunRaySamples !== other.numSunRaySamples)
+                return false;
+            if (this.scatteringStrength !== other.scatteringStrength)
+                return false;
+            if (!this.wavelengths.equals(other.wavelengths))
+                return false;
+            return true;
+        }
+        constructor(json) {
+            this.atmosphereHeightAboveEarth = core_bentley_1.JsonUtils.asDouble(json.atmosphereHeightAboveEarth, Settings._defaultAtmosphereHeightAboveEarth);
+            this.exposure = core_bentley_1.JsonUtils.asDouble(json.exposure, Settings._defaultExposure);
+            this.densityFalloff = core_bentley_1.JsonUtils.asDouble(json.densityFalloff, Settings._defaultDensityFalloff);
+            this.depthBelowEarthForMaxDensity = core_bentley_1.JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, Settings._defaultMinDensityHeightBelowEarth);
+            this.numViewRaySamples = core_bentley_1.JsonUtils.asDouble(json.numViewRaySamples, Settings._defaultNumViewRaySamples);
+            this.numSunRaySamples = core_bentley_1.JsonUtils.asDouble(json.numSunRaySamples, Settings._defaultNumSunRaySamples);
+            this.scatteringStrength = core_bentley_1.JsonUtils.asDouble(json.scatteringStrength, Settings._defaultScatteringStrength);
+            this.wavelengths = Wavelengths.fromJSON(core_bentley_1.JsonUtils.asObject(json.wavelengths) ?? Settings._defaultWavelengths);
+        }
+        static fromJSON(json) {
+            if (undefined === json)
+                return this.defaults;
+            return new Settings(json);
+        }
+        toJSON(display) {
+            const json = {
+                atmosphereHeightAboveEarth: this.atmosphereHeightAboveEarth,
+                exposure: this.exposure,
+                densityFalloff: this.densityFalloff,
+                depthBelowEarthForMaxDensity: this.depthBelowEarthForMaxDensity,
+                numViewRaySamples: this.numViewRaySamples,
+                numSunRaySamples: this.numSunRaySamples,
+                scatteringStrength: this.scatteringStrength,
+                wavelengths: this.wavelengths.toJSON(),
+            };
+            if (undefined !== display)
+                json.display = display;
+            return json;
+        }
+    }
+    _a = Settings;
+    Settings._defaultAtmosphereHeightAboveEarth = 100000.0;
+    Settings._defaultExposure = 2.0;
+    Settings._defaultDensityFalloff = 10.0;
+    Settings._defaultScatteringStrength = 100;
+    Settings._defaultWavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });
+    Settings._defaultNumViewRaySamples = 10;
+    Settings._highQualityNumViewRaySamples = 20;
+    Settings._defaultNumSunRaySamples = 5;
+    Settings.defaults = new Settings({});
+    Settings.highQuality = new Settings({ numViewRaySamples: _a._highQualityNumViewRaySamples });
+    Atmosphere.Settings = Settings;
+})(Atmosphere = exports.Atmosphere || (exports.Atmosphere = {}));
+//# sourceMappingURL=Atmosphere.js.map

package/lib/cjs/Atmosphere.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Atmosphere.js","sourceRoot":"","sources":["../../src/Atmosphere.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,IAAiB,UAAU,CAgK1B;AAhKD,WAAiB,UAAU;;IASzB,oIAAoI;IACpI,MAAa,WAAW;QAKtB;;;;WAIG;QACH,YAAY,KAAuB;YACjC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QAEM,MAAM,CAAC,KAAkB;YAC9B,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;QACxE,CAAC;QAEM,MAAM;YACX,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;QAC7C,CAAC;QAEM,MAAM,CAAC,QAAQ,CAAC,IAAkC;YACvD,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,QAAQ;oBAC5B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBACb,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,QAAQ;oBAC5B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBACb,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,QAAQ;oBAC5B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;aACd;YACD,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC;KACF;IAtCY,sBAAW,cAsCvB,CAAA;IAwBD,kMAAkM;IAClM,MAAa,QAAQ;QAgCZ,MAAM,CAAC,KAAe;YAC3B,IAAI,IAAI,CAAC,0BAA0B,KAAK,KAAK,CAAC,0BAA0B;gBACtE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;gBAClC,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,4BAA4B,KAAK,KAAK,CAAC,4BAA4B;gBAC1E,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;gBACpD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;gBAClD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB;gBACtD,OAAO,KAAK,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;gBAC7C,OAAO,KAAK,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAED,YAAoB,IAAW;YAC7B,IAAI,CAAC,0BAA0B,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,0BAA0B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACnI,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC/F,IAAI,CAAC,4BAA4B,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACvI,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;YACxG,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YACrG,IAAI,CAAC,kBAAkB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC3G,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAChH,CAAC;QAEM,MAAM,CAAC,QAAQ,CAAC,IAAY;YACjC,IAAI,SAAS,KAAK,IAAI;gBACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;YACvB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAEM,MAAM,CAAC,OAAiB;YAC7B,MAAM,IAAI,GAAU;gBAClB,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;gBAC3D,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;gBAC/D,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;gBACzC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;aACvC,CAAC;YAEF,IAAI,SAAS,KAAK,OAAO;gBACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YAEzB,OAAO,IAAI,CAAC;QACd,CAAC;;;IApFc,2CAAkC,GAAW,QAAQ,AAAnB,CAAoB;IACtD,yBAAgB,GAAW,GAAG,AAAd,CAAe;IAC/B,+BAAsB,GAAW,IAAI,AAAf,CAAgB;IAEtC,mCAA0B,GAAW,GAAG,AAAd,CAAe;IACzC,4BAAmB,GAAgB,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,AAAjE,CAAkE;IAErF,kCAAyB,GAAW,EAAE,AAAb,CAAc;IACvC,sCAA6B,GAAW,EAAE,AAAb,CAAc;IAC3C,iCAAwB,GAAW,CAAC,AAAZ,CAAa;IAE7B,iBAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,AAAnB,CAAoB;IAC5B,oBAAW,GAAG,IAAI,QAAQ,CAAC,EAAE,iBAAiB,EAAE,EAAI,CAAC,6BAA6B,EAAE,CAAC,AAA1E,CAA2E;IAblG,mBAAQ,WAsFpB,CAAA;AACH,CAAC,EAhKgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAgK1B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\nimport { JsonUtils } from \"@itwin/core-bentley\";\r\n\r\n/** Namespace containing types controlling how atmospheric scattering should be rendered.\r\n * @beta\r\n * The techniques used to render the atmosphere approximate the physical behavior of light when interacting with particles in the air (Rayleigh Scattering and Mie Scattering)\r\n * Presently, only Rayleigh Scattering is implemented here\r\n *\r\n * In a nutshell, this implementation samples atmospheric density along rays cast from the view and uses the samples to simulate the scattering of light toward the camera.\r\n * The amount of light scattered toward the camera is dependent on the amount of light scattered away from its original path from the sun, so rays must also be cast from the sample points to the sun.\r\n *\r\n * The effect can be computed on vertices (the default for the background map) and fragments (the default for the skybox, which is a ViewportQuad).\r\n * All coordinates are in view space.\r\n *\r\n * This implementation is adapted from equations outlined in \"Display of Clouds Taking into Account Multiple Anisotropic Scattering and Sky Light\", Nishita et al. 1993\r\n *   which are further refined for use in GPU shaders in \"Photorealistic Real-Time Outdoor Light Scattering\", Hoffman and Preetham 2002.\r\n * These sources are also compiled in Chapter 16 of NVIDIA's \"GPU Gems 2\", which can be found online here:\r\n *   https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering\r\n *\r\n * This implementation is also highly inspired by Sebastian Lague's Solar System project: https://github.com/SebLague/Solar-System/ and video: https://www.youtube.com/watch?v=DxfEbulyFcY\r\n *   along with this ShaderToy replica: https://www.shadertoy.com/view/fltXD2.\r\n * Both of which are inspired by this Nvidia article on atmospheric scattering: https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering.\r\n */\r\nexport namespace Atmosphere {\r\n\r\n  /** @internal JSON representation of a [[Wavelengths]] object */\r\n  export interface WavelengthsProps {\r\n    r: number;\r\n    g: number;\r\n    b: number;\r\n  }\r\n\r\n  /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */\r\n  export class Wavelengths {\r\n    public readonly r: number;\r\n    public readonly g: number;\r\n    public readonly b: number;\r\n\r\n    /** Constructs from red, green, and blue wavelength values.\r\n     * @param r Wavelength value for red\r\n     * @param g Wavelength value for green\r\n     * @param b Wavelength value for blue\r\n     */\r\n    constructor(props: WavelengthsProps) {\r\n      this.r = Math.max(0, props.r);\r\n      this.g = Math.max(0, props.g);\r\n      this.b = Math.max(0, props.b);\r\n    }\r\n\r\n    public equals(other: Wavelengths): boolean {\r\n      return this.r === other.r && this.g === other.g && this.b === other.b;\r\n    }\r\n\r\n    public toJSON(): WavelengthsProps {\r\n      return { r: this.r, g: this.g, b: this.b };\r\n    }\r\n\r\n    public static fromJSON(json: WavelengthsProps | undefined): Wavelengths {\r\n      let r = 0;\r\n      let g = 0;\r\n      let b = 0;\r\n      if (undefined !== json) {\r\n        if (typeof json.r === \"number\")\r\n          r = json.r;\r\n        if (typeof json.g === \"number\")\r\n          g = json.g;\r\n        if (typeof json.b === \"number\")\r\n          b = json.b;\r\n      }\r\n      return new Wavelengths({ r, g, b });\r\n    }\r\n  }\r\n\r\n  /** Describes the properties with which the atmospheric scattering effect should be drawn. Theses properties correspond to a physics-based approximation of atmospheric scattering phenomenons. */\r\n  export interface Props {\r\n    /** Whether the ground plane should be displayed. Defaults to false. */\r\n    display?: boolean;\r\n    /** @internal See [[Settings.atmosphereHeightAboveEarth]] */\r\n    atmosphereHeightAboveEarth?: number;\r\n    /** See [[Settings.exposure]] */\r\n    exposure?: number;\r\n    /** @internal See [[Settings.densityFalloff]] */\r\n    densityFalloff?: number;\r\n    /** @internal See [[Settings.minDensityHeightBelowEarth]] */\r\n    depthBelowEarthForMaxDensity?: number;\r\n    /** See [[Settings.numViewRaySamples]] */\r\n    numViewRaySamples?: number;\r\n    /** See [[Settings.numSunRaySamples]] */\r\n    numSunRaySamples?: number;\r\n    /** @internal See [[Settings.scatteringStrength]] */\r\n    scatteringStrength?: number;\r\n    /** @internal See [[Settings.wavelengths]] */\r\n    wavelengths?: WavelengthsProps;\r\n  }\r\n\r\n  /** Describes the properties with which the atmospheric scattering effect should be drawn. Theses properties correspond to a physics-based approximation of atmospheric scattering phenomenons. */\r\n  export class Settings {\r\n    private static _defaultAtmosphereHeightAboveEarth: number = 100000.0;\r\n    private static _defaultExposure: number = 2.0;\r\n    private static _defaultDensityFalloff: number = 10.0;\r\n    private static _defaultMinDensityHeightBelowEarth: 0.0;\r\n    private static _defaultScatteringStrength: number = 100;\r\n    private static _defaultWavelengths: Wavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });\r\n\r\n    private static _defaultNumViewRaySamples: number = 10;\r\n    private static _highQualityNumViewRaySamples: number = 20;\r\n    private static _defaultNumSunRaySamples: number = 5;\r\n\r\n    public static readonly defaults = new Settings({});\r\n    public static readonly highQuality = new Settings({ numViewRaySamples: this._highQualityNumViewRaySamples });\r\n\r\n    /** @internal If defined, corresponds to the height in meters above the earth's pole at which the atmosphere terminates. Physically, this is the point at which there are no more air molecules to interfere with light transmission. Defaults to 100_000.0. */\r\n    public readonly atmosphereHeightAboveEarth: number;\r\n    /** If defined, this value is used to simulate the aperture of a camera. Higher values allow more light in. This value might need to be adjusted slightly in situations without much sunlight (like sunset) to brighten the image. Defaults to 2.0 */\r\n    public readonly exposure: number;\r\n    /** @internal If defined, controls the rate at which the air density decreases between the point it is the highest and the point is is the lowest. A higher value means a faster decrease in air density. Defaults to 10.0. */\r\n    public readonly densityFalloff: number;\r\n    /** @internal If defined, corresponds to the height in meters below the earth's pole at which the atmosphere is at its densest. Physically, this is the point at which there is the most air molecules to interfere with light transmission. Defaults to 0.0. */\r\n    public readonly depthBelowEarthForMaxDensity: number;\r\n    /** If defined, corresponds to the number of atmospheric density samples used to compute the amount of light scattered along each view ray. For each sample point, another ray will be cast toward the sun to compute the amount of light reaching the sample point. Higher values increase fidelity, but greatly decrease performance because sun rays must be cast from each additional sample point. The range is 1 to 40. Defaults to 10. */\r\n    public readonly numViewRaySamples: number;\r\n    /** If defined, corresponds to the number of atmospheric density samples uses to compute the amount of light scattered along each sun ray. Higher values increase fidelity slightly but greatly decrease performance. Minimal improvement is observable with values above 5. The range is 1 to 40. Defaults to 5. */\r\n    public readonly numSunRaySamples: number;\r\n    /** @internal If defined, controls how strongly the atmosphere's air diverts light. Higher values increase scattering intensity. Defaults to 100.0. */\r\n    public readonly scatteringStrength: number;\r\n    /** @internal If defined, corresponds the wavelengths of the red, green and blue color components in nanometers used to simulate how the atmosphere's air molecules affects light transmission. (See Rayleigh Scattering) Thus, a value of 470 for the red wavelength will make the red light component scatter as if it physically were a cyan light ray. The default value is {r:700.0, g:530.0, b:440.0}. */\r\n    public readonly wavelengths: Wavelengths;\r\n\r\n    public equals(other: Settings): boolean {\r\n      if (this.atmosphereHeightAboveEarth !== other.atmosphereHeightAboveEarth)\r\n        return false;\r\n      if (this.exposure !== other.exposure)\r\n        return false;\r\n      if (this.densityFalloff !== other.densityFalloff)\r\n        return false;\r\n      if (this.depthBelowEarthForMaxDensity !== other.depthBelowEarthForMaxDensity)\r\n        return false;\r\n      if (this.numViewRaySamples !== other.numViewRaySamples)\r\n        return false;\r\n      if (this.numSunRaySamples !== other.numSunRaySamples)\r\n        return false;\r\n      if (this.scatteringStrength !== other.scatteringStrength)\r\n        return false;\r\n      if (!this.wavelengths.equals(other.wavelengths))\r\n        return false;\r\n      return true;\r\n    }\r\n\r\n    private constructor(json: Props) {\r\n      this.atmosphereHeightAboveEarth = JsonUtils.asDouble(json.atmosphereHeightAboveEarth, Settings._defaultAtmosphereHeightAboveEarth);\r\n      this.exposure = JsonUtils.asDouble(json.exposure, Settings._defaultExposure);\r\n      this.densityFalloff = JsonUtils.asDouble(json.densityFalloff, Settings._defaultDensityFalloff);\r\n      this.depthBelowEarthForMaxDensity = JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, Settings._defaultMinDensityHeightBelowEarth);\r\n      this.numViewRaySamples = JsonUtils.asDouble(json.numViewRaySamples, Settings._defaultNumViewRaySamples);\r\n      this.numSunRaySamples = JsonUtils.asDouble(json.numSunRaySamples, Settings._defaultNumSunRaySamples);\r\n      this.scatteringStrength = JsonUtils.asDouble(json.scatteringStrength, Settings._defaultScatteringStrength);\r\n      this.wavelengths = Wavelengths.fromJSON(JsonUtils.asObject(json.wavelengths) ?? Settings._defaultWavelengths);\r\n    }\r\n\r\n    public static fromJSON(json?: Props) {\r\n      if (undefined === json)\r\n        return this.defaults;\r\n      return new Settings(json);\r\n    }\r\n\r\n    public toJSON(display?: boolean): Props {\r\n      const json: Props = {\r\n        atmosphereHeightAboveEarth: this.atmosphereHeightAboveEarth,\r\n        exposure: this.exposure,\r\n        densityFalloff: this.densityFalloff,\r\n        depthBelowEarthForMaxDensity: this.depthBelowEarthForMaxDensity,\r\n        numViewRaySamples: this.numViewRaySamples,\r\n        numSunRaySamples: this.numSunRaySamples,\r\n        scatteringStrength: this.scatteringStrength,\r\n        wavelengths: this.wavelengths.toJSON(),\r\n      };\r\n\r\n      if (undefined !== display)\r\n        json.display = display;\r\n\r\n      return json;\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/AuthorizationClient.d.ts

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module Authorization
- */
-import { AccessToken } from "@itwin/core-bentley";
-/** Provides authorization to access APIs.
- * Bentley's iTwin platform APIs [use OAuth 2.0](https://developer.bentley.com/apis/overview/authorization/) for authorization.
- * Implementations are provided for [Electron](https://www.npmjs.com/package/@itwin/electron-authorization), [browsers](https://www.npmjs.com/package/@itwin/browser-authorization),
- * [services](https://www.npmjs.com/package/@itwin/service-authorization), and [command-line applications](https://www.npmjs.com/package/@itwin/node-cli-authorization).
- * @see [IModelHostOptions.authorizationClient]($backend) and [IModelAppOptions.authorizationClient]($frontend) to configure the client.
- * @see [IModelHost.authorizationClient]($backend) and [IModelApp.authorizationClient]($frontend) to access the configured client.
- * @note Access tokens expire periodically and are automatically refreshed when possible; therefore, tokens should always be requested via the client, not cached for later reuse.
- @public
- */
-export interface AuthorizationClient {
-    /** Obtain an [[AccessToken]] for the currently authorized user, or blank string if no token is available. */
-    getAccessToken(): Promise<AccessToken>;
-}
+/** @packageDocumentation
+ * @module Authorization
+ */
+import { AccessToken } from "@itwin/core-bentley";
+/** Provides authorization to access APIs.
+ * Bentley's iTwin platform APIs [use OAuth 2.0](https://developer.bentley.com/apis/overview/authorization/) for authorization.
+ * Implementations are provided for [Electron](https://www.npmjs.com/package/@itwin/electron-authorization), [browsers](https://www.npmjs.com/package/@itwin/browser-authorization),
+ * [services](https://www.npmjs.com/package/@itwin/service-authorization), and [command-line applications](https://www.npmjs.com/package/@itwin/node-cli-authorization).
+ * @see [IModelHostOptions.authorizationClient]($backend) and [IModelAppOptions.authorizationClient]($frontend) to configure the client.
+ * @see [IModelHost.authorizationClient]($backend) and [IModelApp.authorizationClient]($frontend) to access the configured client.
+ * @note Access tokens expire periodically and are automatically refreshed when possible; therefore, tokens should always be requested via the client, not cached for later reuse.
+ @public
+ */
+export interface AuthorizationClient {
+    /** Obtain an [[AccessToken]] for the currently authorized user, or blank string if no token is available. */
+    getAccessToken(): Promise<AccessToken>;
+}
 //# sourceMappingURL=AuthorizationClient.d.ts.map

package/lib/cjs/AuthorizationClient.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Authorization
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Authorization
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=AuthorizationClient.js.map

package/lib/cjs/BackendTypes.d.ts

@@ -1,13 +1,14 @@
-/** @packageDocumentation
- * @module Utils
- */
-/// <reference types="node" />
-import type { Readable, Writable } from "stream";
-import type { Buffer } from "buffer";
-/** @public @deprecated in 3.x. */
-export declare type BackendReadable = Readable;
-/** @public @deprecated in 3.x. */
-export declare type BackendWritable = Writable;
-/** @internal @deprecated in 3.x. */
-export declare type BackendBuffer = Buffer;
+/** @packageDocumentation
+ * @module Utils
+ */
+/// <reference types="node" />
+/// <reference types="node" />
+import type { Readable, Writable } from "stream";
+import type { Buffer } from "buffer";
+/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */
+export type BackendReadable = Readable;
+/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */
+export type BackendWritable = Writable;
+/** @internal @deprecated in 3.x. This type was mistakenly made public in the common scope. */
+export type BackendBuffer = Buffer;
 //# sourceMappingURL=BackendTypes.d.ts.map

package/lib/cjs/BackendTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackendTypes.d.ts","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AASrC,kCAAkC;AAClC,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,kCAAkC;AAClC,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,oCAAoC;AACpC,oBAAY,aAAa,GAAG,MAAM,CAAC"}
+{"version":3,"file":"BackendTypes.d.ts","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;;;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AASrC,4FAA4F;AAC5F,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC;AAEvC,4FAA4F;AAC5F,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC;AAEvC,8FAA8F;AAC9F,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}

package/lib/cjs/BackendTypes.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utils
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utils
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=BackendTypes.js.map

package/lib/cjs/BackendTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated in 3.x. */\r\nexport type BackendBuffer = Buffer;\r\n"]}
+{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendBuffer = Buffer;\r\n"]}

package/lib/cjs/BackgroundMapProvider.d.ts

@@ -1,52 +1,52 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
-/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
- * @public
- * @extensions
- */
-export declare enum BackgroundMapType {
-    Street = 1,
-    Aerial = 2,
-    Hybrid = 3
-}
-/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
- * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
- * @public
- * @extensions
- */
-export declare type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
-/** JSON representation of a [[BackgroundMapProvider]].
- * @see [[BaseMapLayerProps.provider]].
- * @public
- */
-export interface BackgroundMapProviderProps {
-    /** The name of the provider. Default: "BingProvider" */
-    name?: BackgroundMapProviderName;
-    /** The type of imagery to display. Default: Hybrid. */
-    type?: BackgroundMapType;
-}
-/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
- * @public
- */
-export declare class BackgroundMapProvider {
-    /** The name of the provider. */
-    readonly name: BackgroundMapProviderName;
-    /** The type of map imagery provided. */
-    readonly type: BackgroundMapType;
-    private constructor();
-    /** Create a provider from its JSON representation. */
-    static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider;
-    /** Convert this provider to its JSON representation. */
-    toJSON(): BackgroundMapProviderProps;
-    /** @internal */
-    static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
-    /** Return true if this provider is equivalent to `other`. */
-    equals(other: BackgroundMapProvider): boolean;
-    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
-     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
-     */
-    clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { DeprecatedBackgroundMapProps } from "./BackgroundMapSettings";
+/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
+ * @public
+ * @extensions
+ */
+export declare enum BackgroundMapType {
+    Street = 1,
+    Aerial = 2,
+    Hybrid = 3
+}
+/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
+ * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
+ * @public
+ * @extensions
+ */
+export type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
+/** JSON representation of a [[BackgroundMapProvider]].
+ * @see [[BaseMapLayerProps.provider]].
+ * @public
+ */
+export interface BackgroundMapProviderProps {
+    /** The name of the provider. Default: "BingProvider" */
+    name?: BackgroundMapProviderName;
+    /** The type of imagery to display. Default: Hybrid. */
+    type?: BackgroundMapType;
+}
+/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
+ * @public
+ */
+export declare class BackgroundMapProvider {
+    /** The name of the provider. */
+    readonly name: BackgroundMapProviderName;
+    /** The type of map imagery provided. */
+    readonly type: BackgroundMapType;
+    private constructor();
+    /** Create a provider from its JSON representation. */
+    static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider;
+    /** Convert this provider to its JSON representation. */
+    toJSON(): BackgroundMapProviderProps;
+    /** @internal */
+    static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider;
+    /** Return true if this provider is equivalent to `other`. */
+    equals(other: BackgroundMapProvider): boolean;
+    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
+     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
+     */
+    clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider;
+}
 //# sourceMappingURL=BackgroundMapProvider.d.ts.map

package/lib/cjs/BackgroundMapProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;GAIG;AACH,oBAAY,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}
+{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}

package/lib/cjs/BackgroundMapProvider.js

@@ -1,69 +1,68 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BackgroundMapProvider = exports.BackgroundMapType = void 0;
-/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
- * @public
- * @extensions
- */
-var BackgroundMapType;
-(function (BackgroundMapType) {
-    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
-    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
-    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
-})(BackgroundMapType = exports.BackgroundMapType || (exports.BackgroundMapType = {}));
-/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
- * @public
- */
-class BackgroundMapProvider {
-    constructor(name, type) {
-        this.name = name;
-        this.type = type;
-    }
-    /** Create a provider from its JSON representation. */
-    static fromJSON(props) {
-        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
-        let type;
-        switch (props.type) {
-            case BackgroundMapType.Street:
-            case BackgroundMapType.Aerial:
-                type = props.type;
-                break;
-            default:
-                type = BackgroundMapType.Hybrid;
-                break;
-        }
-        return new BackgroundMapProvider(name, type);
-    }
-    /** Convert this provider to its JSON representation. */
-    toJSON() {
-        return { name: this.name, type: this.type };
-    }
-    /** @internal */
-    static fromBackgroundMapProps(props) {
-        var _a;
-        // eslint-disable-next-line deprecation/deprecation
-        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
-    }
-    /** Return true if this provider is equivalent to `other`. */
-    equals(other) {
-        return this.name === other.name && this.type === other.type;
-    }
-    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
-     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
-     */
-    clone(changedProps) {
-        return BackgroundMapProvider.fromJSON({
-            ...this.toJSON(),
-            ...changedProps,
-        });
-    }
-}
-exports.BackgroundMapProvider = BackgroundMapProvider;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackgroundMapProvider = exports.BackgroundMapType = void 0;
+/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].
+ * @public
+ * @extensions
+ */
+var BackgroundMapType;
+(function (BackgroundMapType) {
+    BackgroundMapType[BackgroundMapType["Street"] = 1] = "Street";
+    BackgroundMapType[BackgroundMapType["Aerial"] = 2] = "Aerial";
+    BackgroundMapType[BackgroundMapType["Hybrid"] = 3] = "Hybrid";
+})(BackgroundMapType = exports.BackgroundMapType || (exports.BackgroundMapType = {}));
+/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].
+ * @public
+ */
+class BackgroundMapProvider {
+    constructor(name, type) {
+        this.name = name;
+        this.type = type;
+    }
+    /** Create a provider from its JSON representation. */
+    static fromJSON(props) {
+        const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
+        let type;
+        switch (props.type) {
+            case BackgroundMapType.Street:
+            case BackgroundMapType.Aerial:
+                type = props.type;
+                break;
+            default:
+                type = BackgroundMapType.Hybrid;
+                break;
+        }
+        return new BackgroundMapProvider(name, type);
+    }
+    /** Convert this provider to its JSON representation. */
+    toJSON() {
+        return { name: this.name, type: this.type };
+    }
+    /** @internal */
+    static fromBackgroundMapProps(props) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.fromJSON({ name: props.providerName, type: props.providerData?.mapType });
+    }
+    /** Return true if this provider is equivalent to `other`. */
+    equals(other) {
+        return this.name === other.name && this.type === other.type;
+    }
+    /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.
+     * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.
+     */
+    clone(changedProps) {
+        return BackgroundMapProvider.fromJSON({
+            ...this.toJSON(),
+            ...changedProps,
+        });
+    }
+}
+exports.BackgroundMapProvider = BackgroundMapProvider;
 //# sourceMappingURL=BackgroundMapProvider.js.map

package/lib/cjs/BackgroundMapProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}