@itwin/core-frontend 3.0.0-dev.99 → 3.1.0-dev.1

package/lib/cjs/SubCategoriesCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"SubCategoriesCache.js","sourceRoot":"","sources":["../../src/SubCategoriesCache.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAiF;AACjF,oDAA2E;AAkB3E,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;AAEjD;;GAEG;AACH,MAAa,kBAAkB;IAK7B,YAAmB,MAAwB;QAJ1B,kBAAa,GAAG,IAAI,GAAG,EAAmB,CAAC;QAC3C,iBAAY,GAAG,IAAI,GAAG,EAAiC,CAAC;QAG1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAAC,CAAC;IAEvE,wIAAwI;IACjI,gBAAgB,CAAC,UAAkB,IAAyB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/G,wHAAwH;IACjH,wBAAwB,CAAC,aAAyB,IAAuC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzJ;;;;OAIG;IACI,IAAI,CAAC,WAAoB;QAC9B,IAAI,OAA4B,CAAC;QACjC,KAAK,MAAM,KAAK,IAAI,mBAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBAC/C,IAAI,SAAS,KAAK,OAAO;oBACvB,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;gBAE9B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACpB;SACF;QAED,IAAI,SAAS,KAAK,OAAO;YACvB,OAAO,SAAS,CAAC;QAEnB,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,MAAkC,EAAE,EAAE;YAC7E,IAAI,SAAS,KAAK,MAAM;gBACtB,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,OAAQ,CAAC,CAAC;YAExC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,kBAAkB,EAAE,OAAO;YAC3B,OAAO;YACP,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE;SAC/B,CAAC;IACJ,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAEM,uBAAuB;QAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAC,IAAU;QACnD,IAAI,KAA8C,CAAC;QACnD,IAAI,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAEO,cAAc,CAAC,MAAiC,EAAE,OAAgB;QACxE,KAAK,MAAM,GAAG,IAAI,MAAM;YACtB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QAEjG,mKAAmK;QACnK,KAAK,MAAM,EAAE,IAAI,OAAO;YACtB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACzD,CAAC;IAEO,GAAG,CAAC,UAAkB,EAAE,aAAqB,EAAE,UAAiC;QACtF,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,GAAG;YACnB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC,CAAC;QAE9D,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;CACF;AAlFD,gDAkFC;AAED;;GAEG;AACH,WAAiB,kBAAkB;IASjC,MAAa,OAAO;QASlB,YAAmB,WAAwB,EAAE,MAAwB,EAAE,qBAAqB,GAAG,GAAG;YAPjF,WAAM,GAAa,EAAE,CAAC;YACtB,YAAO,GAAW,EAAE,CAAC;YAC9B,cAAS,GAAG,KAAK,CAAC;YAClB,mBAAc,GAAG,CAAC,CAAC;YAKzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YAEtB,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC;YAChC,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC5F,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2HAA2H,KAAK,GAAG,CAAC,CAAC;aACvJ;QACH,CAAC;QAXD,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAarE,MAAM,KAAK,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QAEnC,KAAK,CAAC,QAAQ;YACnB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,0CAA0C;gBAC3G,OAAO,SAAS,CAAC;YAEnB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,4BAAc,CAAC,kBAAkB,CAAC,EAAE;oBAC/F,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAgB,CAAC,CAAC;oBACpC,IAAI,IAAI,CAAC,WAAW;wBAClB,OAAO,SAAS,CAAC;iBACpB;aACF;YAAC,MAAM;gBACN,oDAAoD;gBACpD,yIAAyI;gBACzI,2EAA2E;aAC5E;YAED,sEAAsE;YACtE,IAAI,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;gBAC9C,IAAI,IAAI,CAAC,WAAW;oBAClB,OAAO,SAAS,CAAC;;oBAEjB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;aAC1B;YAED,+JAA+J;YAC/J,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;KACF;IAlDY,0BAAO,UAkDnB,CAAA;IAID,MAAa,UAAU;QAIrB,YAAmB,WAAoB,EAAE,IAAe;YACtD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF;IARY,6BAAU,aAQtB,CAAA;IAED;;;;;OAKG;IACH,MAAa,KAAK;QAAlB;YAKY,cAAS,GAAG,KAAK,CAAC;QAkG9B,CAAC;QAhGC;;WAEG;QACI,IAAI,CAAC,KAAyB,EAAE,WAAoB,EAAE,IAAe;YAC1E,IAAI,IAAI,CAAC,SAAS;gBAChB,OAAO;iBACJ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;gBAClC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;;gBAE3C,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,+CAA+C;QACxC,OAAO;YACZ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC/B,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;aAC3B;YAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,IAAW,OAAO;YAChB,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC;QACjE,CAAC;QAEO,WAAW,CAAC,KAAyB,EAAE,WAAoB,EAAE,IAAe;YAClF,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEpC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC/B,+CAA+C;gBAC/C,IAAI,EAAE,CAAC;gBACP,OAAO;aACR;iBAAM;gBACL,yEAAyE;gBACzE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;aACnF;QACH,CAAC;QAEO,cAAc,CAAC,KAAyB,EAAE,KAAiB;YACjE,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;YAEjC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAkB,EAAE,EAAE;gBAChD,IAAI,IAAI,CAAC,SAAS;oBAChB,OAAO;gBAET,uEAAuE;gBACvE,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,SAAS;oBACX,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK;wBACpC,IAAI,EAAE,CAAC;gBAEX,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAE1B,0CAA0C;gBAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;gBACvB,IAAI,SAAS,KAAK,IAAI,EAAE;oBACtB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAC7C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;wBAC/B,yBAAyB;wBACzB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;4BAC3B,IAAI,EAAE,CAAC;qBACV;yBAAM;wBACL,kFAAkF;wBAClF,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;qBAClC;iBACF;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAEO,QAAQ,CAAC,WAAoB,EAAE,IAAe;YACpD,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEpC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE;gBAC5B,2DAA2D;gBAC3D,sJAAsJ;gBACtJ,iIAAiI;gBACjI,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;aACpE;iBAAM;gBACL,mGAAmG;gBACnG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5B,KAAK,MAAM,UAAU,IAAI,mBAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;oBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;aAC1C;QACH,CAAC;KACF;IAvGY,wBAAK,QAuGjB,CAAA;AACH,CAAC,EAvLgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAuLlC","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\r\nimport { assert, Id64, Id64Arg, Id64Set, Id64String } from \"@itwin/core-bentley\";\r\nimport { QueryRowFormat, SubCategoryAppearance } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\n\r\n/** A cancelable paginated request for subcategory information.\r\n * @see SubCategoriesCache\r\n * @internal\r\n */\r\nexport interface SubCategoriesRequest {\r\n  /** The Ids of any categories which were requested but were not yet loaded. */\r\n  readonly missingCategoryIds: Id64Set;\r\n  /** A promise which resolves to true when all of the requested categories have been loaded, or to false if not all categories were loaded.\r\n   * Categories may fail to load if the request is explicitly canceled or if the IModelConnection is closed before all categories are loaded.\r\n   */\r\n  readonly promise: Promise<boolean>;\r\n  /** Cancels the request. */\r\n  cancel(): void;\r\n}\r\n\r\nconst invalidCategoryIdEntry = new Set<string>();\r\n\r\n/** A cache of information about the subcategories contained within an [[IModelConnection]]. It is populated on demand.\r\n * @internal\r\n */\r\nexport class SubCategoriesCache {\r\n  private readonly _byCategoryId = new Map<string, Id64Set>();\r\n  private readonly _appearances = new Map<string, SubCategoryAppearance>();\r\n  private readonly _imodel: IModelConnection;\r\n\r\n  public constructor(imodel: IModelConnection) { this._imodel = imodel; }\r\n\r\n  /** Get the Ids of all subcategories belonging to the category with the specified Id, or undefined if no such information is present. */\r\n  public getSubCategories(categoryId: string): Id64Set | undefined { return this._byCategoryId.get(categoryId); }\r\n\r\n  /** Get the base appearance of the subcategory with the specified Id, or undefined if no such information is present. */\r\n  public getSubCategoryAppearance(subCategoryId: Id64String): SubCategoryAppearance | undefined { return this._appearances.get(subCategoryId.toString()); }\r\n\r\n  /** Request that the subcategory information for all of the specified categories is loaded.\r\n   * If all such information has already been loaded, returns undefined.\r\n   * Otherwise, dispatches an asynchronous request to load those categories which are not already loaded and returns a cancellable request object\r\n   * containing the corresponding promise and the set of categories still to be loaded.\r\n   */\r\n  public load(categoryIds: Id64Arg): SubCategoriesRequest | undefined {\r\n    let missing: Id64Set | undefined;\r\n    for (const catId of Id64.iterable(categoryIds)) {\r\n      if (undefined === this._byCategoryId.get(catId)) {\r\n        if (undefined === missing)\r\n          missing = new Set<string>();\r\n\r\n        missing.add(catId);\r\n      }\r\n    }\r\n\r\n    if (undefined === missing)\r\n      return undefined;\r\n\r\n    const request = new SubCategoriesCache.Request(missing, this._imodel);\r\n    const promise = request.dispatch().then((result?: SubCategoriesCache.Result) => {\r\n      if (undefined !== result)\r\n        this.processResults(result, missing!);\r\n\r\n      return !request.wasCanceled;\r\n    });\r\n\r\n    return {\r\n      missingCategoryIds: missing,\r\n      promise,\r\n      cancel: () => request.cancel(),\r\n    };\r\n  }\r\n\r\n  public clear(): void {\r\n    this._byCategoryId.clear();\r\n    this._appearances.clear();\r\n  }\r\n\r\n  public onIModelConnectionClose(): void {\r\n    this.clear();\r\n  }\r\n\r\n  private static createSubCategoryAppearance(json?: any) {\r\n    let props: SubCategoryAppearance.Props | undefined;\r\n    if (\"string\" === typeof json && 0 < json.length)\r\n      props = JSON.parse(json);\r\n\r\n    return new SubCategoryAppearance(props);\r\n  }\r\n\r\n  private processResults(result: SubCategoriesCache.Result, missing: Id64Set): void {\r\n    for (const row of result)\r\n      this.add(row.parentId, row.id, SubCategoriesCache.createSubCategoryAppearance(row.appearance));\r\n\r\n    // Ensure that any category Ids which returned no results (e.g., non-existent category, invalid Id, etc) are still recorded so they are not repeatedly re-requested\r\n    for (const id of missing)\r\n      if (undefined === this._byCategoryId.get(id))\r\n        this._byCategoryId.set(id, invalidCategoryIdEntry);\r\n  }\r\n\r\n  private add(categoryId: string, subCategoryId: string, appearance: SubCategoryAppearance) {\r\n    let set = this._byCategoryId.get(categoryId);\r\n    if (undefined === set)\r\n      this._byCategoryId.set(categoryId, set = new Set<string>());\r\n\r\n    set.add(subCategoryId);\r\n    this._appearances.set(subCategoryId, appearance);\r\n  }\r\n}\r\n\r\n/** This namespace and the types within it are exported strictly for use in tests.\r\n * @internal\r\n */\r\nexport namespace SubCategoriesCache { // eslint-disable-line no-redeclare\r\n  export interface ResultRow {\r\n    parentId: Id64String;\r\n    id: Id64String;\r\n    appearance: SubCategoryAppearance.Props;\r\n  }\r\n\r\n  export type Result = ResultRow[];\r\n\r\n  export class Request {\r\n    private readonly _imodel: IModelConnection;\r\n    private readonly _ecsql: string[] = [];\r\n    private readonly _result: Result = [];\r\n    private _canceled = false;\r\n    private _curECSqlIndex = 0;\r\n\r\n    public get wasCanceled() { return this._canceled || this._imodel.isClosed; }\r\n\r\n    public constructor(categoryIds: Set<string>, imodel: IModelConnection, maxCategoriesPerQuery = 200) {\r\n      this._imodel = imodel;\r\n\r\n      const catIds = [...categoryIds];\r\n      while (catIds.length !== 0) {\r\n        const end = (catIds.length > maxCategoriesPerQuery) ? maxCategoriesPerQuery : catIds.length;\r\n        const where = catIds.splice(0, end).join(\",\");\r\n        this._ecsql.push(`SELECT ECInstanceId as id, Parent.Id as parentId, Properties as appearance FROM BisCore.SubCategory WHERE Parent.Id IN (${where})`);\r\n      }\r\n    }\r\n\r\n    public cancel() { this._canceled = true; }\r\n\r\n    public async dispatch(): Promise<Result | undefined> {\r\n      if (this.wasCanceled || this._curECSqlIndex >= this._ecsql.length) // handle case of empty category Id set...\r\n        return undefined;\r\n\r\n      try {\r\n        const ecsql = this._ecsql[this._curECSqlIndex];\r\n        for await (const row of this._imodel.query(ecsql, undefined, QueryRowFormat.UseJsPropertyNames)) {\r\n          this._result.push(row as ResultRow);\r\n          if (this.wasCanceled)\r\n            return undefined;\r\n        }\r\n      } catch {\r\n        // ###TODO: detect cases in which retry is warranted\r\n        // Note that currently, if we succeed in obtaining some pages of results and fail to retrieve another page, we will end up processing the\r\n        // incomplete results. Since we're not retrying, that's the best we can do.\r\n      }\r\n\r\n      // Finished with current ECSql query. Dispatch the next if one exists.\r\n      if (++this._curECSqlIndex < this._ecsql.length) {\r\n        if (this.wasCanceled)\r\n          return undefined;\r\n        else\r\n          return this.dispatch();\r\n      }\r\n\r\n      // Even if we were canceled, we've retrieved all the rows. Might as well process them to prevent another request for some of the same rows from being enqueued.\r\n      return this._result;\r\n    }\r\n  }\r\n\r\n  export type QueueFunc = () => void;\r\n\r\n  export class QueueEntry {\r\n    public readonly categoryIds: Id64Set;\r\n    public readonly funcs: QueueFunc[];\r\n\r\n    public constructor(categoryIds: Id64Set, func: QueueFunc) {\r\n      this.categoryIds = categoryIds;\r\n      this.funcs = [func];\r\n    }\r\n  }\r\n\r\n  /** A \"queue\" of SubCategoriesRequests, which consists of between 0 and 2 entries. Each entry specifies the set of category IDs to be loaded and a list of functions to be executed\r\n   * when loading is completed. This is used to enforce ordering of operations upon subcategories despite the need to asynchronously load them. It incidentally also provides an\r\n   * opportunity to reduce the number of backend requests by batching consecutive requests.\r\n   * Chiefly used by [[Viewport]].\r\n   * @internal\r\n   */\r\n  export class Queue {\r\n    /* NB: Members marked protected for use in tests only. */\r\n    protected _current?: QueueEntry;\r\n    protected _next?: QueueEntry;\r\n    protected _request?: SubCategoriesRequest;\r\n    protected _disposed = false;\r\n\r\n    /** Push a request onto the queue. The requested categories will be loaded if necessary, and then\r\n     * the supplied function will be invoked. Any previously-pushed requests are guaranteed to be processed before this one.\r\n     */\r\n    public push(cache: SubCategoriesCache, categoryIds: Id64Arg, func: QueueFunc): void {\r\n      if (this._disposed)\r\n        return;\r\n      else if (undefined === this._current)\r\n        this.pushCurrent(cache, categoryIds, func);\r\n      else\r\n        this.pushNext(categoryIds, func);\r\n    }\r\n\r\n    /** Cancel all requests and empty the queue. */\r\n    public dispose(): void {\r\n      if (undefined !== this._request) {\r\n        assert(undefined !== this._current);\r\n        this._request.cancel();\r\n        this._request = undefined;\r\n      }\r\n\r\n      this._current = this._next = undefined;\r\n      this._disposed = true;\r\n    }\r\n\r\n    public get isEmpty(): boolean {\r\n      return undefined === this._current && undefined === this._next;\r\n    }\r\n\r\n    private pushCurrent(cache: SubCategoriesCache, categoryIds: Id64Arg, func: QueueFunc): void {\r\n      assert(undefined === this._next);\r\n      assert(undefined === this._current);\r\n      assert(undefined === this._request);\r\n\r\n      this._request = cache.load(categoryIds);\r\n      if (undefined === this._request) {\r\n        // All requested categories are already loaded.\r\n        func();\r\n        return;\r\n      } else {\r\n        // We need to load the requested categories before invoking the function.\r\n        this.processCurrent(cache, new QueueEntry(Id64.toIdSet(categoryIds, true), func));\r\n      }\r\n    }\r\n\r\n    private processCurrent(cache: SubCategoriesCache, entry: QueueEntry): void {\r\n      assert(undefined !== this._request);\r\n      assert(undefined === this._current);\r\n      assert(undefined === this._next);\r\n\r\n      this._current = entry;\r\n      this._request.promise.then((completed: boolean) => { // eslint-disable-line @typescript-eslint/no-floating-promises\r\n        if (this._disposed)\r\n          return;\r\n\r\n        // Invoke all the functions which were awaiting this set of categories.\r\n        assert(undefined !== this._current);\r\n        if (completed)\r\n          for (const func of this._current.funcs)\r\n            func();\r\n\r\n        this._request = undefined;\r\n        this._current = undefined;\r\n\r\n        // If we have more requests, process them.\r\n        const next = this._next;\r\n        this._next = undefined;\r\n        if (undefined !== next) {\r\n          this._request = cache.load(next.categoryIds);\r\n          if (undefined === this._request) {\r\n            // All categories loaded.\r\n            for (const func of next.funcs)\r\n              func();\r\n          } else {\r\n            // We need to load the requested categories before invoking the pending functions.\r\n            this.processCurrent(cache, next);\r\n          }\r\n        }\r\n      });\r\n    }\r\n\r\n    private pushNext(categoryIds: Id64Arg, func: QueueFunc): void {\r\n      assert(undefined !== this._current);\r\n      assert(undefined !== this._request);\r\n\r\n      if (undefined === this._next) {\r\n        // We have a request currently in process and none pending.\r\n        // We could potentially determine that this request doesn't require any categories that are not already loaded or being loaded by the current request.\r\n        // But we will find that out (synchronously) when current request completes, unless more requests come in. Probably not worth it.\r\n        this._next = new QueueEntry(Id64.toIdSet(categoryIds, true), func);\r\n      } else {\r\n        // We have a request currently in process, and one or more pending. Append this one to the pending.\r\n        this._next.funcs.push(func);\r\n        for (const categoryId of Id64.iterable(categoryIds))\r\n          this._next.categoryIds.add(categoryId);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SubCategoriesCache.js","sourceRoot":"","sources":["../../src/SubCategoriesCache.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAiF;AACjF,oDAA2E;AAkB3E,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;AAEjD;;GAEG;AACH,MAAa,kBAAkB;IAK7B,YAAmB,MAAwB;QAJ1B,kBAAa,GAAG,IAAI,GAAG,EAAmB,CAAC;QAC3C,iBAAY,GAAG,IAAI,GAAG,EAAiC,CAAC;QAG1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAAC,CAAC;IAEvE,wIAAwI;IACjI,gBAAgB,CAAC,UAAkB,IAAyB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/G,wHAAwH;IACjH,wBAAwB,CAAC,aAAyB,IAAuC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzJ;;;;OAIG;IACI,IAAI,CAAC,WAAoB;QAC9B,IAAI,OAA4B,CAAC;QACjC,KAAK,MAAM,KAAK,IAAI,mBAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBAC/C,IAAI,SAAS,KAAK,OAAO;oBACvB,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;gBAE9B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACpB;SACF;QAED,IAAI,SAAS,KAAK,OAAO;YACvB,OAAO,SAAS,CAAC;QAEnB,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,MAAkC,EAAE,EAAE;YAC7E,IAAI,SAAS,KAAK,MAAM;gBACtB,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,OAAQ,CAAC,CAAC;YAExC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,kBAAkB,EAAE,OAAO;YAC3B,OAAO;YACP,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE;SAC/B,CAAC;IACJ,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAEM,uBAAuB;QAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAC,IAAU;QACnD,IAAI,KAA8C,CAAC;QACnD,IAAI,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAEO,cAAc,CAAC,MAAiC,EAAE,OAAgB;QACxE,KAAK,MAAM,GAAG,IAAI,MAAM;YACtB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QAEjG,mKAAmK;QACnK,KAAK,MAAM,EAAE,IAAI,OAAO;YACtB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACzD,CAAC;IAEO,GAAG,CAAC,UAAkB,EAAE,aAAqB,EAAE,UAAiC;QACtF,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,GAAG;YACnB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC,CAAC;QAE9D,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;CACF;AAlFD,gDAkFC;AAED;;GAEG;AACH,WAAiB,kBAAkB;IASjC,MAAa,OAAO;QASlB,YAAmB,WAAwB,EAAE,MAAwB,EAAE,qBAAqB,GAAG,GAAG;YAPjF,WAAM,GAAa,EAAE,CAAC;YACtB,YAAO,GAAW,EAAE,CAAC;YAC9B,cAAS,GAAG,KAAK,CAAC;YAClB,mBAAc,GAAG,CAAC,CAAC;YAKzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YAEtB,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC;YAChC,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC5F,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2HAA2H,KAAK,GAAG,CAAC,CAAC;aACvJ;QACH,CAAC;QAXD,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAarE,MAAM,KAAK,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QAEnC,KAAK,CAAC,QAAQ;YACnB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,0CAA0C;gBAC3G,OAAO,SAAS,CAAC;YAEnB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,4BAAc,CAAC,kBAAkB,EAAE,CAAC,EAAE;oBAC9G,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAgB,CAAC,CAAC;oBACpC,IAAI,IAAI,CAAC,WAAW;wBAClB,OAAO,SAAS,CAAC;iBACpB;aACF;YAAC,MAAM;gBACN,oDAAoD;gBACpD,yIAAyI;gBACzI,2EAA2E;aAC5E;YAED,sEAAsE;YACtE,IAAI,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;gBAC9C,IAAI,IAAI,CAAC,WAAW;oBAClB,OAAO,SAAS,CAAC;;oBAEjB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;aAC1B;YAED,+JAA+J;YAC/J,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;KACF;IAlDY,0BAAO,UAkDnB,CAAA;IAID,MAAa,UAAU;QAIrB,YAAmB,WAAoB,EAAE,IAAe;YACtD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF;IARY,6BAAU,aAQtB,CAAA;IAED;;;;;OAKG;IACH,MAAa,KAAK;QAAlB;YAKY,cAAS,GAAG,KAAK,CAAC;QAkG9B,CAAC;QAhGC;;WAEG;QACI,IAAI,CAAC,KAAyB,EAAE,WAAoB,EAAE,IAAe;YAC1E,IAAI,IAAI,CAAC,SAAS;gBAChB,OAAO;iBACJ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;gBAClC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;;gBAE3C,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,+CAA+C;QACxC,OAAO;YACZ,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC/B,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;aAC3B;YAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,IAAW,OAAO;YAChB,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC;QACjE,CAAC;QAEO,WAAW,CAAC,KAAyB,EAAE,WAAoB,EAAE,IAAe;YAClF,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEpC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC/B,+CAA+C;gBAC/C,IAAI,EAAE,CAAC;gBACP,OAAO;aACR;iBAAM;gBACL,yEAAyE;gBACzE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;aACnF;QACH,CAAC;QAEO,cAAc,CAAC,KAAyB,EAAE,KAAiB;YACjE,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC;YAEjC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAkB,EAAE,EAAE;gBAChD,IAAI,IAAI,CAAC,SAAS;oBAChB,OAAO;gBAET,uEAAuE;gBACvE,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,SAAS;oBACX,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK;wBACpC,IAAI,EAAE,CAAC;gBAEX,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAE1B,0CAA0C;gBAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;gBACvB,IAAI,SAAS,KAAK,IAAI,EAAE;oBACtB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAC7C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;wBAC/B,yBAAyB;wBACzB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;4BAC3B,IAAI,EAAE,CAAC;qBACV;yBAAM;wBACL,kFAAkF;wBAClF,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;qBAClC;iBACF;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAEO,QAAQ,CAAC,WAAoB,EAAE,IAAe;YACpD,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEpC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE;gBAC5B,2DAA2D;gBAC3D,sJAAsJ;gBACtJ,iIAAiI;gBACjI,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;aACpE;iBAAM;gBACL,mGAAmG;gBACnG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5B,KAAK,MAAM,UAAU,IAAI,mBAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;oBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;aAC1C;QACH,CAAC;KACF;IAvGY,wBAAK,QAuGjB,CAAA;AACH,CAAC,EAvLgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAuLlC","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\r\nimport { assert, Id64, Id64Arg, Id64Set, Id64String } from \"@itwin/core-bentley\";\r\nimport { QueryRowFormat, SubCategoryAppearance } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\n\r\n/** A cancelable paginated request for subcategory information.\r\n * @see SubCategoriesCache\r\n * @internal\r\n */\r\nexport interface SubCategoriesRequest {\r\n  /** The Ids of any categories which were requested but were not yet loaded. */\r\n  readonly missingCategoryIds: Id64Set;\r\n  /** A promise which resolves to true when all of the requested categories have been loaded, or to false if not all categories were loaded.\r\n   * Categories may fail to load if the request is explicitly canceled or if the IModelConnection is closed before all categories are loaded.\r\n   */\r\n  readonly promise: Promise<boolean>;\r\n  /** Cancels the request. */\r\n  cancel(): void;\r\n}\r\n\r\nconst invalidCategoryIdEntry = new Set<string>();\r\n\r\n/** A cache of information about the subcategories contained within an [[IModelConnection]]. It is populated on demand.\r\n * @internal\r\n */\r\nexport class SubCategoriesCache {\r\n  private readonly _byCategoryId = new Map<string, Id64Set>();\r\n  private readonly _appearances = new Map<string, SubCategoryAppearance>();\r\n  private readonly _imodel: IModelConnection;\r\n\r\n  public constructor(imodel: IModelConnection) { this._imodel = imodel; }\r\n\r\n  /** Get the Ids of all subcategories belonging to the category with the specified Id, or undefined if no such information is present. */\r\n  public getSubCategories(categoryId: string): Id64Set | undefined { return this._byCategoryId.get(categoryId); }\r\n\r\n  /** Get the base appearance of the subcategory with the specified Id, or undefined if no such information is present. */\r\n  public getSubCategoryAppearance(subCategoryId: Id64String): SubCategoryAppearance | undefined { return this._appearances.get(subCategoryId.toString()); }\r\n\r\n  /** Request that the subcategory information for all of the specified categories is loaded.\r\n   * If all such information has already been loaded, returns undefined.\r\n   * Otherwise, dispatches an asynchronous request to load those categories which are not already loaded and returns a cancellable request object\r\n   * containing the corresponding promise and the set of categories still to be loaded.\r\n   */\r\n  public load(categoryIds: Id64Arg): SubCategoriesRequest | undefined {\r\n    let missing: Id64Set | undefined;\r\n    for (const catId of Id64.iterable(categoryIds)) {\r\n      if (undefined === this._byCategoryId.get(catId)) {\r\n        if (undefined === missing)\r\n          missing = new Set<string>();\r\n\r\n        missing.add(catId);\r\n      }\r\n    }\r\n\r\n    if (undefined === missing)\r\n      return undefined;\r\n\r\n    const request = new SubCategoriesCache.Request(missing, this._imodel);\r\n    const promise = request.dispatch().then((result?: SubCategoriesCache.Result) => {\r\n      if (undefined !== result)\r\n        this.processResults(result, missing!);\r\n\r\n      return !request.wasCanceled;\r\n    });\r\n\r\n    return {\r\n      missingCategoryIds: missing,\r\n      promise,\r\n      cancel: () => request.cancel(),\r\n    };\r\n  }\r\n\r\n  public clear(): void {\r\n    this._byCategoryId.clear();\r\n    this._appearances.clear();\r\n  }\r\n\r\n  public onIModelConnectionClose(): void {\r\n    this.clear();\r\n  }\r\n\r\n  private static createSubCategoryAppearance(json?: any) {\r\n    let props: SubCategoryAppearance.Props | undefined;\r\n    if (\"string\" === typeof json && 0 < json.length)\r\n      props = JSON.parse(json);\r\n\r\n    return new SubCategoryAppearance(props);\r\n  }\r\n\r\n  private processResults(result: SubCategoriesCache.Result, missing: Id64Set): void {\r\n    for (const row of result)\r\n      this.add(row.parentId, row.id, SubCategoriesCache.createSubCategoryAppearance(row.appearance));\r\n\r\n    // Ensure that any category Ids which returned no results (e.g., non-existent category, invalid Id, etc) are still recorded so they are not repeatedly re-requested\r\n    for (const id of missing)\r\n      if (undefined === this._byCategoryId.get(id))\r\n        this._byCategoryId.set(id, invalidCategoryIdEntry);\r\n  }\r\n\r\n  private add(categoryId: string, subCategoryId: string, appearance: SubCategoryAppearance) {\r\n    let set = this._byCategoryId.get(categoryId);\r\n    if (undefined === set)\r\n      this._byCategoryId.set(categoryId, set = new Set<string>());\r\n\r\n    set.add(subCategoryId);\r\n    this._appearances.set(subCategoryId, appearance);\r\n  }\r\n}\r\n\r\n/** This namespace and the types within it are exported strictly for use in tests.\r\n * @internal\r\n */\r\nexport namespace SubCategoriesCache { // eslint-disable-line no-redeclare\r\n  export interface ResultRow {\r\n    parentId: Id64String;\r\n    id: Id64String;\r\n    appearance: SubCategoryAppearance.Props;\r\n  }\r\n\r\n  export type Result = ResultRow[];\r\n\r\n  export class Request {\r\n    private readonly _imodel: IModelConnection;\r\n    private readonly _ecsql: string[] = [];\r\n    private readonly _result: Result = [];\r\n    private _canceled = false;\r\n    private _curECSqlIndex = 0;\r\n\r\n    public get wasCanceled() { return this._canceled || this._imodel.isClosed; }\r\n\r\n    public constructor(categoryIds: Set<string>, imodel: IModelConnection, maxCategoriesPerQuery = 200) {\r\n      this._imodel = imodel;\r\n\r\n      const catIds = [...categoryIds];\r\n      while (catIds.length !== 0) {\r\n        const end = (catIds.length > maxCategoriesPerQuery) ? maxCategoriesPerQuery : catIds.length;\r\n        const where = catIds.splice(0, end).join(\",\");\r\n        this._ecsql.push(`SELECT ECInstanceId as id, Parent.Id as parentId, Properties as appearance FROM BisCore.SubCategory WHERE Parent.Id IN (${where})`);\r\n      }\r\n    }\r\n\r\n    public cancel() { this._canceled = true; }\r\n\r\n    public async dispatch(): Promise<Result | undefined> {\r\n      if (this.wasCanceled || this._curECSqlIndex >= this._ecsql.length) // handle case of empty category Id set...\r\n        return undefined;\r\n\r\n      try {\r\n        const ecsql = this._ecsql[this._curECSqlIndex];\r\n        for await (const row of this._imodel.query(ecsql, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames })) {\r\n          this._result.push(row as ResultRow);\r\n          if (this.wasCanceled)\r\n            return undefined;\r\n        }\r\n      } catch {\r\n        // ###TODO: detect cases in which retry is warranted\r\n        // Note that currently, if we succeed in obtaining some pages of results and fail to retrieve another page, we will end up processing the\r\n        // incomplete results. Since we're not retrying, that's the best we can do.\r\n      }\r\n\r\n      // Finished with current ECSql query. Dispatch the next if one exists.\r\n      if (++this._curECSqlIndex < this._ecsql.length) {\r\n        if (this.wasCanceled)\r\n          return undefined;\r\n        else\r\n          return this.dispatch();\r\n      }\r\n\r\n      // Even if we were canceled, we've retrieved all the rows. Might as well process them to prevent another request for some of the same rows from being enqueued.\r\n      return this._result;\r\n    }\r\n  }\r\n\r\n  export type QueueFunc = () => void;\r\n\r\n  export class QueueEntry {\r\n    public readonly categoryIds: Id64Set;\r\n    public readonly funcs: QueueFunc[];\r\n\r\n    public constructor(categoryIds: Id64Set, func: QueueFunc) {\r\n      this.categoryIds = categoryIds;\r\n      this.funcs = [func];\r\n    }\r\n  }\r\n\r\n  /** A \"queue\" of SubCategoriesRequests, which consists of between 0 and 2 entries. Each entry specifies the set of category IDs to be loaded and a list of functions to be executed\r\n   * when loading is completed. This is used to enforce ordering of operations upon subcategories despite the need to asynchronously load them. It incidentally also provides an\r\n   * opportunity to reduce the number of backend requests by batching consecutive requests.\r\n   * Chiefly used by [[Viewport]].\r\n   * @internal\r\n   */\r\n  export class Queue {\r\n    /* NB: Members marked protected for use in tests only. */\r\n    protected _current?: QueueEntry;\r\n    protected _next?: QueueEntry;\r\n    protected _request?: SubCategoriesRequest;\r\n    protected _disposed = false;\r\n\r\n    /** Push a request onto the queue. The requested categories will be loaded if necessary, and then\r\n     * the supplied function will be invoked. Any previously-pushed requests are guaranteed to be processed before this one.\r\n     */\r\n    public push(cache: SubCategoriesCache, categoryIds: Id64Arg, func: QueueFunc): void {\r\n      if (this._disposed)\r\n        return;\r\n      else if (undefined === this._current)\r\n        this.pushCurrent(cache, categoryIds, func);\r\n      else\r\n        this.pushNext(categoryIds, func);\r\n    }\r\n\r\n    /** Cancel all requests and empty the queue. */\r\n    public dispose(): void {\r\n      if (undefined !== this._request) {\r\n        assert(undefined !== this._current);\r\n        this._request.cancel();\r\n        this._request = undefined;\r\n      }\r\n\r\n      this._current = this._next = undefined;\r\n      this._disposed = true;\r\n    }\r\n\r\n    public get isEmpty(): boolean {\r\n      return undefined === this._current && undefined === this._next;\r\n    }\r\n\r\n    private pushCurrent(cache: SubCategoriesCache, categoryIds: Id64Arg, func: QueueFunc): void {\r\n      assert(undefined === this._next);\r\n      assert(undefined === this._current);\r\n      assert(undefined === this._request);\r\n\r\n      this._request = cache.load(categoryIds);\r\n      if (undefined === this._request) {\r\n        // All requested categories are already loaded.\r\n        func();\r\n        return;\r\n      } else {\r\n        // We need to load the requested categories before invoking the function.\r\n        this.processCurrent(cache, new QueueEntry(Id64.toIdSet(categoryIds, true), func));\r\n      }\r\n    }\r\n\r\n    private processCurrent(cache: SubCategoriesCache, entry: QueueEntry): void {\r\n      assert(undefined !== this._request);\r\n      assert(undefined === this._current);\r\n      assert(undefined === this._next);\r\n\r\n      this._current = entry;\r\n      this._request.promise.then((completed: boolean) => { // eslint-disable-line @typescript-eslint/no-floating-promises\r\n        if (this._disposed)\r\n          return;\r\n\r\n        // Invoke all the functions which were awaiting this set of categories.\r\n        assert(undefined !== this._current);\r\n        if (completed)\r\n          for (const func of this._current.funcs)\r\n            func();\r\n\r\n        this._request = undefined;\r\n        this._current = undefined;\r\n\r\n        // If we have more requests, process them.\r\n        const next = this._next;\r\n        this._next = undefined;\r\n        if (undefined !== next) {\r\n          this._request = cache.load(next.categoryIds);\r\n          if (undefined === this._request) {\r\n            // All categories loaded.\r\n            for (const func of next.funcs)\r\n              func();\r\n          } else {\r\n            // We need to load the requested categories before invoking the pending functions.\r\n            this.processCurrent(cache, next);\r\n          }\r\n        }\r\n      });\r\n    }\r\n\r\n    private pushNext(categoryIds: Id64Arg, func: QueueFunc): void {\r\n      assert(undefined !== this._current);\r\n      assert(undefined !== this._request);\r\n\r\n      if (undefined === this._next) {\r\n        // We have a request currently in process and none pending.\r\n        // We could potentially determine that this request doesn't require any categories that are not already loaded or being loaded by the current request.\r\n        // But we will find that out (synchronously) when current request completes, unless more requests come in. Probably not worth it.\r\n        this._next = new QueueEntry(Id64.toIdSet(categoryIds, true), func);\r\n      } else {\r\n        // We have a request currently in process, and one or more pending. Append this one to the pending.\r\n        this._next.funcs.push(func);\r\n        for (const categoryId of Id64.iterable(categoryIds))\r\n          this._next.categoryIds.add(categoryId);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/Tiles.d.ts

@@ -11,7 +11,11 @@ import { TileTree, TileTreeOwner, TileTreeSupplier } from "./tile/internal";
  * @see [[IModelConnection.tiles]].
  * @public
  */
-export declare class Tiles {
+export declare class Tiles implements Iterable<{
+    supplier: TileTreeSupplier;
+    id: any;
+    owner: TileTreeOwner;
+}> {
     private _iModel;
     private readonly _treesBySupplier;
     private _disposed;
@@ -47,6 +51,12 @@ export declare class Tiles {
     dropSupplier(supplier: TileTreeSupplier): void;
     /** Invokes a function on each extant TileTreeOwner. */
     forEachTreeOwner(func: (owner: TileTreeOwner) => void): void;
+    /** Iterate over all of the TileTreeOwners. */
+    [Symbol.iterator](): Iterator<{
+        supplier: TileTreeSupplier;
+        id: any;
+        owner: TileTreeOwner;
+    }>;
     /** Obtain the TileTreeOwners supplied by the specified supplier. */
     getTreeOwnersForSupplier(supplier: TileTreeSupplier): Iterable<{
         id: any;

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

@@ -1 +1 @@
-{"version":3,"file":"Tiles.d.ts","sourceRoot":"","sources":["../../src/Tiles.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAuB,SAAS,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAE5G,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAsB,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAyDhG;;;;;;GAMG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2D;IAC5F,OAAO,CAAC,SAAS,CAAS;IAE1B,gBAAgB;IAChB,IAAW,UAAU,YAA6B;IAElD,gBAAgB;gBACJ,MAAM,EAAE,gBAAgB;IAiBpC,gBAAgB;IACT,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACI,KAAK,IAAI,IAAI;IAOpB,gBAAgB;IACH,cAAc,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E,OAAO,CAAC,iCAAiC;IASzC;;;;;;OAMG;IACU,uBAAuB,CAAC,qBAAqB,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;YAIxE,eAAe;IAS7B,OAAO,CAAC,gBAAgB;IASxB;;;OAGG;IACI,gBAAgB,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,GAAG,aAAa;IAgB3E,8HAA8H;IACvH,YAAY,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IASrD,uDAAuD;IAChD,gBAAgB,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKnE,oEAAoE;IAC7D,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,QAAQ,CAAC;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAYxG;;OAEG;IACI,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI;CAYpE"}
+{"version":3,"file":"Tiles.d.ts","sourceRoot":"","sources":["../../src/Tiles.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAuB,SAAS,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAE5G,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAsB,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAyDhG;;;;;;GAMG;AACH,qBAAa,KAAM,YAAW,QAAQ,CAAC;IAAE,QAAQ,EAAE,gBAAgB,CAAC;IAAC,EAAE,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,aAAa,CAAA;CAAE,CAAC;IACnG,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2D;IAC5F,OAAO,CAAC,SAAS,CAAS;IAE1B,gBAAgB;IAChB,IAAW,UAAU,YAA6B;IAElD,gBAAgB;gBACJ,MAAM,EAAE,gBAAgB;IAiBpC,gBAAgB;IACT,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACI,KAAK,IAAI,IAAI;IAOpB,gBAAgB;IACH,cAAc,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E,OAAO,CAAC,iCAAiC;IASzC;;;;;;OAMG;IACU,uBAAuB,CAAC,qBAAqB,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;YAIxE,eAAe;IAS7B,OAAO,CAAC,gBAAgB;IASxB;;;OAGG;IACI,gBAAgB,CAAC,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,GAAG,aAAa;IAgB3E,8HAA8H;IACvH,YAAY,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IASrD,uDAAuD;IAChD,gBAAgB,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAKnE,8CAA8C;IACrC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC;QAAE,QAAQ,EAAE,gBAAgB,CAAC;QAAC,EAAE,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAOrG,oEAAoE;IAC7D,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,QAAQ,CAAC;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAYxG;;OAEG;IACI,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI;CAYpE"}

package/lib/cjs/Tiles.js

@@ -158,6 +158,13 @@ class Tiles {
         for (const dict of this._treesBySupplier.values())
             dict.forEach((_key, value) => func(value));
     }
+    /** Iterate over all of the TileTreeOwners. */
+    *[Symbol.iterator]() {
+        for (const [supplier, dict] of this._treesBySupplier) {
+            for (const entry of dict)
+                yield { supplier, id: entry.key, owner: entry.value };
+        }
+    }
     /** Obtain the TileTreeOwners supplied by the specified supplier. */
     getTreeOwnersForSupplier(supplier) {
         function* iterator(trees) {

package/lib/cjs/Tiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tiles.js","sourceRoot":"","sources":["../../src/Tiles.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4G;AAC5G,2CAAwC;AAExC,8CAAgG;AAEhG,MAAM,SAAS;IAYb,YAAmB,EAAO,EAAE,QAA0B,EAAE,MAAwB;QAVxE,gBAAW,GAAuB,6BAAkB,CAAC,SAAS,CAAC;QAWrE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IARD,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACtE,IAAW,UAAU,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,IAAW,MAAM,KAAuB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAQvD,IAAI;QACT,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,8DAA8D;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,SAAS,GAAG,IAAA,sBAAO,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,6BAAkB,CAAC,SAAS,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,IAAI,6BAAkB,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;YAClD,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,6BAAkB,CAAC,OAAO,CAAC;QAC9C,IAAI,IAA0B,CAAC;QAC/B,IAAI,SAA6B,CAAC;QAClC,IAAI;YACF,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAClE,SAAS,GAAG,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAkB,CAAC,QAAQ,CAAC;SAChI;QAAC,OAAO,GAAQ,EAAE;YACjB,SAAS,GAAG,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,6BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,6BAAkB,CAAC,QAAQ,CAAC;SAC9I;QAED,IAAI,6BAAkB,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW,EAAE;YACnD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YAC7B,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACrD;IACH,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAa,KAAK;IAQhB,gBAAgB;IAChB,YAAY,MAAwB;QAPnB,qBAAgB,GAAG,IAAI,GAAG,EAAgD,CAAC;QACpF,cAAS,GAAG,KAAK,CAAC;QAOxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE;gBACnD,IAAI,QAAQ,CAAC,eAAe;oBAC1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QAEH,oEAAoE;QACpE,MAAM,CAAC,uBAAuB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;YACpD,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;gBACzD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAnBD,gBAAgB;IAChB,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAoBlD,gBAAgB;IACT,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB;YAC1C,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAExD,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,cAAc,CAAC,QAA+B;QACzD,OAAO,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAEO,iCAAiC,CAAC,qBAAiC;QACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;YACjD,IAAI,QAAQ,CAAC,yBAAyB;gBACpC,QAAQ,CAAC,yBAAyB,CAAC,QAAQ,EAAE,qBAAqB,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,uBAAuB,CAAC,qBAAiC;QACpE,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,iCAAiC,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAC7F,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,QAAyB;QACrD,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,qBAAS,CAAC,WAAW,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IAEO,gBAAgB;QACtB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;YACjD,IAAI,QAAQ,CAAC,gBAAgB;gBAC3B,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,EAAO,EAAE,QAA0B;QACzD,IAAI,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,KAAK,GAAG,IAAI,yBAAU,CAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAC5F,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;SAC5C;QAED,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,GAAG,IAAI,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACrB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8HAA8H;IACvH,YAAY,CAAC,QAA0B;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO;QAET,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,uDAAuD;IAChD,gBAAgB,CAAC,IAAoC;QAC1D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC/C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,oEAAoE;IAC7D,wBAAwB,CAAC,QAA0B;QACxD,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAA6C;YAC9D,IAAI,KAAK;gBACP,KAAK,MAAM,KAAK,IAAI,KAAK;oBACvB,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAClD,CAAC;QAED,OAAO;YACL,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SACvE,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAsB,EAAE,OAAuB;QAC1D,0KAA0K;QAC1K,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;gBAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;gBAC5B,IAAI,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY;oBACnF,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;wBAC7C,KAAK,CAAC,OAAO,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;CACF;AArJD,sBAqJC","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 IModelConnection\r\n */\r\n\r\nimport { BeTimePoint, Dictionary, dispose, Id64Array, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { TileTree, TileTreeLoadStatus, TileTreeOwner, TileTreeSupplier } from \"./tile/internal\";\r\n\r\nclass TreeOwner implements TileTreeOwner {\r\n  private _tileTree?: TileTree;\r\n  private _loadStatus: TileTreeLoadStatus = TileTreeLoadStatus.NotLoaded;\r\n  private readonly _supplier: TileTreeSupplier;\r\n  private readonly _iModel: IModelConnection;\r\n\r\n  public readonly id: any;\r\n\r\n  public get tileTree(): TileTree | undefined { return this._tileTree; }\r\n  public get loadStatus(): TileTreeLoadStatus { return this._loadStatus; }\r\n  public get iModel(): IModelConnection { return this._iModel; }\r\n\r\n  public constructor(id: any, supplier: TileTreeSupplier, iModel: IModelConnection) {\r\n    this.id = id;\r\n    this._supplier = supplier;\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public load(): TileTree | undefined {\r\n    this._load(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    return this.tileTree;\r\n  }\r\n\r\n  public async loadTree(): Promise<TileTree | undefined> {\r\n    await this._load();\r\n    return this.tileTree;\r\n  }\r\n\r\n  public dispose(): void {\r\n    this._tileTree = dispose(this._tileTree);\r\n    this._loadStatus = TileTreeLoadStatus.NotLoaded;\r\n  }\r\n\r\n  private async _load(): Promise<void> {\r\n    if (TileTreeLoadStatus.NotLoaded !== this.loadStatus)\r\n      return;\r\n\r\n    this._loadStatus = TileTreeLoadStatus.Loading;\r\n    let tree: TileTree | undefined;\r\n    let newStatus: TileTreeLoadStatus;\r\n    try {\r\n      tree = await this._supplier.createTileTree(this.id, this._iModel);\r\n      newStatus = undefined !== tree && !tree.rootTile.contentRange.isNull ? TileTreeLoadStatus.Loaded : TileTreeLoadStatus.NotFound;\r\n    } catch (err: any) {\r\n      newStatus = (err.errorNumber && err.errorNumber === IModelStatus.ServerTimeout) ? TileTreeLoadStatus.NotLoaded : TileTreeLoadStatus.NotFound;\r\n    }\r\n\r\n    if (TileTreeLoadStatus.Loading === this._loadStatus) {\r\n      this._tileTree = tree;\r\n      this._loadStatus = newStatus;\r\n      IModelApp.tileAdmin.onTileTreeLoad.raiseEvent(this);\r\n    }\r\n  }\r\n}\r\n\r\n/** Provides access to [[TileTree]]s associated with an [[IModelConnection]].\r\n * The tile trees are accessed indirectly via their corresponding [[TileTreeOwner]]s.\r\n * Loaded tile trees will be discarded after the iModel is closed, after a period of disuse, or when the contents of a [[GeometricModelState]] they represent\r\n * change.\r\n * @see [[IModelConnection.tiles]].\r\n * @public\r\n */\r\nexport class Tiles {\r\n  private _iModel: IModelConnection;\r\n  private readonly _treesBySupplier = new Map<TileTreeSupplier, Dictionary<any, TreeOwner>>();\r\n  private _disposed = false;\r\n\r\n  /** @internal */\r\n  public get isDisposed() { return this._disposed; }\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelConnection) {\r\n    this._iModel = iModel;\r\n\r\n    iModel.onEcefLocationChanged.addListener(() => {\r\n      for (const supplier of this._treesBySupplier.keys()) {\r\n        if (supplier.isEcefDependent)\r\n          this.dropSupplier(supplier);\r\n      }\r\n    });\r\n\r\n    // When project extents change, purge tile trees for spatial models.\r\n    iModel.onProjectExtentsChanged.addListener(async () => {\r\n      if (!iModel.isBriefcaseConnection() || !iModel.editingScope)\r\n        await this.purgeModelTrees(this.getSpatialModels());\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  public dispose(): void {\r\n    this.reset();\r\n    this._disposed = true;\r\n  }\r\n\r\n  /** Intended strictly for tests.\r\n   * @internal\r\n   */\r\n  public reset(): void {\r\n    for (const supplier of this._treesBySupplier)\r\n      supplier[1].forEach((_key, value) => value.dispose());\r\n\r\n    this._treesBySupplier.clear();\r\n  }\r\n\r\n  /** @internal */\r\n  public async purgeTileTrees(modelIds: Id64Array | undefined): Promise<void> {\r\n    return IModelApp.tileAdmin.purgeTileTrees(this._iModel, modelIds);\r\n  }\r\n\r\n  private getModelsAnimatedByScheduleScript(scriptSourceElementId: Id64String): Set<Id64String> {\r\n    const modelIds = new Set<Id64String>();\r\n    for (const supplier of this._treesBySupplier.keys())\r\n      if (supplier.addModelsAnimatedByScript)\r\n        supplier.addModelsAnimatedByScript(modelIds, scriptSourceElementId, this.getTreeOwnersForSupplier(supplier));\r\n\r\n    return modelIds;\r\n  }\r\n\r\n  /** Update the [[Tile]]s for any [[TileTree]]s that use the [RenderSchedule.Script]($common) hosted by the specified\r\n   * [RenderTimeline]($backend) or [DisplayStyle]($backend) element. This method should be invoked after\r\n   * the host element is updated in the database with a new script, so that any [[Viewport]]s displaying tiles produced\r\n   * based on the previous version of the script are updated to use the new version of the script.\r\n   * @param scriptSourceElementId The Id of the RenderTimeline or DisplayStyle element that hosts the script.\r\n   * @public\r\n   */\r\n  public async updateForScheduleScript(scriptSourceElementId: Id64String): Promise<void> {\r\n    return this.purgeModelTrees(this.getModelsAnimatedByScheduleScript(scriptSourceElementId));\r\n  }\r\n\r\n  private async purgeModelTrees(modelIds: Set<Id64String>): Promise<void> {\r\n    if (0 === modelIds.size)\r\n      return;\r\n\r\n    const ids = Array.from(modelIds);\r\n    await this.purgeTileTrees(ids);\r\n    IModelApp.viewManager.refreshForModifiedModels(ids);\r\n  }\r\n\r\n  private getSpatialModels(): Set<Id64String> {\r\n    const modelIds = new Set<Id64String>();\r\n    for (const supplier of this._treesBySupplier.keys())\r\n      if (supplier.addSpatialModels)\r\n        supplier.addSpatialModels(modelIds, this.getTreeOwnersForSupplier(supplier));\r\n\r\n    return modelIds;\r\n  }\r\n\r\n  /** Obtain the owner of a TileTree.\r\n   * The `id` is unique within all tile trees associated with `supplier`; its specific structure is an implementation detail known only to the supplier.\r\n   * A [[TileTreeReference]] uses this method to obtain the tile tree to which it refers.\r\n   */\r\n  public getTileTreeOwner(id: any, supplier: TileTreeSupplier): TileTreeOwner {\r\n    let trees = this._treesBySupplier.get(supplier);\r\n    if (undefined === trees) {\r\n      trees = new Dictionary<any, TreeOwner>((lhs, rhs) => supplier.compareTileTreeIds(lhs, rhs));\r\n      this._treesBySupplier.set(supplier, trees);\r\n    }\r\n\r\n    let tree = trees.get(id);\r\n    if (undefined === tree) {\r\n      tree = new TreeOwner(id, supplier, this._iModel);\r\n      trees.set(id, tree);\r\n    }\r\n\r\n    return tree;\r\n  }\r\n\r\n  /** Disposes of all [[TileTree]]s belonging to `supplier` and removes `supplier` from the set of known tile tree suppliers. */\r\n  public dropSupplier(supplier: TileTreeSupplier): void {\r\n    const trees = this._treesBySupplier.get(supplier);\r\n    if (undefined === trees)\r\n      return;\r\n\r\n    trees.forEach((_key, value) => value.dispose());\r\n    this._treesBySupplier.delete(supplier);\r\n  }\r\n\r\n  /** Invokes a function on each extant TileTreeOwner. */\r\n  public forEachTreeOwner(func: (owner: TileTreeOwner) => void): void {\r\n    for (const dict of this._treesBySupplier.values())\r\n      dict.forEach((_key, value) => func(value));\r\n  }\r\n\r\n  /** Obtain the TileTreeOwners supplied by the specified supplier. */\r\n  public getTreeOwnersForSupplier(supplier: TileTreeSupplier): Iterable<{ id: any, owner: TileTreeOwner }> {\r\n    function* iterator(trees: Dictionary<any, TreeOwner> | undefined) {\r\n      if (trees)\r\n        for (const entry of trees)\r\n          yield { id: entry.key, owner: entry.value };\r\n    }\r\n\r\n    return {\r\n      [Symbol.iterator]: () => iterator(this._treesBySupplier.get(supplier)),\r\n    };\r\n  }\r\n\r\n  /** Unload any tile trees which have not been drawn since at least the specified time, excluding any of the specified TileTrees.\r\n   * @internal\r\n   */\r\n  public purge(olderThan: BeTimePoint, exclude?: Set<TileTree>): void {\r\n    // NB: It would be nice to be able to detect completely useless leftover Owners or Suppliers, but we can't know if any TileTreeReferences exist pointing to a given Owner.\r\n    for (const entry of this._treesBySupplier) {\r\n      const dict = entry[1];\r\n      dict.forEach((_treeId, owner) => {\r\n        const tree = owner.tileTree;\r\n        if (undefined !== tree && tree.lastSelectedTime.milliseconds < olderThan.milliseconds)\r\n          if (undefined === exclude || !exclude.has(tree))\r\n            owner.dispose();\r\n      });\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Tiles.js","sourceRoot":"","sources":["../../src/Tiles.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4G;AAC5G,2CAAwC;AAExC,8CAAgG;AAEhG,MAAM,SAAS;IAYb,YAAmB,EAAO,EAAE,QAA0B,EAAE,MAAwB;QAVxE,gBAAW,GAAuB,6BAAkB,CAAC,SAAS,CAAC;QAWrE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IARD,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACtE,IAAW,UAAU,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,IAAW,MAAM,KAAuB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAQvD,IAAI;QACT,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,8DAA8D;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,SAAS,GAAG,IAAA,sBAAO,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,6BAAkB,CAAC,SAAS,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,IAAI,6BAAkB,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;YAClD,OAAO;QAET,IAAI,CAAC,WAAW,GAAG,6BAAkB,CAAC,OAAO,CAAC;QAC9C,IAAI,IAA0B,CAAC;QAC/B,IAAI,SAA6B,CAAC;QAClC,IAAI;YACF,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAClE,SAAS,GAAG,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAkB,CAAC,QAAQ,CAAC;SAChI;QAAC,OAAO,GAAQ,EAAE;YACjB,SAAS,GAAG,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,6BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,6BAAkB,CAAC,QAAQ,CAAC;SAC9I;QAED,IAAI,6BAAkB,CAAC,OAAO,KAAK,IAAI,CAAC,WAAW,EAAE;YACnD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YAC7B,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACrD;IACH,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAa,KAAK;IAQhB,gBAAgB;IAChB,YAAY,MAAwB;QAPnB,qBAAgB,GAAG,IAAI,GAAG,EAAgD,CAAC;QACpF,cAAS,GAAG,KAAK,CAAC;QAOxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE;gBACnD,IAAI,QAAQ,CAAC,eAAe;oBAC1B,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QAEH,oEAAoE;QACpE,MAAM,CAAC,uBAAuB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;YACpD,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;gBACzD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAnBD,gBAAgB;IAChB,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAoBlD,gBAAgB;IACT,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB;YAC1C,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAExD,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,cAAc,CAAC,QAA+B;QACzD,OAAO,qBAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAEO,iCAAiC,CAAC,qBAAiC;QACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;YACjD,IAAI,QAAQ,CAAC,yBAAyB;gBACpC,QAAQ,CAAC,yBAAyB,CAAC,QAAQ,EAAE,qBAAqB,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,uBAAuB,CAAC,qBAAiC;QACpE,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,iCAAiC,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAC7F,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,QAAyB;QACrD,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,qBAAS,CAAC,WAAW,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IAEO,gBAAgB;QACtB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE;YACjD,IAAI,QAAQ,CAAC,gBAAgB;gBAC3B,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEjF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,EAAO,EAAE,QAA0B;QACzD,IAAI,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,KAAK,GAAG,IAAI,yBAAU,CAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAC5F,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;SAC5C;QAED,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,IAAI,GAAG,IAAI,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACrB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8HAA8H;IACvH,YAAY,CAAC,QAA0B;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO;QAET,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,uDAAuD;IAChD,gBAAgB,CAAC,IAAoC;QAC1D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC/C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,8CAA8C;IACvC,CAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxB,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACpD,KAAK,MAAM,KAAK,IAAI,IAAI;gBACtB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;SACzD;IACH,CAAC;IAED,oEAAoE;IAC7D,wBAAwB,CAAC,QAA0B;QACxD,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAA6C;YAC9D,IAAI,KAAK;gBACP,KAAK,MAAM,KAAK,IAAI,KAAK;oBACvB,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAClD,CAAC;QAED,OAAO;YACL,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SACvE,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAsB,EAAE,OAAuB;QAC1D,0KAA0K;QAC1K,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;gBAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;gBAC5B,IAAI,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY;oBACnF,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;wBAC7C,KAAK,CAAC,OAAO,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;CACF;AA7JD,sBA6JC","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 IModelConnection\r\n */\r\n\r\nimport { BeTimePoint, Dictionary, dispose, Id64Array, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { TileTree, TileTreeLoadStatus, TileTreeOwner, TileTreeSupplier } from \"./tile/internal\";\r\n\r\nclass TreeOwner implements TileTreeOwner {\r\n  private _tileTree?: TileTree;\r\n  private _loadStatus: TileTreeLoadStatus = TileTreeLoadStatus.NotLoaded;\r\n  private readonly _supplier: TileTreeSupplier;\r\n  private readonly _iModel: IModelConnection;\r\n\r\n  public readonly id: any;\r\n\r\n  public get tileTree(): TileTree | undefined { return this._tileTree; }\r\n  public get loadStatus(): TileTreeLoadStatus { return this._loadStatus; }\r\n  public get iModel(): IModelConnection { return this._iModel; }\r\n\r\n  public constructor(id: any, supplier: TileTreeSupplier, iModel: IModelConnection) {\r\n    this.id = id;\r\n    this._supplier = supplier;\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public load(): TileTree | undefined {\r\n    this._load(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    return this.tileTree;\r\n  }\r\n\r\n  public async loadTree(): Promise<TileTree | undefined> {\r\n    await this._load();\r\n    return this.tileTree;\r\n  }\r\n\r\n  public dispose(): void {\r\n    this._tileTree = dispose(this._tileTree);\r\n    this._loadStatus = TileTreeLoadStatus.NotLoaded;\r\n  }\r\n\r\n  private async _load(): Promise<void> {\r\n    if (TileTreeLoadStatus.NotLoaded !== this.loadStatus)\r\n      return;\r\n\r\n    this._loadStatus = TileTreeLoadStatus.Loading;\r\n    let tree: TileTree | undefined;\r\n    let newStatus: TileTreeLoadStatus;\r\n    try {\r\n      tree = await this._supplier.createTileTree(this.id, this._iModel);\r\n      newStatus = undefined !== tree && !tree.rootTile.contentRange.isNull ? TileTreeLoadStatus.Loaded : TileTreeLoadStatus.NotFound;\r\n    } catch (err: any) {\r\n      newStatus = (err.errorNumber && err.errorNumber === IModelStatus.ServerTimeout) ? TileTreeLoadStatus.NotLoaded : TileTreeLoadStatus.NotFound;\r\n    }\r\n\r\n    if (TileTreeLoadStatus.Loading === this._loadStatus) {\r\n      this._tileTree = tree;\r\n      this._loadStatus = newStatus;\r\n      IModelApp.tileAdmin.onTileTreeLoad.raiseEvent(this);\r\n    }\r\n  }\r\n}\r\n\r\n/** Provides access to [[TileTree]]s associated with an [[IModelConnection]].\r\n * The tile trees are accessed indirectly via their corresponding [[TileTreeOwner]]s.\r\n * Loaded tile trees will be discarded after the iModel is closed, after a period of disuse, or when the contents of a [[GeometricModelState]] they represent\r\n * change.\r\n * @see [[IModelConnection.tiles]].\r\n * @public\r\n */\r\nexport class Tiles implements Iterable<{ supplier: TileTreeSupplier, id: any, owner: TileTreeOwner }> {\r\n  private _iModel: IModelConnection;\r\n  private readonly _treesBySupplier = new Map<TileTreeSupplier, Dictionary<any, TreeOwner>>();\r\n  private _disposed = false;\r\n\r\n  /** @internal */\r\n  public get isDisposed() { return this._disposed; }\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelConnection) {\r\n    this._iModel = iModel;\r\n\r\n    iModel.onEcefLocationChanged.addListener(() => {\r\n      for (const supplier of this._treesBySupplier.keys()) {\r\n        if (supplier.isEcefDependent)\r\n          this.dropSupplier(supplier);\r\n      }\r\n    });\r\n\r\n    // When project extents change, purge tile trees for spatial models.\r\n    iModel.onProjectExtentsChanged.addListener(async () => {\r\n      if (!iModel.isBriefcaseConnection() || !iModel.editingScope)\r\n        await this.purgeModelTrees(this.getSpatialModels());\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  public dispose(): void {\r\n    this.reset();\r\n    this._disposed = true;\r\n  }\r\n\r\n  /** Intended strictly for tests.\r\n   * @internal\r\n   */\r\n  public reset(): void {\r\n    for (const supplier of this._treesBySupplier)\r\n      supplier[1].forEach((_key, value) => value.dispose());\r\n\r\n    this._treesBySupplier.clear();\r\n  }\r\n\r\n  /** @internal */\r\n  public async purgeTileTrees(modelIds: Id64Array | undefined): Promise<void> {\r\n    return IModelApp.tileAdmin.purgeTileTrees(this._iModel, modelIds);\r\n  }\r\n\r\n  private getModelsAnimatedByScheduleScript(scriptSourceElementId: Id64String): Set<Id64String> {\r\n    const modelIds = new Set<Id64String>();\r\n    for (const supplier of this._treesBySupplier.keys())\r\n      if (supplier.addModelsAnimatedByScript)\r\n        supplier.addModelsAnimatedByScript(modelIds, scriptSourceElementId, this.getTreeOwnersForSupplier(supplier));\r\n\r\n    return modelIds;\r\n  }\r\n\r\n  /** Update the [[Tile]]s for any [[TileTree]]s that use the [RenderSchedule.Script]($common) hosted by the specified\r\n   * [RenderTimeline]($backend) or [DisplayStyle]($backend) element. This method should be invoked after\r\n   * the host element is updated in the database with a new script, so that any [[Viewport]]s displaying tiles produced\r\n   * based on the previous version of the script are updated to use the new version of the script.\r\n   * @param scriptSourceElementId The Id of the RenderTimeline or DisplayStyle element that hosts the script.\r\n   * @public\r\n   */\r\n  public async updateForScheduleScript(scriptSourceElementId: Id64String): Promise<void> {\r\n    return this.purgeModelTrees(this.getModelsAnimatedByScheduleScript(scriptSourceElementId));\r\n  }\r\n\r\n  private async purgeModelTrees(modelIds: Set<Id64String>): Promise<void> {\r\n    if (0 === modelIds.size)\r\n      return;\r\n\r\n    const ids = Array.from(modelIds);\r\n    await this.purgeTileTrees(ids);\r\n    IModelApp.viewManager.refreshForModifiedModels(ids);\r\n  }\r\n\r\n  private getSpatialModels(): Set<Id64String> {\r\n    const modelIds = new Set<Id64String>();\r\n    for (const supplier of this._treesBySupplier.keys())\r\n      if (supplier.addSpatialModels)\r\n        supplier.addSpatialModels(modelIds, this.getTreeOwnersForSupplier(supplier));\r\n\r\n    return modelIds;\r\n  }\r\n\r\n  /** Obtain the owner of a TileTree.\r\n   * The `id` is unique within all tile trees associated with `supplier`; its specific structure is an implementation detail known only to the supplier.\r\n   * A [[TileTreeReference]] uses this method to obtain the tile tree to which it refers.\r\n   */\r\n  public getTileTreeOwner(id: any, supplier: TileTreeSupplier): TileTreeOwner {\r\n    let trees = this._treesBySupplier.get(supplier);\r\n    if (undefined === trees) {\r\n      trees = new Dictionary<any, TreeOwner>((lhs, rhs) => supplier.compareTileTreeIds(lhs, rhs));\r\n      this._treesBySupplier.set(supplier, trees);\r\n    }\r\n\r\n    let tree = trees.get(id);\r\n    if (undefined === tree) {\r\n      tree = new TreeOwner(id, supplier, this._iModel);\r\n      trees.set(id, tree);\r\n    }\r\n\r\n    return tree;\r\n  }\r\n\r\n  /** Disposes of all [[TileTree]]s belonging to `supplier` and removes `supplier` from the set of known tile tree suppliers. */\r\n  public dropSupplier(supplier: TileTreeSupplier): void {\r\n    const trees = this._treesBySupplier.get(supplier);\r\n    if (undefined === trees)\r\n      return;\r\n\r\n    trees.forEach((_key, value) => value.dispose());\r\n    this._treesBySupplier.delete(supplier);\r\n  }\r\n\r\n  /** Invokes a function on each extant TileTreeOwner. */\r\n  public forEachTreeOwner(func: (owner: TileTreeOwner) => void): void {\r\n    for (const dict of this._treesBySupplier.values())\r\n      dict.forEach((_key, value) => func(value));\r\n  }\r\n\r\n  /** Iterate over all of the TileTreeOwners. */\r\n  public * [Symbol.iterator](): Iterator<{ supplier: TileTreeSupplier, id: any, owner: TileTreeOwner }> {\r\n    for (const [supplier, dict] of this._treesBySupplier) {\r\n      for (const entry of dict)\r\n        yield { supplier, id: entry.key, owner: entry.value };\r\n    }\r\n  }\r\n\r\n  /** Obtain the TileTreeOwners supplied by the specified supplier. */\r\n  public getTreeOwnersForSupplier(supplier: TileTreeSupplier): Iterable<{ id: any, owner: TileTreeOwner }> {\r\n    function* iterator(trees: Dictionary<any, TreeOwner> | undefined) {\r\n      if (trees)\r\n        for (const entry of trees)\r\n          yield { id: entry.key, owner: entry.value };\r\n    }\r\n\r\n    return {\r\n      [Symbol.iterator]: () => iterator(this._treesBySupplier.get(supplier)),\r\n    };\r\n  }\r\n\r\n  /** Unload any tile trees which have not been drawn since at least the specified time, excluding any of the specified TileTrees.\r\n   * @internal\r\n   */\r\n  public purge(olderThan: BeTimePoint, exclude?: Set<TileTree>): void {\r\n    // NB: It would be nice to be able to detect completely useless leftover Owners or Suppliers, but we can't know if any TileTreeReferences exist pointing to a given Owner.\r\n    for (const entry of this._treesBySupplier) {\r\n      const dict = entry[1];\r\n      dict.forEach((_treeId, owner) => {\r\n        const tree = owner.tileTree;\r\n        if (undefined !== tree && tree.lastSelectedTime.milliseconds < olderThan.milliseconds)\r\n          if (undefined === exclude || !exclude.has(tree))\r\n            owner.dispose();\r\n      });\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/TwoWayViewportSync.d.ts

@@ -2,21 +2,50 @@
  * @module Views
  */
 import { Viewport } from "./Viewport";
-/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of both Viewports are synchronized.
- * For example, panning in one viewport will cause the other viewport to pan by the same distance.
+/** Forms a bidirectional connection between two [[Viewport]]s such that the [[ViewState]]s of each are synchronized with one another.
+ * For example, panning in one viewport will cause the other viewport to pan by the same distance, and changing the [RenderMode]($common) of one viewport
+ * will change it in the other viewport.
+ * By default, all aspects of the views - display style, category and model selectors, frustum, etc - are synchronized, but this can be customized by
+ * subclassing and overriding the [[syncViewports]] and [[connectViewports]] methods.
  * @see [Multiple Viewport Sample](https://www.itwinjs.org/sample-showcase/?group=Viewer+Features&sample=multi-viewport-sample&imodel=Metrostation+Sample)
  * for an interactive demonstration.
+ * @see [[TwoWayViewportFrustumSync]] to synchronize only the frusta of the viewports.
  * @public
  */
 export declare class TwoWayViewportSync {
-    private readonly _disconnect;
+    protected readonly _disconnect: VoidFunction[];
     private _isEcho;
     private syncView;
-    /** Establish the connection between two Viewports. When this method is called, `view2` is initialized with the state of `view1`.
-     * Thereafter, any change to the frustum of either view will be reflected in the frustum of the other view.
+    /** Invoked from [[connect]] to set up the initial synchronization between the two viewports.
+     * `target` should be modified to match `source`.
+     * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.
+     * @see [[syncViewports]] to customize subsequent synchronization.
      */
-    connect(view1: Viewport, view2: Viewport): void;
+    protected connectViewports(source: Viewport, target: Viewport): void;
+    /** Invoked each time `source` changes to update `target` to match.
+     * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.
+     * @param source The viewport that changed
+     * @param target The viewport that should be updated to match `source`
+     * @see [[connectViewports]] to set up the initial synchronization between the two viewports.
+     */
+    protected syncViewports(source: Viewport, target: Viewport): void;
+    /** Establish the connection between two Viewports. When this method is called, `viewport2` is initialized with the state of `viewport1` via [[connectViewports]].
+     * Thereafter, any change to the frustum of either viewport will be reflected in the frustum of the other viewport via [[syncViewports]].
+     */
+    connect(viewport1: Viewport, viewport2: Viewport): void;
     /** Remove the connection between the two views. */
     disconnect(): void;
 }
+/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of each are synchronized with one another.
+ * For example, zooming out in one viewport will zoom out by the same distance in the other viewport.
+ * No other aspects of the viewports are synchronized - they may have entirely different display styles, category/model selectors, etc.
+ * @see [[TwoWayViewportSync]] to synchronize all aspects of the viewports.
+ * @public
+ */
+export declare class TwoWayViewportFrustumSync extends TwoWayViewportSync {
+    /** @internal override */
+    protected syncViewports(source: Viewport, target: Viewport): void;
+    /** @internal override */
+    protected connectViewports(source: Viewport, target: Viewport): void;
+}
 //# sourceMappingURL=TwoWayViewportSync.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TwoWayViewportSync.d.ts","sourceRoot":"","sources":["../../src/TwoWayViewportSync.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,QAAQ;IAOhB;;OAEG;IACI,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ;IAW/C,mDAAmD;IAC5C,UAAU;CAIlB"}
+{"version":3,"file":"TwoWayViewportSync.d.ts","sourceRoot":"","sources":["../../src/TwoWayViewportSync.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;GASG;AACH,qBAAa,kBAAkB;IAC7B,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,CAAM;IACpD,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,QAAQ;IAShB;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKpE;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAIjE;;OAEG;IACI,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ;IAUvD,mDAAmD;IAC5C,UAAU;CAIlB;AAED;;;;;GAKG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,yBAAyB;cACN,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAM1E,yBAAyB;cACN,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;CAG9E"}

package/lib/cjs/TwoWayViewportSync.js

@@ -7,11 +7,15 @@
  * @module Views
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TwoWayViewportSync = void 0;
-/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of both Viewports are synchronized.
- * For example, panning in one viewport will cause the other viewport to pan by the same distance.
+exports.TwoWayViewportFrustumSync = exports.TwoWayViewportSync = void 0;
+/** Forms a bidirectional connection between two [[Viewport]]s such that the [[ViewState]]s of each are synchronized with one another.
+ * For example, panning in one viewport will cause the other viewport to pan by the same distance, and changing the [RenderMode]($common) of one viewport
+ * will change it in the other viewport.
+ * By default, all aspects of the views - display style, category and model selectors, frustum, etc - are synchronized, but this can be customized by
+ * subclassing and overriding the [[syncViewports]] and [[connectViewports]] methods.
  * @see [Multiple Viewport Sample](https://www.itwinjs.org/sample-showcase/?group=Viewer+Features&sample=multi-viewport-sample&imodel=Metrostation+Sample)
  * for an interactive demonstration.
+ * @see [[TwoWayViewportFrustumSync]] to synchronize only the frusta of the viewports.
  * @public
  */
 class TwoWayViewportSync {
@@ -23,19 +27,36 @@ class TwoWayViewportSync {
         if (this._isEcho)
             return;
         this._isEcho = true; // so we don't react to the echo of this sync
-        target.applyViewState(source.view.clone(target.iModel));
+        this.syncViewports(source, target);
         this._isEcho = false;
     }
-    /** Establish the connection between two Viewports. When this method is called, `view2` is initialized with the state of `view1`.
-     * Thereafter, any change to the frustum of either view will be reflected in the frustum of the other view.
+    /** Invoked from [[connect]] to set up the initial synchronization between the two viewports.
+     * `target` should be modified to match `source`.
+     * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.
+     * @see [[syncViewports]] to customize subsequent synchronization.
+     */
+    connectViewports(source, target) {
+        const viewState = source.view.clone(target.iModel);
+        target.applyViewState(viewState);
+    }
+    /** Invoked each time `source` changes to update `target` to match.
+     * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.
+     * @param source The viewport that changed
+     * @param target The viewport that should be updated to match `source`
+     * @see [[connectViewports]] to set up the initial synchronization between the two viewports.
+     */
+    syncViewports(source, target) {
+        target.applyViewState(source.view.clone(target.iModel));
+    }
+    /** Establish the connection between two Viewports. When this method is called, `viewport2` is initialized with the state of `viewport1` via [[connectViewports]].
+     * Thereafter, any change to the frustum of either viewport will be reflected in the frustum of the other viewport via [[syncViewports]].
      */
-    connect(view1, view2) {
+    connect(viewport1, viewport2) {
         this.disconnect();
-        const viewState2 = view1.view.clone(view2.iModel); // use view1 as the starting point
-        view2.applyViewState(viewState2);
+        this.connectViewports(viewport1, viewport2);
         // listen to the onViewChanged events from both views
-        this._disconnect.push(view1.onViewChanged.addListener(() => this.syncView(view1, view2)));
-        this._disconnect.push(view2.onViewChanged.addListener(() => this.syncView(view2, view1)));
+        this._disconnect.push(viewport1.onViewChanged.addListener(() => this.syncView(viewport1, viewport2)));
+        this._disconnect.push(viewport2.onViewChanged.addListener(() => this.syncView(viewport2, viewport1)));
     }
     /** Remove the connection between the two views. */
     disconnect() {
@@ -44,4 +65,23 @@ class TwoWayViewportSync {
     }
 }
 exports.TwoWayViewportSync = TwoWayViewportSync;
+/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of each are synchronized with one another.
+ * For example, zooming out in one viewport will zoom out by the same distance in the other viewport.
+ * No other aspects of the viewports are synchronized - they may have entirely different display styles, category/model selectors, etc.
+ * @see [[TwoWayViewportSync]] to synchronize all aspects of the viewports.
+ * @public
+ */
+class TwoWayViewportFrustumSync extends TwoWayViewportSync {
+    /** @internal override */
+    syncViewports(source, target) {
+        const pose = source.view.savePose();
+        const view = target.view.applyPose(pose);
+        target.applyViewState(view);
+    }
+    /** @internal override */
+    connectViewports(source, target) {
+        this.syncViewports(source, target);
+    }
+}
+exports.TwoWayViewportFrustumSync = TwoWayViewportFrustumSync;
 //# sourceMappingURL=TwoWayViewportSync.js.map

package/lib/cjs/TwoWayViewportSync.js.map

@@ -1 +1 @@
-{"version":3,"file":"TwoWayViewportSync.js","sourceRoot":"","sources":["../../src/TwoWayViewportSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;GAKG;AACH,MAAa,kBAAkB;IAA/B;QACmB,gBAAW,GAAmB,EAAE,CAAC;QAC1C,YAAO,GAAG,KAAK,CAAC;IA4B1B,CAAC;IA1BS,QAAQ,CAAC,MAAgB,EAAE,MAAgB;QACjD,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,6CAA6C;QAClE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,KAAe,EAAE,KAAe;QAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,kCAAkC;QACrF,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAEjC,qDAAqD;QACrD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED,mDAAmD;IAC5C,UAAU;QACf,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF;AA9BD,gDA8BC","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 Views\r\n */\r\n\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of both Viewports are synchronized.\r\n * For example, panning in one viewport will cause the other viewport to pan by the same distance.\r\n * @see [Multiple Viewport Sample](https://www.itwinjs.org/sample-showcase/?group=Viewer+Features&sample=multi-viewport-sample&imodel=Metrostation+Sample)\r\n * for an interactive demonstration.\r\n * @public\r\n */\r\nexport class TwoWayViewportSync {\r\n  private readonly _disconnect: VoidFunction[] = [];\r\n  private _isEcho = false;\r\n\r\n  private syncView(source: Viewport, target: Viewport) {\r\n    if (this._isEcho) return;\r\n    this._isEcho = true; // so we don't react to the echo of this sync\r\n    target.applyViewState(source.view.clone(target.iModel));\r\n    this._isEcho = false;\r\n  }\r\n\r\n  /** Establish the connection between two Viewports. When this method is called, `view2` is initialized with the state of `view1`.\r\n   * Thereafter, any change to the frustum of either view will be reflected in the frustum of the other view.\r\n   */\r\n  public connect(view1: Viewport, view2: Viewport) {\r\n    this.disconnect();\r\n\r\n    const viewState2 = view1.view.clone(view2.iModel); // use view1 as the starting point\r\n    view2.applyViewState(viewState2);\r\n\r\n    // listen to the onViewChanged events from both views\r\n    this._disconnect.push(view1.onViewChanged.addListener(() => this.syncView(view1, view2)));\r\n    this._disconnect.push(view2.onViewChanged.addListener(() => this.syncView(view2, view1)));\r\n  }\r\n\r\n  /** Remove the connection between the two views. */\r\n  public disconnect() {\r\n    this._disconnect.forEach((f) => f());\r\n    this._disconnect.length = 0;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TwoWayViewportSync.js","sourceRoot":"","sources":["../../src/TwoWayViewportSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;;;;;GASG;AACH,MAAa,kBAAkB;IAA/B;QACqB,gBAAW,GAAmB,EAAE,CAAC;QAC5C,YAAO,GAAG,KAAK,CAAC;IAiD1B,CAAC;IA/CS,QAAQ,CAAC,MAAgB,EAAE,MAAgB;QACjD,IAAI,IAAI,CAAC,OAAO;YACd,OAAO;QAET,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,6CAA6C;QAClE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACO,gBAAgB,CAAC,MAAgB,EAAE,MAAgB;QAC3D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACO,aAAa,CAAC,MAAgB,EAAE,MAAgB;QACxD,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,SAAmB,EAAE,SAAmB;QACrD,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE5C,qDAAqD;QACrD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QACtG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACxG,CAAC;IAED,mDAAmD;IAC5C,UAAU;QACf,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF;AAnDD,gDAmDC;AAED;;;;;GAKG;AACH,MAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,yBAAyB;IACN,aAAa,CAAC,MAAgB,EAAE,MAAgB;QACjE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,yBAAyB;IACN,gBAAgB,CAAC,MAAgB,EAAE,MAAgB;QACpE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;CACF;AAZD,8DAYC","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 Views\r\n */\r\n\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/** Forms a bidirectional connection between two [[Viewport]]s such that the [[ViewState]]s of each are synchronized with one another.\r\n * For example, panning in one viewport will cause the other viewport to pan by the same distance, and changing the [RenderMode]($common) of one viewport\r\n * will change it in the other viewport.\r\n * By default, all aspects of the views - display style, category and model selectors, frustum, etc - are synchronized, but this can be customized by\r\n * subclassing and overriding the [[syncViewports]] and [[connectViewports]] methods.\r\n * @see [Multiple Viewport Sample](https://www.itwinjs.org/sample-showcase/?group=Viewer+Features&sample=multi-viewport-sample&imodel=Metrostation+Sample)\r\n * for an interactive demonstration.\r\n * @see [[TwoWayViewportFrustumSync]] to synchronize only the frusta of the viewports.\r\n * @public\r\n */\r\nexport class TwoWayViewportSync {\r\n  protected readonly _disconnect: VoidFunction[] = [];\r\n  private _isEcho = false;\r\n\r\n  private syncView(source: Viewport, target: Viewport) {\r\n    if (this._isEcho)\r\n      return;\r\n\r\n    this._isEcho = true; // so we don't react to the echo of this sync\r\n    this.syncViewports(source, target);\r\n    this._isEcho = false;\r\n  }\r\n\r\n  /** Invoked from [[connect]] to set up the initial synchronization between the two viewports.\r\n   * `target` should be modified to match `source`.\r\n   * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.\r\n   * @see [[syncViewports]] to customize subsequent synchronization.\r\n   */\r\n  protected connectViewports(source: Viewport, target: Viewport): void {\r\n    const viewState = source.view.clone(target.iModel);\r\n    target.applyViewState(viewState);\r\n  }\r\n\r\n  /** Invoked each time `source` changes to update `target` to match.\r\n   * The default implementation applies a clone of `source`'s [[ViewState]] to `target`.\r\n   * @param source The viewport that changed\r\n   * @param target The viewport that should be updated to match `source`\r\n   * @see [[connectViewports]] to set up the initial synchronization between the two viewports.\r\n   */\r\n  protected syncViewports(source: Viewport, target: Viewport): void {\r\n    target.applyViewState(source.view.clone(target.iModel));\r\n  }\r\n\r\n  /** Establish the connection between two Viewports. When this method is called, `viewport2` is initialized with the state of `viewport1` via [[connectViewports]].\r\n   * Thereafter, any change to the frustum of either viewport will be reflected in the frustum of the other viewport via [[syncViewports]].\r\n   */\r\n  public connect(viewport1: Viewport, viewport2: Viewport) {\r\n    this.disconnect();\r\n\r\n    this.connectViewports(viewport1, viewport2);\r\n\r\n    // listen to the onViewChanged events from both views\r\n    this._disconnect.push(viewport1.onViewChanged.addListener(() => this.syncView(viewport1, viewport2)));\r\n    this._disconnect.push(viewport2.onViewChanged.addListener(() => this.syncView(viewport2, viewport1)));\r\n  }\r\n\r\n  /** Remove the connection between the two views. */\r\n  public disconnect() {\r\n    this._disconnect.forEach((f) => f());\r\n    this._disconnect.length = 0;\r\n  }\r\n}\r\n\r\n/** Forms a bidirectional connection between two [[Viewport]]s such that the [Frustum]($common)s of each are synchronized with one another.\r\n * For example, zooming out in one viewport will zoom out by the same distance in the other viewport.\r\n * No other aspects of the viewports are synchronized - they may have entirely different display styles, category/model selectors, etc.\r\n * @see [[TwoWayViewportSync]] to synchronize all aspects of the viewports.\r\n * @public\r\n */\r\nexport class TwoWayViewportFrustumSync extends TwoWayViewportSync {\r\n  /** @internal override */\r\n  protected override syncViewports(source: Viewport, target: Viewport): void {\r\n    const pose = source.view.savePose();\r\n    const view = target.view.applyPose(pose);\r\n    target.applyViewState(view);\r\n  }\r\n\r\n  /** @internal override */\r\n  protected override connectViewports(source: Viewport, target: Viewport): void {\r\n    this.syncViewports(source, target);\r\n  }\r\n}\r\n"]}

package/lib/cjs/UserPreferences.d.ts

@@ -0,0 +1,72 @@
+/** @packageDocumentation
+ * @module UserPreferences
+ */
+import { AccessToken, GuidString } from "@itwin/core-bentley";
+/** Argument for methods that can supply an iTwinId and iModelId.
+ * @beta
+ */
+export interface ITwinIdArg {
+    readonly iTwinId?: GuidString;
+    readonly iModelId?: GuidString;
+}
+/** Argument for methods that can supply an access token.
+ * @beta
+ */
+export interface TokenArg {
+    accessToken?: AccessToken;
+}
+/** Argument for methods that can supply the user preference content.
+ * @beta
+ */
+export interface PreferenceArg extends PreferenceKeyArg {
+    readonly content?: any;
+}
+/** Argument for methods that must supply a key for the user preference.
+ * @beta
+ */
+export interface PreferenceKeyArg {
+    readonly namespace?: string;
+    readonly key: string;
+}
+/** User preferences provide a way to get, store and delete preferences for an application at
+ * two different levels, iTwin and iModel.
+ *
+ * The user preferences are separate from any iTwin or iModel configuration intended to be shared
+ * across multiple users. See [Workspace]($docs/learning/backend/Workspace.md) for more details on
+ * shared configuration.
+ *
+ * Note: Both the key and return type are intended to be abstract and allow any preferences to be stored.
+ *     Based on this simple interface, the implementation of this interface can interpret the key as needed
+ *     to store and retrieve the preferences.
+ * @beta
+ */
+export interface UserPreferencesAccess {
+    /** Method to get a user preference based off of a key within a namespace.
+     *
+     * If both iTwinId and iModelId are provided, the iModel level will be check first. If
+     * it does not exist, the iTwin level will checked next.
+     *
+     * @returns undefined if a preference is not found.
+     * @throws if an error occurs when attempting to retrieve a preference.
+     */
+    get: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<any>;
+    /** Deletes the specified preference by key, if it exists, within the level provided.
+     *
+     * If both iTwinId and iModelId are provided, the key will be deleted from both levels.
+     *
+     * If the key does not exist in either level provided, then this function will do nothing.
+     *
+     * @throws if any error occurs when deleting the preference.
+     */
+    delete: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<void>;
+    /** Saves the provided preference by the key within the provided level.
+     *
+     * If both iTwinId and iModelId are provided, the key will be saved to both levels.
+     *
+     * If the key already exists, in either level, the preference will be updated.
+     *
+     * @throws if any error occurs while saving.
+     */
+    save: (arg: PreferenceArg & ITwinIdArg & TokenArg) => Promise<void>;
+}
+//# sourceMappingURL=UserPreferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserPreferences.d.ts","sourceRoot":"","sources":["../../src/UserPreferences.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;OAOG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,gBAAgB,GAAG,UAAU,GAAG,QAAQ,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAErE;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,gBAAgB,GAAG,UAAU,GAAG,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,aAAa,GAAG,UAAU,GAAG,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE"}

package/lib/cjs/UserPreferences.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=UserPreferences.js.map

package/lib/cjs/UserPreferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPreferences.js","sourceRoot":"","sources":["../../src/UserPreferences.ts"],"names":[],"mappings":";AAAA;;;+FAG+F","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\r\n/** @packageDocumentation\r\n * @module UserPreferences\r\n */\r\n\r\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\r\n\r\n/** Argument for methods that can supply an iTwinId and iModelId.\r\n * @beta\r\n */\r\nexport interface ITwinIdArg {\r\n  readonly iTwinId?: GuidString;\r\n  readonly iModelId?: GuidString;\r\n}\r\n\r\n/** Argument for methods that can supply an access token.\r\n * @beta\r\n */\r\nexport interface TokenArg {\r\n  accessToken?: AccessToken;\r\n}\r\n\r\n/** Argument for methods that can supply the user preference content.\r\n * @beta\r\n */\r\nexport interface PreferenceArg extends PreferenceKeyArg {\r\n  readonly content?: any;\r\n}\r\n\r\n/** Argument for methods that must supply a key for the user preference.\r\n * @beta\r\n */\r\nexport interface PreferenceKeyArg {\r\n  readonly namespace?: string;\r\n  readonly key: string;\r\n}\r\n\r\n/** User preferences provide a way to get, store and delete preferences for an application at\r\n * two different levels, iTwin and iModel.\r\n *\r\n * The user preferences are separate from any iTwin or iModel configuration intended to be shared\r\n * across multiple users. See [Workspace]($docs/learning/backend/Workspace.md) for more details on\r\n * shared configuration.\r\n *\r\n * Note: Both the key and return type are intended to be abstract and allow any preferences to be stored.\r\n *     Based on this simple interface, the implementation of this interface can interpret the key as needed\r\n *     to store and retrieve the preferences.\r\n * @beta\r\n */\r\nexport interface UserPreferencesAccess {\r\n  /** Method to get a user preference based off of a key within a namespace.\r\n   *\r\n   * If both iTwinId and iModelId are provided, the iModel level will be check first. If\r\n   * it does not exist, the iTwin level will checked next.\r\n   *\r\n   * @returns undefined if a preference is not found.\r\n   * @throws if an error occurs when attempting to retrieve a preference.\r\n   */\r\n  get: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<any>;\r\n\r\n  /** Deletes the specified preference by key, if it exists, within the level provided.\r\n   *\r\n   * If both iTwinId and iModelId are provided, the key will be deleted from both levels.\r\n   *\r\n   * If the key does not exist in either level provided, then this function will do nothing.\r\n   *\r\n   * @throws if any error occurs when deleting the preference.\r\n   */\r\n  delete: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<void>;\r\n\r\n  /** Saves the provided preference by the key within the provided level.\r\n   *\r\n   * If both iTwinId and iModelId are provided, the key will be saved to both levels.\r\n   *\r\n   * If the key already exists, in either level, the preference will be updated.\r\n   *\r\n   * @throws if any error occurs while saving.\r\n   */\r\n  save: (arg: PreferenceArg & ITwinIdArg & TokenArg) => Promise<void>;\r\n}\r\n"]}

package/lib/cjs/ViewContext.d.ts

@@ -12,7 +12,7 @@ import { GraphicBranch, GraphicBranchOptions } from "./render/GraphicBranch";
 import { GraphicBuilder, GraphicType, ViewportGraphicBuilderOptions } from "./render/GraphicBuilder";
 import { RenderGraphic } from "./render/RenderGraphic";
 import { RenderPlanarClassifier } from "./render/RenderPlanarClassifier";
-import { RenderTextureDrape } from "./render/RenderSystem";
+import { RenderSystem, RenderTextureDrape } from "./render/RenderSystem";
 import { RenderTarget } from "./render/RenderTarget";
 import { Scene } from "./render/Scene";
 import { SpatialClassifierTileTreeReference, Tile, TileGraphicType, TileTreeReference } from "./tile/internal";
@@ -34,6 +34,8 @@ export declare class RenderContext {
     getPixelSizeAtPoint(inPoint?: Point3d): number;
     /** The [[Viewport]] associated with this context. */
     get viewport(): Viewport;
+    /** The [[RenderSystem]] being used to produce graphics for this context. */
+    get renderSystem(): RenderSystem;
     /** @internal */
     get target(): RenderTarget;
     /** @internal */

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

@@ -1 +1 @@
-{"version":3,"file":"ViewContext.d.ts","sourceRoot":"","sources":["../../src/ViewContext.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EACnC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAoB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAExE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACrG,OAAO,EAAe,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,kCAAkC,EAAE,IAAI,EAAE,eAAe,EAAkB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC/H,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAA8B,cAAc,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAErG;;GAEG;AACH,qBAAa,aAAa;IACxB,2DAA2D;IAC3D,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,yDAAyD;IACzD,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,gEAAgE;IAChE,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAEjC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO;IAO3C,yIAAyI;IAClI,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIrD,qDAAqD;IACrD,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IAED,gBAAgB;IAChB,IAAW,MAAM,IAAI,YAAY,CAAiC;IAElE,gBAAgB;IAChB,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;IAIzG;;;OAGG;IACI,yBAAyB,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,cAAc;IAIvE,iDAAiD;IAC1C,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,oBAAoB,GAAG,aAAa;IAIlH;;;;;OAKG;IACI,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,GAAG,aAAa;IAE9E;;;OAGG;IACI,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;CAG3D;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAO,CAAC,SAAS,CAAC,CAAc;IAEhC,gGAAgG;IACzF,UAAU,CAAC,OAAO,EAAE,aAAa;IAMxC,gBAAgB;IACT,cAAc,IAAI,IAAI;IAI7B;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;CAG/F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,sBAAsB,CAAC,CAAoB;IAEnD,oFAAoF;IACpF,IAAoB,QAAQ,IAAI,cAAc,CAE7C;IAED,gBAAgB;gBACJ,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,gBAAgB;IAMjF;;;;;;;OAOG;IACI,oBAAoB,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,UAAU,GAAG,cAAc;IAItG;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;IAI9F,gBAAgB;IACT,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAmB3D,6FAA6F;IAC7F,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,cAAc;IAKtB;;;;OAIG;IACI,wBAAwB,CAAC,OAAO,EAAE,cAAc;IAIvD;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAsCjE,mFAAmF;IAC5E,mBAAmB,CAAC,UAAU,EAAE,gBAAgB,EAAE,OAAO,UAAQ;IAcxE,2FAA2F;IACpF,iBAAiB,CAAC,UAAU,EAAE,WAAW;IAYhD,gBAAgB;IACT,gBAAgB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI;IAalK;;OAEG;IACI,SAAS,CAAC,OAAO,EAAE,aAAa;IAIvC,wHAAwH;IACjH,iBAAiB,CAAC,OAAO,EAAE,aAAa;CAGhD;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,OAAO,CAAC,kBAAkB,CAAS;IACnC,yCAAyC;IACzC,SAAgB,KAAK,QAAe;IAEpC,gBAAgB;IAChB,SAAgB,YAAY,YAAmB;IAE/C,gBAAgB;IACT,mBAAmB,IAAI,IAAI;IAIlC,gBAAgB;IAChB,IAAW,eAAe,IAAI,OAAO,CAEpC;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,YAAY,CAA0C;gBAE3C,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO;IAIlD,8CAA8C;IAC9C,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED,gBAAgB;IAChB,IAAW,WAAW,oBAAgC;IAEtD,8CAA8C;IACvC,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAclD,6IAA6I;IACtI,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAU1C,gBAAgB;IACT,mBAAmB,IAAI,IAAI;IAIlC,gBAAgB;IACT,mBAAmB,CAAC,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,EAAE,kCAAkC,EAAE,cAAc,CAAC,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,SAAS;IAexL,gBAAgB;IACT,2BAA2B,CAAC,OAAO,EAAE,UAAU;IAItD,gBAAgB;IACT,wBAAwB,CAAC,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,OAAO,GAAG,SAAS,GAAG,kBAAkB,GAAG,SAAS;IAoBpI,gBAAgB;IACT,uBAAuB,CAAC,OAAO,EAAE,UAAU;IAIlD,gBAAgB;IACT,eAAe,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IASrE,+DAA+D;IAC/D,IAAW,QAAQ,oBAAoC;IACvD,2EAA2E;IAC3E,IAAW,kBAAkB,oBAAoC;IACjE,gFAAgF;IAChF,IAAW,eAAe,oBAAiC;IAC3D,gBAAgB;IAChB,IAAW,iBAAiB,wCAA2C;IACvE,gBAAgB;IAChB,IAAW,aAAa,oCAAuC;IAE/D,gBAAgB;IACT,mBAAmB,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;CAGrF"}
+{"version":3,"file":"ViewContext.d.ts","sourceRoot":"","sources":["../../src/ViewContext.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EACnC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAoB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAExE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACrG,OAAO,EAAe,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,kCAAkC,EAAE,IAAI,EAAE,eAAe,EAAkB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC/H,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAA8B,cAAc,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAErG;;GAEG;AACH,qBAAa,aAAa;IACxB,2DAA2D;IAC3D,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,yDAAyD;IACzD,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,gEAAgE;IAChE,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAEjC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO;IAO3C,yIAAyI;IAClI,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAIrD,qDAAqD;IACrD,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IAED,4EAA4E;IAC5E,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED,gBAAgB;IAChB,IAAW,MAAM,IAAI,YAAY,CAAiC;IAElE,gBAAgB;IAChB,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;IAIzG;;;OAGG;IACI,yBAAyB,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,cAAc;IAIvE,iDAAiD;IAC1C,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,oBAAoB,GAAG,aAAa;IAIlH;;;;;OAKG;IACI,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,GAAG,aAAa;IAE9E;;;OAGG;IACI,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;CAG3D;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAO,CAAC,SAAS,CAAC,CAAc;IAEhC,gGAAgG;IACzF,UAAU,CAAC,OAAO,EAAE,aAAa;IAMxC,gBAAgB;IACT,cAAc,IAAI,IAAI;IAI7B;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;CAG/F;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,sBAAsB,CAAC,CAAoB;IAEnD,oFAAoF;IACpF,IAAoB,QAAQ,IAAI,cAAc,CAE7C;IAED,gBAAgB;gBACJ,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,gBAAgB;IAMjF;;;;;;;OAOG;IACI,oBAAoB,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,UAAU,GAAG,cAAc;IAItG;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,cAAc;IAI9F,gBAAgB;IACT,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAmB3D,6FAA6F;IAC7F,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,cAAc;IAKtB;;;;OAIG;IACI,wBAAwB,CAAC,OAAO,EAAE,cAAc;IAIvD;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAsCjE,mFAAmF;IAC5E,mBAAmB,CAAC,UAAU,EAAE,gBAAgB,EAAE,OAAO,UAAQ;IAcxE,2FAA2F;IACpF,iBAAiB,CAAC,UAAU,EAAE,WAAW;IAYhD,gBAAgB;IACT,gBAAgB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,IAAI;IAalK;;OAEG;IACI,SAAS,CAAC,OAAO,EAAE,aAAa;IAIvC,wHAAwH;IACjH,iBAAiB,CAAC,OAAO,EAAE,aAAa;CAGhD;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,OAAO,CAAC,kBAAkB,CAAS;IACnC,yCAAyC;IACzC,SAAgB,KAAK,QAAe;IAEpC,gBAAgB;IAChB,SAAgB,YAAY,YAAmB;IAE/C,gBAAgB;IACT,mBAAmB,IAAI,IAAI;IAIlC,gBAAgB;IAChB,IAAW,eAAe,IAAI,OAAO,CAEpC;IAED,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,YAAY,CAA0C;gBAE3C,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO;IAIlD,8CAA8C;IAC9C,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED,gBAAgB;IAChB,IAAW,WAAW,oBAAgC;IAEtD,8CAA8C;IACvC,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAclD,6IAA6I;IACtI,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAU1C,gBAAgB;IACT,mBAAmB,IAAI,IAAI;IAIlC,gBAAgB;IACT,mBAAmB,CAAC,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,EAAE,kCAAkC,EAAE,cAAc,CAAC,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,SAAS;IAexL,gBAAgB;IACT,2BAA2B,CAAC,OAAO,EAAE,UAAU;IAItD,gBAAgB;IACT,wBAAwB,CAAC,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,OAAO,GAAG,SAAS,GAAG,kBAAkB,GAAG,SAAS;IAoBpI,gBAAgB;IACT,uBAAuB,CAAC,OAAO,EAAE,UAAU;IAIlD,gBAAgB;IACT,eAAe,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IASrE,+DAA+D;IAC/D,IAAW,QAAQ,oBAAoC;IACvD,2EAA2E;IAC3E,IAAW,kBAAkB,oBAAoC;IACjE,gFAAgF;IAChF,IAAW,eAAe,oBAAiC;IAC3D,gBAAgB;IAChB,IAAW,iBAAiB,wCAA2C;IACvE,gBAAgB;IAChB,IAAW,aAAa,oCAAuC;IAE/D,gBAAgB;IACT,mBAAmB,CAAC,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;CAGrF"}

package/lib/cjs/ViewContext.js

@@ -33,6 +33,10 @@ class RenderContext {
     get viewport() {
         return this._viewport;
     }
+    /** The [[RenderSystem]] being used to produce graphics for this context. */
+    get renderSystem() {
+        return this.target.renderSystem;
+    }
     /** @internal */
     get target() { return this.viewport.target; }
     /** @internal */