@itwin/core-frontend 5.9.0-dev.9 → 5.9.1

package/lib/cjs/tools/ToolSettings.d.ts

@@ -76,5 +76,9 @@ export declare class ToolSettings {
      * @beta
      */
     static enableVolumeSelection: boolean;
+    /** If true, pressing Escape key sets focus to Home to allow shortcuts to be used.
+     * @beta
+    */
+    static escapeMovesFocusToHome: boolean;
 }
 //# sourceMappingURL=ToolSettings.d.ts.map

package/lib/cjs/tools/ToolSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolSettings.d.ts","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAY,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,qBAAa,YAAY;IACvB,6DAA6D;IAC7D,OAAc,gBAAgB,aAAoC;IAClE,kEAAkE;IAClE,OAAc,kBAAkB,aAAoC;IACpE,sGAAsG;IACtG,OAAc,0BAA0B,SAAQ;IAChD,4HAA4H;IAC5H,OAAc,4BAA4B,UAAS;IACnD,qFAAqF;IACrF,OAAc,eAAe,UAAQ;IACrC,wEAAwE;IACxE,OAAc,cAAc,aAAmC;IAC/D,gEAAgE;IAChE,OAAc,cAAc,aAAoC;IAChE,wFAAwF;IACxF,OAAc,uBAAuB,SAAO;IAC5C,qFAAqF;IACrF,OAAc,uBAAuB,SAAQ;IAC7C,sGAAsG;IACtG,OAAc,8BAA8B,SAAQ;IACpD,qFAAqF;IACrF,OAAc,wBAAwB,SAAQ;IAC9C,2CAA2C;IAC3C,OAAc,eAAe,QAA6B;IAC1D,oEAAoE;IACpE,OAAc,cAAc,UAAS;IACrC,sDAAsD;IACtD,OAAc,YAAY,SAAO;IACjC,kHAAkH;IAClH,OAAc,kBAAkB,SAAK;IACrC,oFAAoF;IACpF,OAAc,sBAAsB,UAAQ;IAC5C,mFAAmF;IACnF,OAAc,cAAc,UAAS;IACrC,kHAAkH;IAClH,OAAc,eAAe,UAAS;IACtC,oGAAoG;IACpG,OAAc,cAAc,SAAO;IACnC,mFAAmF;IACnF,OAAc,aAAa,SAAO;IAClC,sEAAsE;IACtE,OAAc,eAAe,SAAM;IACnC,sEAAsE;IACtE,OAAc,eAAe,SAAO;IACpC,6HAA6H;IAC7H,OAAc,qBAAqB,SAA0B;IAC7D,4EAA4E;IAC5E,OAAc,WAAW,SAAO;IAChC,kDAAkD;IAClD,OAAc,SAAS,SAAM;IAC7B,iDAAiD;IACjD,OAAc,cAAc,SAAO;IACnC,mHAAmH;IACnH,OAAc,cAAc;QAC1B,8BAA8B;;QAE9B,yHAAyH;;QAEzH,qFAAqF;;MAErF;IACF,2FAA2F;IAC3F,OAAc,4BAA4B,SAAM;IAChD;;;OAGG;IACH,OAAc,qBAAqB,UAAS;CAC7C"}
+{"version":3,"file":"ToolSettings.d.ts","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAY,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,qBAAa,YAAY;IACvB,6DAA6D;IAC7D,OAAc,gBAAgB,aAAoC;IAClE,kEAAkE;IAClE,OAAc,kBAAkB,aAAoC;IACpE,sGAAsG;IACtG,OAAc,0BAA0B,SAAQ;IAChD,4HAA4H;IAC5H,OAAc,4BAA4B,UAAS;IACnD,qFAAqF;IACrF,OAAc,eAAe,UAAQ;IACrC,wEAAwE;IACxE,OAAc,cAAc,aAAmC;IAC/D,gEAAgE;IAChE,OAAc,cAAc,aAAoC;IAChE,wFAAwF;IACxF,OAAc,uBAAuB,SAAO;IAC5C,qFAAqF;IACrF,OAAc,uBAAuB,SAAQ;IAC7C,sGAAsG;IACtG,OAAc,8BAA8B,SAAQ;IACpD,qFAAqF;IACrF,OAAc,wBAAwB,SAAQ;IAC9C,2CAA2C;IAC3C,OAAc,eAAe,QAA6B;IAC1D,oEAAoE;IACpE,OAAc,cAAc,UAAS;IACrC,sDAAsD;IACtD,OAAc,YAAY,SAAO;IACjC,kHAAkH;IAClH,OAAc,kBAAkB,SAAK;IACrC,oFAAoF;IACpF,OAAc,sBAAsB,UAAQ;IAC5C,mFAAmF;IACnF,OAAc,cAAc,UAAS;IACrC,kHAAkH;IAClH,OAAc,eAAe,UAAS;IACtC,oGAAoG;IACpG,OAAc,cAAc,SAAO;IACnC,mFAAmF;IACnF,OAAc,aAAa,SAAO;IAClC,sEAAsE;IACtE,OAAc,eAAe,SAAM;IACnC,sEAAsE;IACtE,OAAc,eAAe,SAAO;IACpC,6HAA6H;IAC7H,OAAc,qBAAqB,SAA0B;IAC7D,4EAA4E;IAC5E,OAAc,WAAW,SAAO;IAChC,kDAAkD;IAClD,OAAc,SAAS,SAAM;IAC7B,iDAAiD;IACjD,OAAc,cAAc,SAAO;IACnC,mHAAmH;IACnH,OAAc,cAAc;QAC1B,8BAA8B;;QAE9B,yHAAyH;;QAEzH,qFAAqF;;MAErF;IACF,2FAA2F;IAC3F,OAAc,4BAA4B,SAAM;IAChD;;;OAGG;IACH,OAAc,qBAAqB,UAAS;IAC5C;;MAEE;IACF,OAAc,sBAAsB,UAAQ;CAC7C"}

package/lib/cjs/tools/ToolSettings.js

@@ -83,6 +83,10 @@ class ToolSettings {
      * @beta
      */
     static enableVolumeSelection = false;
+    /** If true, pressing Escape key sets focus to Home to allow shortcuts to be used.
+     * @beta
+    */
+    static escapeMovesFocusToHome = true;
 }
 exports.ToolSettings = ToolSettings;
 //# sourceMappingURL=ToolSettings.js.map

package/lib/cjs/tools/ToolSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolSettings.js","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AACjD,wDAAuD;AAEvD;;;GAGG;AACH,MAAa,YAAY;IACvB,6DAA6D;IACtD,MAAM,CAAC,gBAAgB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAClE,kEAAkE;IAC3D,MAAM,CAAC,kBAAkB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpE,sGAAsG;IAC/F,MAAM,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAChD,4HAA4H;IACrH,MAAM,CAAC,4BAA4B,GAAG,KAAK,CAAC;IACnD,qFAAqF;IAC9E,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;IACrC,wEAAwE;IACjE,MAAM,CAAC,cAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC/D,gEAAgE;IACzD,MAAM,CAAC,cAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAChE,wFAAwF;IACjF,MAAM,CAAC,uBAAuB,GAAG,GAAG,CAAC;IAC5C,qFAAqF;IAC9E,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAC7C,sGAAsG;IAC/F,MAAM,CAAC,8BAA8B,GAAG,IAAI,CAAC;IACpD,qFAAqF;IAC9E,MAAM,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAC9C,2CAA2C;IACpC,MAAM,CAAC,eAAe,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1D,oEAAoE;IAC7D,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IACrC,sDAAsD;IAC/C,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC;IACjC,kHAAkH;IAC3G,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAC;IACrC,oFAAoF;IAC7E,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAC5C,mFAAmF;IAC5E,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IACrC,kHAAkH;IAC3G,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IACtC,oGAAoG;IAC7F,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC;IACnC,mFAAmF;IAC5E,MAAM,CAAC,aAAa,GAAG,GAAG,CAAC;IAClC,sEAAsE;IAC/D,MAAM,CAAC,eAAe,GAAG,EAAE,CAAC;IACnC,sEAAsE;IAC/D,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC;IACpC,6HAA6H;IACtH,MAAM,CAAC,qBAAqB,GAAG,wBAAQ,CAAC,aAAa,CAAC;IAC7D,4EAA4E;IACrE,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;IAChC,kDAAkD;IAC3C,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;IAC7B,iDAAiD;IAC1C,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC;IACnC,mHAAmH;IAC5G,MAAM,CAAC,cAAc,GAAG;QAC7B,8BAA8B;QAC9B,OAAO,EAAE,IAAI;QACb,yHAAyH;QACzH,OAAO,EAAE,GAAG;QACZ,qFAAqF;QACrF,QAAQ,EAAE,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC;KAC3C,CAAC;IACF,2FAA2F;IACpF,MAAM,CAAC,4BAA4B,GAAG,EAAE,CAAC;IAChD;;;OAGG;IACI,MAAM,CAAC,qBAAqB,GAAG,KAAK,CAAC;;AApE9C,oCAqEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tools\n */\n\nimport { BeDuration } from \"@itwin/core-bentley\";\nimport { Angle, Constant } from \"@itwin/core-geometry\";\n\n/** Settings that control the behavior of built-in tools. Applications may modify these values.\n * @public\n * @extensions\n */\nexport class ToolSettings {\n  /** Two tap must be within this period to be a double tap. */\n  public static doubleTapTimeout = BeDuration.fromMilliseconds(250);\n  /** Two clicks must be within this period to be a double click. */\n  public static doubleClickTimeout = BeDuration.fromMilliseconds(500);\n  /** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */\n  public static doubleClickToleranceInches = 0.05;\n  /** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */\n  public static enableVirtualCursorForLocate = false;\n  /** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */\n  public static preserveWorldUp = true;\n  /** Delay with a touch on the surface before a move operation begins. */\n  public static touchMoveDelay = BeDuration.fromMilliseconds(50);\n  /** Delay with the mouse down before a drag operation begins. */\n  public static startDragDelay = BeDuration.fromMilliseconds(110);\n  /** Distance in screen inches a touch point must move before being considered motion. */\n  public static touchMoveDistanceInches = 0.1;\n  /** Distance in screen inches the cursor must move before a drag operation begins. */\n  public static startDragDistanceInches = 0.15;\n  /** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */\n  public static touchZoomChangeThresholdInches = 0.20;\n  /** Radius in screen inches to search for elements that anchor viewing operations. */\n  public static viewToolPickRadiusInches = 0.20;\n  /** Camera angle enforced for walk tool. */\n  public static walkCameraAngle = Angle.createDegrees(75.6);\n  /** Whether the walk tool enforces worldZ be aligned with screenY */\n  public static walkEnforceZUp = false;\n  /** Speed, in meters per second, for the walk tool. */\n  public static walkVelocity = 3.5;\n  /** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */\n  public static walkVelocityChange = 0;\n  /** Whether the walk tool requests pointer lock to hide the cursor for mouse look */\n  public static walkRequestPointerLock = true;\n  /** @beta Whether the look and move tool detects collisions while moving forward */\n  public static walkCollisions = false;\n  /** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */\n  public static walkDetectFloor = false;\n  /** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */\n  public static walkStepHeight = 0.3;\n  /** @beta Camera height in meters above floor/ground to use for set up walk tool */\n  public static walkEyeHeight = 1.6;\n  /** Scale factor applied for wheel events with \"per-line\" modifier. */\n  public static wheelLineFactor = 40;\n  /** Scale factor applied for wheel events with \"per-page\" modifier. */\n  public static wheelPageFactor = 120;\n  /** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it \"bumps\" through. */\n  public static wheelZoomBumpDistance = Constant.oneCentimeter;\n  /** the speed to scroll for the \"scroll view\" tool (distance per second). */\n  public static scrollSpeed = .75;\n  /** the speed to zoom for the \"zoom view\" tool. */\n  public static zoomSpeed = 10;\n  /** Scale factor for zooming with mouse wheel. */\n  public static wheelZoomRatio = 1.5;\n  /** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */\n  public static viewingInertia = {\n    /** Flag to enable inertia. */\n    enabled: true,\n    /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */\n    damping: .96,\n    /** Maximum duration of the inertia operation. Important when frame rates are low. */\n    duration: BeDuration.fromMilliseconds(500),\n  };\n  /** Maximum number of times in a second the accuSnap tool's onMotion function is called. */\n  public static maxOnMotionSnapCallPerSecond = 15;\n  /** If true, drag box selection will accept spatial elements that are inside or overlap a clip volume instead of only what is visible in the view.\n   * @note Enabling is not recommended for web applications.\n   * @beta\n   */\n  public static enableVolumeSelection = false;\n}\n"]}
+{"version":3,"file":"ToolSettings.js","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AACjD,wDAAuD;AAEvD;;;GAGG;AACH,MAAa,YAAY;IACvB,6DAA6D;IACtD,MAAM,CAAC,gBAAgB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAClE,kEAAkE;IAC3D,MAAM,CAAC,kBAAkB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpE,sGAAsG;IAC/F,MAAM,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAChD,4HAA4H;IACrH,MAAM,CAAC,4BAA4B,GAAG,KAAK,CAAC;IACnD,qFAAqF;IAC9E,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;IACrC,wEAAwE;IACjE,MAAM,CAAC,cAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC/D,gEAAgE;IACzD,MAAM,CAAC,cAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAChE,wFAAwF;IACjF,MAAM,CAAC,uBAAuB,GAAG,GAAG,CAAC;IAC5C,qFAAqF;IAC9E,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAC7C,sGAAsG;IAC/F,MAAM,CAAC,8BAA8B,GAAG,IAAI,CAAC;IACpD,qFAAqF;IAC9E,MAAM,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAC9C,2CAA2C;IACpC,MAAM,CAAC,eAAe,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1D,oEAAoE;IAC7D,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IACrC,sDAAsD;IAC/C,MAAM,CAAC,YAAY,GAAG,GAAG,CAAC;IACjC,kHAAkH;IAC3G,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAC;IACrC,oFAAoF;IAC7E,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAC5C,mFAAmF;IAC5E,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IACrC,kHAAkH;IAC3G,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IACtC,oGAAoG;IAC7F,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC;IACnC,mFAAmF;IAC5E,MAAM,CAAC,aAAa,GAAG,GAAG,CAAC;IAClC,sEAAsE;IAC/D,MAAM,CAAC,eAAe,GAAG,EAAE,CAAC;IACnC,sEAAsE;IAC/D,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC;IACpC,6HAA6H;IACtH,MAAM,CAAC,qBAAqB,GAAG,wBAAQ,CAAC,aAAa,CAAC;IAC7D,4EAA4E;IACrE,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC;IAChC,kDAAkD;IAC3C,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;IAC7B,iDAAiD;IAC1C,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC;IACnC,mHAAmH;IAC5G,MAAM,CAAC,cAAc,GAAG;QAC7B,8BAA8B;QAC9B,OAAO,EAAE,IAAI;QACb,yHAAyH;QACzH,OAAO,EAAE,GAAG;QACZ,qFAAqF;QACrF,QAAQ,EAAE,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC;KAC3C,CAAC;IACF,2FAA2F;IACpF,MAAM,CAAC,4BAA4B,GAAG,EAAE,CAAC;IAChD;;;OAGG;IACI,MAAM,CAAC,qBAAqB,GAAG,KAAK,CAAC;IAC5C;;MAEE;IACK,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC;;AAxE9C,oCAyEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tools\n */\n\nimport { BeDuration } from \"@itwin/core-bentley\";\nimport { Angle, Constant } from \"@itwin/core-geometry\";\n\n/** Settings that control the behavior of built-in tools. Applications may modify these values.\n * @public\n * @extensions\n */\nexport class ToolSettings {\n  /** Two tap must be within this period to be a double tap. */\n  public static doubleTapTimeout = BeDuration.fromMilliseconds(250);\n  /** Two clicks must be within this period to be a double click. */\n  public static doubleClickTimeout = BeDuration.fromMilliseconds(500);\n  /** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */\n  public static doubleClickToleranceInches = 0.05;\n  /** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */\n  public static enableVirtualCursorForLocate = false;\n  /** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */\n  public static preserveWorldUp = true;\n  /** Delay with a touch on the surface before a move operation begins. */\n  public static touchMoveDelay = BeDuration.fromMilliseconds(50);\n  /** Delay with the mouse down before a drag operation begins. */\n  public static startDragDelay = BeDuration.fromMilliseconds(110);\n  /** Distance in screen inches a touch point must move before being considered motion. */\n  public static touchMoveDistanceInches = 0.1;\n  /** Distance in screen inches the cursor must move before a drag operation begins. */\n  public static startDragDistanceInches = 0.15;\n  /** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */\n  public static touchZoomChangeThresholdInches = 0.20;\n  /** Radius in screen inches to search for elements that anchor viewing operations. */\n  public static viewToolPickRadiusInches = 0.20;\n  /** Camera angle enforced for walk tool. */\n  public static walkCameraAngle = Angle.createDegrees(75.6);\n  /** Whether the walk tool enforces worldZ be aligned with screenY */\n  public static walkEnforceZUp = false;\n  /** Speed, in meters per second, for the walk tool. */\n  public static walkVelocity = 3.5;\n  /** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */\n  public static walkVelocityChange = 0;\n  /** Whether the walk tool requests pointer lock to hide the cursor for mouse look */\n  public static walkRequestPointerLock = true;\n  /** @beta Whether the look and move tool detects collisions while moving forward */\n  public static walkCollisions = false;\n  /** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */\n  public static walkDetectFloor = false;\n  /** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */\n  public static walkStepHeight = 0.3;\n  /** @beta Camera height in meters above floor/ground to use for set up walk tool */\n  public static walkEyeHeight = 1.6;\n  /** Scale factor applied for wheel events with \"per-line\" modifier. */\n  public static wheelLineFactor = 40;\n  /** Scale factor applied for wheel events with \"per-page\" modifier. */\n  public static wheelPageFactor = 120;\n  /** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it \"bumps\" through. */\n  public static wheelZoomBumpDistance = Constant.oneCentimeter;\n  /** the speed to scroll for the \"scroll view\" tool (distance per second). */\n  public static scrollSpeed = .75;\n  /** the speed to zoom for the \"zoom view\" tool. */\n  public static zoomSpeed = 10;\n  /** Scale factor for zooming with mouse wheel. */\n  public static wheelZoomRatio = 1.5;\n  /** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */\n  public static viewingInertia = {\n    /** Flag to enable inertia. */\n    enabled: true,\n    /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */\n    damping: .96,\n    /** Maximum duration of the inertia operation. Important when frame rates are low. */\n    duration: BeDuration.fromMilliseconds(500),\n  };\n  /** Maximum number of times in a second the accuSnap tool's onMotion function is called. */\n  public static maxOnMotionSnapCallPerSecond = 15;\n  /** If true, drag box selection will accept spatial elements that are inside or overlap a clip volume instead of only what is visible in the view.\n   * @note Enabling is not recommended for web applications.\n   * @beta\n   */\n  public static enableVolumeSelection = false;\n  /** If true, pressing Escape key sets focus to Home to allow shortcuts to be used.\n   * @beta\n  */\n  public static escapeMovesFocusToHome = true;\n}\n"]}

package/lib/esm/BriefcaseConnection.d.ts

@@ -144,11 +144,11 @@ export declare class BriefcaseConnection extends IModelConnection {
     hasPendingTxns(): Promise<boolean>;
     /** Commit pending changes to this briefcase.
      * @param description Optional description of the changes.
-     * @deprecated Use methods on EditCommand instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.
      */
     saveChanges(description?: string): Promise<void>;
     /** Abandon pending changes to this briefcase.
-     * @deprecated Use methods on EditCommand instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.
      */
     abandonChanges(): Promise<void>;
     /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase

package/lib/esm/BriefcaseConnection.js

@@ -244,13 +244,13 @@ export class BriefcaseConnection extends IModelConnection {
     }
     /** Commit pending changes to this briefcase.
      * @param description Optional description of the changes.
-     * @deprecated Use methods on EditCommand instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.
      */
     async saveChanges(description) {
         await IpcApp.appFunctionIpc.saveChanges(this.key, description); // eslint-disable-line @typescript-eslint/no-deprecated
     }
     /** Abandon pending changes to this briefcase.
-     * @deprecated Use methods on EditCommand instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.
      */
     async abandonChanges() {
         await IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated

package/lib/esm/BriefcaseConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseConnection.js","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAmC,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxI,OAAO,EAC0D,wBAAwB,EAAE,WAAW,GAErG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,kCAAkC,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AA8CtC;;;GAGG;AACH,MAAM,kBAAkB;IACd,aAAa,CAAyB;IAC7B,UAAU,CAAsB;IAChC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,SAAS,GAAmB,EAAE,CAAC;IAEhD,YAAmB,SAA8B;QAC/C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,iCAAiC;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YAChF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,8BAA8B;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACzE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,KAAK,MAAM,EAAE,IAAI,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,gHAAgH;QAChH,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,IAAI,CAAC,YAAY;gBACnB,OAAO;YAET,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBACrB,MAAM,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEtE,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,EAAE,CAAC;QAEZ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,IAAI,CAAC,aAAa,GAAG,MAAM,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAExE,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACtF,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,MAAM,IAAI,OAAO;gBAC1B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAE3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5C,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,kBAAkB,EAAE,CAAC;YACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC;YACrD,IAAI,KAAK;gBACP,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChC,kCAAkC,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9D,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEO,gBAAgB,CAAC,aAAmC;QAC1D,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACjD,IAAI,IAAI,YAAY,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChE,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;oBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;wBAClC,IAAI,CAAC,eAAe,EAAE,CAAC;wBACvB,IAAI,CAAC,iCAAiC,EAAE,CAAC;wBACzC,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAqBD;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA2B;IAC9B,SAAS,CAAc;IACvB,MAAM,CAAc;IAE5B,sEAAsE;IACtD,iBAAiB,GAAG,IAAI,OAAO,EAAsD,CAAC;IAEtG,mEAAmE;IACnD,cAAc,GAAG,IAAI,OAAO,EAAmD,CAAC;IAEhG;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,QAAQ,CAAC,QAAgC;QAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAW,KAAK,CAAC,KAA6B;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,gBAAgB;IAC7C,SAAS,CAAW;IACb,cAAc,CAAqB;IAC5C,MAAM,CAAe;IAE7B;;OAEG;IACa,WAAW,CAAU;IAErC;;OAEG;IACa,kBAAkB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IAEvE,+FAA+F;IAC/E,IAAI,CAAgB;IAEpC;;;OAGG;IACH,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnD,qBAAqB,KAAkC,OAAO,IAAI,CAAC,CAAC,CAAC;IAErF,gEAAgE;IAChE,IAAoB,OAAO,KAAiB,OAAO,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAEtK,4CAA4C;IAC5C,IAAoB,QAAQ,KAAiB,OAAO,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAExK,YAAsB,KAA+B,EAAE,QAAkB;QACvE,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACvC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAkC,EAAE,kBAAuC;QACtG,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC9E,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACrI,IAAI,kBAAkB;YACpB,UAAU,CAAC,MAAM,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE3D,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,WAAqB,QAAQ,CAAC,SAAS,EAAE,IAA4B;QACxH,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpD,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IAElE;;;OAGG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QAET,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAES,eAAe;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK;YAC7B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;IAC9E,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,cAAc;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,WAAoB;QAC3C,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,uDAAuD;IACzH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,uDAAuD;IAC/G,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,OAA4B;QAC7E,MAAM,eAAe,GAAmB,EAAE,CAAC;QAC3C,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,EAAE,wBAAwB,CAAC;QAEjE,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,OAAO,EAAE,wBAAwB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC5C,CAAC,CAAC;YAEF,MAAM,sBAAsB,GAAG,MAAM,CAAC,WAAW,CAC/C,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,EACvC,cAAc,CACf,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClF,OAAO,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACtD,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,aAAa,GAA6B;YAC9C,cAAc,EAAE,oBAAoB;YACpC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;YAC3C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW;SAC3C,CAAC;QACF,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACT,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,WAAmB;QAC1C,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB;QAC5B,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,sBAAsB,GAAG,IAAI,OAAO,EAA0C,CAAC;CAChG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module IModelConnection\n */\n\nimport { assert, BeEvent, CompressedId64Set, Guid, GuidString, Id64Set, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseConnectionProps, ChangesetIndex, ChangesetIndexAndId, getPullChangesIpcChannel, IModelError,\n  PullChangesOptions as IpcAppPullChangesOptions, LockState, OpenBriefcaseProps, StandaloneOpenOptions,\n} from \"@itwin/core-common\";\nimport { BriefcaseTxns } from \"./BriefcaseTxns\";\nimport { GraphicalEditingScope } from \"./GraphicalEditingScope\";\nimport { IModelApp } from \"./IModelApp\";\nimport { IModelConnection } from \"./IModelConnection\";\nimport { IpcApp } from \"./IpcApp\";\nimport { disposeTileTreesForGeometricModels } from \"./tile/internal\";\nimport { Viewport } from \"./Viewport\";\n\n/**\n * Download progress information.\n * @public\n */\nexport interface DownloadProgressInfo {\n  /** Bytes downloaded. */\n  loaded: number;\n  /** Total size of the download in bytes. */\n  total: number;\n}\n\n/**\n * Called to show progress during a download.\n * @public\n */\nexport type OnDownloadProgress = (progress: DownloadProgressInfo) => void;\n\n/**\n * Partial interface of AbortSignal.\n * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal\n * @beta\n */\nexport interface GenericAbortSignal {\n  /** Add Listener for abort signal. */\n  addEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\n  /** Remove Listener for abort signal. */\n  removeEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\n}\n\n/**\n * Options for pulling iModel changes.\n * @public\n */\nexport interface PullChangesOptions {\n  /** Function called regularly to report progress of changes download. */\n  downloadProgressCallback?: OnDownloadProgress;\n  /** Interval for calling progress callback (in milliseconds). */\n  progressInterval?: number;\n  /** Signal for cancelling the download.\n   * @beta\n   */\n  abortSignal?: GenericAbortSignal;\n}\n\n/** Keeps track of changes to models, buffering them until synchronization points.\n * While a GraphicalEditingScope is open, the changes are buffered until the scope exits, at which point they are processed.\n * Otherwise, the buffered changes are processed after undo/redo, commit, or pull+merge changes.\n */\nclass ModelChangeMonitor {\n  private _editingScope?: GraphicalEditingScope;\n  private readonly _briefcase: BriefcaseConnection;\n  private readonly _deletedModels = new Set<string>();\n  private readonly _modelIdToGuid = new Map<string, string>();\n  private readonly _removals: VoidFunction[] = [];\n\n  public constructor(briefcase: BriefcaseConnection) {\n    this._briefcase = briefcase;\n\n    // Buffer updated geometry guids.\n    this._removals.push(briefcase.txns.onModelGeometryChanged.addListener((changes) => {\n      for (const change of changes) {\n        this._deletedModels.delete(change.id);\n        this._modelIdToGuid.set(change.id, change.guid);\n      }\n    }));\n\n    // Buffer deletions of models.\n    this._removals.push(briefcase.txns.onModelsChanged.addListener((changes) => {\n      if (changes.deleted) {\n        for (const id of CompressedId64Set.iterable(changes.deleted)) {\n          this._modelIdToGuid.delete(id);\n          this._deletedModels.add(id);\n        }\n      }\n    }));\n\n    // Outside of an editing scope, we want to update viewport contents after commit, undo/redo, or merging changes.\n    const maybeProcess = async () => {\n      if (this.editingScope)\n        return;\n\n      const modelIds = Array.from(this._modelIdToGuid.keys());\n      if (modelIds.length > 0)\n        await IModelApp.tileAdmin.purgeTileTrees(this._briefcase, modelIds);\n\n      this.processBuffered();\n    };\n\n    this._removals.push(briefcase.txns.onCommitted.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onReplayedExternalTxns.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onAfterUndoRedo.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onChangesPulled.addListener(maybeProcess));\n  }\n\n  public async close(): Promise<void> {\n    for (const removal of this._removals)\n      removal();\n\n    this._removals.length = 0;\n\n    if (this._editingScope) {\n      await this._editingScope.exit();\n      this._editingScope = undefined;\n    }\n  }\n\n  public get editingScope(): GraphicalEditingScope | undefined {\n    return this._editingScope;\n  }\n\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\n    if (this._editingScope)\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\n\n    this._editingScope = await GraphicalEditingScope.enter(this._briefcase);\n\n    const removeGeomListener = this._editingScope.onGeometryChanges.addListener((changes) => {\n      const modelIds = [];\n      for (const change of changes)\n        modelIds.push(change.id);\n\n      this.invalidateScenes(modelIds);\n    });\n\n    this._editingScope.onExited.addOnce((scope) => {\n      assert(scope === this._editingScope);\n      this._editingScope = undefined;\n      removeGeomListener();\n      this.processBuffered();\n    });\n\n    return this._editingScope;\n  }\n\n  private processBuffered(): void {\n    const models = this._briefcase.models;\n    for (const [id, guid] of this._modelIdToGuid) {\n      const model = models.getLoaded(id)?.asGeometricModel;\n      if (model)\n        model.geometryGuid = guid;\n    }\n\n    const modelIds = new Set<string>(this._modelIdToGuid.keys());\n    for (const deleted of this._deletedModels) {\n      modelIds.add(deleted);\n      models.unload(deleted);\n    }\n\n    this.invalidateScenes(modelIds);\n    disposeTileTreesForGeometricModels(modelIds, this._briefcase);\n\n    this._briefcase.onBufferedModelChanges.raiseEvent(modelIds);\n\n    this._modelIdToGuid.clear();\n    this._deletedModels.clear();\n  }\n\n  private invalidateScenes(changedModels: Iterable<Id64String>): void {\n    for (const user of IModelApp.tileAdmin.tileUsers) {\n      if (user instanceof Viewport && user.iModel === this._briefcase) {\n        for (const modelId of changedModels) {\n          if (user.view.viewsModel(modelId)) {\n            user.invalidateScene();\n            user.setFeatureOverrideProviderChanged();\n            break;\n          }\n        }\n      }\n    }\n  }\n}\n\n/**\n * Provides access to lock information in the iModel.\n * @see [[BriefcaseConnection.locks]]\n * @alpha\n */\nexport interface LockService {\n  /** Get all elements with exclusive locks owned by other briefcases. */\n  getExclusiveForeignLocks(): Promise<Id64Set>;\n  /** Get all elements with shared locks owned by other briefcases. */\n  getSharedForeignLocks(): Promise<Id64Set>;\n  /** Check whether it's possible to acquire a lock for the element. */\n  checkElementLockAvailability(elementId: Id64String, lock: LockState): Promise<boolean>;\n}\n\n/** Function for creating a [[LockService]] for a [[BriefcaseConnection]].\n * @alpha\n */\nexport type LockServiceFactory = (iModel: BriefcaseConnection) => Promise<LockService>;\n\n/** Settings that can be used to control the behavior of [[Tool]]s that modify a [[BriefcaseConnection]].\n * For example, tools that want to create new elements can consult the briefcase's editor tool settings to\n * determine into which model and category to insert the elements.\n * Specialized tools are free to ignore these settings.\n * @see [[BriefcaseConnection.editorToolSettings]] to query or modify the current settings for a briefcase.\n * @see [CreateElementTool]($editor-frontend) for an example of a tool that uses these settings.\n * @beta\n */\nexport class BriefcaseEditorToolSettings {\n  private _category?: Id64String;\n  private _model?: Id64String;\n\n  /** An event raised just after the default [[category]] is changed. */\n  public readonly onCategoryChanged = new BeEvent<(previousCategory: Id64String | undefined) => void>();\n\n  /** An event raised just after the default [[model]] is changed. */\n  public readonly onModelChanged = new BeEvent<(previousModel: Id64String | undefined) => void>();\n\n  /** The [Category]($backend) into which new elements should be inserted by default.\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate category.\n   * @see [[onCategoryChanged]] to be notified when this property is modified.\n   * @see [CreateElementTool.targetCategory]($editor-frontend) for an example of a tool that uses this setting.\n   */\n  public get category(): Id64String | undefined {\n    return this._category;\n  }\n  public set category(category: Id64String | undefined) {\n    const previousCategory = this.category;\n    if (category !== this.category) {\n      this._category = category;\n      this.onCategoryChanged.raiseEvent(previousCategory);\n    }\n  }\n\n  /** The [Model]($backend) into which new elements should be inserted by default.\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate model.\n   * @see [[onModelChanged]] to be notified when this property is modified.\n   * @see [CreateElementTool.targetModelId]($editor-frontend) for an example of a tool that uses this setting.\n   */\n  public get model(): Id64String | undefined {\n    return this._model;\n  }\n  public set model(model: Id64String | undefined) {\n    const previousModel = this.model;\n    if (model !== this.model) {\n      this._model = model;\n      this.onModelChanged.raiseEvent(previousModel);\n    }\n  }\n}\n\n/** A connection to an editable briefcase on the backend. This class uses [Ipc]($docs/learning/IpcInterface.md) to communicate\n * to the backend and may only be used by [[IpcApp]]s.\n * @public\n */\nexport class BriefcaseConnection extends IModelConnection {\n  protected _isClosed?: boolean;\n  private readonly _modelsMonitor: ModelChangeMonitor;\n  private _locks?: LockService;\n\n  /** The ID of the briefcase.\n   * @beta\n   */\n  public readonly briefcaseId?: number;\n\n  /** Default settings that can be used to control the behavior of [[Tool]]s that modify this briefcase.\n   * @beta\n   */\n  public readonly editorToolSettings = new BriefcaseEditorToolSettings();\n\n  /** Manages local changes to the briefcase via [Txns]($docs/learning/InteractiveEditing.md). */\n  public readonly txns: BriefcaseTxns;\n\n  /** Information about locks held on this iModel.\n   * @note This is intended to be used by tools and other UI elements, to provide information about the current lock state. Implementations are expected to cache lock information and so may not reflect changes to locks immediately.\n   * @alpha\n   */\n  public get locks(): LockService | undefined { return this._locks; }\n\n  public override isBriefcaseConnection(): this is BriefcaseConnection { return true; }\n\n  /** The Guid that identifies the iTwin that owns this iModel. */\n  public override get iTwinId(): GuidString { return super.iTwinId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\n\n  /** The Guid that identifies this iModel. */\n  public override get iModelId(): GuidString { return super.iModelId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\n\n  protected constructor(props: BriefcaseConnectionProps, openMode: OpenMode) {\n    super(props);\n    this._openMode = openMode;\n    this.briefcaseId = props.briefcaseId;\n    this.txns = new BriefcaseTxns(this);\n    this._modelsMonitor = new ModelChangeMonitor(this);\n    if (OpenMode.ReadWrite === this._openMode)\n      this.txns.onAfterUndoRedo.addListener(async () => { await IModelApp.toolAdmin.restartPrimitiveTool(); });\n\n    this.categories.cache.attachToBriefcase(this);\n  }\n\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend). */\n  public static async openFile(briefcaseProps: OpenBriefcaseProps): Promise<BriefcaseConnection>;\n\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend).\n   * @alpha\n   */\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection>\n\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection> {\n    const iModelProps = await IpcApp.appFunctionIpc.openBriefcase(briefcaseProps);\n    const connection = new this({ ...briefcaseProps, ...iModelProps }, briefcaseProps.readonly ? OpenMode.Readonly : OpenMode.ReadWrite);\n    if (lockServiceFactory)\n      connection._locks = await lockServiceFactory(connection);\n\n    IModelConnection.onOpen.raiseEvent(connection);\n    return connection;\n  }\n\n  /** Open a BriefcaseConnection to a [StandaloneDb]($backend)\n   * @note StandaloneDbs, by definition, may not push or pull changes. Attempting to do so will throw exceptions.\n   */\n  public static async openStandalone(filePath: string, openMode: OpenMode = OpenMode.ReadWrite, opts?: StandaloneOpenOptions): Promise<BriefcaseConnection> {\n    const openResponse = await IpcApp.appFunctionIpc.openStandalone(filePath, openMode, opts);\n    const connection = new this(openResponse, openMode);\n    IModelConnection.onOpen.raiseEvent(connection);\n    return connection;\n  }\n\n  /** Returns `true` if [[close]] has already been called. */\n  public get isClosed(): boolean { return this._isClosed === true; }\n\n  /**\n   * Close this BriefcaseConnection.\n   * @note make sure to call [[saveChanges]] before calling this method. Unsaved local changes are abandoned.\n   */\n  public async close(): Promise<void> {\n    if (this.isClosed)\n      return;\n\n    await this._modelsMonitor.close();\n\n    this.beforeClose();\n    this.txns[Symbol.dispose]();\n\n    this._isClosed = true;\n    await IpcApp.appFunctionIpc.closeIModel(this._fileKey);\n  }\n\n  protected requireTimeline() {\n    if (this.iTwinId === Guid.empty)\n      throw new IModelError(IModelStatus.WrongIModel, \"iModel has no timeline\");\n  }\n\n  /** Query if there are any pending Txns in this briefcase that are waiting to be pushed. */\n  public async hasPendingTxns(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\n    return this.txns.hasPendingTxns();\n  }\n\n  /** Commit pending changes to this briefcase.\n   * @param description Optional description of the changes.\n   * @deprecated Use methods on EditCommand instead.\n   */\n  public async saveChanges(description?: string): Promise<void> {\n    await IpcApp.appFunctionIpc.saveChanges(this.key, description); // eslint-disable-line @typescript-eslint/no-deprecated\n  }\n\n  /** Abandon pending changes to this briefcase.\n   * @deprecated Use methods on EditCommand instead.\n   */\n  public async abandonChanges(): Promise<void> {\n    await IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated\n  }\n\n  /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase\n   * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.\n   * @param options Options for pulling changes.\n   * @see [[BriefcaseTxns.onChangesPulled]] for the event dispatched after changes are pulled.\n   */\n  public async pullChanges(toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<void> {\n    const removeListeners: VoidFunction[] = [];\n    const shouldReportProgress = !!options?.downloadProgressCallback;\n\n    if (shouldReportProgress) {\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\n        options?.downloadProgressCallback?.(data);\n      };\n\n      const removeProgressListener = IpcApp.addListener(\n        getPullChangesIpcChannel(this.iModelId),\n        handleProgress,\n      );\n      removeListeners.push(removeProgressListener);\n    }\n\n    if (options?.abortSignal) {\n      const abort = () => void IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key);\n      options?.abortSignal.addEventListener(\"abort\", abort);\n      removeListeners.push(() => options?.abortSignal?.removeEventListener(\"abort\", abort));\n    }\n\n    this.requireTimeline();\n    const ipcAppOptions: IpcAppPullChangesOptions = {\n      reportProgress: shouldReportProgress,\n      progressInterval: options?.progressInterval,\n      enableCancellation: !!options?.abortSignal,\n    };\n    try {\n      this.changeset = await IpcApp.appFunctionIpc.pullChanges(this.key, toIndex, ipcAppOptions);\n    } finally {\n      removeListeners.forEach((remove) => remove());\n    }\n  }\n\n  /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.\n   * @param description The description for the changeset\n   * @returns the changesetId of the pushed changes\n   * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.\n   */\n  public async pushChanges(description: string): Promise<ChangesetIndexAndId> {\n    this.requireTimeline();\n    return IpcApp.appFunctionIpc.pushChanges(this.key, description);\n  }\n\n  /** The current graphical editing scope, if one is in progress.\n   * @see [[enterEditingScope]] to begin graphical editing.\n   */\n  public get editingScope(): GraphicalEditingScope | undefined {\n    return this._modelsMonitor.editingScope;\n  }\n\n  /** Return whether graphical editing is supported for this briefcase. It is not supported if the briefcase is read-only, or the briefcase contains a version of\n   * the BisCore ECSchema older than v0.1.11.\n   * @see [[enterEditingScope]] to enable graphical editing.\n   */\n  public async supportsGraphicalEditing(): Promise<boolean> {\n    return IpcApp.appFunctionIpc.isGraphicalEditingSupported(this.key);\n  }\n\n  /** Begin a new graphical editing scope.\n   * @throws Error if an editing scope already exists or one could not be created.\n   * @see [[GraphicalEditingScope.exit]] to exit the scope.\n   * @see [[supportsGraphicalEditing]] to determine whether this method should be expected to succeed.\n   * @see [[editingScope]] to obtain the current editing scope, if one is in progress.\n   */\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\n    return this._modelsMonitor.enterEditingScope();\n  }\n\n  /** Strictly for tests - dispatched from ModelChangeMonitor.processBuffered.\n   * @internal\n   */\n  public readonly onBufferedModelChanges = new BeEvent<(changedModelIds: Set<string>) => void>();\n}\n"]}
+{"version":3,"file":"BriefcaseConnection.js","sourceRoot":"","sources":["../../src/BriefcaseConnection.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAmC,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxI,OAAO,EAC0D,wBAAwB,EAAE,WAAW,GAErG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,kCAAkC,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AA8CtC;;;GAGG;AACH,MAAM,kBAAkB;IACd,aAAa,CAAyB;IAC7B,UAAU,CAAsB;IAChC,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,SAAS,GAAmB,EAAE,CAAC;IAEhD,YAAmB,SAA8B;QAC/C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,iCAAiC;QACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YAChF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,8BAA8B;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACzE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,KAAK,MAAM,EAAE,IAAI,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7D,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,gHAAgH;QAChH,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,IAAI,CAAC,YAAY;gBACnB,OAAO;YAET,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBACrB,MAAM,SAAS,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAEtE,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,EAAE,CAAC;QAEZ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAE1B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,IAAI,CAAC,aAAa,GAAG,MAAM,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAExE,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;YACtF,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,MAAM,IAAI,OAAO;gBAC1B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAE3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5C,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,kBAAkB,EAAE,CAAC;YACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC;YACrD,IAAI,KAAK;gBACP,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChC,kCAAkC,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9D,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE5D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAEO,gBAAgB,CAAC,aAAmC;QAC1D,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACjD,IAAI,IAAI,YAAY,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChE,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;oBACpC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;wBAClC,IAAI,CAAC,eAAe,EAAE,CAAC;wBACvB,IAAI,CAAC,iCAAiC,EAAE,CAAC;wBACzC,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAqBD;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA2B;IAC9B,SAAS,CAAc;IACvB,MAAM,CAAc;IAE5B,sEAAsE;IACtD,iBAAiB,GAAG,IAAI,OAAO,EAAsD,CAAC;IAEtG,mEAAmE;IACnD,cAAc,GAAG,IAAI,OAAO,EAAmD,CAAC;IAEhG;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAW,QAAQ,CAAC,QAAgC;QAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAW,KAAK,CAAC,KAA6B;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;QACjC,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,gBAAgB;IAC7C,SAAS,CAAW;IACb,cAAc,CAAqB;IAC5C,MAAM,CAAe;IAE7B;;OAEG;IACa,WAAW,CAAU;IAErC;;OAEG;IACa,kBAAkB,GAAG,IAAI,2BAA2B,EAAE,CAAC;IAEvE,+FAA+F;IAC/E,IAAI,CAAgB;IAEpC;;;OAGG;IACH,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnD,qBAAqB,KAAkC,OAAO,IAAI,CAAC,CAAC,CAAC;IAErF,gEAAgE;IAChE,IAAoB,OAAO,KAAiB,OAAO,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAEtK,4CAA4C;IAC5C,IAAoB,QAAQ,KAAiB,OAAO,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,oFAAoF;IAExK,YAAsB,KAA+B,EAAE,QAAkB;QACvE,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACvC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3G,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAUM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAkC,EAAE,kBAAuC;QACtG,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC9E,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACrI,IAAI,kBAAkB;YACpB,UAAU,CAAC,MAAM,GAAG,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE3D,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,WAAqB,QAAQ,CAAC,SAAS,EAAE,IAA4B;QACxH,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpD,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,2DAA2D;IAC3D,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IAElE;;;OAGG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO;QAET,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAES,eAAe;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK;YAC7B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;IAC9E,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,cAAc;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,WAAoB;QAC3C,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,uDAAuD;IACzH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,uDAAuD;IAC/G,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,OAA4B;QAC7E,MAAM,eAAe,GAAmB,EAAE,CAAC;QAC3C,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,EAAE,wBAAwB,CAAC;QAEjE,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,cAAc,GAAG,CAAC,IAAW,EAAE,IAAuC,EAAE,EAAE;gBAC9E,OAAO,EAAE,wBAAwB,EAAE,CAAC,IAAI,CAAC,CAAC;YAC5C,CAAC,CAAC;YAEF,MAAM,sBAAsB,GAAG,MAAM,CAAC,WAAW,CAC/C,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,EACvC,cAAc,CACf,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClF,OAAO,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACtD,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,aAAa,GAA6B;YAC9C,cAAc,EAAE,oBAAoB;YACpC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;YAC3C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW;SAC3C,CAAC;QACF,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC7F,CAAC;gBAAS,CAAC;YACT,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,WAAmB;QAC1C,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB;QAC5B,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,sBAAsB,GAAG,IAAI,OAAO,EAA0C,CAAC;CAChG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module IModelConnection\n */\n\nimport { assert, BeEvent, CompressedId64Set, Guid, GuidString, Id64Set, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseConnectionProps, ChangesetIndex, ChangesetIndexAndId, getPullChangesIpcChannel, IModelError,\n  PullChangesOptions as IpcAppPullChangesOptions, LockState, OpenBriefcaseProps, StandaloneOpenOptions,\n} from \"@itwin/core-common\";\nimport { BriefcaseTxns } from \"./BriefcaseTxns\";\nimport { GraphicalEditingScope } from \"./GraphicalEditingScope\";\nimport { IModelApp } from \"./IModelApp\";\nimport { IModelConnection } from \"./IModelConnection\";\nimport { IpcApp } from \"./IpcApp\";\nimport { disposeTileTreesForGeometricModels } from \"./tile/internal\";\nimport { Viewport } from \"./Viewport\";\n\n/**\n * Download progress information.\n * @public\n */\nexport interface DownloadProgressInfo {\n  /** Bytes downloaded. */\n  loaded: number;\n  /** Total size of the download in bytes. */\n  total: number;\n}\n\n/**\n * Called to show progress during a download.\n * @public\n */\nexport type OnDownloadProgress = (progress: DownloadProgressInfo) => void;\n\n/**\n * Partial interface of AbortSignal.\n * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal\n * @beta\n */\nexport interface GenericAbortSignal {\n  /** Add Listener for abort signal. */\n  addEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\n  /** Remove Listener for abort signal. */\n  removeEventListener: (type: \"abort\", listener: (this: GenericAbortSignal, ev: any) => any) => void;\n}\n\n/**\n * Options for pulling iModel changes.\n * @public\n */\nexport interface PullChangesOptions {\n  /** Function called regularly to report progress of changes download. */\n  downloadProgressCallback?: OnDownloadProgress;\n  /** Interval for calling progress callback (in milliseconds). */\n  progressInterval?: number;\n  /** Signal for cancelling the download.\n   * @beta\n   */\n  abortSignal?: GenericAbortSignal;\n}\n\n/** Keeps track of changes to models, buffering them until synchronization points.\n * While a GraphicalEditingScope is open, the changes are buffered until the scope exits, at which point they are processed.\n * Otherwise, the buffered changes are processed after undo/redo, commit, or pull+merge changes.\n */\nclass ModelChangeMonitor {\n  private _editingScope?: GraphicalEditingScope;\n  private readonly _briefcase: BriefcaseConnection;\n  private readonly _deletedModels = new Set<string>();\n  private readonly _modelIdToGuid = new Map<string, string>();\n  private readonly _removals: VoidFunction[] = [];\n\n  public constructor(briefcase: BriefcaseConnection) {\n    this._briefcase = briefcase;\n\n    // Buffer updated geometry guids.\n    this._removals.push(briefcase.txns.onModelGeometryChanged.addListener((changes) => {\n      for (const change of changes) {\n        this._deletedModels.delete(change.id);\n        this._modelIdToGuid.set(change.id, change.guid);\n      }\n    }));\n\n    // Buffer deletions of models.\n    this._removals.push(briefcase.txns.onModelsChanged.addListener((changes) => {\n      if (changes.deleted) {\n        for (const id of CompressedId64Set.iterable(changes.deleted)) {\n          this._modelIdToGuid.delete(id);\n          this._deletedModels.add(id);\n        }\n      }\n    }));\n\n    // Outside of an editing scope, we want to update viewport contents after commit, undo/redo, or merging changes.\n    const maybeProcess = async () => {\n      if (this.editingScope)\n        return;\n\n      const modelIds = Array.from(this._modelIdToGuid.keys());\n      if (modelIds.length > 0)\n        await IModelApp.tileAdmin.purgeTileTrees(this._briefcase, modelIds);\n\n      this.processBuffered();\n    };\n\n    this._removals.push(briefcase.txns.onCommitted.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onReplayedExternalTxns.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onAfterUndoRedo.addListener(maybeProcess));\n    this._removals.push(briefcase.txns.onChangesPulled.addListener(maybeProcess));\n  }\n\n  public async close(): Promise<void> {\n    for (const removal of this._removals)\n      removal();\n\n    this._removals.length = 0;\n\n    if (this._editingScope) {\n      await this._editingScope.exit();\n      this._editingScope = undefined;\n    }\n  }\n\n  public get editingScope(): GraphicalEditingScope | undefined {\n    return this._editingScope;\n  }\n\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\n    if (this._editingScope)\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\n\n    this._editingScope = await GraphicalEditingScope.enter(this._briefcase);\n\n    const removeGeomListener = this._editingScope.onGeometryChanges.addListener((changes) => {\n      const modelIds = [];\n      for (const change of changes)\n        modelIds.push(change.id);\n\n      this.invalidateScenes(modelIds);\n    });\n\n    this._editingScope.onExited.addOnce((scope) => {\n      assert(scope === this._editingScope);\n      this._editingScope = undefined;\n      removeGeomListener();\n      this.processBuffered();\n    });\n\n    return this._editingScope;\n  }\n\n  private processBuffered(): void {\n    const models = this._briefcase.models;\n    for (const [id, guid] of this._modelIdToGuid) {\n      const model = models.getLoaded(id)?.asGeometricModel;\n      if (model)\n        model.geometryGuid = guid;\n    }\n\n    const modelIds = new Set<string>(this._modelIdToGuid.keys());\n    for (const deleted of this._deletedModels) {\n      modelIds.add(deleted);\n      models.unload(deleted);\n    }\n\n    this.invalidateScenes(modelIds);\n    disposeTileTreesForGeometricModels(modelIds, this._briefcase);\n\n    this._briefcase.onBufferedModelChanges.raiseEvent(modelIds);\n\n    this._modelIdToGuid.clear();\n    this._deletedModels.clear();\n  }\n\n  private invalidateScenes(changedModels: Iterable<Id64String>): void {\n    for (const user of IModelApp.tileAdmin.tileUsers) {\n      if (user instanceof Viewport && user.iModel === this._briefcase) {\n        for (const modelId of changedModels) {\n          if (user.view.viewsModel(modelId)) {\n            user.invalidateScene();\n            user.setFeatureOverrideProviderChanged();\n            break;\n          }\n        }\n      }\n    }\n  }\n}\n\n/**\n * Provides access to lock information in the iModel.\n * @see [[BriefcaseConnection.locks]]\n * @alpha\n */\nexport interface LockService {\n  /** Get all elements with exclusive locks owned by other briefcases. */\n  getExclusiveForeignLocks(): Promise<Id64Set>;\n  /** Get all elements with shared locks owned by other briefcases. */\n  getSharedForeignLocks(): Promise<Id64Set>;\n  /** Check whether it's possible to acquire a lock for the element. */\n  checkElementLockAvailability(elementId: Id64String, lock: LockState): Promise<boolean>;\n}\n\n/** Function for creating a [[LockService]] for a [[BriefcaseConnection]].\n * @alpha\n */\nexport type LockServiceFactory = (iModel: BriefcaseConnection) => Promise<LockService>;\n\n/** Settings that can be used to control the behavior of [[Tool]]s that modify a [[BriefcaseConnection]].\n * For example, tools that want to create new elements can consult the briefcase's editor tool settings to\n * determine into which model and category to insert the elements.\n * Specialized tools are free to ignore these settings.\n * @see [[BriefcaseConnection.editorToolSettings]] to query or modify the current settings for a briefcase.\n * @see [CreateElementTool]($editor-frontend) for an example of a tool that uses these settings.\n * @beta\n */\nexport class BriefcaseEditorToolSettings {\n  private _category?: Id64String;\n  private _model?: Id64String;\n\n  /** An event raised just after the default [[category]] is changed. */\n  public readonly onCategoryChanged = new BeEvent<(previousCategory: Id64String | undefined) => void>();\n\n  /** An event raised just after the default [[model]] is changed. */\n  public readonly onModelChanged = new BeEvent<(previousModel: Id64String | undefined) => void>();\n\n  /** The [Category]($backend) into which new elements should be inserted by default.\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate category.\n   * @see [[onCategoryChanged]] to be notified when this property is modified.\n   * @see [CreateElementTool.targetCategory]($editor-frontend) for an example of a tool that uses this setting.\n   */\n  public get category(): Id64String | undefined {\n    return this._category;\n  }\n  public set category(category: Id64String | undefined) {\n    const previousCategory = this.category;\n    if (category !== this.category) {\n      this._category = category;\n      this.onCategoryChanged.raiseEvent(previousCategory);\n    }\n  }\n\n  /** The [Model]($backend) into which new elements should be inserted by default.\n   * Specialized tools are free to ignore this setting and instead use their own logic to select an appropriate model.\n   * @see [[onModelChanged]] to be notified when this property is modified.\n   * @see [CreateElementTool.targetModelId]($editor-frontend) for an example of a tool that uses this setting.\n   */\n  public get model(): Id64String | undefined {\n    return this._model;\n  }\n  public set model(model: Id64String | undefined) {\n    const previousModel = this.model;\n    if (model !== this.model) {\n      this._model = model;\n      this.onModelChanged.raiseEvent(previousModel);\n    }\n  }\n}\n\n/** A connection to an editable briefcase on the backend. This class uses [Ipc]($docs/learning/IpcInterface.md) to communicate\n * to the backend and may only be used by [[IpcApp]]s.\n * @public\n */\nexport class BriefcaseConnection extends IModelConnection {\n  protected _isClosed?: boolean;\n  private readonly _modelsMonitor: ModelChangeMonitor;\n  private _locks?: LockService;\n\n  /** The ID of the briefcase.\n   * @beta\n   */\n  public readonly briefcaseId?: number;\n\n  /** Default settings that can be used to control the behavior of [[Tool]]s that modify this briefcase.\n   * @beta\n   */\n  public readonly editorToolSettings = new BriefcaseEditorToolSettings();\n\n  /** Manages local changes to the briefcase via [Txns]($docs/learning/InteractiveEditing.md). */\n  public readonly txns: BriefcaseTxns;\n\n  /** Information about locks held on this iModel.\n   * @note This is intended to be used by tools and other UI elements, to provide information about the current lock state. Implementations are expected to cache lock information and so may not reflect changes to locks immediately.\n   * @alpha\n   */\n  public get locks(): LockService | undefined { return this._locks; }\n\n  public override isBriefcaseConnection(): this is BriefcaseConnection { return true; }\n\n  /** The Guid that identifies the iTwin that owns this iModel. */\n  public override get iTwinId(): GuidString { return super.iTwinId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\n\n  /** The Guid that identifies this iModel. */\n  public override get iModelId(): GuidString { return super.iModelId ?? Guid.empty; } // GuidString | undefined for IModelConnection, but required for BriefcaseConnection\n\n  protected constructor(props: BriefcaseConnectionProps, openMode: OpenMode) {\n    super(props);\n    this._openMode = openMode;\n    this.briefcaseId = props.briefcaseId;\n    this.txns = new BriefcaseTxns(this);\n    this._modelsMonitor = new ModelChangeMonitor(this);\n    if (OpenMode.ReadWrite === this._openMode)\n      this.txns.onAfterUndoRedo.addListener(async () => { await IModelApp.toolAdmin.restartPrimitiveTool(); });\n\n    this.categories.cache.attachToBriefcase(this);\n  }\n\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend). */\n  public static async openFile(briefcaseProps: OpenBriefcaseProps): Promise<BriefcaseConnection>;\n\n  /** Open a BriefcaseConnection to a [BriefcaseDb]($backend).\n   * @alpha\n   */\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection>\n\n  public static async openFile(briefcaseProps: OpenBriefcaseProps, lockServiceFactory?: LockServiceFactory): Promise<BriefcaseConnection> {\n    const iModelProps = await IpcApp.appFunctionIpc.openBriefcase(briefcaseProps);\n    const connection = new this({ ...briefcaseProps, ...iModelProps }, briefcaseProps.readonly ? OpenMode.Readonly : OpenMode.ReadWrite);\n    if (lockServiceFactory)\n      connection._locks = await lockServiceFactory(connection);\n\n    IModelConnection.onOpen.raiseEvent(connection);\n    return connection;\n  }\n\n  /** Open a BriefcaseConnection to a [StandaloneDb]($backend)\n   * @note StandaloneDbs, by definition, may not push or pull changes. Attempting to do so will throw exceptions.\n   */\n  public static async openStandalone(filePath: string, openMode: OpenMode = OpenMode.ReadWrite, opts?: StandaloneOpenOptions): Promise<BriefcaseConnection> {\n    const openResponse = await IpcApp.appFunctionIpc.openStandalone(filePath, openMode, opts);\n    const connection = new this(openResponse, openMode);\n    IModelConnection.onOpen.raiseEvent(connection);\n    return connection;\n  }\n\n  /** Returns `true` if [[close]] has already been called. */\n  public get isClosed(): boolean { return this._isClosed === true; }\n\n  /**\n   * Close this BriefcaseConnection.\n   * @note make sure to call [[saveChanges]] before calling this method. Unsaved local changes are abandoned.\n   */\n  public async close(): Promise<void> {\n    if (this.isClosed)\n      return;\n\n    await this._modelsMonitor.close();\n\n    this.beforeClose();\n    this.txns[Symbol.dispose]();\n\n    this._isClosed = true;\n    await IpcApp.appFunctionIpc.closeIModel(this._fileKey);\n  }\n\n  protected requireTimeline() {\n    if (this.iTwinId === Guid.empty)\n      throw new IModelError(IModelStatus.WrongIModel, \"iModel has no timeline\");\n  }\n\n  /** Query if there are any pending Txns in this briefcase that are waiting to be pushed. */\n  public async hasPendingTxns(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\n    return this.txns.hasPendingTxns();\n  }\n\n  /** Commit pending changes to this briefcase.\n   * @param description Optional description of the changes.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\n   */\n  public async saveChanges(description?: string): Promise<void> {\n    await IpcApp.appFunctionIpc.saveChanges(this.key, description); // eslint-disable-line @typescript-eslint/no-deprecated\n  }\n\n  /** Abandon pending changes to this briefcase.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use methods on EditCommand instead.\n   */\n  public async abandonChanges(): Promise<void> {\n    await IpcApp.appFunctionIpc.abandonChanges(this.key); // eslint-disable-line @typescript-eslint/no-deprecated\n  }\n\n  /** Pull (and potentially merge if there are local changes) up to a specified changeset from iModelHub into this briefcase\n   * @param toIndex The changeset index to pull changes to. If `undefined`, pull all changes.\n   * @param options Options for pulling changes.\n   * @see [[BriefcaseTxns.onChangesPulled]] for the event dispatched after changes are pulled.\n   */\n  public async pullChanges(toIndex?: ChangesetIndex, options?: PullChangesOptions): Promise<void> {\n    const removeListeners: VoidFunction[] = [];\n    const shouldReportProgress = !!options?.downloadProgressCallback;\n\n    if (shouldReportProgress) {\n      const handleProgress = (_evt: Event, data: { loaded: number, total: number }) => {\n        options?.downloadProgressCallback?.(data);\n      };\n\n      const removeProgressListener = IpcApp.addListener(\n        getPullChangesIpcChannel(this.iModelId),\n        handleProgress,\n      );\n      removeListeners.push(removeProgressListener);\n    }\n\n    if (options?.abortSignal) {\n      const abort = () => void IpcApp.appFunctionIpc.cancelPullChangesRequest(this.key);\n      options?.abortSignal.addEventListener(\"abort\", abort);\n      removeListeners.push(() => options?.abortSignal?.removeEventListener(\"abort\", abort));\n    }\n\n    this.requireTimeline();\n    const ipcAppOptions: IpcAppPullChangesOptions = {\n      reportProgress: shouldReportProgress,\n      progressInterval: options?.progressInterval,\n      enableCancellation: !!options?.abortSignal,\n    };\n    try {\n      this.changeset = await IpcApp.appFunctionIpc.pullChanges(this.key, toIndex, ipcAppOptions);\n    } finally {\n      removeListeners.forEach((remove) => remove());\n    }\n  }\n\n  /** Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.\n   * @param description The description for the changeset\n   * @returns the changesetId of the pushed changes\n   * @see [[BriefcaseTxns.onChangesPushed]] for the event dispatched after changes are pushed.\n   */\n  public async pushChanges(description: string): Promise<ChangesetIndexAndId> {\n    this.requireTimeline();\n    return IpcApp.appFunctionIpc.pushChanges(this.key, description);\n  }\n\n  /** The current graphical editing scope, if one is in progress.\n   * @see [[enterEditingScope]] to begin graphical editing.\n   */\n  public get editingScope(): GraphicalEditingScope | undefined {\n    return this._modelsMonitor.editingScope;\n  }\n\n  /** Return whether graphical editing is supported for this briefcase. It is not supported if the briefcase is read-only, or the briefcase contains a version of\n   * the BisCore ECSchema older than v0.1.11.\n   * @see [[enterEditingScope]] to enable graphical editing.\n   */\n  public async supportsGraphicalEditing(): Promise<boolean> {\n    return IpcApp.appFunctionIpc.isGraphicalEditingSupported(this.key);\n  }\n\n  /** Begin a new graphical editing scope.\n   * @throws Error if an editing scope already exists or one could not be created.\n   * @see [[GraphicalEditingScope.exit]] to exit the scope.\n   * @see [[supportsGraphicalEditing]] to determine whether this method should be expected to succeed.\n   * @see [[editingScope]] to obtain the current editing scope, if one is in progress.\n   */\n  public async enterEditingScope(): Promise<GraphicalEditingScope> {\n    return this._modelsMonitor.enterEditingScope();\n  }\n\n  /** Strictly for tests - dispatched from ModelChangeMonitor.processBuffered.\n   * @internal\n   */\n  public readonly onBufferedModelChanges = new BeEvent<(changedModelIds: Set<string>) => void>();\n}\n"]}

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,oBAAoB,CAAC;AACtD,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;;WAEG;QACH,YAAY,CAAC,0BAA0B,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5F,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;;;MAGE;IACF,UAAiB,KAAK;QACpB,wDAAwD;QACxD,OAAO,EAAE,MAAM,CAAC;QAChB,uGAAuG;QACvG,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,gEAAgE;QAChE,WAAW,EAAE,0BAA0B,CAAC,QAAQ,CAAC;KAClD;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,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,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;;WAEG;QACH,YAAY,CAAC,0BAA0B,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5F,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;;;MAGE;IACF,UAAiB,KAAK;QACpB,wDAAwD;QACxD,OAAO,EAAE,MAAM,CAAC;QAChB,uGAAuG;QACvG,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,gEAAgE;QAChE,WAAW,EAAE,0BAA0B,CAAC,QAAQ,CAAC;KAClD;IAED,SAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,0BAA0B,CAAC,SAAS,CAExF;CACF"}

package/lib/esm/PerModelCategoryVisibility.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module Views
  */
-import { compareStrings, Id64, SortedArray } from "@itwin/core-bentley";
+import { Id64 } from "@itwin/core-bentley";
 /** Per-model category visibility permits the visibility of categories within a [[Viewport]] displaying a [[SpatialViewState]] to be overridden in
  * the context of individual [[GeometricModelState]]s.
  * 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]].
@@ -32,41 +32,77 @@ export var PerModelCategoryVisibility;
     }
     PerModelCategoryVisibility.createOverrides = createOverrides;
 })(PerModelCategoryVisibility || (PerModelCategoryVisibility = {}));
-class PerModelCategoryVisibilityOverride {
-    modelId;
-    categoryId;
-    visible;
-    constructor(modelId, categoryId, visible) {
-        this.modelId = modelId;
-        this.categoryId = categoryId;
-        this.visible = visible;
-    }
-    reset(modelId, categoryId, visible) {
-        this.modelId = modelId;
-        this.categoryId = categoryId;
-        this.visible = visible;
-    }
-}
-function compareCategoryOverrides(lhs, rhs) {
-    const cmp = compareStrings(lhs.modelId, rhs.modelId);
-    return 0 === cmp ? compareStrings(lhs.categoryId, rhs.categoryId) : cmp;
-}
 /** The Viewport-specific implementation of PerModelCategoryVisibility.Overrides. */
-class PerModelCategoryVisibilityOverrides extends SortedArray {
-    _scratch = new PerModelCategoryVisibilityOverride("0", "0", false);
+class PerModelCategoryVisibilityOverrides {
+    _map = new Map();
+    /** Flat set of all override entries, providing O(1) iteration via [Symbol.iterator]. Kept in sync with `_map`. */
+    _set = new Set();
     _vp;
     constructor(vp) {
-        super(compareCategoryOverrides);
         this._vp = vp;
     }
+    [Symbol.iterator]() {
+        return this._set[Symbol.iterator]();
+    }
     getOverride(modelId, categoryId) {
-        this._scratch.reset(modelId, categoryId, false);
-        const ovr = this.findEqual(this._scratch);
+        const ovr = this._map.get(modelId)?.get(categoryId);
         if (undefined !== ovr)
             return ovr.visible ? PerModelCategoryVisibility.Override.Show : PerModelCategoryVisibility.Override.Hide;
         else
             return PerModelCategoryVisibility.Override.None;
     }
+    getModelEntry({ modelId, override }) {
+        let modelEntry = this._map.get(modelId);
+        if (modelEntry) {
+            return modelEntry;
+        }
+        if (override === PerModelCategoryVisibility.Override.None) {
+            return undefined;
+        }
+        modelEntry = new Map();
+        this._map.set(modelId, modelEntry);
+        return modelEntry;
+    }
+    addOrRemoveOverrideEntry({ modelEntry, categoryId, modelId, override }) {
+        const overrideEntry = modelEntry.get(categoryId);
+        if (override === PerModelCategoryVisibility.Override.None) {
+            if (overrideEntry === undefined) {
+                return false;
+            }
+            this._set.delete(overrideEntry);
+            modelEntry.delete(categoryId);
+            return true;
+        }
+        const visible = override === PerModelCategoryVisibility.Override.Show;
+        if (overrideEntry === undefined) {
+            const ovr = { modelId, categoryId, visible };
+            modelEntry.set(categoryId, ovr);
+            this._set.add(ovr);
+            return true;
+        }
+        if (overrideEntry.visible !== visible) {
+            overrideEntry.visible = visible;
+            return true;
+        }
+        return false;
+    }
+    applyOverride(modelId, categoryIds, override, catIdsToLoad) {
+        const modelEntry = this.getModelEntry({ modelId, override });
+        let changed = false;
+        if (!modelEntry)
+            return changed;
+        for (const categoryId of categoryIds) {
+            if (this.addOrRemoveOverrideEntry({ modelEntry, categoryId, modelId, override })) {
+                changed = true;
+                if (catIdsToLoad && override !== PerModelCategoryVisibility.Override.None)
+                    catIdsToLoad.push(categoryId);
+            }
+        }
+        if (modelEntry.size === 0) {
+            this._map.delete(modelId);
+        }
+        return changed;
+    }
     /**
      * set the overrides for multiple perModelCategoryVisibility props, loading categoryIds from the iModel if necessary.
      * @see [[PerModelCategoryVisibility]]
@@ -81,19 +117,11 @@ class PerModelCategoryVisibilityOverrides extends SortedArray {
         const catIdsToLoad = [];
         const iModelToUse = iModel ? iModel : this._vp.iModel;
         for (const override of perModelCategoryVisibility) {
-            const modelId = override.modelId;
             // The caller may pass a single categoryId as a string, if we don't convert this to an array we will iterate
             // over each individual character of that string, which is not the desired behavior.
             const categoryIds = typeof override.categoryIds === "string" ? [override.categoryIds] : override.categoryIds;
-            const visOverride = override.visOverride;
-            for (const categoryId of categoryIds) {
-                if (this.findAndUpdateOverrideInArray(modelId, categoryId, visOverride)) {
-                    anyChanged = true;
-                    if (PerModelCategoryVisibility.Override.None !== visOverride) {
-                        catIdsToLoad.push(categoryId);
-                    }
-                }
-            }
+            if (this.applyOverride(override.modelId, categoryIds, override.visOverride, catIdsToLoad))
+                anyChanged = true;
         }
         if (anyChanged) {
             this._vp.setViewedCategoriesPerModelChanged();
@@ -101,44 +129,17 @@ class PerModelCategoryVisibilityOverrides extends SortedArray {
                 this._vp.subcategories.push(iModelToUse.subcategories, catIdsToLoad, () => this._vp.setViewedCategoriesPerModelChanged());
             }
         }
-        return;
-    }
-    /** Find and update the override in the array of overrides. If override not found, adds it to the array.
-     *  If the array was changed, returns true. */
-    findAndUpdateOverrideInArray(modelId, categoryId, override) {
-        const ovr = this._scratch;
-        ovr.reset(modelId, categoryId, false);
-        let changed = false;
-        const index = this.indexOf(ovr);
-        if (-1 === index) {
-            if (PerModelCategoryVisibility.Override.None !== override) {
-                this.insert(new PerModelCategoryVisibilityOverride(modelId, categoryId, PerModelCategoryVisibility.Override.Show === override));
-                changed = true;
-            }
-        }
-        else {
-            if (PerModelCategoryVisibility.Override.None === override) {
-                this._array.splice(index, 1);
-                changed = true;
-            }
-            else if (this._array[index].visible !== (PerModelCategoryVisibility.Override.Show === override)) {
-                this._array[index].visible = (PerModelCategoryVisibility.Override.Show === override);
-                changed = true;
-            }
-        }
-        return changed;
     }
     setOverride(modelIds, categoryIds, override) {
+        const categoryIdIterable = Id64.iterable(categoryIds);
         let changed = false;
         for (const modelId of Id64.iterable(modelIds)) {
-            for (const categoryId of Id64.iterable(categoryIds)) {
-                if (this.findAndUpdateOverrideInArray(modelId, categoryId, override))
-                    changed = true;
-            }
+            if (this.applyOverride(modelId, categoryIdIterable, override))
+                changed = true;
         }
         if (changed) {
             this._vp.setViewedCategoriesPerModelChanged();
-            if (PerModelCategoryVisibility.Override.None !== override) {
+            if (override !== PerModelCategoryVisibility.Override.None) {
                 // Ensure subcategories loaded.
                 this._vp.subcategories.push(this._vp.iModel.subcategories, categoryIds, () => this._vp.setViewedCategoriesPerModelChanged());
             }
@@ -146,30 +147,32 @@ class PerModelCategoryVisibilityOverrides extends SortedArray {
     }
     clearOverrides(modelIds) {
         if (undefined === modelIds) {
-            if (0 < this.length) {
-                this.clear();
+            if (this._map.size > 0) {
+                this._map.clear();
+                this._set.clear();
                 this._vp.setViewedCategoriesPerModelChanged();
             }
             return;
         }
-        for (let i = 0; i < this.length;) {
-            const ovr = this._array[i];
-            let removed = false;
-            for (const modelId of Id64.iterable(modelIds)) {
-                if (modelId === ovr.modelId) {
-                    this._array.splice(i, 1);
-                    this._vp.setViewedCategoriesPerModelChanged();
-                    removed = true;
-                    break;
-                }
+        let changed = false;
+        for (const modelId of Id64.iterable(modelIds)) {
+            const modelEntry = this._map.get(modelId);
+            if (!modelEntry) {
+                continue;
+            }
+            changed = true;
+            for (const overrideEntry of modelEntry.values()) {
+                this._set.delete(overrideEntry);
             }
-            if (!removed)
-                ++i;
+            this._map.delete(modelId);
+        }
+        if (changed) {
+            this._vp.setViewedCategoriesPerModelChanged();
         }
     }
     addOverrides(fs, ovrs) {
         const cache = this._vp.iModel.subcategories;
-        for (const ovr of this._array) {
+        for (const ovr of this._set) {
             const subcats = cache.getSubCategories(ovr.categoryId);
             if (undefined === subcats)
                 continue;
@@ -179,7 +182,6 @@ class PerModelCategoryVisibilityOverrides extends SortedArray {
             /* if (!this._vp.view.viewsModel(ovr.modelId))
               continue; */
             // ###TODO: Avoid recomputing upper and lower portions of modelId if modelId repeated.
-            // (Array is sorted first by modelId).
             // Also avoid computing if no effective overrides.
             const modelLo = Id64.getLowerUint32(ovr.modelId);
             const modelHi = Id64.getUpperUint32(ovr.modelId);

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;AAK7F;;;;;;;;GAQG;AACH,MAAM,KAAW,0BAA0B,CAyD1C;AAzDD,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;IA6CD,SAAgB,eAAe,CAAC,QAAkB;QAChD,OAAO,IAAI,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAFe,0CAAe,kBAE9B,CAAA;AACH,CAAC,EAzDgB,0BAA0B,KAA1B,0BAA0B,QAyD1C;AAED,MAAM,kCAAkC;IAC/B,OAAO,CAAa;IACpB,UAAU,CAAa;IACvB,OAAO,CAAU;IAExB,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;IAC9E,QAAQ,GAAG,IAAI,kCAAkC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACnE,GAAG,CAAW;IAE/B,YAAmB,EAAY;QAC7B,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChC,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;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,0BAA8D,EAAE,MAAyB;QACjH,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QACtD,KAAK,MAAM,QAAQ,IAAI,0BAA0B,EAAE,CAAC;YAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YACjC,4GAA4G;YAC5G,oFAAoF;YACpF,MAAM,WAAW,GAAG,OAAO,QAAQ,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC7G,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;gBACrC,IAAI,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,CAAC;oBACxE,UAAU,GAAG,IAAI,CAAC;oBAClB,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAC9C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC,CAAC;YAC5H,CAAC;QACH,CAAC;QACD,OAAO;IACT,CAAC;IAED;kDAC8C;IACtC,4BAA4B,CAAC,OAAmB,EAAE,UAAsB,EAAE,QAA6C;QAC7H,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1B,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACjB,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1D,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,OAAO,EAAE,UAAU,EAAE,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;gBAChI,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAC7B,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;iBAAM,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,KAAK,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;gBAClG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;gBACrF,OAAO,GAAG,IAAI,CAAC;YACjB,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,WAAW,CAAC,QAAiB,EAAE,WAAoB,EAAE,QAA6C;QACvG,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBACpD,IAAI,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC;oBAClE,OAAO,GAAG,IAAI,CAAC;YACnB,CAAC;QACH,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAE9C,IAAI,0BAA0B,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1D,+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;YAC/H,CAAC;QACH,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,QAAkB;QACtC,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;gBACpB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAChD,CAAC;YAED,OAAO;QACT,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC;YACjC,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,CAAC;gBAC9C,IAAI,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;oBAC5B,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;gBACR,CAAC;YACH,CAAC;YAED,IAAI,CAAC,OAAO;gBACV,EAAE,CAAC,CAAC;QACR,CAAC;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,CAAC;YAC9B,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,CAAC;gBAC7B,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,CAAC;oBACxB,oEAAoE;oBACpE,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACvC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;wBACxB,KAAK,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;oBACpC,CAAC;oBAED,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { compareStrings, Id64, Id64Arg, Id64String, SortedArray } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"./IModelConnection\";\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\nimport { Viewport } from \"./Viewport\";\n\n/** Per-model category visibility permits the visibility of categories within a [[Viewport]] displaying a [[SpatialViewState]] to be overridden in\n * the context of individual [[GeometricModelState]]s.\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]].\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\n * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].\n * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.\n * @public\n * @extensions\n */\nexport namespace PerModelCategoryVisibility {\n  /** Describes whether and how a category's visibility is overridden. */\n  export enum Override {\n    /** The category's visibility is not overridden; its visibility is wholly controlled by the [[Viewport]]'s [[CategorySelectorState]]. */\n    None,\n    /** The category is overridden to be visible. */\n    Show,\n    /** The category is overridden to be invisible. */\n    Hide,\n  }\n\n  /** Describes one visibility override in a [[PerModelCategoryVisibility.Overrides]]. */\n  export interface OverrideEntry {\n    /** The Id of the [[GeometricModelState]] in which the override applies. */\n    readonly modelId: Id64String;\n    /** The Id of the [SpatialCategory]($backend) whose visibility is overridden. */\n    readonly categoryId: Id64String;\n    /** Whether the category is visible in the context of the model. */\n    readonly visible: boolean;\n  }\n\n  /** Describes a set of per-model category visibility overrides. Changes to these overrides invoke the [[Viewport.onViewedCategoriesPerModelChanged]] event.\n   * @see [[Viewport.perModelCategoryVisibility]].\n   */\n  export interface Overrides {\n    /** Returns the override state of the specified category within the specified model. */\n    getOverride(modelId: Id64String, categoryId: Id64String): Override;\n    /** Changes the override state of one or more categories for one or more models. */\n    setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: Override): void;\n    /** Changes multiple overrides, given an array of overrides *\n     * @beta\n     */\n    setOverrides(perModelCategoryVisibility: Props[], iModel?: IModelConnection): Promise<void>;\n    /** Removes all overrides for the specified models, or for all models if `modelIds` is undefined. */\n    clearOverrides(modelIds?: Id64Arg): void;\n    /** An iterator over all of the visibility overrides. */\n    [Symbol.iterator]: () => Iterator<OverrideEntry>;\n    /** Populate the symbology overrides based on the per-model category visibility. */\n    addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void;\n  }\n\n  /** Describes a set of [[PerModelCategoryVisibility.Overrides]].\n   * @see [[PerModelCategoryVisibility.Overrides.setOverrides]].\n   * @beta\n  */\n  export interface Props {\n    /** The id of the model to which the overrides apply. */\n    modelId: string;\n    /** The ids of the categories whose visibility are to be overridden within the context of the model. */\n    categoryIds: Iterable<Id64String>;\n    /** The visibility to be applied to the specified categories. */\n    visOverride: PerModelCategoryVisibility.Override;\n  }\n\n  export function createOverrides(viewport: Viewport): PerModelCategoryVisibility.Overrides {\n    return new PerModelCategoryVisibilityOverrides(viewport);\n  }\n}\n\nclass PerModelCategoryVisibilityOverride {\n  public modelId: Id64String;\n  public categoryId: Id64String;\n  public visible: boolean;\n\n  public constructor(modelId: Id64String, categoryId: Id64String, visible: boolean) {\n    this.modelId = modelId;\n    this.categoryId = categoryId;\n    this.visible = visible;\n  }\n\n  public reset(modelId: Id64String, categoryId: Id64String, visible: boolean): void {\n    this.modelId = modelId;\n    this.categoryId = categoryId;\n    this.visible = visible;\n  }\n}\n\nfunction compareCategoryOverrides(lhs: PerModelCategoryVisibilityOverride, rhs: PerModelCategoryVisibilityOverride): number {\n  const cmp = compareStrings(lhs.modelId, rhs.modelId);\n  return 0 === cmp ? compareStrings(lhs.categoryId, rhs.categoryId) : cmp;\n}\n\n/** The Viewport-specific implementation of PerModelCategoryVisibility.Overrides. */\nclass PerModelCategoryVisibilityOverrides extends SortedArray<PerModelCategoryVisibilityOverride> implements PerModelCategoryVisibility.Overrides {\n  private readonly _scratch = new PerModelCategoryVisibilityOverride(\"0\", \"0\", false);\n  private readonly _vp: Viewport;\n\n  public constructor(vp: Viewport) {\n    super(compareCategoryOverrides);\n    this._vp = vp;\n  }\n\n  public getOverride(modelId: Id64String, categoryId: Id64String): PerModelCategoryVisibility.Override {\n    this._scratch.reset(modelId, categoryId, false);\n    const ovr = this.findEqual(this._scratch);\n    if (undefined !== ovr)\n      return ovr.visible ? PerModelCategoryVisibility.Override.Show : PerModelCategoryVisibility.Override.Hide;\n    else\n      return PerModelCategoryVisibility.Override.None;\n  }\n\n  /**\n   * set the overrides for multiple perModelCategoryVisibility props, loading categoryIds from the iModel if necessary.\n   * @see [[PerModelCategoryVisibility]]\n   * @param perModelCategoryVisibility array of model category visibility overrides @see [[PerModelCategoryVisibility.Props]]\n   * @param iModel Optional param iModel. If no iModel is provided, then the iModel associated with the viewport (used to construct this class) is used.\n   * This optional iModel param is useful for apps which may show multiple iModels at once. Passing in an iModel ensures that the subcategories cache for the provided iModel\n   * is populated as opposed to the iModel associated with the viewport which may or may not be an empty iModel.\n   * @returns a promise that resolves once the overrides have been applied.\n   */\n  public async setOverrides(perModelCategoryVisibility: PerModelCategoryVisibility.Props[], iModel?: IModelConnection): Promise<void> {\n    let anyChanged = false;\n    const catIdsToLoad: string[] = [];\n    const iModelToUse = iModel ? iModel : this._vp.iModel;\n    for (const override of perModelCategoryVisibility) {\n      const modelId = override.modelId;\n      // The caller may pass a single categoryId as a string, if we don't convert this to an array we will iterate\n      // over each individual character of that string, which is not the desired behavior.\n      const categoryIds = typeof override.categoryIds === \"string\" ? [override.categoryIds] : override.categoryIds;\n      const visOverride = override.visOverride;\n      for (const categoryId of categoryIds) {\n        if (this.findAndUpdateOverrideInArray(modelId, categoryId, visOverride)) {\n          anyChanged = true;\n          if (PerModelCategoryVisibility.Override.None !== visOverride) {\n            catIdsToLoad.push(categoryId);\n          }\n        }\n      }\n    }\n    if (anyChanged) {\n      this._vp.setViewedCategoriesPerModelChanged();\n      if (catIdsToLoad.length !== 0) {\n        this._vp.subcategories.push(iModelToUse.subcategories, catIdsToLoad, () => this._vp.setViewedCategoriesPerModelChanged());\n      }\n    }\n    return;\n  }\n\n  /** Find and update the override in the array of overrides. If override not found, adds it to the array.\n   *  If the array was changed, returns true. */\n  private findAndUpdateOverrideInArray(modelId: Id64String, categoryId: Id64String, override: PerModelCategoryVisibility.Override): boolean {\n    const ovr = this._scratch;\n    ovr.reset(modelId, categoryId, false);\n    let changed = false;\n    const index = this.indexOf(ovr);\n    if (-1 === index) {\n      if (PerModelCategoryVisibility.Override.None !== override) {\n        this.insert(new PerModelCategoryVisibilityOverride(modelId, categoryId, PerModelCategoryVisibility.Override.Show === override));\n        changed = true;\n      }\n    } else {\n      if (PerModelCategoryVisibility.Override.None === override) {\n        this._array.splice(index, 1);\n        changed = true;\n      } else if (this._array[index].visible !== (PerModelCategoryVisibility.Override.Show === override)) {\n        this._array[index].visible = (PerModelCategoryVisibility.Override.Show === override);\n        changed = true;\n      }\n    }\n    return changed;\n  }\n\n  public setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: PerModelCategoryVisibility.Override): void {\n    let changed = false;\n    for (const modelId of Id64.iterable(modelIds)) {\n      for (const categoryId of Id64.iterable(categoryIds)) {\n        if (this.findAndUpdateOverrideInArray(modelId, categoryId, override))\n          changed = true;\n      }\n    }\n\n    if (changed) {\n      this._vp.setViewedCategoriesPerModelChanged();\n\n      if (PerModelCategoryVisibility.Override.None !== override) {\n        // Ensure subcategories loaded.\n        this._vp.subcategories.push(this._vp.iModel.subcategories, categoryIds, () => this._vp.setViewedCategoriesPerModelChanged());\n      }\n    }\n  }\n\n  public clearOverrides(modelIds?: Id64Arg): void {\n    if (undefined === modelIds) {\n      if (0 < this.length) {\n        this.clear();\n        this._vp.setViewedCategoriesPerModelChanged();\n      }\n\n      return;\n    }\n\n    for (let i = 0; i < this.length;) {\n      const ovr = this._array[i];\n      let removed = false;\n      for (const modelId of Id64.iterable(modelIds)) {\n        if (modelId === ovr.modelId) {\n          this._array.splice(i, 1);\n          this._vp.setViewedCategoriesPerModelChanged();\n          removed = true;\n          break;\n        }\n      }\n\n      if (!removed)\n        ++i;\n    }\n  }\n\n  public addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void {\n    const cache = this._vp.iModel.subcategories;\n\n    for (const ovr of this._array) {\n      const subcats = cache.getSubCategories(ovr.categoryId);\n      if (undefined === subcats)\n        continue;\n\n      // It's pointless to override for models which aren't displayed...except if we do this, and then someone enables that model,\n      // we would need to regenerate our symbology overrides in response. Preferably people wouldn't bother overriding models that\n      // they don't want us to draw...\n      /* if (!this._vp.view.viewsModel(ovr.modelId))\n        continue; */\n\n      // ###TODO: Avoid recomputing upper and lower portions of modelId if modelId repeated.\n      // (Array is sorted first by modelId).\n      // Also avoid computing if no effective overrides.\n      const modelLo = Id64.getLowerUint32(ovr.modelId);\n      const modelHi = Id64.getUpperUint32(ovr.modelId);\n\n      for (const subcat of subcats) {\n        const subcatLo = Id64.getLowerUint32(subcat);\n        const subcatHi = Id64.getUpperUint32(subcat);\n        const vis = fs.isSubCategoryVisible(subcatLo, subcatHi);\n        if (vis !== ovr.visible) {\n          // Only care if visibility differs from that defined for entire view\n          let entry = ovrs.get(modelLo, modelHi);\n          if (undefined === entry) {\n            entry = new Id64.Uint32Set();\n            ovrs.set(modelLo, modelHi, entry);\n          }\n\n          entry.add(subcatLo, subcatHi);\n        }\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"PerModelCategoryVisibility.js","sourceRoot":"","sources":["../../src/PerModelCategoryVisibility.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAuB,MAAM,qBAAqB,CAAC;AAKhE;;;;;;;;GAQG;AACH,MAAM,KAAW,0BAA0B,CAyD1C;AAzDD,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;IA6CD,SAAgB,eAAe,CAAC,QAAkB;QAChD,OAAO,IAAI,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAFe,0CAAe,kBAE9B,CAAA;AACH,CAAC,EAzDgB,0BAA0B,KAA1B,0BAA0B,QAyD1C;AAMD,oFAAoF;AACpF,MAAM,mCAAmC;IACtB,IAAI,GAAG,IAAI,GAAG,EAA0B,CAAC;IAC1D,kHAAkH;IACjG,IAAI,GAAG,IAAI,GAAG,EAA0B,CAAC;IACzC,GAAG,CAAW;IAE/B,YAAmB,EAAY;QAC7B,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;IAChB,CAAC;IAGM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACtC,CAAC;IAEM,WAAW,CAAC,OAAmB,EAAE,UAAsB;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,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;IAEO,aAAa,CAAC,EAAE,OAAO,EAAE,QAAQ,EAA0E;QACjH,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC1D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,UAAU,GAAG,IAAI,GAAG,EAAsC,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACnC,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,wBAAwB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAA0H;QACpM,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC1D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAChC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,GAAG,GAA2B,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;YACrE,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,aAAa,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACtC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,aAAa,CAAC,OAAmB,EAAE,WAAiC,EAAE,QAA6C,EAAE,YAAuB;QAClJ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU;YACb,OAAO,OAAO,CAAC;QAEjB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,wBAAwB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACjF,OAAO,GAAG,IAAI,CAAC;gBACf,IAAI,YAAY,IAAI,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI;oBACvE,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;QACD,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,0BAA8D,EAAE,MAAyB;QACjH,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QACtD,KAAK,MAAM,QAAQ,IAAI,0BAA0B,EAAE,CAAC;YAClD,4GAA4G;YAC5G,oFAAoF;YACpF,MAAM,WAAW,GAAG,OAAO,QAAQ,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC7G,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;gBACvF,UAAU,GAAG,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAC9C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC,CAAC;YAC5H,CAAC;QACH,CAAC;IACH,CAAC;IAEM,WAAW,CAAC,QAAiB,EAAE,WAAoB,EAAE,QAA6C;QACvG,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,CAAC;gBAC3D,OAAO,GAAG,IAAI,CAAC;QACnB,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAE9C,IAAI,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC1D,+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;YAC/H,CAAC;QACH,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,QAAkB;QACtC,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBAClB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBAClB,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;YAChD,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,SAAS;YACX,CAAC;YACD,OAAO,GAAG,IAAI,CAAC;YACf,KAAK,MAAM,aAAa,IAAI,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAClC,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,CAAC;QAChD,CAAC;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,IAAI,EAAE,CAAC;YAC5B,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,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,CAAC;gBAC7B,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,CAAC;oBACxB,oEAAoE;oBACpE,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACvC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;wBACxB,KAAK,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;oBACpC,CAAC;oBAED,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { Id64, Id64Arg, Id64String } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"./IModelConnection\";\nimport { FeatureSymbology } from \"./render/FeatureSymbology\";\nimport { Viewport } from \"./Viewport\";\n\n/** Per-model category visibility permits the visibility of categories within a [[Viewport]] displaying a [[SpatialViewState]] to be overridden in\n * the context of individual [[GeometricModelState]]s.\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]].\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\n * will be visible, regardless of any [SubCategoryOverride]($common)s applied by the view's [[DisplayStyleState]].\n * @see [[Viewport.perModelCategoryVisibility]] to define the per-model category visibility for a viewport.\n * @public\n * @extensions\n */\nexport namespace PerModelCategoryVisibility {\n  /** Describes whether and how a category's visibility is overridden. */\n  export enum Override {\n    /** The category's visibility is not overridden; its visibility is wholly controlled by the [[Viewport]]'s [[CategorySelectorState]]. */\n    None,\n    /** The category is overridden to be visible. */\n    Show,\n    /** The category is overridden to be invisible. */\n    Hide,\n  }\n\n  /** Describes one visibility override in a [[PerModelCategoryVisibility.Overrides]]. */\n  export interface OverrideEntry {\n    /** The Id of the [[GeometricModelState]] in which the override applies. */\n    readonly modelId: Id64String;\n    /** The Id of the [SpatialCategory]($backend) whose visibility is overridden. */\n    readonly categoryId: Id64String;\n    /** Whether the category is visible in the context of the model. */\n    readonly visible: boolean;\n  }\n\n  /** Describes a set of per-model category visibility overrides. Changes to these overrides invoke the [[Viewport.onViewedCategoriesPerModelChanged]] event.\n   * @see [[Viewport.perModelCategoryVisibility]].\n   */\n  export interface Overrides {\n    /** Returns the override state of the specified category within the specified model. */\n    getOverride(modelId: Id64String, categoryId: Id64String): Override;\n    /** Changes the override state of one or more categories for one or more models. */\n    setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: Override): void;\n    /** Changes multiple overrides, given an array of overrides *\n     * @beta\n     */\n    setOverrides(perModelCategoryVisibility: Props[], iModel?: IModelConnection): Promise<void>;\n    /** Removes all overrides for the specified models, or for all models if `modelIds` is undefined. */\n    clearOverrides(modelIds?: Id64Arg): void;\n    /** An iterator over all of the visibility overrides. */\n    [Symbol.iterator]: () => Iterator<OverrideEntry>;\n    /** Populate the symbology overrides based on the per-model category visibility. */\n    addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void;\n  }\n\n  /** Describes a set of [[PerModelCategoryVisibility.Overrides]].\n   * @see [[PerModelCategoryVisibility.Overrides.setOverrides]].\n   * @beta\n  */\n  export interface Props {\n    /** The id of the model to which the overrides apply. */\n    modelId: string;\n    /** The ids of the categories whose visibility are to be overridden within the context of the model. */\n    categoryIds: Iterable<Id64String>;\n    /** The visibility to be applied to the specified categories. */\n    visOverride: PerModelCategoryVisibility.Override;\n  }\n\n  export function createOverrides(viewport: Viewport): PerModelCategoryVisibility.Overrides {\n    return new PerModelCategoryVisibilityOverrides(viewport);\n  }\n}\ntype Writeable<T extends object> = { -readonly [P in keyof T]: T[P] };\ntype WriteableOverrideEntry = Writeable<PerModelCategoryVisibility.OverrideEntry>;\n\ntype ModelEntry = Map<Id64String, WriteableOverrideEntry>;\n\n/** The Viewport-specific implementation of PerModelCategoryVisibility.Overrides. */\nclass PerModelCategoryVisibilityOverrides implements PerModelCategoryVisibility.Overrides {\n  private readonly _map = new Map<Id64String, ModelEntry>();\n  /** Flat set of all override entries, providing O(1) iteration via [Symbol.iterator]. Kept in sync with `_map`. */\n  private readonly _set = new Set<WriteableOverrideEntry>();\n  private readonly _vp: Viewport;\n\n  public constructor(vp: Viewport) {\n    this._vp = vp;\n  }\n\n\n  public [Symbol.iterator](): Iterator<PerModelCategoryVisibility.OverrideEntry> {\n    return this._set[Symbol.iterator]();\n  }\n\n  public getOverride(modelId: Id64String, categoryId: Id64String): PerModelCategoryVisibility.Override {\n    const ovr = this._map.get(modelId)?.get(categoryId);\n    if (undefined !== ovr)\n      return ovr.visible ? PerModelCategoryVisibility.Override.Show : PerModelCategoryVisibility.Override.Hide;\n    else\n      return PerModelCategoryVisibility.Override.None;\n  }\n\n  private getModelEntry({ modelId, override }: { modelId: Id64String; override: PerModelCategoryVisibility.Override }): ModelEntry | undefined {\n    let modelEntry = this._map.get(modelId);\n    if (modelEntry) {\n      return modelEntry;\n    }\n    if (override === PerModelCategoryVisibility.Override.None) {\n      return undefined;\n    }\n    modelEntry = new Map<Id64String, WriteableOverrideEntry>();\n    this._map.set(modelId, modelEntry);\n    return modelEntry;\n  }\n\n  private addOrRemoveOverrideEntry({ modelEntry, categoryId, modelId, override }: { modelEntry: ModelEntry; categoryId: Id64String; modelId: Id64String; override: PerModelCategoryVisibility.Override }): boolean {\n    const overrideEntry = modelEntry.get(categoryId);\n    if (override === PerModelCategoryVisibility.Override.None) {\n      if (overrideEntry === undefined) {\n        return false;\n      }\n\n      this._set.delete(overrideEntry);\n      modelEntry.delete(categoryId);\n      return true;\n    }\n    const visible = override === PerModelCategoryVisibility.Override.Show;\n    if (overrideEntry === undefined) {\n      const ovr: WriteableOverrideEntry = { modelId, categoryId, visible };\n      modelEntry.set(categoryId, ovr);\n      this._set.add(ovr);\n      return true;\n    }\n    if (overrideEntry.visible !== visible) {\n      overrideEntry.visible = visible;\n      return true;\n    }\n    return false;\n  }\n\n  private applyOverride(modelId: Id64String, categoryIds: Iterable<Id64String>, override: PerModelCategoryVisibility.Override, catIdsToLoad?: string[]): boolean {\n    const modelEntry = this.getModelEntry({ modelId, override });\n    let changed = false;\n    if (!modelEntry)\n      return changed;\n\n    for (const categoryId of categoryIds) {\n      if (this.addOrRemoveOverrideEntry({ modelEntry, categoryId, modelId, override })) {\n        changed = true;\n        if (catIdsToLoad && override !== PerModelCategoryVisibility.Override.None)\n          catIdsToLoad.push(categoryId);\n      }\n    }\n    if (modelEntry.size === 0) {\n      this._map.delete(modelId);\n    }\n    return changed;\n  }\n\n  /**\n   * set the overrides for multiple perModelCategoryVisibility props, loading categoryIds from the iModel if necessary.\n   * @see [[PerModelCategoryVisibility]]\n   * @param perModelCategoryVisibility array of model category visibility overrides @see [[PerModelCategoryVisibility.Props]]\n   * @param iModel Optional param iModel. If no iModel is provided, then the iModel associated with the viewport (used to construct this class) is used.\n   * This optional iModel param is useful for apps which may show multiple iModels at once. Passing in an iModel ensures that the subcategories cache for the provided iModel\n   * is populated as opposed to the iModel associated with the viewport which may or may not be an empty iModel.\n   * @returns a promise that resolves once the overrides have been applied.\n   */\n  public async setOverrides(perModelCategoryVisibility: PerModelCategoryVisibility.Props[], iModel?: IModelConnection): Promise<void> {\n    let anyChanged = false;\n    const catIdsToLoad: string[] = [];\n    const iModelToUse = iModel ? iModel : this._vp.iModel;\n    for (const override of perModelCategoryVisibility) {\n      // The caller may pass a single categoryId as a string, if we don't convert this to an array we will iterate\n      // over each individual character of that string, which is not the desired behavior.\n      const categoryIds = typeof override.categoryIds === \"string\" ? [override.categoryIds] : override.categoryIds;\n      if (this.applyOverride(override.modelId, categoryIds, override.visOverride, catIdsToLoad))\n        anyChanged = true;\n    }\n    if (anyChanged) {\n      this._vp.setViewedCategoriesPerModelChanged();\n      if (catIdsToLoad.length !== 0) {\n        this._vp.subcategories.push(iModelToUse.subcategories, catIdsToLoad, () => this._vp.setViewedCategoriesPerModelChanged());\n      }\n    }\n  }\n\n  public setOverride(modelIds: Id64Arg, categoryIds: Id64Arg, override: PerModelCategoryVisibility.Override): void {\n    const categoryIdIterable = Id64.iterable(categoryIds);\n    let changed = false;\n    for (const modelId of Id64.iterable(modelIds)) {\n      if (this.applyOverride(modelId, categoryIdIterable, override))\n        changed = true;\n    }\n\n    if (changed) {\n      this._vp.setViewedCategoriesPerModelChanged();\n\n      if (override !== PerModelCategoryVisibility.Override.None) {\n        // Ensure subcategories loaded.\n        this._vp.subcategories.push(this._vp.iModel.subcategories, categoryIds, () => this._vp.setViewedCategoriesPerModelChanged());\n      }\n    }\n  }\n\n  public clearOverrides(modelIds?: Id64Arg): void {\n    if (undefined === modelIds) {\n      if (this._map.size > 0) {\n        this._map.clear();\n        this._set.clear();\n        this._vp.setViewedCategoriesPerModelChanged();\n      }\n      return;\n    }\n\n    let changed = false;\n    for (const modelId of Id64.iterable(modelIds)) {\n      const modelEntry = this._map.get(modelId);\n      if (!modelEntry) {\n        continue;\n      }\n      changed = true;\n      for (const overrideEntry of modelEntry.values()) {\n        this._set.delete(overrideEntry);\n      }\n      this._map.delete(modelId);\n    }\n    if (changed) {\n      this._vp.setViewedCategoriesPerModelChanged();\n    }\n  }\n\n  public addOverrides(fs: FeatureSymbology.Overrides, ovrs: Id64.Uint32Map<Id64.Uint32Set>): void {\n    const cache = this._vp.iModel.subcategories;\n\n    for (const ovr of this._set) {\n      const subcats = cache.getSubCategories(ovr.categoryId);\n      if (undefined === subcats)\n        continue;\n\n      // It's pointless to override for models which aren't displayed...except if we do this, and then someone enables that model,\n      // we would need to regenerate our symbology overrides in response. Preferably people wouldn't bother overriding models that\n      // they don't want us to draw...\n      /* if (!this._vp.view.viewsModel(ovr.modelId))\n        continue; */\n\n      // ###TODO: Avoid recomputing upper and lower portions of modelId if modelId repeated.\n      // Also avoid computing if no effective overrides.\n      const modelLo = Id64.getLowerUint32(ovr.modelId);\n      const modelHi = Id64.getUpperUint32(ovr.modelId);\n\n      for (const subcat of subcats) {\n        const subcatLo = Id64.getLowerUint32(subcat);\n        const subcatHi = Id64.getUpperUint32(subcat);\n        const vis = fs.isSubCategoryVisible(subcatLo, subcatHi);\n        if (vis !== ovr.visible) {\n          // Only care if visibility differs from that defined for entire view\n          let entry = ovrs.get(modelLo, modelHi);\n          if (undefined === entry) {\n            entry = new Id64.Uint32Set();\n            ovrs.set(modelLo, modelHi, entry);\n          }\n\n          entry.add(subcatLo, subcatHi);\n        }\n      }\n    }\n  }\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"SpatialViewState.d.ts","sourceRoot":"","sources":["../../src/SpatialViewState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAoC,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAY,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/J,OAAO,EAA8B,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAyB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAA6B,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,2FAA2F;IAC3F,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,WAA2B,SAAS,WAAsC;IAE1E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4B;IACtD,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iCAAiC,CAAsB;IAExE;;OAEG;IACH,SAAgB,qBAAqB,gBAAqB,IAAI,EAAI;IAElE,IAAW,aAAa,IAAI,kBAAkB,CAE7C;IAED,IAAW,aAAa,CAAC,QAAQ,EAAE,kBAAkB,EAepD;IAED;;;;;;;;OAQG;WACW,WAAW,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,gBAAgB;WAapG,eAAe,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAOzF,OAAO,IAAI,cAAc;gBAM7B,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB;IAS1J,aAAa,IAAI,IAAI,IAAI,gBAAgB;IAEzC,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IAE5B,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB;IAC1E,IAAW,mBAAmB;;;MAAiF;IAE/G,gBAAgB;IACT,wBAAwB,IAAI,IAAI;IAIvC,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACI,eAAe,CAAC,OAAO,CAAC,EAAE,iCAAiC,GAAG,gBAAgB;IAiB9E,gBAAgB,IAAI,gBAAgB;IAU3B,MAAM,IAAI,0BAA0B;IAMpD,gBAAgB;cACG,OAAO,CAAC,cAAc,EAAE,4BAA4B,GAAG,IAAI;IAQ9E,gBAAgB;cACS,QAAQ,CAAC,eAAe,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzF,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IACxC,iBAAiB;IACjB,cAAc,CAAC,EAAE,EAAE,UAAU;IAC7B,iBAAiB,CAAC,EAAE,EAAE,UAAU;IAEhC,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI;IAQ9D,gBAAgB;IACE,gBAAgB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;IAMjE,gBAAgB;IACA,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMxD,0CAA0C;IAC1B,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAMlE,4CAA4C;IAC5B,kBAAkB,IAAI,IAAI;IAM1C;;;;;;OAMG;IACI,gCAAgC,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,SAAS,EAAE,WAAW,EAAE,OAAO,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,IAAI;IAI9L;;;;;OAKG;IACI,eAAe,CAAC,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,iBAAiB,EAAE,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAIlH;;;;OAIG;IACI,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,UAAU,EAAE,GAAG,SAAS;IAIrH,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,gCAAgC;CAIzC;AACD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,WAA2B,SAAS,WAA2C;gBAEnE,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB;IAEhK,cAAc,IAAI,OAAO;CAC1C"}
+{"version":3,"file":"SpatialViewState.d.ts","sourceRoot":"","sources":["../../src/SpatialViewState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAoC,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAY,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/J,OAAO,EAA8B,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAyB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAA6B,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,2FAA2F;IAC3F,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,WAA2B,SAAS,WAAsC;IAE1E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4B;IACtD,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iCAAiC,CAAsB;IAExE;;OAEG;IACH,SAAgB,qBAAqB,gBAAqB,IAAI,EAAI;IAElE,IAAW,aAAa,IAAI,kBAAkB,CAE7C;IAED,IAAW,aAAa,CAAC,QAAQ,EAAE,kBAAkB,EAepD;IAED;;;;;;;;OAQG;WACW,WAAW,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,gBAAgB;WAapG,eAAe,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAOzF,OAAO,IAAI,cAAc;gBAM7B,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB;IAS1J,aAAa,IAAI,IAAI,IAAI,gBAAgB;IAEzC,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IAE5B,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,mBAAmB;IAC1E,IAAW,mBAAmB;;;MAAiF;IAE/G,gBAAgB;IACT,wBAAwB,IAAI,IAAI;IAIvC,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACI,eAAe,CAAC,OAAO,CAAC,EAAE,iCAAiC,GAAG,gBAAgB;IAiB9E,gBAAgB,IAAI,gBAAgB;IAU3B,MAAM,IAAI,0BAA0B;IAQpD,gBAAgB;cACG,OAAO,CAAC,cAAc,EAAE,4BAA4B,GAAG,IAAI;IAQ9E,gBAAgB;cACS,QAAQ,CAAC,eAAe,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzF,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IACxC,iBAAiB;IACjB,cAAc,CAAC,EAAE,EAAE,UAAU;IAC7B,iBAAiB,CAAC,EAAE,EAAE,UAAU;IAEhC,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI;IAQ9D,gBAAgB;IACE,gBAAgB,IAAI,QAAQ,CAAC,iBAAiB,CAAC;IAMjE,gBAAgB;IACA,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAMxD,0CAA0C;IAC1B,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI;IAMlE,4CAA4C;IAC5B,kBAAkB,IAAI,IAAI;IAM1C;;;;;;OAMG;IACI,gCAAgC,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,SAAS,EAAE,WAAW,EAAE,OAAO,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,IAAI;IAI9L;;;;;OAKG;IACI,eAAe,CAAC,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,iBAAiB,EAAE,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;IAIlH;;;;OAIG;IACI,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,UAAU,EAAE,GAAG,SAAS;IAIrH,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,gCAAgC;CAIzC;AACD;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,WAA2B,SAAS,WAA2C;gBAEnE,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,gBAAgB,EAAE,UAAU,EAAE,qBAAqB,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,kBAAkB;IAEhK,cAAc,IAAI,OAAO;CAC1C"}

package/lib/esm/SpatialViewState.js

@@ -128,7 +128,9 @@ export class SpatialViewState extends ViewState3d {
     }
     toJSON() {
         const val = super.toJSON();
-        val.modelSelectorId = this.modelSelector.id;
+        val.modelSelector = { id: this.modelSelector.id };
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        val.modelSelectorId = this.modelSelector.id; // for backward compatibility
         return val;
     }
     /** @internal */