@itwin/core-common 4.0.0-dev.17 → 4.0.0-dev.18

package/lib/esm/BackgroundMapSettings.d.ts

@@ -1,137 +1,137 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { BackgroundMapType } from "./BackgroundMapProvider";
-import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
-import { TerrainProps, TerrainSettings } from "./TerrainSettings";
-/** Describes the projection of the background map
- * @see [[BackgroundMapProps]]
- * @see [[DisplayStyleSettingsProps]]
- * @public
- * @extensions
- */
-export declare enum GlobeMode {
-    /** Display Earth as 3d ellipsoid */
-    Ellipsoid = 0,
-    /** Display Earth as plane. */
-    Plane = 1
-}
-/** In-memory JSON representation of a [[BackgroundMapSettings]].
- * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.
- * @public
- * @extensions
- */
-export interface BackgroundMapProps {
-    /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */
-    groundBias?: number;
-    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.
-     * Default value: false.
-     */
-    transparency?: number | false;
-    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
-    useDepthBuffer?: boolean;
-    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
-    applyTerrain?: boolean;
-    /** Properties associated with terrain display. */
-    terrainSettings?: TerrainProps;
-    /** Globe Mode. Default value: GlobeMode.Ellipsoid */
-    globeMode?: GlobeMode;
-    /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
-     * allows the user to select elements that are behind the map.
-     */
-    nonLocatable?: boolean;
-    /** A planar mask applied to the map geometry
-     * @beta
-     */
-    planarClipMask?: PlanarClipMaskProps;
-    /** See [[DeprecatedBackgroundMapProps.providerName]]. */
-    providerName?: never;
-    /** See [[DeprecatedBackgroundMapProps.providerData]]. */
-    providerData?: never;
-}
-/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.
- * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in
- * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.
- * @public
- * @extensions
- */
-export interface DeprecatedBackgroundMapProps {
-    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
-     * Default value: "BingProvider"
-     * @deprecated in 3.x. use MapImageryProps.backgroundBase.
-     */
-    providerName?: string;
-    /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
-     * @deprecated in 3.x. use MapImageryProps.backgroundBase
-     */
-    providerData?: {
-        /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */
-        mapType?: BackgroundMapType;
-    };
-}
-/** Persistent JSON representation of a [[BackgroundMapSettings]].
- * @public
- * @extensions
- */
-export declare type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;
-/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
- * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
- * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
- * @public
- */
-export declare class BackgroundMapSettings {
-    /** Retained strictly for persistence. */
-    private readonly _provider;
-    /** Elevation in meters, relative to WGS84 Ellipsoid.. */
-    readonly groundBias: number;
-    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
-    readonly transparency: number | false;
-    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
-    readonly useDepthBuffer: boolean;
-    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
-    readonly applyTerrain: boolean;
-    /** Settings associated with terrain display. */
-    readonly terrainSettings: TerrainSettings;
-    /** Globe display mode. */
-    readonly globeMode: GlobeMode;
-    /** Planar Mask - used to mask the background map to avoid overlapping with other geometry
-     * @beta
-     */
-    readonly planarClipMask: PlanarClipMaskSettings;
-    private readonly _locatable;
-    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
-     * allows the user to select elements that are behind the map.
-     */
-    get locatable(): boolean;
-    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
-    get transparencyOverride(): number | undefined;
-    private constructor();
-    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
-     * the iModel - otherwise, prefer [[fromJSON]].
-     */
-    static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings;
-    /** Construct from JSON, performing validation and applying default values for undefined fields.
-     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
-     */
-    static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings;
-    /** Convert these settings to their in-memory JSON representation.
-     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
-     */
-    toJSON(): BackgroundMapProps;
-    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
-     * the iModel - otherwise, prefer [[toJSON]].
-     */
-    toPersistentJSON(): PersistentBackgroundMapProps;
-    /** Returns true if these settings are equivalent to the supplied JSON settings. */
-    equalsJSON(json?: BackgroundMapProps): boolean;
-    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
-    equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean;
-    /** Returns true if these settings are equivalent to `other`. */
-    equals(other: BackgroundMapSettings): boolean;
-    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps?: BackgroundMapProps): BackgroundMapSettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { BackgroundMapType } from "./BackgroundMapProvider";
+import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
+import { TerrainProps, TerrainSettings } from "./TerrainSettings";
+/** Describes the projection of the background map
+ * @see [[BackgroundMapProps]]
+ * @see [[DisplayStyleSettingsProps]]
+ * @public
+ * @extensions
+ */
+export declare enum GlobeMode {
+    /** Display Earth as 3d ellipsoid */
+    Ellipsoid = 0,
+    /** Display Earth as plane. */
+    Plane = 1
+}
+/** In-memory JSON representation of a [[BackgroundMapSettings]].
+ * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.
+ * @public
+ * @extensions
+ */
+export interface BackgroundMapProps {
+    /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */
+    groundBias?: number;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.
+     * Default value: false.
+     */
+    transparency?: number | false;
+    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
+    useDepthBuffer?: boolean;
+    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
+    applyTerrain?: boolean;
+    /** Properties associated with terrain display. */
+    terrainSettings?: TerrainProps;
+    /** Globe Mode. Default value: GlobeMode.Ellipsoid */
+    globeMode?: GlobeMode;
+    /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
+     * allows the user to select elements that are behind the map.
+     */
+    nonLocatable?: boolean;
+    /** A planar mask applied to the map geometry
+     * @beta
+     */
+    planarClipMask?: PlanarClipMaskProps;
+    /** See [[DeprecatedBackgroundMapProps.providerName]]. */
+    providerName?: never;
+    /** See [[DeprecatedBackgroundMapProps.providerData]]. */
+    providerData?: never;
+}
+/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.
+ * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in
+ * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.
+ * @public
+ * @extensions
+ */
+export interface DeprecatedBackgroundMapProps {
+    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
+     * Default value: "BingProvider"
+     * @deprecated in 3.x. use MapImageryProps.backgroundBase.
+     */
+    providerName?: string;
+    /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
+     * @deprecated in 3.x. use MapImageryProps.backgroundBase
+     */
+    providerData?: {
+        /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */
+        mapType?: BackgroundMapType;
+    };
+}
+/** Persistent JSON representation of a [[BackgroundMapSettings]].
+ * @public
+ * @extensions
+ */
+export declare type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;
+/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
+ * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
+ * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
+ * @public
+ */
+export declare class BackgroundMapSettings {
+    /** Retained strictly for persistence. */
+    private readonly _provider;
+    /** Elevation in meters, relative to WGS84 Ellipsoid.. */
+    readonly groundBias: number;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
+    readonly transparency: number | false;
+    /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */
+    readonly useDepthBuffer: boolean;
+    /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
+    readonly applyTerrain: boolean;
+    /** Settings associated with terrain display. */
+    readonly terrainSettings: TerrainSettings;
+    /** Globe display mode. */
+    readonly globeMode: GlobeMode;
+    /** Planar Mask - used to mask the background map to avoid overlapping with other geometry
+     * @beta
+     */
+    readonly planarClipMask: PlanarClipMaskSettings;
+    private readonly _locatable;
+    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
+     * allows the user to select elements that are behind the map.
+     */
+    get locatable(): boolean;
+    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
+    get transparencyOverride(): number | undefined;
+    private constructor();
+    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
+     * the iModel - otherwise, prefer [[fromJSON]].
+     */
+    static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings;
+    /** Construct from JSON, performing validation and applying default values for undefined fields.
+     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
+     */
+    static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings;
+    /** Convert these settings to their in-memory JSON representation.
+     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
+     */
+    toJSON(): BackgroundMapProps;
+    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
+     * the iModel - otherwise, prefer [[toJSON]].
+     */
+    toPersistentJSON(): PersistentBackgroundMapProps;
+    /** Returns true if these settings are equivalent to the supplied JSON settings. */
+    equalsJSON(json?: BackgroundMapProps): boolean;
+    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
+    equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean;
+    /** Returns true if these settings are equivalent to `other`. */
+    equals(other: BackgroundMapSettings): boolean;
+    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps?: BackgroundMapProps): BackgroundMapSettings;
+}
 //# sourceMappingURL=BackgroundMapSettings.d.ts.map

package/lib/esm/BackgroundMapSettings.js

@@ -1,153 +1,153 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { BackgroundMapProvider, BackgroundMapType } from "./BackgroundMapProvider";
-import { PlanarClipMaskSettings } from "./PlanarClipMask";
-import { TerrainSettings } from "./TerrainSettings";
-/** Describes the projection of the background map
- * @see [[BackgroundMapProps]]
- * @see [[DisplayStyleSettingsProps]]
- * @public
- * @extensions
- */
-export var GlobeMode;
-(function (GlobeMode) {
-    /** Display Earth as 3d ellipsoid */
-    GlobeMode[GlobeMode["Ellipsoid"] = 0] = "Ellipsoid";
-    /** Display Earth as plane. */
-    GlobeMode[GlobeMode["Plane"] = 1] = "Plane";
-})(GlobeMode || (GlobeMode = {}));
-function normalizeGlobeMode(mode) {
-    return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;
-}
-function normalizeTransparency(trans) {
-    if ("number" === typeof trans)
-        return Math.min(1, Math.max(0, trans));
-    return false;
-}
-/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
- * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
- * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
- * @public
- */
-export class BackgroundMapSettings {
-    constructor(props) {
-        var _a, _b, _c;
-        this.groundBias = (_a = props.groundBias) !== null && _a !== void 0 ? _a : 0;
-        this.transparency = normalizeTransparency(props.transparency);
-        this.useDepthBuffer = (_b = props.useDepthBuffer) !== null && _b !== void 0 ? _b : false;
-        this.applyTerrain = (_c = props.applyTerrain) !== null && _c !== void 0 ? _c : false;
-        this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);
-        this.globeMode = normalizeGlobeMode(props.globeMode);
-        this._locatable = true !== props.nonLocatable;
-        this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);
-        this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);
-    }
-    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
-     * allows the user to select elements that are behind the map.
-     */
-    get locatable() {
-        // Handle legacy TerrainProps.nonLocatable:
-        // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.
-        // - Otherwise, use BackgroundMapProps.nonLocatable.
-        if (this.applyTerrain && this.terrainSettings.nonLocatable)
-            return false;
-        return this._locatable;
-    }
-    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
-    get transparencyOverride() { return false !== this.transparency ? this.transparency : undefined; }
-    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
-     * the iModel - otherwise, prefer [[fromJSON]].
-     */
-    static fromPersistentJSON(json) {
-        return new this(json !== null && json !== void 0 ? json : {});
-    }
-    /** Construct from JSON, performing validation and applying default values for undefined fields.
-     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
-     */
-    static fromJSON(json) {
-        return new BackgroundMapSettings(json !== null && json !== void 0 ? json : {});
-    }
-    /** Convert these settings to their in-memory JSON representation.
-     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
-     */
-    toJSON() {
-        const props = {};
-        if (0 !== this.groundBias)
-            props.groundBias = this.groundBias;
-        if (this.applyTerrain)
-            props.applyTerrain = true;
-        if (false !== this.transparency)
-            props.transparency = this.transparency;
-        if (GlobeMode.Ellipsoid !== this.globeMode)
-            props.globeMode = this.globeMode;
-        if (this.useDepthBuffer)
-            props.useDepthBuffer = true;
-        if (!this._locatable)
-            props.nonLocatable = true;
-        const terrainSettings = this.terrainSettings.toJSON();
-        for (const prop of Object.values(terrainSettings)) {
-            if (undefined !== prop) {
-                props.terrainSettings = terrainSettings;
-                break;
-            }
-        }
-        if (this.planarClipMask.isValid)
-            props.planarClipMask = this.planarClipMask.toJSON();
-        return props;
-    }
-    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
-     * the iModel - otherwise, prefer [[toJSON]].
-     */
-    toPersistentJSON() {
-        const props = this.toJSON();
-        // Preserve deprecated imagery provider properties.
-        if ("BingProvider" !== this._provider.name)
-            props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation
-        if (BackgroundMapType.Hybrid !== this._provider.type)
-            props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation
-        return props;
-    }
-    /** Returns true if these settings are equivalent to the supplied JSON settings. */
-    equalsJSON(json) {
-        return this.equals(BackgroundMapSettings.fromJSON(json));
-    }
-    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
-    equalsPersistentJSON(json) {
-        return this.equals(BackgroundMapSettings.fromPersistentJSON(json));
-    }
-    /** Returns true if these settings are equivalent to `other`. */
-    equals(other) {
-        return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency
-            && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain
-            && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)
-            && this._provider.name === other._provider.name && this._provider.type === other._provider.type;
-    }
-    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps) {
-        var _a, _b, _c, _d, _e, _f;
-        if (undefined === changedProps)
-            return this;
-        const props = {
-            groundBias: (_a = changedProps.groundBias) !== null && _a !== void 0 ? _a : this.groundBias,
-            transparency: (_b = changedProps.transparency) !== null && _b !== void 0 ? _b : this.transparency,
-            useDepthBuffer: (_c = changedProps.useDepthBuffer) !== null && _c !== void 0 ? _c : this.useDepthBuffer,
-            globeMode: (_d = changedProps.globeMode) !== null && _d !== void 0 ? _d : this.globeMode,
-            nonLocatable: (_e = changedProps.nonLocatable) !== null && _e !== void 0 ? _e : !this._locatable,
-            applyTerrain: (_f = changedProps.applyTerrain) !== null && _f !== void 0 ? _f : this.applyTerrain,
-            terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),
-            planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),
-            providerName: this._provider.name,
-            providerData: { mapType: this._provider.type },
-        };
-        return BackgroundMapSettings.fromPersistentJSON(props);
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { BackgroundMapProvider, BackgroundMapType } from "./BackgroundMapProvider";
+import { PlanarClipMaskSettings } from "./PlanarClipMask";
+import { TerrainSettings } from "./TerrainSettings";
+/** Describes the projection of the background map
+ * @see [[BackgroundMapProps]]
+ * @see [[DisplayStyleSettingsProps]]
+ * @public
+ * @extensions
+ */
+export var GlobeMode;
+(function (GlobeMode) {
+    /** Display Earth as 3d ellipsoid */
+    GlobeMode[GlobeMode["Ellipsoid"] = 0] = "Ellipsoid";
+    /** Display Earth as plane. */
+    GlobeMode[GlobeMode["Plane"] = 1] = "Plane";
+})(GlobeMode || (GlobeMode = {}));
+function normalizeGlobeMode(mode) {
+    return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;
+}
+function normalizeTransparency(trans) {
+    if ("number" === typeof trans)
+        return Math.min(1, Math.max(0, trans));
+    return false;
+}
+/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.
+ * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.
+ * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.
+ * @public
+ */
+export class BackgroundMapSettings {
+    constructor(props) {
+        var _a, _b, _c;
+        this.groundBias = (_a = props.groundBias) !== null && _a !== void 0 ? _a : 0;
+        this.transparency = normalizeTransparency(props.transparency);
+        this.useDepthBuffer = (_b = props.useDepthBuffer) !== null && _b !== void 0 ? _b : false;
+        this.applyTerrain = (_c = props.applyTerrain) !== null && _c !== void 0 ? _c : false;
+        this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);
+        this.globeMode = normalizeGlobeMode(props.globeMode);
+        this._locatable = true !== props.nonLocatable;
+        this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);
+        this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);
+    }
+    /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it
+     * allows the user to select elements that are behind the map.
+     */
+    get locatable() {
+        // Handle legacy TerrainProps.nonLocatable:
+        // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.
+        // - Otherwise, use BackgroundMapProps.nonLocatable.
+        if (this.applyTerrain && this.terrainSettings.nonLocatable)
+            return false;
+        return this._locatable;
+    }
+    /** If transparency is overridden, the transparency to apply; otherwise, undefined. */
+    get transparencyOverride() { return false !== this.transparency ? this.transparency : undefined; }
+    /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from
+     * the iModel - otherwise, prefer [[fromJSON]].
+     */
+    static fromPersistentJSON(json) {
+        return new this(json !== null && json !== void 0 ? json : {});
+    }
+    /** Construct from JSON, performing validation and applying default values for undefined fields.
+     * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
+     */
+    static fromJSON(json) {
+        return new BackgroundMapSettings(json !== null && json !== void 0 ? json : {});
+    }
+    /** Convert these settings to their in-memory JSON representation.
+     * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
+     */
+    toJSON() {
+        const props = {};
+        if (0 !== this.groundBias)
+            props.groundBias = this.groundBias;
+        if (this.applyTerrain)
+            props.applyTerrain = true;
+        if (false !== this.transparency)
+            props.transparency = this.transparency;
+        if (GlobeMode.Ellipsoid !== this.globeMode)
+            props.globeMode = this.globeMode;
+        if (this.useDepthBuffer)
+            props.useDepthBuffer = true;
+        if (!this._locatable)
+            props.nonLocatable = true;
+        const terrainSettings = this.terrainSettings.toJSON();
+        for (const prop of Object.values(terrainSettings)) {
+            if (undefined !== prop) {
+                props.terrainSettings = terrainSettings;
+                break;
+            }
+        }
+        if (this.planarClipMask.isValid)
+            props.planarClipMask = this.planarClipMask.toJSON();
+        return props;
+    }
+    /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to
+     * the iModel - otherwise, prefer [[toJSON]].
+     */
+    toPersistentJSON() {
+        const props = this.toJSON();
+        // Preserve deprecated imagery provider properties.
+        if ("BingProvider" !== this._provider.name)
+            props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation
+        if (BackgroundMapType.Hybrid !== this._provider.type)
+            props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation
+        return props;
+    }
+    /** Returns true if these settings are equivalent to the supplied JSON settings. */
+    equalsJSON(json) {
+        return this.equals(BackgroundMapSettings.fromJSON(json));
+    }
+    /** Returns true if the persistent representation of these settings is equivalent to `json`. */
+    equalsPersistentJSON(json) {
+        return this.equals(BackgroundMapSettings.fromPersistentJSON(json));
+    }
+    /** Returns true if these settings are equivalent to `other`. */
+    equals(other) {
+        return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency
+            && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain
+            && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)
+            && this._provider.name === other._provider.name && this._provider.type === other._provider.type;
+    }
+    /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps) {
+        var _a, _b, _c, _d, _e, _f;
+        if (undefined === changedProps)
+            return this;
+        const props = {
+            groundBias: (_a = changedProps.groundBias) !== null && _a !== void 0 ? _a : this.groundBias,
+            transparency: (_b = changedProps.transparency) !== null && _b !== void 0 ? _b : this.transparency,
+            useDepthBuffer: (_c = changedProps.useDepthBuffer) !== null && _c !== void 0 ? _c : this.useDepthBuffer,
+            globeMode: (_d = changedProps.globeMode) !== null && _d !== void 0 ? _d : this.globeMode,
+            nonLocatable: (_e = changedProps.nonLocatable) !== null && _e !== void 0 ? _e : !this._locatable,
+            applyTerrain: (_f = changedProps.applyTerrain) !== null && _f !== void 0 ? _f : this.applyTerrain,
+            terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),
+            planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),
+            providerName: this._provider.name,
+            providerData: { mapType: this._provider.type },
+        };
+        return BackgroundMapSettings.fromPersistentJSON(props);
+    }
+}
 //# sourceMappingURL=BackgroundMapSettings.js.map