@itwin/core-frontend 5.0.0-dev.22 → 5.0.0-dev.23

package/lib/cjs/GraphicalEditingScope.js

@@ -168,7 +168,7 @@ class GraphicalEditingScope extends BriefcaseTxns_1.BriefcaseNotificationHandler
         }
         if (deletedIds) {
             this.iModel.selectionSet.remove(deletedIds);
-            this.iModel.hilited.setHilite(deletedIds, false);
+            this.iModel.hilited.remove({ elements: deletedIds });
         }
         this.onGeometryChanges.raiseEvent(changes, this);
     }

package/lib/cjs/GraphicalEditingScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicalEditingScope.js","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+I;AAE/I,oDAE4B;AAC5B,mDAA+D;AAE/D,qCAAkC;AAElC,MAAM,YAAa,SAAQ,0BAAkC;IAI3D,YAAmB,YAAwB,EAAE,KAAc;QACzD,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,8BAAe,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,qBAAsB,SAAQ,4CAA4B;IACrE,IAAW,oBAAoB,KAAK,OAAO,4BAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IA8BzE;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAA2B;QACnD,IAAI,MAAM,CAAC,YAAY;YACrB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,gIAAgI;QAChI,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/F,IAAA,qBAAM,EAAC,YAAY,CAAC,CAAC,CAAC,4CAA4C;QACpE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,CAAC;QACV,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI;YACrD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAExF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;gBAAS,CAAC;YACT,MAAM,WAAW,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpG,IAAA,qBAAM,EAAC,CAAC,WAAW,CAAC,CAAC;YACrB,IAAI,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IAED,yGAAyG;IAClG,0BAA0B,CAAC,OAAmB;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEO,CAAE,sBAAsB;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACjD,MAAM;gBACJ,EAAE,EAAE,GAAG;gBACP,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,QAAQ,EAAE,KAAK;aAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,YAAoB,MAA2B;QAC7C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAnGpB,8FAA8F;QAC7E,qBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAChE,cAAS,GAAG,KAAK,CAAC;QAW1B;;;WAGG;QACa,cAAS,GAAG,IAAI,sBAAO,EAA0C,CAAC;QAElF;;;WAGG;QACa,aAAQ,GAAG,IAAI,sBAAO,EAA0C,CAAC;QAEjF,sEAAsE;QACtD,sBAAiB,GAAG,IAAI,sBAAO,EAAmF,CAAC;QA0EjI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEtB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,qBAAqB,CAAC,KAAkC;QAC7D,MAAM,OAAO,GAAG,kCAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAClC,IAAI,UAA+B,CAAC;QAEpC,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE,CAAC;YACnC,4CAA4C;YAC5C,IAAI,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACtD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC/B,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAClD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;oBAC9C,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC3B,IAAI,uBAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI,EAAE,CAAC;oBAC3C,IAAI,SAAS,KAAK,UAAU;wBAC1B,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;oBACrC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;;AA3JH,sDA4JC;AAjJC;;GAEG;AACoB,6BAAO,GAAG,IAAI,sBAAO,EAA0C,AAAxD,CAAyD","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 { assert, BeEvent, compareStrings, DbOpcode, DuplicatePolicy, GuidString, Id64Set, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  EditingScopeNotifications, ElementGeometryChange, ipcAppChannels, ModelGeometryChanges, ModelGeometryChangesProps, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseNotificationHandler } from \"./BriefcaseTxns\";\r\nimport { BriefcaseConnection } from \"./BriefcaseConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\n\r\nclass ModelChanges extends SortedArray<ElementGeometryChange> {\r\n  public geometryGuid: GuidString;\r\n  public readonly range: Range3d;\r\n\r\n  public constructor(geometryGuid: GuidString, range: Range3d) {\r\n    super((lhs, rhs) => compareStrings(lhs.id, rhs.id), DuplicatePolicy.Replace);\r\n    this.geometryGuid = geometryGuid;\r\n    this.range = range;\r\n  }\r\n}\r\n\r\n/** Represents a period of time within an [interactive editing]($docs/learning/InteractiveEditing.md) session during which the\r\n * geometry of elements being displayed in one or more [[Viewport]]s is being modified. Outside of such a scope, whenever the\r\n * geometry within a [GeometricModel]($backend) changes new [[Tile]]s must be generated to reflect those changes in a viewport.\r\n * Regenerating entire tiles each time individual elements change can be time-consuming, which may introduce an unacceptable delay\r\n * between making a modification and seeing its result on the screen.\r\n *\r\n * Within the context of a graphical editing scope, no new tiles are generated. Instead, the geometry for any deleted or modified elements\r\n * is hidden in the tile graphics, and additional temporary graphics are displayed for any newly-inserted or modified elements. Only when the\r\n * scope exits are new tiles produced.\r\n *\r\n * The application decides when to enter and exit a graphical editing scope. A single interactive editing session may involve any number of\r\n * editing scopes. Typically, applications will enter a new editing scope (after first exiting a previous scope, if one exists):\r\n *  - When switching from a non-graphical workflow to one that involves editing geometry; or\r\n *  - When changing which geometric model is being edited; or\r\n *  - After performing an operation that creates or modifies a \"large\" number (perhaps hundreds?) of elements.\r\n *\r\n * An application should typically exit any graphical editing scope before:\r\n *  - Pulling changesets; or\r\n *  - Switching from a graphical editing workflow to some non-graphical workflow.\r\n *\r\n * Graphical editing scopes are only supported for [[BriefcaseConnection]]s opened in read-write mode that contain version 1.0.11 or newer of the BisCore schema.\r\n * @see [[BriefcaseConnection.enterEditingScope]] to create a scope for a briefcase.\r\n * @see [[BriefcaseConnection.editingScope]] to obtain a briefcase's current scope.\r\n * @see [[exit]] to terminate a scope.\r\n * @public\r\n */\r\nexport class GraphicalEditingScope extends BriefcaseNotificationHandler implements EditingScopeNotifications {\r\n  public get briefcaseChannelName() { return ipcAppChannels.editingScope; }\r\n\r\n  /** Maps model Id to accumulated changes to geometric elements within the associated model. */\r\n  private readonly _geometryChanges = new Map<Id64String, ModelChanges>();\r\n  private _disposed = false;\r\n  private _cleanup?: RemoveFunction;\r\n\r\n  /** The connection to the iModel being edited. */\r\n  public readonly iModel: BriefcaseConnection;\r\n\r\n  /** Event raised when a new scope is created for any [[BriefcaseConnection]].\r\n   * @see [[onExiting]] and [[onExited]] for complementary events.\r\n   */\r\n  public static readonly onEnter = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope is about to exit.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExited]] for an event raised after the scope exits.\r\n   */\r\n  public readonly onExiting = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope has exited.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExiting]] for an event raised just before the scope is exited.\r\n   */\r\n  public readonly onExited = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised after geometric changes are written to the iModel. */\r\n  public readonly onGeometryChanges = new BeEvent<(changes: Iterable<ModelGeometryChanges>, scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Don't call this directly - use BriefcaseConnection.enterEditingScope.\r\n   * @internal\r\n   */\r\n  public static async enter(imodel: BriefcaseConnection): Promise<GraphicalEditingScope> {\r\n    if (imodel.editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    // Register the scope synchronously, in case enter() is called again for same iModel while awaiting asynchronous initialization.\r\n    const scope = new GraphicalEditingScope(imodel);\r\n    try {\r\n      const scopeStarted = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(imodel.key, true);\r\n      assert(scopeStarted); // If it didn't, the backend threw an error.\r\n    } catch (e) {\r\n      scope.dispose();\r\n      throw e;\r\n    }\r\n\r\n    this.onEnter.raiseEvent(scope);\r\n\r\n    return scope;\r\n  }\r\n\r\n  /** Exits this editing scope. The associated [[BriefcaseConnection]]'s `editingScope` will be reset to `undefined`.\r\n   * @throws Error if the scope could not be exited, e.g., if it has already been exited.\r\n   * @see [[BriefcaseConnection.enterEditingScope]] to enter an editing scope.\r\n   */\r\n  public async exit(): Promise<void> {\r\n    if (this._disposed || this.iModel.editingScope !== this)\r\n      throw new Error(\"Cannot exit editing scope after it is disconnected from the iModel\");\r\n\r\n    this._disposed = true;\r\n    try {\r\n      this.onExiting.raiseEvent(this);\r\n    } finally {\r\n      const scopeExited = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(this.iModel.key, false);\r\n      assert(!scopeExited);\r\n      try {\r\n        this.onExited.raiseEvent(this);\r\n      } finally {\r\n        this.dispose();\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Obtain all geometric changes to elements within the specified model accumulated within this scope. */\r\n  public getGeometryChangesForModel(modelId: Id64String): Iterable<ElementGeometryChange> | undefined {\r\n    return this._geometryChanges.get(modelId);\r\n  }\r\n\r\n  /** Obtain all geometric changes to models accumulated within this scope. */\r\n  public getGeometryChanges(): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => this.geometryChangeIterator() };\r\n  }\r\n\r\n  /** @internal */\r\n  public get isDisposed() {\r\n    return this._disposed;\r\n  }\r\n\r\n  private * geometryChangeIterator(): Iterator<ModelGeometryChanges> {\r\n    for (const [key, value] of this._geometryChanges) {\r\n      yield {\r\n        id: key,\r\n        geometryGuid: value.geometryGuid,\r\n        range: value.range,\r\n        elements: value,\r\n      };\r\n    }\r\n  }\r\n\r\n  private constructor(iModel: BriefcaseConnection) {\r\n    super(iModel.key);\r\n    this.iModel = iModel;\r\n    this._cleanup = this.registerImpl();\r\n  }\r\n\r\n  private dispose(): void {\r\n    this._disposed = true;\r\n\r\n    this.onExiting.clear();\r\n    this.onGeometryChanges.clear();\r\n    this.onExited.clear();\r\n\r\n    this._geometryChanges.clear();\r\n\r\n    if (this._cleanup) {\r\n      this._cleanup();\r\n      this._cleanup = undefined;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public notifyGeometryChanged(props: ModelGeometryChangesProps[]) {\r\n    const changes = ModelGeometryChanges.iterable(props);\r\n    const modelIds: Id64String[] = [];\r\n    let deletedIds: Id64Set | undefined;\r\n\r\n    for (const modelChanges of changes) {\r\n      // ###TODO do we care about the model range?\r\n      let list = this._geometryChanges.get(modelChanges.id);\r\n      modelIds.push(modelChanges.id);\r\n      for (const elementChange of modelChanges.elements) {\r\n        if (!list) {\r\n          this._geometryChanges.set(modelChanges.id, list = new ModelChanges(modelChanges.geometryGuid, modelChanges.range));\r\n        } else {\r\n          list.geometryGuid = modelChanges.geometryGuid;\r\n          modelChanges.range.clone(list.range);\r\n        }\r\n\r\n        list.insert(elementChange);\r\n        if (DbOpcode.Delete === elementChange.type) {\r\n          if (undefined === deletedIds)\r\n            deletedIds = new Set<Id64String>();\r\n          deletedIds.add(elementChange.id);\r\n        }\r\n      }\r\n    }\r\n\r\n    if (deletedIds) {\r\n      this.iModel.selectionSet.remove(deletedIds);\r\n      this.iModel.hilited.setHilite(deletedIds, false);\r\n    }\r\n\r\n    this.onGeometryChanges.raiseEvent(changes, this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GraphicalEditingScope.js","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+I;AAE/I,oDAE4B;AAC5B,mDAA+D;AAE/D,qCAAkC;AAElC,MAAM,YAAa,SAAQ,0BAAkC;IAI3D,YAAmB,YAAwB,EAAE,KAAc;QACzD,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,8BAAe,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,qBAAsB,SAAQ,4CAA4B;IACrE,IAAW,oBAAoB,KAAK,OAAO,4BAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IA8BzE;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAA2B;QACnD,IAAI,MAAM,CAAC,YAAY;YACrB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,gIAAgI;QAChI,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/F,IAAA,qBAAM,EAAC,YAAY,CAAC,CAAC,CAAC,4CAA4C;QACpE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,CAAC;QACV,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI;YACrD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAExF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;gBAAS,CAAC;YACT,MAAM,WAAW,GAAG,MAAM,eAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpG,IAAA,qBAAM,EAAC,CAAC,WAAW,CAAC,CAAC;YACrB,IAAI,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IAED,yGAAyG;IAClG,0BAA0B,CAAC,OAAmB;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEO,CAAE,sBAAsB;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACjD,MAAM;gBACJ,EAAE,EAAE,GAAG;gBACP,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,QAAQ,EAAE,KAAK;aAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,YAAoB,MAA2B;QAC7C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAnGpB,8FAA8F;QAC7E,qBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAChE,cAAS,GAAG,KAAK,CAAC;QAW1B;;;WAGG;QACa,cAAS,GAAG,IAAI,sBAAO,EAA0C,CAAC;QAElF;;;WAGG;QACa,aAAQ,GAAG,IAAI,sBAAO,EAA0C,CAAC;QAEjF,sEAAsE;QACtD,sBAAiB,GAAG,IAAI,sBAAO,EAAmF,CAAC;QA0EjI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEtB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,qBAAqB,CAAC,KAAkC;QAC7D,MAAM,OAAO,GAAG,kCAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAClC,IAAI,UAA+B,CAAC;QAEpC,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE,CAAC;YACnC,4CAA4C;YAC5C,IAAI,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACtD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC/B,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAClD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;oBAC9C,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC3B,IAAI,uBAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI,EAAE,CAAC;oBAC3C,IAAI,SAAS,KAAK,UAAU;wBAC1B,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;oBACrC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;;AA3JH,sDA4JC;AAjJC;;GAEG;AACoB,6BAAO,GAAG,IAAI,sBAAO,EAA0C,AAAxD,CAAyD","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 { assert, BeEvent, compareStrings, DbOpcode, DuplicatePolicy, GuidString, Id64Set, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  EditingScopeNotifications, ElementGeometryChange, ipcAppChannels, ModelGeometryChanges, ModelGeometryChangesProps, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseNotificationHandler } from \"./BriefcaseTxns\";\r\nimport { BriefcaseConnection } from \"./BriefcaseConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\n\r\nclass ModelChanges extends SortedArray<ElementGeometryChange> {\r\n  public geometryGuid: GuidString;\r\n  public readonly range: Range3d;\r\n\r\n  public constructor(geometryGuid: GuidString, range: Range3d) {\r\n    super((lhs, rhs) => compareStrings(lhs.id, rhs.id), DuplicatePolicy.Replace);\r\n    this.geometryGuid = geometryGuid;\r\n    this.range = range;\r\n  }\r\n}\r\n\r\n/** Represents a period of time within an [interactive editing]($docs/learning/InteractiveEditing.md) session during which the\r\n * geometry of elements being displayed in one or more [[Viewport]]s is being modified. Outside of such a scope, whenever the\r\n * geometry within a [GeometricModel]($backend) changes new [[Tile]]s must be generated to reflect those changes in a viewport.\r\n * Regenerating entire tiles each time individual elements change can be time-consuming, which may introduce an unacceptable delay\r\n * between making a modification and seeing its result on the screen.\r\n *\r\n * Within the context of a graphical editing scope, no new tiles are generated. Instead, the geometry for any deleted or modified elements\r\n * is hidden in the tile graphics, and additional temporary graphics are displayed for any newly-inserted or modified elements. Only when the\r\n * scope exits are new tiles produced.\r\n *\r\n * The application decides when to enter and exit a graphical editing scope. A single interactive editing session may involve any number of\r\n * editing scopes. Typically, applications will enter a new editing scope (after first exiting a previous scope, if one exists):\r\n *  - When switching from a non-graphical workflow to one that involves editing geometry; or\r\n *  - When changing which geometric model is being edited; or\r\n *  - After performing an operation that creates or modifies a \"large\" number (perhaps hundreds?) of elements.\r\n *\r\n * An application should typically exit any graphical editing scope before:\r\n *  - Pulling changesets; or\r\n *  - Switching from a graphical editing workflow to some non-graphical workflow.\r\n *\r\n * Graphical editing scopes are only supported for [[BriefcaseConnection]]s opened in read-write mode that contain version 1.0.11 or newer of the BisCore schema.\r\n * @see [[BriefcaseConnection.enterEditingScope]] to create a scope for a briefcase.\r\n * @see [[BriefcaseConnection.editingScope]] to obtain a briefcase's current scope.\r\n * @see [[exit]] to terminate a scope.\r\n * @public\r\n */\r\nexport class GraphicalEditingScope extends BriefcaseNotificationHandler implements EditingScopeNotifications {\r\n  public get briefcaseChannelName() { return ipcAppChannels.editingScope; }\r\n\r\n  /** Maps model Id to accumulated changes to geometric elements within the associated model. */\r\n  private readonly _geometryChanges = new Map<Id64String, ModelChanges>();\r\n  private _disposed = false;\r\n  private _cleanup?: RemoveFunction;\r\n\r\n  /** The connection to the iModel being edited. */\r\n  public readonly iModel: BriefcaseConnection;\r\n\r\n  /** Event raised when a new scope is created for any [[BriefcaseConnection]].\r\n   * @see [[onExiting]] and [[onExited]] for complementary events.\r\n   */\r\n  public static readonly onEnter = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope is about to exit.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExited]] for an event raised after the scope exits.\r\n   */\r\n  public readonly onExiting = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope has exited.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExiting]] for an event raised just before the scope is exited.\r\n   */\r\n  public readonly onExited = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised after geometric changes are written to the iModel. */\r\n  public readonly onGeometryChanges = new BeEvent<(changes: Iterable<ModelGeometryChanges>, scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Don't call this directly - use BriefcaseConnection.enterEditingScope.\r\n   * @internal\r\n   */\r\n  public static async enter(imodel: BriefcaseConnection): Promise<GraphicalEditingScope> {\r\n    if (imodel.editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    // Register the scope synchronously, in case enter() is called again for same iModel while awaiting asynchronous initialization.\r\n    const scope = new GraphicalEditingScope(imodel);\r\n    try {\r\n      const scopeStarted = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(imodel.key, true);\r\n      assert(scopeStarted); // If it didn't, the backend threw an error.\r\n    } catch (e) {\r\n      scope.dispose();\r\n      throw e;\r\n    }\r\n\r\n    this.onEnter.raiseEvent(scope);\r\n\r\n    return scope;\r\n  }\r\n\r\n  /** Exits this editing scope. The associated [[BriefcaseConnection]]'s `editingScope` will be reset to `undefined`.\r\n   * @throws Error if the scope could not be exited, e.g., if it has already been exited.\r\n   * @see [[BriefcaseConnection.enterEditingScope]] to enter an editing scope.\r\n   */\r\n  public async exit(): Promise<void> {\r\n    if (this._disposed || this.iModel.editingScope !== this)\r\n      throw new Error(\"Cannot exit editing scope after it is disconnected from the iModel\");\r\n\r\n    this._disposed = true;\r\n    try {\r\n      this.onExiting.raiseEvent(this);\r\n    } finally {\r\n      const scopeExited = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(this.iModel.key, false);\r\n      assert(!scopeExited);\r\n      try {\r\n        this.onExited.raiseEvent(this);\r\n      } finally {\r\n        this.dispose();\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Obtain all geometric changes to elements within the specified model accumulated within this scope. */\r\n  public getGeometryChangesForModel(modelId: Id64String): Iterable<ElementGeometryChange> | undefined {\r\n    return this._geometryChanges.get(modelId);\r\n  }\r\n\r\n  /** Obtain all geometric changes to models accumulated within this scope. */\r\n  public getGeometryChanges(): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => this.geometryChangeIterator() };\r\n  }\r\n\r\n  /** @internal */\r\n  public get isDisposed() {\r\n    return this._disposed;\r\n  }\r\n\r\n  private * geometryChangeIterator(): Iterator<ModelGeometryChanges> {\r\n    for (const [key, value] of this._geometryChanges) {\r\n      yield {\r\n        id: key,\r\n        geometryGuid: value.geometryGuid,\r\n        range: value.range,\r\n        elements: value,\r\n      };\r\n    }\r\n  }\r\n\r\n  private constructor(iModel: BriefcaseConnection) {\r\n    super(iModel.key);\r\n    this.iModel = iModel;\r\n    this._cleanup = this.registerImpl();\r\n  }\r\n\r\n  private dispose(): void {\r\n    this._disposed = true;\r\n\r\n    this.onExiting.clear();\r\n    this.onGeometryChanges.clear();\r\n    this.onExited.clear();\r\n\r\n    this._geometryChanges.clear();\r\n\r\n    if (this._cleanup) {\r\n      this._cleanup();\r\n      this._cleanup = undefined;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public notifyGeometryChanged(props: ModelGeometryChangesProps[]) {\r\n    const changes = ModelGeometryChanges.iterable(props);\r\n    const modelIds: Id64String[] = [];\r\n    let deletedIds: Id64Set | undefined;\r\n\r\n    for (const modelChanges of changes) {\r\n      // ###TODO do we care about the model range?\r\n      let list = this._geometryChanges.get(modelChanges.id);\r\n      modelIds.push(modelChanges.id);\r\n      for (const elementChange of modelChanges.elements) {\r\n        if (!list) {\r\n          this._geometryChanges.set(modelChanges.id, list = new ModelChanges(modelChanges.geometryGuid, modelChanges.range));\r\n        } else {\r\n          list.geometryGuid = modelChanges.geometryGuid;\r\n          modelChanges.range.clone(list.range);\r\n        }\r\n\r\n        list.insert(elementChange);\r\n        if (DbOpcode.Delete === elementChange.type) {\r\n          if (undefined === deletedIds)\r\n            deletedIds = new Set<Id64String>();\r\n          deletedIds.add(elementChange.id);\r\n        }\r\n      }\r\n    }\r\n\r\n    if (deletedIds) {\r\n      this.iModel.selectionSet.remove(deletedIds);\r\n      this.iModel.hilited.remove({ elements: deletedIds });\r\n    }\r\n\r\n    this.onGeometryChanges.raiseEvent(changes, this);\r\n  }\r\n}\r\n"]}

package/lib/cjs/SelectionSet.d.ts

@@ -8,48 +8,68 @@ import { IModelConnection } from "./IModelConnection";
  * @extensions
  */
 export declare enum SelectionSetEventType {
-    /** Elements have been added to the set. */
+    /** Ids have been added to the set. */
     Add = 0,
-    /** Elements have been removed from the set. */
+    /** Ids have been removed from the set. */
     Remove = 1,
-    /** Some elements have been added to the set and others have been removed. */
+    /** Some ids have been added to the set and others have been removed. */
     Replace = 2,
-    /** All elements are about to be removed from the set. */
+    /** All ids have been removed from the set. */
     Clear = 3
 }
-/** Passed to [[SelectionSet.onChanged]] event listeners when elements are added to the selection set.
+/** Passed to [[SelectionSet.onChanged]] event listeners when ids are added to the selection set.
  * @public
  * @extensions
  */
 export interface SelectAddEvent {
     type: SelectionSetEventType.Add;
-    /** The Ids of the elements added to the set. */
+    /**
+     * The Ids of the elements added to the set.
+     * @deprecated in 5.0. Use the [[additions]] attribute instead.
+     */
     added: Id64Arg;
+    /** A collection of geometric element, model and subcategory ids that have been added to selection set. */
+    additions: SelectableIds;
     /** The affected SelectionSet. */
     set: SelectionSet;
 }
-/** Passed to [[SelectionSet.onChanged]] event listeners when elements are removed from the selection set.
+/** Passed to [[SelectionSet.onChanged]] event listeners when ids are removed from the selection set.
  * @public
  * @extensions
  */
 export interface SelectRemoveEvent {
     /** The type of operation that produced this event. */
     type: SelectionSetEventType.Remove | SelectionSetEventType.Clear;
-    /** The element Ids removed from the set. */
+    /**
+     * The element Ids removed from the set.
+     * @deprecated in 5.0. Use the [[removals]] attribute instead.
+     */
     removed: Id64Arg;
+    /** A collection of geometric element, model and subcategory ids that have been removed from selection set. */
+    removals: SelectableIds;
     /** The affected SelectionSet. */
     set: SelectionSet;
 }
-/** Passed to [[SelectionSet.onChanged]] event listeners when elements are simultaneously added to and removed from the selection set.
+/** Passed to [[SelectionSet.onChanged]] event listeners when ids are simultaneously added to and removed from the selection set.
  * @public
  * @extensions
  */
 export interface SelectReplaceEvent {
     type: SelectionSetEventType.Replace;
-    /** The element Ids added to the set. */
+    /**
+     * The element Ids added to the set.
+     * @deprecated in 5.0. Use the [[additions]] attribute instead.
+     */
     added: Id64Arg;
-    /** The element Ids removed from the set. */
+    /** A collection of geometric element, model and subcategory ids that have been added to selection set. */
+    additions: SelectableIds;
+    /**
+     * The element Ids removed from the set.
+     * @deprecated in 5.0. Use the [[removals]] attribute instead.
+     */
     removed: Id64Arg;
+    /** A collection of geometric element, model and subcategory ids that have been removed from selection set. */
+    removals: SelectableIds;
     /** The affected SelectionSet. */
     set: SelectionSet;
 }
@@ -58,10 +78,10 @@ export interface SelectReplaceEvent {
  *  ```ts
  *  processSelectionSetEvent(ev: SelectionSetEvent): void {
  *    if (SelectionSetEventType.Add === ev.type || SelectionSetEventType.Replace === ev.type)
- *      console.log("Added " + ev.added.size + " elements");
+ *      console.log("Added " + (ev.additions.elements?.size ?? 0) + " elements");
  *
  *    if (SelectionSetEventType.Add !== ev.type)
- *      console.log("Removed " + ev.removed.size + " elements");
+ *      console.log("Removed " + (ev.removals.elements?.size ?? 0) + " elements");
  *  }
  *  ```
  * @public
@@ -95,9 +115,10 @@ export type ModelSubCategoryHiliteMode = "union" | "intersection";
  * @extensions
  */
 export declare class HiliteSet {
+    #private;
     iModel: IModelConnection;
-    private readonly _elements;
-    private _mode;
+    /** The set of hilited elements. */
+    readonly elements: Id64.Uint32Set;
     /** The set of hilited subcategories.
      * @see [[modelSubCategoryMode]] to control how this set interacts with the set of hilited [[models]].
      * @see [[IModelConnection.Categories]] to obtain the set of subcategories associated with one or more [Category]($backend)'s.
@@ -107,8 +128,6 @@ export declare class HiliteSet {
      * @see [[modelSubCategoryMode]] to control how this set interacts with the set of hilited [[subcategories]].
      */
     readonly models: Id64.Uint32Set;
-    /** The set of hilited elements. */
-    get elements(): Id64.Uint32Set;
     /** Controls how the sets of hilited [[models]] and [[subcategories]] interact with one another.
      * By default they are treated as a union: a [Feature]($common) is hilited if either its model **or** its subcategory is hilited.
      * This can be changed to an intersection such that a [Feature]($common) is hilited only if both its model **and** subcategory are hilited.
@@ -121,16 +140,22 @@ export declare class HiliteSet {
     readonly onModelSubCategoryModeChanged: BeEvent<(newMode: ModelSubCategoryHiliteMode) => void>;
     /** Construct a HiliteSet
      * @param iModel The iModel containing the entities to be hilited.
-     * @param syncWithSelectionSet If true, the contents of the `elements` set will be synchronized with those in the `iModel`'s [[SelectionSet]].
+     * @param syncWithSelectionSet If true, the hilite set contents will be synchronized with those in the `iModel`'s [[SelectionSet]].
      */
     constructor(iModel: IModelConnection, syncWithSelectionSet?: boolean);
-    /** Control whether the hilited elements will be synchronized with the contents of the [[SelectionSet]].
+    /** Control whether the hilite set will be synchronized with the contents of the [[SelectionSet]].
      * By default they are synchronized. Applications that override this take responsibility for managing the set of hilited entities.
      * When turning synchronization off, the contents of the HiliteSet will remain unchanged.
      * When turning synchronization on, the current contents of the HiliteSet will be preserved, and the contents of the selection set will be added to them.
      */
     get wantSyncWithSelectionSet(): boolean;
     set wantSyncWithSelectionSet(want: boolean);
+    /** Adds a collection of geometric element, model and subcategory ids to this hilite set. */
+    add(additions: SelectableIds): void;
+    /** Removes a collection of geometric element, model and subcategory ids from this hilite set. */
+    remove(removals: SelectableIds): void;
+    /** Replaces ids currently in the hilite set with the given collection. */
+    replace(ids: SelectableIds): void;
     /** Remove all elements from the hilited set. */
     clear(): void;
     /** Returns true if nothing is hilited. */
@@ -138,36 +163,52 @@ export declare class HiliteSet {
     /** Toggle the hilited state of one or more elements.
      * @param arg the ID(s) of the elements whose state is to be toggled.
      * @param onOff True to add the elements to the hilited set, false to remove them.
+     * @deprecated in 5.0. Use [[add]], [[remove]], [[replace]] instead.
      */
     setHilite(arg: Id64Arg, onOff: boolean): void;
 }
-/** A set of *currently selected* elements for an IModelConnection.
- * Selected elements are displayed with a customizable hilite effect within a [[Viewport]].
+/** A set of *currently selected* geometric elements, models and subcategories for an `IModelConnection`.
+ * Generally, selected elements are displayed with a customizable hilite effect within a [[Viewport]], see [[HiliteSet]].
  * @see [Hilite.Settings]($common) for customization of the hilite effect.
  * @public
  * @extensions
  */
 export declare class SelectionSet {
+    #private;
     iModel: IModelConnection;
-    private _elements;
     /** The IDs of the selected elements.
      * @note Do not modify this set directly. Instead, use methods like [[SelectionSet.add]].
      */
-    get elements(): Set<string>;
-    /** Called whenever elements are added or removed from this SelectionSet */
+    get elements(): Set<Id64String>;
+    /** The IDs of the selected models.
+     * @note Do not modify this set directly. Instead, use methods like [[SelectionSet.add]].
+     */
+    get models(): Set<Id64String>;
+    /** The IDs of the selected subcategories.
+     * @note Do not modify this set directly. Instead, use methods like [[SelectionSet.add]].
+     */
+    get subcategories(): Set<Id64String>;
+    /** Get the active selection as a collection of geometric element, model and subcategory ids.
+     * @note Do not modify the sets in returned collection directly. Instead, use methods like [[SelectionSet.add]].
+     */
+    get active(): {
+        [P in keyof SelectableIds]-?: Set<Id64String>;
+    };
+    /** Called whenever ids are added or removed from this `SelectionSet` */
     readonly onChanged: BeEvent<(ev: SelectionSetEvent) => void>;
     constructor(iModel: IModelConnection);
-    private sendChangedEvent;
     /** Get the number of entries in this selection set. */
     get size(): number;
-    /** Check whether there are any selected elements. */
+    /** Check whether there are any ids in this selection set. */
     get isActive(): boolean;
-    /** Return true if elemId is in this SelectionSet.
+    /** Return true if elemId is in this `SelectionSet`.
      * @see [[isSelected]]
+     * @deprecated in 5.0. Use `SelectionSet.elements.has(elemId)` instead.
      */
     has(elemId?: string): boolean;
     /** Query whether an Id is in the selection set.
      * @see [[has]]
+     * @deprecated in 5.0. Use `SelectionSet.elements.has(elemId)` instead.
      */
     isSelected(elemId?: Id64String): boolean;
     /** Clear current selection set.
@@ -179,23 +220,31 @@ export declare class SelectionSet {
      * @param elem The set of Ids to add.
      * @returns true if any elements were added.
      */
-    add(elem: Id64Arg): boolean;
-    private _add;
+    add(adds: Id64Arg | SelectableIds): boolean;
     /**
      * Remove one or more Ids from the current selection set.
      * @param elem The set of Ids to remove.
      * @returns true if any elements were removed.
      */
-    remove(elem: Id64Arg): boolean;
-    private _remove;
+    remove(removes: Id64Arg | SelectableIds): boolean;
     /**
      * Add one set of Ids, and remove another set of Ids. Any Ids that are in both sets are removed.
      * @returns True if any Ids were either added or removed.
      */
-    addAndRemove(adds: Id64Arg, removes: Id64Arg): boolean;
-    /** Invert the state of a set of Ids in the SelectionSet */
-    invert(elem: Id64Arg): boolean;
+    addAndRemove(adds: Id64Arg | SelectableIds, removes: Id64Arg | SelectableIds): boolean;
+    /** Invert the state of a set of Ids in the `SelectionSet` */
+    invert(ids: Id64Arg | SelectableIds): boolean;
     /** Change selection set to be the supplied set of Ids. */
-    replace(elem: Id64Arg): void;
+    replace(ids: Id64Arg | SelectableIds): boolean;
+}
+/**
+ * A collection of geometric element, model and subcategory ids that can be added to
+ * a [[SelectionSet]] or [[HiliteSet]].
+ * @public
+ */
+export interface SelectableIds {
+    elements?: Id64Arg;
+    models?: Id64Arg;
+    subcategories?: Id64Arg;
 }
 //# sourceMappingURL=SelectionSet.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionSet.d.ts","sourceRoot":"","sources":["../../src/SelectionSet.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,oBAAY,qBAAqB;IAC/B,2CAA2C;IAC3C,GAAG,IAAA;IACH,+CAA+C;IAC/C,MAAM,IAAA;IACN,6EAA6E;IAC7E,OAAO,IAAA;IACP,yDAAyD;IACzD,KAAK,IAAA;CACN;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,qBAAqB,CAAC,GAAG,CAAC;IAChC,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,IAAI,EAAE,qBAAqB,CAAC,MAAM,GAAG,qBAAqB,CAAC,KAAK,CAAC;IACjE,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC;IACpC,wCAAwC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AA0FxF;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,cAAc,CAAC;AAElE;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,SAAS;IA0CM,MAAM,EAAE,gBAAgB;IAzClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,KAAK,CAAuC;IAEpD;;;OAGG;IACH,SAAgB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,SAAgB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;IAEvC,mCAAmC;IACnC,IAAW,QAAQ,IAAI,IAAI,CAAC,SAAS,CAA2B;IAEhE;;;;;OAKG;IACH,IAAW,oBAAoB,IAAI,0BAA0B,CAE5D;IACD,IAAW,oBAAoB,CAAC,IAAI,EAAE,0BAA0B,EAM/D;IAED,+EAA+E;IAC/E,SAAgB,6BAA6B,oBAAyB,0BAA0B,KAAK,IAAI,EAAI;IAE7G;;;OAGG;gBACuB,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,UAAO;IAM/E;;;;OAIG;IACH,IAAW,wBAAwB,IAAI,OAAO,CAAoD;IAClG,IAAW,wBAAwB,CAAC,IAAI,EAAE,OAAO,EAAqD;IAEtG,gDAAgD;IACzC,KAAK;IAMZ,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAAuF;IAEpH;;;OAGG;IACI,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;CAarD;AAED;;;;;GAKG;AACH,qBAAa,YAAY;IAWG,MAAM,EAAE,gBAAgB;IAVlD,OAAO,CAAC,SAAS,CAAqB;IAEtC;;OAEG;IACH,IAAW,QAAQ,IAAI,GAAG,CAAC,MAAM,CAAC,CAA2B;IAE7D,2EAA2E;IAC3E,SAAgB,SAAS,eAAoB,iBAAiB,KAAK,IAAI,EAAI;gBAEjD,MAAM,EAAE,gBAAgB;IAElD,OAAO,CAAC,gBAAgB;IAKxB,uDAAuD;IACvD,IAAW,IAAI,WAAiC;IAEhD,qDAAqD;IACrD,IAAW,QAAQ,YAA8B;IAEjD;;OAEG;IACI,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM;IAE1B;;OAEG;IACI,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO;IAE/C;;OAEG;IACI,QAAQ,IAAI,IAAI;IASvB;;;;OAIG;IACI,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAIlC,OAAO,CAAC,IAAI;IAYZ;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAIrC,OAAO,CAAC,OAAO;IAYf;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAc7D,2DAA2D;IACpD,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAarC,0DAA0D;IACnD,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;CAiBpC"}
+{"version":3,"file":"SelectionSet.d.ts","sourceRoot":"","sources":["../../src/SelectionSet.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAsB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,oBAAY,qBAAqB;IAC/B,sCAAsC;IACtC,GAAG,IAAA;IACH,0CAA0C;IAC1C,MAAM,IAAA;IACN,wEAAwE;IACxE,OAAO,IAAA;IACP,8CAA8C;IAC9C,KAAK,IAAA;CACN;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,qBAAqB,CAAC,GAAG,CAAC;IAChC;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf,0GAA0G;IAC1G,SAAS,EAAE,aAAa,CAAC;IACzB,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,IAAI,EAAE,qBAAqB,CAAC,MAAM,GAAG,qBAAqB,CAAC,KAAK,CAAC;IACjE;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,8GAA8G;IAC9G,QAAQ,EAAE,aAAa,CAAC;IACxB,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC;IACpC;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf,0GAA0G;IAC1G,SAAS,EAAE,aAAa,CAAC;IACzB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,8GAA8G;IAC9G,QAAQ,EAAE,aAAa,CAAC;IACxB,iCAAiC;IACjC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AAgCxF;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG,cAAc,CAAC;AAElE;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,SAAS;;IA2CM,MAAM,EAAE,gBAAgB;IAtClD,mCAAmC;IACnC,SAAgB,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;IAEzC;;;OAGG;IACH,SAAgB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;IAE9C;;OAEG;IACH,SAAgB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;IAEvC;;;;;OAKG;IACH,IAAW,oBAAoB,IAAI,0BAA0B,CAE5D;IACD,IAAW,oBAAoB,CAAC,IAAI,EAAE,0BAA0B,EAM/D;IAED,+EAA+E;IAC/E,SAAgB,6BAA6B,oBAAyB,0BAA0B,KAAK,IAAI,EAAI;IAE7G;;;OAGG;gBACuB,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,UAAO;IAO/E;;;;OAIG;IACH,IAAW,wBAAwB,IAAI,OAAO,CAE7C;IACD,IAAW,wBAAwB,CAAC,IAAI,EAAE,OAAO,EAYhD;IAkCD,4FAA4F;IACrF,GAAG,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI;IAQ1C,iGAAiG;IAC1F,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAQ5C,0EAA0E;IACnE,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAOxC,gDAAgD;IACzC,KAAK;IAQZ,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;;;OAIG;IACI,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;CAOrD;AAED;;;;;GAKG;AACH,qBAAa,YAAY;;IAoCG,MAAM,EAAE,gBAAgB;IA/BlD;;OAEG;IACH,IAAW,QAAQ,IAAI,GAAG,CAAC,UAAU,CAAC,CAErC;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,GAAG,CAAC,UAAU,CAAC,CAEnC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,GAAG,CAAC,UAAU,CAAC,CAE1C;IAED;;OAEG;IACH,IAAW,MAAM,IAAI;SAAG,CAAC,IAAI,MAAM,aAAa,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC;KAAE,CAErE;IAED,wEAAwE;IACxE,SAAgB,SAAS,eAAoB,iBAAiB,KAAK,IAAI,EAAI;gBAEjD,MAAM,EAAE,gBAAgB;IAalD,uDAAuD;IACvD,IAAW,IAAI,WAEd;IAED,6DAA6D;IAC7D,IAAW,QAAQ,YAElB;IAED;;;OAGG;IACI,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM;IAI1B;;;OAGG;IACI,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO;IAI/C;;OAEG;IACI,QAAQ,IAAI,IAAI;IAavB;;;;OAIG;IACI,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO;IA2ClD;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO;IA2CxD;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO;IAgC7F,6DAA6D;IACtD,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO;IAwBpD,0DAA0D;IACnD,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO;CA2DtD;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB"}