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

package/lib/cjs/AnalysisStyle.js

@@ -1,166 +1,166 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalysisStyle = exports.AnalysisStyleThematic = exports.AnalysisStyleDisplacement = void 0;
-const core_geometry_1 = require("@itwin/core-geometry");
-const ThematicDisplay_1 = require("./ThematicDisplay");
-const Gradient_1 = require("./Gradient");
-/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.
- * @see [[AnalysisStyle.displacement]].
- * @public
- */
-class AnalysisStyleDisplacement {
-    /** @internal */
-    constructor(channelName, scale = 1) {
-        this.channelName = channelName;
-        this.scale = scale;
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        return new this(props.channelName, props.scale);
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        const props = { channelName: this.channelName };
-        if (this.scale !== 1)
-            props.scale = this.scale;
-        return props;
-    }
-    /** Return true if `this` is equivalent to `other`. */
-    equals(other) {
-        return this.channelName === other.channelName && this.scale === other.scale;
-    }
-}
-exports.AnalysisStyleDisplacement = AnalysisStyleDisplacement;
-/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type
- * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied
- * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.
- * @see [[AnalysisStyle.thematic]].
- * @public
- */
-class AnalysisStyleThematic {
-    /** @internal */
-    constructor(props) {
-        this.channelName = props.channelName;
-        this.range = core_geometry_1.Range1d.fromJSON(props.range);
-        this.thematicSettings = ThematicDisplay_1.ThematicGradientSettings.fromJSON(props.thematicSettings);
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        return new this(props);
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        const props = {
-            channelName: this.channelName,
-            range: this.range.toJSON(),
-        };
-        if (!this.thematicSettings.equals(ThematicDisplay_1.ThematicGradientSettings.defaults))
-            props.thematicSettings = this.thematicSettings.toJSON();
-        return props;
-    }
-    /** The gradient computed from [[thematicSettings]]. */
-    get gradient() {
-        if (!this._gradient)
-            this._gradient = Gradient_1.Gradient.Symb.createThematic(this.thematicSettings);
-        return this._gradient;
-    }
-    /** Return true if `this` is equivalent to `other`. */
-    equals(other) {
-        return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);
-    }
-}
-exports.AnalysisStyleThematic = AnalysisStyleThematic;
-function tryConvertLegacyProps(input) {
-    if (input.displacement || input.scalar)
-        return input;
-    const legacy = input;
-    if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)
-        return input;
-    const output = {
-        normalChannelName: input.normalChannelName,
-    };
-    if (undefined !== legacy.displacementChannelName) {
-        output.displacement = {
-            channelName: legacy.displacementChannelName,
-            scale: legacy.displacementScale,
-        };
-    }
-    if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {
-        output.scalar = {
-            channelName: legacy.scalarChannelName,
-            range: legacy.scalarRange,
-            thematicSettings: legacy.scalarThematicSettings,
-        };
-    }
-    return output;
-}
-/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with
- * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by
- * translating vertices and/or recolor vertices using [[ThematicDisplay]].
- * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).
- * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.
- * @public
- */
-class AnalysisStyle {
-    /** @internal */
-    constructor(props) {
-        this.normalChannelName = props.normalChannelName;
-        if (props.displacement)
-            this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);
-        if (props.scalar)
-            this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);
-    }
-    /** Create an analysis style from its JSON representation.
-     * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.
-     */
-    static fromJSON(props) {
-        if (!props)
-            return this.defaults;
-        props = tryConvertLegacyProps(props);
-        if (!props.displacement && !props.scalar && undefined === props.normalChannelName)
-            return this.defaults;
-        return new AnalysisStyle(props);
-    }
-    /** Convert this style to its JSON representation. */
-    toJSON() {
-        const props = {};
-        if (this === AnalysisStyle.defaults)
-            return props;
-        if (this.displacement)
-            props.displacement = this.displacement.toJSON();
-        if (this.thematic)
-            props.scalar = this.thematic.toJSON();
-        if (undefined !== this.normalChannelName)
-            props.normalChannelName = this.normalChannelName;
-        return props;
-    }
-    /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */
-    clone(changedProps) {
-        return AnalysisStyle.fromJSON({
-            ...this.toJSON(),
-            ...changedProps,
-        });
-    }
-    /** Return true if this style is equivalent to `other`. */
-    equals(other) {
-        if (this.normalChannelName !== other.normalChannelName)
-            return false;
-        if ((undefined === this.displacement) !== (undefined === other.displacement))
-            return false;
-        else if (this.displacement && !this.displacement.equals(other.displacement))
-            return false;
-        if ((undefined === this.thematic) !== (undefined === other.thematic))
-            return false;
-        return undefined === this.thematic || this.thematic.equals(other.thematic);
-    }
-}
-exports.AnalysisStyle = AnalysisStyle;
-AnalysisStyle.defaults = new AnalysisStyle({});
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalysisStyle = exports.AnalysisStyleThematic = exports.AnalysisStyleDisplacement = void 0;
+const core_geometry_1 = require("@itwin/core-geometry");
+const ThematicDisplay_1 = require("./ThematicDisplay");
+const Gradient_1 = require("./Gradient");
+/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.
+ * @see [[AnalysisStyle.displacement]].
+ * @public
+ */
+class AnalysisStyleDisplacement {
+    /** @internal */
+    constructor(channelName, scale = 1) {
+        this.channelName = channelName;
+        this.scale = scale;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        return new this(props.channelName, props.scale);
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        const props = { channelName: this.channelName };
+        if (this.scale !== 1)
+            props.scale = this.scale;
+        return props;
+    }
+    /** Return true if `this` is equivalent to `other`. */
+    equals(other) {
+        return this.channelName === other.channelName && this.scale === other.scale;
+    }
+}
+exports.AnalysisStyleDisplacement = AnalysisStyleDisplacement;
+/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type
+ * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied
+ * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.
+ * @see [[AnalysisStyle.thematic]].
+ * @public
+ */
+class AnalysisStyleThematic {
+    /** @internal */
+    constructor(props) {
+        this.channelName = props.channelName;
+        this.range = core_geometry_1.Range1d.fromJSON(props.range);
+        this.thematicSettings = ThematicDisplay_1.ThematicGradientSettings.fromJSON(props.thematicSettings);
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        return new this(props);
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        const props = {
+            channelName: this.channelName,
+            range: this.range.toJSON(),
+        };
+        if (!this.thematicSettings.equals(ThematicDisplay_1.ThematicGradientSettings.defaults))
+            props.thematicSettings = this.thematicSettings.toJSON();
+        return props;
+    }
+    /** The gradient computed from [[thematicSettings]]. */
+    get gradient() {
+        if (!this._gradient)
+            this._gradient = Gradient_1.Gradient.Symb.createThematic(this.thematicSettings);
+        return this._gradient;
+    }
+    /** Return true if `this` is equivalent to `other`. */
+    equals(other) {
+        return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);
+    }
+}
+exports.AnalysisStyleThematic = AnalysisStyleThematic;
+function tryConvertLegacyProps(input) {
+    if (input.displacement || input.scalar)
+        return input;
+    const legacy = input;
+    if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)
+        return input;
+    const output = {
+        normalChannelName: input.normalChannelName,
+    };
+    if (undefined !== legacy.displacementChannelName) {
+        output.displacement = {
+            channelName: legacy.displacementChannelName,
+            scale: legacy.displacementScale,
+        };
+    }
+    if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {
+        output.scalar = {
+            channelName: legacy.scalarChannelName,
+            range: legacy.scalarRange,
+            thematicSettings: legacy.scalarThematicSettings,
+        };
+    }
+    return output;
+}
+/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with
+ * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by
+ * translating vertices and/or recolor vertices using [[ThematicDisplay]].
+ * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).
+ * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.
+ * @public
+ */
+class AnalysisStyle {
+    /** Create an analysis style from its JSON representation.
+     * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.
+     */
+    static fromJSON(props) {
+        if (!props)
+            return this.defaults;
+        props = tryConvertLegacyProps(props);
+        if (!props.displacement && !props.scalar && undefined === props.normalChannelName)
+            return this.defaults;
+        return new AnalysisStyle(props);
+    }
+    /** @internal */
+    constructor(props) {
+        this.normalChannelName = props.normalChannelName;
+        if (props.displacement)
+            this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);
+        if (props.scalar)
+            this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);
+    }
+    /** Convert this style to its JSON representation. */
+    toJSON() {
+        const props = {};
+        if (this === AnalysisStyle.defaults)
+            return props;
+        if (this.displacement)
+            props.displacement = this.displacement.toJSON();
+        if (this.thematic)
+            props.scalar = this.thematic.toJSON();
+        if (undefined !== this.normalChannelName)
+            props.normalChannelName = this.normalChannelName;
+        return props;
+    }
+    /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */
+    clone(changedProps) {
+        return AnalysisStyle.fromJSON({
+            ...this.toJSON(),
+            ...changedProps,
+        });
+    }
+    /** Return true if this style is equivalent to `other`. */
+    equals(other) {
+        if (this.normalChannelName !== other.normalChannelName)
+            return false;
+        if ((undefined === this.displacement) !== (undefined === other.displacement))
+            return false;
+        else if (this.displacement && !this.displacement.equals(other.displacement))
+            return false;
+        if ((undefined === this.thematic) !== (undefined === other.thematic))
+            return false;
+        return undefined === this.thematic || this.thematic.equals(other.thematic);
+    }
+}
+AnalysisStyle.defaults = new AnalysisStyle({});
+exports.AnalysisStyle = 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;QAChD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;KACH;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE;QAC9E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAa,aAAa;IAoBxB,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;IAtBD;;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;IAYD,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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Range1d, Range1dProps } from \"@itwin/core-geometry\";\r\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\r\nimport { Gradient } from \"./Gradient\";\r\n\r\n/** JSON representation of an [[AnalysisStyleDisplacement]].\r\n * @see [[AnalysisStyleProps.displacement]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleDisplacementProps {\r\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleDisplacement.scale]].\r\n   * Default value: 1.\r\n   */\r\n  scale?: number;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\r\n * @see [[AnalysisStyle.displacement]].\r\n * @public\r\n */\r\nexport class AnalysisStyleDisplacement {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\r\n  public readonly channelName: string;\r\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\r\n   * Default value: 1.\r\n   */\r\n  public readonly scale: number;\r\n\r\n  /** @internal */\r\n  private constructor(channelName: string, scale = 1) {\r\n    this.channelName = channelName;\r\n    this.scale = scale;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\r\n    return new this(props.channelName, props.scale);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleDisplacementProps {\r\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\r\n    if (this.scale !== 1)\r\n      props.scale = this.scale;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleDisplacement): boolean {\r\n    return this.channelName === other.channelName && this.scale === other.scale;\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyleThematic]].\r\n * @see [[AnalysisStyleProps.scalar]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleThematicProps {\r\n  /** See [[AnalysisStyleThematic.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleThematic.range]]. */\r\n  range: Range1dProps;\r\n  /** See [[AnalysisStyleThematic.thematicSettings]].\r\n   * Default value: [[ThematicGradientSettings.defaults]].\r\n   */\r\n  thematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\r\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\r\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\r\n * @see [[AnalysisStyle.thematic]].\r\n * @public\r\n */\r\nexport class AnalysisStyleThematic {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\r\n  public readonly channelName: string;\r\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\r\n   * this range are displayed with the gradient's margin color.\r\n   */\r\n  public readonly range: Readonly<Range1d>;\r\n  /** Settings used to produce the [[Gradient]] image. */\r\n  public readonly thematicSettings: ThematicGradientSettings;\r\n  private _gradient?: Gradient.Symb;\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleThematicProps) {\r\n    this.channelName = props.channelName;\r\n    this.range = Range1d.fromJSON(props.range);\r\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\r\n    return new this(props);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleThematicProps {\r\n    const props: AnalysisStyleThematicProps = {\r\n      channelName: this.channelName,\r\n      range: this.range.toJSON(),\r\n    };\r\n\r\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\r\n      props.thematicSettings = this.thematicSettings.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** The gradient computed from [[thematicSettings]]. */\r\n  public get gradient(): Gradient.Symb {\r\n    if (!this._gradient)\r\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\r\n\r\n    return this._gradient;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleThematic): boolean {\r\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleProps {\r\n  /** See [[AnalysisStyle.displacement]]. */\r\n  displacement?: AnalysisStyleDisplacementProps;\r\n  /** JSON representation of [[AnalysisStyle.thematic]].\r\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\r\n   */\r\n  scalar?: AnalysisStyleThematicProps;\r\n  /** See [[AnalysisStyle.normalChannelName]]. */\r\n  normalChannelName?: string;\r\n}\r\n\r\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\r\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\r\n * but that representation is not part of the public API.\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface LegacyAnalysisStyleProps {\r\n  displacementChannelName?: string;\r\n  scalarChannelName?: string;\r\n  normalChannelName?: string;\r\n  displacementScale?: number;\r\n  scalarRange?: Range1dProps;\r\n  scalarThematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\r\n  if (input.displacement || input.scalar)\r\n    return input;\r\n\r\n  const legacy = input as LegacyAnalysisStyleProps;\r\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\r\n    return input;\r\n\r\n  const output: AnalysisStyleProps = {\r\n    normalChannelName: input.normalChannelName,\r\n  };\r\n\r\n  if (undefined !== legacy.displacementChannelName) {\r\n    output.displacement = {\r\n      channelName: legacy.displacementChannelName,\r\n      scale: legacy.displacementScale,\r\n    };\r\n  }\r\n\r\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\r\n    output.scalar = {\r\n      channelName: legacy.scalarChannelName,\r\n      range: legacy.scalarRange,\r\n      thematicSettings: legacy.scalarThematicSettings,\r\n    };\r\n  }\r\n\r\n  return output;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\r\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\r\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\r\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\r\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\r\n * @public\r\n */\r\nexport class AnalysisStyle {\r\n  public readonly displacement?: AnalysisStyleDisplacement;\r\n  public readonly thematic?: AnalysisStyleThematic;\r\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\r\n  public readonly normalChannelName?: string;\r\n\r\n  /** Create an analysis style from its JSON representation.\r\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\r\n   */\r\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    props = tryConvertLegacyProps(props);\r\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\r\n      return this.defaults;\r\n\r\n    return new AnalysisStyle(props);\r\n  }\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleProps) {\r\n    this.normalChannelName = props.normalChannelName;\r\n    if (props.displacement)\r\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\r\n\r\n    if (props.scalar)\r\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\r\n  }\r\n\r\n  /** Convert this style to its JSON representation. */\r\n  public toJSON(): AnalysisStyleProps {\r\n    const props: AnalysisStyleProps = {};\r\n    if (this === AnalysisStyle.defaults)\r\n      return props;\r\n\r\n    if (this.displacement)\r\n      props.displacement = this.displacement.toJSON();\r\n\r\n    if (this.thematic)\r\n      props.scalar = this.thematic.toJSON();\r\n\r\n    if (undefined !== this.normalChannelName)\r\n      props.normalChannelName = this.normalChannelName;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\r\n    return AnalysisStyle.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Return true if this style is equivalent to `other`. */\r\n  public equals(other: AnalysisStyle): boolean {\r\n    if (this.normalChannelName !== other.normalChannelName)\r\n      return false;\r\n\r\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\r\n      return false;\r\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\r\n      return false;\r\n\r\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\r\n      return false;\r\n\r\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\r\n  }\r\n\r\n  public static readonly defaults = new AnalysisStyle({});\r\n}\r\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;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;QAChD,MAAM,CAAC,YAAY,GAAG;YACpB,WAAW,EAAE,MAAM,CAAC,uBAAuB;YAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;SAChC,CAAC;KACH;IAED,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB,IAAI,SAAS,KAAK,MAAM,CAAC,WAAW,EAAE;QAC9E,MAAM,CAAC,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC,iBAAiB;YACrC,KAAK,EAAE,MAAM,CAAC,WAAW;YACzB,gBAAgB,EAAE,MAAM,CAAC,sBAAsB;SAChD,CAAC;KACH;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;;AAEsB,sBAAQ,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC;AAxE7C,sCAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Range1d, Range1dProps } from \"@itwin/core-geometry\";\r\nimport { ThematicGradientSettings, ThematicGradientSettingsProps } from \"./ThematicDisplay\";\r\nimport { Gradient } from \"./Gradient\";\r\n\r\n/** JSON representation of an [[AnalysisStyleDisplacement]].\r\n * @see [[AnalysisStyleProps.displacement]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleDisplacementProps {\r\n  /** See [[AnalysisStyleDisplacement.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleDisplacement.scale]].\r\n   * Default value: 1.\r\n   */\r\n  scale?: number;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] deforms a [Polyface]($core-geometry) by applying translation to its vertices.\r\n * @see [[AnalysisStyle.displacement]].\r\n * @public\r\n */\r\nexport class AnalysisStyleDisplacement {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the displacements to be applied to the vertices. */\r\n  public readonly channelName: string;\r\n  /** A scale applied to the displacements to adjust the magnitude of the effect.\r\n   * Default value: 1.\r\n   */\r\n  public readonly scale: number;\r\n\r\n  /** @internal */\r\n  private constructor(channelName: string, scale = 1) {\r\n    this.channelName = channelName;\r\n    this.scale = scale;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleDisplacementProps): AnalysisStyleDisplacement {\r\n    return new this(props.channelName, props.scale);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleDisplacementProps {\r\n    const props: AnalysisStyleDisplacementProps = { channelName: this.channelName };\r\n    if (this.scale !== 1)\r\n      props.scale = this.scale;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleDisplacement): boolean {\r\n    return this.channelName === other.channelName && this.scale === other.scale;\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyleThematic]].\r\n * @see [[AnalysisStyleProps.scalar]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleThematicProps {\r\n  /** See [[AnalysisStyleThematic.channelName]]. */\r\n  channelName: string;\r\n  /** See [[AnalysisStyleThematic.range]]. */\r\n  range: Range1dProps;\r\n  /** See [[AnalysisStyleThematic.thematicSettings]].\r\n   * Default value: [[ThematicGradientSettings.defaults]].\r\n   */\r\n  thematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\n/** Describes how an [[AnalysisStyle]] recolors [Polyface]($core-geometry) vertices by mapping values of type\r\n * [AuxChannelDataType.Scalar]($core-geometry) or [AuxChannelDataType.Distance]($core-geometry) supplied\r\n * by an [AuxChannel]($core-geometry) to colors supplied by a [[Gradient]] image.\r\n * @see [[AnalysisStyle.thematic]].\r\n * @public\r\n */\r\nexport class AnalysisStyleThematic {\r\n  /** The name of the [AuxChannel]($core-geometry) supplying the values from which the vertex colors are computed. */\r\n  public readonly channelName: string;\r\n  /** The minimum and maximum values that map to colors in the [[Gradient]] image. Vertices with values outside of\r\n   * this range are displayed with the gradient's margin color.\r\n   */\r\n  public readonly range: Readonly<Range1d>;\r\n  /** Settings used to produce the [[Gradient]] image. */\r\n  public readonly thematicSettings: ThematicGradientSettings;\r\n  private _gradient?: Gradient.Symb;\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleThematicProps) {\r\n    this.channelName = props.channelName;\r\n    this.range = Range1d.fromJSON(props.range);\r\n    this.thematicSettings = ThematicGradientSettings.fromJSON(props.thematicSettings);\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: AnalysisStyleThematicProps): AnalysisStyleThematic {\r\n    return new this(props);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): AnalysisStyleThematicProps {\r\n    const props: AnalysisStyleThematicProps = {\r\n      channelName: this.channelName,\r\n      range: this.range.toJSON(),\r\n    };\r\n\r\n    if (!this.thematicSettings.equals(ThematicGradientSettings.defaults))\r\n      props.thematicSettings = this.thematicSettings.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** The gradient computed from [[thematicSettings]]. */\r\n  public get gradient(): Gradient.Symb {\r\n    if (!this._gradient)\r\n      this._gradient = Gradient.Symb.createThematic(this.thematicSettings);\r\n\r\n    return this._gradient;\r\n  }\r\n\r\n  /** Return true if `this` is equivalent to `other`. */\r\n  public equals(other: AnalysisStyleThematic): boolean {\r\n    return this.channelName === other.channelName && this.range.isAlmostEqual(other.range) && this.thematicSettings.equals(other.thematicSettings);\r\n  }\r\n}\r\n\r\n/** JSON representation of an [[AnalysisStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AnalysisStyleProps {\r\n  /** See [[AnalysisStyle.displacement]]. */\r\n  displacement?: AnalysisStyleDisplacementProps;\r\n  /** JSON representation of [[AnalysisStyle.thematic]].\r\n   * @note The name \"scalar\" is used instead of \"thematic\" for backwards compatibility.\r\n   */\r\n  scalar?: AnalysisStyleThematicProps;\r\n  /** See [[AnalysisStyle.normalChannelName]]. */\r\n  normalChannelName?: string;\r\n}\r\n\r\n/** At time of writing, the only iModel in existence that uses AnalysisStyle is the one created by the analysis-importer test app.\r\n * To avoid breaking existing saved views of that iModel, AnalysisStyle.fromJSON() continues  to accept the old JSON representation -\r\n * but that representation is not part of the public API.\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface LegacyAnalysisStyleProps {\r\n  displacementChannelName?: string;\r\n  scalarChannelName?: string;\r\n  normalChannelName?: string;\r\n  displacementScale?: number;\r\n  scalarRange?: Range1dProps;\r\n  scalarThematicSettings?: ThematicGradientSettingsProps;\r\n}\r\n\r\nfunction tryConvertLegacyProps(input: AnalysisStyleProps): AnalysisStyleProps {\r\n  if (input.displacement || input.scalar)\r\n    return input;\r\n\r\n  const legacy = input as LegacyAnalysisStyleProps;\r\n  if (undefined === legacy.displacementChannelName && undefined === legacy.scalarChannelName)\r\n    return input;\r\n\r\n  const output: AnalysisStyleProps = {\r\n    normalChannelName: input.normalChannelName,\r\n  };\r\n\r\n  if (undefined !== legacy.displacementChannelName) {\r\n    output.displacement = {\r\n      channelName: legacy.displacementChannelName,\r\n      scale: legacy.displacementScale,\r\n    };\r\n  }\r\n\r\n  if (undefined !== legacy.scalarChannelName && undefined !== legacy.scalarRange) {\r\n    output.scalar = {\r\n      channelName: legacy.scalarChannelName,\r\n      range: legacy.scalarRange,\r\n      thematicSettings: legacy.scalarThematicSettings,\r\n    };\r\n  }\r\n\r\n  return output;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], describes how to animate meshes in the view that have been augmented with\r\n * [PolyfaceAuxData]($core-geometry). The style specifies which channels to use, and can deform the meshes by\r\n * translating vertices and/or recolor vertices using [[ThematicDisplay]].\r\n * @see [[DisplayStyleSettings.analysisStyle]] to define the analysis style for a [DisplayStyle]($backend).\r\n * @see [[DisplayStyleSettings.analysisFraction]] to control playback of the animation.\r\n * @public\r\n */\r\nexport class AnalysisStyle {\r\n  public readonly displacement?: AnalysisStyleDisplacement;\r\n  public readonly thematic?: AnalysisStyleThematic;\r\n  /** If defined, the name of the [AuxChannel]($core-geometry) from which to obtain normal vectors for the vertices. */\r\n  public readonly normalChannelName?: string;\r\n\r\n  /** Create an analysis style from its JSON representation.\r\n   * @note AnalysisStyle is an immutable type - use [[clone]] to produce a modified copy.\r\n   */\r\n  public static fromJSON(props?: AnalysisStyleProps): AnalysisStyle {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    props = tryConvertLegacyProps(props);\r\n    if (!props.displacement && !props.scalar && undefined === props.normalChannelName)\r\n      return this.defaults;\r\n\r\n    return new AnalysisStyle(props);\r\n  }\r\n\r\n  /** @internal */\r\n  private constructor(props: AnalysisStyleProps) {\r\n    this.normalChannelName = props.normalChannelName;\r\n    if (props.displacement)\r\n      this.displacement = AnalysisStyleDisplacement.fromJSON(props.displacement);\r\n\r\n    if (props.scalar)\r\n      this.thematic = AnalysisStyleThematic.fromJSON(props.scalar);\r\n  }\r\n\r\n  /** Convert this style to its JSON representation. */\r\n  public toJSON(): AnalysisStyleProps {\r\n    const props: AnalysisStyleProps = {};\r\n    if (this === AnalysisStyle.defaults)\r\n      return props;\r\n\r\n    if (this.displacement)\r\n      props.displacement = this.displacement.toJSON();\r\n\r\n    if (this.thematic)\r\n      props.scalar = this.thematic.toJSON();\r\n\r\n    if (undefined !== this.normalChannelName)\r\n      props.normalChannelName = this.normalChannelName;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Produce a copy of this style identical except for properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: AnalysisStyleProps): AnalysisStyle {\r\n    return AnalysisStyle.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Return true if this style is equivalent to `other`. */\r\n  public equals(other: AnalysisStyle): boolean {\r\n    if (this.normalChannelName !== other.normalChannelName)\r\n      return false;\r\n\r\n    if ((undefined === this.displacement) !== (undefined === other.displacement))\r\n      return false;\r\n    else if (this.displacement && !this.displacement.equals(other.displacement!))\r\n      return false;\r\n\r\n    if ((undefined === this.thematic) !== (undefined === other.thematic))\r\n      return false;\r\n\r\n    return undefined === this.thematic || this.thematic.equals(other.thematic!);\r\n  }\r\n\r\n  public static readonly defaults = new AnalysisStyle({});\r\n}\r\n"]}

package/lib/cjs/Atmosphere.d.ts

@@ -0,0 +1,99 @@
+/** Namespace containing types controlling how atmospheric scattering should be rendered.
+ * @beta
+ * The techniques used to render the atmosphere approximate the physical behavior of light when interacting with particles in the air (Rayleigh Scattering and Mie Scattering)
+ * Presently, only Rayleigh Scattering is implemented here
+ *
+ * In a nutshell, this implementation samples atmospheric density along rays cast from the view and uses the samples to simulate the scattering of light toward the camera.
+ * The amount of light scattered toward the camera is dependent on the amount of light scattered away from its original path from the sun, so rays must also be cast from the sample points to the sun.
+ *
+ * The effect can be computed on vertices (the default for the background map) and fragments (the default for the skybox, which is a ViewportQuad).
+ * All coordinates are in view space.
+ *
+ * This implementation is adapted from equations outlined in "Display of Clouds Taking into Account Multiple Anisotropic Scattering and Sky Light", Nishita et al. 1993
+ *   which are further refined for use in GPU shaders in "Photorealistic Real-Time Outdoor Light Scattering", Hoffman and Preetham 2002.
+ * These sources are also compiled in Chapter 16 of NVIDIA's "GPU Gems 2", which can be found online here:
+ *   https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering
+ *
+ * This implementation is also highly inspired by Sebastian Lague's Solar System project: https://github.com/SebLague/Solar-System/ and video: https://www.youtube.com/watch?v=DxfEbulyFcY
+ *   along with this ShaderToy replica: https://www.shadertoy.com/view/fltXD2.
+ * Both of which are inspired by this Nvidia article on atmospheric scattering: https://developer.nvidia.com/gpugems/gpugems2/part-ii-shading-lighting-and-shadows/chapter-16-accurate-atmospheric-scattering.
+ */
+export declare namespace Atmosphere {
+    /** @internal JSON representation of a [[Wavelengths]] object */
+    interface WavelengthsProps {
+        r: number;
+        g: number;
+        b: number;
+    }
+    /** @internal An immutable container of wavelength values for the red, green and blue pixel components. Values are in nanometers. */
+    class Wavelengths {
+        readonly r: number;
+        readonly g: number;
+        readonly b: number;
+        /** Constructs from red, green, and blue wavelength values.
+         * @param r Wavelength value for red
+         * @param g Wavelength value for green
+         * @param b Wavelength value for blue
+         */
+        constructor(props: WavelengthsProps);
+        equals(other: Wavelengths): boolean;
+        toJSON(): WavelengthsProps;
+        static fromJSON(json: WavelengthsProps | undefined): 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. */
+    interface Props {
+        /** Whether the ground plane should be displayed. Defaults to false. */
+        display?: boolean;
+        /** @internal See [[Settings.atmosphereHeightAboveEarth]] */
+        atmosphereHeightAboveEarth?: number;
+        /** See [[Settings.exposure]] */
+        exposure?: number;
+        /** @internal See [[Settings.densityFalloff]] */
+        densityFalloff?: number;
+        /** @internal See [[Settings.minDensityHeightBelowEarth]] */
+        depthBelowEarthForMaxDensity?: number;
+        /** See [[Settings.numViewRaySamples]] */
+        numViewRaySamples?: number;
+        /** See [[Settings.numSunRaySamples]] */
+        numSunRaySamples?: number;
+        /** @internal See [[Settings.scatteringStrength]] */
+        scatteringStrength?: number;
+        /** @internal See [[Settings.wavelengths]] */
+        wavelengths?: WavelengthsProps;
+    }
+    /** 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 {
+        private static _defaultAtmosphereHeightAboveEarth;
+        private static _defaultExposure;
+        private static _defaultDensityFalloff;
+        private static _defaultMinDensityHeightBelowEarth;
+        private static _defaultScatteringStrength;
+        private static _defaultWavelengths;
+        private static _defaultNumViewRaySamples;
+        private static _highQualityNumViewRaySamples;
+        private static _defaultNumSunRaySamples;
+        static readonly defaults: Settings;
+        static readonly highQuality: Settings;
+        /** @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. */
+        readonly atmosphereHeightAboveEarth: number;
+        /** 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 */
+        readonly exposure: number;
+        /** @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. */
+        readonly densityFalloff: number;
+        /** @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. */
+        readonly depthBelowEarthForMaxDensity: number;
+        /** 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. */
+        readonly numViewRaySamples: number;
+        /** 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. */
+        readonly numSunRaySamples: number;
+        /** @internal If defined, controls how strongly the atmosphere's air diverts light. Higher values increase scattering intensity. Defaults to 100.0. */
+        readonly scatteringStrength: number;
+        /** @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}. */
+        readonly wavelengths: Wavelengths;
+        equals(other: Settings): boolean;
+        private constructor();
+        static fromJSON(json?: Props): Settings;
+        toJSON(display?: boolean): Props;
+    }
+}
+//# sourceMappingURL=Atmosphere.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Atmosphere.d.ts","sourceRoot":"","sources":["../../src/Atmosphere.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,yBAAiB,UAAU,CAAC;IAE1B,gEAAgE;IAChE,UAAiB,gBAAgB;QAC/B,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX;IAED,oIAAoI;IACpI,MAAa,WAAW;QACtB,SAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,SAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,SAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;oBACS,KAAK,EAAE,gBAAgB;QAM5B,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;QAInC,MAAM,IAAI,gBAAgB;eAInB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,SAAS,GAAG,WAAW;KAcxE;IAED,kMAAkM;IAClM,UAAiB,KAAK;QACpB,uEAAuE;QACvE,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,4DAA4D;QAC5D,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,gCAAgC;QAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gDAAgD;QAChD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,4DAA4D;QAC5D,4BAA4B,CAAC,EAAE,MAAM,CAAC;QACtC,yCAAyC;QACzC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,wCAAwC;QACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oDAAoD;QACpD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,6CAA6C;QAC7C,WAAW,CAAC,EAAE,gBAAgB,CAAC;KAChC;IAED,kMAAkM;IAClM,MAAa,QAAQ;QACnB,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAoB;QACrE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAe;QAC9C,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAgB;QACrD,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAM;QACvD,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAe;QACxD,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAkE;QAEpG,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAc;QACtD,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAc;QAC1D,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAa;QAEpD,gBAAuB,QAAQ,WAAoB;QACnD,gBAAuB,WAAW,WAA2E;QAE7G,+PAA+P;QAC/P,SAAgB,0BAA0B,EAAE,MAAM,CAAC;QACnD,qPAAqP;QACrP,SAAgB,QAAQ,EAAE,MAAM,CAAC;QACjC,8NAA8N;QAC9N,SAAgB,cAAc,EAAE,MAAM,CAAC;QACvC,gQAAgQ;QAChQ,SAAgB,4BAA4B,EAAE,MAAM,CAAC;QACrD,gbAAgb;QAChb,SAAgB,iBAAiB,EAAE,MAAM,CAAC;QAC1C,oTAAoT;QACpT,SAAgB,gBAAgB,EAAE,MAAM,CAAC;QACzC,sJAAsJ;QACtJ,SAAgB,kBAAkB,EAAE,MAAM,CAAC;QAC3C,+YAA+Y;QAC/Y,SAAgB,WAAW,EAAE,WAAW,CAAC;QAElC,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;QAoBvC,OAAO;eAWO,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK;QAM5B,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;KAiBxC;CACF"}