@itwin/core-common 4.6.0-dev.22 → 4.6.0-dev.23

package/lib/esm/Localization.js.map

@@ -1 +1 @@
-{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA6GH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB;QAC9C,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YAC7B,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;SACd;QACD,sEAAsE;QACtE,iEAAiE;QACjE,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAG,CAAC;IAClC,CAAC;IACM,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\nexport interface TranslationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   * @deprecated in 3.x. Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\r\n   * including `{ ns: <namespace> }` in the options.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param namespace - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n\r\n  /** Unregister a namespace.\r\n   * @param namespace - the name of the namespace.\r\n   */\r\n  unregisterNamespace(namespace: string): void;\r\n\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n\r\n  /** Change the language for translations. This overrides the language from the browser, for tests.\r\n   * @param language - the language to change to.\r\n   */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string {\r\n    if (typeof (key) !== \"string\") {\r\n      key = key[0];\r\n    }\r\n    // Simulate correct and simple usage of i18next's translation function\r\n    // Namely, remove the leading namespace substring if there is one\r\n    return key.split(\":\", 2).pop()!;\r\n  }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}
+{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA6GH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB;QAC9C,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC9B,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACf,CAAC;QACD,sEAAsE;QACtE,iEAAiE;QACjE,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAG,CAAC;IAClC,CAAC;IACM,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\nexport interface TranslationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   * @deprecated in 3.x. Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\r\n   * including `{ ns: <namespace> }` in the options.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param namespace - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n\r\n  /** Unregister a namespace.\r\n   * @param namespace - the name of the namespace.\r\n   */\r\n  unregisterNamespace(namespace: string): void;\r\n\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n\r\n  /** Change the language for translations. This overrides the language from the browser, for tests.\r\n   * @param language - the language to change to.\r\n   */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string {\r\n    if (typeof (key) !== \"string\") {\r\n      key = key[0];\r\n    }\r\n    // Simulate correct and simple usage of i18next's translation function\r\n    // Namely, remove the leading namespace substring if there is one\r\n    return key.split(\":\", 2).pop()!;\r\n  }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}

package/lib/esm/MapImagerySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapImagerySettings.js","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAqB,oBAAoB,EAAiB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA4B9G,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,KAAjB,iBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IAK7B,YAAoB,IAAuB,EAAE,oBAAsC,EAAE,kBAAoC;QAHjH,sBAAiB,GAAG,IAAI,KAAK,EAAoB,CAAC;QAClD,mBAAc,GAAG,IAAI,KAAK,EAAoB,CAAC;QAGrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,oBAAoB,EAAE;YACxB,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE;gBAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACpD,IAAI,KAAK;oBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACtC;SACF;QACD,IAAI,kBAAkB,EAAE;YACtB,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;gBAClD,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBAClE,IAAI,YAAY;oBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC1C;SACF;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc,KAAwB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC/E,IAAW,cAAc,CAAC,IAAuB,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC;IAEnF,IAAW,gBAAgB,KAAyB,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpF,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,CAAC,IAAI,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAEzI,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,WAA6B;QAClD,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,WAA6B,EAAE,QAAuC;QACjG,MAAM,SAAS,GAAG,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,QAAQ,IAAI,EAAG,CAAC,CAAC;QAEtK,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IACtG,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAoB,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QACjF,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACnC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAChC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAE3E,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayers\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\r\n\r\n/** JSON representation of a [[BaseLayerSettings]].\r\n * @public\r\n */\r\nexport type BaseLayerProps = BaseMapLayerProps | ColorDefProps;\r\n\r\n/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally\r\n * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model\r\n * that is generated from two dimensional GIS data.\r\n * @public\r\n */\r\nexport interface MapImageryProps {\r\n  backgroundBase?: BaseLayerProps;\r\n  backgroundLayers?: MapLayerProps[];\r\n  overlayLayers?: MapLayerProps[];\r\n}\r\n\r\n/** The base layer for a [[MapImagerySettings]].\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\r\n\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace BaseLayerSettings {\r\n  /** Create a base layer from its JSON representation. */\r\n  export function fromJSON(props: BaseLayerProps): BaseLayerSettings {\r\n    return typeof props === \"number\" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);\r\n  }\r\n}\r\n\r\n/** Provides access to the map imagery settings (Base and layers).\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * @public\r\n */\r\nexport class MapImagerySettings {\r\n  private _backgroundBase: BaseLayerSettings;\r\n  private _backgroundLayers = new Array<MapLayerSettings>();\r\n  private _overlayLayers = new Array<MapLayerSettings>();\r\n\r\n  private constructor(base: BaseLayerSettings, backgroundLayerProps?: MapLayerProps[], overlayLayersProps?: MapLayerProps[]) {\r\n    this._backgroundBase = base;\r\n    if (backgroundLayerProps) {\r\n      for (const layerProps of backgroundLayerProps) {\r\n        const layer = MapLayerSettings.fromJSON(layerProps);\r\n        if (layer)\r\n          this._backgroundLayers.push(layer);\r\n      }\r\n    }\r\n    if (overlayLayersProps) {\r\n      for (const overlayLayerProps of overlayLayersProps) {\r\n        const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);\r\n        if (overlayLayer)\r\n          this._overlayLayers.push(overlayLayer);\r\n      }\r\n    }\r\n  }\r\n\r\n  /** The settings for the base layer.\r\n   *  @note If changing the base provider it is currently necessary to also update the background map settings.\r\n   */\r\n  public get backgroundBase(): BaseLayerSettings { return this._backgroundBase; }\r\n  public set backgroundBase(base: BaseLayerSettings) { this._backgroundBase = base; }\r\n\r\n  public get backgroundLayers(): MapLayerSettings[] { return this._backgroundLayers; }\r\n  public get overlayLayers(): MapLayerSettings[] { return this._overlayLayers; }\r\n\r\n  /** Return base transparency as a number between 0 and 1.\r\n   * @internal\r\n   */\r\n  public get baseTransparency(): number {\r\n    return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;\r\n\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(imageryJson?: MapImageryProps) {\r\n    return this.createFromJSON(imageryJson, undefined);\r\n  }\r\n\r\n  /** @internal */\r\n  public static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps) {\r\n    const baseLayer = imageryJson?.backgroundBase ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps ?? { });\r\n\r\n    return new MapImagerySettings(baseLayer, imageryJson?.backgroundLayers, imageryJson?.overlayLayers);\r\n  }\r\n\r\n  public toJSON(): MapImageryProps {\r\n    const props: MapImageryProps = { backgroundBase: this._backgroundBase.toJSON() };\r\n    if (this._backgroundLayers.length > 0)\r\n      props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());\r\n\r\n    if (this._overlayLayers.length > 0)\r\n      props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());\r\n\r\n    return props;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapImagerySettings.js","sourceRoot":"","sources":["../../src/MapImagerySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAqB,oBAAoB,EAAiB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA4B9G,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,iBAAiB,CAKjC;AALD,WAAiB,iBAAiB;IAChC,wDAAwD;IACxD,SAAgB,QAAQ,CAAC,KAAqB;QAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC;IAFe,0BAAQ,WAEvB,CAAA;AACH,CAAC,EALgB,iBAAiB,KAAjB,iBAAiB,QAKjC;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IAK7B,YAAoB,IAAuB,EAAE,oBAAsC,EAAE,kBAAoC;QAHjH,sBAAiB,GAAG,IAAI,KAAK,EAAoB,CAAC;QAClD,mBAAc,GAAG,IAAI,KAAK,EAAoB,CAAC;QAGrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,oBAAoB,EAAE,CAAC;YACzB,KAAK,MAAM,UAAU,IAAI,oBAAoB,EAAE,CAAC;gBAC9C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACpD,IAAI,KAAK;oBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,IAAI,kBAAkB,EAAE,CAAC;YACvB,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE,CAAC;gBACnD,MAAM,YAAY,GAAG,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBAClE,IAAI,YAAY;oBACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc,KAAwB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC/E,IAAW,cAAc,CAAC,IAAuB,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC;IAEnF,IAAW,gBAAgB,KAAyB,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpF,IAAW,aAAa,KAAyB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE9E;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,CAAC,IAAI,CAAC,eAAe,YAAY,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAEzI,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,WAA6B;QAClD,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,cAAc,CAAC,WAA6B,EAAE,QAAuC;QACjG,MAAM,SAAS,GAAG,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,QAAQ,IAAI,EAAG,CAAC,CAAC;QAEtK,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;IACtG,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAoB,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QACjF,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACnC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAEjF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAChC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAE3E,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayers\r\n */\r\n\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { BaseMapLayerProps, BaseMapLayerSettings, MapLayerProps, MapLayerSettings } from \"./MapLayerSettings\";\r\n\r\n/** JSON representation of a [[BaseLayerSettings]].\r\n * @public\r\n */\r\nexport type BaseLayerProps = BaseMapLayerProps | ColorDefProps;\r\n\r\n/** The JSON representation of the map imagery.  Map imagery include the specification for the base layer (which was originally\r\n * represented by [[BackgroundMapProps.providerName]]  && [[BackgroundMapProps.providerData]]) and additional map layers.\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * The non-base map layers may represent image layers generated by tile servers or model layers that are generated by 2d projection of model geometry, typically from a model\r\n * that is generated from two dimensional GIS data.\r\n * @public\r\n */\r\nexport interface MapImageryProps {\r\n  backgroundBase?: BaseLayerProps;\r\n  backgroundLayers?: MapLayerProps[];\r\n  overlayLayers?: MapLayerProps[];\r\n}\r\n\r\n/** The base layer for a [[MapImagerySettings]].\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport type BaseLayerSettings = BaseMapLayerSettings | ColorDef;\r\n\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace BaseLayerSettings {\r\n  /** Create a base layer from its JSON representation. */\r\n  export function fromJSON(props: BaseLayerProps): BaseLayerSettings {\r\n    return typeof props === \"number\" ? ColorDef.fromJSON(props) : BaseMapLayerSettings.fromJSON(props);\r\n  }\r\n}\r\n\r\n/** Provides access to the map imagery settings (Base and layers).\r\n * In earlier versions only a background map was supported as specified by the providerName and mapType members of [[BackgroundMapSettings]] object.\r\n * In order to provide backward compatibility the original [[BackgroundMapSettings]] are synchronized with the [[MapImagerySettings]] base layer as long as\r\n * the settings are compatible.\r\n * @public\r\n */\r\nexport class MapImagerySettings {\r\n  private _backgroundBase: BaseLayerSettings;\r\n  private _backgroundLayers = new Array<MapLayerSettings>();\r\n  private _overlayLayers = new Array<MapLayerSettings>();\r\n\r\n  private constructor(base: BaseLayerSettings, backgroundLayerProps?: MapLayerProps[], overlayLayersProps?: MapLayerProps[]) {\r\n    this._backgroundBase = base;\r\n    if (backgroundLayerProps) {\r\n      for (const layerProps of backgroundLayerProps) {\r\n        const layer = MapLayerSettings.fromJSON(layerProps);\r\n        if (layer)\r\n          this._backgroundLayers.push(layer);\r\n      }\r\n    }\r\n    if (overlayLayersProps) {\r\n      for (const overlayLayerProps of overlayLayersProps) {\r\n        const overlayLayer = MapLayerSettings.fromJSON(overlayLayerProps);\r\n        if (overlayLayer)\r\n          this._overlayLayers.push(overlayLayer);\r\n      }\r\n    }\r\n  }\r\n\r\n  /** The settings for the base layer.\r\n   *  @note If changing the base provider it is currently necessary to also update the background map settings.\r\n   */\r\n  public get backgroundBase(): BaseLayerSettings { return this._backgroundBase; }\r\n  public set backgroundBase(base: BaseLayerSettings) { this._backgroundBase = base; }\r\n\r\n  public get backgroundLayers(): MapLayerSettings[] { return this._backgroundLayers; }\r\n  public get overlayLayers(): MapLayerSettings[] { return this._overlayLayers; }\r\n\r\n  /** Return base transparency as a number between 0 and 1.\r\n   * @internal\r\n   */\r\n  public get baseTransparency(): number {\r\n    return (this._backgroundBase instanceof ColorDef) ? (this._backgroundBase.getTransparency() / 255) : this._backgroundBase.transparency;\r\n\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(imageryJson?: MapImageryProps) {\r\n    return this.createFromJSON(imageryJson, undefined);\r\n  }\r\n\r\n  /** @internal */\r\n  public static createFromJSON(imageryJson?: MapImageryProps, mapProps?: DeprecatedBackgroundMapProps) {\r\n    const baseLayer = imageryJson?.backgroundBase ? BaseLayerSettings.fromJSON(imageryJson.backgroundBase) : BaseMapLayerSettings.fromBackgroundMapProps(mapProps ?? { });\r\n\r\n    return new MapImagerySettings(baseLayer, imageryJson?.backgroundLayers, imageryJson?.overlayLayers);\r\n  }\r\n\r\n  public toJSON(): MapImageryProps {\r\n    const props: MapImageryProps = { backgroundBase: this._backgroundBase.toJSON() };\r\n    if (this._backgroundLayers.length > 0)\r\n      props.backgroundLayers = this._backgroundLayers.map((layer) => layer.toJSON());\r\n\r\n    if (this._overlayLayers.length > 0)\r\n      props.overlayLayers = this._overlayLayers.map((layer) => layer.toJSON());\r\n\r\n    return props;\r\n  }\r\n}\r\n"]}

package/lib/esm/MapLayerSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAA8B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA2B/G;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AAoFD;;;;;GAKG;AACH,MAAM,OAAgB,gBAAgB;IAUpC,gBAAgB;IAChB,YAAsB,IAAY,EAAE,OAAO,GAAG,IAAI,EAAE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACxG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrH,CAAC;IAED,gBAAgB;IACN,OAAO;QACf,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;SAC1I,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IAC9K,CAAC;IAKD,gBAAgB;IACT,oBAAoB,CAAC,IAAY,EAAE,MAAc;QACtD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IACtD,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAkBzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEzD,gBAAgB;IAChB,YAAsB,KAAyB;QAC7C,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC;QAClE,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,KAAK,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,gBAAgB,GAAG,EAAC,GAAG,KAAK,CAAC,WAAW,EAAC,CAAC;SAChD;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS;YAClB,OAAO;QAET,KAAK,MAAM,aAAa,IAAI,KAAK,CAAC,SAAS,EAAE;YAC3C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,QAAQ;gBACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACjC;IACH,CAAC;IAEM,MAAM,CAAU,QAAQ,CAAC,KAAyB;QACvD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC3B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAE5E,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,EAAC,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,gBAAgB,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QAEnE,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACxD,KAAK,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QACzC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5B,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,YAAY,CAAC,WAAW,EAAC,CAAC;SACnD;aAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAChC,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;SAChD;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAE,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC5E,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YAC5H,OAAO,KAAK,CAAC;SACd;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,kDAAkD;IAClD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE;YACZ,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAEM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;KAEC;IACM,kBAAkB;QACvB,IAAI,WAAW,GAA4B,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,gBAAgB;YACvB,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,kBAAkB;YACzB,WAAW,GAAG,EAAC,GAAG,WAAW,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAEzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D,gBAAgB;IAChB,YAAsB,OAAmB,EAAG,IAAY,EAAE,OAAO,GAAG,IAAI,EACtE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACtD,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAU,QAAQ,CAAC,IAAwB;QACtD,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;IACnG,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QACnE,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC3E,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,0GAA0G;IAC1G,IAAW,qBAAqB;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AASD;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAG7D,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAwC;QACjE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAElE,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;aACpC,IAAI,IAAI,CAAC,QAAQ;YACpB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAwC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAE,CAAC;QAE5E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;iBACT;gBAED,IAAI,GAAG,cAAc,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,4DAA4D,CAAC;wBACnE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6DAA6D,CAAC;wBACpE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,sEAAsE,CAAC;wBAC7E,MAAM;iBACT;gBAED,MAAM;SACT;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,SAAS;YAC5B,YAAY,EAAE,OAAO,EAAE,YAAY;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,CAAC;CACF","sourcesContent":["/* eslint-disable deprecation/deprecation */\r\n/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayers\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** The current set of supported map layer formats.\r\n * In order to be displayed, a corresponding format must have been registered in the [MapLayerFormatRegistry]($frontend)\r\n * @public\r\n */\r\nexport type ImageryMapLayerFormatId  = \"ArcGIS\" | \"BingMaps\" | \"MapboxImagery\" | \"TileURL\" | \"WMS\" | \"WMTS\";\r\n\r\n/** @public */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @public\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @public\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props)!;\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of properties common to both [[ImageMapLayerProps]] and [[ModelMapLayerProps]].\r\n * @see [[MapImageryProps]]\r\n * @public\r\n */\r\nexport interface CommonMapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n\r\n  /** A user-friendly name for the layer. */\r\n  name: string;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden.\r\n   * Default value: 0.\r\n   */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.\r\n   * Default: true.\r\n   */\r\n  transparentBackground?: boolean;\r\n}\r\n\r\n/** JSON representation of an [[ImageMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @see [[ImageryMapLayerFormatId]].\r\n * @public\r\n */\r\nexport interface ImageMapLayerProps extends CommonMapLayerProps {\r\n  /** URL */\r\n  url: string;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * ###TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  /** @internal */\r\n  accessKey?: MapLayerKey;\r\n\r\n  /** @internal */\r\n  modelId?: never;\r\n\r\n  /** List of query parameters that will get appended to the source.\r\n   * @beta\r\n  */\r\n  queryParams?: { [key: string]: string };\r\n\r\n}\r\n\r\n/** JSON representation of a [[ModelMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport interface ModelMapLayerProps extends CommonMapLayerProps {\r\n  /** The Id of the [GeometricModel]($backend) containing the geometry to be drawn by the layer. */\r\n  modelId: Id64String;\r\n\r\n  /** @internal */\r\n  url?: never;\r\n  /** @internal */\r\n  formatId?: never;\r\n  /** @internal */\r\n  subLayers?: never;\r\n  /** @internal */\r\n  accessKey?: never;\r\n}\r\n\r\n/** JSON representation of a [[MapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @public\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** Abstract base class for normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @public\r\n */\r\nexport abstract class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n\r\n  public readonly name: string;\r\n  public readonly transparency: number;\r\n  public readonly transparentBackground: boolean;\r\n  public abstract get allSubLayersInvisible(): boolean;\r\n  public abstract clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;\r\n  public abstract toJSON(): MapLayerProps;\r\n\r\n  /** @internal */\r\n  protected constructor(name: string, visible = true, transparency: number = 0, transparentBackground = true) {\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a map layer settings from its JSON representation. */\r\n  public static fromJSON(props: MapLayerProps): MapLayerSettings {\r\n    return undefined !== props.modelId ? ModelMapLayerSettings.fromJSON(props) : ImageMapLayerSettings.fromJSON(props);\r\n  }\r\n\r\n  /** @internal */\r\n  protected _toJSON(): CommonMapLayerProps {\r\n    const props: CommonMapLayerProps = {\r\n      name: this.name,\r\n      visible: this.visible,\r\n    };\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): CommonMapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible && this.transparency === other.transparency && this.transparentBackground === other.transparentBackground;\r\n  }\r\n\r\n  /** Return a unique string identifying the layers source... The URL for image layer or modelID for model layer  */\r\n  public abstract get source(): string;\r\n\r\n  /** @internal */\r\n  public matchesNameAndSource(name: string, source: string): boolean {\r\n    return this.name === name && this.source === source;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ModelMapLayerSettings]] for model based map layer settings.\r\n * @public\r\n */\r\nexport class ImageMapLayerSettings extends MapLayerSettings {\r\n  public readonly formatId: string;\r\n  public readonly url: string;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n\r\n  /** List of query parameters to append to the settings URL and persisted as part of the JSON representation.\r\n   * @note Sensitive information like user credentials should be provided in [[unsavedQueryParams]] to ensure it is never persisted.\r\n   * @beta\r\n  */\r\n  public savedQueryParams?: { [key: string]: string };\r\n\r\n  /** List of query parameters that will get appended to the settings URL that should *not* be be persisted part of the JSON representation.\r\n   * @beta\r\n  */\r\n  public unsavedQueryParams?: { [key: string]: string };\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public override get source(): string { return this.url; }\r\n\r\n  /** @internal */\r\n  protected constructor(props: ImageMapLayerProps) {\r\n    const transparentBackground = props.transparentBackground ?? true;\r\n    super(props.name, props.visible, props.transparency, transparentBackground);\r\n\r\n    this.formatId = props.formatId;\r\n    this.url = props.url;\r\n    this.accessKey = props.accessKey;\r\n    if (props.queryParams) {\r\n      this.savedQueryParams = {...props.queryParams};\r\n    }\r\n    this.subLayers = [];\r\n    if (!props.subLayers)\r\n      return;\r\n\r\n    for (const subLayerProps of props.subLayers) {\r\n      const subLayer = MapSubLayerSettings.fromJSON(subLayerProps);\r\n      if (subLayer)\r\n        this.subLayers.push(subLayer);\r\n    }\r\n  }\r\n\r\n  public static override fromJSON(props: ImageMapLayerProps): ImageMapLayerSettings {\r\n    return new this(props);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ImageMapLayerProps {\r\n    const props = super._toJSON() as ImageMapLayerProps;\r\n    props.url = this.url;\r\n    props.formatId = this.formatId;\r\n\r\n    if (this.subLayers.length > 0)\r\n      props.subLayers = this.subLayers.map((x) => x.toJSON());\r\n\r\n    if (this.savedQueryParams)\r\n      props.queryParams = {...this.savedQueryParams};\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerSettings {\r\n    const clone = ImageMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n    if (this.unsavedQueryParams)\r\n      clone.unsavedQueryParams = {...this.unsavedQueryParams};\r\n    if (this.savedQueryParams)\r\n      clone.savedQueryParams = {...this.savedQueryParams};\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ImageMapLayerProps;\r\n\r\n    props.formatId = changedProps.formatId ?? this.formatId;\r\n    props.url = changedProps.url ?? this.url;\r\n    props.accessKey = changedProps.accessKey ?? this.accessKey;\r\n    props.subLayers = changedProps.subLayers ?? this.subLayers;\r\n    if (changedProps.queryParams) {\r\n      props.queryParams = {...changedProps.queryParams};\r\n    } else if (this.savedQueryParams) {\r\n      props.queryParams = {...this.savedQueryParams};\r\n    }\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (! (other instanceof ImageMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n\r\n  /** Collect all query parameters\r\n * @beta\r\n */\r\n  public collectQueryParams() {\r\n    let queryParams: {[key: string]: string} = {};\r\n    if (this.savedQueryParams)\r\n      queryParams = {...this.savedQueryParams};\r\n\r\n    if (this.unsavedQueryParams)\r\n      queryParams = {...queryParams, ...this.unsavedQueryParams};\r\n\r\n    return queryParams;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ImageMapLayerSettings]] for image based map layer settings.\r\n * @public\r\n */\r\nexport class ModelMapLayerSettings extends MapLayerSettings {\r\n  public readonly modelId: Id64String;\r\n  public override get source(): string { return this.modelId; }\r\n\r\n  /** @internal */\r\n  protected constructor(modelId: Id64String,  name: string, visible = true,\r\n    transparency: number = 0, transparentBackground = true) {\r\n    super(name, visible, transparency, transparentBackground);\r\n    this.modelId = modelId;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static override fromJSON(json: ModelMapLayerProps): ModelMapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.modelId, json.name, json.visible, json.transparency, transparentBackground);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ModelMapLayerProps {\r\n    const props = super._toJSON() as ModelMapLayerProps;\r\n    props.modelId = this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerSettings {\r\n    return ModelMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ModelMapLayerProps;\r\n    props.modelId = changedProps.modelId ?? this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (!(other instanceof ModelMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    return this.modelId === other.modelId;\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */\r\n  public get allSubLayersInvisible(): boolean {\r\n    return false;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport interface BaseMapLayerProps extends ImageMapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport class BaseMapLayerSettings extends ImageMapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n\r\n    if (changedProps.provider)\r\n      props.provider = changedProps.provider;\r\n    else if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps))!;\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n\r\n        name = `Bing Maps: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/\";\r\n            break;\r\n        }\r\n\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAA8B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA2B/G;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IAED,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AAoFD;;;;;GAKG;AACH,MAAM,OAAgB,gBAAgB;IAUpC,gBAAgB;IAChB,YAAsB,IAAY,EAAE,OAAO,GAAG,IAAI,EAAE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACxG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,QAAQ,CAAC,KAAoB;QACzC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrH,CAAC;IAED,gBAAgB;IACN,OAAO;QACf,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;SAC1I,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB,CAAC;IAC9K,CAAC;IAKD,gBAAgB;IACT,oBAAoB,CAAC,IAAY,EAAE,MAAc;QACtD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;IACtD,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAkBzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEzD,gBAAgB;IAChB,YAAsB,KAAyB;QAC7C,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,IAAI,IAAI,CAAC;QAClE,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAE5E,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,gBAAgB,GAAG,EAAC,GAAG,KAAK,CAAC,WAAW,EAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS;YAClB,OAAO;QAET,KAAK,MAAM,aAAa,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC7D,IAAI,QAAQ;gBACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAEM,MAAM,CAAU,QAAQ,CAAC,KAAyB;QACvD,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE/B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAC3B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAE1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAE5E,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,EAAC,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,gBAAgB;YACvB,KAAK,CAAC,gBAAgB,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QAEnE,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACxD,KAAK,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QACzC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC;QAC3D,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;YAC7B,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,YAAY,CAAC,WAAW,EAAC,CAAC;QACpD,CAAC;aAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACjC,KAAK,CAAC,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QACjD,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAE,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC5E,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC7H,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,kDAAkD;IAClD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;KAEC;IACM,kBAAkB;QACvB,IAAI,WAAW,GAA4B,EAAE,CAAC;QAC9C,IAAI,IAAI,CAAC,gBAAgB;YACvB,WAAW,GAAG,EAAC,GAAG,IAAI,CAAC,gBAAgB,EAAC,CAAC;QAE3C,IAAI,IAAI,CAAC,kBAAkB;YACzB,WAAW,GAAG,EAAC,GAAG,WAAW,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,qBAAsB,SAAQ,gBAAgB;IAEzD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7D,gBAAgB;IAChB,YAAsB,OAAmB,EAAG,IAAY,EAAE,OAAO,GAAG,IAAI,EACtE,eAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI;QACtD,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,qBAAqB,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAU,QAAQ,CAAC,IAAwB;QACtD,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;IACnG,CAAC;IAED,iEAAiE;IACjD,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAwB,CAAC;QACpD,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAyC;QACpD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB;IACG,UAAU,CAAC,YAAyC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAuB,CAAC;QACnE,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,cAAc,CAAC,KAAuB;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;YAC3E,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,0GAA0G;IAC1G,IAAW,qBAAqB;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AASD;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,qBAAqB;IAG7D,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAwC;QACjE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAElE,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;aACpC,IAAI,IAAI,CAAC,QAAQ;YACpB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAwC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAE3E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACtB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;gBACV,CAAC;gBAED,IAAI,GAAG,cAAc,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,qBAAqB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrE,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACtB,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,4DAA4D,CAAC;wBACnE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6DAA6D,CAAC;wBACpE,MAAM;oBACR,KAAK,iBAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,sEAAsE,CAAC;wBAC7E,MAAM;gBACV,CAAC;gBAED,MAAM;QACV,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,OAAO,EAAE,CAAC,OAAO,EAAE,SAAS;YAC5B,YAAY,EAAE,OAAO,EAAE,YAAY;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,CAAC;CACF","sourcesContent":["/* eslint-disable deprecation/deprecation */\r\n/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayers\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** The current set of supported map layer formats.\r\n * In order to be displayed, a corresponding format must have been registered in the [MapLayerFormatRegistry]($frontend)\r\n * @public\r\n */\r\nexport type ImageryMapLayerFormatId  = \"ArcGIS\" | \"BingMaps\" | \"MapboxImagery\" | \"TileURL\" | \"WMS\" | \"WMTS\";\r\n\r\n/** @public */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @public\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @public\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props);\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of properties common to both [[ImageMapLayerProps]] and [[ModelMapLayerProps]].\r\n * @see [[MapImageryProps]]\r\n * @public\r\n */\r\nexport interface CommonMapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n\r\n  /** A user-friendly name for the layer. */\r\n  name: string;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden.\r\n   * Default value: 0.\r\n   */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.\r\n   * Default: true.\r\n   */\r\n  transparentBackground?: boolean;\r\n}\r\n\r\n/** JSON representation of an [[ImageMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @see [[ImageryMapLayerFormatId]].\r\n * @public\r\n */\r\nexport interface ImageMapLayerProps extends CommonMapLayerProps {\r\n  /** URL */\r\n  url: string;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * ###TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  /** @internal */\r\n  accessKey?: MapLayerKey;\r\n\r\n  /** @internal */\r\n  modelId?: never;\r\n\r\n  /** List of query parameters that will get appended to the source.\r\n   * @beta\r\n  */\r\n  queryParams?: { [key: string]: string };\r\n\r\n}\r\n\r\n/** JSON representation of a [[ModelMapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport interface ModelMapLayerProps extends CommonMapLayerProps {\r\n  /** The Id of the [GeometricModel]($backend) containing the geometry to be drawn by the layer. */\r\n  modelId: Id64String;\r\n\r\n  /** @internal */\r\n  url?: never;\r\n  /** @internal */\r\n  formatId?: never;\r\n  /** @internal */\r\n  subLayers?: never;\r\n  /** @internal */\r\n  accessKey?: never;\r\n}\r\n\r\n/** JSON representation of a [[MapLayerSettings]].\r\n * @see [[MapImagerySettings]].\r\n * @public\r\n */\r\nexport type MapLayerProps = ImageMapLayerProps | ModelMapLayerProps;\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @public\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** Abstract base class for normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * This class is extended by [[ImageMapLayerSettings]] and [ModelMapLayerSettings]] to create the settings for image and model based layers.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @public\r\n */\r\nexport abstract class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n\r\n  public readonly name: string;\r\n  public readonly transparency: number;\r\n  public readonly transparentBackground: boolean;\r\n  public abstract get allSubLayersInvisible(): boolean;\r\n  public abstract clone(changedProps: Partial<MapLayerProps>): MapLayerSettings;\r\n  public abstract toJSON(): MapLayerProps;\r\n\r\n  /** @internal */\r\n  protected constructor(name: string, visible = true, transparency: number = 0, transparentBackground = true) {\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a map layer settings from its JSON representation. */\r\n  public static fromJSON(props: MapLayerProps): MapLayerSettings {\r\n    return undefined !== props.modelId ? ModelMapLayerSettings.fromJSON(props) : ImageMapLayerSettings.fromJSON(props);\r\n  }\r\n\r\n  /** @internal */\r\n  protected _toJSON(): CommonMapLayerProps {\r\n    const props: CommonMapLayerProps = {\r\n      name: this.name,\r\n      visible: this.visible,\r\n    };\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): CommonMapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible && this.transparency === other.transparency && this.transparentBackground === other.transparentBackground;\r\n  }\r\n\r\n  /** Return a unique string identifying the layers source... The URL for image layer or modelID for model layer  */\r\n  public abstract get source(): string;\r\n\r\n  /** @internal */\r\n  public matchesNameAndSource(name: string, source: string): boolean {\r\n    return this.name === name && this.source === source;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ImageMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Image map layers are created from servers that produce images that represent map tiles.  Map layers map also be represented by models.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ModelMapLayerSettings]] for model based map layer settings.\r\n * @public\r\n */\r\nexport class ImageMapLayerSettings extends MapLayerSettings {\r\n  public readonly formatId: string;\r\n  public readonly url: string;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n\r\n  /** List of query parameters to append to the settings URL and persisted as part of the JSON representation.\r\n   * @note Sensitive information like user credentials should be provided in [[unsavedQueryParams]] to ensure it is never persisted.\r\n   * @beta\r\n  */\r\n  public savedQueryParams?: { [key: string]: string };\r\n\r\n  /** List of query parameters that will get appended to the settings URL that should *not* be be persisted part of the JSON representation.\r\n   * @beta\r\n  */\r\n  public unsavedQueryParams?: { [key: string]: string };\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public override get source(): string { return this.url; }\r\n\r\n  /** @internal */\r\n  protected constructor(props: ImageMapLayerProps) {\r\n    const transparentBackground = props.transparentBackground ?? true;\r\n    super(props.name, props.visible, props.transparency, transparentBackground);\r\n\r\n    this.formatId = props.formatId;\r\n    this.url = props.url;\r\n    this.accessKey = props.accessKey;\r\n    if (props.queryParams) {\r\n      this.savedQueryParams = {...props.queryParams};\r\n    }\r\n    this.subLayers = [];\r\n    if (!props.subLayers)\r\n      return;\r\n\r\n    for (const subLayerProps of props.subLayers) {\r\n      const subLayer = MapSubLayerSettings.fromJSON(subLayerProps);\r\n      if (subLayer)\r\n        this.subLayers.push(subLayer);\r\n    }\r\n  }\r\n\r\n  public static override fromJSON(props: ImageMapLayerProps): ImageMapLayerSettings {\r\n    return new this(props);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ImageMapLayerProps {\r\n    const props = super._toJSON() as ImageMapLayerProps;\r\n    props.url = this.url;\r\n    props.formatId = this.formatId;\r\n\r\n    if (this.subLayers.length > 0)\r\n      props.subLayers = this.subLayers.map((x) => x.toJSON());\r\n\r\n    if (this.savedQueryParams)\r\n      props.queryParams = {...this.savedQueryParams};\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerSettings {\r\n    const clone = ImageMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n    if (this.unsavedQueryParams)\r\n      clone.unsavedQueryParams = {...this.unsavedQueryParams};\r\n    if (this.savedQueryParams)\r\n      clone.savedQueryParams = {...this.savedQueryParams};\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ImageMapLayerProps>): ImageMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ImageMapLayerProps;\r\n\r\n    props.formatId = changedProps.formatId ?? this.formatId;\r\n    props.url = changedProps.url ?? this.url;\r\n    props.accessKey = changedProps.accessKey ?? this.accessKey;\r\n    props.subLayers = changedProps.subLayers ?? this.subLayers;\r\n    if (changedProps.queryParams) {\r\n      props.queryParams = {...changedProps.queryParams};\r\n    } else if (this.savedQueryParams) {\r\n      props.queryParams = {...this.savedQueryParams};\r\n    }\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (! (other instanceof ImageMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n\r\n  /** Collect all query parameters\r\n * @beta\r\n */\r\n  public collectQueryParams() {\r\n    let queryParams: {[key: string]: string} = {};\r\n    if (this.savedQueryParams)\r\n      queryParams = {...this.savedQueryParams};\r\n\r\n    if (this.unsavedQueryParams)\r\n      queryParams = {...queryParams, ...this.unsavedQueryParams};\r\n\r\n    return queryParams;\r\n  }\r\n}\r\n\r\n/** Normalized representation of a [[ModelMapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * Model map layers are produced from models, typically from two dimensional geometry that may originate in a GIS system.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @see [[ImageMapLayerSettings]] for image based map layer settings.\r\n * @public\r\n */\r\nexport class ModelMapLayerSettings extends MapLayerSettings {\r\n  public readonly modelId: Id64String;\r\n  public override get source(): string { return this.modelId; }\r\n\r\n  /** @internal */\r\n  protected constructor(modelId: Id64String,  name: string, visible = true,\r\n    transparency: number = 0, transparentBackground = true) {\r\n    super(name, visible, transparency, transparentBackground);\r\n    this.modelId = modelId;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static override fromJSON(json: ModelMapLayerProps): ModelMapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.modelId, json.name, json.visible, json.transparency, transparentBackground);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public override toJSON(): ModelMapLayerProps {\r\n    const props = super._toJSON() as ModelMapLayerProps;\r\n    props.modelId = this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerSettings {\r\n    return ModelMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n  }\r\n\r\n  /** @internal */\r\n  protected override cloneProps(changedProps: Partial<ModelMapLayerProps>): ModelMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as ModelMapLayerProps;\r\n    props.modelId = changedProps.modelId ?? this.modelId;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override displayMatches(other: MapLayerSettings): boolean {\r\n    if (!(other instanceof ModelMapLayerSettings) || !super.displayMatches(other))\r\n      return false;\r\n\r\n    return this.modelId === other.modelId;\r\n  }\r\n\r\n  /** Return true if all sublayers are invisible (always false as model layers do not include sublayers). */\r\n  public get allSubLayersInvisible(): boolean {\r\n    return false;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport interface BaseMapLayerProps extends ImageMapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[ImageMapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @public\r\n */\r\nexport class BaseMapLayerSettings extends ImageMapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n\r\n    if (changedProps.provider)\r\n      props.provider = changedProps.provider;\r\n    else if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<BaseMapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n\r\n        name = `Bing Maps: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${ImageMapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/streets-v11/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/\";\r\n            break;\r\n        }\r\n\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}

package/lib/esm/ModelGeometryChanges.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAA0B,MAAM,qBAAqB,CAAC;AAClG,OAAO,EAAE,OAAO,EAAgB,MAAM,sBAAsB,CAAC;AAwE7D;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,KAArB,qBAAqB,QAiCrC;AAiBD;;;GAGG;AACH,MAAM,KAAW,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,KAApB,oBAAoB,QA8BpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Geometry\r\n */\r\n\r\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\n\r\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\r\n * All of the elements belong to the same model.\r\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\r\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\r\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ElementIdsAndRangesProps {\r\n  /** The Ids of the elements, compressed and sorted in ascending order. */\r\n  readonly ids: CompressedId64Set;\r\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\r\n  readonly ranges: Range3dProps[];\r\n}\r\n\r\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\r\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\r\n * @see [[ModelGeometryChanges]] for a more useful representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChangesProps {\r\n  /** The Id of the model. */\r\n  readonly id: Id64String;\r\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\r\n  readonly range: Range3dProps;\r\n  /** The geometry GUID of the model. */\r\n  readonly guid: GuidString;\r\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\r\n  readonly inserted?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\r\n  readonly updated?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\r\n  readonly deleted?: CompressedId64Set;\r\n}\r\n\r\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ExtantElementGeometryChange {\r\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\r\n   * Used as discriminant for [[ElementGeometryChange]] union.\r\n   */\r\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n  /** The element's range. */\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Represents the deletion of a [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeletedElementGeometryChange {\r\n  /** Discriminant for [[ElementGeometryChange]] union. */\r\n  readonly type: DbOpcode.Delete;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\r\n\r\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\r\n * @public\r\n */\r\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\r\n    let index = 0;\r\n    const ids = CompressedId64Set.iterable(props.ids);\r\n    for (const id of ids) {\r\n      assert(undefined !== props.ranges[index]);\r\n      const range = Range3d.fromJSON(props.ranges[index]);\r\n      index++;\r\n      yield { type, id, range };\r\n    }\r\n  }\r\n\r\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\r\n  }\r\n\r\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\r\n    if (modelChanges.inserted)\r\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\r\n\r\n    if (modelChanges.updated)\r\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\r\n\r\n    if (modelChanges.deleted)\r\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\r\n        yield { type: DbOpcode.Delete, id };\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChanges {\r\n  /** The model's Id. */\r\n  readonly id: Id64String;\r\n  /** The model's geometry GUID. */\r\n  readonly geometryGuid: GuidString;\r\n  /** The model's range. */\r\n  readonly range: Range3d;\r\n  /** The individual geometric element changes. */\r\n  readonly elements: Iterable<ElementGeometryChange>;\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\r\n * @public\r\n */\r\nexport namespace ModelGeometryChanges {\r\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\r\n    for (const props of modelChanges)\r\n      yield fromJSON(props);\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n\r\n  /** Instantiate from wire format. */\r\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\r\n    return {\r\n      id: props.id,\r\n      geometryGuid: props.guid,\r\n      range: Range3d.fromJSON(props.range),\r\n      elements: ElementGeometryChange.iterable(props),\r\n    };\r\n  }\r\n\r\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\r\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\r\n    for (const change of changes)\r\n      if (change.id === modelId)\r\n        return change;\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAA0B,MAAM,qBAAqB,CAAC;AAClG,OAAO,EAAE,OAAO,EAAgB,MAAM,sBAAsB,CAAC;AAwE7D;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,KAArB,qBAAqB,QAiCrC;AAiBD;;;GAGG;AACH,MAAM,KAAW,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,KAApB,oBAAoB,QA8BpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Geometry\r\n */\r\n\r\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\n\r\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\r\n * All of the elements belong to the same model.\r\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\r\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\r\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ElementIdsAndRangesProps {\r\n  /** The Ids of the elements, compressed and sorted in ascending order. */\r\n  readonly ids: CompressedId64Set;\r\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\r\n  readonly ranges: Range3dProps[];\r\n}\r\n\r\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\r\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\r\n * @see [[ModelGeometryChanges]] for a more useful representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChangesProps {\r\n  /** The Id of the model. */\r\n  readonly id: Id64String;\r\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\r\n  readonly range: Range3dProps;\r\n  /** The geometry GUID of the model. */\r\n  readonly guid: GuidString;\r\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\r\n  readonly inserted?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\r\n  readonly updated?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\r\n  readonly deleted?: CompressedId64Set;\r\n}\r\n\r\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ExtantElementGeometryChange {\r\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\r\n   * Used as discriminant for [[ElementGeometryChange]] union.\r\n   */\r\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n  /** The element's range. */\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Represents the deletion of a [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeletedElementGeometryChange {\r\n  /** Discriminant for [[ElementGeometryChange]] union. */\r\n  readonly type: DbOpcode.Delete;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\r\n\r\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\r\n * @public\r\n */\r\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\r\n    let index = 0;\r\n    const ids = CompressedId64Set.iterable(props.ids);\r\n    for (const id of ids) {\r\n      assert(undefined !== props.ranges[index]);\r\n      const range = Range3d.fromJSON(props.ranges[index]);\r\n      index++;\r\n      yield { type, id, range };\r\n    }\r\n  }\r\n\r\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\r\n  }\r\n\r\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\r\n    if (modelChanges.inserted)\r\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\r\n\r\n    if (modelChanges.updated)\r\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\r\n\r\n    if (modelChanges.deleted)\r\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\r\n        yield { type: DbOpcode.Delete, id };\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChanges {\r\n  /** The model's Id. */\r\n  readonly id: Id64String;\r\n  /** The model's geometry GUID. */\r\n  readonly geometryGuid: GuidString;\r\n  /** The model's range. */\r\n  readonly range: Range3d;\r\n  /** The individual geometric element changes. */\r\n  readonly elements: Iterable<ElementGeometryChange>;\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\r\n * @public\r\n */\r\nexport namespace ModelGeometryChanges {\r\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\r\n    for (const props of modelChanges)\r\n      yield fromJSON(props);\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n\r\n  /** Instantiate from wire format. */\r\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\r\n    return {\r\n      id: props.id,\r\n      geometryGuid: props.guid,\r\n      range: Range3d.fromJSON(props.range),\r\n      elements: ElementGeometryChange.iterable(props),\r\n    };\r\n  }\r\n\r\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\r\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\r\n    for (const change of changes)\r\n      if (change.id === modelId)\r\n        return change;\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/esm/OctEncodedNormal.js.map

@@ -1 +1 @@
-{"version":3,"file":"OctEncodedNormal.js","sourceRoot":"","sources":["../../src/OctEncodedNormal.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAU,MAAM,sBAAsB,CAAC;AAExD,MAAM,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEzC,SAAS,KAAK,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;IACxD,OAAO,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,aAAa,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACvB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAI3B;;;OAGG;IACH,YAAmB,GAAW;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,MAAM,CAAC,GAAW;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,CAAC,EAAE;YACV,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACxC,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SACzC;QACD,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,UAAU,CAAC,GAAW;QAClC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,+DAA+D;IACxD,MAAM;QACX,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,MAAiB;QACtD,IAAI,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;QACpB,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QAClB,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;QACN,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;SAC9B;aAAM;YACL,CAAC,GAAG,MAAM,CAAC;YACX,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;SACV;QAED,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;YACX,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SAC1C;QAED,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,OAAO,oBAAoB;IAC/B,YAAmB,KAAuB,EAAS,MAAwB;QAAxD,UAAK,GAAL,KAAK,CAAkB;QAAS,WAAM,GAAN,MAAM,CAAkB;IAAI,CAAC;CACjF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { Vector3d, XYAndZ } from \"@itwin/core-geometry\";\r\n\r\nconst scratchUInt16 = new Uint16Array(1);\r\n\r\nfunction clamp(val: number, minVal: number, maxVal: number): number {\r\n  return val < minVal ? minVal : (val > maxVal ? maxVal : val);\r\n}\r\n\r\nfunction clampUint8(val: number): number {\r\n  return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);\r\n}\r\n\r\nfunction roundUint16(val: number): number {\r\n  scratchUInt16[0] = val;\r\n  return scratchUInt16[0];\r\n}\r\n\r\nfunction signNotZero(val: number): number {\r\n  return val < 0.0 ? -1.0 : 1.0;\r\n}\r\n\r\n/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).\r\n * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.\r\n * @public\r\n */\r\nexport class OctEncodedNormal {\r\n  /** The encoded normal. */\r\n  public readonly value: number;\r\n\r\n  /** Construct directly from a 16-bit encoded value.\r\n   * @see [[encode]] to compute the encoded value.\r\n   * @see [[fromVector]] to construct from a vector.\r\n   */\r\n  public constructor(val: number) {\r\n    this.value = roundUint16(val);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector. */\r\n  public static encode(vec: XYAndZ): number {\r\n    return this.encodeXYZ(vec.x, vec.y, vec.z);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector components. */\r\n  public static encodeXYZ(nx: number, ny: number, nz: number): number {\r\n    const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);\r\n    let rx = nx / denom;\r\n    let ry = ny / denom;\r\n    if (nz < 0) {\r\n      const x = rx;\r\n      const y = ry;\r\n      rx = (1 - Math.abs(y)) * signNotZero(x);\r\n      ry = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n    return clampUint8(ry) << 8 | clampUint8(rx);\r\n  }\r\n\r\n  /** Create an OctEncodedNormal from a normalized vector. */\r\n  public static fromVector(val: XYAndZ): OctEncodedNormal {\r\n    return new OctEncodedNormal(this.encode(val));\r\n  }\r\n\r\n  /** Decode this oct-encoded normal into a normalized vector. */\r\n  public decode(): Vector3d {\r\n    return OctEncodedNormal.decodeValue(this.value);\r\n  }\r\n\r\n  /** Decode a 16-bit encoded value into a normalized vector. */\r\n  public static decodeValue(val: number, result?: Vector3d): Vector3d {\r\n    let ex = val & 0xff;\r\n    let ey = val >> 8;\r\n    ex = ex / 255.0 * 2.0 - 1.0;\r\n    ey = ey / 255.0 * 2.0 - 1.0;\r\n    const ez = 1 - (Math.abs(ex) + Math.abs(ey));\r\n    let n;\r\n    if (result === undefined) {\r\n      n = new Vector3d(ex, ey, ez);\r\n    } else {\r\n      n = result;\r\n      n.x = ex;\r\n      n.y = ey;\r\n      n.z = ez;\r\n    }\r\n\r\n    if (n.z < 0) {\r\n      const x = n.x;\r\n      const y = n.y;\r\n      n.x = (1 - Math.abs(y)) * signNotZero(x);\r\n      n.y = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n\r\n    n.normalizeInPlace();\r\n    return n;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class OctEncodedNormalPair {\r\n  constructor(public first: OctEncodedNormal, public second: OctEncodedNormal) { }\r\n}\r\n"]}
+{"version":3,"file":"OctEncodedNormal.js","sourceRoot":"","sources":["../../src/OctEncodedNormal.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAU,MAAM,sBAAsB,CAAC;AAExD,MAAM,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEzC,SAAS,KAAK,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;IACxD,OAAO,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,aAAa,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACvB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAI3B;;;OAGG;IACH,YAAmB,GAAW;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,MAAM,CAAC,GAAW;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACxC,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,UAAU,CAAC,GAAW;QAClC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,+DAA+D;IACxD,MAAM;QACX,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,MAAiB;QACtD,IAAI,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;QACpB,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QAClB,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;QACN,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,CAAC,GAAG,MAAM,CAAC;YACX,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACX,CAAC;QAED,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,OAAO,oBAAoB;IAC/B,YAAmB,KAAuB,EAAS,MAAwB;QAAxD,UAAK,GAAL,KAAK,CAAkB;QAAS,WAAM,GAAN,MAAM,CAAkB;IAAI,CAAC;CACjF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { Vector3d, XYAndZ } from \"@itwin/core-geometry\";\r\n\r\nconst scratchUInt16 = new Uint16Array(1);\r\n\r\nfunction clamp(val: number, minVal: number, maxVal: number): number {\r\n  return val < minVal ? minVal : (val > maxVal ? maxVal : val);\r\n}\r\n\r\nfunction clampUint8(val: number): number {\r\n  return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);\r\n}\r\n\r\nfunction roundUint16(val: number): number {\r\n  scratchUInt16[0] = val;\r\n  return scratchUInt16[0];\r\n}\r\n\r\nfunction signNotZero(val: number): number {\r\n  return val < 0.0 ? -1.0 : 1.0;\r\n}\r\n\r\n/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).\r\n * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.\r\n * @public\r\n */\r\nexport class OctEncodedNormal {\r\n  /** The encoded normal. */\r\n  public readonly value: number;\r\n\r\n  /** Construct directly from a 16-bit encoded value.\r\n   * @see [[encode]] to compute the encoded value.\r\n   * @see [[fromVector]] to construct from a vector.\r\n   */\r\n  public constructor(val: number) {\r\n    this.value = roundUint16(val);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector. */\r\n  public static encode(vec: XYAndZ): number {\r\n    return this.encodeXYZ(vec.x, vec.y, vec.z);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector components. */\r\n  public static encodeXYZ(nx: number, ny: number, nz: number): number {\r\n    const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);\r\n    let rx = nx / denom;\r\n    let ry = ny / denom;\r\n    if (nz < 0) {\r\n      const x = rx;\r\n      const y = ry;\r\n      rx = (1 - Math.abs(y)) * signNotZero(x);\r\n      ry = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n    return clampUint8(ry) << 8 | clampUint8(rx);\r\n  }\r\n\r\n  /** Create an OctEncodedNormal from a normalized vector. */\r\n  public static fromVector(val: XYAndZ): OctEncodedNormal {\r\n    return new OctEncodedNormal(this.encode(val));\r\n  }\r\n\r\n  /** Decode this oct-encoded normal into a normalized vector. */\r\n  public decode(): Vector3d {\r\n    return OctEncodedNormal.decodeValue(this.value);\r\n  }\r\n\r\n  /** Decode a 16-bit encoded value into a normalized vector. */\r\n  public static decodeValue(val: number, result?: Vector3d): Vector3d {\r\n    let ex = val & 0xff;\r\n    let ey = val >> 8;\r\n    ex = ex / 255.0 * 2.0 - 1.0;\r\n    ey = ey / 255.0 * 2.0 - 1.0;\r\n    const ez = 1 - (Math.abs(ex) + Math.abs(ey));\r\n    let n;\r\n    if (result === undefined) {\r\n      n = new Vector3d(ex, ey, ez);\r\n    } else {\r\n      n = result;\r\n      n.x = ex;\r\n      n.y = ey;\r\n      n.z = ez;\r\n    }\r\n\r\n    if (n.z < 0) {\r\n      const x = n.x;\r\n      const y = n.y;\r\n      n.x = (1 - Math.abs(y)) * signNotZero(x);\r\n      n.y = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n\r\n    n.normalizeInPlace();\r\n    return n;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class OctEncodedNormalPair {\r\n  constructor(public first: OctEncodedNormal, public second: OctEncodedNormal) { }\r\n}\r\n"]}

package/lib/esm/PlanarClipMask.js

@@ -53,7 +53,7 @@ export var PlanarClipMaskPriority;
  * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.
  * @public
  */
-class PlanarClipMaskSettings {
+export class PlanarClipMaskSettings {
     /** The compressed representation of [[modelIds]]. */
     get compressedModelIds() {
         return this._modelIds;
@@ -130,5 +130,4 @@ class PlanarClipMaskSettings {
 }
 /** A default PlanarClipMask which masks nothing. */
 PlanarClipMaskSettings.defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);
-export { PlanarClipMaskSettings };
 //# sourceMappingURL=PlanarClipMask.js.map

package/lib/esm/PlanarClipMask.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAmC,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAgBX;AAhBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;OAGG;IACH,mEAAY,CAAA;IACZ,yGAAyG;IACzG,+DAAU,CAAA;IACV,iGAAiG;IACjG,2FAAwB,CAAA;IACxB,2GAA2G;IAC3G,iFAAmB,CAAA;IACnB,qKAAqK;IACrK,iFAAmB,CAAA;AACrB,CAAC,EAhBW,kBAAkB,KAAlB,kBAAkB,QAgB7B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC;AA8FD;;;;;;;;GAQG;AACH,MAAa,sBAAsB;IAuBjC,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;;AAED,oDAAoD;AACtC,+BAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;SAlHlE,sBAAsB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\n\r\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskMode {\r\n  /** No masking. */\r\n  None = 0,\r\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\r\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\r\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\r\n   */\r\n  Priority = 1,\r\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */\r\n  Models = 2,\r\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */\r\n  IncludeSubCategories = 3,\r\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */\r\n  IncludeElements = 4,\r\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */\r\n  ExcludeElements = 5,\r\n}\r\n\r\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\r\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\r\n *  @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskPriority {\r\n  /** Background map. */\r\n  BackgroundMap = -2048,\r\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\r\n  GlobalRealityModel = -1024,\r\n  /** A reality model with a bounded range. */\r\n  RealityModel = 0,\r\n  /** A design model stored in the [IModelDb]($backend). */\r\n  DesignModel = 2048,\r\n}\r\n\r\n/** JSON representation of a [[PlanarClipMaskSettings]].\r\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PlanarClipMaskProps {\r\n  /** Controls how the mask geometry is collected */\r\n  mode: PlanarClipMaskMode;\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryOrElementIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority?: number;\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See PlanarClipMaskSettings.invert */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\r\n * @public\r\n */\r\nexport interface BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See [[PlanarClipMaskSettings.invert]]. */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\r\n * @public\r\n */\r\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  subCategoryIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\r\n * @public\r\n */\r\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  elementIds: Iterable<Id64String>;\r\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\r\n  exclude?: boolean;\r\n  /** @internal */\r\n  subCategoryIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\r\n * @public\r\n */\r\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryIds: Iterable<Id64String>;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\r\n * @public\r\n */\r\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority: number;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  modelIds?: never;\r\n}\r\n\r\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\r\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\r\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\r\n * of a reality model that intersect a design model.\r\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\r\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\r\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\r\n * @public\r\n */\r\nexport class PlanarClipMaskSettings {\r\n  /** Specifies how the mask geometry is produced. */\r\n  public readonly mode: PlanarClipMaskMode;\r\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.\r\n   * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.\r\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\r\n   */\r\n  public readonly modelIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\r\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\r\n   */\r\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\r\n  public readonly priority?: number;\r\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\r\n   If no transparency is defined then the transparencies of the mask elements are used.\r\n   */\r\n  public readonly transparency?: number;\r\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\r\n  public readonly invert: boolean;\r\n  private readonly _modelIds?: CompressedId64Set;\r\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\r\n\r\n  /** The compressed representation of [[modelIds]]. */\r\n  public get compressedModelIds(): CompressedId64Set | undefined {\r\n    return this._modelIds;\r\n  }\r\n\r\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\r\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (!json || undefined === json.mode)\r\n      return this.defaults;\r\n\r\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\r\n  }\r\n\r\n  /** Create a new PlanarClipMaskSettings. */\r\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\r\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\r\n    if (undefined !== args.priority)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\r\n    else if (undefined !== args.subCategoryIds)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\r\n    else if (undefined !== args.elementIds)\r\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\r\n    else\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\r\n  }\r\n\r\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\r\n  public toJSON(): PlanarClipMaskProps {\r\n    const props: PlanarClipMaskProps = { mode: this.mode };\r\n    if (undefined !== this._modelIds)\r\n      props.modelIds = this._modelIds;\r\n\r\n    if (undefined !== this._subCategoryOrElementIds)\r\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\r\n\r\n    if (undefined !== this.priority)\r\n      props.priority = this.priority;\r\n\r\n    if (undefined !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.invert)\r\n      props.invert = true;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if masking is enabled. */\r\n  public get isValid(): boolean {\r\n    return this.mode !== PlanarClipMaskMode.None;\r\n  }\r\n\r\n  public equals(other: PlanarClipMaskSettings): boolean {\r\n    return this.mode === other.mode &&\r\n      this.priority === other.priority &&\r\n      this.transparency === other.transparency &&\r\n      this.invert === other.invert &&\r\n      this._modelIds === other._modelIds &&\r\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\r\n  }\r\n\r\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    return PlanarClipMaskSettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\r\n    this.mode = mode;\r\n    this._modelIds = modelIds;\r\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\r\n    this.priority = priority;\r\n    this.invert = true === invert;\r\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\r\n\r\n    if (modelIds)\r\n      this.modelIds = CompressedId64Set.iterable(modelIds);\r\n\r\n    if (subCategoryOrElementIds)\r\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\r\n  }\r\n\r\n  /** A default PlanarClipMask which masks nothing. */\r\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\r\n}\r\n"]}
+{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAmC,MAAM,qBAAqB,CAAC;AAEzF;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAgBX;AAhBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;OAGG;IACH,mEAAY,CAAA;IACZ,yGAAyG;IACzG,+DAAU,CAAA;IACV,iGAAiG;IACjG,2FAAwB,CAAA;IACxB,2GAA2G;IAC3G,iFAAmB,CAAA;IACnB,qKAAqK;IACrK,iFAAmB,CAAA;AACrB,CAAC,EAhBW,kBAAkB,KAAlB,kBAAkB,QAgB7B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC;AA8FD;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IAuBjC,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;;AAED,oDAAoD;AACtC,+BAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\n\r\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskMode {\r\n  /** No masking. */\r\n  None = 0,\r\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\r\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\r\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\r\n   */\r\n  Priority = 1,\r\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */\r\n  Models = 2,\r\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */\r\n  IncludeSubCategories = 3,\r\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */\r\n  IncludeElements = 4,\r\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */\r\n  ExcludeElements = 5,\r\n}\r\n\r\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\r\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\r\n *  @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskPriority {\r\n  /** Background map. */\r\n  BackgroundMap = -2048,\r\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\r\n  GlobalRealityModel = -1024,\r\n  /** A reality model with a bounded range. */\r\n  RealityModel = 0,\r\n  /** A design model stored in the [IModelDb]($backend). */\r\n  DesignModel = 2048,\r\n}\r\n\r\n/** JSON representation of a [[PlanarClipMaskSettings]].\r\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PlanarClipMaskProps {\r\n  /** Controls how the mask geometry is collected */\r\n  mode: PlanarClipMaskMode;\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryOrElementIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority?: number;\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See PlanarClipMaskSettings.invert */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\r\n * @public\r\n */\r\nexport interface BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See [[PlanarClipMaskSettings.invert]]. */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\r\n * @public\r\n */\r\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  subCategoryIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\r\n * @public\r\n */\r\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  elementIds: Iterable<Id64String>;\r\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\r\n  exclude?: boolean;\r\n  /** @internal */\r\n  subCategoryIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\r\n * @public\r\n */\r\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryIds: Iterable<Id64String>;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\r\n * @public\r\n */\r\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority: number;\r\n  /** @internal */\r\n  exclude?: never;\r\n  /** @internal */\r\n  elementIds?: never;\r\n  /** @internal */\r\n  modelIds?: never;\r\n}\r\n\r\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\r\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\r\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\r\n * of a reality model that intersect a design model.\r\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\r\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\r\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\r\n * @public\r\n */\r\nexport class PlanarClipMaskSettings {\r\n  /** Specifies how the mask geometry is produced. */\r\n  public readonly mode: PlanarClipMaskMode;\r\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.\r\n   * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.\r\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\r\n   */\r\n  public readonly modelIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\r\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\r\n   */\r\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\r\n  public readonly priority?: number;\r\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\r\n   If no transparency is defined then the transparencies of the mask elements are used.\r\n   */\r\n  public readonly transparency?: number;\r\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\r\n  public readonly invert: boolean;\r\n  private readonly _modelIds?: CompressedId64Set;\r\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\r\n\r\n  /** The compressed representation of [[modelIds]]. */\r\n  public get compressedModelIds(): CompressedId64Set | undefined {\r\n    return this._modelIds;\r\n  }\r\n\r\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\r\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (!json || undefined === json.mode)\r\n      return this.defaults;\r\n\r\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\r\n  }\r\n\r\n  /** Create a new PlanarClipMaskSettings. */\r\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\r\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\r\n    if (undefined !== args.priority)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\r\n    else if (undefined !== args.subCategoryIds)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\r\n    else if (undefined !== args.elementIds)\r\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\r\n    else\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\r\n  }\r\n\r\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\r\n  public toJSON(): PlanarClipMaskProps {\r\n    const props: PlanarClipMaskProps = { mode: this.mode };\r\n    if (undefined !== this._modelIds)\r\n      props.modelIds = this._modelIds;\r\n\r\n    if (undefined !== this._subCategoryOrElementIds)\r\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\r\n\r\n    if (undefined !== this.priority)\r\n      props.priority = this.priority;\r\n\r\n    if (undefined !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.invert)\r\n      props.invert = true;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if masking is enabled. */\r\n  public get isValid(): boolean {\r\n    return this.mode !== PlanarClipMaskMode.None;\r\n  }\r\n\r\n  public equals(other: PlanarClipMaskSettings): boolean {\r\n    return this.mode === other.mode &&\r\n      this.priority === other.priority &&\r\n      this.transparency === other.transparency &&\r\n      this.invert === other.invert &&\r\n      this._modelIds === other._modelIds &&\r\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\r\n  }\r\n\r\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    return PlanarClipMaskSettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\r\n    this.mode = mode;\r\n    this._modelIds = modelIds;\r\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\r\n    this.priority = priority;\r\n    this.invert = true === invert;\r\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\r\n\r\n    if (modelIds)\r\n      this.modelIds = CompressedId64Set.iterable(modelIds);\r\n\r\n    if (subCategoryOrElementIds)\r\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\r\n  }\r\n\r\n  /** A default PlanarClipMask which masks nothing. */\r\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\r\n}\r\n"]}