@itwin/presentation-frontend 3.7.0-dev.2 → 3.7.0-dev.5

package/lib/cjs/presentation-frontend/selection/HiliteSetProvider.js

@@ -1,98 +1,98 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HiliteSetProvider = exports.HILITE_RULESET = void 0;
-const presentation_common_1 = require("@itwin/presentation-common");
-const Presentation_1 = require("../Presentation");
-const SelectionManager_1 = require("./SelectionManager");
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-exports.HILITE_RULESET = require("./HiliteRules.json");
-/**
- * Presentation-based provider which uses presentation ruleset to determine
- * what `HiliteSet` should be hilited in the graphics viewport based on the
- * supplied `KeySet`.
- *
- * @public
- */
-class HiliteSetProvider {
-    constructor(props) {
-        this._imodel = props.imodel;
-    }
-    /**
-     * Create a hilite set provider for the specified iModel.
-     */
-    static create(props) { return new HiliteSetProvider(props); }
-    async getRecords(keys) {
-        const descriptor = {
-            displayType: presentation_common_1.DefaultContentDisplayTypes.Viewport,
-            contentFlags: presentation_common_1.ContentFlags.KeysOnly,
-        };
-        const options = {
-            imodel: this._imodel,
-            rulesetOrId: exports.HILITE_RULESET,
-            descriptor,
-        };
-        const contentPromises = new Array();
-        keys.forEachBatch(presentation_common_1.DEFAULT_KEYS_BATCH_SIZE, (batch) => {
-            contentPromises.push(Presentation_1.Presentation.presentation.getContent({ ...options, keys: batch }));
-        });
-        return (await Promise.all(contentPromises)).reduce((items, content) => {
-            if (content)
-                items.push(...content.contentSet);
-            return items;
-        }, new Array());
-    }
-    createHiliteSet(records, transientIds) {
-        if (!records.length)
-            return { elements: transientIds };
-        const modelIds = new Array();
-        const subCategoryIds = new Array();
-        const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway
-        records.forEach((rec) => {
-            const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;
-            rec.primaryKeys.forEach((pk) => ids.push(pk.id));
-        });
-        return {
-            models: modelIds.length ? modelIds : undefined,
-            subCategories: subCategoryIds.length ? subCategoryIds : undefined,
-            elements: elementIds.length ? elementIds : undefined,
-        };
-    }
-    /**
-     * Get hilite set for instances and/or nodes whose keys are specified in the
-     * given KeySet.
-     *
-     * Note: The provider caches result of the last request, so subsequent requests
-     * for the same input doesn't cost.
-     */
-    async getHiliteSet(selection) {
-        const selectionGuid = selection.guid;
-        if (!this._cached || this._cached.keysGuid !== selectionGuid) {
-            // need to create a new set without transients
-            const transientIds = new Array();
-            const keys = new presentation_common_1.KeySet();
-            keys.add(selection, (key) => {
-                if (presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME) {
-                    transientIds.push(key.id);
-                    return false;
-                }
-                return true;
-            });
-            const records = await this.getRecords(keys);
-            const result = this.createHiliteSet(records, transientIds);
-            this._cached = { keysGuid: selectionGuid, result };
-        }
-        return this._cached.result;
-    }
-}
-exports.HiliteSetProvider = HiliteSetProvider;
-const isModelRecord = (rec) => (rec.extendedData && rec.extendedData.isModel);
-const isSubCategoryRecord = (rec) => (rec.extendedData && rec.extendedData.isSubCategory);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HiliteSetProvider = exports.HILITE_RULESET = void 0;
+const presentation_common_1 = require("@itwin/presentation-common");
+const Presentation_1 = require("../Presentation");
+const SelectionManager_1 = require("./SelectionManager");
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+exports.HILITE_RULESET = require("./HiliteRules.json");
+/**
+ * Presentation-based provider which uses presentation ruleset to determine
+ * what `HiliteSet` should be hilited in the graphics viewport based on the
+ * supplied `KeySet`.
+ *
+ * @public
+ */
+class HiliteSetProvider {
+    constructor(props) {
+        this._imodel = props.imodel;
+    }
+    /**
+     * Create a hilite set provider for the specified iModel.
+     */
+    static create(props) { return new HiliteSetProvider(props); }
+    async getRecords(keys) {
+        const descriptor = {
+            displayType: presentation_common_1.DefaultContentDisplayTypes.Viewport,
+            contentFlags: presentation_common_1.ContentFlags.KeysOnly,
+        };
+        const options = {
+            imodel: this._imodel,
+            rulesetOrId: exports.HILITE_RULESET,
+            descriptor,
+        };
+        const contentPromises = new Array();
+        keys.forEachBatch(presentation_common_1.DEFAULT_KEYS_BATCH_SIZE, (batch) => {
+            contentPromises.push(Presentation_1.Presentation.presentation.getContent({ ...options, keys: batch }));
+        });
+        return (await Promise.all(contentPromises)).reduce((items, content) => {
+            if (content)
+                items.push(...content.contentSet);
+            return items;
+        }, new Array());
+    }
+    createHiliteSet(records, transientIds) {
+        if (!records.length)
+            return { elements: transientIds };
+        const modelIds = new Array();
+        const subCategoryIds = new Array();
+        const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway
+        records.forEach((rec) => {
+            const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;
+            rec.primaryKeys.forEach((pk) => ids.push(pk.id));
+        });
+        return {
+            models: modelIds.length ? modelIds : undefined,
+            subCategories: subCategoryIds.length ? subCategoryIds : undefined,
+            elements: elementIds.length ? elementIds : undefined,
+        };
+    }
+    /**
+     * Get hilite set for instances and/or nodes whose keys are specified in the
+     * given KeySet.
+     *
+     * Note: The provider caches result of the last request, so subsequent requests
+     * for the same input doesn't cost.
+     */
+    async getHiliteSet(selection) {
+        const selectionGuid = selection.guid;
+        if (!this._cached || this._cached.keysGuid !== selectionGuid) {
+            // need to create a new set without transients
+            const transientIds = new Array();
+            const keys = new presentation_common_1.KeySet();
+            keys.add(selection, (key) => {
+                if (presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME) {
+                    transientIds.push(key.id);
+                    return false;
+                }
+                return true;
+            });
+            const records = await this.getRecords(keys);
+            const result = this.createHiliteSet(records, transientIds);
+            this._cached = { keysGuid: selectionGuid, result };
+        }
+        return this._cached.result;
+    }
+}
+exports.HiliteSetProvider = HiliteSetProvider;
+const isModelRecord = (rec) => (rec.extendedData && rec.extendedData.isModel);
+const isSubCategoryRecord = (rec) => (rec.extendedData && rec.extendedData.isSubCategory);
 //# sourceMappingURL=HiliteSetProvider.js.map

package/lib/cjs/presentation-frontend/selection/HiliteSetProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"HiliteSetProvider.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/HiliteSetProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH,oEAEoC;AACpC,kDAA+C;AAC/C,yDAAiE;AAEjE,gBAAgB;AAChB,8DAA8D;AACjD,QAAA,cAAc,GAAY,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAsBrE;;;;;;GAMG;AACH,MAAa,iBAAiB;IAI5B,YAAoB,KAA6B;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAA6B,IAAI,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEpF,KAAK,CAAC,UAAU,CAAC,IAAY;QACnC,MAAM,UAAU,GAAwB;YACtC,WAAW,EAAE,gDAA0B,CAAC,QAAQ;YAChD,YAAY,EAAE,kCAAY,CAAC,QAAQ;SACpC,CAAC;QACF,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,WAAW,EAAE,sBAAc;YAC3B,UAAU;SACX,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,KAAK,EAAgC,CAAC;QAClE,IAAI,CAAC,YAAY,CAAC,6CAAuB,EAAE,CAAC,KAAa,EAAE,EAAE;YAC3D,eAAe,CAAC,IAAI,CAAC,2BAAY,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACpE,IAAI,OAAO;gBACT,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,IAAI,KAAK,EAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,eAAe,CAAC,OAAe,EAAE,YAA0B;QACjE,IAAI,CAAC,OAAO,CAAC,MAAM;YACjB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAc,CAAC;QACzC,MAAM,cAAc,GAAG,IAAI,KAAK,EAAc,CAAC;QAC/C,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,+EAA+E;QAChH,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACtB,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC;YACnG,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC9C,aAAa,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;YACjE,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;SACrD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,SAA2B;QACnD,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,aAAa,EAAE;YAC5D,8CAA8C;YAC9C,MAAM,YAAY,GAAG,IAAI,KAAK,EAAc,CAAC;YAC7C,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE;gBAC/B,IAAI,yBAAG,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,KAAK,8CAA2B,EAAE;oBAC3E,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC1B,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;CACF;AA9ED,8CA8EC;AAED,MAAM,aAAa,GAAG,CAAC,GAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AAEpF,MAAM,mBAAmB,GAAG,CAAC,GAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC","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 UnifiedSelection\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport {\n  Content, ContentFlags, DEFAULT_KEYS_BATCH_SIZE, DefaultContentDisplayTypes, DescriptorOverrides, Item, Key, KeySet, Ruleset,\n} from \"@itwin/presentation-common\";\nimport { Presentation } from \"../Presentation\";\nimport { TRANSIENT_ELEMENT_CLASSNAME } from \"./SelectionManager\";\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/no-var-requires\nexport const HILITE_RULESET: Ruleset = require(\"./HiliteRules.json\");\n\n/**\n * A set of model, subcategory and element ids that can be used for specifying\n * viewport hilite.\n *\n * @public\n */\nexport interface HiliteSet {\n  models?: Id64String[];\n  subCategories?: Id64String[];\n  elements?: Id64String[];\n}\n\n/**\n * Properties for creating a `HiliteSetProvider` instance.\n * @public\n */\nexport interface HiliteSetProviderProps {\n  imodel: IModelConnection;\n}\n\n/**\n * Presentation-based provider which uses presentation ruleset to determine\n * what `HiliteSet` should be hilited in the graphics viewport based on the\n * supplied `KeySet`.\n *\n * @public\n */\nexport class HiliteSetProvider {\n  private _imodel: IModelConnection;\n  private _cached: undefined | { keysGuid: string, result: HiliteSet };\n\n  private constructor(props: HiliteSetProviderProps) {\n    this._imodel = props.imodel;\n  }\n\n  /**\n   * Create a hilite set provider for the specified iModel.\n   */\n  public static create(props: HiliteSetProviderProps) { return new HiliteSetProvider(props); }\n\n  private async getRecords(keys: KeySet): Promise<Item[]> {\n    const descriptor: DescriptorOverrides = {\n      displayType: DefaultContentDisplayTypes.Viewport,\n      contentFlags: ContentFlags.KeysOnly,\n    };\n    const options = {\n      imodel: this._imodel,\n      rulesetOrId: HILITE_RULESET,\n      descriptor,\n    };\n    const contentPromises = new Array<Promise<Content | undefined>>();\n    keys.forEachBatch(DEFAULT_KEYS_BATCH_SIZE, (batch: KeySet) => {\n      contentPromises.push(Presentation.presentation.getContent({ ...options, keys: batch }));\n    });\n    return (await Promise.all(contentPromises)).reduce((items, content) => {\n      if (content)\n        items.push(...content.contentSet);\n      return items;\n    }, new Array<Item>());\n  }\n\n  private createHiliteSet(records: Item[], transientIds: Id64String[]) {\n    if (!records.length)\n      return { elements: transientIds };\n\n    const modelIds = new Array<Id64String>();\n    const subCategoryIds = new Array<Id64String>();\n    const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway\n    records.forEach((rec) => {\n      const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;\n      rec.primaryKeys.forEach((pk) => ids.push(pk.id));\n    });\n    return {\n      models: modelIds.length ? modelIds : undefined,\n      subCategories: subCategoryIds.length ? subCategoryIds : undefined,\n      elements: elementIds.length ? elementIds : undefined,\n    };\n  }\n\n  /**\n   * Get hilite set for instances and/or nodes whose keys are specified in the\n   * given KeySet.\n   *\n   * Note: The provider caches result of the last request, so subsequent requests\n   * for the same input doesn't cost.\n   */\n  public async getHiliteSet(selection: Readonly<KeySet>): Promise<HiliteSet> {\n    const selectionGuid = selection.guid;\n    if (!this._cached || this._cached.keysGuid !== selectionGuid) {\n      // need to create a new set without transients\n      const transientIds = new Array<Id64String>();\n      const keys = new KeySet();\n      keys.add(selection, (key: Key) => {\n        if (Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME) {\n          transientIds.push(key.id);\n          return false;\n        }\n        return true;\n      });\n      const records = await this.getRecords(keys);\n      const result = this.createHiliteSet(records, transientIds);\n      this._cached = { keysGuid: selectionGuid, result };\n    }\n    return this._cached.result;\n  }\n}\n\nconst isModelRecord = (rec: Item) => (rec.extendedData && rec.extendedData.isModel);\n\nconst isSubCategoryRecord = (rec: Item) => (rec.extendedData && rec.extendedData.isSubCategory);\n"]}
+{"version":3,"file":"HiliteSetProvider.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/HiliteSetProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH,oEAEoC;AACpC,kDAA+C;AAC/C,yDAAiE;AAEjE,gBAAgB;AAChB,8DAA8D;AACjD,QAAA,cAAc,GAAY,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAsBrE;;;;;;GAMG;AACH,MAAa,iBAAiB;IAI5B,YAAoB,KAA6B;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAA6B,IAAI,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEpF,KAAK,CAAC,UAAU,CAAC,IAAY;QACnC,MAAM,UAAU,GAAwB;YACtC,WAAW,EAAE,gDAA0B,CAAC,QAAQ;YAChD,YAAY,EAAE,kCAAY,CAAC,QAAQ;SACpC,CAAC;QACF,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,WAAW,EAAE,sBAAc;YAC3B,UAAU;SACX,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,KAAK,EAAgC,CAAC;QAClE,IAAI,CAAC,YAAY,CAAC,6CAAuB,EAAE,CAAC,KAAa,EAAE,EAAE;YAC3D,eAAe,CAAC,IAAI,CAAC,2BAAY,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACpE,IAAI,OAAO;gBACT,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,IAAI,KAAK,EAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,eAAe,CAAC,OAAe,EAAE,YAA0B;QACjE,IAAI,CAAC,OAAO,CAAC,MAAM;YACjB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAc,CAAC;QACzC,MAAM,cAAc,GAAG,IAAI,KAAK,EAAc,CAAC;QAC/C,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,+EAA+E;QAChH,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACtB,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC;YACnG,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC9C,aAAa,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;YACjE,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;SACrD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,SAA2B;QACnD,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,aAAa,EAAE;YAC5D,8CAA8C;YAC9C,MAAM,YAAY,GAAG,IAAI,KAAK,EAAc,CAAC;YAC7C,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE;gBAC/B,IAAI,yBAAG,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,KAAK,8CAA2B,EAAE;oBAC3E,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC1B,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;CACF;AA9ED,8CA8EC;AAED,MAAM,aAAa,GAAG,CAAC,GAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AAEpF,MAAM,mBAAmB,GAAG,CAAC,GAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport {\r\n  Content, ContentFlags, DEFAULT_KEYS_BATCH_SIZE, DefaultContentDisplayTypes, DescriptorOverrides, Item, Key, KeySet, Ruleset,\r\n} from \"@itwin/presentation-common\";\r\nimport { Presentation } from \"../Presentation\";\r\nimport { TRANSIENT_ELEMENT_CLASSNAME } from \"./SelectionManager\";\r\n\r\n/** @internal */\r\n// eslint-disable-next-line @typescript-eslint/no-var-requires\r\nexport const HILITE_RULESET: Ruleset = require(\"./HiliteRules.json\");\r\n\r\n/**\r\n * A set of model, subcategory and element ids that can be used for specifying\r\n * viewport hilite.\r\n *\r\n * @public\r\n */\r\nexport interface HiliteSet {\r\n  models?: Id64String[];\r\n  subCategories?: Id64String[];\r\n  elements?: Id64String[];\r\n}\r\n\r\n/**\r\n * Properties for creating a `HiliteSetProvider` instance.\r\n * @public\r\n */\r\nexport interface HiliteSetProviderProps {\r\n  imodel: IModelConnection;\r\n}\r\n\r\n/**\r\n * Presentation-based provider which uses presentation ruleset to determine\r\n * what `HiliteSet` should be hilited in the graphics viewport based on the\r\n * supplied `KeySet`.\r\n *\r\n * @public\r\n */\r\nexport class HiliteSetProvider {\r\n  private _imodel: IModelConnection;\r\n  private _cached: undefined | { keysGuid: string, result: HiliteSet };\r\n\r\n  private constructor(props: HiliteSetProviderProps) {\r\n    this._imodel = props.imodel;\r\n  }\r\n\r\n  /**\r\n   * Create a hilite set provider for the specified iModel.\r\n   */\r\n  public static create(props: HiliteSetProviderProps) { return new HiliteSetProvider(props); }\r\n\r\n  private async getRecords(keys: KeySet): Promise<Item[]> {\r\n    const descriptor: DescriptorOverrides = {\r\n      displayType: DefaultContentDisplayTypes.Viewport,\r\n      contentFlags: ContentFlags.KeysOnly,\r\n    };\r\n    const options = {\r\n      imodel: this._imodel,\r\n      rulesetOrId: HILITE_RULESET,\r\n      descriptor,\r\n    };\r\n    const contentPromises = new Array<Promise<Content | undefined>>();\r\n    keys.forEachBatch(DEFAULT_KEYS_BATCH_SIZE, (batch: KeySet) => {\r\n      contentPromises.push(Presentation.presentation.getContent({ ...options, keys: batch }));\r\n    });\r\n    return (await Promise.all(contentPromises)).reduce((items, content) => {\r\n      if (content)\r\n        items.push(...content.contentSet);\r\n      return items;\r\n    }, new Array<Item>());\r\n  }\r\n\r\n  private createHiliteSet(records: Item[], transientIds: Id64String[]) {\r\n    if (!records.length)\r\n      return { elements: transientIds };\r\n\r\n    const modelIds = new Array<Id64String>();\r\n    const subCategoryIds = new Array<Id64String>();\r\n    const elementIds = transientIds; // note: not making a copy here since we're throwing away `transientIds` anyway\r\n    records.forEach((rec) => {\r\n      const ids = isModelRecord(rec) ? modelIds : isSubCategoryRecord(rec) ? subCategoryIds : elementIds;\r\n      rec.primaryKeys.forEach((pk) => ids.push(pk.id));\r\n    });\r\n    return {\r\n      models: modelIds.length ? modelIds : undefined,\r\n      subCategories: subCategoryIds.length ? subCategoryIds : undefined,\r\n      elements: elementIds.length ? elementIds : undefined,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Get hilite set for instances and/or nodes whose keys are specified in the\r\n   * given KeySet.\r\n   *\r\n   * Note: The provider caches result of the last request, so subsequent requests\r\n   * for the same input doesn't cost.\r\n   */\r\n  public async getHiliteSet(selection: Readonly<KeySet>): Promise<HiliteSet> {\r\n    const selectionGuid = selection.guid;\r\n    if (!this._cached || this._cached.keysGuid !== selectionGuid) {\r\n      // need to create a new set without transients\r\n      const transientIds = new Array<Id64String>();\r\n      const keys = new KeySet();\r\n      keys.add(selection, (key: Key) => {\r\n        if (Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME) {\r\n          transientIds.push(key.id);\r\n          return false;\r\n        }\r\n        return true;\r\n      });\r\n      const records = await this.getRecords(keys);\r\n      const result = this.createHiliteSet(records, transientIds);\r\n      this._cached = { keysGuid: selectionGuid, result };\r\n    }\r\n    return this._cached.result;\r\n  }\r\n}\r\n\r\nconst isModelRecord = (rec: Item) => (rec.extendedData && rec.extendedData.isModel);\r\n\r\nconst isSubCategoryRecord = (rec: Item) => (rec.extendedData && rec.extendedData.isSubCategory);\r\n"]}

package/lib/cjs/presentation-frontend/selection/ISelectionProvider.d.ts

@@ -1,20 +1,20 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { IModelConnection } from "@itwin/core-frontend";
-import { KeySet } from "@itwin/presentation-common";
-import { SelectionChangeEvent } from "./SelectionChangeEvent";
-/**
- * Selection provider interface which provides main selection and sub-selection.
- * @public
- */
-export interface ISelectionProvider {
-    /** An event that's fired when selection changes */
-    selectionChange: SelectionChangeEvent;
-    /** Get the selection stored in the provider.
-     * @param imodel iModel connection which the selection is associated with.
-     * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))
-     */
-    getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { IModelConnection } from "@itwin/core-frontend";
+import { KeySet } from "@itwin/presentation-common";
+import { SelectionChangeEvent } from "./SelectionChangeEvent";
+/**
+ * Selection provider interface which provides main selection and sub-selection.
+ * @public
+ */
+export interface ISelectionProvider {
+    /** An event that's fired when selection changes */
+    selectionChange: SelectionChangeEvent;
+    /** Get the selection stored in the provider.
+     * @param imodel iModel connection which the selection is associated with.
+     * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))
+     */
+    getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;
+}
 //# sourceMappingURL=ISelectionProvider.d.ts.map

package/lib/cjs/presentation-frontend/selection/ISelectionProvider.js

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

package/lib/cjs/presentation-frontend/selection/ISelectionProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISelectionProvider.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/ISelectionProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 UnifiedSelection\n */\n\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { KeySet } from \"@itwin/presentation-common\";\nimport { SelectionChangeEvent } from \"./SelectionChangeEvent\";\n\n/**\n * Selection provider interface which provides main selection and sub-selection.\n * @public\n */\nexport interface ISelectionProvider {\n  /** An event that's fired when selection changes */\n  selectionChange: SelectionChangeEvent;\n\n  /** Get the selection stored in the provider.\n   * @param imodel iModel connection which the selection is associated with.\n   * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))\n   */\n  getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;\n}\n"]}
+{"version":3,"file":"ISelectionProvider.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/ISelectionProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { KeySet } from \"@itwin/presentation-common\";\r\nimport { SelectionChangeEvent } from \"./SelectionChangeEvent\";\r\n\r\n/**\r\n * Selection provider interface which provides main selection and sub-selection.\r\n * @public\r\n */\r\nexport interface ISelectionProvider {\r\n  /** An event that's fired when selection changes */\r\n  selectionChange: SelectionChangeEvent;\r\n\r\n  /** Get the selection stored in the provider.\r\n   * @param imodel iModel connection which the selection is associated with.\r\n   * @param level Level of the selection (see [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels))\r\n   */\r\n  getSelection(imodel: IModelConnection, level: number): Readonly<KeySet>;\r\n}\r\n"]}

package/lib/cjs/presentation-frontend/selection/SelectionChangeEvent.d.ts

@@ -1,53 +1,53 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { KeySet } from "@itwin/presentation-common";
-import { ISelectionProvider } from "./ISelectionProvider";
-/**
- * An interface for selection change listeners.
- * @public
- */
-export declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
-/**
- * An event broadcasted on selection changes
- * @public
- */
-export declare class SelectionChangeEvent extends BeEvent<SelectionChangesListener> {
-}
-/**
- * The type of selection change
- * @public
- */
-export declare enum SelectionChangeType {
-    /** Added to selection. */
-    Add = 0,
-    /** Removed from selection. */
-    Remove = 1,
-    /** Selection was replaced. */
-    Replace = 2,
-    /** Selection was cleared. */
-    Clear = 3
-}
-/**
- * The event object that's sent when the selection changes.
- * @public
- */
-export interface SelectionChangeEventArgs {
-    /** The name of the selection source which caused the selection change. */
-    source: string;
-    /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */
-    level: number;
-    /** The selection change type. */
-    changeType: SelectionChangeType;
-    /** Set of keys affected by this selection change event. */
-    keys: Readonly<KeySet>;
-    /** iModel connection with which the selection is associated with. */
-    imodel: IModelConnection;
-    /** The timestamp of when the selection change happened */
-    timestamp: Date;
-    /** Id of the ruleset associated with the selection change. */
-    rulesetId?: string;
-}
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { KeySet } from "@itwin/presentation-common";
+import { ISelectionProvider } from "./ISelectionProvider";
+/**
+ * An interface for selection change listeners.
+ * @public
+ */
+export declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;
+/**
+ * An event broadcasted on selection changes
+ * @public
+ */
+export declare class SelectionChangeEvent extends BeEvent<SelectionChangesListener> {
+}
+/**
+ * The type of selection change
+ * @public
+ */
+export declare enum SelectionChangeType {
+    /** Added to selection. */
+    Add = 0,
+    /** Removed from selection. */
+    Remove = 1,
+    /** Selection was replaced. */
+    Replace = 2,
+    /** Selection was cleared. */
+    Clear = 3
+}
+/**
+ * The event object that's sent when the selection changes.
+ * @public
+ */
+export interface SelectionChangeEventArgs {
+    /** The name of the selection source which caused the selection change. */
+    source: string;
+    /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */
+    level: number;
+    /** The selection change type. */
+    changeType: SelectionChangeType;
+    /** Set of keys affected by this selection change event. */
+    keys: Readonly<KeySet>;
+    /** iModel connection with which the selection is associated with. */
+    imodel: IModelConnection;
+    /** The timestamp of when the selection change happened */
+    timestamp: Date;
+    /** Id of the ruleset associated with the selection change. */
+    rulesetId?: string;
+}
 //# sourceMappingURL=SelectionChangeEvent.d.ts.map

package/lib/cjs/presentation-frontend/selection/SelectionChangeEvent.js

@@ -1,34 +1,34 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UnifiedSelection
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectionChangeType = exports.SelectionChangeEvent = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/**
- * An event broadcasted on selection changes
- * @public
- */
-class SelectionChangeEvent extends core_bentley_1.BeEvent {
-}
-exports.SelectionChangeEvent = SelectionChangeEvent;
-/**
- * The type of selection change
- * @public
- */
-var SelectionChangeType;
-(function (SelectionChangeType) {
-    /** Added to selection. */
-    SelectionChangeType[SelectionChangeType["Add"] = 0] = "Add";
-    /** Removed from selection. */
-    SelectionChangeType[SelectionChangeType["Remove"] = 1] = "Remove";
-    /** Selection was replaced. */
-    SelectionChangeType[SelectionChangeType["Replace"] = 2] = "Replace";
-    /** Selection was cleared. */
-    SelectionChangeType[SelectionChangeType["Clear"] = 3] = "Clear";
-})(SelectionChangeType = exports.SelectionChangeType || (exports.SelectionChangeType = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectionChangeType = exports.SelectionChangeEvent = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * An event broadcasted on selection changes
+ * @public
+ */
+class SelectionChangeEvent extends core_bentley_1.BeEvent {
+}
+exports.SelectionChangeEvent = SelectionChangeEvent;
+/**
+ * The type of selection change
+ * @public
+ */
+var SelectionChangeType;
+(function (SelectionChangeType) {
+    /** Added to selection. */
+    SelectionChangeType[SelectionChangeType["Add"] = 0] = "Add";
+    /** Removed from selection. */
+    SelectionChangeType[SelectionChangeType["Remove"] = 1] = "Remove";
+    /** Selection was replaced. */
+    SelectionChangeType[SelectionChangeType["Replace"] = 2] = "Replace";
+    /** Selection was cleared. */
+    SelectionChangeType[SelectionChangeType["Clear"] = 3] = "Clear";
+})(SelectionChangeType = exports.SelectionChangeType || (exports.SelectionChangeType = {}));
 //# sourceMappingURL=SelectionChangeEvent.js.map

package/lib/cjs/presentation-frontend/selection/SelectionChangeEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"SelectionChangeEvent.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionChangeEvent.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA8C;AAW9C;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,sBAAiC;CAAI;AAA/E,oDAA+E;AAE/E;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B,0BAA0B;IAC1B,2DAAG,CAAA;IAEH,8BAA8B;IAC9B,iEAAM,CAAA;IAEN,8BAA8B;IAC9B,mEAAO,CAAA;IAEP,6BAA6B;IAC7B,+DAAK,CAAA;AACP,CAAC,EAZW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAY9B","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 UnifiedSelection\n */\n\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { KeySet } from \"@itwin/presentation-common\";\nimport { ISelectionProvider } from \"./ISelectionProvider\";\n\n/**\n * An interface for selection change listeners.\n * @public\n */\nexport declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;\n\n/**\n * An event broadcasted on selection changes\n * @public\n */\nexport class SelectionChangeEvent extends BeEvent<SelectionChangesListener> { }\n\n/**\n * The type of selection change\n * @public\n */\nexport enum SelectionChangeType {\n  /** Added to selection. */\n  Add,\n\n  /** Removed from selection. */\n  Remove,\n\n  /** Selection was replaced. */\n  Replace,\n\n  /** Selection was cleared. */\n  Clear,\n}\n\n/**\n * The event object that's sent when the selection changes.\n * @public\n */\nexport interface SelectionChangeEventArgs {\n  /** The name of the selection source which caused the selection change. */\n  source: string;\n\n  /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */\n  level: number;\n\n  /** The selection change type. */\n  changeType: SelectionChangeType;\n\n  /** Set of keys affected by this selection change event. */\n  keys: Readonly<KeySet>;\n\n  /** iModel connection with which the selection is associated with. */\n  imodel: IModelConnection;\n\n  /** The timestamp of when the selection change happened */\n  timestamp: Date;\n\n  /** Id of the ruleset associated with the selection change. */\n  rulesetId?: string;\n}\n"]}
+{"version":3,"file":"SelectionChangeEvent.js","sourceRoot":"","sources":["../../../../src/presentation-frontend/selection/SelectionChangeEvent.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA8C;AAW9C;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,sBAAiC;CAAI;AAA/E,oDAA+E;AAE/E;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B,0BAA0B;IAC1B,2DAAG,CAAA;IAEH,8BAA8B;IAC9B,iEAAM,CAAA;IAEN,8BAA8B;IAC9B,mEAAO,CAAA;IAEP,6BAA6B;IAC7B,+DAAK,CAAA;AACP,CAAC,EAZW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAY9B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UnifiedSelection\r\n */\r\n\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { KeySet } from \"@itwin/presentation-common\";\r\nimport { ISelectionProvider } from \"./ISelectionProvider\";\r\n\r\n/**\r\n * An interface for selection change listeners.\r\n * @public\r\n */\r\nexport declare type SelectionChangesListener = (args: SelectionChangeEventArgs, provider: ISelectionProvider) => void;\r\n\r\n/**\r\n * An event broadcasted on selection changes\r\n * @public\r\n */\r\nexport class SelectionChangeEvent extends BeEvent<SelectionChangesListener> { }\r\n\r\n/**\r\n * The type of selection change\r\n * @public\r\n */\r\nexport enum SelectionChangeType {\r\n  /** Added to selection. */\r\n  Add,\r\n\r\n  /** Removed from selection. */\r\n  Remove,\r\n\r\n  /** Selection was replaced. */\r\n  Replace,\r\n\r\n  /** Selection was cleared. */\r\n  Clear,\r\n}\r\n\r\n/**\r\n * The event object that's sent when the selection changes.\r\n * @public\r\n */\r\nexport interface SelectionChangeEventArgs {\r\n  /** The name of the selection source which caused the selection change. */\r\n  source: string;\r\n\r\n  /** Level of the selection. See [selection levels documentation section]($docs/presentation/unified-selection/index#selection-levels). */\r\n  level: number;\r\n\r\n  /** The selection change type. */\r\n  changeType: SelectionChangeType;\r\n\r\n  /** Set of keys affected by this selection change event. */\r\n  keys: Readonly<KeySet>;\r\n\r\n  /** iModel connection with which the selection is associated with. */\r\n  imodel: IModelConnection;\r\n\r\n  /** The timestamp of when the selection change happened */\r\n  timestamp: Date;\r\n\r\n  /** Id of the ruleset associated with the selection change. */\r\n  rulesetId?: string;\r\n}\r\n"]}