@itwin/core-frontend 5.0.0-dev.4 → 5.0.0-dev.41

package/lib/esm/SelectionSet.d.ts

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

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

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