@itwin/core-common 5.0.0-dev.8 → 5.0.0-dev.83

package/CHANGELOG.md

@@ -1,6 +1,55 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Thu, 14 Nov 2024 18:13:56 GMT and should not be manually modified.
+This log was last generated on Tue, 11 Mar 2025 15:27:53 GMT and should not be manually modified.
+
+## 4.10.10
+Tue, 11 Mar 2025 15:25:11 GMT
+
+### Updates
+
+- Resolves CVE-2025-27152
+
+## 4.10.9
+Tue, 11 Mar 2025 05:17:33 GMT
+
+_Version update only_
+
+## 4.10.8
+Thu, 06 Mar 2025 14:13:37 GMT
+
+_Version update only_
+
+## 4.10.7
+Tue, 18 Feb 2025 17:27:03 GMT
+
+### Updates
+
+- Update ECSql reader api to support no stat and error code.
+
+## 4.10.6
+Fri, 24 Jan 2025 08:02:40 GMT
+
+_Version update only_
+
+## 4.10.5
+Tue, 21 Jan 2025 21:56:45 GMT
+
+_Version update only_
+
+## 4.10.4
+Mon, 13 Jan 2025 14:06:43 GMT
+
+_Version update only_
+
+## 4.10.3
+Mon, 06 Jan 2025 14:00:13 GMT
+
+_Version update only_
+
+## 4.10.2
+Thu, 21 Nov 2024 15:22:20 GMT
+
+_Version update only_
 
 ## 4.10.1
 Thu, 14 Nov 2024 18:11:00 GMT

package/lib/cjs/AmbientOcclusion.js

@@ -16,6 +16,22 @@ var AmbientOcclusion;
 (function (AmbientOcclusion) {
     /** Describes the properties with which ambient occlusion should be drawn. These properties correspond to a horizon-based ambient occlusion approach. */
     class Settings {
+        static _defaultBias = 0.25;
+        static _defaultZLengthCap = 0.0025;
+        static _defaultMaxDistance = 10000.0;
+        static _defaultIntensity = 1.0;
+        static _defaultTexelStepSize = 1;
+        static _defaultBlurDelta = 1.0;
+        static _defaultBlurSigma = 2.0;
+        static _defaultBlurTexelStepSize = 1.0;
+        bias;
+        zLengthCap;
+        maxDistance;
+        intensity;
+        texelStepSize;
+        blurDelta;
+        blurSigma;
+        blurTexelStepSize;
         constructor(json) {
             if (undefined === json)
                 json = {};
@@ -28,6 +44,7 @@ var AmbientOcclusion;
             this.blurSigma = core_bentley_1.JsonUtils.asDouble(json.blurSigma, Settings._defaultBlurSigma);
             this.blurTexelStepSize = core_bentley_1.JsonUtils.asDouble(json.blurTexelStepSize, Settings._defaultBlurTexelStepSize);
         }
+        static defaults = new Settings({});
         static fromJSON(json) { return undefined !== json ? new Settings(json) : this.defaults; }
         toJSON() {
             return {
@@ -42,15 +59,6 @@ var AmbientOcclusion;
             };
         }
     }
-    Settings._defaultBias = 0.25;
-    Settings._defaultZLengthCap = 0.0025;
-    Settings._defaultMaxDistance = 10000.0;
-    Settings._defaultIntensity = 1.0;
-    Settings._defaultTexelStepSize = 1;
-    Settings._defaultBlurDelta = 1.0;
-    Settings._defaultBlurSigma = 2.0;
-    Settings._defaultBlurTexelStepSize = 1.0;
-    Settings.defaults = new Settings({});
     AmbientOcclusion.Settings = Settings;
 })(AmbientOcclusion || (exports.AmbientOcclusion = AmbientOcclusion = {}));
 //# sourceMappingURL=AmbientOcclusion.js.map

package/lib/cjs/AmbientOcclusion.js.map

@@ -1 +1 @@
-{"version":3,"file":"AmbientOcclusion.js","sourceRoot":"","sources":["../../src/AmbientOcclusion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAEhD;;GAEG;AACH,IAAiB,gBAAgB,CAwEhC;AAxED,WAAiB,gBAAgB;IAqB/B,wJAAwJ;IACxJ,MAAa,QAAQ;QAmBnB,YAAoB,IAAY;YAC9B,IAAI,SAAS,KAAK,IAAI;gBACpB,IAAI,GAAG,EAAE,CAAC;YAEZ,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;YACjE,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;YACnF,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YACtF,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,aAAa,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YAC5F,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAC1G,CAAC;QAIM,MAAM,CAAC,QAAQ,CAAC,IAAY,IAAc,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3G,MAAM;YACX,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBACjE,UAAU,EAAE,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;gBACzF,WAAW,EAAE,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAC7F,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,aAAa,EAAE,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBACrG,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,KAAK,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;aACtH,CAAC;QACJ,CAAC;;IA/Cc,qBAAY,GAAW,IAAI,CAAC;IAC5B,2BAAkB,GAAW,MAAM,CAAC;IACpC,4BAAmB,GAAW,OAAO,CAAC;IACtC,0BAAiB,GAAW,GAAG,CAAC;IAChC,8BAAqB,GAAW,CAAC,CAAC;IAClC,0BAAiB,GAAW,GAAG,CAAC;IAChC,0BAAiB,GAAW,GAAG,CAAC;IAChC,kCAAyB,GAAW,GAAG,CAAC;IAyBzC,iBAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;IAjC/B,yBAAQ,WAiDpB,CAAA;AACH,CAAC,EAxEgB,gBAAgB,gCAAhB,gBAAgB,QAwEhC","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 { JsonUtils } from \"@itwin/core-bentley\";\n\n/** Namespace containing types controlling how ambient occlusion should be drawn.\n * @public\n */\nexport namespace AmbientOcclusion {\n  /** Describes the properties with which ambient occlusion should be drawn. These properties correspond to a horizon-based ambient occlusion approach. */\n  export interface Props {\n    /** If defined, represents an angle in radians. If the dot product between the normal of the sample and the vector to the camera is less than this value, sampling stops in the current direction. This is used to remove shadows from near planar edges. If undefined, the bias defaults to 0.25. */\n    readonly bias?: number;\n    /** If defined, if the distance in linear depth from the current sample to first sample is greater than this value, sampling stops in the current direction. If undefined, the zLengthCap defaults to 0.0025.  The full range of linear depth is 0 to 1. */\n    readonly zLengthCap?: number;\n    /** If defined, the maximum distance from the camera's near plane in meters at which ambient occlusion will be applied. If undefined, the maximum distance defaults to 10000. */\n    readonly maxDistance?: number;\n    /** If defined, raise the final ambient occlusion to the power of this value. Larger values make the ambient shadows darker. If undefined, the intensity defaults to 2.0. */\n    readonly intensity?: number;\n    /** If defined, indicates the texel distance to step toward the next texel sample in the current direction. For portions of geometry close to the near plane, this value will be what is used. As portions of geometry extend away from the near plane, this value will gradually reduce until it reaches a minimum value of 1.0 at the far plane. If undefined, texelStepSize defaults to 1.95. */\n    readonly texelStepSize?: number;\n    /** If defined, blurDelta is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)). If undefined, blurDelta defaults to 1.0. */\n    readonly blurDelta?: number;\n    /** If defined, blurSigma is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)). If undefined, blurSigma defaults to 2.0. */\n    readonly blurSigma?: number;\n    /* If defined, blurTexelStepSize indicates the distance to the next texel for blurring. If undefined, blurTexelStepSize defaults to 1.0. */\n    readonly blurTexelStepSize?: number;\n  }\n\n  /** Describes the properties with which ambient occlusion should be drawn. These properties correspond to a horizon-based ambient occlusion approach. */\n  export class Settings implements Props {\n    private static _defaultBias: number = 0.25;\n    private static _defaultZLengthCap: number = 0.0025;\n    private static _defaultMaxDistance: number = 10000.0;\n    private static _defaultIntensity: number = 1.0;\n    private static _defaultTexelStepSize: number = 1;\n    private static _defaultBlurDelta: number = 1.0;\n    private static _defaultBlurSigma: number = 2.0;\n    private static _defaultBlurTexelStepSize: number = 1.0;\n\n    public readonly bias: number;\n    public readonly zLengthCap: number;\n    public readonly maxDistance: number;\n    public readonly intensity: number;\n    public readonly texelStepSize: number;\n    public readonly blurDelta: number;\n    public readonly blurSigma: number;\n    public readonly blurTexelStepSize: number;\n\n    private constructor(json?: Props) {\n      if (undefined === json)\n        json = {};\n\n      this.bias = JsonUtils.asDouble(json.bias, Settings._defaultBias);\n      this.zLengthCap = JsonUtils.asDouble(json.zLengthCap, Settings._defaultZLengthCap);\n      this.maxDistance = JsonUtils.asDouble(json.maxDistance, Settings._defaultMaxDistance);\n      this.intensity = JsonUtils.asDouble(json.intensity, Settings._defaultIntensity);\n      this.texelStepSize = JsonUtils.asDouble(json.texelStepSize, Settings._defaultTexelStepSize);\n      this.blurDelta = JsonUtils.asDouble(json.blurDelta, Settings._defaultBlurDelta);\n      this.blurSigma = JsonUtils.asDouble(json.blurSigma, Settings._defaultBlurSigma);\n      this.blurTexelStepSize = JsonUtils.asDouble(json.blurTexelStepSize, Settings._defaultBlurTexelStepSize);\n    }\n\n    public static defaults = new Settings({});\n\n    public static fromJSON(json?: Props): Settings { return undefined !== json ? new Settings(json) : this.defaults; }\n\n    public toJSON(): Props {\n      return {\n        bias: this.bias !== Settings._defaultBias ? this.bias : undefined,\n        zLengthCap: this.zLengthCap !== Settings._defaultZLengthCap ? this.zLengthCap : undefined,\n        maxDistance: this.maxDistance !== Settings._defaultMaxDistance ? this.maxDistance : undefined,\n        intensity: this.intensity !== Settings._defaultIntensity ? this.intensity : undefined,\n        texelStepSize: this.texelStepSize !== Settings._defaultTexelStepSize ? this.texelStepSize : undefined,\n        blurDelta: this.blurDelta !== Settings._defaultBlurDelta ? this.blurDelta : undefined,\n        blurSigma: this.blurSigma !== Settings._defaultBlurSigma ? this.blurSigma : undefined,\n        blurTexelStepSize: this.blurTexelStepSize !== Settings._defaultBlurTexelStepSize ? this.blurTexelStepSize : undefined,\n      };\n    }\n  }\n}\n"]}
+{"version":3,"file":"AmbientOcclusion.js","sourceRoot":"","sources":["../../src/AmbientOcclusion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgD;AAEhD;;GAEG;AACH,IAAiB,gBAAgB,CAwEhC;AAxED,WAAiB,gBAAgB;IAqB/B,wJAAwJ;IACxJ,MAAa,QAAQ;QACX,MAAM,CAAC,YAAY,GAAW,IAAI,CAAC;QACnC,MAAM,CAAC,kBAAkB,GAAW,MAAM,CAAC;QAC3C,MAAM,CAAC,mBAAmB,GAAW,OAAO,CAAC;QAC7C,MAAM,CAAC,iBAAiB,GAAW,GAAG,CAAC;QACvC,MAAM,CAAC,qBAAqB,GAAW,CAAC,CAAC;QACzC,MAAM,CAAC,iBAAiB,GAAW,GAAG,CAAC;QACvC,MAAM,CAAC,iBAAiB,GAAW,GAAG,CAAC;QACvC,MAAM,CAAC,yBAAyB,GAAW,GAAG,CAAC;QAEvC,IAAI,CAAS;QACb,UAAU,CAAS;QACnB,WAAW,CAAS;QACpB,SAAS,CAAS;QAClB,aAAa,CAAS;QACtB,SAAS,CAAS;QAClB,SAAS,CAAS;QAClB,iBAAiB,CAAS;QAE1C,YAAoB,IAAY;YAC9B,IAAI,SAAS,KAAK,IAAI;gBACpB,IAAI,GAAG,EAAE,CAAC;YAEZ,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;YACjE,IAAI,CAAC,UAAU,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;YACnF,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YACtF,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,aAAa,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YAC5F,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAC1G,CAAC;QAEM,MAAM,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEnC,MAAM,CAAC,QAAQ,CAAC,IAAY,IAAc,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3G,MAAM;YACX,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBACjE,UAAU,EAAE,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;gBACzF,WAAW,EAAE,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAC7F,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,aAAa,EAAE,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBACrG,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,SAAS,EAAE,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrF,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,KAAK,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;aACtH,CAAC;QACJ,CAAC;;IAhDU,yBAAQ,WAiDpB,CAAA;AACH,CAAC,EAxEgB,gBAAgB,gCAAhB,gBAAgB,QAwEhC","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 { JsonUtils } from \"@itwin/core-bentley\";\n\n/** Namespace containing types controlling how ambient occlusion should be drawn.\n * @public\n */\nexport namespace AmbientOcclusion {\n  /** Describes the properties with which ambient occlusion should be drawn. These properties correspond to a horizon-based ambient occlusion approach. */\n  export interface Props {\n    /** If defined, represents an angle in radians. If the dot product between the normal of the sample and the vector to the camera is less than this value, sampling stops in the current direction. This is used to remove shadows from near planar edges. If undefined, the bias defaults to 0.25. */\n    readonly bias?: number;\n    /** If defined, if the distance in linear depth from the current sample to first sample is greater than this value, sampling stops in the current direction. If undefined, the zLengthCap defaults to 0.0025.  The full range of linear depth is 0 to 1. */\n    readonly zLengthCap?: number;\n    /** If defined, the maximum distance from the camera's near plane in meters at which ambient occlusion will be applied. If undefined, the maximum distance defaults to 10000. */\n    readonly maxDistance?: number;\n    /** If defined, raise the final ambient occlusion to the power of this value. Larger values make the ambient shadows darker. If undefined, the intensity defaults to 2.0. */\n    readonly intensity?: number;\n    /** If defined, indicates the texel distance to step toward the next texel sample in the current direction. For portions of geometry close to the near plane, this value will be what is used. As portions of geometry extend away from the near plane, this value will gradually reduce until it reaches a minimum value of 1.0 at the far plane. If undefined, texelStepSize defaults to 1.95. */\n    readonly texelStepSize?: number;\n    /** If defined, blurDelta is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)). If undefined, blurDelta defaults to 1.0. */\n    readonly blurDelta?: number;\n    /** If defined, blurSigma is used to compute the weight of a Gaussian filter. The equation is exp((-0.5 * blurDelta * blurDelta) / (blurSigma * blurSigma)). If undefined, blurSigma defaults to 2.0. */\n    readonly blurSigma?: number;\n    /* If defined, blurTexelStepSize indicates the distance to the next texel for blurring. If undefined, blurTexelStepSize defaults to 1.0. */\n    readonly blurTexelStepSize?: number;\n  }\n\n  /** Describes the properties with which ambient occlusion should be drawn. These properties correspond to a horizon-based ambient occlusion approach. */\n  export class Settings implements Props {\n    private static _defaultBias: number = 0.25;\n    private static _defaultZLengthCap: number = 0.0025;\n    private static _defaultMaxDistance: number = 10000.0;\n    private static _defaultIntensity: number = 1.0;\n    private static _defaultTexelStepSize: number = 1;\n    private static _defaultBlurDelta: number = 1.0;\n    private static _defaultBlurSigma: number = 2.0;\n    private static _defaultBlurTexelStepSize: number = 1.0;\n\n    public readonly bias: number;\n    public readonly zLengthCap: number;\n    public readonly maxDistance: number;\n    public readonly intensity: number;\n    public readonly texelStepSize: number;\n    public readonly blurDelta: number;\n    public readonly blurSigma: number;\n    public readonly blurTexelStepSize: number;\n\n    private constructor(json?: Props) {\n      if (undefined === json)\n        json = {};\n\n      this.bias = JsonUtils.asDouble(json.bias, Settings._defaultBias);\n      this.zLengthCap = JsonUtils.asDouble(json.zLengthCap, Settings._defaultZLengthCap);\n      this.maxDistance = JsonUtils.asDouble(json.maxDistance, Settings._defaultMaxDistance);\n      this.intensity = JsonUtils.asDouble(json.intensity, Settings._defaultIntensity);\n      this.texelStepSize = JsonUtils.asDouble(json.texelStepSize, Settings._defaultTexelStepSize);\n      this.blurDelta = JsonUtils.asDouble(json.blurDelta, Settings._defaultBlurDelta);\n      this.blurSigma = JsonUtils.asDouble(json.blurSigma, Settings._defaultBlurSigma);\n      this.blurTexelStepSize = JsonUtils.asDouble(json.blurTexelStepSize, Settings._defaultBlurTexelStepSize);\n    }\n\n    public static defaults = new Settings({});\n\n    public static fromJSON(json?: Props): Settings { return undefined !== json ? new Settings(json) : this.defaults; }\n\n    public toJSON(): Props {\n      return {\n        bias: this.bias !== Settings._defaultBias ? this.bias : undefined,\n        zLengthCap: this.zLengthCap !== Settings._defaultZLengthCap ? this.zLengthCap : undefined,\n        maxDistance: this.maxDistance !== Settings._defaultMaxDistance ? this.maxDistance : undefined,\n        intensity: this.intensity !== Settings._defaultIntensity ? this.intensity : undefined,\n        texelStepSize: this.texelStepSize !== Settings._defaultTexelStepSize ? this.texelStepSize : undefined,\n        blurDelta: this.blurDelta !== Settings._defaultBlurDelta ? this.blurDelta : undefined,\n        blurSigma: this.blurSigma !== Settings._defaultBlurSigma ? this.blurSigma : undefined,\n        blurTexelStepSize: this.blurTexelStepSize !== Settings._defaultBlurTexelStepSize ? this.blurTexelStepSize : undefined,\n      };\n    }\n  }\n}\n"]}

package/lib/cjs/AnalysisStyle.d.ts

@@ -28,7 +28,6 @@ export declare class AnalysisStyleDisplacement {
      * Default value: 1.
      */
     readonly scale: number;
-    /** @internal */
     private constructor();
     /** Create from JSON representation. */
     static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement;
@@ -68,7 +67,6 @@ export declare class AnalysisStyleThematic {
     /** Settings used to produce the [[Gradient]] image. */
     readonly thematicSettings: ThematicGradientSettings;
     private _gradient?;
-    /** @internal */
     private constructor();
     /** Create from JSON representation. */
     static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic;
@@ -122,7 +120,6 @@ export declare class AnalysisStyle {
      * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.
      */
     static fromJSON(props?: AnalysisStyleProps): AnalysisStyle;
-    /** @internal */
     private constructor();
     /** Convert this style to its JSON representation. */
     toJSON(): AnalysisStyleProps;

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

@@ -1 +1 @@
-{"version":3,"file":"AnalysisStyle.d.ts","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,8GAA8G;IAC9G,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,gBAAgB;IAChB,OAAO;IAKP,uCAAuC;WACzB,QAAQ,CAAC,KAAK,EAAE,8BAA8B,GAAG,yBAAyB;IAIxF,sCAAsC;IAC/B,MAAM,IAAI,8BAA8B;IAQ/C,sDAAsD;IAC/C,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAGzD;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;CAClD;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB;IAChC,mHAAmH;IACnH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzC,uDAAuD;IACvD,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D,OAAO,CAAC,SAAS,CAAC,CAAgB;IAElC,gBAAgB;IAChB,OAAO;IAMP,uCAAuC;WACzB,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAIhF,sCAAsC;IAC/B,MAAM,IAAI,0BAA0B;IAY3C,uDAAuD;IACvD,IAAW,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAKnC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;CAGrD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,8BAA8B,CAAC;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,+CAA+C;IAC/C,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,sBAAsB,CAAC,EAAE,6BAA6B,CAAC;CACxD;AAgCD;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,SAAgB,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzD,SAAgB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjD,qHAAqH;IACrH,SAAgB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3C;;OAEG;WACW,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAWjE,gBAAgB;IAChB,OAAO;IASP,qDAAqD;IAC9C,MAAM,IAAI,kBAAkB;IAiBnC,2GAA2G;IACpG,KAAK,CAAC,YAAY,EAAE,kBAAkB,GAAG,aAAa;IAO7D,0DAA0D;IACnD,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAe5C,gBAAuB,QAAQ,gBAAyB;CACzD"}
+{"version":3,"file":"AnalysisStyle.d.ts","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,8GAA8G;IAC9G,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAKP,uCAAuC;WACzB,QAAQ,CAAC,KAAK,EAAE,8BAA8B,GAAG,yBAAyB;IAIxF,sCAAsC;IAC/B,MAAM,IAAI,8BAA8B;IAQ/C,sDAAsD;IAC/C,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAGzD;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;CAClD;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB;IAChC,mHAAmH;IACnH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzC,uDAAuD;IACvD,SAAgB,gBAAgB,EAAE,wBAAwB,CAAC;IAC3D,OAAO,CAAC,SAAS,CAAC,CAAgB;IAElC,OAAO;IAMP,uCAAuC;WACzB,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAIhF,sCAAsC;IAC/B,MAAM,IAAI,0BAA0B;IAY3C,uDAAuD;IACvD,IAAW,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAKnC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;CAGrD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,8BAA8B,CAAC;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,+CAA+C;IAC/C,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,sBAAsB,CAAC,EAAE,6BAA6B,CAAC;CACxD;AAgCD;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,SAAgB,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzD,SAAgB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjD,qHAAqH;IACrH,SAAgB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3C;;OAEG;WACW,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAWjE,OAAO;IASP,qDAAqD;IAC9C,MAAM,IAAI,kBAAkB;IAiBnC,2GAA2G;IACpG,KAAK,CAAC,YAAY,EAAE,kBAAkB,GAAG,aAAa;IAO7D,0DAA0D;IACnD,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAe5C,gBAAuB,QAAQ,gBAAyB;CACzD"}

package/lib/cjs/AnalysisStyle.js

@@ -16,7 +16,12 @@ const Gradient_1 = require("./Gradient");
  * @public
  */
 class AnalysisStyleDisplacement {
-    /** @internal */
+    /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */
+    channelName;
+    /** A scale applied to the displacements to adjust the magnitude of the effect.
+     * Default value: 1.
+     */
+    scale;
     constructor(channelName, scale = 1) {
         this.channelName = channelName;
         this.scale = scale;
@@ -45,7 +50,15 @@ exports.AnalysisStyleDisplacement = AnalysisStyleDisplacement;
  * @public
  */
 class AnalysisStyleThematic {
-    /** @internal */
+    /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */
+    channelName;
+    /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of
+     * this range are displayed with the gradient's margin color.
+     */
+    range;
+    /** Settings used to produce the [[Gradient]] image. */
+    thematicSettings;
+    _gradient;
     constructor(props) {
         this.channelName = props.channelName;
         this.range = core_geometry_1.Range1d.fromJSON(props.range);
@@ -109,6 +122,10 @@ function tryConvertLegacyProps(input) {
  * @public
  */
 class AnalysisStyle {
+    displacement;
+    thematic;
+    /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */
+    normalChannelName;
     /** Create an analysis style from its JSON representation.
      * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.
      */
@@ -120,7 +137,6 @@ class AnalysisStyle {
             return this.defaults;
         return new AnalysisStyle(props);
     }
-    /** @internal */
     constructor(props) {
         this.normalChannelName = props.normalChannelName;
         if (props.displacement)
@@ -160,7 +176,7 @@ class AnalysisStyle {
             return false;
         return undefined === this.thematic || this.thematic.equals(other.thematic);
     }
+    static defaults = new AnalysisStyle({});
 }
 exports.AnalysisStyle = AnalysisStyle;
-AnalysisStyle.defaults = new AnalysisStyle({});
 //# sourceMappingURL=AnalysisStyle.js.map

package/lib/cjs/AnalysisStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"AnalysisStyle.js","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAA6D;AAC7D,uDAA4F;AAC5F,yCAAsC;AAgBtC;;;GAGG;AACH,MAAa,yBAAyB;IAQpC,gBAAgB;IAChB,YAAoB,WAAmB,EAAE,KAAK,GAAG,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAqC;QAC1D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAmC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAgC;QAC5C,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC;IAC9E,CAAC;CACF;AAhCD,8DAgCC;AAkBD;;;;;GAKG;AACH,MAAa,qBAAqB;IAWhC,gBAAgB;IAChB,YAAoB,KAAiC;QACnD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,0CAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,0CAAwB,CAAC,QAAQ,CAAC;YAClE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uDAAuD;IACvD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,IAAI,CAAC,SAAS,GAAG,mBAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjJ,CAAC;CACF;AAhDD,sDAgDC;AA+BD,SAAS,qBAAqB,CAAC,KAAyB;IACtD,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,MAAM;QACpC,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAG,KAAiC,CAAC;IACjD,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;QACxF,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAuB;QACjC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;KAC3C,CAAC;IAEF,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,EAAE,CAAC;QACjD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC;QAC/E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAa,aAAa;IAMxB;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB;YAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,gBAAgB;IAChB,YAAoB,KAAyB;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,KAAK,CAAC,YAAY;YACpB,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAE7E,IAAI,KAAK,CAAC,MAAM;YACd,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,qDAAqD;IAC9C,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,IAAI,KAAK,aAAa,CAAC,QAAQ;YACjC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2GAA2G;IACpG,KAAK,CAAC,YAAgC;QAC3C,OAAO,aAAa,CAAC,QAAQ,CAAC;YAC5B,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;YACpD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC;YAC1E,OAAO,KAAK,CAAC;aACV,IAAI,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,YAAa,CAAC;YAC1E,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC;YAClE,OAAO,KAAK,CAAC;QAEf,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;IAC9E,CAAC;;AAtEH,sCAyEC;AADwB,sBAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,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 DisplayStyles\n */\n\nimport { Range1d, Range1dProps } from \"@itwin/core-geometry\";\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\nimport { Gradient } from \"./Gradient\";\n\n/** JSON representation of an [[AnalysisStyleDisplacement]].\n * @see [[AnalysisStyleProps.displacement]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleDisplacementProps {\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleDisplacement.scale]].\n   * Default value: 1.\n   */\n  scale?: number;\n}\n\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\n * @see [[AnalysisStyle.displacement]].\n * @public\n */\nexport class AnalysisStyleDisplacement {\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\n  public readonly channelName: string;\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\n   * Default value: 1.\n   */\n  public readonly scale: number;\n\n  /** @internal */\n  private constructor(channelName: string, scale = 1) {\n    this.channelName = channelName;\n    this.scale = scale;\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\n    return new this(props.channelName, props.scale);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleDisplacementProps {\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\n    if (this.scale !== 1)\n      props.scale = this.scale;\n\n    return props;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleDisplacement): boolean {\n    return this.channelName === other.channelName && this.scale === other.scale;\n  }\n}\n\n/** JSON representation of an [[AnalysisStyleThematic]].\n * @see [[AnalysisStyleProps.scalar]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleThematicProps {\n  /** See [[AnalysisStyleThematic.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleThematic.range]]. */\n  range: Range1dProps;\n  /** See [[AnalysisStyleThematic.thematicSettings]].\n   * Default value: [[ThematicGradientSettings.defaults]].\n   */\n  thematicSettings?: ThematicGradientSettingsProps;\n}\n\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\n * @see [[AnalysisStyle.thematic]].\n * @public\n */\nexport class AnalysisStyleThematic {\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\n  public readonly channelName: string;\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\n   * this range are displayed with the gradient's margin color.\n   */\n  public readonly range: Readonly<Range1d>;\n  /** Settings used to produce the [[Gradient]] image. */\n  public readonly thematicSettings: ThematicGradientSettings;\n  private _gradient?: Gradient.Symb;\n\n  /** @internal */\n  private constructor(props: AnalysisStyleThematicProps) {\n    this.channelName = props.channelName;\n    this.range = Range1d.fromJSON(props.range);\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\n    return new this(props);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleThematicProps {\n    const props: AnalysisStyleThematicProps = {\n      channelName: this.channelName,\n      range: this.range.toJSON(),\n    };\n\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\n      props.thematicSettings = this.thematicSettings.toJSON();\n\n    return props;\n  }\n\n  /** The gradient computed from [[thematicSettings]]. */\n  public get gradient(): Gradient.Symb {\n    if (!this._gradient)\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\n\n    return this._gradient;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleThematic): boolean {\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\n  }\n}\n\n/** JSON representation of an [[AnalysisStyle]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleProps {\n  /** See [[AnalysisStyle.displacement]]. */\n  displacement?: AnalysisStyleDisplacementProps;\n  /** JSON representation of [[AnalysisStyle.thematic]].\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\n   */\n  scalar?: AnalysisStyleThematicProps;\n  /** See [[AnalysisStyle.normalChannelName]]. */\n  normalChannelName?: string;\n}\n\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\n * but that representation is not part of the public API.\n * @internal exported strictly for tests.\n */\nexport interface LegacyAnalysisStyleProps {\n  displacementChannelName?: string;\n  scalarChannelName?: string;\n  normalChannelName?: string;\n  displacementScale?: number;\n  scalarRange?: Range1dProps;\n  scalarThematicSettings?: ThematicGradientSettingsProps;\n}\n\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\n  if (input.displacement || input.scalar)\n    return input;\n\n  const legacy = input as LegacyAnalysisStyleProps;\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\n    return input;\n\n  const output: AnalysisStyleProps = {\n    normalChannelName: input.normalChannelName,\n  };\n\n  if (undefined !== legacy.displacementChannelName) {\n    output.displacement = {\n      channelName: legacy.displacementChannelName,\n      scale: legacy.displacementScale,\n    };\n  }\n\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\n    output.scalar = {\n      channelName: legacy.scalarChannelName,\n      range: legacy.scalarRange,\n      thematicSettings: legacy.scalarThematicSettings,\n    };\n  }\n\n  return output;\n}\n\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\n * @public\n */\nexport class AnalysisStyle {\n  public readonly displacement?: AnalysisStyleDisplacement;\n  public readonly thematic?: AnalysisStyleThematic;\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\n  public readonly normalChannelName?: string;\n\n  /** Create an analysis style from its JSON representation.\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\n   */\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\n    if (!props)\n      return this.defaults;\n\n    props = tryConvertLegacyProps(props);\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\n      return this.defaults;\n\n    return new AnalysisStyle(props);\n  }\n\n  /** @internal */\n  private constructor(props: AnalysisStyleProps) {\n    this.normalChannelName = props.normalChannelName;\n    if (props.displacement)\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\n\n    if (props.scalar)\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\n  }\n\n  /** Convert this style to its JSON representation. */\n  public toJSON(): AnalysisStyleProps {\n    const props: AnalysisStyleProps = {};\n    if (this === AnalysisStyle.defaults)\n      return props;\n\n    if (this.displacement)\n      props.displacement = this.displacement.toJSON();\n\n    if (this.thematic)\n      props.scalar = this.thematic.toJSON();\n\n    if (undefined !== this.normalChannelName)\n      props.normalChannelName = this.normalChannelName;\n\n    return props;\n  }\n\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\n    return AnalysisStyle.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  /** Return true if this style is equivalent to `other`. */\n  public equals(other: AnalysisStyle): boolean {\n    if (this.normalChannelName !== other.normalChannelName)\n      return false;\n\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\n      return false;\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\n      return false;\n\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\n      return false;\n\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\n  }\n\n  public static readonly defaults = new AnalysisStyle({});\n}\n"]}
+{"version":3,"file":"AnalysisStyle.js","sourceRoot":"","sources":["../../src/AnalysisStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAA6D;AAC7D,uDAA4F;AAC5F,yCAAsC;AAgBtC;;;GAGG;AACH,MAAa,yBAAyB;IACpC,8GAA8G;IAC9F,WAAW,CAAS;IACpC;;OAEG;IACa,KAAK,CAAS;IAE9B,YAAoB,WAAmB,EAAE,KAAK,GAAG,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAqC;QAC1D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAmC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAAgC;QAC5C,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC;IAC9E,CAAC;CACF;AA/BD,8DA+BC;AAkBD;;;;;GAKG;AACH,MAAa,qBAAqB;IAChC,mHAAmH;IACnG,WAAW,CAAS;IACpC;;OAEG;IACa,KAAK,CAAoB;IACzC,uDAAuD;IACvC,gBAAgB,CAA2B;IACnD,SAAS,CAAiB;IAElC,YAAoB,KAAiC;QACnD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,gBAAgB,GAAG,0CAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpF,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;SAC3B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,0CAAwB,CAAC,QAAQ,CAAC;YAClE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uDAAuD;IACvD,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,IAAI,CAAC,SAAS,GAAG,mBAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEvE,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjJ,CAAC;CACF;AA/CD,sDA+CC;AA+BD,SAAS,qBAAqB,CAAC,KAAyB;IACtD,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,MAAM;QACpC,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAG,KAAiC,CAAC;IACjD,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;QACxF,OAAO,KAAK,CAAC;IAEf,MAAM,MAAM,GAAuB;QACjC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;KAC3C,CAAC;IAEF,IAAI,SAAS,KAAK,MAAM,CAAC,uBAAuB,EAAE,CAAC;QACjD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC;QAC/E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAa,aAAa;IACR,YAAY,CAA6B;IACzC,QAAQ,CAAyB;IACjD,qHAAqH;IACrG,iBAAiB,CAAU;IAE3C;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,KAAK,KAAK,CAAC,iBAAiB;YAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,YAAoB,KAAyB;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,KAAK,CAAC,YAAY;YACpB,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAE7E,IAAI,KAAK,CAAC,MAAM;YACd,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,qDAAqD;IAC9C,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,IAAI,KAAK,aAAa,CAAC,QAAQ;YACjC,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2GAA2G;IACpG,KAAK,CAAC,YAAgC;QAC3C,OAAO,aAAa,CAAC,QAAQ,CAAC;YAC5B,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;YACpD,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,CAAC;YAC1E,OAAO,KAAK,CAAC;aACV,IAAI,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,YAAa,CAAC;YAC1E,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC;YAClE,OAAO,KAAK,CAAC;QAEf,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAU,QAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;;AAvE1D,sCAwEC","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 { Range1d, Range1dProps } from \"@itwin/core-geometry\";\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\nimport { Gradient } from \"./Gradient\";\n\n/** JSON representation of an [[AnalysisStyleDisplacement]].\n * @see [[AnalysisStyleProps.displacement]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleDisplacementProps {\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleDisplacement.scale]].\n   * Default value: 1.\n   */\n  scale?: number;\n}\n\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\n * @see [[AnalysisStyle.displacement]].\n * @public\n */\nexport class AnalysisStyleDisplacement {\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\n  public readonly channelName: string;\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\n   * Default value: 1.\n   */\n  public readonly scale: number;\n\n  private constructor(channelName: string, scale = 1) {\n    this.channelName = channelName;\n    this.scale = scale;\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\n    return new this(props.channelName, props.scale);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleDisplacementProps {\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\n    if (this.scale !== 1)\n      props.scale = this.scale;\n\n    return props;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleDisplacement): boolean {\n    return this.channelName === other.channelName && this.scale === other.scale;\n  }\n}\n\n/** JSON representation of an [[AnalysisStyleThematic]].\n * @see [[AnalysisStyleProps.scalar]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleThematicProps {\n  /** See [[AnalysisStyleThematic.channelName]]. */\n  channelName: string;\n  /** See [[AnalysisStyleThematic.range]]. */\n  range: Range1dProps;\n  /** See [[AnalysisStyleThematic.thematicSettings]].\n   * Default value: [[ThematicGradientSettings.defaults]].\n   */\n  thematicSettings?: ThematicGradientSettingsProps;\n}\n\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\n * @see [[AnalysisStyle.thematic]].\n * @public\n */\nexport class AnalysisStyleThematic {\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\n  public readonly channelName: string;\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\n   * this range are displayed with the gradient's margin color.\n   */\n  public readonly range: Readonly<Range1d>;\n  /** Settings used to produce the [[Gradient]] image. */\n  public readonly thematicSettings: ThematicGradientSettings;\n  private _gradient?: Gradient.Symb;\n\n  private constructor(props: AnalysisStyleThematicProps) {\n    this.channelName = props.channelName;\n    this.range = Range1d.fromJSON(props.range);\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\n    return new this(props);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): AnalysisStyleThematicProps {\n    const props: AnalysisStyleThematicProps = {\n      channelName: this.channelName,\n      range: this.range.toJSON(),\n    };\n\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\n      props.thematicSettings = this.thematicSettings.toJSON();\n\n    return props;\n  }\n\n  /** The gradient computed from [[thematicSettings]]. */\n  public get gradient(): Gradient.Symb {\n    if (!this._gradient)\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\n\n    return this._gradient;\n  }\n\n  /** Return true if `this` is equivalent to `other`. */\n  public equals(other: AnalysisStyleThematic): boolean {\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\n  }\n}\n\n/** JSON representation of an [[AnalysisStyle]].\n * @public\n * @extensions\n */\nexport interface AnalysisStyleProps {\n  /** See [[AnalysisStyle.displacement]]. */\n  displacement?: AnalysisStyleDisplacementProps;\n  /** JSON representation of [[AnalysisStyle.thematic]].\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\n   */\n  scalar?: AnalysisStyleThematicProps;\n  /** See [[AnalysisStyle.normalChannelName]]. */\n  normalChannelName?: string;\n}\n\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\n * but that representation is not part of the public API.\n * @internal exported strictly for tests.\n */\nexport interface LegacyAnalysisStyleProps {\n  displacementChannelName?: string;\n  scalarChannelName?: string;\n  normalChannelName?: string;\n  displacementScale?: number;\n  scalarRange?: Range1dProps;\n  scalarThematicSettings?: ThematicGradientSettingsProps;\n}\n\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\n  if (input.displacement || input.scalar)\n    return input;\n\n  const legacy = input as LegacyAnalysisStyleProps;\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\n    return input;\n\n  const output: AnalysisStyleProps = {\n    normalChannelName: input.normalChannelName,\n  };\n\n  if (undefined !== legacy.displacementChannelName) {\n    output.displacement = {\n      channelName: legacy.displacementChannelName,\n      scale: legacy.displacementScale,\n    };\n  }\n\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\n    output.scalar = {\n      channelName: legacy.scalarChannelName,\n      range: legacy.scalarRange,\n      thematicSettings: legacy.scalarThematicSettings,\n    };\n  }\n\n  return output;\n}\n\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\n * @public\n */\nexport class AnalysisStyle {\n  public readonly displacement?: AnalysisStyleDisplacement;\n  public readonly thematic?: AnalysisStyleThematic;\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\n  public readonly normalChannelName?: string;\n\n  /** Create an analysis style from its JSON representation.\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\n   */\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\n    if (!props)\n      return this.defaults;\n\n    props = tryConvertLegacyProps(props);\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\n      return this.defaults;\n\n    return new AnalysisStyle(props);\n  }\n\n  private constructor(props: AnalysisStyleProps) {\n    this.normalChannelName = props.normalChannelName;\n    if (props.displacement)\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\n\n    if (props.scalar)\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\n  }\n\n  /** Convert this style to its JSON representation. */\n  public toJSON(): AnalysisStyleProps {\n    const props: AnalysisStyleProps = {};\n    if (this === AnalysisStyle.defaults)\n      return props;\n\n    if (this.displacement)\n      props.displacement = this.displacement.toJSON();\n\n    if (this.thematic)\n      props.scalar = this.thematic.toJSON();\n\n    if (undefined !== this.normalChannelName)\n      props.normalChannelName = this.normalChannelName;\n\n    return props;\n  }\n\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\n    return AnalysisStyle.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  /** Return true if this style is equivalent to `other`. */\n  public equals(other: AnalysisStyle): boolean {\n    if (this.normalChannelName !== other.normalChannelName)\n      return false;\n\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\n      return false;\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\n      return false;\n\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\n      return false;\n\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\n  }\n\n  public static readonly defaults = new AnalysisStyle({});\n}\n"]}

package/lib/cjs/Atmosphere.js

@@ -31,9 +31,11 @@ const core_bentley_1 = require("@itwin/core-bentley");
  */
 var Atmosphere;
 (function (Atmosphere) {
-    var _a;
     /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */
     class Wavelengths {
+        r;
+        g;
+        b;
         /** Constructs from red, green, and blue wavelength values.
          * @param r Wavelength value for red
          * @param g Wavelength value for green
@@ -68,6 +70,33 @@ var Atmosphere;
     Atmosphere.Wavelengths = Wavelengths;
     /** Describes the properties with which the atmospheric scattering effect should be drawn. Theses properties correspond to a physics-based approximation of atmospheric scattering phenomenons. */
     class Settings {
+        static _defaultAtmosphereHeightAboveEarth = 100000.0;
+        static _defaultExposure = 2.0;
+        static _defaultDensityFalloff = 10.0;
+        static _defaultMinDensityHeightBelowEarth;
+        static _defaultScatteringStrength = 100;
+        static _defaultWavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });
+        static _defaultNumViewRaySamples = 10;
+        static _highQualityNumViewRaySamples = 20;
+        static _defaultNumSunRaySamples = 5;
+        static defaults = new Settings({});
+        static highQuality = new Settings({ numViewRaySamples: this._highQualityNumViewRaySamples });
+        /** @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. */
+        atmosphereHeightAboveEarth;
+        /** 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 */
+        exposure;
+        /** @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. */
+        densityFalloff;
+        /** @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. */
+        depthBelowEarthForMaxDensity;
+        /** 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. */
+        numViewRaySamples;
+        /** 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. */
+        numSunRaySamples;
+        /** @internal If defined, controls how strongly the atmosphere's air diverts light. Higher values increase scattering intensity. Defaults to 100.0. */
+        scatteringStrength;
+        /** @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}. */
+        wavelengths;
         equals(other) {
             if (this.atmosphereHeightAboveEarth !== other.atmosphereHeightAboveEarth)
                 return false;
@@ -88,19 +117,19 @@ var Atmosphere;
             return true;
         }
         constructor(json) {
-            this.atmosphereHeightAboveEarth = core_bentley_1.JsonUtils.asDouble(json.atmosphereHeightAboveEarth, _a._defaultAtmosphereHeightAboveEarth);
-            this.exposure = core_bentley_1.JsonUtils.asDouble(json.exposure, _a._defaultExposure);
-            this.densityFalloff = core_bentley_1.JsonUtils.asDouble(json.densityFalloff, _a._defaultDensityFalloff);
-            this.depthBelowEarthForMaxDensity = core_bentley_1.JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, _a._defaultMinDensityHeightBelowEarth);
-            this.numViewRaySamples = core_bentley_1.JsonUtils.asDouble(json.numViewRaySamples, _a._defaultNumViewRaySamples);
-            this.numSunRaySamples = core_bentley_1.JsonUtils.asDouble(json.numSunRaySamples, _a._defaultNumSunRaySamples);
-            this.scatteringStrength = core_bentley_1.JsonUtils.asDouble(json.scatteringStrength, _a._defaultScatteringStrength);
-            this.wavelengths = Wavelengths.fromJSON(core_bentley_1.JsonUtils.asObject(json.wavelengths) ?? _a._defaultWavelengths);
+            this.atmosphereHeightAboveEarth = core_bentley_1.JsonUtils.asDouble(json.atmosphereHeightAboveEarth, Settings._defaultAtmosphereHeightAboveEarth);
+            this.exposure = core_bentley_1.JsonUtils.asDouble(json.exposure, Settings._defaultExposure);
+            this.densityFalloff = core_bentley_1.JsonUtils.asDouble(json.densityFalloff, Settings._defaultDensityFalloff);
+            this.depthBelowEarthForMaxDensity = core_bentley_1.JsonUtils.asDouble(json.depthBelowEarthForMaxDensity, Settings._defaultMinDensityHeightBelowEarth);
+            this.numViewRaySamples = core_bentley_1.JsonUtils.asDouble(json.numViewRaySamples, Settings._defaultNumViewRaySamples);
+            this.numSunRaySamples = core_bentley_1.JsonUtils.asDouble(json.numSunRaySamples, Settings._defaultNumSunRaySamples);
+            this.scatteringStrength = core_bentley_1.JsonUtils.asDouble(json.scatteringStrength, Settings._defaultScatteringStrength);
+            this.wavelengths = Wavelengths.fromJSON(core_bentley_1.JsonUtils.asObject(json.wavelengths) ?? Settings._defaultWavelengths);
         }
         static fromJSON(json) {
             if (undefined === json)
                 return this.defaults;
-            return new _a(json);
+            return new Settings(json);
         }
         toJSON(display) {
             const json = {
@@ -118,17 +147,6 @@ var Atmosphere;
             return json;
         }
     }
-    _a = Settings;
-    Settings._defaultAtmosphereHeightAboveEarth = 100000.0;
-    Settings._defaultExposure = 2.0;
-    Settings._defaultDensityFalloff = 10.0;
-    Settings._defaultScatteringStrength = 100;
-    Settings._defaultWavelengths = new Wavelengths({ r: 700.0, g: 530.0, b: 440.0 });
-    Settings._defaultNumViewRaySamples = 10;
-    Settings._highQualityNumViewRaySamples = 20;
-    Settings._defaultNumSunRaySamples = 5;
-    Settings.defaults = new _a({});
-    Settings.highQuality = new _a({ numViewRaySamples: _a._highQualityNumViewRaySamples });
     Atmosphere.Settings = Settings;
 })(Atmosphere || (exports.Atmosphere = Atmosphere = {}));
 //# sourceMappingURL=Atmosphere.js.map

package/lib/cjs/Atmosphere.js.map

@@ -1 +1 @@
-{"version":3,"file":"Atmosphere.js","sourceRoot":"","sources":["../../src/Atmosphere.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,IAAiB,UAAU,CAgK1B;AAhKD,WAAiB,UAAU;;IASzB,oIAAoI;IACpI,MAAa,WAAW;QAKtB;;;;WAIG;QACH,YAAY,KAAuB;YACjC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QAEM,MAAM,CAAC,KAAkB;YAC9B,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;QACxE,CAAC;QAEM,MAAM;YACX,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;QAC7C,CAAC;QAEM,MAAM,CAAC,QAAQ,CAAC,IAAkC;YACvD,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,SAAS,KAAK,IAAI,EAAE,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;QAgCZ,MAAM,CAAC,KAAe;YAC3B,IAAI,IAAI,CAAC,0BAA0B,KAAK,KAAK,CAAC,0BAA0B;gBACtE,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;gBAClC,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc;gBAC9C,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,4BAA4B,KAAK,KAAK,CAAC,4BAA4B;gBAC1E,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;gBACpD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;gBAClD,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB;gBACtD,OAAO,KAAK,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;gBAC7C,OAAO,KAAK,CAAC;YACf,OAAO,IAAI,CAAC;QACd,CAAC;QAED,YAAoB,IAAW;YAC7B,IAAI,CAAC,0BAA0B,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAQ,CAAC,kCAAkC,CAAC,CAAC;YACnI,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,EAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC/F,IAAI,CAAC,4BAA4B,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAQ,CAAC,kCAAkC,CAAC,CAAC;YACvI,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAQ,CAAC,yBAAyB,CAAC,CAAC;YACxG,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAQ,CAAC,wBAAwB,CAAC,CAAC;YACrG,IAAI,CAAC,kBAAkB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC3G,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAQ,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,EAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAEM,MAAM,CAAC,OAAiB;YAC7B,MAAM,IAAI,GAAU;gBAClB,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;gBAC3D,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;gBAC/D,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;gBACzC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;aACvC,CAAC;YAEF,IAAI,SAAS,KAAK,OAAO;gBACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YAEzB,OAAO,IAAI,CAAC;QACd,CAAC;;;IApFc,2CAAkC,GAAW,QAAQ,AAAnB,CAAoB;IACtD,yBAAgB,GAAW,GAAG,AAAd,CAAe;IAC/B,+BAAsB,GAAW,IAAI,AAAf,CAAgB;IAEtC,mCAA0B,GAAW,GAAG,AAAd,CAAe;IACzC,4BAAmB,GAAgB,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,AAAjE,CAAkE;IAErF,kCAAyB,GAAW,EAAE,AAAb,CAAc;IACvC,sCAA6B,GAAW,EAAE,AAAb,CAAc;IAC3C,iCAAwB,GAAW,CAAC,AAAZ,CAAa;IAE7B,iBAAQ,GAAG,IAAI,EAAQ,CAAC,EAAE,CAAC,AAAnB,CAAoB;IAC5B,oBAAW,GAAG,IAAI,EAAQ,CAAC,EAAE,iBAAiB,EAAE,EAAI,CAAC,6BAA6B,EAAE,CAAC,AAA1E,CAA2E;IAblG,mBAAQ,WAsFpB,CAAA;AACH,CAAC,EAhKgB,UAAU,0BAAV,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,sDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,IAAiB,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,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,0BAA0B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACnI,IAAI,CAAC,QAAQ,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC/F,IAAI,CAAC,4BAA4B,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;YACvI,IAAI,CAAC,iBAAiB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;YACxG,IAAI,CAAC,gBAAgB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YACrG,IAAI,CAAC,kBAAkB,GAAG,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC3G,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,wBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAChH,CAAC;QAEM,MAAM,CAAC,QAAQ,CAAC,IAAY;YACjC,IAAI,SAAS,KAAK,IAAI;gBACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;YACvB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAEM,MAAM,CAAC,OAAiB;YAC7B,MAAM,IAAI,GAAU;gBAClB,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;gBAC3D,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,4BAA4B,EAAE,IAAI,CAAC,4BAA4B;gBAC/D,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;gBACzC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;aACvC,CAAC;YAEF,IAAI,SAAS,KAAK,OAAO;gBACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YAEzB,OAAO,IAAI,CAAC;QACd,CAAC;;IArFU,mBAAQ,WAsFpB,CAAA;AACH,CAAC,EAhKgB,UAAU,0BAAV,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/cjs/BackgroundMapProvider.js

@@ -22,6 +22,10 @@ var BackgroundMapType;
  * @public
  */
 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/cjs/BackgroundMapProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE,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;AArDD,sDAqDC","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,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,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;AArDD,sDAqDC","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/cjs/BackgroundMapSettings.js

@@ -38,6 +38,25 @@ function normalizeTransparency(trans) {
  * @public
  */
 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.
      */