@itwin/core-common 5.0.0-dev.99 → 5.0.0

package/CHANGELOG.md

@@ -1,6 +1,85 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Wed, 02 Apr 2025 19:38:36 GMT and should not be manually modified.
+This log was last generated on Fri, 13 Jun 2025 20:25:38 GMT and should not be manually modified.
+
+## 5.0.0
+Fri, 13 Jun 2025 20:25:38 GMT
+
+### Updates
+
+- Add new `properties` property to `ImageMapLayerSettings` class.
+- Deprecated the property extendType of QueryPropertyMetaData and added new property extendedType to QueryPropertyMetaData
+- removed getThumbnail api
+- Mark iModel edit API as @preview
+- Update ECSql reader api to support no stat and error code.
+- Adding support for margins to `TextBlock`
+- Resolves CVE-2025-27152
+- Depreciate ECSqlStatement API
+- add new imodel drapeTarget to ModelMapLayerProps
+- Add drapeTarget to ModelMapLayerProps (Reality data now a possible target)
+- FontMap.getFont now uses case insensitive matching for font names.
+- Upgrade compile target to ES2023 and module to ES2022
+- Removed `WipRpcInterface`
+- Deprecate `SnapshotIModelRpcInterface`
+- add CatalogIModelTypes
+- Add CesiumIonAssetId enum
+- Deprecated `MassPropertiesPerCandidateRequestProps` and `MassPropertiesPerCandidateResponseProps`
+- Deprecated `GeoCoordStatus.Pending`
+- Thinning iModelPlatform API
+- Revert BackendTypes to Public
+- Remove 3.x Deprecated APIs
+- Add support for tiles compressed with meshoptimizer
+- Adding Errors for Channels
+- Refactoring ITwin Error
+- Adding metadata for bentley error in IpcInvokeReturn
+- Updated IpcInvokeReturn to include error metadata
+- Add DrawingProps with scaleFactor.
+- Add new font APIs.
+- Remove deprecated IModelEncryptionProps
+- Removes re-exports from @itwin/core-bentley
+- Deprecate metadata types replaced by ecschema-metadata
+- Change core peer dependencies to strict version.
+
+## 4.11.5
+Fri, 06 Jun 2025 13:41:18 GMT
+
+_Version update only_
+
+## 4.11.4
+Tue, 03 Jun 2025 16:15:19 GMT
+
+_Version update only_
+
+## 4.11.3
+Wed, 28 May 2025 13:56:22 GMT
+
+_Version update only_
+
+## 4.11.2
+Tue, 20 May 2025 20:14:45 GMT
+
+_Version update only_
+
+## 4.11.1
+Wed, 30 Apr 2025 13:13:21 GMT
+
+_Version update only_
+
+## 4.11.0
+Wed, 16 Apr 2025 15:50:28 GMT
+
+### Updates
+
+- Deprecated the property extendType of QueryPropertyMetaData and added new property extendedType to QueryPropertyMetaData
+- Deprecate ECSqlStatement API
+- Update ECSql reader api to support no stat and error code.
+- Resolves CVE-2025-27152
+- Deprecated `MassPropertiesPerCandidateRequestProps` and `MassPropertiesPerCandidateResponseProps`
+
+## 4.10.13
+Thu, 10 Apr 2025 17:47:21 GMT
+
+_Version update only_
 
 ## 4.10.12
 Wed, 02 Apr 2025 19:35:47 GMT

package/lib/cjs/BackgroundMapSettings.d.ts

@@ -58,11 +58,11 @@ export interface BackgroundMapProps {
 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.
+     * @deprecated in 3.x - might be removed in next major version. 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
+     * @deprecated in 3.x - might be removed in next major version. use MapImageryProps.backgroundBase
      */
     providerData?: {
         /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */

package/lib/cjs/BackgroundMapSettings.js.map

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

package/lib/cjs/CatalogIModel.d.ts

@@ -0,0 +1,152 @@
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { Id64String, ITwinError } from "@itwin/core-bentley";
+import { LocalFileName } from "./ChangesetProps";
+import { IModelConnectionProps, SnapshotOpenOptions } from "./IModel";
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+export declare namespace CatalogError {
+    const scope = "itwin-Catalog";
+    type Key = "invalid-seed-catalog" | "manifest-missing";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error: unknown, key?: Key): error is ITwinError;
+    /** Instantiate and throw a CatalogError */
+    function throwError<T extends ITwinError>(key: Key, e: Omit<T, "name" | "iTwinErrorId">): never;
+}
+/** A "catalog iModel" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.
+ * They can be stored in [BlobContainer]($backend)s managed by a "reference data service" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.
+ * @see [CatalogDb]($backend) to interact with catalog iModels on the backend
+ * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.
+ * @beta
+ */
+export declare namespace CatalogIModel {
+    /** Metadata describing a catalog iModel.
+     * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.
+     * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.
+     * @beta
+     */
+    interface Manifest {
+        /** The iTwinId for the Catalog */
+        readonly iTwinId?: Id64String;
+        /**
+         * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough
+         * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in
+         * lists of catalogs.
+         * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).
+         */
+        readonly catalogName: string;
+        /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */
+        readonly description?: string;
+        /** The name of the person to contact with questions about this catalog */
+        readonly contactName?: string;
+        /** The name of the person who last modified this catalog. */
+        lastEditedBy?: string;
+    }
+    /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */
+    interface CreateNewContainerArgs {
+        /** supplies the iTwinId for the new container */
+        readonly iTwinId: Id64String;
+        /** metadata stored with the new container */
+        readonly metadata: {
+            /** a "name" for the Catalog container. Should be long enough to be unique, but this is not enforced. */
+            label: string;
+            /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
+            description?: string;
+            /** optional properties for the container */
+            json?: {
+                [key: string]: any;
+            };
+        };
+        /** The manifest to be stored in the catalog */
+        readonly manifest: Manifest;
+        /** The name for the CatalogIModel database within the container. May not contain a version. Default is "catalog-db" */
+        readonly dbName?: string;
+        /** version for the catalog created [[localCatalogFile]]. Defaults to "0.0.0" */
+        readonly version?: string;
+        /** A filename on the local computer of the "seed" CatalogIModel to be uploaded into the new container */
+        readonly localCatalogFile: LocalFileName;
+    }
+    /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */
+    interface NewContainerProps {
+        /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */
+        readonly containerId: string;
+        /** the uri of the BlobContainer service where the new container resides. */
+        readonly baseUri: string;
+        /** name of the blob storage provider. */
+        readonly provider: "azure" | "google";
+    }
+    /** Properties to identify a specific CatalogIModel within a container. */
+    interface NameAndVersion {
+        /** The name of the catalog database. Defaults to "catalog-db" for CatalogIModels stored in cloud containers. */
+        readonly dbName?: string;
+        /** The range of acceptable versions of the database of the specified [[dbName]].
+         * If not present, defaults to the newest available version.
+         */
+        readonly version?: VersionRange;
+    }
+    /** Arguments to open an existing version of a CatalogIModel. */
+    interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {
+        /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */
+        containerId?: string;
+        /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a
+         * container is accessed within a session, this is usually not necessary except for tests.
+         */
+        syncWithCloud?: boolean;
+        /** Start a prefetch operation on the CatalogIModel as it is opened. */
+        prefetch?: boolean;
+    }
+    /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */
+    interface CreateNewVersionArgs {
+        /** The id of cloud container. */
+        readonly containerId: string;
+        /** the source version of the CatalogIModel, from which the new version will copied. */
+        readonly fromDb: NameAndVersion;
+        /** The type of version increment to apply to the source version. */
+        readonly versionType: "major" | "minor" | "patch" | "premajor" | "preminor" | "prepatch" | "prerelease";
+        /** For prerelease versions, a string that becomes part of the version name. */
+        readonly identifier?: string;
+    }
+    /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,
+     * e.g., ">=1.2.7 <1.3.0".
+     */
+    type VersionRange = string;
+    /** The name of the ipc channel for [[IpcMethods]]
+     * @internal
+     */
+    type IpcChannel = "catalogIModel/ipc";
+    /** @internal */
+    interface IpcMethods {
+        /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */
+        createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;
+        /** Acquire the write lock for a CatalogIModel container. */
+        acquireWriteLock(args: {
+            containerId: string;
+            username: string;
+        }): Promise<void>;
+        /** Release the write lock for a CatalogIModel container. */
+        releaseWriteLock(args: {
+            containerId: string;
+            abandon?: true;
+        }): Promise<void>;
+        /** create a new version of a CatalogIModel from an existing version. */
+        createNewVersion(args: CreateNewVersionArgs): Promise<{
+            oldDb: NameAndVersion;
+            newDb: NameAndVersion;
+        }>;
+        /** Attempt to open a CatalogIModel readonly*/
+        openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Attempt to open a CatalogIModel for editing */
+        openEditable(args: OpenArgs): Promise<IModelConnectionProps>;
+        /** Get the manifest and version number for an open CatalogConnection. */
+        getInfo(key: string): Promise<{
+            manifest?: CatalogIModel.Manifest;
+            version: string;
+        }>;
+        /** Update the manifest stored in an open EditableCatalog */
+        updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;
+    }
+}
+//# sourceMappingURL=CatalogIModel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.d.ts","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEtE;;;GAGG;AACH,yBAAiB,YAAY,CAAC;IACrB,MAAM,KAAK,kBAAkB,CAAC;IAErC,KAAY,GAAG,GACb,sBAAsB,GACtB,kBAAkB,CAAC;IAErB,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;;;GAKG;AACH,yBAAiB,aAAa,CAAC;IAE7B;;;;OAIG;IACH,UAAiB,QAAQ;QACvB,kCAAkC;QAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;QAE9B;;;;;WAKG;QACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,0EAA0E;QAC1E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,6DAA6D;QAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,uGAAuG;IACvG,UAAiB,sBAAsB;QACrC,iDAAiD;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,6CAA6C;QAC7C,QAAQ,CAAC,QAAQ,EAAE;YACjB,wGAAwG;YACxG,KAAK,EAAE,MAAM,CAAC;YACd,kKAAkK;YAClK,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,4CAA4C;YAC5C,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAC;SAC/B,CAAA;QAED,+CAA+C;QAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC5B,uHAAuH;QACvH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,gFAAgF;QAChF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAC1B,yGAAyG;QACzG,QAAQ,CAAC,gBAAgB,EAAE,aAAa,CAAC;KAC1C;IAED,wKAAwK;IACxK,UAAiB,iBAAiB;QAChC,kKAAkK;QAClK,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,4EAA4E;QAC5E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,yCAAyC;QACzC,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;KACvC;IAED,0EAA0E;IAC1E,UAAiB,cAAc;QAC7B,gHAAgH;QAChH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;KACjC;IAED,gEAAgE;IAChE,UAAiB,QAAS,SAAQ,cAAc,EAAE,mBAAmB;QACnE,kHAAkH;QAClH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,uEAAuE;QACvE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,sHAAsH;IACtH,UAAiB,oBAAoB;QACnC,iCAAiC;QACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,uFAAuF;QACvF,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC,oEAAoE;QACpE,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QACxG,+EAA+E;QAC/E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;OAEG;IACH,KAAY,UAAU,GAAG,mBAAmB,CAAC;IAE7C,gBAAgB;IAChB,UAAiB,UAAU;QACzB,mHAAmH;QACnH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC7E,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACjF,4DAA4D;QAC5D,gBAAgB,CAAC,IAAI,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,IAAI,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,wEAAwE;QACxE,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC;YAAE,KAAK,EAAE,cAAc,CAAC;YAAC,KAAK,EAAE,cAAc,CAAA;SAAE,CAAC,CAAC;QACxG,8CAA8C;QAC9C,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,kDAAkD;QAClD,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC7D,yEAAyE;QACzE,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;YAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACtF,4DAA4D;QAC5D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACrF;CACF"}

package/lib/cjs/CatalogIModel.js

@@ -0,0 +1,30 @@
+"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 NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogError = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * Errors produced by the [[CatalogIModel]] API.
+ * @beta
+ */
+var CatalogError;
+(function (CatalogError) {
+    CatalogError.scope = "itwin-Catalog";
+    /** Determine whether an error object is a CatalogError */
+    function isError(error, key) {
+        return core_bentley_1.ITwinError.isError(error, CatalogError.scope, key);
+    }
+    CatalogError.isError = isError;
+    /** Instantiate and throw a CatalogError */
+    function throwError(key, e) {
+        core_bentley_1.ITwinError.throwError({ ...e, iTwinErrorId: { scope: CatalogError.scope, key } });
+    }
+    CatalogError.throwError = throwError;
+})(CatalogError || (exports.CatalogError = CatalogError = {}));
+//# sourceMappingURL=CatalogIModel.js.map

package/lib/cjs/CatalogIModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CatalogIModel.js","sourceRoot":"","sources":["../../src/CatalogIModel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAI7D;;;GAGG;AACH,IAAiB,YAAY,CAgB5B;AAhBD,WAAiB,YAAY;IACd,kBAAK,GAAG,eAAe,CAAC;IAMrC,0DAA0D;IAC1D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAa,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,oBAAO,UAEtB,CAAA;IAED,2CAA2C;IAC3C,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,uBAAU,aAEzB,CAAA;AACH,CAAC,EAhBgB,YAAY,4BAAZ,YAAY,QAgB5B","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 NativeApp\n */\n\nimport { Id64String, ITwinError } from \"@itwin/core-bentley\";\nimport { LocalFileName } from \"./ChangesetProps\";\nimport { IModelConnectionProps, SnapshotOpenOptions } from \"./IModel\";\n\n/**\n * Errors produced by the [[CatalogIModel]] API.\n * @beta\n */\nexport namespace CatalogError {\n  export const scope = \"itwin-Catalog\";\n\n  export type Key =\n    \"invalid-seed-catalog\" |\n    \"manifest-missing\";\n\n  /** Determine whether an error object is a CatalogError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CatalogError */\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** A \"catalog iModel\" is an [[IModel]] containing elements (e.g., component definitions) that are intended to be copied into another iModel by applications.\n * They can be stored in [BlobContainer]($backend)s managed by a \"reference data service\" that uses [semantic versioning](https://semver.org/), much like [WorkspaceDb]($backend)s.\n * @see [CatalogDb]($backend) to interact with catalog iModels on the backend\n * @see [CatalogConnection]($frontend) to interact with catalog iModels on the frontend.\n * @beta\n */\nexport namespace CatalogIModel {\n\n  /** Metadata describing a catalog iModel.\n   * @note Only the [[catalogName]] field is required, and users may add additional fields for their own purposes.\n   * @note The manifest is stored inside of the CatalogIModel, so it is versioned along with the rest of the catalog's contents.\n   * @beta\n   */\n  export interface Manifest {\n    /** The iTwinId for the Catalog */\n    readonly iTwinId?: Id64String;\n\n    /**\n     * The name of the Catalog to be shown in user interfaces. Organizations should attempt to make this name informative enough\n     * so that uses may refer to it in conversations. It should also be unique enough that there's no confusion when it appears in\n     * lists of catalogs.\n     * @note it is possible and valid to change the catalogName between versions of a CatalogIModel (e.g. incorporating a date).\n     */\n    readonly catalogName: string;\n    /** A description of the contents of this catalog to help users understand its purpose and appropriate usage. */\n    readonly description?: string;\n    /** The name of the person to contact with questions about this catalog */\n    readonly contactName?: string;\n    /** The name of the person who last modified this catalog. */\n    lastEditedBy?: string;\n  }\n\n  /** Arguments for creating a new [BlobContainer]($backend) that holds (versions of) a CatalogIModel. */\n  export interface CreateNewContainerArgs {\n    /** supplies the iTwinId for the new container */\n    readonly iTwinId: Id64String;\n    /** metadata stored with the new container */\n    readonly metadata: {\n      /** a \"name\" for the Catalog container. Should be long enough to be unique, but this is not enforced. */\n      label: string;\n      /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n      description?: string;\n      /** optional properties for the container */\n      json?: { [key: string]: any };\n    }\n\n    /** The manifest to be stored in the catalog */\n    readonly manifest: Manifest;\n    /** The name for the CatalogIModel database within the container. May not contain a version. Default is \"catalog-db\" */\n    readonly dbName?: string,\n    /** version for the catalog created [[localCatalogFile]]. Defaults to \"0.0.0\" */\n    readonly version?: string;\n    /** A filename on the local computer of the \"seed\" CatalogIModel to be uploaded into the new container */\n    readonly localCatalogFile: LocalFileName;\n  }\n\n  /** Properties of a newly created container created from [[CatalogIModel.CreateNewContainerArgs]]. Most importantly, this holds the ContainerId of the new container. */\n  export interface NewContainerProps {\n    /** The ContainerId of the new container (usually a [Guid]($bentley)). Applications should store this value to access the container via the CatalogIModel apis. */\n    readonly containerId: string;\n    /** the uri of the BlobContainer service where the new container resides. */\n    readonly baseUri: string;\n    /** name of the blob storage provider. */\n    readonly provider: \"azure\" | \"google\";\n  }\n\n  /** Properties to identify a specific CatalogIModel within a container. */\n  export interface NameAndVersion {\n    /** The name of the catalog database. Defaults to \"catalog-db\" for CatalogIModels stored in cloud containers. */\n    readonly dbName?: string;\n    /** The range of acceptable versions of the database of the specified [[dbName]].\n     * If not present, defaults to the newest available version.\n     */\n    readonly version?: VersionRange;\n  }\n\n  /** Arguments to open an existing version of a CatalogIModel. */\n  export interface OpenArgs extends NameAndVersion, SnapshotOpenOptions {\n    /** The ContainerId of the cloud container. If not present, dbName is the name of a file on the local computer. */\n    containerId?: string;\n    /** If true, attempt to synchronize the container with any changes in the cloud. Since this automatically happens the first time a\n     * container is accessed within a session, this is usually not necessary except for tests.\n     */\n    syncWithCloud?: boolean;\n    /** Start a prefetch operation on the CatalogIModel as it is opened. */\n    prefetch?: boolean;\n  }\n\n  /** Arguments to create a new version of a CatalogIModel from (a copy of) an existing version in a cloud container. */\n  export interface CreateNewVersionArgs {\n    /** The id of cloud container. */\n    readonly containerId: string;\n    /** the source version of the CatalogIModel, from which the new version will copied. */\n    readonly fromDb: NameAndVersion;\n    /** The type of version increment to apply to the source version. */\n    readonly versionType: \"major\" | \"minor\" | \"patch\" | \"premajor\" | \"preminor\" | \"prepatch\" | \"prerelease\";\n    /** For prerelease versions, a string that becomes part of the version name. */\n    readonly identifier?: string;\n  }\n\n  /** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[CatalogIModel]]s,\n   * e.g., \">=1.2.7 <1.3.0\".\n   */\n  export type VersionRange = string;\n\n  /** The name of the ipc channel for [[IpcMethods]]\n   * @internal\n   */\n  export type IpcChannel = \"catalogIModel/ipc\";\n\n  /** @internal */\n  export interface IpcMethods {\n    /** create a new container from the BlobContainerService for holding a CatalogIModel. Also uploads the seed file */\n    createNewContainer(args: CreateNewContainerArgs): Promise<NewContainerProps>;\n    /** Acquire the write lock for a CatalogIModel container. */\n    acquireWriteLock(args: { containerId: string, username: string }): Promise<void>;\n    /** Release the write lock for a CatalogIModel container. */\n    releaseWriteLock(args: { containerId: string, abandon?: true }): Promise<void>;\n    /** create a new version of a CatalogIModel from an existing version. */\n    createNewVersion(args: CreateNewVersionArgs): Promise<{ oldDb: NameAndVersion, newDb: NameAndVersion }>;\n    /** Attempt to open a CatalogIModel readonly*/\n    openReadonly(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Attempt to open a CatalogIModel for editing */\n    openEditable(args: OpenArgs): Promise<IModelConnectionProps>;\n    /** Get the manifest and version number for an open CatalogConnection. */\n    getInfo(key: string): Promise<{ manifest?: CatalogIModel.Manifest, version: string }>;\n    /** Update the manifest stored in an open EditableCatalog */\n    updateCatalogManifest(key: string, manifest: CatalogIModel.Manifest): Promise<void>;\n  }\n}\n"]}

package/lib/cjs/CesiumIonAssets.d.ts

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+export declare enum CesiumTerrainAssetId {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    Default = "1",
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    Bathymetry = "2426648"
+}
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+export declare enum CesiumIonAssetId {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    OSMBuildings = "96188"
+}
+//# sourceMappingURL=CesiumIonAssets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.d.ts","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,yGAAyG;IACzG,OAAO,MAAM;IACb,gJAAgJ;IAChJ,UAAU,YAAY;CACvB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,oGAAoG;IACpG,YAAY,UAAU;CACvB"}

package/lib/cjs/CesiumIonAssets.js

@@ -0,0 +1,32 @@
+"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.CesiumIonAssetId = exports.CesiumTerrainAssetId = void 0;
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.
+ * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to "CesiumWorldTerrain".
+ * You may alternatively use the Id of any ion asset to which you have access.
+ * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.
+ * @public
+ */
+var CesiumTerrainAssetId;
+(function (CesiumTerrainAssetId) {
+    /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */
+    CesiumTerrainAssetId["Default"] = "1";
+    /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */
+    CesiumTerrainAssetId["Bathymetry"] = "2426648";
+})(CesiumTerrainAssetId || (exports.CesiumTerrainAssetId = CesiumTerrainAssetId = {}));
+/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].
+ * @beta
+ */
+var CesiumIonAssetId;
+(function (CesiumIonAssetId) {
+    /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */
+    CesiumIonAssetId["OSMBuildings"] = "96188";
+})(CesiumIonAssetId || (exports.CesiumIonAssetId = CesiumIonAssetId = {}));
+//# sourceMappingURL=CesiumIonAssets.js.map

package/lib/cjs/CesiumIonAssets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CesiumIonAssets.js","sourceRoot":"","sources":["../../src/CesiumIonAssets.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;GAKG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,yGAAyG;IACzG,qCAAa,CAAA;IACb,gJAAgJ;IAChJ,8CAAsB,CAAA;AACxB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,oGAAoG;IACpG,0CAAsB,CAAA;AACxB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing global terrain data.\n * These values are appropriate to use with [[TerrainSettings.dataSource]] when [[TerrainSettings.providerName]] is set to \"CesiumWorldTerrain\".\n * You may alternatively use the Id of any ion asset to which you have access.\n * @see [[TerrainSettings.fromCesiumIonAsset]] to create TerrainSettings that obtain terrain from a specified ion asset.\n * @public\n */\nexport enum CesiumTerrainAssetId {\n  /** Default [global 3d terrain](https://cesium.com/platform/cesium-ion/content/cesium-world-terrain/). */\n  Default = \"1\",\n  /** Global 3d terrain that includes [bathymetry](https://cesium.com/platform/cesium-ion/content/cesium-world-bathymetry/) (seafloor) terrain. */\n  Bathymetry = \"2426648\",\n}\n\n/** Ids of [Cesium ion assets](https://cesium.com/platform/cesium-ion/content/) providing data not covered by [[CesiumTerrainAssetId]].\n * @beta\n */\nexport enum CesiumIonAssetId {\n  /** [Cesium OSM Buildings](https://cesium.com/platform/cesium-ion/content/cesium-osm-buildings/). */\n  OSMBuildings = \"96188\",\n}\n"]}

package/lib/cjs/ClipStyle.d.ts

@@ -139,7 +139,7 @@ export declare class ClipStyle {
     /** The default style, which overrides none of the view's settings. */
     static readonly defaults: ClipStyle;
     private constructor();
-    /** @deprecated in 4.x. Use [[create(style: ClipStyleCreateArgs]] */
+    /** @deprecated in 4.x - will not be removed until after 2026-06-13. Use [[create(style: ClipStyleCreateArgs]] */
     static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;
     /** Create a style from its components. */
     static create(style: ClipStyleCreateArgs): ClipStyle;

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

@@ -1 +1 @@
-{"version":3,"file":"ClipStyle.d.ts","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG/E;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,+FAA+F;IAC/F,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,8FAA8F;IAC9F,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;IACtC,qEAAqE;IACrE,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACnB,oGAAoG;IACpG,SAAgB,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACvD,sGAAsG;IACtG,SAAgB,UAAU,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;IACjD,kFAAkF;IAClF,SAAgB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/C,sHAAsH;IACtH,gBAAuB,QAAQ,WAAkB;IAEjD,OAAO;IASP,6CAA6C;WAC/B,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,iBAAiB,GAAG,QAAQ;WAO3H,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ;IAYvD,6GAA6G;IACtG,MAAM,IAAI,aAAa,GAAG,SAAS;IAiB1C,gHAAgH;IAChH,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,gFAAgF;IAChF,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,+EAA+E;IAC/E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,gFAAgF;IAChF,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,+EAA+E;IAC/E,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAIP,+CAA+C;WACjC,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,qBAAqB;IAO7E,gBAAuB,QAAQ,wBAA+B;WAEhD,QAAQ,CAAC,KAAK,CAAC,EAAE,0BAA0B,GAAG,qBAAqB;IAUjF,mGAAmG;IAC5F,MAAM,IAAI,0BAA0B,GAAG,SAAS;IAgBvD,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,kGAAkG;IAClG,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,4GAA4G;IAC5G,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,kGAAkG;IAClG,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,4GAA4G;IAC5G,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,0BAA0B,CAAC;CAChD;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,OAAO,CAAC;IAC5C,4EAA4E;IAC5E,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAC9C,kGAAkG;IAClG,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,+EAA+E;IAC/E,SAAgB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvC,4GAA4G;IAC5G,SAAgB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxC,yEAAyE;IACzE,SAAgB,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAE1D,sEAAsE;IACtE,gBAAuB,QAAQ,YAAmF;IAElH,OAAO;IASP,oEAAoE;WACtD,MAAM,CAAC,kBAAkB,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS;IAEjI,0CAA0C;WAC5B,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS;WA0B7C,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS;IAezD,mGAAmG;IAC5F,MAAM,IAAI,cAAc,GAAG,SAAS;IA6B3C,uHAAuH;IACvH,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF"}
+{"version":3,"file":"ClipStyle.d.ts","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG/E;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,+FAA+F;IAC/F,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,8FAA8F;IAC9F,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;IACtC,qEAAqE;IACrE,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACnB,oGAAoG;IACpG,SAAgB,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACvD,sGAAsG;IACtG,SAAgB,UAAU,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;IACjD,kFAAkF;IAClF,SAAgB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/C,sHAAsH;IACtH,gBAAuB,QAAQ,WAAkB;IAEjD,OAAO;IASP,6CAA6C;WAC/B,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,iBAAiB,GAAG,QAAQ;WAO3H,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,GAAG,QAAQ;IAYvD,6GAA6G;IACtG,MAAM,IAAI,aAAa,GAAG,SAAS;IAiB1C,gHAAgH;IAChH,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,gFAAgF;IAChF,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,+EAA+E;IAC/E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,gFAAgF;IAChF,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,+EAA+E;IAC/E,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B,OAAO;IAIP,+CAA+C;WACjC,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,qBAAqB;IAO7E,gBAAuB,QAAQ,wBAA+B;WAEhD,QAAQ,CAAC,KAAK,CAAC,EAAE,0BAA0B,GAAG,qBAAqB;IAUjF,mGAAmG;IAC5F,MAAM,IAAI,0BAA0B,GAAG,SAAS;IAgBvD,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,kGAAkG;IAClG,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,4GAA4G;IAC5G,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,kGAAkG;IAClG,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,4GAA4G;IAC5G,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,0BAA0B,CAAC;CAChD;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,OAAO,CAAC;IAC5C,4EAA4E;IAC5E,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAC9C,kGAAkG;IAClG,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,+EAA+E;IAC/E,SAAgB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvC,4GAA4G;IAC5G,SAAgB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxC,yEAAyE;IACzE,SAAgB,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAE1D,sEAAsE;IACtE,gBAAuB,QAAQ,YAAmF;IAElH,OAAO;IASP,iHAAiH;WACnG,MAAM,CAAC,kBAAkB,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS;IAEjI,0CAA0C;WAC5B,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS;WA0B7C,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS;IAezD,mGAAmG;IAC5F,MAAM,IAAI,cAAc,GAAG,SAAS;IA6B3C,uHAAuH;IACvH,IAAW,eAAe,IAAI,OAAO,CAKpC;CACF"}

package/lib/cjs/ClipStyle.js.map

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