@itwin/core-frontend 3.2.0-dev.9 → 3.3.0-dev.2

package/lib/esm/NotificationManager.js

@@ -12,6 +12,7 @@ import { IModelApp } from "./IModelApp";
 // cSpell:words messagebox
 /** Describes the type and behavior of a [[NotifyMessageDetails]].
  * @public
+ * @extensions
  */
 export var OutputMessageType;
 (function (OutputMessageType) {
@@ -28,6 +29,7 @@ export var OutputMessageType;
 })(OutputMessageType || (OutputMessageType = {}));
 /** Classifies a [[NotifyMessageDetails]] by its level of importance.
  * @public
+ * @extensions
  */
 export var OutputMessagePriority;
 (function (OutputMessagePriority) {
@@ -41,6 +43,7 @@ export var OutputMessagePriority;
 })(OutputMessagePriority || (OutputMessagePriority = {}));
 /** Describes the alert behavior of a [[NotifyMessageDetails]].
  * @public
+ * @extensions
  */
 export var OutputMessageAlert;
 (function (OutputMessageAlert) {
@@ -50,6 +53,7 @@ export var OutputMessageAlert;
 })(OutputMessageAlert || (OutputMessageAlert = {}));
 /** Reason for ending the activity message via endActivityMessage
  * @public
+ * @extensions
  */
 export var ActivityMessageEndReason;
 (function (ActivityMessageEndReason) {
@@ -58,6 +62,7 @@ export var ActivityMessageEndReason;
 })(ActivityMessageEndReason || (ActivityMessageEndReason = {}));
 /** Describes the set of buttons displayed in a message box opened using [[NotificationManager.openMessageBox]].
  * @public
+ * @extensions
  */
 export var MessageBoxType;
 (function (MessageBoxType) {
@@ -70,6 +75,7 @@ export var MessageBoxType;
 })(MessageBoxType || (MessageBoxType = {}));
 /** Describes the icon displayed in a messagebox opened using [[NotificationManager.openMessageBox]].
  * @public
+ * @extensions
  */
 export var MessageBoxIconType;
 (function (MessageBoxIconType) {
@@ -82,6 +88,7 @@ export var MessageBoxIconType;
 })(MessageBoxIconType || (MessageBoxIconType = {}));
 /** Describes the possible return values produced when the user clicks a button in a messagebox opened using [[NotificationManager.openMessageBox]].
  * @public
+ * @extensions
  */
 export var MessageBoxValue;
 (function (MessageBoxValue) {
@@ -100,6 +107,7 @@ export var MessageBoxValue;
 })(MessageBoxValue || (MessageBoxValue = {}));
 /** Describes a message to be displayed to the user.
  * @public
+ * @extensions
  */
 export class NotifyMessageDetails {
     /** Constructor
@@ -139,6 +147,7 @@ export class NotifyMessageDetails {
 }
 /** Specifies the details of an activity message to be displayed to the user.
  * @public
+ * @extensions
  */
 export class ActivityMessageDetails {
     /**
@@ -163,6 +172,7 @@ export class ActivityMessageDetails {
  * Implementations of the NotificationManager may present the information in different ways. For example, in
  * non-interactive sessions, these messages may be saved to a log file or simply discarded.
  * @public
+ * @extensions
  */
 export class NotificationManager {
     constructor() {

package/lib/esm/NotificationManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"NotificationManager.js","sourceRoot":"","sources":["../../src/NotificationManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAS,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAoB,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAChH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,0BAA0B;AAE1B;;GAEG;AACH,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,uGAAuG;IACvG,2DAAS,CAAA;IACT,2GAA2G;IAC3G,+DAAW,CAAA;IACX,2FAA2F;IAC3F,6DAAU,CAAA;IACV,4EAA4E;IAC5E,qEAAc,CAAA;IACd,yBAAyB;IACzB,2DAAS,CAAA;AACX,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,iEAAQ,CAAA;IACR,uEAAW,CAAA;IACX,oEAAU,CAAA;IACV,wEAAY,CAAA;IACZ,kEAAS,CAAA;IACT,oEAAU,CAAA;IACV,oEAAU,CAAA;AACZ,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,2DAAQ,CAAA;IACR,+DAAU,CAAA;IACV,iEAAW,CAAA;AACb,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,iFAAa,CAAA;IACb,iFAAa,CAAA;AACf,CAAC,EAHW,wBAAwB,KAAxB,wBAAwB,QAGnC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,2DAAQ,CAAA;IACR,+CAAE,CAAA;IACF,yDAAO,CAAA;IACP,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,qDAAK,CAAA;AACP,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,mEAAY,CAAA;IACZ,yEAAe,CAAA;IACf,mEAAY,CAAA;IACZ,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,iEAAW,CAAA;AACb,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,uDAAS,CAAA;IACT,uDAAS,CAAA;IACT,iDAAM,CAAA;IACN,yDAAU,CAAA;IACV,2DAAW,CAAA;IACX,mDAAO,CAAA;IACP,iDAAM,CAAA;IACN,uDAAS,CAAA;IACT,qDAAQ,CAAA;IACR,sDAAS,CAAA;IACT,8DAAa,CAAA;IACb,4DAAY,CAAA;AACd,CAAC,EAbW,eAAe,KAAf,eAAe,QAa1B;AAUD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAO/B;;;;;;OAMG;IACH,YAA0B,QAA+B,EAAS,YAAkC,EAC3F,eAAsC,EAAS,UAAU,iBAAiB,CAAC,KAAK,EAAS,YAAY,kBAAkB,CAAC,IAAI;QAD3G,aAAQ,GAAR,QAAQ,CAAuB;QAAS,iBAAY,GAAZ,YAAY,CAAsB;QAC3F,oBAAe,GAAf,eAAe,CAAuB;QAAS,YAAO,GAAP,OAAO,CAA0B;QAAS,cAAS,GAAT,SAAS,CAA0B;QAd9H,gBAAW,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAIxC,qBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;IAUqF,CAAC;IAE1I;;;;OAIG;IACI,qBAAqB,CAAC,QAAqB,EAAE,YAAmB,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ;QACnH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,UAAuB;QACrD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,UAAU,CAAC;IAC9C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAGjC;;;;;OAKG;IACH,YAA0B,eAAwB,EAAS,oBAA6B,EAAS,oBAA6B,EAAS,sBAA+B,IAAI;QAAhJ,oBAAe,GAAf,eAAe,CAAS;QAAS,yBAAoB,GAApB,oBAAoB,CAAS;QAAS,yBAAoB,GAApB,oBAAoB,CAAS;QAAS,wBAAmB,GAAnB,mBAAmB,CAAgB;QARnK,iBAAY,GAAG,KAAK,CAAC;IAQkJ,CAAC;IAE/K,wEAAwE;IACjE,mBAAmB,KAAK,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAE1D,8EAA8E;IACvE,mBAAmB,KAAK,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC;CAC5D;AAED;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACkB,oBAAe,GAAG,IAAI,OAAO,EAAE,CAAC;IAkJlD,CAAC;IAhJC;;OAEG;IACI,iBAAiB,CAAC,GAAW,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5G;;OAEG;IACI,YAAY,CAAC,OAAe,IAAI,CAAC;IAExC,kDAAkD;IAC3C,aAAa,CAAC,QAA8B,IAAI,CAAC;IAExD;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,OAAuB,EAAE,QAA8B,EAAE,KAAyB,IAA8B,OAAO,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAExK;;;;OAIG;IACI,oBAAoB,CAAC,QAAgC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9E;;;;;OAKG;IACI,qBAAqB,CAAC,YAAkC,EAAE,gBAAwB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE3G;;;;OAIG;IACI,kBAAkB,CAAC,OAAiC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE7E,oFAAoF;IACpF,IAAW,kBAAkB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D,oDAAoD;IACpD,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,wEAAwE;IAC9D,YAAY,CAAC,YAAyB,EAAE,QAA8B,EAAE,SAAiB,EAAE,QAAyB,IAAU,CAAC;IAEzI;;;;;;;;OAQG;IACI,WAAW,CAAC,WAAwB,EAAE,OAA6B,EAAE,QAAgB,EAAE,OAAwB;QACpH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,iDAAiD;IAC1C,YAAY,KAAW,CAAC;IAE/B;;;OAGG;IACI,oBAAoB,CAAC,aAAoB,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,QAAQ,IAAU,CAAC;IAE1G,gEAAgE;IACzD,mBAAmB,KAAW,CAAC;IAEtC,mEAAmE;IAC5D,sBAAsB,KAAW,CAAC;IAEzC;;OAEG;IACI,iBAAiB,CAAC,YAAoD;QAC3E,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,QAAyB,EAAE,YAAkC,EAAE,eAAsC,EAAE,WAAgC;QAC3J,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;QACxJ,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,UAAuB,EAAE,QAAyB,EAAE,YAAkC,EAAE,eAAsC;QAC5J,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QAClH,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAEO,yBAAyB,CAAC,QAAyB;QACzD,QAAQ,QAAQ,EAAE;YAChB,KAAK,eAAe,CAAC,WAAW;gBAC9B,OAAO,qBAAqB,CAAC,IAAI,CAAC;YACpC,KAAK,eAAe,CAAC,OAAO;gBAC1B,OAAO,qBAAqB,CAAC,OAAO,CAAC;YACvC,KAAK,eAAe,CAAC,KAAK;gBACxB,OAAO,qBAAqB,CAAC,KAAK,CAAC;YACrC,KAAK,eAAe,CAAC,KAAK;gBACxB,OAAO,qBAAqB,CAAC,KAAK,CAAC;YACrC,KAAK,eAAe,CAAC,IAAI,CAAC;YAC1B;gBACE,OAAO,qBAAqB,CAAC,IAAI,CAAC;SACrC;IACH,CAAC;IAEO,kBAAkB,CAAC,aAAkC;QAC3D,QAAQ,aAAa,EAAE;YACrB,KAAK,kBAAkB,CAAC,KAAK;gBAC3B,OAAO,iBAAiB,CAAC,KAAK,CAAC;YACjC,KAAK,kBAAkB,CAAC,UAAU;gBAChC,OAAO,iBAAiB,CAAC,UAAU,CAAC;YACtC,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,iBAAiB,CAAC,MAAM,CAAC;YAClC,KAAK,kBAAkB,CAAC,KAAK;gBAC3B,OAAO,iBAAiB,CAAC,KAAK,CAAC;YACjC;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;CAEF","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 Notifications\r\n */\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { Point2d, XAndY } from \"@itwin/core-geometry\";\r\nimport { DisplayMessageType, MessagePresenter, MessageSeverity, RelativePosition } from \"@itwin/appui-abstract\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { ToolAssistanceInstructions } from \"./tools/ToolAssistance\";\r\n\r\n// cSpell:words messagebox\r\n\r\n/** Describes the type and behavior of a [[NotifyMessageDetails]].\r\n * @public\r\n */\r\nexport enum OutputMessageType {\r\n  /** Temporary message box displays at the top or bottom of the screen then disappears automatically. */\r\n  Toast = 0,\r\n  /** Message box displays near the cursor over a Viewport and is closed by calling `closePointerMessage`. */\r\n  Pointer = 1,\r\n  /** Message box displays at the top or bottom of the screen and contains a Close button. */\r\n  Sticky = 2,\r\n  /** Message box displays near an input field and contains a Close button. */\r\n  InputField = 3,\r\n  /** Modal message box. */\r\n  Alert = 4,\r\n}\r\n\r\n/** Classifies a [[NotifyMessageDetails]] by its level of importance.\r\n * @public\r\n */\r\nexport enum OutputMessagePriority {\r\n  None = 0,\r\n  Success = 1,\r\n  Error = 10,\r\n  Warning = 11,\r\n  Info = 12,\r\n  Debug = 13,\r\n  Fatal = 17,\r\n}\r\n\r\n/** Describes the alert behavior of a [[NotifyMessageDetails]].\r\n * @public\r\n */\r\nexport enum OutputMessageAlert {\r\n  None = 0,\r\n  Dialog = 1,\r\n  Balloon = 2,\r\n}\r\n\r\n/** Reason for ending the activity message via endActivityMessage\r\n * @public\r\n */\r\nexport enum ActivityMessageEndReason {\r\n  Completed = 0,\r\n  Cancelled = 1,\r\n}\r\n\r\n/** Describes the set of buttons displayed in a message box opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n */\r\nexport enum MessageBoxType {\r\n  OkCancel,\r\n  Ok,\r\n  LargeOk,\r\n  MediumAlert,\r\n  YesNoCancel,\r\n  YesNo,\r\n}\r\n\r\n/** Describes the icon displayed in a messagebox opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n */\r\nexport enum MessageBoxIconType {\r\n  NoSymbol = 0,   // Means Don't draw Symbol\r\n  Information = 1,   // Lower Case i\r\n  Question = 2,   // Question Mark\r\n  Warning = 3,   // Exclamation Point\r\n  Critical = 4,   // Stop Sign\r\n  Success = 5, // check mark\r\n}\r\n\r\n/** Describes the possible return values produced when the user clicks a button in a messagebox opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n */\r\nexport enum MessageBoxValue {\r\n  Apply = 1,\r\n  Reset = 2,\r\n  Ok = 3,\r\n  Cancel = 4,\r\n  Default = 5,\r\n  Yes = 6,\r\n  No = 7,\r\n  Retry = 8,\r\n  Stop = 9,\r\n  Help = 10,\r\n  YesToAll = 11,\r\n  NoToAll = 12,\r\n}\r\n\r\n/** Describes the behavior of a tooltip created using [[NotificationManager.openToolTip]].\r\n * @public\r\n */\r\nexport interface ToolTipOptions {\r\n  duration?: BeDuration;\r\n  placement?: string;\r\n}\r\n\r\n/** Describes a message to be displayed to the user.\r\n * @public\r\n */\r\nexport class NotifyMessageDetails {\r\n  public displayTime = BeDuration.fromSeconds(5);\r\n  public viewport?: HTMLElement;\r\n  public inputField?: HTMLElement;\r\n  public displayPoint?: Point2d;\r\n  public relativePosition = RelativePosition.TopRight;\r\n\r\n  /** Constructor\r\n   * @param priority          The priority this message should be accorded by the NotificationManager.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   * @param msgType           The type of message. Defaults to Toast.\r\n   * @param openAlert         Whether an alert box should be displayed or not, and if so what kind.\r\n   */\r\n  public constructor(public priority: OutputMessagePriority, public briefMessage: HTMLElement | string,\r\n    public detailedMessage?: HTMLElement | string, public msgType = OutputMessageType.Toast, public openAlert = OutputMessageAlert.None) { }\r\n\r\n  /** Set OutputMessageType.Pointer message details.\r\n   * @param viewport          Viewport over which to display the Pointer type message.\r\n   * @param displayPoint      Point at which to display the Pointer type message.\r\n   * @param relativePosition  Position relative to displayPoint at which to display the Pointer type message.\r\n   */\r\n  public setPointerTypeDetails(viewport: HTMLElement, displayPoint: XAndY, relativePosition = RelativePosition.TopRight) {\r\n    this.viewport = viewport;\r\n    this.displayPoint = Point2d.fromJSON(displayPoint);\r\n    this.relativePosition = relativePosition;\r\n    this.msgType = OutputMessageType.Pointer;\r\n  }\r\n\r\n  /** Set OutputMessageType.InputField message details.\r\n   * @param inputField        Input field to which the message pertains. The message will be shown just below this input field element.\r\n   */\r\n  public setInputFieldTypeDetails(inputField: HTMLElement) {\r\n    this.inputField = inputField;\r\n    this.msgType = OutputMessageType.InputField;\r\n  }\r\n}\r\n\r\n/** Specifies the details of an activity message to be displayed to the user.\r\n * @public\r\n */\r\nexport class ActivityMessageDetails {\r\n  public wasCancelled = false;\r\n\r\n  /**\r\n   * @param showProgressBar         Indicates whether to show the progress bar in the activity message dialog.\r\n   * @param showPercentInMessage    Indicates whether to show the percentage complete in the activity message text.\r\n   * @param supportsCancellation    Indicates whether to show the Cancel button, giving the user the ability to cancel the operation.\r\n   * @param showDialogInitially     Indicates whether to show the activity message dialog initially. User can click status bar to open it.\r\n   */\r\n  public constructor(public showProgressBar: boolean, public showPercentInMessage: boolean, public supportsCancellation: boolean, public showDialogInitially: boolean = true) { }\r\n\r\n  /** Called from NotificationAdmin when the user cancels the activity. */\r\n  public onActivityCancelled() { this.wasCancelled = true; }\r\n\r\n  /** Called from NotificationAdmin when the activity completes successfully. */\r\n  public onActivityCompleted() { this.wasCancelled = false; }\r\n}\r\n\r\n/** The NotificationManager controls the interaction with the user for prompts, error messages, and alert dialogs.\r\n * Implementations of the NotificationManager may present the information in different ways. For example, in\r\n * non-interactive sessions, these messages may be saved to a log file or simply discarded.\r\n * @public\r\n */\r\nexport class NotificationManager implements MessagePresenter {\r\n  public readonly toolTipLocation = new Point2d();\r\n\r\n  /** Output a prompt, given a localization key.\r\n   * @param key The key of the localized string with the prompt message.\r\n   */\r\n  public outputPromptByKey(key: string) { this.outputPrompt(IModelApp.localization.getLocalizedString(key)); }\r\n\r\n  /** Output a localized prompt to the user. A 'prompt' indicates an action the user should take to proceed.\r\n   * @param _prompt The localized string with the prompt message.\r\n   */\r\n  public outputPrompt(_prompt: string) { }\r\n\r\n  /** Output a message and/or alert to the user.  */\r\n  public outputMessage(_message: NotifyMessageDetails) { }\r\n\r\n  /** Output a MessageBox and wait for response from the user.\r\n   * @param _mbType       The MessageBox type.\r\n   * @param _message      The message to display.\r\n   * @param _icon         The MessageBox icon type.\r\n   * @return the response from the user.\r\n   */\r\n  public async openMessageBox(_mbType: MessageBoxType, _message: HTMLElement | string, _icon: MessageBoxIconType): Promise<MessageBoxValue> { return MessageBoxValue.Ok; }\r\n\r\n  /**\r\n   * Set up for activity messages.\r\n   * @param _details  The activity message details.\r\n   * @return true if the message was displayed, false if an invalid priority is specified.\r\n   */\r\n  public setupActivityMessage(_details: ActivityMessageDetails) { return true; }\r\n\r\n  /**\r\n   * Output an activity message to the user.\r\n   * @param _messageText The message text.\r\n   * @param _percentComplete The percentage of completion.\r\n   * @return true if the message was displayed, false if the message could not be displayed.\r\n   */\r\n  public outputActivityMessage(_messageText: HTMLElement | string, _percentComplete: number) { return true; }\r\n\r\n  /**\r\n   * End an activity message.\r\n   * @param _reason The reason for the end of the Activity Message.\r\n   * @return true if the message was ended successfully, false if the activityMessage could not be ended.\r\n   */\r\n  public endActivityMessage(_reason: ActivityMessageEndReason) { return true; }\r\n\r\n  /** Return true if _showTooltip has an implementation and will display a tooltip. */\r\n  public get isToolTipSupported(): boolean { return false; }\r\n\r\n  /** Return true if the tooltip is currently open. */\r\n  public get isToolTipOpen(): boolean { return false; }\r\n\r\n  /** Implement to display a tooltip message at the specified location. */\r\n  protected _showToolTip(_htmlElement: HTMLElement, _message: HTMLElement | string, _location?: XAndY, _options?: ToolTipOptions): void { }\r\n\r\n  /** Show a tooltip window. Saves tooltip location for AccuSnap to test if cursor has moved far enough away to close tooltip.\r\n   * @param htmlElement The HTMLElement that anchors the toolTip.\r\n   * @param message What to display inside the ToolTip. May be a string or an HTMLElement.\r\n   * @param location An optional location, relative to the origin of _htmlElement, for the ToolTip. If undefined, center of `htmlElement`\r\n   * @param options Options that supply additional information about how the ToolTip should function.\r\n   * @note If message is an HTMLElement, the notification manager will display the HTMLElement verbatim. This can represent a security\r\n   * risk if any part the element is created from user input. Applications should be careful to *sanitize* any such input before\r\n   * creating an HTMLElement to pass to this method.\r\n   */\r\n  public openToolTip(htmlElement: HTMLElement, message: HTMLElement | string, location?: XAndY, options?: ToolTipOptions): void {\r\n    this.toolTipLocation.setFrom(location);\r\n    this._showToolTip(htmlElement, message, location, options);\r\n  }\r\n\r\n  /** Clear the tooltip if it is currently open. */\r\n  public clearToolTip(): void { }\r\n\r\n  /** Update message position created with [[OutputMessageType.Pointer]].\r\n   * @param displayPoint        Point at which to display the Pointer type message.\r\n   * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.\r\n   */\r\n  public updatePointerMessage(_displayPoint: XAndY, _relativePosition = RelativePosition.TopRight): void { }\r\n\r\n  /** Close message created with [[OutputMessageType.Pointer]]. */\r\n  public closePointerMessage(): void { }\r\n\r\n  /** Close message created with [[OutputMessageType.InputField]]. */\r\n  public closeInputFieldMessage(): void { }\r\n\r\n  /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.\r\n   * @param instructions The tool assistance instructions.\r\n   */\r\n  public setToolAssistance(instructions: ToolAssistanceInstructions | undefined) {\r\n    this.outputPrompt(instructions ? instructions.mainInstruction.text : \"\");\r\n  }\r\n\r\n  /**\r\n   * Displays a notification message.\r\n   * @param severity          The severity of the message.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   * @param messageType       The type of message. Defaults to Toast.\r\n   */\r\n  public displayMessage(severity: MessageSeverity, briefMessage: HTMLElement | string, detailedMessage?: HTMLElement | string, messageType?: DisplayMessageType): void {\r\n    const details = new NotifyMessageDetails(this.convertSeverityToPriority(severity), briefMessage, detailedMessage, this.convertMessageType(messageType));\r\n    this.outputMessage(details);\r\n  }\r\n\r\n  /**\r\n   * Displays an input field notification message.\r\n   * @param inputField        Input field to which the message pertains. The message will be shown just below this input field element.\r\n   * @param severity          The severity of the message.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   */\r\n  public displayInputFieldMessage(inputField: HTMLElement, severity: MessageSeverity, briefMessage: HTMLElement | string, detailedMessage?: HTMLElement | string): void {\r\n    const details = new NotifyMessageDetails(this.convertSeverityToPriority(severity), briefMessage, detailedMessage);\r\n    details.setInputFieldTypeDetails(inputField);\r\n    this.outputMessage(details);\r\n  }\r\n\r\n  private convertSeverityToPriority(severity: MessageSeverity): OutputMessagePriority {\r\n    switch (severity) {\r\n      case MessageSeverity.Information:\r\n        return OutputMessagePriority.Info;\r\n      case MessageSeverity.Warning:\r\n        return OutputMessagePriority.Warning;\r\n      case MessageSeverity.Error:\r\n        return OutputMessagePriority.Error;\r\n      case MessageSeverity.Fatal:\r\n        return OutputMessagePriority.Fatal;\r\n      case MessageSeverity.None:\r\n      default:\r\n        return OutputMessagePriority.None;\r\n    }\r\n  }\r\n\r\n  private convertMessageType(inMessageType?: DisplayMessageType): OutputMessageType | undefined {\r\n    switch (inMessageType) {\r\n      case DisplayMessageType.Alert:\r\n        return OutputMessageType.Alert;\r\n      case DisplayMessageType.InputField:\r\n        return OutputMessageType.InputField;\r\n      case DisplayMessageType.Sticky:\r\n        return OutputMessageType.Sticky;\r\n      case DisplayMessageType.Toast:\r\n        return OutputMessageType.Toast;\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"NotificationManager.js","sourceRoot":"","sources":["../../src/NotificationManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAS,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAoB,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAChH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,0BAA0B;AAE1B;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,uGAAuG;IACvG,2DAAS,CAAA;IACT,2GAA2G;IAC3G,+DAAW,CAAA;IACX,2FAA2F;IAC3F,6DAAU,CAAA;IACV,4EAA4E;IAC5E,qEAAc,CAAA;IACd,yBAAyB;IACzB,2DAAS,CAAA;AACX,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,iEAAQ,CAAA;IACR,uEAAW,CAAA;IACX,oEAAU,CAAA;IACV,wEAAY,CAAA;IACZ,kEAAS,CAAA;IACT,oEAAU,CAAA;IACV,oEAAU,CAAA;AACZ,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,2DAAQ,CAAA;IACR,+DAAU,CAAA;IACV,iEAAW,CAAA;AACb,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,iFAAa,CAAA;IACb,iFAAa,CAAA;AACf,CAAC,EAHW,wBAAwB,KAAxB,wBAAwB,QAGnC;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,2DAAQ,CAAA;IACR,+CAAE,CAAA;IACF,yDAAO,CAAA;IACP,iEAAW,CAAA;IACX,iEAAW,CAAA;IACX,qDAAK,CAAA;AACP,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,mEAAY,CAAA;IACZ,yEAAe,CAAA;IACf,mEAAY,CAAA;IACZ,iEAAW,CAAA;IACX,mEAAY,CAAA;IACZ,iEAAW,CAAA;AACb,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,uDAAS,CAAA;IACT,uDAAS,CAAA;IACT,iDAAM,CAAA;IACN,yDAAU,CAAA;IACV,2DAAW,CAAA;IACX,mDAAO,CAAA;IACP,iDAAM,CAAA;IACN,uDAAS,CAAA;IACT,qDAAQ,CAAA;IACR,sDAAS,CAAA;IACT,8DAAa,CAAA;IACb,4DAAY,CAAA;AACd,CAAC,EAbW,eAAe,KAAf,eAAe,QAa1B;AAWD;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAO/B;;;;;;OAMG;IACH,YAA0B,QAA+B,EAAS,YAAkC,EAC3F,eAAsC,EAAS,UAAU,iBAAiB,CAAC,KAAK,EAAS,YAAY,kBAAkB,CAAC,IAAI;QAD3G,aAAQ,GAAR,QAAQ,CAAuB;QAAS,iBAAY,GAAZ,YAAY,CAAsB;QAC3F,oBAAe,GAAf,eAAe,CAAuB;QAAS,YAAO,GAAP,OAAO,CAA0B;QAAS,cAAS,GAAT,SAAS,CAA0B;QAd9H,gBAAW,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAIxC,qBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;IAUqF,CAAC;IAE1I;;;;OAIG;IACI,qBAAqB,CAAC,QAAqB,EAAE,YAAmB,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ;QACnH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,UAAuB;QACrD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,UAAU,CAAC;IAC9C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,sBAAsB;IAGjC;;;;;OAKG;IACH,YAA0B,eAAwB,EAAS,oBAA6B,EAAS,oBAA6B,EAAS,sBAA+B,IAAI;QAAhJ,oBAAe,GAAf,eAAe,CAAS;QAAS,yBAAoB,GAApB,oBAAoB,CAAS;QAAS,yBAAoB,GAApB,oBAAoB,CAAS;QAAS,wBAAmB,GAAnB,mBAAmB,CAAgB;QARnK,iBAAY,GAAG,KAAK,CAAC;IAQkJ,CAAC;IAE/K,wEAAwE;IACjE,mBAAmB,KAAK,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAE1D,8EAA8E;IACvE,mBAAmB,KAAK,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACkB,oBAAe,GAAG,IAAI,OAAO,EAAE,CAAC;IAkJlD,CAAC;IAhJC;;OAEG;IACI,iBAAiB,CAAC,GAAW,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5G;;OAEG;IACI,YAAY,CAAC,OAAe,IAAI,CAAC;IAExC,kDAAkD;IAC3C,aAAa,CAAC,QAA8B,IAAI,CAAC;IAExD;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,OAAuB,EAAE,QAA8B,EAAE,KAAyB,IAA8B,OAAO,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAExK;;;;OAIG;IACI,oBAAoB,CAAC,QAAgC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9E;;;;;OAKG;IACI,qBAAqB,CAAC,YAAkC,EAAE,gBAAwB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE3G;;;;OAIG;IACI,kBAAkB,CAAC,OAAiC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IAE7E,oFAAoF;IACpF,IAAW,kBAAkB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D,oDAAoD;IACpD,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,wEAAwE;IAC9D,YAAY,CAAC,YAAyB,EAAE,QAA8B,EAAE,SAAiB,EAAE,QAAyB,IAAU,CAAC;IAEzI;;;;;;;;OAQG;IACI,WAAW,CAAC,WAAwB,EAAE,OAA6B,EAAE,QAAgB,EAAE,OAAwB;QACpH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,iDAAiD;IAC1C,YAAY,KAAW,CAAC;IAE/B;;;OAGG;IACI,oBAAoB,CAAC,aAAoB,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,QAAQ,IAAU,CAAC;IAE1G,gEAAgE;IACzD,mBAAmB,KAAW,CAAC;IAEtC,mEAAmE;IAC5D,sBAAsB,KAAW,CAAC;IAEzC;;OAEG;IACI,iBAAiB,CAAC,YAAoD;QAC3E,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,QAAyB,EAAE,YAAkC,EAAE,eAAsC,EAAE,WAAgC;QAC3J,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;QACxJ,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAAC,UAAuB,EAAE,QAAyB,EAAE,YAAkC,EAAE,eAAsC;QAC5J,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QAClH,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAEO,yBAAyB,CAAC,QAAyB;QACzD,QAAQ,QAAQ,EAAE;YAChB,KAAK,eAAe,CAAC,WAAW;gBAC9B,OAAO,qBAAqB,CAAC,IAAI,CAAC;YACpC,KAAK,eAAe,CAAC,OAAO;gBAC1B,OAAO,qBAAqB,CAAC,OAAO,CAAC;YACvC,KAAK,eAAe,CAAC,KAAK;gBACxB,OAAO,qBAAqB,CAAC,KAAK,CAAC;YACrC,KAAK,eAAe,CAAC,KAAK;gBACxB,OAAO,qBAAqB,CAAC,KAAK,CAAC;YACrC,KAAK,eAAe,CAAC,IAAI,CAAC;YAC1B;gBACE,OAAO,qBAAqB,CAAC,IAAI,CAAC;SACrC;IACH,CAAC;IAEO,kBAAkB,CAAC,aAAkC;QAC3D,QAAQ,aAAa,EAAE;YACrB,KAAK,kBAAkB,CAAC,KAAK;gBAC3B,OAAO,iBAAiB,CAAC,KAAK,CAAC;YACjC,KAAK,kBAAkB,CAAC,UAAU;gBAChC,OAAO,iBAAiB,CAAC,UAAU,CAAC;YACtC,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,iBAAiB,CAAC,MAAM,CAAC;YAClC,KAAK,kBAAkB,CAAC,KAAK;gBAC3B,OAAO,iBAAiB,CAAC,KAAK,CAAC;YACjC;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;CAEF","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 Notifications\r\n */\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { Point2d, XAndY } from \"@itwin/core-geometry\";\r\nimport { DisplayMessageType, MessagePresenter, MessageSeverity, RelativePosition } from \"@itwin/appui-abstract\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { ToolAssistanceInstructions } from \"./tools/ToolAssistance\";\r\n\r\n// cSpell:words messagebox\r\n\r\n/** Describes the type and behavior of a [[NotifyMessageDetails]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum OutputMessageType {\r\n  /** Temporary message box displays at the top or bottom of the screen then disappears automatically. */\r\n  Toast = 0,\r\n  /** Message box displays near the cursor over a Viewport and is closed by calling `closePointerMessage`. */\r\n  Pointer = 1,\r\n  /** Message box displays at the top or bottom of the screen and contains a Close button. */\r\n  Sticky = 2,\r\n  /** Message box displays near an input field and contains a Close button. */\r\n  InputField = 3,\r\n  /** Modal message box. */\r\n  Alert = 4,\r\n}\r\n\r\n/** Classifies a [[NotifyMessageDetails]] by its level of importance.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum OutputMessagePriority {\r\n  None = 0,\r\n  Success = 1,\r\n  Error = 10,\r\n  Warning = 11,\r\n  Info = 12,\r\n  Debug = 13,\r\n  Fatal = 17,\r\n}\r\n\r\n/** Describes the alert behavior of a [[NotifyMessageDetails]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum OutputMessageAlert {\r\n  None = 0,\r\n  Dialog = 1,\r\n  Balloon = 2,\r\n}\r\n\r\n/** Reason for ending the activity message via endActivityMessage\r\n * @public\r\n * @extensions\r\n */\r\nexport enum ActivityMessageEndReason {\r\n  Completed = 0,\r\n  Cancelled = 1,\r\n}\r\n\r\n/** Describes the set of buttons displayed in a message box opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum MessageBoxType {\r\n  OkCancel,\r\n  Ok,\r\n  LargeOk,\r\n  MediumAlert,\r\n  YesNoCancel,\r\n  YesNo,\r\n}\r\n\r\n/** Describes the icon displayed in a messagebox opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum MessageBoxIconType {\r\n  NoSymbol = 0,   // Means Don't draw Symbol\r\n  Information = 1,   // Lower Case i\r\n  Question = 2,   // Question Mark\r\n  Warning = 3,   // Exclamation Point\r\n  Critical = 4,   // Stop Sign\r\n  Success = 5, // check mark\r\n}\r\n\r\n/** Describes the possible return values produced when the user clicks a button in a messagebox opened using [[NotificationManager.openMessageBox]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum MessageBoxValue {\r\n  Apply = 1,\r\n  Reset = 2,\r\n  Ok = 3,\r\n  Cancel = 4,\r\n  Default = 5,\r\n  Yes = 6,\r\n  No = 7,\r\n  Retry = 8,\r\n  Stop = 9,\r\n  Help = 10,\r\n  YesToAll = 11,\r\n  NoToAll = 12,\r\n}\r\n\r\n/** Describes the behavior of a tooltip created using [[NotificationManager.openToolTip]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ToolTipOptions {\r\n  duration?: BeDuration;\r\n  placement?: string;\r\n}\r\n\r\n/** Describes a message to be displayed to the user.\r\n * @public\r\n * @extensions\r\n */\r\nexport class NotifyMessageDetails {\r\n  public displayTime = BeDuration.fromSeconds(5);\r\n  public viewport?: HTMLElement;\r\n  public inputField?: HTMLElement;\r\n  public displayPoint?: Point2d;\r\n  public relativePosition = RelativePosition.TopRight;\r\n\r\n  /** Constructor\r\n   * @param priority          The priority this message should be accorded by the NotificationManager.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   * @param msgType           The type of message. Defaults to Toast.\r\n   * @param openAlert         Whether an alert box should be displayed or not, and if so what kind.\r\n   */\r\n  public constructor(public priority: OutputMessagePriority, public briefMessage: HTMLElement | string,\r\n    public detailedMessage?: HTMLElement | string, public msgType = OutputMessageType.Toast, public openAlert = OutputMessageAlert.None) { }\r\n\r\n  /** Set OutputMessageType.Pointer message details.\r\n   * @param viewport          Viewport over which to display the Pointer type message.\r\n   * @param displayPoint      Point at which to display the Pointer type message.\r\n   * @param relativePosition  Position relative to displayPoint at which to display the Pointer type message.\r\n   */\r\n  public setPointerTypeDetails(viewport: HTMLElement, displayPoint: XAndY, relativePosition = RelativePosition.TopRight) {\r\n    this.viewport = viewport;\r\n    this.displayPoint = Point2d.fromJSON(displayPoint);\r\n    this.relativePosition = relativePosition;\r\n    this.msgType = OutputMessageType.Pointer;\r\n  }\r\n\r\n  /** Set OutputMessageType.InputField message details.\r\n   * @param inputField        Input field to which the message pertains. The message will be shown just below this input field element.\r\n   */\r\n  public setInputFieldTypeDetails(inputField: HTMLElement) {\r\n    this.inputField = inputField;\r\n    this.msgType = OutputMessageType.InputField;\r\n  }\r\n}\r\n\r\n/** Specifies the details of an activity message to be displayed to the user.\r\n * @public\r\n * @extensions\r\n */\r\nexport class ActivityMessageDetails {\r\n  public wasCancelled = false;\r\n\r\n  /**\r\n   * @param showProgressBar         Indicates whether to show the progress bar in the activity message dialog.\r\n   * @param showPercentInMessage    Indicates whether to show the percentage complete in the activity message text.\r\n   * @param supportsCancellation    Indicates whether to show the Cancel button, giving the user the ability to cancel the operation.\r\n   * @param showDialogInitially     Indicates whether to show the activity message dialog initially. User can click status bar to open it.\r\n   */\r\n  public constructor(public showProgressBar: boolean, public showPercentInMessage: boolean, public supportsCancellation: boolean, public showDialogInitially: boolean = true) { }\r\n\r\n  /** Called from NotificationAdmin when the user cancels the activity. */\r\n  public onActivityCancelled() { this.wasCancelled = true; }\r\n\r\n  /** Called from NotificationAdmin when the activity completes successfully. */\r\n  public onActivityCompleted() { this.wasCancelled = false; }\r\n}\r\n\r\n/** The NotificationManager controls the interaction with the user for prompts, error messages, and alert dialogs.\r\n * Implementations of the NotificationManager may present the information in different ways. For example, in\r\n * non-interactive sessions, these messages may be saved to a log file or simply discarded.\r\n * @public\r\n * @extensions\r\n */\r\nexport class NotificationManager implements MessagePresenter {\r\n  public readonly toolTipLocation = new Point2d();\r\n\r\n  /** Output a prompt, given a localization key.\r\n   * @param key The key of the localized string with the prompt message.\r\n   */\r\n  public outputPromptByKey(key: string) { this.outputPrompt(IModelApp.localization.getLocalizedString(key)); }\r\n\r\n  /** Output a localized prompt to the user. A 'prompt' indicates an action the user should take to proceed.\r\n   * @param _prompt The localized string with the prompt message.\r\n   */\r\n  public outputPrompt(_prompt: string) { }\r\n\r\n  /** Output a message and/or alert to the user.  */\r\n  public outputMessage(_message: NotifyMessageDetails) { }\r\n\r\n  /** Output a MessageBox and wait for response from the user.\r\n   * @param _mbType       The MessageBox type.\r\n   * @param _message      The message to display.\r\n   * @param _icon         The MessageBox icon type.\r\n   * @return the response from the user.\r\n   */\r\n  public async openMessageBox(_mbType: MessageBoxType, _message: HTMLElement | string, _icon: MessageBoxIconType): Promise<MessageBoxValue> { return MessageBoxValue.Ok; }\r\n\r\n  /**\r\n   * Set up for activity messages.\r\n   * @param _details  The activity message details.\r\n   * @return true if the message was displayed, false if an invalid priority is specified.\r\n   */\r\n  public setupActivityMessage(_details: ActivityMessageDetails) { return true; }\r\n\r\n  /**\r\n   * Output an activity message to the user.\r\n   * @param _messageText The message text.\r\n   * @param _percentComplete The percentage of completion.\r\n   * @return true if the message was displayed, false if the message could not be displayed.\r\n   */\r\n  public outputActivityMessage(_messageText: HTMLElement | string, _percentComplete: number) { return true; }\r\n\r\n  /**\r\n   * End an activity message.\r\n   * @param _reason The reason for the end of the Activity Message.\r\n   * @return true if the message was ended successfully, false if the activityMessage could not be ended.\r\n   */\r\n  public endActivityMessage(_reason: ActivityMessageEndReason) { return true; }\r\n\r\n  /** Return true if _showTooltip has an implementation and will display a tooltip. */\r\n  public get isToolTipSupported(): boolean { return false; }\r\n\r\n  /** Return true if the tooltip is currently open. */\r\n  public get isToolTipOpen(): boolean { return false; }\r\n\r\n  /** Implement to display a tooltip message at the specified location. */\r\n  protected _showToolTip(_htmlElement: HTMLElement, _message: HTMLElement | string, _location?: XAndY, _options?: ToolTipOptions): void { }\r\n\r\n  /** Show a tooltip window. Saves tooltip location for AccuSnap to test if cursor has moved far enough away to close tooltip.\r\n   * @param htmlElement The HTMLElement that anchors the toolTip.\r\n   * @param message What to display inside the ToolTip. May be a string or an HTMLElement.\r\n   * @param location An optional location, relative to the origin of _htmlElement, for the ToolTip. If undefined, center of `htmlElement`\r\n   * @param options Options that supply additional information about how the ToolTip should function.\r\n   * @note If message is an HTMLElement, the notification manager will display the HTMLElement verbatim. This can represent a security\r\n   * risk if any part the element is created from user input. Applications should be careful to *sanitize* any such input before\r\n   * creating an HTMLElement to pass to this method.\r\n   */\r\n  public openToolTip(htmlElement: HTMLElement, message: HTMLElement | string, location?: XAndY, options?: ToolTipOptions): void {\r\n    this.toolTipLocation.setFrom(location);\r\n    this._showToolTip(htmlElement, message, location, options);\r\n  }\r\n\r\n  /** Clear the tooltip if it is currently open. */\r\n  public clearToolTip(): void { }\r\n\r\n  /** Update message position created with [[OutputMessageType.Pointer]].\r\n   * @param displayPoint        Point at which to display the Pointer type message.\r\n   * @param relativePosition    Position relative to displayPoint at which to display the Pointer type message.\r\n   */\r\n  public updatePointerMessage(_displayPoint: XAndY, _relativePosition = RelativePosition.TopRight): void { }\r\n\r\n  /** Close message created with [[OutputMessageType.Pointer]]. */\r\n  public closePointerMessage(): void { }\r\n\r\n  /** Close message created with [[OutputMessageType.InputField]]. */\r\n  public closeInputFieldMessage(): void { }\r\n\r\n  /** Setup tool assistance instructions for a tool. The instructions include the main instruction, which includes the current prompt.\r\n   * @param instructions The tool assistance instructions.\r\n   */\r\n  public setToolAssistance(instructions: ToolAssistanceInstructions | undefined) {\r\n    this.outputPrompt(instructions ? instructions.mainInstruction.text : \"\");\r\n  }\r\n\r\n  /**\r\n   * Displays a notification message.\r\n   * @param severity          The severity of the message.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   * @param messageType       The type of message. Defaults to Toast.\r\n   */\r\n  public displayMessage(severity: MessageSeverity, briefMessage: HTMLElement | string, detailedMessage?: HTMLElement | string, messageType?: DisplayMessageType): void {\r\n    const details = new NotifyMessageDetails(this.convertSeverityToPriority(severity), briefMessage, detailedMessage, this.convertMessageType(messageType));\r\n    this.outputMessage(details);\r\n  }\r\n\r\n  /**\r\n   * Displays an input field notification message.\r\n   * @param inputField        Input field to which the message pertains. The message will be shown just below this input field element.\r\n   * @param severity          The severity of the message.\r\n   * @param briefMessage      A short message that conveys the simplest explanation of the issue.\r\n   * @param detailedMessage   An optional comprehensive message that explains the issue in detail and potentially offers a solution.\r\n   */\r\n  public displayInputFieldMessage(inputField: HTMLElement, severity: MessageSeverity, briefMessage: HTMLElement | string, detailedMessage?: HTMLElement | string): void {\r\n    const details = new NotifyMessageDetails(this.convertSeverityToPriority(severity), briefMessage, detailedMessage);\r\n    details.setInputFieldTypeDetails(inputField);\r\n    this.outputMessage(details);\r\n  }\r\n\r\n  private convertSeverityToPriority(severity: MessageSeverity): OutputMessagePriority {\r\n    switch (severity) {\r\n      case MessageSeverity.Information:\r\n        return OutputMessagePriority.Info;\r\n      case MessageSeverity.Warning:\r\n        return OutputMessagePriority.Warning;\r\n      case MessageSeverity.Error:\r\n        return OutputMessagePriority.Error;\r\n      case MessageSeverity.Fatal:\r\n        return OutputMessagePriority.Fatal;\r\n      case MessageSeverity.None:\r\n      default:\r\n        return OutputMessagePriority.None;\r\n    }\r\n  }\r\n\r\n  private convertMessageType(inMessageType?: DisplayMessageType): OutputMessageType | undefined {\r\n    switch (inMessageType) {\r\n      case DisplayMessageType.Alert:\r\n        return OutputMessageType.Alert;\r\n      case DisplayMessageType.InputField:\r\n        return OutputMessageType.InputField;\r\n      case DisplayMessageType.Sticky:\r\n        return OutputMessageType.Sticky;\r\n      case DisplayMessageType.Toast:\r\n        return OutputMessageType.Toast;\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/PerModelCategoryVisibility.d.ts

@@ -11,6 +11,7 @@ import { Viewport } from "./Viewport";
  * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].
  * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.
  * @public
+ * @extensions
  */
 export declare namespace PerModelCategoryVisibility {
     /** Describes whether and how a category's visibility is overridden. */

package/lib/esm/PerModelCategoryVisibility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PerModelCategoryVisibility.d.ts","sourceRoot":"","sources":["../../src/PerModelCategoryVisibility.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,IAAI,EAAE,OAAO,EAAE,UAAU,EAAe,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;GAOG;AACH,yBAAiB,0BAA0B,CAAC;IAC1C,uEAAuE;IACvE,KAAY,QAAQ;QAClB,wIAAwI;QACxI,IAAI,IAAA;QACJ,gDAAgD;QAChD,IAAI,IAAA;QACJ,kDAAkD;QAClD,IAAI,IAAA;KACL;IAED,uFAAuF;IACvF,UAAiB,aAAa;QAC5B,2EAA2E;QAC3E,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,gFAAgF;QAChF,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;QAChC,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,uFAAuF;QACvF,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;QACnE,mFAAmF;QACnF,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC/E,oGAAoG;QACpG,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QACzC,wDAAwD;QACxD,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC;QACjD,mFAAmF;QACnF,YAAY,CAAC,EAAE,EAAE,gBAAgB,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC1F;IAED,SAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAExF;CACF"}
+{"version":3,"file":"PerModelCategoryVisibility.d.ts","sourceRoot":"","sources":["../../src/PerModelCategoryVisibility.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,IAAI,EAAE,OAAO,EAAE,UAAU,EAAe,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;GAQG;AACH,yBAAiB,0BAA0B,CAAC;IAC1C,uEAAuE;IACvE,KAAY,QAAQ;QAClB,wIAAwI;QACxI,IAAI,IAAA;QACJ,gDAAgD;QAChD,IAAI,IAAA;QACJ,kDAAkD;QAClD,IAAI,IAAA;KACL;IAED,uFAAuF;IACvF,UAAiB,aAAa;QAC5B,2EAA2E;QAC3E,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;QAC7B,gFAAgF;QAChF,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;QAChC,mEAAmE;QACnE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB,uFAAuF;QACvF,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;QACnE,mFAAmF;QACnF,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC/E,oGAAoG;QACpG,cAAc,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QACzC,wDAAwD;QACxD,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC;QACjD,mFAAmF;QACnF,YAAY,CAAC,EAAE,EAAE,gBAAgB,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;KAC1F;IAED,SAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAExF;CACF"}

package/lib/esm/PerModelCategoryVisibility.js

@@ -13,6 +13,7 @@ import { compareStrings, Id64, SortedArray } from "@itwin/core-bentley";
  * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].
  * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.
  * @public
+ * @extensions
  */
 export var PerModelCategoryVisibility;
 (function (PerModelCategoryVisibility) {

package/lib/esm/PerModelCategoryVisibility.js.map

@@ -1 +1 @@
-{"version":3,"file":"PerModelCategoryVisibility.js","sourceRoot":"","sources":["../../src/PerModelCategoryVisibility.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,IAAI,EAAuB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAI7F;;;;;;;GAOG;AACH,MAAM,KAAW,0BAA0B,CAwC1C;AAxCD,WAAiB,0BAA0B;IACzC,uEAAuE;IACvE,IAAY,QAOX;IAPD,WAAY,QAAQ;QAClB,wIAAwI;QACxI,uCAAI,CAAA;QACJ,gDAAgD;QAChD,uCAAI,CAAA;QACJ,kDAAkD;QAClD,uCAAI,CAAA;IACN,CAAC,EAPW,QAAQ,GAAR,mCAAQ,KAAR,mCAAQ,QAOnB;IA4BD,SAAgB,eAAe,CAAC,QAAkB;QAChD,OAAO,IAAI,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAFe,0CAAe,kBAE9B,CAAA;AACH,CAAC,EAxCgB,0BAA0B,KAA1B,0BAA0B,QAwC1C;AAED,MAAM,kCAAkC;IAKtC,YAAmB,OAAmB,EAAE,UAAsB,EAAE,OAAgB;QAC9E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAmB,EAAE,UAAsB,EAAE,OAAgB;QACxE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,GAAuC,EAAE,GAAuC;IAChH,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC1E,CAAC;AAED,oFAAoF;AACpF,MAAM,mCAAoC,SAAQ,WAA+C;IAI/F,YAAmB,EAAY;QAC7B,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAJjB,aAAQ,GAAG,IAAI,kCAAkC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAKlF,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;IAChB,CAAC;IAEM,WAAW,CAAC,OAAmB,EAAE,UAAsB;QAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,GAAG;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;;YAEzG,OAAO,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,QAAiB,EAAE,WAAoB,EAAE,QAA6C;QACvG,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC7C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACnD,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAChC,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE;oBAChB,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;wBACzD,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,OAAO,EAAE,UAAU,EAAE,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;wBAChI,OAAO,GAAG,IAAI,CAAC;qBAChB;iBACF;qBAAM;oBACL,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;wBACzD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;wBAC7B,OAAO,GAAG,IAAI,CAAC;qBAChB;yBAAM,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,KAAK,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE;wBACjG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;wBACrF,OAAO,GAAG,IAAI,CAAC;qBAChB;iBACF;aACF;SACF;QAED,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAE9C,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACzD,+BAA+B;gBAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC,CAAC;aAC9H;SACF;IACH,CAAC;IAEM,cAAc,CAAC,QAAkB;QACtC,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;gBACnB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;aAC/C;YAED,OAAO;SACR;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC7C,IAAI,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE;oBAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACzB,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;oBAC9C,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM;iBACP;aACF;YAED,IAAI,CAAC,OAAO;gBACV,EAAE,CAAC,CAAC;SACP;IACH,CAAC;IAEM,YAAY,CAAC,EAA8B,EAAE,IAAoC;QACtF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;QAE5C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,MAAM,OAAO,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,OAAO;gBACvB,SAAS;YAEX,4HAA4H;YAC5H,4HAA4H;YAC5H,gCAAgC;YAChC;0BACc;YAEd,sFAAsF;YACtF,sCAAsC;YACtC,kDAAkD;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC7C,MAAM,GAAG,GAAG,EAAE,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACxD,IAAI,GAAG,KAAK,GAAG,CAAC,OAAO,EAAE;oBACvB,oEAAoE;oBACpE,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACvC,IAAI,SAAS,KAAK,KAAK,EAAE;wBACvB,KAAK,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;qBACnC;oBAED,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;iBAC/B;aACF;SACF;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { compareStrings, Id64, Id64Arg, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/** Per-model category visibility permits the visibility of categories within a [[Viewport]] displaying a [[SpatialViewState]] to be overridden in\r\n * the context of individual [[GeometricModelState]]s.\r\n * If a category's visibility is overridden for a given model, then elements belonging to that category within that model will be displayed or hidden regardless of the category's inclusion in the Viewport's [[CategorySelectorState]].\r\n * The override affects geometry on all subcategories belonging to the overridden category. That is, if the category is overridden to be visible, then geometry on all subcategories of the category\r\n * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].\r\n * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.\r\n * @public\r\n */\r\nexport namespace PerModelCategoryVisibility {\r\n  /** Describes whether and how a category's visibility is overridden. */\r\n  export enum Override {\r\n    /** The category's visibility is not overridden; its visibility is wholly controlled by the [[Viewport]]'s [[CategorySelectorState]]. */\r\n    None,\r\n    /** The category is overridden to be visible. */\r\n    Show,\r\n    /** The category is overridden to be invisible. */\r\n    Hide,\r\n  }\r\n\r\n  /** Describes one visibility override in a [[PerModelCategoryVisibility.Overrides]]. */\r\n  export interface OverrideEntry {\r\n    /** The Id of the [[GeometricModelState]] in which the override applies. */\r\n    readonly modelId: Id64String;\r\n    /** The Id of the [SpatialCategory]($backend) whose visibility is overridden. */\r\n    readonly categoryId: Id64String;\r\n    /** Whether the category is visible in the context of the model. */\r\n    readonly visible: boolean;\r\n  }\r\n\r\n  /** Describes a set of per-model category visibility overrides. Changes to these overrides invoke the [[Viewport.onViewedCategoriesPerModelChanged]] event.\r\n   * @see [[Viewport.perModelCategoryVisibility]].\r\n   */\r\n  export interface Overrides {\r\n    /** Returns the override state of the specified category within the specified model. */\r\n    getOverride(modelId: Id64String, categoryId: Id64String): Override;\r\n    /** Changes the override state of one or more categories for one or more models. */\r\n    setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: Override): void;\r\n    /** Removes all overrides for the specified models, or for all models if `modelIds` is undefined. */\r\n    clearOverrides(modelIds?: Id64Arg): void;\r\n    /** An iterator over all of the visibility overrides. */\r\n    [Symbol.iterator]: () => Iterator<OverrideEntry>;\r\n    /** Populate the symbology overrides based on the per-model category visibility. */\r\n    addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void;\r\n  }\r\n\r\n  export function createOverrides(viewport: Viewport): PerModelCategoryVisibility.Overrides {\r\n    return new PerModelCategoryVisibilityOverrides(viewport);\r\n  }\r\n}\r\n\r\nclass PerModelCategoryVisibilityOverride {\r\n  public modelId: Id64String;\r\n  public categoryId: Id64String;\r\n  public visible: boolean;\r\n\r\n  public constructor(modelId: Id64String, categoryId: Id64String, visible: boolean) {\r\n    this.modelId = modelId;\r\n    this.categoryId = categoryId;\r\n    this.visible = visible;\r\n  }\r\n\r\n  public reset(modelId: Id64String, categoryId: Id64String, visible: boolean): void {\r\n    this.modelId = modelId;\r\n    this.categoryId = categoryId;\r\n    this.visible = visible;\r\n  }\r\n}\r\n\r\nfunction compareCategoryOverrides(lhs: PerModelCategoryVisibilityOverride, rhs: PerModelCategoryVisibilityOverride): number {\r\n  const cmp = compareStrings(lhs.modelId, rhs.modelId);\r\n  return 0 === cmp ? compareStrings(lhs.categoryId, rhs.categoryId) : cmp;\r\n}\r\n\r\n/** The Viewport-specific implementation of PerModelCategoryVisibility.Overrides. */\r\nclass PerModelCategoryVisibilityOverrides extends SortedArray<PerModelCategoryVisibilityOverride> implements PerModelCategoryVisibility.Overrides {\r\n  private readonly _scratch = new PerModelCategoryVisibilityOverride(\"0\", \"0\", false);\r\n  private readonly _vp: Viewport;\r\n\r\n  public constructor(vp: Viewport) {\r\n    super(compareCategoryOverrides);\r\n    this._vp = vp;\r\n  }\r\n\r\n  public getOverride(modelId: Id64String, categoryId: Id64String): PerModelCategoryVisibility.Override {\r\n    this._scratch.reset(modelId, categoryId, false);\r\n    const ovr = this.findEqual(this._scratch);\r\n    if (undefined !== ovr)\r\n      return ovr.visible ? PerModelCategoryVisibility.Override.Show : PerModelCategoryVisibility.Override.Hide;\r\n    else\r\n      return PerModelCategoryVisibility.Override.None;\r\n  }\r\n\r\n  public setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: PerModelCategoryVisibility.Override): void {\r\n    const ovr = this._scratch;\r\n    let changed = false;\r\n    for (const modelId of Id64.iterable(modelIds)) {\r\n      for (const categoryId of Id64.iterable(categoryIds)) {\r\n        ovr.reset(modelId, categoryId, false);\r\n        const index = this.indexOf(ovr);\r\n        if (-1 === index) {\r\n          if (PerModelCategoryVisibility.Override.None !== override) {\r\n            this.insert(new PerModelCategoryVisibilityOverride(modelId, categoryId, PerModelCategoryVisibility.Override.Show === override));\r\n            changed = true;\r\n          }\r\n        } else {\r\n          if (PerModelCategoryVisibility.Override.None === override) {\r\n            this._array.splice(index, 1);\r\n            changed = true;\r\n          } else if (this._array[index].visible !== (PerModelCategoryVisibility.Override.Show === override)) {\r\n            this._array[index].visible = (PerModelCategoryVisibility.Override.Show === override);\r\n            changed = true;\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    if (changed) {\r\n      this._vp.setViewedCategoriesPerModelChanged();\r\n\r\n      if (PerModelCategoryVisibility.Override.None !== override) {\r\n        // Ensure subcategories loaded.\r\n        this._vp.subcategories.push(this._vp.iModel.subcategories, categoryIds, () => this._vp.setViewedCategoriesPerModelChanged());\r\n      }\r\n    }\r\n  }\r\n\r\n  public clearOverrides(modelIds?: Id64Arg): void {\r\n    if (undefined === modelIds) {\r\n      if (0 < this.length) {\r\n        this.clear();\r\n        this._vp.setViewedCategoriesPerModelChanged();\r\n      }\r\n\r\n      return;\r\n    }\r\n\r\n    for (let i = 0; i < this.length;) {\r\n      const ovr = this._array[i];\r\n      let removed = false;\r\n      for (const modelId of Id64.iterable(modelIds)) {\r\n        if (modelId === ovr.modelId) {\r\n          this._array.splice(i, 1);\r\n          this._vp.setViewedCategoriesPerModelChanged();\r\n          removed = true;\r\n          break;\r\n        }\r\n      }\r\n\r\n      if (!removed)\r\n        ++i;\r\n    }\r\n  }\r\n\r\n  public addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void {\r\n    const cache = this._vp.iModel.subcategories;\r\n\r\n    for (const ovr of this._array) {\r\n      const subcats = cache.getSubCategories(ovr.categoryId);\r\n      if (undefined === subcats)\r\n        continue;\r\n\r\n      // It's pointless to override for models which aren't displayed...except if we do this, and then someone enables that model,\r\n      // we would need to regenerate our symbology overrides in response. Preferably people wouldn't bother overriding models that\r\n      // they don't want us to draw...\r\n      /* if (!this._vp.view.viewsModel(ovr.modelId))\r\n        continue; */\r\n\r\n      // ###TODO: Avoid recomputing upper and lower portions of modelId if modelId repeated.\r\n      // (Array is sorted first by modelId).\r\n      // Also avoid computing if no effective overrides.\r\n      const modelLo = Id64.getLowerUint32(ovr.modelId);\r\n      const modelHi = Id64.getUpperUint32(ovr.modelId);\r\n\r\n      for (const subcat of subcats) {\r\n        const subcatLo = Id64.getLowerUint32(subcat);\r\n        const subcatHi = Id64.getUpperUint32(subcat);\r\n        const vis = fs.isSubCategoryVisible(subcatLo, subcatHi);\r\n        if (vis !== ovr.visible) {\r\n          // Only care if visibility differs from that defined for entire view\r\n          let entry = ovrs.get(modelLo, modelHi);\r\n          if (undefined === entry) {\r\n            entry = new Id64.Uint32Set();\r\n            ovrs.set(modelLo, modelHi, entry);\r\n          }\r\n\r\n          entry.add(subcatLo, subcatHi);\r\n        }\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PerModelCategoryVisibility.js","sourceRoot":"","sources":["../../src/PerModelCategoryVisibility.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,IAAI,EAAuB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAI7F;;;;;;;;GAQG;AACH,MAAM,KAAW,0BAA0B,CAwC1C;AAxCD,WAAiB,0BAA0B;IACzC,uEAAuE;IACvE,IAAY,QAOX;IAPD,WAAY,QAAQ;QAClB,wIAAwI;QACxI,uCAAI,CAAA;QACJ,gDAAgD;QAChD,uCAAI,CAAA;QACJ,kDAAkD;QAClD,uCAAI,CAAA;IACN,CAAC,EAPW,QAAQ,GAAR,mCAAQ,KAAR,mCAAQ,QAOnB;IA4BD,SAAgB,eAAe,CAAC,QAAkB;QAChD,OAAO,IAAI,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAFe,0CAAe,kBAE9B,CAAA;AACH,CAAC,EAxCgB,0BAA0B,KAA1B,0BAA0B,QAwC1C;AAED,MAAM,kCAAkC;IAKtC,YAAmB,OAAmB,EAAE,UAAsB,EAAE,OAAgB;QAC9E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAmB,EAAE,UAAsB,EAAE,OAAgB;QACxE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,GAAuC,EAAE,GAAuC;IAChH,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC1E,CAAC;AAED,oFAAoF;AACpF,MAAM,mCAAoC,SAAQ,WAA+C;IAI/F,YAAmB,EAAY;QAC7B,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAJjB,aAAQ,GAAG,IAAI,kCAAkC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAKlF,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;IAChB,CAAC;IAEM,WAAW,CAAC,OAAmB,EAAE,UAAsB;QAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,SAAS,KAAK,GAAG;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;;YAEzG,OAAO,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,QAAiB,EAAE,WAAoB,EAAE,QAA6C;QACvG,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC7C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACnD,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAChC,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE;oBAChB,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;wBACzD,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,OAAO,EAAE,UAAU,EAAE,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;wBAChI,OAAO,GAAG,IAAI,CAAC;qBAChB;iBACF;qBAAM;oBACL,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;wBACzD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;wBAC7B,OAAO,GAAG,IAAI,CAAC;qBAChB;yBAAM,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,KAAK,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE;wBACjG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;wBACrF,OAAO,GAAG,IAAI,CAAC;qBAChB;iBACF;aACF;SACF;QAED,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAE9C,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACzD,+BAA+B;gBAC/B,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC,CAAC;aAC9H;SACF;IACH,CAAC;IAEM,cAAc,CAAC,QAAkB;QACtC,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;gBACnB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;aAC/C;YAED,OAAO;SACR;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC7C,IAAI,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE;oBAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACzB,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;oBAC9C,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM;iBACP;aACF;YAED,IAAI,CAAC,OAAO;gBACV,EAAE,CAAC,CAAC;SACP;IACH,CAAC;IAEM,YAAY,CAAC,EAA8B,EAAE,IAAoC;QACtF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;QAE5C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,MAAM,OAAO,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,OAAO;gBACvB,SAAS;YAEX,4HAA4H;YAC5H,4HAA4H;YAC5H,gCAAgC;YAChC;0BACc;YAEd,sFAAsF;YACtF,sCAAsC;YACtC,kDAAkD;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC7C,MAAM,GAAG,GAAG,EAAE,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBACxD,IAAI,GAAG,KAAK,GAAG,CAAC,OAAO,EAAE;oBACvB,oEAAoE;oBACpE,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACvC,IAAI,SAAS,KAAK,KAAK,EAAE;wBACvB,KAAK,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;qBACnC;oBAED,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;iBAC/B;aACF;SACF;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { compareStrings, Id64, Id64Arg, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\r\nimport { Viewport } from \"./Viewport\";\r\n\r\n/** Per-model category visibility permits the visibility of categories within a [[Viewport]] displaying a [[SpatialViewState]] to be overridden in\r\n * the context of individual [[GeometricModelState]]s.\r\n * If a category's visibility is overridden for a given model, then elements belonging to that category within that model will be displayed or hidden regardless of the category's inclusion in the Viewport's [[CategorySelectorState]].\r\n * The override affects geometry on all subcategories belonging to the overridden category. That is, if the category is overridden to be visible, then geometry on all subcategories of the category\r\n * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].\r\n * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.\r\n * @public\r\n * @extensions\r\n */\r\nexport namespace PerModelCategoryVisibility {\r\n  /** Describes whether and how a category's visibility is overridden. */\r\n  export enum Override {\r\n    /** The category's visibility is not overridden; its visibility is wholly controlled by the [[Viewport]]'s [[CategorySelectorState]]. */\r\n    None,\r\n    /** The category is overridden to be visible. */\r\n    Show,\r\n    /** The category is overridden to be invisible. */\r\n    Hide,\r\n  }\r\n\r\n  /** Describes one visibility override in a [[PerModelCategoryVisibility.Overrides]]. */\r\n  export interface OverrideEntry {\r\n    /** The Id of the [[GeometricModelState]] in which the override applies. */\r\n    readonly modelId: Id64String;\r\n    /** The Id of the [SpatialCategory]($backend) whose visibility is overridden. */\r\n    readonly categoryId: Id64String;\r\n    /** Whether the category is visible in the context of the model. */\r\n    readonly visible: boolean;\r\n  }\r\n\r\n  /** Describes a set of per-model category visibility overrides. Changes to these overrides invoke the [[Viewport.onViewedCategoriesPerModelChanged]] event.\r\n   * @see [[Viewport.perModelCategoryVisibility]].\r\n   */\r\n  export interface Overrides {\r\n    /** Returns the override state of the specified category within the specified model. */\r\n    getOverride(modelId: Id64String, categoryId: Id64String): Override;\r\n    /** Changes the override state of one or more categories for one or more models. */\r\n    setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: Override): void;\r\n    /** Removes all overrides for the specified models, or for all models if `modelIds` is undefined. */\r\n    clearOverrides(modelIds?: Id64Arg): void;\r\n    /** An iterator over all of the visibility overrides. */\r\n    [Symbol.iterator]: () => Iterator<OverrideEntry>;\r\n    /** Populate the symbology overrides based on the per-model category visibility. */\r\n    addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void;\r\n  }\r\n\r\n  export function createOverrides(viewport: Viewport): PerModelCategoryVisibility.Overrides {\r\n    return new PerModelCategoryVisibilityOverrides(viewport);\r\n  }\r\n}\r\n\r\nclass PerModelCategoryVisibilityOverride {\r\n  public modelId: Id64String;\r\n  public categoryId: Id64String;\r\n  public visible: boolean;\r\n\r\n  public constructor(modelId: Id64String, categoryId: Id64String, visible: boolean) {\r\n    this.modelId = modelId;\r\n    this.categoryId = categoryId;\r\n    this.visible = visible;\r\n  }\r\n\r\n  public reset(modelId: Id64String, categoryId: Id64String, visible: boolean): void {\r\n    this.modelId = modelId;\r\n    this.categoryId = categoryId;\r\n    this.visible = visible;\r\n  }\r\n}\r\n\r\nfunction compareCategoryOverrides(lhs: PerModelCategoryVisibilityOverride, rhs: PerModelCategoryVisibilityOverride): number {\r\n  const cmp = compareStrings(lhs.modelId, rhs.modelId);\r\n  return 0 === cmp ? compareStrings(lhs.categoryId, rhs.categoryId) : cmp;\r\n}\r\n\r\n/** The Viewport-specific implementation of PerModelCategoryVisibility.Overrides. */\r\nclass PerModelCategoryVisibilityOverrides extends SortedArray<PerModelCategoryVisibilityOverride> implements PerModelCategoryVisibility.Overrides {\r\n  private readonly _scratch = new PerModelCategoryVisibilityOverride(\"0\", \"0\", false);\r\n  private readonly _vp: Viewport;\r\n\r\n  public constructor(vp: Viewport) {\r\n    super(compareCategoryOverrides);\r\n    this._vp = vp;\r\n  }\r\n\r\n  public getOverride(modelId: Id64String, categoryId: Id64String): PerModelCategoryVisibility.Override {\r\n    this._scratch.reset(modelId, categoryId, false);\r\n    const ovr = this.findEqual(this._scratch);\r\n    if (undefined !== ovr)\r\n      return ovr.visible ? PerModelCategoryVisibility.Override.Show : PerModelCategoryVisibility.Override.Hide;\r\n    else\r\n      return PerModelCategoryVisibility.Override.None;\r\n  }\r\n\r\n  public setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: PerModelCategoryVisibility.Override): void {\r\n    const ovr = this._scratch;\r\n    let changed = false;\r\n    for (const modelId of Id64.iterable(modelIds)) {\r\n      for (const categoryId of Id64.iterable(categoryIds)) {\r\n        ovr.reset(modelId, categoryId, false);\r\n        const index = this.indexOf(ovr);\r\n        if (-1 === index) {\r\n          if (PerModelCategoryVisibility.Override.None !== override) {\r\n            this.insert(new PerModelCategoryVisibilityOverride(modelId, categoryId, PerModelCategoryVisibility.Override.Show === override));\r\n            changed = true;\r\n          }\r\n        } else {\r\n          if (PerModelCategoryVisibility.Override.None === override) {\r\n            this._array.splice(index, 1);\r\n            changed = true;\r\n          } else if (this._array[index].visible !== (PerModelCategoryVisibility.Override.Show === override)) {\r\n            this._array[index].visible = (PerModelCategoryVisibility.Override.Show === override);\r\n            changed = true;\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    if (changed) {\r\n      this._vp.setViewedCategoriesPerModelChanged();\r\n\r\n      if (PerModelCategoryVisibility.Override.None !== override) {\r\n        // Ensure subcategories loaded.\r\n        this._vp.subcategories.push(this._vp.iModel.subcategories, categoryIds, () => this._vp.setViewedCategoriesPerModelChanged());\r\n      }\r\n    }\r\n  }\r\n\r\n  public clearOverrides(modelIds?: Id64Arg): void {\r\n    if (undefined === modelIds) {\r\n      if (0 < this.length) {\r\n        this.clear();\r\n        this._vp.setViewedCategoriesPerModelChanged();\r\n      }\r\n\r\n      return;\r\n    }\r\n\r\n    for (let i = 0; i < this.length;) {\r\n      const ovr = this._array[i];\r\n      let removed = false;\r\n      for (const modelId of Id64.iterable(modelIds)) {\r\n        if (modelId === ovr.modelId) {\r\n          this._array.splice(i, 1);\r\n          this._vp.setViewedCategoriesPerModelChanged();\r\n          removed = true;\r\n          break;\r\n        }\r\n      }\r\n\r\n      if (!removed)\r\n        ++i;\r\n    }\r\n  }\r\n\r\n  public addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void {\r\n    const cache = this._vp.iModel.subcategories;\r\n\r\n    for (const ovr of this._array) {\r\n      const subcats = cache.getSubCategories(ovr.categoryId);\r\n      if (undefined === subcats)\r\n        continue;\r\n\r\n      // It's pointless to override for models which aren't displayed...except if we do this, and then someone enables that model,\r\n      // we would need to regenerate our symbology overrides in response. Preferably people wouldn't bother overriding models that\r\n      // they don't want us to draw...\r\n      /* if (!this._vp.view.viewsModel(ovr.modelId))\r\n        continue; */\r\n\r\n      // ###TODO: Avoid recomputing upper and lower portions of modelId if modelId repeated.\r\n      // (Array is sorted first by modelId).\r\n      // Also avoid computing if no effective overrides.\r\n      const modelLo = Id64.getLowerUint32(ovr.modelId);\r\n      const modelHi = Id64.getUpperUint32(ovr.modelId);\r\n\r\n      for (const subcat of subcats) {\r\n        const subcatLo = Id64.getLowerUint32(subcat);\r\n        const subcatHi = Id64.getUpperUint32(subcat);\r\n        const vis = fs.isSubCategoryVisible(subcatLo, subcatHi);\r\n        if (vis !== ovr.visible) {\r\n          // Only care if visibility differs from that defined for entire view\r\n          let entry = ovrs.get(modelLo, modelHi);\r\n          if (undefined === entry) {\r\n            entry = new Id64.Uint32Set();\r\n            ovrs.set(modelLo, modelHi, entry);\r\n          }\r\n\r\n          entry.add(subcatLo, subcatHi);\r\n        }\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/SelectionSet.d.ts

@@ -5,6 +5,7 @@ import { BeEvent, Id64, Id64Arg, Id64String } from "@itwin/core-bentley";
 import { IModelConnection } from "./IModelConnection";
 /** Identifies the type of changes made to the [[SelectionSet]] to produce a [[SelectionSetEvent]].
  * @public
+ * @extensions
  */
 export declare enum SelectionSetEventType {
     /** Elements have been added to the set. */
@@ -18,6 +19,7 @@ export declare enum SelectionSetEventType {
 }
 /** Passed to [[SelectionSet.onChanged]] event listeners when elements are added to the selection set.
  * @public
+ * @extensions
  */
 export interface SelectAddEvent {
     type: SelectionSetEventType.Add;
@@ -28,6 +30,7 @@ export interface SelectAddEvent {
 }
 /** Passed to [[SelectionSet.onChanged]] event listeners when elements are removed from the selection set.
  * @public
+ * @extensions
  */
 export interface SelectRemoveEvent {
     /** The type of operation that produced this event. */
@@ -39,6 +42,7 @@ export interface SelectRemoveEvent {
 }
 /** Passed to [[SelectionSet.onChanged]] event listeners when elements are simultaneously added to and removed from the selection set.
  * @public
+ * @extensions
  */
 export interface SelectReplaceEvent {
     type: SelectionSetEventType.Replace;
@@ -61,6 +65,7 @@ export interface SelectReplaceEvent {
  *  }
  *  ```
  * @public
+ * @extensions
  */
 export declare type SelectionSetEvent = SelectAddEvent | SelectRemoveEvent | SelectReplaceEvent;
 /** A set of *hilited* elements for an [[IModelConnection]], by element id.
@@ -73,6 +78,7 @@ export declare type SelectionSetEvent = SelectAddEvent | SelectRemoveEvent | Sel
  * @see [[IModelConnection.hilited]] for the HiliteSet associated with an iModel.
  * @see [Hilite.Settings]($common) for customization of the hilite effect.
  * @public
+ * @extensions
  */
 export declare class HiliteSet {
     iModel: IModelConnection;
@@ -114,6 +120,7 @@ export declare class HiliteSet {
  * Selected elements are displayed with a customizable hilite effect within a [[Viewport]].
  * @see [Hilite.Settings]($common) for customization of the hilite effect.
  * @public
+ * @extensions
  */
 export declare class SelectionSet {
     iModel: IModelConnection;

package/lib/esm/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;;GAEG;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;;GAEG;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;;GAEG;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;;GAEG;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;;;;;;;;;;;;GAYG;AACH,oBAAY,iBAAiB,GAAG,cAAc,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AA0FxF;;;;;;;;;;GAUG;AACH,qBAAa,SAAS;IAmBM,MAAM,EAAE,gBAAgB;IAlBlD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAE9C;;OAEG;IACH,SAAgB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAgB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;IACvC,mCAAmC;IACnC,IAAW,QAAQ,IAAI,IAAI,CAAC,SAAS,CAA2B;IAEhE;;;;OAIG;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;CAUrD;AAED;;;;GAIG;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":"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,oBAAY,iBAAiB,GAAG,cAAc,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;AA0FxF;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IAmBM,MAAM,EAAE,gBAAgB;IAlBlD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAE9C;;OAEG;IACH,SAAgB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAgB,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;IACvC,mCAAmC;IACnC,IAAW,QAAQ,IAAI,IAAI,CAAC,SAAS,CAA2B;IAEhE;;;;OAIG;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;CAUrD;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"}

package/lib/esm/SelectionSet.js

@@ -9,6 +9,7 @@ import { BeEvent, Id64 } from "@itwin/core-bentley";
 import { IModelApp } from "./IModelApp";
 /** Identifies the type of changes made to the [[SelectionSet]] to produce a [[SelectionSetEvent]].
  * @public
+ * @extensions
  */
 export var SelectionSetEventType;
 (function (SelectionSetEventType) {
@@ -103,6 +104,7 @@ class HilitedElementIds extends HilitedIds {
  * @see [[IModelConnection.hilited]] for the HiliteSet associated with an iModel.
  * @see [Hilite.Settings]($common) for customization of the hilite effect.
  * @public
+ * @extensions
  */
 export class HiliteSet {
     /** Construct a HiliteSet
@@ -151,6 +153,7 @@ export class HiliteSet {
  * Selected elements are displayed with a customizable hilite effect within a [[Viewport]].
  * @see [Hilite.Settings]($common) for customization of the hilite effect.
  * @public
+ * @extensions
  */
 export class SelectionSet {
     constructor(iModel) {

package/lib/esm/SelectionSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"SelectionSet.js","sourceRoot":"","sources":["../../src/SelectionSet.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAuB,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;GAEG;AACH,MAAM,CAAN,IAAY,qBASX;AATD,WAAY,qBAAqB;IAC/B,2CAA2C;IAC3C,+DAAG,CAAA;IACH,+CAA+C;IAC/C,qEAAM,CAAA;IACN,6EAA6E;IAC7E,uEAAO,CAAA;IACP,yDAAyD;IACzD,mEAAK,CAAA;AACP,CAAC,EATW,qBAAqB,KAArB,qBAAqB,QAShC;AAqDD;;GAEG;AACH,MAAM,UAAW,SAAQ,IAAI,CAAC,SAAS;IAIrC,YAAmB,MAAwB;QACzC,KAAK,EAAE,CAAC;QAHA,cAAS,GAAG,KAAK,CAAC;QAI1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEe,GAAG,CAAC,GAAW,EAAE,IAAY;QAC3C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,MAAM,CAAC,GAAW,EAAE,IAAY;QAC9C,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,KAAK;QACnB,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,MAAM,CAAC,GAAY;QACjC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IAEe,SAAS,CAAC,GAAY;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC;IAES,SAAS;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAES,MAAM,CAAC,IAAgB;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,EAAE,CAAC;QACP,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,iBAAkB,SAAQ,UAAU;IAGxC,YAAmB,MAAwB,EAAE,oBAAoB,GAAG,IAAI;QACtE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,wBAAwB,GAAG,oBAAoB,CAAC;IACvD,CAAC;IAED,IAAW,wBAAwB,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7F,IAAW,wBAAwB,CAAC,IAAa;QAC/C,IAAI,IAAI,KAAK,IAAI,CAAC,wBAAwB;YACxC,OAAO;QAET,IAAI,IAAI,EAAE;YACR,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/G,IAAI,CAAC,wBAAwB,CAAC;gBAC5B,GAAG;gBACH,IAAI,EAAE,qBAAqB,CAAC,GAAG;gBAC/B,KAAK,EAAE,GAAG,CAAC,QAAQ;aACpB,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,eAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SAClC;IACH,CAAC;IAEO,wBAAwB,CAAC,EAAqB;QACpD,IAAI,qBAAqB,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI;YACvC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAE7B,IAAI,EAAE,CAAC,IAAI,KAAK,qBAAqB,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,KAAK,qBAAqB,CAAC,OAAO;YACpF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAS;IAcpB;;;;OAIG;IACH,YAA0B,MAAwB,EAAE,oBAAoB,GAAG,IAAI;QAArD,WAAM,GAAN,MAAM,CAAkB;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QACrE,IAAI,CAAC,aAAa,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAZD,mCAAmC;IACnC,IAAW,QAAQ,KAAqB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAahE;;;;OAIG;IACH,IAAW,wBAAwB,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAClG,IAAW,wBAAwB,CAAC,IAAa,IAAI,IAAI,CAAC,SAAS,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC,CAAC;IAEtG,gDAAgD;IACzC,KAAK;QACV,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpH;;;OAGG;IACI,SAAS,CAAC,GAAY,EAAE,KAAc;QAC3C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,KAAK;gBACP,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;;gBAExB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAC9B;QAED,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAWvB,YAA0B,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;QAV1C,cAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QAOtC,2EAA2E;QAC3D,cAAS,GAAG,IAAI,OAAO,EAAmC,CAAC;IAErB,CAAC;IARvD;;OAEG;IACH,IAAW,QAAQ,KAAkB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOrD,gBAAgB,CAAC,EAAqB;QAC5C,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,uDAAuD;IACvD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,qDAAqD;IACrD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjD;;OAEG;IACI,GAAG,CAAC,MAAe,IAAI,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE7E;;OAEG;IACI,UAAU,CAAC,MAAmB,IAAa,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEjG;;OAEG;IACI,QAAQ;QACb,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,IAAa;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAEO,IAAI,CAAC,IAAa,EAAE,SAAS,GAAG,IAAI;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAExB,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,IAAI,SAAS,IAAI,OAAO;YACtB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAErF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAa;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,OAAO,CAAC,IAAa,EAAE,SAAS,GAAG,IAAI;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAE3B,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,IAAI,SAAS,IAAI,OAAO;YACtB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1F,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,IAAa,EAAE,OAAgB;QACjD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,IAAI,OAAO;YAClB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;aACtG,IAAI,KAAK;YACZ,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;aAChF,IAAI,OAAO;YACd,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE7F,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,IAAa;QACzB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC3C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;;gBAEzB,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACzB;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED,0DAA0D;IACnD,OAAO,CAAC,IAAa;QAC1B,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC;YAC/B,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEvB,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpC,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjB,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;aACtB;SACF;QAED,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,GAAgB,EAAE,GAAY;IAC9C,wDAAwD;IACxD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACpB,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE1B,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;QAC/B,OAAO,KAAK,CAAC;IAEf,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;IAEjB,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SelectionSet\r\n */\r\nimport { BeEvent, Id64, Id64Arg, Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\n\r\n/** Identifies the type of changes made to the [[SelectionSet]] to produce a [[SelectionSetEvent]].\r\n * @public\r\n */\r\nexport enum SelectionSetEventType {\r\n  /** Elements have been added to the set. */\r\n  Add,\r\n  /** Elements have been removed from the set. */\r\n  Remove,\r\n  /** Some elements have been added to the set and others have been removed. */\r\n  Replace,\r\n  /** All elements are about to be removed from the set. */\r\n  Clear,\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are added to the selection set.\r\n * @public\r\n */\r\nexport interface SelectAddEvent {\r\n  type: SelectionSetEventType.Add;\r\n  /** The Ids of the elements added to the set. */\r\n  added: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are removed from the selection set.\r\n * @public\r\n */\r\nexport interface SelectRemoveEvent {\r\n  /** The type of operation that produced this event. */\r\n  type: SelectionSetEventType.Remove | SelectionSetEventType.Clear;\r\n  /** The element Ids removed from the set. */\r\n  removed: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are simultaneously added to and removed from the selection set.\r\n * @public\r\n */\r\nexport interface SelectReplaceEvent {\r\n  type: SelectionSetEventType.Replace;\r\n  /** The element Ids added to the set. */\r\n  added: Id64Arg;\r\n  /** The element Ids removed from the set. */\r\n  removed: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Payload sent to [[SelectionSet.onChanged]] event listeners to describe how the contents of the set have changed.\r\n * The `type` property of the event serves as a type assertion. For example, the following code will output the added and/or removed Ids:\r\n *  ```ts\r\n *  processSelectionSetEvent(ev: SelectionSetEvent): void {\r\n *    if (SelectionSetEventType.Add === ev.type || SelectionSetEventType.Replace === ev.type)\r\n *      console.log(\"Added \" + ev.added.size + \" elements\");\r\n *\r\n *    if (SelectionSetEventType.Add !== ev.type)\r\n *      console.log(\"Removed \" + ev.removed.size + \" elements\");\r\n *  }\r\n *  ```\r\n * @public\r\n */\r\nexport type SelectionSetEvent = SelectAddEvent | SelectRemoveEvent | SelectReplaceEvent;\r\n\r\n/** Tracks a set of hilited entities. When the set changes, notifies ViewManager so that symbology overrides can be updated in active Viewports.\r\n * @internal\r\n */\r\nclass HilitedIds extends Id64.Uint32Set {\r\n  protected _iModel: IModelConnection;\r\n  protected _changing = false;\r\n\r\n  public constructor(iModel: IModelConnection) {\r\n    super();\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public override add(low: number, high: number) {\r\n    super.add(low, high);\r\n    this.onChanged();\r\n  }\r\n\r\n  public override delete(low: number, high: number) {\r\n    super.delete(low, high);\r\n    this.onChanged();\r\n  }\r\n\r\n  public override clear() {\r\n    super.clear();\r\n    this.onChanged();\r\n  }\r\n\r\n  public override addIds(ids: Id64Arg) {\r\n    this.change(() => super.addIds(ids));\r\n  }\r\n\r\n  public override deleteIds(ids: Id64Arg) {\r\n    this.change(() => super.deleteIds(ids));\r\n  }\r\n\r\n  protected onChanged() {\r\n    if (!this._changing)\r\n      IModelApp.viewManager.onSelectionSetChanged(this._iModel);\r\n  }\r\n\r\n  protected change(func: () => void) {\r\n    const changing = this._changing;\r\n    this._changing = false;\r\n    func();\r\n    this._changing = changing;\r\n    this.onChanged();\r\n  }\r\n}\r\n\r\n/** Keeps the set of hilited elements in sync with the selection set.\r\n * @internal\r\n */\r\nclass HilitedElementIds extends HilitedIds {\r\n  private _removeListener?: () => void;\r\n\r\n  public constructor(iModel: IModelConnection, syncWithSelectionSet = true) {\r\n    super(iModel);\r\n    this.wantSyncWithSelectionSet = syncWithSelectionSet;\r\n  }\r\n\r\n  public get wantSyncWithSelectionSet(): boolean { return undefined !== this._removeListener; }\r\n  public set wantSyncWithSelectionSet(want: boolean) {\r\n    if (want === this.wantSyncWithSelectionSet)\r\n      return;\r\n\r\n    if (want) {\r\n      const set = this._iModel.selectionSet;\r\n      this._removeListener = set.onChanged.addListener((ev) => this.change(() => this.processSelectionSetEvent(ev)));\r\n      this.processSelectionSetEvent({\r\n        set,\r\n        type: SelectionSetEventType.Add,\r\n        added: set.elements,\r\n      });\r\n    } else {\r\n      this._removeListener!();\r\n      this._removeListener = undefined;\r\n    }\r\n  }\r\n\r\n  private processSelectionSetEvent(ev: SelectionSetEvent): void {\r\n    if (SelectionSetEventType.Add !== ev.type)\r\n      this.deleteIds(ev.removed);\r\n\r\n    if (ev.type === SelectionSetEventType.Add || ev.type === SelectionSetEventType.Replace)\r\n      this.addIds(ev.added);\r\n  }\r\n}\r\n\r\n/** A set of *hilited* elements for an [[IModelConnection]], by element id.\r\n * Hilited elements are displayed with a customizable hilite effect within a [[Viewport]].\r\n * The set exposes 3 types of elements in 3 separate collections: geometric elements, subcategories, and geometric models.\r\n * @note Typically, elements are hilited by virtue of their presence in the IModelConnection's [[SelectionSet]]. The HiliteSet allows additional\r\n * elements to be displayed with the hilite effect without adding them to the [[SelectionSet]]. If you add elements to the HiliteSet directly, you\r\n * are also responsible for removing them as appropriate.\r\n * @note Support for subcategories and geometric models in the HiliteSet is currently `beta`.\r\n * @see [[IModelConnection.hilited]] for the HiliteSet associated with an iModel.\r\n * @see [Hilite.Settings]($common) for customization of the hilite effect.\r\n * @public\r\n */\r\nexport class HiliteSet {\r\n  private readonly _elements: HilitedElementIds;\r\n\r\n  /** The set of hilited subcategories.\r\n   * @beta\r\n   */\r\n  public readonly subcategories: Id64.Uint32Set;\r\n  /** The set of hilited [[GeometricModelState]]s.\r\n   * @beta\r\n   */\r\n  public readonly models: Id64.Uint32Set;\r\n  /** The set of hilited elements. */\r\n  public get elements(): Id64.Uint32Set { return this._elements; }\r\n\r\n  /** Construct a HiliteSet\r\n   * @param iModel The iModel containing the entities to be hilited.\r\n   * @param syncWithSelectionSet If true, the contents of the `elements` set will be synchronized with those in the `iModel`'s [[SelectionSet]].\r\n   * @internal\r\n   */\r\n  public constructor(public iModel: IModelConnection, syncWithSelectionSet = true) {\r\n    this._elements = new HilitedElementIds(iModel, syncWithSelectionSet);\r\n    this.subcategories = new HilitedIds(iModel);\r\n    this.models = new HilitedIds(iModel);\r\n  }\r\n\r\n  /** Control whether the hilited elements will be synchronized with the contents of the [[SelectionSet]].\r\n   * By default they are synchronized. Applications that override this take responsibility for managing the set of hilited entities.\r\n   * When turning synchronization off, the contents of the HiliteSet will remain unchanged.\r\n   * 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.\r\n   */\r\n  public get wantSyncWithSelectionSet(): boolean { return this._elements.wantSyncWithSelectionSet; }\r\n  public set wantSyncWithSelectionSet(want: boolean) { this._elements.wantSyncWithSelectionSet = want; }\r\n\r\n  /** Remove all elements from the hilited set. */\r\n  public clear() {\r\n    this.elements.clear();\r\n    this.subcategories.clear();\r\n    this.models.clear();\r\n  }\r\n\r\n  /** Returns true if nothing is hilited. */\r\n  public get isEmpty(): boolean { return this.elements.isEmpty && this.subcategories.isEmpty && this.models.isEmpty; }\r\n\r\n  /** Toggle the hilited state of one or more elements.\r\n   * @param arg the ID(s) of the elements whose state is to be toggled.\r\n   * @param onOff True to add the elements to the hilited set, false to remove them.\r\n   */\r\n  public setHilite(arg: Id64Arg, onOff: boolean): void {\r\n    for (const id of Id64.iterable(arg)) {\r\n      if (onOff)\r\n        this.elements.addId(id);\r\n      else\r\n        this.elements.deleteId(id);\r\n    }\r\n\r\n    IModelApp.viewManager.onSelectionSetChanged(this.iModel);\r\n  }\r\n}\r\n\r\n/** A set of *currently selected* elements for an IModelConnection.\r\n * Selected elements are displayed with a customizable hilite effect within a [[Viewport]].\r\n * @see [Hilite.Settings]($common) for customization of the hilite effect.\r\n * @public\r\n */\r\nexport class SelectionSet {\r\n  private _elements = new Set<string>();\r\n\r\n  /** The IDs of the selected elements.\r\n   * @note Do not modify this set directly. Instead, use methods like [[SelectionSet.add]].\r\n   */\r\n  public get elements(): Set<string> { return this._elements; }\r\n\r\n  /** Called whenever elements are added or removed from this SelectionSet */\r\n  public readonly onChanged = new BeEvent<(ev: SelectionSetEvent) => void>();\r\n\r\n  public constructor(public iModel: IModelConnection) { }\r\n\r\n  private sendChangedEvent(ev: SelectionSetEvent) {\r\n    IModelApp.viewManager.onSelectionSetChanged(this.iModel);\r\n    this.onChanged.raiseEvent(ev);\r\n  }\r\n\r\n  /** Get the number of entries in this selection set. */\r\n  public get size() { return this.elements.size; }\r\n\r\n  /** Check whether there are any selected elements. */\r\n  public get isActive() { return this.size !== 0; }\r\n\r\n  /** Return true if elemId is in this SelectionSet.\r\n   * @see [[isSelected]]\r\n   */\r\n  public has(elemId?: string) { return !!elemId && this.elements.has(elemId); }\r\n\r\n  /** Query whether an Id is in the selection set.\r\n   * @see [[has]]\r\n   */\r\n  public isSelected(elemId?: Id64String): boolean { return !!elemId && this.elements.has(elemId); }\r\n\r\n  /** Clear current selection set.\r\n   * @note raises the [[onChanged]] event with [[SelectionSetEventType.Clear]].\r\n   */\r\n  public emptyAll(): void {\r\n    if (!this.isActive)\r\n      return;\r\n\r\n    const removed = this._elements;\r\n    this._elements = new Set<string>();\r\n    this.sendChangedEvent({ set: this, type: SelectionSetEventType.Clear, removed });\r\n  }\r\n\r\n  /**\r\n   * Add one or more Ids to the current selection set.\r\n   * @param elem The set of Ids to add.\r\n   * @returns true if any elements were added.\r\n   */\r\n  public add(elem: Id64Arg): boolean {\r\n    return this._add(elem);\r\n  }\r\n\r\n  private _add(elem: Id64Arg, sendEvent = true): boolean {\r\n    const oldSize = this.elements.size;\r\n    for (const id of Id64.iterable(elem))\r\n      this.elements.add(id);\r\n\r\n    const changed = oldSize !== this.elements.size;\r\n    if (sendEvent && changed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Add, set: this, added: elem });\r\n\r\n    return changed;\r\n  }\r\n\r\n  /**\r\n   * Remove one or more Ids from the current selection set.\r\n   * @param elem The set of Ids to remove.\r\n   * @returns true if any elements were removed.\r\n   */\r\n  public remove(elem: Id64Arg): boolean {\r\n    return this._remove(elem);\r\n  }\r\n\r\n  private _remove(elem: Id64Arg, sendEvent = true): boolean {\r\n    const oldSize = this.elements.size;\r\n    for (const id of Id64.iterable(elem))\r\n      this.elements.delete(id);\r\n\r\n    const changed = oldSize !== this.elements.size;\r\n    if (sendEvent && changed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Remove, set: this, removed: elem });\r\n\r\n    return changed;\r\n  }\r\n\r\n  /**\r\n   * Add one set of Ids, and remove another set of Ids. Any Ids that are in both sets are removed.\r\n   * @returns True if any Ids were either added or removed.\r\n   */\r\n  public addAndRemove(adds: Id64Arg, removes: Id64Arg): boolean {\r\n    const added = this._add(adds, false);\r\n    const removed = this._remove(removes, false);\r\n\r\n    if (added && removed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Replace, set: this, added: adds, removed: removes });\r\n    else if (added)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Add, set: this, added: adds });\r\n    else if (removed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Remove, set: this, removed: removes });\r\n\r\n    return (added || removed);\r\n  }\r\n\r\n  /** Invert the state of a set of Ids in the SelectionSet */\r\n  public invert(elem: Id64Arg): boolean {\r\n    const elementsToAdd = new Set<string>();\r\n    const elementsToRemove = new Set<string>();\r\n    for (const id of Id64.iterable(elem)) {\r\n      if (this.elements.has(id))\r\n        elementsToRemove.add(id);\r\n      else\r\n        elementsToAdd.add(id);\r\n    }\r\n\r\n    return this.addAndRemove(elementsToAdd, elementsToRemove);\r\n  }\r\n\r\n  /** Change selection set to be the supplied set of Ids. */\r\n  public replace(elem: Id64Arg): void {\r\n    if (areEqual(this.elements, elem))\r\n      return;\r\n\r\n    const removed = this._elements;\r\n    this._elements = new Set<string>();\r\n    this._add(elem, false);\r\n\r\n    if (0 < removed.size) {\r\n      for (const id of Id64.iterable(elem)) {\r\n        if (removed.has(id))\r\n          removed.delete(id);\r\n      }\r\n    }\r\n\r\n    this.sendChangedEvent({ type: SelectionSetEventType.Replace, set: this, added: elem, removed });\r\n  }\r\n}\r\n\r\nfunction areEqual(lhs: Set<string>, rhs: Id64Arg): boolean {\r\n  // Size is unreliable if input can contain duplicates...\r\n  if (Array.isArray(rhs))\r\n    rhs = Id64.toIdSet(rhs);\r\n\r\n  if (lhs.size !== Id64.sizeOf(rhs))\r\n    return false;\r\n\r\n  for (const id of Id64.iterable(rhs))\r\n    if (!lhs.has(id))\r\n      return false;\r\n\r\n  return true;\r\n}\r\n"]}
+{"version":3,"file":"SelectionSet.js","sourceRoot":"","sources":["../../src/SelectionSet.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAuB,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,MAAM,CAAN,IAAY,qBASX;AATD,WAAY,qBAAqB;IAC/B,2CAA2C;IAC3C,+DAAG,CAAA;IACH,+CAA+C;IAC/C,qEAAM,CAAA;IACN,6EAA6E;IAC7E,uEAAO,CAAA;IACP,yDAAyD;IACzD,mEAAK,CAAA;AACP,CAAC,EATW,qBAAqB,KAArB,qBAAqB,QAShC;AAyDD;;GAEG;AACH,MAAM,UAAW,SAAQ,IAAI,CAAC,SAAS;IAIrC,YAAmB,MAAwB;QACzC,KAAK,EAAE,CAAC;QAHA,cAAS,GAAG,KAAK,CAAC;QAI1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEe,GAAG,CAAC,GAAW,EAAE,IAAY;QAC3C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,MAAM,CAAC,GAAW,EAAE,IAAY;QAC9C,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,KAAK;QACnB,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAEe,MAAM,CAAC,GAAY;QACjC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IAEe,SAAS,CAAC,GAAY;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC;IAES,SAAS;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAES,MAAM,CAAC,IAAgB;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,EAAE,CAAC;QACP,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,iBAAkB,SAAQ,UAAU;IAGxC,YAAmB,MAAwB,EAAE,oBAAoB,GAAG,IAAI;QACtE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,wBAAwB,GAAG,oBAAoB,CAAC;IACvD,CAAC;IAED,IAAW,wBAAwB,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7F,IAAW,wBAAwB,CAAC,IAAa;QAC/C,IAAI,IAAI,KAAK,IAAI,CAAC,wBAAwB;YACxC,OAAO;QAET,IAAI,IAAI,EAAE;YACR,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/G,IAAI,CAAC,wBAAwB,CAAC;gBAC5B,GAAG;gBACH,IAAI,EAAE,qBAAqB,CAAC,GAAG;gBAC/B,KAAK,EAAE,GAAG,CAAC,QAAQ;aACpB,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,eAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SAClC;IACH,CAAC;IAEO,wBAAwB,CAAC,EAAqB;QACpD,IAAI,qBAAqB,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI;YACvC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAE7B,IAAI,EAAE,CAAC,IAAI,KAAK,qBAAqB,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,KAAK,qBAAqB,CAAC,OAAO;YACpF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,SAAS;IAcpB;;;;OAIG;IACH,YAA0B,MAAwB,EAAE,oBAAoB,GAAG,IAAI;QAArD,WAAM,GAAN,MAAM,CAAkB;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,iBAAiB,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QACrE,IAAI,CAAC,aAAa,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAZD,mCAAmC;IACnC,IAAW,QAAQ,KAAqB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAahE;;;;OAIG;IACH,IAAW,wBAAwB,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAClG,IAAW,wBAAwB,CAAC,IAAa,IAAI,IAAI,CAAC,SAAS,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC,CAAC;IAEtG,gDAAgD;IACzC,KAAK;QACV,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpH;;;OAGG;IACI,SAAS,CAAC,GAAY,EAAE,KAAc;QAC3C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,KAAK;gBACP,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;;gBAExB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAC9B;QAED,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAWvB,YAA0B,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;QAV1C,cAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QAOtC,2EAA2E;QAC3D,cAAS,GAAG,IAAI,OAAO,EAAmC,CAAC;IAErB,CAAC;IARvD;;OAEG;IACH,IAAW,QAAQ,KAAkB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOrD,gBAAgB,CAAC,EAAqB;QAC5C,SAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,uDAAuD;IACvD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhD,qDAAqD;IACrD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjD;;OAEG;IACI,GAAG,CAAC,MAAe,IAAI,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE7E;;OAEG;IACI,UAAU,CAAC,MAAmB,IAAa,OAAO,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEjG;;OAEG;IACI,QAAQ;QACb,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,IAAa;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAEO,IAAI,CAAC,IAAa,EAAE,SAAS,GAAG,IAAI;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAExB,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,IAAI,SAAS,IAAI,OAAO;YACtB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAErF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAa;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,OAAO,CAAC,IAAa,EAAE,SAAS,GAAG,IAAI;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAE3B,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,IAAI,SAAS,IAAI,OAAO;YACtB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1F,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,IAAa,EAAE,OAAgB;QACjD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,IAAI,OAAO;YAClB,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;aACtG,IAAI,KAAK;YACZ,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;aAChF,IAAI,OAAO;YACd,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE7F,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,IAAa;QACzB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC3C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;;gBAEzB,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACzB;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED,0DAA0D;IACnD,OAAO,CAAC,IAAa;QAC1B,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC;YAC/B,OAAO;QAET,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEvB,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACpC,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjB,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;aACtB;SACF;QAED,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,GAAgB,EAAE,GAAY;IAC9C,wDAAwD;IACxD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QACpB,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE1B,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;QAC/B,OAAO,KAAK,CAAC;IAEf,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;IAEjB,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SelectionSet\r\n */\r\nimport { BeEvent, Id64, Id64Arg, Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelApp } from \"./IModelApp\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\n\r\n/** Identifies the type of changes made to the [[SelectionSet]] to produce a [[SelectionSetEvent]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SelectionSetEventType {\r\n  /** Elements have been added to the set. */\r\n  Add,\r\n  /** Elements have been removed from the set. */\r\n  Remove,\r\n  /** Some elements have been added to the set and others have been removed. */\r\n  Replace,\r\n  /** All elements are about to be removed from the set. */\r\n  Clear,\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are added to the selection set.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SelectAddEvent {\r\n  type: SelectionSetEventType.Add;\r\n  /** The Ids of the elements added to the set. */\r\n  added: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are removed from the selection set.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SelectRemoveEvent {\r\n  /** The type of operation that produced this event. */\r\n  type: SelectionSetEventType.Remove | SelectionSetEventType.Clear;\r\n  /** The element Ids removed from the set. */\r\n  removed: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Passed to [[SelectionSet.onChanged]] event listeners when elements are simultaneously added to and removed from the selection set.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SelectReplaceEvent {\r\n  type: SelectionSetEventType.Replace;\r\n  /** The element Ids added to the set. */\r\n  added: Id64Arg;\r\n  /** The element Ids removed from the set. */\r\n  removed: Id64Arg;\r\n  /** The affected SelectionSet. */\r\n  set: SelectionSet;\r\n}\r\n\r\n/** Payload sent to [[SelectionSet.onChanged]] event listeners to describe how the contents of the set have changed.\r\n * The `type` property of the event serves as a type assertion. For example, the following code will output the added and/or removed Ids:\r\n *  ```ts\r\n *  processSelectionSetEvent(ev: SelectionSetEvent): void {\r\n *    if (SelectionSetEventType.Add === ev.type || SelectionSetEventType.Replace === ev.type)\r\n *      console.log(\"Added \" + ev.added.size + \" elements\");\r\n *\r\n *    if (SelectionSetEventType.Add !== ev.type)\r\n *      console.log(\"Removed \" + ev.removed.size + \" elements\");\r\n *  }\r\n *  ```\r\n * @public\r\n * @extensions\r\n */\r\nexport type SelectionSetEvent = SelectAddEvent | SelectRemoveEvent | SelectReplaceEvent;\r\n\r\n/** Tracks a set of hilited entities. When the set changes, notifies ViewManager so that symbology overrides can be updated in active Viewports.\r\n * @internal\r\n */\r\nclass HilitedIds extends Id64.Uint32Set {\r\n  protected _iModel: IModelConnection;\r\n  protected _changing = false;\r\n\r\n  public constructor(iModel: IModelConnection) {\r\n    super();\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  public override add(low: number, high: number) {\r\n    super.add(low, high);\r\n    this.onChanged();\r\n  }\r\n\r\n  public override delete(low: number, high: number) {\r\n    super.delete(low, high);\r\n    this.onChanged();\r\n  }\r\n\r\n  public override clear() {\r\n    super.clear();\r\n    this.onChanged();\r\n  }\r\n\r\n  public override addIds(ids: Id64Arg) {\r\n    this.change(() => super.addIds(ids));\r\n  }\r\n\r\n  public override deleteIds(ids: Id64Arg) {\r\n    this.change(() => super.deleteIds(ids));\r\n  }\r\n\r\n  protected onChanged() {\r\n    if (!this._changing)\r\n      IModelApp.viewManager.onSelectionSetChanged(this._iModel);\r\n  }\r\n\r\n  protected change(func: () => void) {\r\n    const changing = this._changing;\r\n    this._changing = false;\r\n    func();\r\n    this._changing = changing;\r\n    this.onChanged();\r\n  }\r\n}\r\n\r\n/** Keeps the set of hilited elements in sync with the selection set.\r\n * @internal\r\n */\r\nclass HilitedElementIds extends HilitedIds {\r\n  private _removeListener?: () => void;\r\n\r\n  public constructor(iModel: IModelConnection, syncWithSelectionSet = true) {\r\n    super(iModel);\r\n    this.wantSyncWithSelectionSet = syncWithSelectionSet;\r\n  }\r\n\r\n  public get wantSyncWithSelectionSet(): boolean { return undefined !== this._removeListener; }\r\n  public set wantSyncWithSelectionSet(want: boolean) {\r\n    if (want === this.wantSyncWithSelectionSet)\r\n      return;\r\n\r\n    if (want) {\r\n      const set = this._iModel.selectionSet;\r\n      this._removeListener = set.onChanged.addListener((ev) => this.change(() => this.processSelectionSetEvent(ev)));\r\n      this.processSelectionSetEvent({\r\n        set,\r\n        type: SelectionSetEventType.Add,\r\n        added: set.elements,\r\n      });\r\n    } else {\r\n      this._removeListener!();\r\n      this._removeListener = undefined;\r\n    }\r\n  }\r\n\r\n  private processSelectionSetEvent(ev: SelectionSetEvent): void {\r\n    if (SelectionSetEventType.Add !== ev.type)\r\n      this.deleteIds(ev.removed);\r\n\r\n    if (ev.type === SelectionSetEventType.Add || ev.type === SelectionSetEventType.Replace)\r\n      this.addIds(ev.added);\r\n  }\r\n}\r\n\r\n/** A set of *hilited* elements for an [[IModelConnection]], by element id.\r\n * Hilited elements are displayed with a customizable hilite effect within a [[Viewport]].\r\n * The set exposes 3 types of elements in 3 separate collections: geometric elements, subcategories, and geometric models.\r\n * @note Typically, elements are hilited by virtue of their presence in the IModelConnection's [[SelectionSet]]. The HiliteSet allows additional\r\n * elements to be displayed with the hilite effect without adding them to the [[SelectionSet]]. If you add elements to the HiliteSet directly, you\r\n * are also responsible for removing them as appropriate.\r\n * @note Support for subcategories and geometric models in the HiliteSet is currently `beta`.\r\n * @see [[IModelConnection.hilited]] for the HiliteSet associated with an iModel.\r\n * @see [Hilite.Settings]($common) for customization of the hilite effect.\r\n * @public\r\n * @extensions\r\n */\r\nexport class HiliteSet {\r\n  private readonly _elements: HilitedElementIds;\r\n\r\n  /** The set of hilited subcategories.\r\n   * @beta\r\n   */\r\n  public readonly subcategories: Id64.Uint32Set;\r\n  /** The set of hilited [[GeometricModelState]]s.\r\n   * @beta\r\n   */\r\n  public readonly models: Id64.Uint32Set;\r\n  /** The set of hilited elements. */\r\n  public get elements(): Id64.Uint32Set { return this._elements; }\r\n\r\n  /** Construct a HiliteSet\r\n   * @param iModel The iModel containing the entities to be hilited.\r\n   * @param syncWithSelectionSet If true, the contents of the `elements` set will be synchronized with those in the `iModel`'s [[SelectionSet]].\r\n   * @internal\r\n   */\r\n  public constructor(public iModel: IModelConnection, syncWithSelectionSet = true) {\r\n    this._elements = new HilitedElementIds(iModel, syncWithSelectionSet);\r\n    this.subcategories = new HilitedIds(iModel);\r\n    this.models = new HilitedIds(iModel);\r\n  }\r\n\r\n  /** Control whether the hilited elements will be synchronized with the contents of the [[SelectionSet]].\r\n   * By default they are synchronized. Applications that override this take responsibility for managing the set of hilited entities.\r\n   * When turning synchronization off, the contents of the HiliteSet will remain unchanged.\r\n   * 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.\r\n   */\r\n  public get wantSyncWithSelectionSet(): boolean { return this._elements.wantSyncWithSelectionSet; }\r\n  public set wantSyncWithSelectionSet(want: boolean) { this._elements.wantSyncWithSelectionSet = want; }\r\n\r\n  /** Remove all elements from the hilited set. */\r\n  public clear() {\r\n    this.elements.clear();\r\n    this.subcategories.clear();\r\n    this.models.clear();\r\n  }\r\n\r\n  /** Returns true if nothing is hilited. */\r\n  public get isEmpty(): boolean { return this.elements.isEmpty && this.subcategories.isEmpty && this.models.isEmpty; }\r\n\r\n  /** Toggle the hilited state of one or more elements.\r\n   * @param arg the ID(s) of the elements whose state is to be toggled.\r\n   * @param onOff True to add the elements to the hilited set, false to remove them.\r\n   */\r\n  public setHilite(arg: Id64Arg, onOff: boolean): void {\r\n    for (const id of Id64.iterable(arg)) {\r\n      if (onOff)\r\n        this.elements.addId(id);\r\n      else\r\n        this.elements.deleteId(id);\r\n    }\r\n\r\n    IModelApp.viewManager.onSelectionSetChanged(this.iModel);\r\n  }\r\n}\r\n\r\n/** A set of *currently selected* elements for an IModelConnection.\r\n * Selected elements are displayed with a customizable hilite effect within a [[Viewport]].\r\n * @see [Hilite.Settings]($common) for customization of the hilite effect.\r\n * @public\r\n * @extensions\r\n */\r\nexport class SelectionSet {\r\n  private _elements = new Set<string>();\r\n\r\n  /** The IDs of the selected elements.\r\n   * @note Do not modify this set directly. Instead, use methods like [[SelectionSet.add]].\r\n   */\r\n  public get elements(): Set<string> { return this._elements; }\r\n\r\n  /** Called whenever elements are added or removed from this SelectionSet */\r\n  public readonly onChanged = new BeEvent<(ev: SelectionSetEvent) => void>();\r\n\r\n  public constructor(public iModel: IModelConnection) { }\r\n\r\n  private sendChangedEvent(ev: SelectionSetEvent) {\r\n    IModelApp.viewManager.onSelectionSetChanged(this.iModel);\r\n    this.onChanged.raiseEvent(ev);\r\n  }\r\n\r\n  /** Get the number of entries in this selection set. */\r\n  public get size() { return this.elements.size; }\r\n\r\n  /** Check whether there are any selected elements. */\r\n  public get isActive() { return this.size !== 0; }\r\n\r\n  /** Return true if elemId is in this SelectionSet.\r\n   * @see [[isSelected]]\r\n   */\r\n  public has(elemId?: string) { return !!elemId && this.elements.has(elemId); }\r\n\r\n  /** Query whether an Id is in the selection set.\r\n   * @see [[has]]\r\n   */\r\n  public isSelected(elemId?: Id64String): boolean { return !!elemId && this.elements.has(elemId); }\r\n\r\n  /** Clear current selection set.\r\n   * @note raises the [[onChanged]] event with [[SelectionSetEventType.Clear]].\r\n   */\r\n  public emptyAll(): void {\r\n    if (!this.isActive)\r\n      return;\r\n\r\n    const removed = this._elements;\r\n    this._elements = new Set<string>();\r\n    this.sendChangedEvent({ set: this, type: SelectionSetEventType.Clear, removed });\r\n  }\r\n\r\n  /**\r\n   * Add one or more Ids to the current selection set.\r\n   * @param elem The set of Ids to add.\r\n   * @returns true if any elements were added.\r\n   */\r\n  public add(elem: Id64Arg): boolean {\r\n    return this._add(elem);\r\n  }\r\n\r\n  private _add(elem: Id64Arg, sendEvent = true): boolean {\r\n    const oldSize = this.elements.size;\r\n    for (const id of Id64.iterable(elem))\r\n      this.elements.add(id);\r\n\r\n    const changed = oldSize !== this.elements.size;\r\n    if (sendEvent && changed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Add, set: this, added: elem });\r\n\r\n    return changed;\r\n  }\r\n\r\n  /**\r\n   * Remove one or more Ids from the current selection set.\r\n   * @param elem The set of Ids to remove.\r\n   * @returns true if any elements were removed.\r\n   */\r\n  public remove(elem: Id64Arg): boolean {\r\n    return this._remove(elem);\r\n  }\r\n\r\n  private _remove(elem: Id64Arg, sendEvent = true): boolean {\r\n    const oldSize = this.elements.size;\r\n    for (const id of Id64.iterable(elem))\r\n      this.elements.delete(id);\r\n\r\n    const changed = oldSize !== this.elements.size;\r\n    if (sendEvent && changed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Remove, set: this, removed: elem });\r\n\r\n    return changed;\r\n  }\r\n\r\n  /**\r\n   * Add one set of Ids, and remove another set of Ids. Any Ids that are in both sets are removed.\r\n   * @returns True if any Ids were either added or removed.\r\n   */\r\n  public addAndRemove(adds: Id64Arg, removes: Id64Arg): boolean {\r\n    const added = this._add(adds, false);\r\n    const removed = this._remove(removes, false);\r\n\r\n    if (added && removed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Replace, set: this, added: adds, removed: removes });\r\n    else if (added)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Add, set: this, added: adds });\r\n    else if (removed)\r\n      this.sendChangedEvent({ type: SelectionSetEventType.Remove, set: this, removed: removes });\r\n\r\n    return (added || removed);\r\n  }\r\n\r\n  /** Invert the state of a set of Ids in the SelectionSet */\r\n  public invert(elem: Id64Arg): boolean {\r\n    const elementsToAdd = new Set<string>();\r\n    const elementsToRemove = new Set<string>();\r\n    for (const id of Id64.iterable(elem)) {\r\n      if (this.elements.has(id))\r\n        elementsToRemove.add(id);\r\n      else\r\n        elementsToAdd.add(id);\r\n    }\r\n\r\n    return this.addAndRemove(elementsToAdd, elementsToRemove);\r\n  }\r\n\r\n  /** Change selection set to be the supplied set of Ids. */\r\n  public replace(elem: Id64Arg): void {\r\n    if (areEqual(this.elements, elem))\r\n      return;\r\n\r\n    const removed = this._elements;\r\n    this._elements = new Set<string>();\r\n    this._add(elem, false);\r\n\r\n    if (0 < removed.size) {\r\n      for (const id of Id64.iterable(elem)) {\r\n        if (removed.has(id))\r\n          removed.delete(id);\r\n      }\r\n    }\r\n\r\n    this.sendChangedEvent({ type: SelectionSetEventType.Replace, set: this, added: elem, removed });\r\n  }\r\n}\r\n\r\nfunction areEqual(lhs: Set<string>, rhs: Id64Arg): boolean {\r\n  // Size is unreliable if input can contain duplicates...\r\n  if (Array.isArray(rhs))\r\n    rhs = Id64.toIdSet(rhs);\r\n\r\n  if (lhs.size !== Id64.sizeOf(rhs))\r\n    return false;\r\n\r\n  for (const id of Id64.iterable(rhs))\r\n    if (!lhs.has(id))\r\n      return false;\r\n\r\n  return true;\r\n}\r\n"]}

package/lib/esm/SheetViewState.d.ts

@@ -3,7 +3,7 @@
  */
 import { Id64Array, Id64String } from "@itwin/core-bentley";
 import { Point2d, Point3d, Range3d } from "@itwin/core-geometry";
-import { AxisAlignedBox3d, SheetProps, ViewAttachmentProps, ViewDefinition2dProps, ViewStateProps } from "@itwin/core-common";
+import { AxisAlignedBox3d, HydrateViewStateRequestProps, HydrateViewStateResponseProps, SheetProps, ViewAttachmentProps, ViewDefinition2dProps, ViewStateProps } from "@itwin/core-common";
 import { CategorySelectorState } from "./CategorySelectorState";
 import { DisplayStyle2dState } from "./DisplayStyleState";
 import { IModelConnection } from "./IModelConnection";
@@ -15,6 +15,7 @@ import { DrawingViewState } from "./DrawingViewState";
 import { DisclosedTileTreeSet } from "./tile/internal";
 /** A view of a [SheetModel]($backend).
  * @public
+ * @extensions
  */
 export declare class SheetViewState extends ViewState2d {
     /** The width and height of the sheet in world coordinates. */
@@ -51,10 +52,10 @@ export declare class SheetViewState extends ViewState2d {
     };
     /** @internal */
     getViewedExtents(): AxisAlignedBox3d;
-    /** Load the size and attachment for this sheet, as well as any other 2d view state characteristics.
-     * @internal override
-     */
-    load(): Promise<void>;
+    /** @internal */
+    protected preload(hydrateRequest: HydrateViewStateRequestProps): void;
+    /** @internal */
+    protected postload(hydrateResponse: HydrateViewStateResponseProps): Promise<void>;
     /** @internal */
     createScene(context: SceneContext): void;
     /** @internal */

package/lib/esm/SheetViewState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SheetViewState.d.ts","sourceRoot":"","sources":["../../src/SheetViewState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAmB,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAoD,OAAO,EAAE,OAAO,EAA4B,OAAO,EAA4B,MAAM,sBAAsB,CAAC;AACvK,OAAO,EACL,gBAAgB,EAAkH,UAAU,EACvH,mBAAmB,EAAE,qBAAqB,EAAqB,cAAc,EACnG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAStD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAI9D,OAAO,EAAqB,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAa,WAAW,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAkC,oBAAoB,EAAmB,MAAM,iBAAiB,CAAC;AAwOxG;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,8DAA8D;IAC9D,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,gBAAgB,CAAsB;IAC9C,OAAO,CAAC,YAAY,CAAC,CAAkB;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAmB;IAElD,IAAW,aAAa,IAAI,SAAS,CAEpC;IAED,gBAAgB;IAChB,WAA2B,SAAS,WAAoC;WAEjD,eAAe,CAAC,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,GAAG,cAAc;IAQ/F,OAAO,IAAI,cAAc;IAmBzC,sCAAsC;IACtC,IAAW,mBAAmB,IAAI,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAErE;IAED,sCAAsC;IACtC,IAAW,WAAW,IAAI,MAAM,EAAE,GAAG,SAAS,CAE7C;IAED,gBAAgB;IACA,aAAa,IAAI,IAAI,IAAI,gBAAgB;IACzD,gBAAgB;IACA,WAAW,IAAI,IAAI,IAAI,cAAc;gBAElC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS;IAkB/K,SAAS;IAQT,UAAU;IAQ1B;;OAEG;IACa,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAMpE,gBAAgB;IACA,4BAA4B,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAMlF,gBAAgB;IAChB,IAAoB,mBAAmB;;;MAEtC;IAED,gBAAgB;IACA,gBAAgB,IAAI,gBAAgB;IAIpD;;OAEG;IACmB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3C,gBAAgB;IACA,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMxD,gBAAgB;IAChB,IAAoB,kBAAkB,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAgB3D;IAED,gBAAgB;YACF,kBAAkB;IAShC,gBAAgB;IACM,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3E,gBAAgB;IACA,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAMlE,gBAAgB;IACA,kBAAkB,IAAI,IAAI;IAK1C,gBAAgB;IAChB,IAAoB,qBAAqB,IAAI,OAAO,CAEnD;IAED,gDAAgD;IAChD,OAAO,CAAC,YAAY;IAOpB,gBAAgB;IACA,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAQxD,gBAAgB;IACA,eAAe,IAAI,OAAO;CAM3C"}
+{"version":3,"file":"SheetViewState.d.ts","sourceRoot":"","sources":["../../src/SheetViewState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAsC,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,EAAoD,OAAO,EAAE,OAAO,EAA4B,OAAO,EAA4B,MAAM,sBAAsB,CAAC;AACvK,OAAO,EACL,gBAAgB,EAAiF,4BAA4B,EAAE,6BAA6B,EAAmC,UAAU,EACpL,mBAAmB,EAAE,qBAAqB,EAAqB,cAAc,EACnG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAStD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAI9D,OAAO,EAAqB,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAa,WAAW,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAkC,oBAAoB,EAAmB,MAAM,iBAAiB,CAAC;AA0RxG;;;GAGG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,8DAA8D;IAC9D,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,gBAAgB,CAAsB;IAC9C,OAAO,CAAC,YAAY,CAAC,CAAkB;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAmB;IAElD,IAAW,aAAa,IAAI,SAAS,CAEpC;IAED,gBAAgB;IAChB,WAA2B,SAAS,WAAoC;WAEjD,eAAe,CAAC,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,GAAG,cAAc;IAQ/F,OAAO,IAAI,cAAc;IAmBzC,sCAAsC;IACtC,IAAW,mBAAmB,IAAI,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAErE;IAED,sCAAsC;IACtC,IAAW,WAAW,IAAI,MAAM,EAAE,GAAG,SAAS,CAE7C;IAED,gBAAgB;IACA,aAAa,IAAI,IAAI,IAAI,gBAAgB;IACzD,gBAAgB;IACA,WAAW,IAAI,IAAI,IAAI,cAAc;gBAElC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS;IAkB/K,SAAS;IAQT,UAAU;IAQ1B;;OAEG;IACa,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,IAAI;IAMpE,gBAAgB;IACA,4BAA4B,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;IAMlF,gBAAgB;IAChB,IAAoB,mBAAmB;;;MAEtC;IAED,gBAAgB;IACA,gBAAgB,IAAI,gBAAgB;IAIpD,gBAAgB;cACG,OAAO,CAAC,cAAc,EAAE,4BAA4B,GAAG,IAAI;IAK9E,gBAAgB;cACS,QAAQ,CAAC,eAAe,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhG,gBAAgB;IACA,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMxD,gBAAgB;IAChB,IAAoB,kBAAkB,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAgB3D;IAED,gBAAgB;YACF,kBAAkB;IAShC,gBAAgB;IACM,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3E,gBAAgB;IACA,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAMlE,gBAAgB;IACA,kBAAkB,IAAI,IAAI;IAK1C,gBAAgB;IAChB,IAAoB,qBAAqB,IAAI,OAAO,CAEnD;IAED,gDAAgD;IAChD,OAAO,CAAC,YAAY;IAOpB,gBAAgB;IACA,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAQxD,gBAAgB;IACA,eAAe,IAAI,OAAO;CAM3C"}

package/lib/esm/SheetViewState.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module Views
  */
-import { assert, dispose } from "@itwin/core-bentley";
+import { assert, CompressedId64Set, dispose } from "@itwin/core-bentley";
 import { Angle, ClipShape, ClipVector, Constant, Matrix3d, Point2d, Point3d, PolyfaceBuilder, Range2d, Range3d, StrokeOptions, Transform } from "@itwin/core-geometry";
 import { ColorDef, Feature, FeatureTable, Frustum, Gradient, GraphicParams, PackedFeatureTable, Placement2d, TextureTransparency, } from "@itwin/core-common";
 import { CategorySelectorState } from "./CategorySelectorState";
@@ -124,6 +124,52 @@ class ViewAttachmentsInfo {
         // No reason to clone the array.
         return new ViewAttachmentsInfo(this._attachments);
     }
+    preload(options) {
+        if (this.isLoaded)
+            return;
+        options.sheetViewAttachmentIds = CompressedId64Set.sortAndCompress(this._ids);
+        options.viewStateLoadProps = {
+            displayStyle: {
+                omitScheduleScriptElementIds: true,
+                compressExcludedElementIds: true,
+            },
+        };
+    }
+    async postload(options, iModel) {
+        if (options.sheetViewViews === undefined)
+            return;
+        if (options.sheetViewAttachmentProps === undefined)
+            return;
+        const viewStateProps = options.sheetViewViews; // This is viewstateProps, need to turn this into ViewState
+        const promises = [];
+        for (const viewProps of viewStateProps) {
+            const loadView = async () => {
+                try {
+                    if (viewProps === undefined)
+                        return undefined;
+                    const view = await iModel.views.convertViewStatePropsToViewState(viewProps);
+                    return view;
+                }
+                catch {
+                    return undefined;
+                }
+            };
+            promises.push(loadView());
+        }
+        const views = await Promise.all(promises);
+        const attachmentProps = options.sheetViewAttachmentProps;
+        assert(views.length === attachmentProps.length);
+        const attachments = [];
+        for (let i = 0; i < views.length; i++) {
+            const view = views[i];
+            if (view && !(view instanceof SheetViewState)) {
+                const props = attachmentProps[i];
+                props.attachedView = view;
+                attachments.push(props);
+            }
+        }
+        this._attachments = attachments;
+    }
     async load(iModel) {
         if (this.isLoaded)
             return;
@@ -207,6 +253,7 @@ class ViewAttachments {
 }
 /** A view of a [SheetModel]($backend).
  * @public
+ * @extensions
  */
 export class SheetViewState extends ViewState2d {
     constructor(props, iModel, categories, displayStyle, sheetProps, attachments) {
@@ -299,12 +346,17 @@ export class SheetViewState extends ViewState2d {
     getViewedExtents() {
         return this._viewedExtents;
     }
-    /** Load the size and attachment for this sheet, as well as any other 2d view state characteristics.
-     * @internal override
-     */
-    async load() {
-        await super.load();
-        await this._attachmentsInfo.load(this.iModel);
+    /** @internal */
+    preload(hydrateRequest) {
+        super.preload(hydrateRequest);
+        this._attachmentsInfo.preload(hydrateRequest);
+    }
+    /** @internal */
+    async postload(hydrateResponse) {
+        const promises = [];
+        promises.push(super.postload(hydrateResponse));
+        promises.push(this._attachmentsInfo.postload(hydrateResponse, this.iModel));
+        await Promise.all(promises);
     }
     /** @internal */
     createScene(context) {