@itwin/core-common 4.0.0-dev.52 → 4.0.0-dev.54

package/lib/esm/SubCategoryOverride.d.ts

@@ -1,47 +1,47 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { Id64String } from "@itwin/core-bentley";
-import { ColorDef } from "./ColorDef";
-import { SubCategoryAppearance } from "./SubCategoryAppearance";
-/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].
- * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:
- *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.
- *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.
- *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.
- * An aspect is overridden by virtue of not being set to "undefined" in the SubCategoryOverride.
- * @see [[DisplayStyleState.overrideSubCategory]]
- * @public
- */
-export declare class SubCategoryOverride {
-    /** See [[SubCategoryAppearance.color]] */
-    readonly color?: ColorDef;
-    /** See [[SubCategoryAppearance.invisible]] */
-    readonly invisible?: boolean;
-    /** See [[SubCategoryAppearance.weight]] */
-    readonly weight?: number;
-    /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */
-    readonly style?: Id64String;
-    /** See [[SubCategoryAppearance.priority]] */
-    readonly priority?: number;
-    /** See [[SubCategoryAppearance.materialId]] */
-    readonly material?: Id64String;
-    /** See [[SubCategoryAppearance.transparency]] */
-    readonly transparency?: number;
-    /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */
-    get anyOverridden(): boolean;
-    /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */
-    override(appearance: SubCategoryAppearance): SubCategoryAppearance;
-    /** Convert this SubCategoryOverride to a JSON object
-     * @internal
-     */
-    toJSON(): SubCategoryAppearance.Props;
-    /** Perform equality comparison against another SubCategoryOverride. */
-    equals(other: SubCategoryOverride): boolean;
-    /** Create a new SubCategoryOverride from a JSON object */
-    static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride;
-    private constructor();
-    /** A default SubCategoryOverride which overrides nothing. */
-    static defaults: SubCategoryOverride;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { ColorDef } from "./ColorDef";
+import { SubCategoryAppearance } from "./SubCategoryAppearance";
+/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].
+ * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:
+ *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.
+ *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.
+ *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.
+ * An aspect is overridden by virtue of not being set to "undefined" in the SubCategoryOverride.
+ * @see [[DisplayStyleState.overrideSubCategory]]
+ * @public
+ */
+export declare class SubCategoryOverride {
+    /** See [[SubCategoryAppearance.color]] */
+    readonly color?: ColorDef;
+    /** See [[SubCategoryAppearance.invisible]] */
+    readonly invisible?: boolean;
+    /** See [[SubCategoryAppearance.weight]] */
+    readonly weight?: number;
+    /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */
+    readonly style?: Id64String;
+    /** See [[SubCategoryAppearance.priority]] */
+    readonly priority?: number;
+    /** See [[SubCategoryAppearance.materialId]] */
+    readonly material?: Id64String;
+    /** See [[SubCategoryAppearance.transparency]] */
+    readonly transparency?: number;
+    /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */
+    get anyOverridden(): boolean;
+    /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */
+    override(appearance: SubCategoryAppearance): SubCategoryAppearance;
+    /** Convert this SubCategoryOverride to a JSON object
+     * @internal
+     */
+    toJSON(): SubCategoryAppearance.Props;
+    /** Perform equality comparison against another SubCategoryOverride. */
+    equals(other: SubCategoryOverride): boolean;
+    /** Create a new SubCategoryOverride from a JSON object */
+    static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride;
+    private constructor();
+    /** A default SubCategoryOverride which overrides nothing. */
+    static defaults: SubCategoryOverride;
+}
 //# sourceMappingURL=SubCategoryOverride.d.ts.map

package/lib/esm/SubCategoryOverride.js

@@ -1,101 +1,102 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { Id64, JsonUtils } from "@itwin/core-bentley";
-import { ColorDef } from "./ColorDef";
-import { SubCategoryAppearance } from "./SubCategoryAppearance";
-/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].
- * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:
- *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.
- *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.
- *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.
- * An aspect is overridden by virtue of not being set to "undefined" in the SubCategoryOverride.
- * @see [[DisplayStyleState.overrideSubCategory]]
- * @public
- */
-export class SubCategoryOverride {
-    constructor(props) {
-        if (undefined !== props.invisible)
-            this.invisible = JsonUtils.asBool(props.invisible);
-        if (undefined !== props.color)
-            this.color = ColorDef.fromJSON(props.color);
-        if (undefined !== props.weight)
-            this.weight = JsonUtils.asInt(props.weight);
-        if (undefined !== props.style)
-            this.style = Id64.fromJSON(props.style);
-        if (undefined !== props.material)
-            this.material = Id64.fromJSON(props.material);
-        if (undefined !== props.priority)
-            this.priority = JsonUtils.asInt(props.priority);
-        if (undefined !== props.transp)
-            this.transparency = JsonUtils.asDouble(props.transp);
-    }
-    /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */
-    get anyOverridden() {
-        return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;
-    }
-    /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */
-    override(appearance) {
-        if (!this.anyOverridden)
-            return appearance;
-        const props = appearance.toJSON();
-        const ovrProps = this.toJSON();
-        if (undefined !== ovrProps.invisible)
-            props.invisible = ovrProps.invisible;
-        if (undefined !== ovrProps.weight)
-            props.weight = ovrProps.weight;
-        if (undefined !== ovrProps.style)
-            props.style = ovrProps.style;
-        if (undefined !== ovrProps.material)
-            props.material = ovrProps.material;
-        if (undefined !== ovrProps.priority)
-            props.priority = ovrProps.priority;
-        if (undefined !== ovrProps.transp)
-            props.transp = ovrProps.transp;
-        if (undefined !== ovrProps.color)
-            props.color = ovrProps.color;
-        return new SubCategoryAppearance(props);
-    }
-    /** Convert this SubCategoryOverride to a JSON object
-     * @internal
-     */
-    toJSON() {
-        const props = {};
-        if (undefined !== this.invisible)
-            props.invisible = this.invisible;
-        if (undefined !== this.weight)
-            props.weight = this.weight;
-        if (undefined !== this.style)
-            props.style = this.style;
-        if (undefined !== this.material)
-            props.material = this.material;
-        if (undefined !== this.priority)
-            props.priority = this.priority;
-        if (undefined !== this.transparency)
-            props.transp = this.transparency;
-        if (undefined !== this.color)
-            props.color = this.color.toJSON();
-        return props;
-    }
-    /** Perform equality comparison against another SubCategoryOverride. */
-    equals(other) {
-        if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style
-            || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)
-            return false;
-        if (undefined !== this.color && undefined !== other.color)
-            return this.color.tbgr === other.color.tbgr;
-        else
-            return undefined === this.color && undefined === other.color;
-    }
-    /** Create a new SubCategoryOverride from a JSON object */
-    static fromJSON(json) {
-        return undefined !== json ? new SubCategoryOverride(json) : this.defaults;
-    }
-}
-/** A default SubCategoryOverride which overrides nothing. */
-SubCategoryOverride.defaults = new SubCategoryOverride({});
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { Id64, JsonUtils } from "@itwin/core-bentley";
+import { ColorDef } from "./ColorDef";
+import { SubCategoryAppearance } from "./SubCategoryAppearance";
+/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].
+ * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:
+ *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.
+ *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.
+ *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.
+ * An aspect is overridden by virtue of not being set to "undefined" in the SubCategoryOverride.
+ * @see [[DisplayStyleState.overrideSubCategory]]
+ * @public
+ */
+class SubCategoryOverride {
+    /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */
+    get anyOverridden() {
+        return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;
+    }
+    /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */
+    override(appearance) {
+        if (!this.anyOverridden)
+            return appearance;
+        const props = appearance.toJSON();
+        const ovrProps = this.toJSON();
+        if (undefined !== ovrProps.invisible)
+            props.invisible = ovrProps.invisible;
+        if (undefined !== ovrProps.weight)
+            props.weight = ovrProps.weight;
+        if (undefined !== ovrProps.style)
+            props.style = ovrProps.style;
+        if (undefined !== ovrProps.material)
+            props.material = ovrProps.material;
+        if (undefined !== ovrProps.priority)
+            props.priority = ovrProps.priority;
+        if (undefined !== ovrProps.transp)
+            props.transp = ovrProps.transp;
+        if (undefined !== ovrProps.color)
+            props.color = ovrProps.color;
+        return new SubCategoryAppearance(props);
+    }
+    /** Convert this SubCategoryOverride to a JSON object
+     * @internal
+     */
+    toJSON() {
+        const props = {};
+        if (undefined !== this.invisible)
+            props.invisible = this.invisible;
+        if (undefined !== this.weight)
+            props.weight = this.weight;
+        if (undefined !== this.style)
+            props.style = this.style;
+        if (undefined !== this.material)
+            props.material = this.material;
+        if (undefined !== this.priority)
+            props.priority = this.priority;
+        if (undefined !== this.transparency)
+            props.transp = this.transparency;
+        if (undefined !== this.color)
+            props.color = this.color.toJSON();
+        return props;
+    }
+    /** Perform equality comparison against another SubCategoryOverride. */
+    equals(other) {
+        if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style
+            || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)
+            return false;
+        if (undefined !== this.color && undefined !== other.color)
+            return this.color.tbgr === other.color.tbgr;
+        else
+            return undefined === this.color && undefined === other.color;
+    }
+    /** Create a new SubCategoryOverride from a JSON object */
+    static fromJSON(json) {
+        return undefined !== json ? new SubCategoryOverride(json) : this.defaults;
+    }
+    constructor(props) {
+        if (undefined !== props.invisible)
+            this.invisible = JsonUtils.asBool(props.invisible);
+        if (undefined !== props.color)
+            this.color = ColorDef.fromJSON(props.color);
+        if (undefined !== props.weight)
+            this.weight = JsonUtils.asInt(props.weight);
+        if (undefined !== props.style)
+            this.style = Id64.fromJSON(props.style);
+        if (undefined !== props.material)
+            this.material = Id64.fromJSON(props.material);
+        if (undefined !== props.priority)
+            this.priority = JsonUtils.asInt(props.priority);
+        if (undefined !== props.transp)
+            this.transparency = JsonUtils.asDouble(props.transp);
+    }
+}
+/** A default SubCategoryOverride which overrides nothing. */
+SubCategoryOverride.defaults = new SubCategoryOverride({});
+export { SubCategoryOverride };
 //# sourceMappingURL=SubCategoryOverride.js.map

package/lib/esm/SubCategoryOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"SubCategoryOverride.js","sourceRoot":"","sources":["../../src/SubCategoryOverride.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAmB;IA4F9B,YAAoB,KAAkC;QACpD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;YAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;IA3FD,yGAAyG;IACzG,IAAW,aAAa;QACtB,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC;IAC5N,CAAC;IAED,8GAA8G;IACvG,QAAQ,CAAC,UAAiC;QAC/C,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,OAAO,UAAU,CAAC;QAEpB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS;YAClC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAE/B,OAAO,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAgC,EAAE,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,KAA0B;QACtC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;eAC/F,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACnH,OAAO,KAAK,CAAC;QAEf,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YACvD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;;YAE5C,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC;IACjE,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAkC;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5E,CAAC;;AAmBD,6DAA6D;AAC/C,4BAAQ,GAAG,IAAI,mBAAmB,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 { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ColorDef } from \"./ColorDef\";\r\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\r\n\r\n/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].\r\n * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:\r\n *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.\r\n *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.\r\n *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.\r\n * An aspect is overridden by virtue of not being set to \"undefined\" in the SubCategoryOverride.\r\n * @see [[DisplayStyleState.overrideSubCategory]]\r\n * @public\r\n */\r\nexport class SubCategoryOverride {\r\n  /** See [[SubCategoryAppearance.color]] */\r\n  public readonly color?: ColorDef;\r\n  /** See [[SubCategoryAppearance.invisible]] */\r\n  public readonly invisible?: boolean;\r\n  /** See [[SubCategoryAppearance.weight]] */\r\n  public readonly weight?: number;\r\n  /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */\r\n  public readonly style?: Id64String;\r\n  /** See [[SubCategoryAppearance.priority]] */\r\n  public readonly priority?: number;\r\n  /** See [[SubCategoryAppearance.materialId]] */\r\n  public readonly material?: Id64String;\r\n  /** See [[SubCategoryAppearance.transparency]] */\r\n  public readonly transparency?: number;\r\n\r\n  /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */\r\n  public get anyOverridden(): boolean {\r\n    return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;\r\n  }\r\n\r\n  /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */\r\n  public override(appearance: SubCategoryAppearance): SubCategoryAppearance {\r\n    if (!this.anyOverridden)\r\n      return appearance;\r\n\r\n    const props = appearance.toJSON();\r\n    const ovrProps = this.toJSON();\r\n    if (undefined !== ovrProps.invisible)\r\n      props.invisible = ovrProps.invisible;\r\n    if (undefined !== ovrProps.weight)\r\n      props.weight = ovrProps.weight;\r\n    if (undefined !== ovrProps.style)\r\n      props.style = ovrProps.style;\r\n    if (undefined !== ovrProps.material)\r\n      props.material = ovrProps.material;\r\n    if (undefined !== ovrProps.priority)\r\n      props.priority = ovrProps.priority;\r\n    if (undefined !== ovrProps.transp)\r\n      props.transp = ovrProps.transp;\r\n    if (undefined !== ovrProps.color)\r\n      props.color = ovrProps.color;\r\n\r\n    return new SubCategoryAppearance(props);\r\n  }\r\n\r\n  /** Convert this SubCategoryOverride to a JSON object\r\n   * @internal\r\n   */\r\n  public toJSON(): SubCategoryAppearance.Props {\r\n    const props: SubCategoryAppearance.Props = {};\r\n    if (undefined !== this.invisible)\r\n      props.invisible = this.invisible;\r\n\r\n    if (undefined !== this.weight)\r\n      props.weight = this.weight;\r\n\r\n    if (undefined !== this.style)\r\n      props.style = this.style;\r\n\r\n    if (undefined !== this.material)\r\n      props.material = this.material;\r\n\r\n    if (undefined !== this.priority)\r\n      props.priority = this.priority;\r\n\r\n    if (undefined !== this.transparency)\r\n      props.transp = this.transparency;\r\n\r\n    if (undefined !== this.color)\r\n      props.color = this.color.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Perform equality comparison against another SubCategoryOverride. */\r\n  public equals(other: SubCategoryOverride): boolean {\r\n    if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style\r\n      || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)\r\n      return false;\r\n\r\n    if (undefined !== this.color && undefined !== other.color)\r\n      return this.color.tbgr === other.color.tbgr;\r\n    else\r\n      return undefined === this.color && undefined === other.color;\r\n  }\r\n\r\n  /** Create a new SubCategoryOverride from a JSON object */\r\n  public static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride {\r\n    return undefined !== json ? new SubCategoryOverride(json) : this.defaults;\r\n  }\r\n\r\n  private constructor(props: SubCategoryAppearance.Props) {\r\n    if (undefined !== props.invisible)\r\n      this.invisible = JsonUtils.asBool(props.invisible);\r\n    if (undefined !== props.color)\r\n      this.color = ColorDef.fromJSON(props.color);\r\n    if (undefined !== props.weight)\r\n      this.weight = JsonUtils.asInt(props.weight);\r\n    if (undefined !== props.style)\r\n      this.style = Id64.fromJSON(props.style);\r\n    if (undefined !== props.material)\r\n      this.material = Id64.fromJSON(props.material);\r\n    if (undefined !== props.priority)\r\n      this.priority = JsonUtils.asInt(props.priority);\r\n    if (undefined !== props.transp)\r\n      this.transparency = JsonUtils.asDouble(props.transp);\r\n  }\r\n\r\n  /** A default SubCategoryOverride which overrides nothing. */\r\n  public static defaults = new SubCategoryOverride({});\r\n}\r\n"]}
+{"version":3,"file":"SubCategoryOverride.js","sourceRoot":"","sources":["../../src/SubCategoryOverride.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;;GAQG;AACH,MAAa,mBAAmB;IAgB9B,yGAAyG;IACzG,IAAW,aAAa;QACtB,OAAO,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC;IAC5N,CAAC;IAED,8GAA8G;IACvG,QAAQ,CAAC,UAAiC;QAC/C,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,OAAO,UAAU,CAAC;QAEpB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,SAAS;YAClC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC/B,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACrC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM;YAC/B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACjC,IAAI,SAAS,KAAK,QAAQ,CAAC,KAAK;YAC9B,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAE/B,OAAO,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAgC,EAAE,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;QAEnC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAEpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,KAA0B;QACtC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;eAC/F,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACnH,OAAO,KAAK,CAAC;QAEf,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YACvD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;;YAE5C,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC;IACjE,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,QAAQ,CAAC,IAAkC;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5E,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;YAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,CAAC,QAAQ;YAC9B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;;AAED,6DAA6D;AAC/C,4BAAQ,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;SA9G1C,mBAAmB","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 { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport { ColorDef } from \"./ColorDef\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\n\n/** Overrides selected aspects of a [[SubCategoryAppearance]] in the context of a [[DisplayStyleState]].\n * When determining how geometry belonging to a [[SubCategory]] will appear when drawn within a view:\n *  1. The base [[SubCategoryAppearance]] associated with that subcategory is obtained.\n *  2. The [[SubCategoryOverride]] associated with that subcategory in the [[DisplayStyleState]] is obtained.\n *  3. Any aspects of the appearance overridden by the SubCategoryOverride are replaced with the values from the SubCategoryOverride.\n * An aspect is overridden by virtue of not being set to \"undefined\" in the SubCategoryOverride.\n * @see [[DisplayStyleState.overrideSubCategory]]\n * @public\n */\nexport class SubCategoryOverride {\n  /** See [[SubCategoryAppearance.color]] */\n  public readonly color?: ColorDef;\n  /** See [[SubCategoryAppearance.invisible]] */\n  public readonly invisible?: boolean;\n  /** See [[SubCategoryAppearance.weight]] */\n  public readonly weight?: number;\n  /** @internal Overriding with arbitrary custom line style is not supported - overriding with LinePixels enum could be. */\n  public readonly style?: Id64String;\n  /** See [[SubCategoryAppearance.priority]] */\n  public readonly priority?: number;\n  /** See [[SubCategoryAppearance.materialId]] */\n  public readonly material?: Id64String;\n  /** See [[SubCategoryAppearance.transparency]] */\n  public readonly transparency?: number;\n\n  /** Returns true if any aspect of the appearance is overridden (i.e., if any member is not undefined). */\n  public get anyOverridden(): boolean {\n    return undefined !== this.invisible || undefined !== this.color || undefined !== this.weight || undefined !== this.style || undefined !== this.priority || undefined !== this.material || undefined !== this.transparency;\n  }\n\n  /** Returns a SubCategoryAppearance overridden to match the properties defined by this SubCategoryOverride. */\n  public override(appearance: SubCategoryAppearance): SubCategoryAppearance {\n    if (!this.anyOverridden)\n      return appearance;\n\n    const props = appearance.toJSON();\n    const ovrProps = this.toJSON();\n    if (undefined !== ovrProps.invisible)\n      props.invisible = ovrProps.invisible;\n    if (undefined !== ovrProps.weight)\n      props.weight = ovrProps.weight;\n    if (undefined !== ovrProps.style)\n      props.style = ovrProps.style;\n    if (undefined !== ovrProps.material)\n      props.material = ovrProps.material;\n    if (undefined !== ovrProps.priority)\n      props.priority = ovrProps.priority;\n    if (undefined !== ovrProps.transp)\n      props.transp = ovrProps.transp;\n    if (undefined !== ovrProps.color)\n      props.color = ovrProps.color;\n\n    return new SubCategoryAppearance(props);\n  }\n\n  /** Convert this SubCategoryOverride to a JSON object\n   * @internal\n   */\n  public toJSON(): SubCategoryAppearance.Props {\n    const props: SubCategoryAppearance.Props = {};\n    if (undefined !== this.invisible)\n      props.invisible = this.invisible;\n\n    if (undefined !== this.weight)\n      props.weight = this.weight;\n\n    if (undefined !== this.style)\n      props.style = this.style;\n\n    if (undefined !== this.material)\n      props.material = this.material;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transp = this.transparency;\n\n    if (undefined !== this.color)\n      props.color = this.color.toJSON();\n\n    return props;\n  }\n\n  /** Perform equality comparison against another SubCategoryOverride. */\n  public equals(other: SubCategoryOverride): boolean {\n    if (this.invisible !== other.invisible || this.weight !== other.weight || this.style !== other.style\n      || this.priority !== other.priority || this.material !== other.material || this.transparency !== other.transparency)\n      return false;\n\n    if (undefined !== this.color && undefined !== other.color)\n      return this.color.tbgr === other.color.tbgr;\n    else\n      return undefined === this.color && undefined === other.color;\n  }\n\n  /** Create a new SubCategoryOverride from a JSON object */\n  public static fromJSON(json?: SubCategoryAppearance.Props): SubCategoryOverride {\n    return undefined !== json ? new SubCategoryOverride(json) : this.defaults;\n  }\n\n  private constructor(props: SubCategoryAppearance.Props) {\n    if (undefined !== props.invisible)\n      this.invisible = JsonUtils.asBool(props.invisible);\n    if (undefined !== props.color)\n      this.color = ColorDef.fromJSON(props.color);\n    if (undefined !== props.weight)\n      this.weight = JsonUtils.asInt(props.weight);\n    if (undefined !== props.style)\n      this.style = Id64.fromJSON(props.style);\n    if (undefined !== props.material)\n      this.material = Id64.fromJSON(props.material);\n    if (undefined !== props.priority)\n      this.priority = JsonUtils.asInt(props.priority);\n    if (undefined !== props.transp)\n      this.transparency = JsonUtils.asDouble(props.transp);\n  }\n\n  /** A default SubCategoryOverride which overrides nothing. */\n  public static defaults = new SubCategoryOverride({});\n}\n"]}

package/lib/esm/TerrainSettings.d.ts

@@ -1,83 +1,83 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { BackgroundMapProps } from "./BackgroundMapSettings";
-/** Identifies a [TerrainProvider]($frontend).
- * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].
- * @public
- * @extensions
- * @deprecated in 3.x. Use string instead.
- */
-export declare type TerrainProviderName = string;
-/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].
- * @see [[DisplayStyleSettingsProps]]
- * @see [[BackgroundMapProps]]
- * @public
- * @extensions
- */
-export interface TerrainProps {
-    /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.
-     * If omitted, it defaults to "CesiumWorldTerrain".
-     */
-    providerName?: string;
-    /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */
-    exaggeration?: number;
-    /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */
-    applyLighting?: boolean;
-    /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */
-    heightOrigin?: number;
-    /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */
-    heightOriginMode?: TerrainHeightOriginMode;
-    /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.
-     * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.
-     */
-    nonLocatable?: boolean;
-}
-/** Correction modes for terrain height
- * @see [[TerrainProps]]
- * @public
- * @extensions
- */
-export declare enum TerrainHeightOriginMode {
-    /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */
-    Geodetic = 0,
-    /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */
-    Geoid = 1,
-    /** Height value indicates the height of the IModel origin relative to ground level at project center. */
-    Ground = 2
-}
-/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.
- * @public
- */
-export declare class TerrainSettings {
-    private _nonLocatable;
-    /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.
-     * Defaults to "CesiumWorldTerrain".
-     */
-    readonly providerName: string;
-    /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */
-    readonly exaggeration: number;
-    /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */
-    readonly applyLighting: boolean;
-    /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */
-    readonly heightOrigin: number;
-    /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */
-    readonly heightOriginMode: TerrainHeightOriginMode;
-    /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.
-     * @see [[TerrainProps.nonLocatable]].
-     * @internal
-     */
-    get nonLocatable(): true | undefined;
-    constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);
-    static fromJSON(json?: TerrainProps): TerrainSettings;
-    toJSON(): TerrainProps;
-    equals(other: TerrainSettings): boolean;
-    /** Returns true if these settings are equivalent to the supplied JSON settings. */
-    equalsJSON(json?: BackgroundMapProps): boolean;
-    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps?: TerrainProps): TerrainSettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { BackgroundMapProps } from "./BackgroundMapSettings";
+/** Identifies a [TerrainProvider]($frontend).
+ * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].
+ * @public
+ * @extensions
+ * @deprecated in 3.x. Use string instead.
+ */
+export type TerrainProviderName = string;
+/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].
+ * @see [[DisplayStyleSettingsProps]]
+ * @see [[BackgroundMapProps]]
+ * @public
+ * @extensions
+ */
+export interface TerrainProps {
+    /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.
+     * If omitted, it defaults to "CesiumWorldTerrain".
+     */
+    providerName?: string;
+    /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */
+    exaggeration?: number;
+    /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */
+    applyLighting?: boolean;
+    /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */
+    heightOrigin?: number;
+    /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */
+    heightOriginMode?: TerrainHeightOriginMode;
+    /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.
+     * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.
+     */
+    nonLocatable?: boolean;
+}
+/** Correction modes for terrain height
+ * @see [[TerrainProps]]
+ * @public
+ * @extensions
+ */
+export declare enum TerrainHeightOriginMode {
+    /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */
+    Geodetic = 0,
+    /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */
+    Geoid = 1,
+    /** Height value indicates the height of the IModel origin relative to ground level at project center. */
+    Ground = 2
+}
+/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.
+ * @public
+ */
+export declare class TerrainSettings {
+    private _nonLocatable;
+    /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.
+     * Defaults to "CesiumWorldTerrain".
+     */
+    readonly providerName: string;
+    /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */
+    readonly exaggeration: number;
+    /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */
+    readonly applyLighting: boolean;
+    /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */
+    readonly heightOrigin: number;
+    /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */
+    readonly heightOriginMode: TerrainHeightOriginMode;
+    /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.
+     * @see [[TerrainProps.nonLocatable]].
+     * @internal
+     */
+    get nonLocatable(): true | undefined;
+    constructor(providerName?: string, exaggeration?: number, applyLighting?: boolean, heightOrigin?: number, heightOriginMode?: TerrainHeightOriginMode);
+    static fromJSON(json?: TerrainProps): TerrainSettings;
+    toJSON(): TerrainProps;
+    equals(other: TerrainSettings): boolean;
+    /** Returns true if these settings are equivalent to the supplied JSON settings. */
+    equalsJSON(json?: BackgroundMapProps): boolean;
+    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps?: TerrainProps): TerrainSettings;
+}
 //# sourceMappingURL=TerrainSettings.d.ts.map

package/lib/esm/TerrainSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainSettings.d.ts","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;GAKG;AACH,oBAAY,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8IAA8I;IAC9I,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0HAA0H;IAC1H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,sHAAsH;IACtH,QAAQ,IAAI;IACZ,0GAA0G;IAC1G,KAAK,IAAI;IACT,yGAAyG;IACzG,MAAM,IAAI;CACX;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmB;IACxC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,qIAAqI;IACrI,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,+FAA+F;IAC/F,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,yHAAyH;IACzH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,mGAAmG;IACnG,SAAgB,gBAAgB,EAAE,uBAAuB,CAAC;IAC1D;;;OAGG;IACH,IAAW,YAAY,IAAI,IAAI,GAAG,SAAS,CAE1C;gBAEW,YAAY,GAAE,MAA6B,EAAE,YAAY,GAAE,MAAY,EAAE,aAAa,UAAQ,EAAE,YAAY,SAAM,EAAE,gBAAgB,0BAAmC;WAgBrK,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;IAYnC,MAAM,IAAI,YAAY;IAgBtB,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAK9C,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe;CAe3D"}
+{"version":3,"file":"TerrainSettings.d.ts","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8IAA8I;IAC9I,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0HAA0H;IAC1H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mGAAmG;IACnG,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,sHAAsH;IACtH,QAAQ,IAAI;IACZ,0GAA0G;IAC1G,KAAK,IAAI;IACT,yGAAyG;IACzG,MAAM,IAAI;CACX;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmB;IACxC;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,qIAAqI;IACrI,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,+FAA+F;IAC/F,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,yHAAyH;IACzH,SAAgB,YAAY,EAAE,MAAM,CAAC;IACrC,mGAAmG;IACnG,SAAgB,gBAAgB,EAAE,uBAAuB,CAAC;IAC1D;;;OAGG;IACH,IAAW,YAAY,IAAI,IAAI,GAAG,SAAS,CAE1C;gBAEW,YAAY,GAAE,MAA6B,EAAE,YAAY,GAAE,MAAY,EAAE,aAAa,UAAQ,EAAE,YAAY,SAAM,EAAE,gBAAgB,0BAAmC;WAgBrK,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY;IAYnC,MAAM,IAAI,YAAY;IAgBtB,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAK9C,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe;CAe3D"}