@itwin/core-common 5.0.0-dev.56 → 5.0.0-dev.57

package/lib/esm/Atmosphere.js.map

@@ -1 +1 @@
-{"version":3,"file":"Atmosphere.js","sourceRoot":"","sources":["../../src/Atmosphere.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,KAAW,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,CAAC;gBACvB,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;YACf,CAAC;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;iBACJ,uCAAkC,GAAW,QAAQ,CAAC;iBACtD,qBAAgB,GAAW,GAAG,CAAC;iBAC/B,2BAAsB,GAAW,IAAI,CAAC;iBAEtC,+BAA0B,GAAW,GAAG,CAAC;iBACzC,wBAAmB,GAAgB,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;iBAErF,8BAAyB,GAAW,EAAE,CAAC;iBACvC,kCAA6B,GAAW,EAAE,CAAC;iBAC3C,6BAAwB,GAAW,CAAC,CAAC;iBAE7B,aAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;iBAC5B,gBAAW,GAAG,IAAI,QAAQ,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,6BAA6B,EAAE,CAAC,CAAC;QAmBtG,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,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,0BAA0B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACnI,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC/F,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACvI,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;YACxG,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YACrG,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC3G,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,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;;IArFU,mBAAQ,WAsFpB,CAAA;AACH,CAAC,EAhKgB,UAAU,KAAV,UAAU,QAgK1B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\nimport { JsonUtils } from \"@itwin/core-bentley\";\n\n/** Namespace containing types controlling how atmospheric scattering should be rendered.\n * @beta\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)\n * Presently, only Rayleigh Scattering is implemented here\n *\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.\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.\n *\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).\n * All coordinates are in view space.\n *\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\n *   which are further refined for use in GPU shaders in \"Photorealistic Real-Time Outdoor Light Scattering\", Hoffman and Preetham 2002.\n * These sources are also compiled in Chapter 16 of NVIDIA's \"GPU Gems 2\", which can be found online here:\n *   https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering\n *\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\n *   along with this ShaderToy replica: https://www.shadertoy.com/view/fltXD2.\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.\n */\nexport namespace Atmosphere {\n\n  /** @internal JSON representation of a [[Wavelengths]] object */\n  export interface WavelengthsProps {\n    r: number;\n    g: number;\n    b: number;\n  }\n\n  /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */\n  export class Wavelengths {\n    public readonly r: number;\n    public readonly g: number;\n    public readonly b: number;\n\n    /** Constructs from red, green, and blue wavelength values.\n     * @param r Wavelength value for red\n     * @param g Wavelength value for green\n     * @param b Wavelength value for blue\n     */\n    constructor(props: WavelengthsProps) {\n      this.r = Math.max(0, props.r);\n      this.g = Math.max(0, props.g);\n      this.b = Math.max(0, props.b);\n    }\n\n    public equals(other: Wavelengths): boolean {\n      return this.r === other.r && this.g === other.g && this.b === other.b;\n    }\n\n    public toJSON(): WavelengthsProps {\n      return { r: this.r, g: this.g, b: this.b };\n    }\n\n    public static fromJSON(json: WavelengthsProps | undefined): Wavelengths {\n      let r = 0;\n      let g = 0;\n      let b = 0;\n      if (undefined !== json) {\n        if (typeof json.r === \"number\")\n          r = json.r;\n        if (typeof json.g === \"number\")\n          g = json.g;\n        if (typeof json.b === \"number\")\n          b = json.b;\n      }\n      return new Wavelengths({ r, g, b });\n    }\n  }\n\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. */\n  export interface Props {\n    /** Whether the ground plane should be displayed. Defaults to false. */\n    display?: boolean;\n    /** @internal See [[Settings.atmosphereHeightAboveEarth]] */\n    atmosphereHeightAboveEarth?: number;\n    /** See [[Settings.exposure]] */\n    exposure?: number;\n    /** @internal See [[Settings.densityFalloff]] */\n    densityFalloff?: number;\n    /** @internal See [[Settings.minDensityHeightBelowEarth]] */\n    depthBelowEarthForMaxDensity?: number;\n    /** See [[Settings.numViewRaySamples]] */\n    numViewRaySamples?: number;\n    /** See [[Settings.numSunRaySamples]] */\n    numSunRaySamples?: number;\n    /** @internal See [[Settings.scatteringStrength]] */\n    scatteringStrength?: number;\n    /** @internal See [[Settings.wavelengths]] */\n    wavelengths?: WavelengthsProps;\n  }\n\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. */\n  export class Settings {\n    private static _defaultAtmosphereHeightAboveEarth: number = 100000.0;\n    private static _defaultExposure: number = 2.0;\n    private static _defaultDensityFalloff: number = 10.0;\n    private static _defaultMinDensityHeightBelowEarth: 0.0;\n    private static _defaultScatteringStrength: number = 100;\n    private static _defaultWavelengths: Wavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });\n\n    private static _defaultNumViewRaySamples: number = 10;\n    private static _highQualityNumViewRaySamples: number = 20;\n    private static _defaultNumSunRaySamples: number = 5;\n\n    public static readonly defaults = new Settings({});\n    public static readonly highQuality = new Settings({ numViewRaySamples: this._highQualityNumViewRaySamples });\n\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. */\n    public readonly atmosphereHeightAboveEarth: number;\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 */\n    public readonly exposure: number;\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. */\n    public readonly densityFalloff: number;\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. */\n    public readonly depthBelowEarthForMaxDensity: number;\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. */\n    public readonly numViewRaySamples: number;\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. */\n    public readonly numSunRaySamples: number;\n    /** @internal If defined, controls how strongly the atmosphere's air diverts light. Higher values increase scattering intensity. Defaults to 100.0. */\n    public readonly scatteringStrength: number;\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}. */\n    public readonly wavelengths: Wavelengths;\n\n    public equals(other: Settings): boolean {\n      if (this.atmosphereHeightAboveEarth !== other.atmosphereHeightAboveEarth)\n        return false;\n      if (this.exposure !== other.exposure)\n        return false;\n      if (this.densityFalloff !== other.densityFalloff)\n        return false;\n      if (this.depthBelowEarthForMaxDensity !== other.depthBelowEarthForMaxDensity)\n        return false;\n      if (this.numViewRaySamples !== other.numViewRaySamples)\n        return false;\n      if (this.numSunRaySamples !== other.numSunRaySamples)\n        return false;\n      if (this.scatteringStrength !== other.scatteringStrength)\n        return false;\n      if (!this.wavelengths.equals(other.wavelengths))\n        return false;\n      return true;\n    }\n\n    private constructor(json: Props) {\n      this.atmosphereHeightAboveEarth = JsonUtils.asDouble(json.atmosphereHeightAboveEarth, Settings._defaultAtmosphereHeightAboveEarth);\n      this.exposure = JsonUtils.asDouble(json.exposure, Settings._defaultExposure);\n      this.densityFalloff = JsonUtils.asDouble(json.densityFalloff, Settings._defaultDensityFalloff);\n      this.depthBelowEarthForMaxDensity = JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, Settings._defaultMinDensityHeightBelowEarth);\n      this.numViewRaySamples = JsonUtils.asDouble(json.numViewRaySamples, Settings._defaultNumViewRaySamples);\n      this.numSunRaySamples = JsonUtils.asDouble(json.numSunRaySamples, Settings._defaultNumSunRaySamples);\n      this.scatteringStrength = JsonUtils.asDouble(json.scatteringStrength, Settings._defaultScatteringStrength);\n      this.wavelengths = Wavelengths.fromJSON(JsonUtils.asObject(json.wavelengths) ?? Settings._defaultWavelengths);\n    }\n\n    public static fromJSON(json?: Props) {\n      if (undefined === json)\n        return this.defaults;\n      return new Settings(json);\n    }\n\n    public toJSON(display?: boolean): Props {\n      const json: Props = {\n        atmosphereHeightAboveEarth: this.atmosphereHeightAboveEarth,\n        exposure: this.exposure,\n        densityFalloff: this.densityFalloff,\n        depthBelowEarthForMaxDensity: this.depthBelowEarthForMaxDensity,\n        numViewRaySamples: this.numViewRaySamples,\n        numSunRaySamples: this.numSunRaySamples,\n        scatteringStrength: this.scatteringStrength,\n        wavelengths: this.wavelengths.toJSON(),\n      };\n\n      if (undefined !== display)\n        json.display = display;\n\n      return json;\n    }\n  }\n}\n"]}
+{"version":3,"file":"Atmosphere.js","sourceRoot":"","sources":["../../src/Atmosphere.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,KAAW,UAAU,CAgK1B;AAhKD,WAAiB,UAAU;IASzB,oIAAoI;IACpI,MAAa,WAAW;QACN,CAAC,CAAS;QACV,CAAC,CAAS;QACV,CAAC,CAAS;QAE1B;;;;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,CAAC;gBACvB,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;YACf,CAAC;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;QACX,MAAM,CAAC,kCAAkC,GAAW,QAAQ,CAAC;QAC7D,MAAM,CAAC,gBAAgB,GAAW,GAAG,CAAC;QACtC,MAAM,CAAC,sBAAsB,GAAW,IAAI,CAAC;QAC7C,MAAM,CAAC,kCAAkC,CAAM;QAC/C,MAAM,CAAC,0BAA0B,GAAW,GAAG,CAAC;QAChD,MAAM,CAAC,mBAAmB,GAAgB,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5F,MAAM,CAAC,yBAAyB,GAAW,EAAE,CAAC;QAC9C,MAAM,CAAC,6BAA6B,GAAW,EAAE,CAAC;QAClD,MAAM,CAAC,wBAAwB,GAAW,CAAC,CAAC;QAE7C,MAAM,CAAU,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAU,WAAW,GAAG,IAAI,QAAQ,CAAC,EAAE,iBAAiB,EAAE,IAAI,CAAC,6BAA6B,EAAE,CAAC,CAAC;QAE7G,+PAA+P;QAC/O,0BAA0B,CAAS;QACnD,qPAAqP;QACrO,QAAQ,CAAS;QACjC,8NAA8N;QAC9M,cAAc,CAAS;QACvC,gQAAgQ;QAChP,4BAA4B,CAAS;QACrD,gbAAgb;QACha,iBAAiB,CAAS;QAC1C,oTAAoT;QACpS,gBAAgB,CAAS;QACzC,sJAAsJ;QACtI,kBAAkB,CAAS;QAC3C,+YAA+Y;QAC/X,WAAW,CAAc;QAElC,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,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,0BAA0B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACnI,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC/F,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACvI,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;YACxG,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YACrG,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC3G,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,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;;IArFU,mBAAQ,WAsFpB,CAAA;AACH,CAAC,EAhKgB,UAAU,KAAV,UAAU,QAgK1B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\nimport { JsonUtils } from \"@itwin/core-bentley\";\n\n/** Namespace containing types controlling how atmospheric scattering should be rendered.\n * @beta\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)\n * Presently, only Rayleigh Scattering is implemented here\n *\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.\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.\n *\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).\n * All coordinates are in view space.\n *\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\n *   which are further refined for use in GPU shaders in \"Photorealistic Real-Time Outdoor Light Scattering\", Hoffman and Preetham 2002.\n * These sources are also compiled in Chapter 16 of NVIDIA's \"GPU Gems 2\", which can be found online here:\n *   https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering\n *\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\n *   along with this ShaderToy replica: https://www.shadertoy.com/view/fltXD2.\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.\n */\nexport namespace Atmosphere {\n\n  /** @internal JSON representation of a [[Wavelengths]] object */\n  export interface WavelengthsProps {\n    r: number;\n    g: number;\n    b: number;\n  }\n\n  /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */\n  export class Wavelengths {\n    public readonly r: number;\n    public readonly g: number;\n    public readonly b: number;\n\n    /** Constructs from red, green, and blue wavelength values.\n     * @param r Wavelength value for red\n     * @param g Wavelength value for green\n     * @param b Wavelength value for blue\n     */\n    constructor(props: WavelengthsProps) {\n      this.r = Math.max(0, props.r);\n      this.g = Math.max(0, props.g);\n      this.b = Math.max(0, props.b);\n    }\n\n    public equals(other: Wavelengths): boolean {\n      return this.r === other.r && this.g === other.g && this.b === other.b;\n    }\n\n    public toJSON(): WavelengthsProps {\n      return { r: this.r, g: this.g, b: this.b };\n    }\n\n    public static fromJSON(json: WavelengthsProps | undefined): Wavelengths {\n      let r = 0;\n      let g = 0;\n      let b = 0;\n      if (undefined !== json) {\n        if (typeof json.r === \"number\")\n          r = json.r;\n        if (typeof json.g === \"number\")\n          g = json.g;\n        if (typeof json.b === \"number\")\n          b = json.b;\n      }\n      return new Wavelengths({ r, g, b });\n    }\n  }\n\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. */\n  export interface Props {\n    /** Whether the ground plane should be displayed. Defaults to false. */\n    display?: boolean;\n    /** @internal See [[Settings.atmosphereHeightAboveEarth]] */\n    atmosphereHeightAboveEarth?: number;\n    /** See [[Settings.exposure]] */\n    exposure?: number;\n    /** @internal See [[Settings.densityFalloff]] */\n    densityFalloff?: number;\n    /** @internal See [[Settings.minDensityHeightBelowEarth]] */\n    depthBelowEarthForMaxDensity?: number;\n    /** See [[Settings.numViewRaySamples]] */\n    numViewRaySamples?: number;\n    /** See [[Settings.numSunRaySamples]] */\n    numSunRaySamples?: number;\n    /** @internal See [[Settings.scatteringStrength]] */\n    scatteringStrength?: number;\n    /** @internal See [[Settings.wavelengths]] */\n    wavelengths?: WavelengthsProps;\n  }\n\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. */\n  export class Settings {\n    private static _defaultAtmosphereHeightAboveEarth: number = 100000.0;\n    private static _defaultExposure: number = 2.0;\n    private static _defaultDensityFalloff: number = 10.0;\n    private static _defaultMinDensityHeightBelowEarth: 0.0;\n    private static _defaultScatteringStrength: number = 100;\n    private static _defaultWavelengths: Wavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });\n\n    private static _defaultNumViewRaySamples: number = 10;\n    private static _highQualityNumViewRaySamples: number = 20;\n    private static _defaultNumSunRaySamples: number = 5;\n\n    public static readonly defaults = new Settings({});\n    public static readonly highQuality = new Settings({ numViewRaySamples: this._highQualityNumViewRaySamples });\n\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. */\n    public readonly atmosphereHeightAboveEarth: number;\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 */\n    public readonly exposure: number;\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. */\n    public readonly densityFalloff: number;\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. */\n    public readonly depthBelowEarthForMaxDensity: number;\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. */\n    public readonly numViewRaySamples: number;\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. */\n    public readonly numSunRaySamples: number;\n    /** @internal If defined, controls how strongly the atmosphere's air diverts light. Higher values increase scattering intensity. Defaults to 100.0. */\n    public readonly scatteringStrength: number;\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}. */\n    public readonly wavelengths: Wavelengths;\n\n    public equals(other: Settings): boolean {\n      if (this.atmosphereHeightAboveEarth !== other.atmosphereHeightAboveEarth)\n        return false;\n      if (this.exposure !== other.exposure)\n        return false;\n      if (this.densityFalloff !== other.densityFalloff)\n        return false;\n      if (this.depthBelowEarthForMaxDensity !== other.depthBelowEarthForMaxDensity)\n        return false;\n      if (this.numViewRaySamples !== other.numViewRaySamples)\n        return false;\n      if (this.numSunRaySamples !== other.numSunRaySamples)\n        return false;\n      if (this.scatteringStrength !== other.scatteringStrength)\n        return false;\n      if (!this.wavelengths.equals(other.wavelengths))\n        return false;\n      return true;\n    }\n\n    private constructor(json: Props) {\n      this.atmosphereHeightAboveEarth = JsonUtils.asDouble(json.atmosphereHeightAboveEarth, Settings._defaultAtmosphereHeightAboveEarth);\n      this.exposure = JsonUtils.asDouble(json.exposure, Settings._defaultExposure);\n      this.densityFalloff = JsonUtils.asDouble(json.densityFalloff, Settings._defaultDensityFalloff);\n      this.depthBelowEarthForMaxDensity = JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, Settings._defaultMinDensityHeightBelowEarth);\n      this.numViewRaySamples = JsonUtils.asDouble(json.numViewRaySamples, Settings._defaultNumViewRaySamples);\n      this.numSunRaySamples = JsonUtils.asDouble(json.numSunRaySamples, Settings._defaultNumSunRaySamples);\n      this.scatteringStrength = JsonUtils.asDouble(json.scatteringStrength, Settings._defaultScatteringStrength);\n      this.wavelengths = Wavelengths.fromJSON(JsonUtils.asObject(json.wavelengths) ?? Settings._defaultWavelengths);\n    }\n\n    public static fromJSON(json?: Props) {\n      if (undefined === json)\n        return this.defaults;\n      return new Settings(json);\n    }\n\n    public toJSON(display?: boolean): Props {\n      const json: Props = {\n        atmosphereHeightAboveEarth: this.atmosphereHeightAboveEarth,\n        exposure: this.exposure,\n        densityFalloff: this.densityFalloff,\n        depthBelowEarthForMaxDensity: this.depthBelowEarthForMaxDensity,\n        numViewRaySamples: this.numViewRaySamples,\n        numSunRaySamples: this.numSunRaySamples,\n        scatteringStrength: this.scatteringStrength,\n        wavelengths: this.wavelengths.toJSON(),\n      };\n\n      if (undefined !== display)\n        json.display = display;\n\n      return json;\n    }\n  }\n}\n"]}

package/lib/esm/BackgroundMapProvider.js

@@ -19,6 +19,10 @@ export var BackgroundMapType;
  * @public
  */
 export class BackgroundMapProvider {
+    /** The name of the provider. */
+    name;
+    /** The type of map imagery provided. */
+    type;
     constructor(name, type) {
         this.name = name;
         this.type = type;

package/lib/esm/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,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAM,OAAO,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAChC,gCAAgC;IAChB,IAAI,CAA4B;IAChD,wCAAwC;IACxB,IAAI,CAAoB;IAExC,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}

package/lib/esm/BackgroundMapSettings.js

@@ -35,6 +35,25 @@ function normalizeTransparency(trans) {
  * @public
  */
 export class BackgroundMapSettings {
+    /** Retained strictly for persistence. */
+    _provider;
+    /** Elevation in meters, relative to WGS84 Ellipsoid.. */
+    groundBias;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
+    transparency;
+    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
+    useDepthBuffer;
+    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
+    applyTerrain;
+    /** Settings associated with terrain display. */
+    terrainSettings;
+    /** Globe display mode. */
+    globeMode;
+    /** Planar Mask - used to mask the background map to avoid overlapping with other geometry
+     * @beta
+     */
+    planarClipMask;
+    _locatable;
     /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
      * allows the user to select elements that are behind the map.
      */

package/lib/esm/BackgroundMapSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAgED,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAqBhC;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7H,YAAoB,KAAwD;QAC1E,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,uDAAuD;QACnG,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,uDAAuD;QAEhH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,YAAY,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\n   * Default value: false.\n   */\n  transparency?: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\n   * Default value: \"BingProvider\"\n   * @deprecated in 3.x. use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.x. use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\n  public readonly transparency: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}
+{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAgED,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAChC,yCAAyC;IACxB,SAAS,CAAwB;IAElD,yDAAyD;IACzC,UAAU,CAAS;IACnC,2MAA2M;IAC3L,YAAY,CAAiB;IAC7C,+LAA+L;IAC/K,cAAc,CAAU;IACxC,0GAA0G;IAC1F,YAAY,CAAU;IACtC,gDAAgD;IAChC,eAAe,CAAkB;IACjD,0BAA0B;IACV,SAAS,CAAY;IACrC;;OAEG;IACa,cAAc,CAAyB;IACtC,UAAU,CAAU;IACrC;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7H,YAAoB,KAAwD;QAC1E,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,uDAAuD;QACnG,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,uDAAuD;QAEhH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,YAAY,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\n   * Default value: false.\n   */\n  transparency?: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\n   * Default value: \"BingProvider\"\n   * @deprecated in 3.x. use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.x. use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\n  public readonly transparency: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}

package/lib/esm/BlobReader.js

@@ -1,9 +1,7 @@
 import { BlobOptionsBuilder, DbQueryError, DbRequestKind, } from "./ConcurrentQuery";
 /** @beta */
 export class Uint8Chunks {
-    constructor() {
-        this._chunks = [];
-    }
+    _chunks = [];
     append(chunk) {
         this._chunks.push(chunk);
     }
@@ -25,14 +23,18 @@ export class Uint8Chunks {
 }
 /** @beta */
 export class BlobReader {
+    _executor;
+    className;
+    accessString;
+    instanceId;
+    _chunks = new Uint8Chunks();
+    _lengthToRead = -1;
+    _options = new BlobOptionsBuilder().getOptions();
     constructor(_executor, className, accessString, instanceId, options) {
         this._executor = _executor;
         this.className = className;
         this.accessString = accessString;
         this.instanceId = instanceId;
-        this._chunks = new Uint8Chunks();
-        this._lengthToRead = -1;
-        this._options = new BlobOptionsBuilder().getOptions();
         this.reset(options);
     }
     reset(options) {

package/lib/esm/BlobReader.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACQ,kBAAkB,EAA4C,YAAY,EAAqB,aAAa,GAC1H,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,WAAW;IAAxB;QACU,YAAO,GAAiB,EAAE,CAAC;IAmBrC,CAAC;IAlBQ,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AACD,YAAY;AACZ,MAAM,OAAO,UAAU;IAIrB,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QANhC,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,aAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;QAMvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\n} from \"./ConcurrentQuery\";\n\n/** @beta */\nexport class Uint8Chunks implements Iterable<Uint8Array> {\n  private _chunks: Uint8Array[] = [];\n  public append(chunk: Uint8Array) {\n    this._chunks.push(chunk);\n  }\n  public at(idx: number) { return this._chunks[idx]; }\n  public get length() { return this._chunks.length; }\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\n    return (this._chunks as any)[Symbol.iterator];\n  }\n  public combine(): Uint8Array {\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\n    const combineChunk = new Uint8Array(totalChunkLength);\n    let offset = 0;\n    for (const array of this._chunks) {\n      combineChunk.set(array, offset);\n      offset += array.length;\n    }\n    return combineChunk;\n  }\n}\n/** @beta */\nexport class BlobReader {\n  private _chunks = new Uint8Chunks();\n  private _lengthToRead: number = -1;\n  private _options = new BlobOptionsBuilder().getOptions();\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\n    public readonly className: string,\n    public readonly accessString: string,\n    public readonly instanceId: Id64String,\n    options?: BlobOptions) {\n    this.reset(options);\n  }\n  public reset(options?: BlobOptions) {\n    if (options) {\n      this._options = options;\n    }\n    this._chunks = new Uint8Chunks();\n    this._lengthToRead = this.range.count!;\n  }\n  public get range(): BlobRange { return this._options.range!; }\n  public async step(): Promise<boolean> {\n    if (this._lengthToRead === this._chunks.length) {\n      return false;\n    }\n    const request: DbBlobRequest = {\n      kind: DbRequestKind.BlobIO,\n      className: this.className,\n      accessString: this.accessString,\n      instanceId: this.instanceId,\n      ...this._options,\n    };\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\n    const resp = await this._executor.execute(request);\n    DbQueryError.throwIfError(resp, request);\n\n    if (this._lengthToRead === -1) {\n      this._lengthToRead = resp.rawBlobSize;\n    }\n    if (resp.data && resp.data.length > 0) {\n      this._chunks.append(resp.data);\n    }\n    return true;\n  }\n  public async readToEnd(): Promise<Uint8Array> {\n    while (await this.step()) { }\n    return this._chunks.combine();\n  }\n  public get current(): Uint8Array {\n    if (this._chunks.length === 0) {\n      throw new Error(\"there is no current buffer\");\n    }\n    return this._chunks.at(this._chunks.length);\n  }\n  public get chunks(): Uint8Chunks { return this._chunks; }\n}\n"]}
+{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACQ,kBAAkB,EAA4C,YAAY,EAAqB,aAAa,GAC1H,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,WAAW;IACd,OAAO,GAAiB,EAAE,CAAC;IAC5B,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;QACzB,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AACD,YAAY;AACZ,MAAM,OAAO,UAAU;IAIM;IACT;IACA;IACA;IANV,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAC5B,aAAa,GAAW,CAAC,CAAC,CAAC;IAC3B,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;IACzD,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QAEtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\n} from \"./ConcurrentQuery\";\n\n/** @beta */\nexport class Uint8Chunks implements Iterable<Uint8Array> {\n  private _chunks: Uint8Array[] = [];\n  public append(chunk: Uint8Array) {\n    this._chunks.push(chunk);\n  }\n  public at(idx: number) { return this._chunks[idx]; }\n  public get length() { return this._chunks.length; }\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\n    return (this._chunks as any)[Symbol.iterator];\n  }\n  public combine(): Uint8Array {\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\n    const combineChunk = new Uint8Array(totalChunkLength);\n    let offset = 0;\n    for (const array of this._chunks) {\n      combineChunk.set(array, offset);\n      offset += array.length;\n    }\n    return combineChunk;\n  }\n}\n/** @beta */\nexport class BlobReader {\n  private _chunks = new Uint8Chunks();\n  private _lengthToRead: number = -1;\n  private _options = new BlobOptionsBuilder().getOptions();\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\n    public readonly className: string,\n    public readonly accessString: string,\n    public readonly instanceId: Id64String,\n    options?: BlobOptions) {\n    this.reset(options);\n  }\n  public reset(options?: BlobOptions) {\n    if (options) {\n      this._options = options;\n    }\n    this._chunks = new Uint8Chunks();\n    this._lengthToRead = this.range.count!;\n  }\n  public get range(): BlobRange { return this._options.range!; }\n  public async step(): Promise<boolean> {\n    if (this._lengthToRead === this._chunks.length) {\n      return false;\n    }\n    const request: DbBlobRequest = {\n      kind: DbRequestKind.BlobIO,\n      className: this.className,\n      accessString: this.accessString,\n      instanceId: this.instanceId,\n      ...this._options,\n    };\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\n    const resp = await this._executor.execute(request);\n    DbQueryError.throwIfError(resp, request);\n\n    if (this._lengthToRead === -1) {\n      this._lengthToRead = resp.rawBlobSize;\n    }\n    if (resp.data && resp.data.length > 0) {\n      this._chunks.append(resp.data);\n    }\n    return true;\n  }\n  public async readToEnd(): Promise<Uint8Array> {\n    while (await this.step()) { }\n    return this._chunks.combine();\n  }\n  public get current(): Uint8Array {\n    if (this._chunks.length === 0) {\n      throw new Error(\"there is no current buffer\");\n    }\n    return this._chunks.at(this._chunks.length);\n  }\n  public get chunks(): Uint8Chunks { return this._chunks; }\n}\n"]}

package/lib/esm/Camera.js

@@ -12,6 +12,9 @@ import { Angle, Point3d } from "@itwin/core-geometry";
  * @public
  */
 export class Camera {
+    lens;
+    focusDist;
+    eye;
     static isValidLensAngle(val) {
         return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;
     }

package/lib/esm/Camera.js.map

@@ -1 +1 @@
-{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAc,OAAO,EAAoB,MAAM,sBAAsB,CAAC;AAYpF;;;GAGG;AACH,MAAM,OAAO,MAAM;IAKV,MAAM,CAAC,gBAAgB,CAAC,GAAU;QACvC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,GAAU;QACxC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { JsonUtils } from \"@itwin/core-bentley\";\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[Camera]].\n * @public\n * @extensions\n */\nexport interface CameraProps {\n  lens: AngleProps;\n  focusDist: number; // NOTE: this is abbreviated, do not change!\n  eye: XYZProps;\n}\n\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\n * @see [Views]($docs/learning/frontend/Views.md)\n * @public\n */\nexport class Camera implements CameraProps {\n  public readonly lens: Angle;\n  public focusDist: number;\n  public readonly eye: Point3d;\n\n  public static isValidLensAngle(val: Angle) {\n    return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;\n  }\n\n  public static validateLensAngle(val: Angle) {\n    if (!this.isValidLensAngle(val))\n      val.setRadians(Math.PI / 2.0);\n  }\n\n  public invalidateFocus() { this.focusDist = 0.0; }\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\n  public getFocusDistance() { return this.focusDist; }\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\n  public validateLens() { Camera.validateLensAngle(this.lens); }\n  public getLensAngle() { return this.lens; }\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\n  public getEyePoint() { return this.eye; }\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\n  public equals(other: Camera) {\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\n      this.eye.isAlmostEqual(other.eye);\n  }\n  public clone() { return new Camera(this); }\n  public setFrom(rhs: Camera) {\n    this.lens.setFrom(rhs.lens);\n    this.focusDist = rhs.focusDist;\n    this.eye.setFrom(rhs.eye);\n  }\n\n  /** Construct a Camera\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\n   */\n  public constructor(props?: CameraProps) {\n    if (props !== undefined) {\n      this.lens = Angle.fromJSON(props.lens);\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\n      this.eye = Point3d.fromJSON(props.eye);\n      return;\n    }\n    this.lens = Angle.createRadians(Math.PI / 2.0);\n    this.focusDist = 1;\n    this.eye = new Point3d();\n  }\n}\n"]}
+{"version":3,"file":"Camera.js","sourceRoot":"","sources":["../../src/Camera.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAc,OAAO,EAAoB,MAAM,sBAAsB,CAAC;AAYpF;;;GAGG;AACH,MAAM,OAAO,MAAM;IACD,IAAI,CAAQ;IACrB,SAAS,CAAS;IACT,GAAG,CAAU;IAEtB,MAAM,CAAC,gBAAgB,CAAC,GAAU;QACvC,OAAO,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,GAAU;QACxC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAC7B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IAEM,eAAe,KAAK,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC;IAC9E,gBAAgB,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,gBAAgB,CAAC,IAAY,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,IAAW,WAAW,KAAK,OAAO,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,YAAY,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvD,YAAY,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACpC,YAAY,CAAC,KAAY,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,CAAC,EAAU,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACxD,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAa;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG;YAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACM,KAAK,KAAK,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAW;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,YAAmB,KAAmB;QACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { JsonUtils } from \"@itwin/core-bentley\";\nimport { Angle, AngleProps, Point3d, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[Camera]].\n * @public\n * @extensions\n */\nexport interface CameraProps {\n  lens: AngleProps;\n  focusDist: number; // NOTE: this is abbreviated, do not change!\n  eye: XYZProps;\n}\n\n/** The current position (eyepoint), lens angle, and focus distance of a camera.\n * @see [Views]($docs/learning/frontend/Views.md)\n * @public\n */\nexport class Camera implements CameraProps {\n  public readonly lens: Angle;\n  public focusDist: number;\n  public readonly eye: Point3d;\n\n  public static isValidLensAngle(val: Angle) {\n    return val.radians > (Math.PI / 8.0) && val.radians < Math.PI;\n  }\n\n  public static validateLensAngle(val: Angle) {\n    if (!this.isValidLensAngle(val))\n      val.setRadians(Math.PI / 2.0);\n  }\n\n  public invalidateFocus() { this.focusDist = 0.0; }\n  public get isFocusValid() { return this.focusDist > 0.0 && this.focusDist < 1.0e14; }\n  public getFocusDistance() { return this.focusDist; }\n  public setFocusDistance(dist: number) { this.focusDist = dist; }\n  public get isLensValid() { return Camera.isValidLensAngle(this.lens); }\n  public validateLens() { Camera.validateLensAngle(this.lens); }\n  public getLensAngle() { return this.lens; }\n  public setLensAngle(angle: Angle) { this.lens.setFrom(angle); }\n  public getEyePoint() { return this.eye; }\n  public setEyePoint(pt: XYAndZ) { this.eye.setFrom(pt); }\n  public get isValid() { return this.isLensValid && this.isFocusValid; }\n  public equals(other: Camera) {\n    return Math.abs(this.lens.radians - other.lens.radians) < .01 &&\n      Math.abs(this.focusDist - other.focusDist) < .1 &&\n      this.eye.isAlmostEqual(other.eye);\n  }\n  public clone() { return new Camera(this); }\n  public setFrom(rhs: Camera) {\n    this.lens.setFrom(rhs.lens);\n    this.focusDist = rhs.focusDist;\n    this.eye.setFrom(rhs.eye);\n  }\n\n  /** Construct a Camera\n   * @param props The properties of the new camera. If undefined, create a camera with eye at {0,0,0}, 90 degree lens, 1 meter focus distance.\n   */\n  public constructor(props?: CameraProps) {\n    if (props !== undefined) {\n      this.lens = Angle.fromJSON(props.lens);\n      this.focusDist = JsonUtils.asDouble(props.focusDist);\n      this.eye = Point3d.fromJSON(props.eye);\n      return;\n    }\n    this.lens = Angle.createRadians(Math.PI / 2.0);\n    this.focusDist = 1;\n    this.eye = new Point3d();\n  }\n}\n"]}

package/lib/esm/ClipStyle.js

@@ -15,8 +15,14 @@ import { ColorDef } from "./ColorDef";
  * @public
  */
 export class CutStyle {
+    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
+    viewflags;
+    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
+    hiddenLine;
+    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
+    appearance;
     /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
-    static { this.defaults = new CutStyle(); }
+    static defaults = new CutStyle();
     constructor(viewflags, hiddenLine, appearance) {
         this.viewflags = viewflags ?? {};
         if (hiddenLine && !hiddenLine.matchesDefaults)
@@ -67,6 +73,10 @@ export class CutStyle {
  * @extensions
  */
 export class ClipIntersectionStyle {
+    /** Color to apply to intersection of geometry and clip planes, default white */
+    color;
+    /** Number of pixels to be considered intersecting the clip plane, default 1 */
+    width;
     constructor(color = RgbColor.fromColorDef(ColorDef.white), width = 1) {
         this.color = color;
         this.width = width;
@@ -77,7 +87,7 @@ export class ClipIntersectionStyle {
             return this.defaults;
         return new ClipIntersectionStyle(color, width);
     }
-    static { this.defaults = new ClipIntersectionStyle(); }
+    static defaults = new ClipIntersectionStyle();
     static fromJSON(props) {
         if (props === undefined) {
             return ClipIntersectionStyle.defaults;
@@ -109,8 +119,24 @@ export class ClipIntersectionStyle {
  * @public
  */
 export class ClipStyle {
+    /** If `true`, geometry will be produced at the clip planes.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    produceCutGeometry;
+    /** If 'true', intersection of geometry and clip planes will be colorized */
+    colorizeIntersection;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    cutStyle;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    insideColor;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    outsideColor;
+    /** Controls the style of the intersection of geometry and clip planes */
+    intersectionStyle;
     /** The default style, which overrides none of the view's settings. */
-    static { this.defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined); }
+    static defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined);
     constructor(produceCutGeometry, colorizeIntersection, cutStyle, inside, outside, intersectionStyle) {
         this.produceCutGeometry = produceCutGeometry;
         this.colorizeIntersection = colorizeIntersection;

package/lib/esm/ClipStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBtC;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAQnB,sHAAsH;aAC/F,aAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAEjD,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAeH;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAMhC,YAAoB,QAAkB,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAgB,CAAC;QAC5F,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,+CAA+C;IACxC,MAAM,CAAC,MAAM,CAAC,KAAgB,EAAE,KAAc;QACnD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK;YAClB,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;aAEsB,aAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAEvD,MAAM,CAAC,QAAQ,CAAC,KAAkC;QACvD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,qBAAqB,CAAC,QAAQ,CAAC;QACxC,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnG,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,MAAM,KAAK,GAA+B,EAAE,CAAC;QAE7C,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,KAAK;YACZ,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,IAAI,IAAI,CAAC,KAAK;YACZ,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,qBAAqB,CAAC,QAAQ;YACzC,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACpC,CAAC;;AAkDH;;;GAGG;AACH,MAAM,OAAO,SAAS;IAkBpB,sEAAsE;aAC/C,aAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAElH,YAAoB,kBAA2B,EAAE,oBAA6B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B,EAAE,iBAAoD;QACnN,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAQD,gBAAgB;IACT,MAAM,CAAC,MAAM,CAAC,yBAAwD,EAAE,QAAmB,EAAE,WAAsB,EAAE,YAAuB;QAEjJ,IAAI,OAAO,yBAAyB,KAAK,SAAS,EAAE,CAAC;YACnD,QAAQ,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;YAEjE,IAAI,CAAC,yBAAyB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC5F,OAAO,IAAI,CAAC,QAAQ,CAAC;YACvB,CAAC;YAED,OAAO,IAAI,SAAS,CAAC,yBAAyB,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,KAAK,GAAG,yBAAyB,CAAC;QACxC,IAAI,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,iBAAiB;YAC1L,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACnE,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACvE,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;QAE7E,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,YAAY,EAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC5I,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAC3C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC;YAC7D,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YACvE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAExH,OAAO,IAAI,CAAC,MAAM,CAAC,EAAC,kBAAkB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAC,CAAC,CAAC;QACzH,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,IAAI,IAAI,CAAC,oBAAoB;YAC3B,KAAK,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAEpC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,CAAC;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,iBAAiB;YACxB,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAE5D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACvK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { assert, JsonUtils } from \"@itwin/core-bentley\";\nimport { ViewFlagOverrides } from \"./ViewFlags\";\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\nimport { HiddenLine } from \"./HiddenLine\";\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\nimport { ColorDef } from \"./ColorDef\";\n\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\n * @see [[ClipStyleProps.cutStyle]].\n * @public\n * @extensions\n */\nexport interface CutStyleProps {\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\n  viewflags?: ViewFlagOverrides;\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\n  hiddenLine?: HiddenLine.SettingsProps;\n  /** If defined, overrides aspects of the cut geometry's symbology. */\n  appearance?: FeatureAppearanceProps;\n}\n\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\n * @public\n */\nexport class CutStyle {\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\n  public readonly hiddenLine?: HiddenLine.Settings;\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\n  public readonly appearance?: FeatureAppearance;\n\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\n  public static readonly defaults = new CutStyle();\n\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\n    this.viewflags = viewflags ?? {};\n    if (hiddenLine && !hiddenLine.matchesDefaults)\n      this.hiddenLine = hiddenLine;\n\n    if (appearance && !appearance.matchesDefaults)\n      this.appearance = appearance;\n  }\n\n  /** Create a CutStyle from its components. */\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\n      return new CutStyle(viewflags, hiddenLine, appearance);\n\n    return this.defaults;\n  }\n\n  public static fromJSON(props?: CutStyleProps): CutStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const viewflags = { ...props?.viewflags };\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\n\n      return this.create(viewflags, hiddenLine, appearance);\n    } else {\n      return this.defaults;\n    }\n  }\n\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\n  public toJSON(): CutStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: CutStyleProps = {};\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\n      props.viewflags = this.viewflags;\n\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\n      props.hiddenLine = this.hiddenLine?.toJSON();\n\n    if (this.appearance && !this.appearance.matchesDefaults)\n      props.appearance = this.appearance.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\n  public get matchesDefaults(): boolean {\n    if (this === CutStyle.defaults)\n      return true;\n\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\n  }\n}\n\n/** Wire format describing a [[ClipIntersectionStyle]].\n * @see [[ClipStyleProps.ClipIntersectionStyle]].\n * @public\n * @extensions\n */\nexport interface ClipIntersectionStyleProps {\n  /** Color to apply to intersection of geometry and clip planes, default white */\n  color?: RgbColorProps;\n  /** Number of pixels to be considered intersecting the clip plane, default 1 */\n  width?: number;\n}\n\n/** As part of a [[ClipStyle]], describes how to colorize geometry intersecting the clip planes.\n * @note Edges are highlighted only if [[ClipStyle.ClipIntersectionStyle]] is `true`.\n * @public\n * @extensions\n */\nexport class ClipIntersectionStyle {\n  /** Color to apply to intersection of geometry and clip planes, default white */\n  public readonly color: RgbColor;\n  /** Number of pixels to be considered intersecting the clip plane, default 1 */\n  public readonly width: number;\n\n  private constructor(color: RgbColor = RgbColor.fromColorDef(ColorDef.white), width: number = 1) {\n    this.color = color;\n    this.width = width;\n  }\n  /** Create a highlight  from its components. */\n  public static create(color?: RgbColor, width?: number): ClipIntersectionStyle {\n    if (!color && !width)\n      return this.defaults;\n\n    return new ClipIntersectionStyle(color, width);\n  }\n\n  public static readonly defaults = new ClipIntersectionStyle();\n\n  public static fromJSON(props?: ClipIntersectionStyleProps): ClipIntersectionStyle {\n    if (props === undefined) {\n      return ClipIntersectionStyle.defaults;\n    }\n\n    const color = props.color ? RgbColor.fromJSON(props.color) : RgbColor.fromColorDef(ColorDef.white);\n    const width = props.width ? props.width : 1;\n    return new ClipIntersectionStyle(color, width);\n  }\n\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\n  public toJSON(): ClipIntersectionStyleProps | undefined {\n    const props: ClipIntersectionStyleProps = {};\n\n    if (this.matchesDefaults) {\n      return undefined;\n    }\n\n    if (this.color)\n      props.color = this.color.toJSON();\n\n    if (this.width)\n      props.width = this.width;\n\n    return props;\n  }\n\n  public get matchesDefaults(): boolean {\n    if (this === ClipIntersectionStyle.defaults)\n      return true;\n\n    return !this.color && !this.width;\n  }\n}\n\n/** Arguments supplied to [[ClipStyle.create]].\n * @public\n * @extensions\n */\nexport interface ClipStyleCreateArgs {\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  produceCutGeometry?: boolean;\n  /** If `true`, intersection of geometry and clip planes will be colorized */\n  colorizeIntersection?: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  cutStyle?: CutStyle;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  insideColor?: RgbColor;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  outsideColor?: RgbColor;\n  /** Controls the style of the intersection of geometry and clip planes */\n  intersectionStyle?: ClipIntersectionStyle;\n}\n\n/** Wire format describing a [[ClipStyle]].\n * @see [[DisplayStyleSettingsProps.clipStyle]].\n * @public\n * @extensions\n */\nexport interface ClipStyleProps {\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  produceCutGeometry?: boolean;\n  /** If 'true', intersection of geometry and clip planes will be colorized */\n  colorizeIntersection?: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  cutStyle?: CutStyleProps;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  insideColor?: RgbColorProps;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  outsideColor?: RgbColorProps;\n  /** Controls the style of the intersection of geometry and clip planes */\n  intersectionStyle?: ClipIntersectionStyleProps;\n}\n\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\n * @see [[DisplayStyleSettings.clipStyle]].\n * @public\n */\nexport class ClipStyle {\n  /** If `true`, geometry will be produced at the clip planes.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  public readonly produceCutGeometry: boolean;\n  /** If 'true', intersection of geometry and clip planes will be colorized */\n  public readonly colorizeIntersection: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  public readonly cutStyle: CutStyle;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  public readonly insideColor?: RgbColor;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  public readonly outsideColor?: RgbColor;\n  /** Controls the style of the intersection of geometry and clip planes */\n  public readonly intersectionStyle?: ClipIntersectionStyle;\n\n  /** The default style, which overrides none of the view's settings. */\n  public static readonly defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined);\n\n  private constructor(produceCutGeometry: boolean, colorizeIntersection: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined, intersectionStyle: ClipIntersectionStyle | undefined) {\n    this.produceCutGeometry = produceCutGeometry;\n    this.colorizeIntersection = colorizeIntersection;\n    this.cutStyle = cutStyle;\n    this.insideColor = inside;\n    this.outsideColor = outside;\n    this.intersectionStyle = intersectionStyle;\n  }\n\n  /** @deprecated in 4.x. Use [[create(style: ClipStyleCreateArgs]] */\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;\n\n  /** Create a style from its components. */\n  public static create(style: ClipStyleCreateArgs): ClipStyle;\n\n  /** @internal */\n  public static create(styleOrProduceCutGeometry: ClipStyleCreateArgs | boolean, cutStyle?: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\n\n    if (typeof styleOrProduceCutGeometry === \"boolean\") {\n      cutStyle = cutStyle === undefined ? CutStyle.defaults : cutStyle;\n\n      if (!styleOrProduceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor) {\n        return this.defaults;\n      }\n\n      return new ClipStyle(styleOrProduceCutGeometry, false, cutStyle, insideColor, outsideColor, undefined);\n    }\n\n    const style = styleOrProduceCutGeometry;\n    if (!style.produceCutGeometry && !style.colorizeIntersection && (!style.cutStyle || style.cutStyle.matchesDefaults) && !style.insideColor && !style.outsideColor && !style.intersectionStyle)\n      return this.defaults;\n\n    const produceCutGeometry = style.produceCutGeometry ? true : false;\n    const colorizeIntersection = style.colorizeIntersection ? true : false;\n    cutStyle = style.cutStyle === undefined ? CutStyle.defaults : style.cutStyle;\n\n    return new ClipStyle(produceCutGeometry, colorizeIntersection, cutStyle, style.insideColor, style.outsideColor,  style.intersectionStyle);\n  }\n\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const produceCutGeometry = props.produceCutGeometry ?? false;\n      const colorizeIntersection = props.colorizeIntersection ? true : false;\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\n      const insideColor = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\n      const outsideColor = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\n      const intersectionStyle = props.intersectionStyle ? ClipIntersectionStyle.fromJSON(props.intersectionStyle) : undefined;\n\n      return this.create({produceCutGeometry, colorizeIntersection, cutStyle, insideColor, outsideColor, intersectionStyle});\n    }\n\n    return this.defaults;\n  }\n\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\n  public toJSON(): ClipStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: ClipStyleProps = {};\n    if (this.produceCutGeometry)\n      props.produceCutGeometry = true;\n\n    if (this.colorizeIntersection)\n      props.colorizeIntersection = true;\n\n    const cutStyle = this.cutStyle.toJSON();\n    if (cutStyle) {\n      assert(!this.cutStyle.matchesDefaults);\n      props.cutStyle = cutStyle;\n    }\n\n    if (this.insideColor)\n      props.insideColor = this.insideColor.toJSON();\n\n    if (this.outsideColor)\n      props.outsideColor = this.outsideColor.toJSON();\n\n    if (this.intersectionStyle)\n      props.intersectionStyle = this.intersectionStyle.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\n  public get matchesDefaults(): boolean {\n    if (this === ClipStyle.defaults)\n      return true;\n\n    return !this.produceCutGeometry && !this.colorizeIntersection && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults && !this.intersectionStyle;\n  }\n}\n"]}
+{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBtC;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACnB,oGAAoG;IACpF,SAAS,CAA8B;IACvD,sGAAsG;IACtF,UAAU,CAAuB;IACjD,kFAAkF;IAClE,UAAU,CAAqB;IAE/C,sHAAsH;IAC/G,MAAM,CAAU,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAEjD,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAeH;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAChC,gFAAgF;IAChE,KAAK,CAAW;IAChC,+EAA+E;IAC/D,KAAK,CAAS;IAE9B,YAAoB,QAAkB,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAgB,CAAC;QAC5F,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,+CAA+C;IACxC,MAAM,CAAC,MAAM,CAAC,KAAgB,EAAE,KAAc;QACnD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK;YAClB,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM,CAAU,QAAQ,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAEvD,MAAM,CAAC,QAAQ,CAAC,KAAkC;QACvD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,qBAAqB,CAAC,QAAQ,CAAC;QACxC,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnG,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,MAAM,KAAK,GAA+B,EAAE,CAAC;QAE7C,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,KAAK;YACZ,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,IAAI,IAAI,CAAC,KAAK;YACZ,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,qBAAqB,CAAC,QAAQ;YACzC,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACpC,CAAC;;AAkDH;;;GAGG;AACH,MAAM,OAAO,SAAS;IACpB;;;;OAIG;IACa,kBAAkB,CAAU;IAC5C,4EAA4E;IAC5D,oBAAoB,CAAU;IAC9C,kGAAkG;IAClF,QAAQ,CAAW;IACnC,+EAA+E;IAC/D,WAAW,CAAY;IACvC,4GAA4G;IAC5F,YAAY,CAAY;IACxC,yEAAyE;IACzD,iBAAiB,CAAyB;IAE1D,sEAAsE;IAC/D,MAAM,CAAU,QAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAElH,YAAoB,kBAA2B,EAAE,oBAA6B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B,EAAE,iBAAoD;QACnN,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAQD,gBAAgB;IACT,MAAM,CAAC,MAAM,CAAC,yBAAwD,EAAE,QAAmB,EAAE,WAAsB,EAAE,YAAuB;QAEjJ,IAAI,OAAO,yBAAyB,KAAK,SAAS,EAAE,CAAC;YACnD,QAAQ,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;YAEjE,IAAI,CAAC,yBAAyB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC5F,OAAO,IAAI,CAAC,QAAQ,CAAC;YACvB,CAAC;YAED,OAAO,IAAI,SAAS,CAAC,yBAAyB,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,KAAK,GAAG,yBAAyB,CAAC;QACxC,IAAI,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,iBAAiB;YAC1L,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACnE,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACvE,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;QAE7E,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,YAAY,EAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC5I,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAC3C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC;YAC7D,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YACvE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAExH,OAAO,IAAI,CAAC,MAAM,CAAC,EAAC,kBAAkB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAC,CAAC,CAAC;QACzH,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,IAAI,IAAI,CAAC,oBAAoB;YAC3B,KAAK,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAEpC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,CAAC;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,iBAAiB;YACxB,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAE5D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACvK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { assert, JsonUtils } from \"@itwin/core-bentley\";\nimport { ViewFlagOverrides } from \"./ViewFlags\";\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\nimport { HiddenLine } from \"./HiddenLine\";\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\nimport { ColorDef } from \"./ColorDef\";\n\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\n * @see [[ClipStyleProps.cutStyle]].\n * @public\n * @extensions\n */\nexport interface CutStyleProps {\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\n  viewflags?: ViewFlagOverrides;\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\n  hiddenLine?: HiddenLine.SettingsProps;\n  /** If defined, overrides aspects of the cut geometry's symbology. */\n  appearance?: FeatureAppearanceProps;\n}\n\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\n * @public\n */\nexport class CutStyle {\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\n  public readonly hiddenLine?: HiddenLine.Settings;\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\n  public readonly appearance?: FeatureAppearance;\n\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\n  public static readonly defaults = new CutStyle();\n\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\n    this.viewflags = viewflags ?? {};\n    if (hiddenLine && !hiddenLine.matchesDefaults)\n      this.hiddenLine = hiddenLine;\n\n    if (appearance && !appearance.matchesDefaults)\n      this.appearance = appearance;\n  }\n\n  /** Create a CutStyle from its components. */\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\n      return new CutStyle(viewflags, hiddenLine, appearance);\n\n    return this.defaults;\n  }\n\n  public static fromJSON(props?: CutStyleProps): CutStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const viewflags = { ...props?.viewflags };\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\n\n      return this.create(viewflags, hiddenLine, appearance);\n    } else {\n      return this.defaults;\n    }\n  }\n\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\n  public toJSON(): CutStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: CutStyleProps = {};\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\n      props.viewflags = this.viewflags;\n\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\n      props.hiddenLine = this.hiddenLine?.toJSON();\n\n    if (this.appearance && !this.appearance.matchesDefaults)\n      props.appearance = this.appearance.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\n  public get matchesDefaults(): boolean {\n    if (this === CutStyle.defaults)\n      return true;\n\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\n  }\n}\n\n/** Wire format describing a [[ClipIntersectionStyle]].\n * @see [[ClipStyleProps.ClipIntersectionStyle]].\n * @public\n * @extensions\n */\nexport interface ClipIntersectionStyleProps {\n  /** Color to apply to intersection of geometry and clip planes, default white */\n  color?: RgbColorProps;\n  /** Number of pixels to be considered intersecting the clip plane, default 1 */\n  width?: number;\n}\n\n/** As part of a [[ClipStyle]], describes how to colorize geometry intersecting the clip planes.\n * @note Edges are highlighted only if [[ClipStyle.ClipIntersectionStyle]] is `true`.\n * @public\n * @extensions\n */\nexport class ClipIntersectionStyle {\n  /** Color to apply to intersection of geometry and clip planes, default white */\n  public readonly color: RgbColor;\n  /** Number of pixels to be considered intersecting the clip plane, default 1 */\n  public readonly width: number;\n\n  private constructor(color: RgbColor = RgbColor.fromColorDef(ColorDef.white), width: number = 1) {\n    this.color = color;\n    this.width = width;\n  }\n  /** Create a highlight  from its components. */\n  public static create(color?: RgbColor, width?: number): ClipIntersectionStyle {\n    if (!color && !width)\n      return this.defaults;\n\n    return new ClipIntersectionStyle(color, width);\n  }\n\n  public static readonly defaults = new ClipIntersectionStyle();\n\n  public static fromJSON(props?: ClipIntersectionStyleProps): ClipIntersectionStyle {\n    if (props === undefined) {\n      return ClipIntersectionStyle.defaults;\n    }\n\n    const color = props.color ? RgbColor.fromJSON(props.color) : RgbColor.fromColorDef(ColorDef.white);\n    const width = props.width ? props.width : 1;\n    return new ClipIntersectionStyle(color, width);\n  }\n\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\n  public toJSON(): ClipIntersectionStyleProps | undefined {\n    const props: ClipIntersectionStyleProps = {};\n\n    if (this.matchesDefaults) {\n      return undefined;\n    }\n\n    if (this.color)\n      props.color = this.color.toJSON();\n\n    if (this.width)\n      props.width = this.width;\n\n    return props;\n  }\n\n  public get matchesDefaults(): boolean {\n    if (this === ClipIntersectionStyle.defaults)\n      return true;\n\n    return !this.color && !this.width;\n  }\n}\n\n/** Arguments supplied to [[ClipStyle.create]].\n * @public\n * @extensions\n */\nexport interface ClipStyleCreateArgs {\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  produceCutGeometry?: boolean;\n  /** If `true`, intersection of geometry and clip planes will be colorized */\n  colorizeIntersection?: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  cutStyle?: CutStyle;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  insideColor?: RgbColor;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  outsideColor?: RgbColor;\n  /** Controls the style of the intersection of geometry and clip planes */\n  intersectionStyle?: ClipIntersectionStyle;\n}\n\n/** Wire format describing a [[ClipStyle]].\n * @see [[DisplayStyleSettingsProps.clipStyle]].\n * @public\n * @extensions\n */\nexport interface ClipStyleProps {\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  produceCutGeometry?: boolean;\n  /** If 'true', intersection of geometry and clip planes will be colorized */\n  colorizeIntersection?: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  cutStyle?: CutStyleProps;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  insideColor?: RgbColorProps;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  outsideColor?: RgbColorProps;\n  /** Controls the style of the intersection of geometry and clip planes */\n  intersectionStyle?: ClipIntersectionStyleProps;\n}\n\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\n * @see [[DisplayStyleSettings.clipStyle]].\n * @public\n */\nexport class ClipStyle {\n  /** If `true`, geometry will be produced at the clip planes.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  public readonly produceCutGeometry: boolean;\n  /** If 'true', intersection of geometry and clip planes will be colorized */\n  public readonly colorizeIntersection: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  public readonly cutStyle: CutStyle;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  public readonly insideColor?: RgbColor;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  public readonly outsideColor?: RgbColor;\n  /** Controls the style of the intersection of geometry and clip planes */\n  public readonly intersectionStyle?: ClipIntersectionStyle;\n\n  /** The default style, which overrides none of the view's settings. */\n  public static readonly defaults = new ClipStyle(false, false, CutStyle.defaults, undefined, undefined, undefined);\n\n  private constructor(produceCutGeometry: boolean, colorizeIntersection: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined, intersectionStyle: ClipIntersectionStyle | undefined) {\n    this.produceCutGeometry = produceCutGeometry;\n    this.colorizeIntersection = colorizeIntersection;\n    this.cutStyle = cutStyle;\n    this.insideColor = inside;\n    this.outsideColor = outside;\n    this.intersectionStyle = intersectionStyle;\n  }\n\n  /** @deprecated in 4.x. Use [[create(style: ClipStyleCreateArgs]] */\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;\n\n  /** Create a style from its components. */\n  public static create(style: ClipStyleCreateArgs): ClipStyle;\n\n  /** @internal */\n  public static create(styleOrProduceCutGeometry: ClipStyleCreateArgs | boolean, cutStyle?: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\n\n    if (typeof styleOrProduceCutGeometry === \"boolean\") {\n      cutStyle = cutStyle === undefined ? CutStyle.defaults : cutStyle;\n\n      if (!styleOrProduceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor) {\n        return this.defaults;\n      }\n\n      return new ClipStyle(styleOrProduceCutGeometry, false, cutStyle, insideColor, outsideColor, undefined);\n    }\n\n    const style = styleOrProduceCutGeometry;\n    if (!style.produceCutGeometry && !style.colorizeIntersection && (!style.cutStyle || style.cutStyle.matchesDefaults) && !style.insideColor && !style.outsideColor && !style.intersectionStyle)\n      return this.defaults;\n\n    const produceCutGeometry = style.produceCutGeometry ? true : false;\n    const colorizeIntersection = style.colorizeIntersection ? true : false;\n    cutStyle = style.cutStyle === undefined ? CutStyle.defaults : style.cutStyle;\n\n    return new ClipStyle(produceCutGeometry, colorizeIntersection, cutStyle, style.insideColor, style.outsideColor,  style.intersectionStyle);\n  }\n\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const produceCutGeometry = props.produceCutGeometry ?? false;\n      const colorizeIntersection = props.colorizeIntersection ? true : false;\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\n      const insideColor = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\n      const outsideColor = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\n      const intersectionStyle = props.intersectionStyle ? ClipIntersectionStyle.fromJSON(props.intersectionStyle) : undefined;\n\n      return this.create({produceCutGeometry, colorizeIntersection, cutStyle, insideColor, outsideColor, intersectionStyle});\n    }\n\n    return this.defaults;\n  }\n\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\n  public toJSON(): ClipStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: ClipStyleProps = {};\n    if (this.produceCutGeometry)\n      props.produceCutGeometry = true;\n\n    if (this.colorizeIntersection)\n      props.colorizeIntersection = true;\n\n    const cutStyle = this.cutStyle.toJSON();\n    if (cutStyle) {\n      assert(!this.cutStyle.matchesDefaults);\n      props.cutStyle = cutStyle;\n    }\n\n    if (this.insideColor)\n      props.insideColor = this.insideColor.toJSON();\n\n    if (this.outsideColor)\n      props.outsideColor = this.outsideColor.toJSON();\n\n    if (this.intersectionStyle)\n      props.intersectionStyle = this.intersectionStyle.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\n  public get matchesDefaults(): boolean {\n    if (this === ClipStyle.defaults)\n      return true;\n\n    return !this.produceCutGeometry && !this.colorizeIntersection && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults && !this.intersectionStyle;\n  }\n}\n"]}

package/lib/esm/Code.js

@@ -11,11 +11,16 @@ import { Id64, JsonUtils } from "@itwin/core-bentley";
  * @public
  */
 export class Code {
+    /** The id of the [CodeSpec]($docs/bis/guide/fundamentals/codes.md#codespec) of the Element */
+    spec;
+    /** The [CodeScope]($docs/bis/guide/fundamentals/codes.md#codescope-property) of the Element */
+    scope;
     /** The [CodeValue]($docs/bis/guide/fundamentals/codes.md#codevalue-property) of the Element
      * @note Leading and trailing whitespace is invalid so is automatically trimmed.
      */
     get value() { return this._value ?? ""; }
     set value(val) { this._value = val?.trim(); }
+    _value;
     constructor(codeProps) {
         this.spec = Id64.fromJSON(codeProps.spec);
         this.scope = JsonUtils.asString(codeProps.scope);
@@ -219,6 +224,17 @@ export var CodeScopeSpec;
  * @public
  */
 export class CodeSpec {
+    /** The iModel holding this CodeSpec. */
+    iModel;
+    /** The id of this CodeSpec. */
+    id;
+    /** The name of this CodeSpec. */
+    name;
+    /** The JSON properties for this CodeSpec.
+     * @note Use the getters and setters instead of accessing this directly.
+     * @internal
+     */
+    properties;
     constructor(iModel, id, name, properties) {
         this.iModel = iModel;
         this.id = id;