@itwin/core-frontend 5.1.0-dev.7 → 5.1.0-dev.71

package/lib/esm/tools/ElementSetTool.d.ts

@@ -2,7 +2,7 @@
  * @module Tools
  */
 import { CompressedId64Set, Id64Arg, Id64Array, Id64String, OrderedId64Array } from "@itwin/core-bentley";
-import { Point3d } from "@itwin/core-geometry";
+import { Point3d, XAndY } from "@itwin/core-geometry";
 import { LocateFilterStatus, LocateResponse } from "../ElementLocateManager";
 import { HitDetail } from "../HitDetail";
 import { IModelConnection } from "../IModelConnection";
@@ -206,6 +206,14 @@ export declare abstract class ElementSetTool extends PrimitiveTool {
      * @see [[ElementSetTool.getLocateCandidates]] to add additional elements.
      */
     protected buildLocateAgenda(hit: HitDetail): Promise<boolean>;
+    /** Get ids of spatial elements to process from a clip volume created by drag box selection. */
+    private static getVolumeSelectionCandidates;
+    /** Get ids of visible elements to process from drag box or crossing line selection. */
+    private static getAreaSelectionCandidates;
+    /** Get ids of elements to process from drag box or crossing line selection using either the depth buffer or clip vector...
+     * @internal
+     */
+    static getAreaOrVolumeSelectionCandidates(vp: Viewport, origin: XAndY, corner: XAndY, method: SelectionMethod, allowOverlaps: boolean, filter?: (id: Id64String) => boolean, includeDecorationsForVolume?: boolean): Promise<Set<Id64String>>;
     /** Get element ids to process from drag box or crossing line selection.
      * Sub-classes may override to support selection scopes or apply tool specific filtering.
      */

package/lib/esm/tools/ElementSetTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ElementSetTool.d.ts","sourceRoot":"","sources":["../../../src/tools/ElementSetTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAQ,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEhH,OAAO,EAAW,OAAO,EAAW,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAY,aAAa,EAAE,cAAc,EAAa,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC1F,OAAO,EAAkE,yBAAyB,EAAyB,MAAM,kBAAkB,CAAC;AAEpJ;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,oFAAoF;IACpF,OAAO,IAAI;IACX,2CAA2C;IAC3C,QAAQ,IAAI;IACZ,mEAAmE;IACnE,YAAY,IAAI,CAAE,mDAAmD;IACrE,qFAAqF;IACrF,UAAU,IAAI;CACf;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;;EAIE;AACF,qBAAa,aAAa;IAUE,MAAM,EAAE,gBAAgB;IATlD;;OAEG;IACH,SAAgB,QAAQ,EAAE,SAAS,CAAM;IACzC;;OAEG;IACH,SAAgB,UAAU,EAAE,SAAS,EAAE,CAAM;IACtC,iBAAiB,UAAQ;gBACN,MAAM,EAAE,gBAAgB;IAElD,iKAAiK;IAC1J,SAAS;IAIhB,8DAA8D;IACvD,SAAS,CAAC,GAAG,EAAE,mBAAmB;IAKzC,IAAW,OAAO,YAAgC;IAClD,IAAW,KAAK,WAA0B;IAC1C,IAAW,MAAM,WAAmC;IAEpD,+CAA+C;IACxC,QAAQ,IAAI,gBAAgB;IAMnC,gDAAgD;IACzC,WAAW,IAAI,iBAAiB;IAKvC,iFAAiF;IAC1E,KAAK;IAMZ,OAAO,CAAC,qBAAqB;IAoB7B,+DAA+D;IACxD,QAAQ;IAUf,0DAA0D;IACnD,GAAG,CAAC,EAAE,EAAE,MAAM;IAErB,0DAA0D;IACnD,IAAI,CAAC,EAAE,EAAE,UAAU;IAE1B,mCAAmC;IAC5B,GAAG,CAAC,GAAG,EAAE,OAAO;IAevB,OAAO,CAAC,SAAS;IAmEV,MAAM,CAAC,GAAG,EAAE,OAAO;IAe1B,4FAA4F;IACrF,MAAM,CAAC,GAAG,EAAE,OAAO;CA+B3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,cAAe,SAAQ,aAAa;IACxD,OAAO,CAAC,OAAO,CAAC,CAAgB;IAChC,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,mFAAmF;IACnF,SAAS,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAChC,8EAA8E;IAC9E,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAEnC,0DAA0D;IAC1D,SAAS,KAAK,MAAM,IAAI,aAAa,CAIpC;IAED,8EAA8E;IAC9E,SAAS,KAAK,mBAAmB,IAAI,MAAM,CAAgE;IAE3G;;;OAGG;IACH,SAAS,KAAK,oBAAoB,IAAI,MAAM,CAAc;IAE1D;;;;OAIG;IACH,SAAS,KAAK,eAAe,IAAI,OAAO,CAAkB;IAE1D;;;OAGG;IACH,SAAS,KAAK,WAAW,IAAI,OAAO,CAAkB;IAEtD;;;OAGG;IACH,SAAS,KAAK,iBAAiB,IAAI,OAAO,CAAkB;IAE5D;;;;OAIG;IACH,SAAS,KAAK,iBAAiB,IAAI,OAAO,CAAoC;IAE9E;;;OAGG;IACH,SAAS,KAAK,qCAAqC,IAAI,OAAO,CAAiB;IAE/E;;;OAGG;IACH,SAAS,KAAK,oCAAoC,IAAI,OAAO,CAAiB;IAE9E;;OAEG;IACH,SAAS,KAAK,oBAAoB,IAAI,OAAO,CAAkC;IAE/E;;OAEG;IACH,SAAS,KAAK,gBAAgB,IAAI,OAAO,CAA8C;IAEvF;;OAEG;IACH,SAAS,KAAK,4BAA4B,IAAI,OAAO,CAAkB;IAEvE;;OAEG;IACH,SAAS,KAAK,0BAA0B,IAAI,OAAO,CAA8C;IAEjG;;;OAGG;IACH,SAAS,KAAK,YAAY,IAAI,OAAO,CAAkB;IAEvD;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,OAAO,CAAkB;IAEvD;;OAEG;IACH,SAAS,KAAK,sBAAsB,IAAI,OAAO,CAS9C;IAED;;;;OAIG;IACH,SAAS,KAAK,mBAAmB,IAAI,OAAO,CAA2D;IAEvG;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAExD;;MAEE;IACF,SAAS,CAAC,yBAAyB,IAAI,IAAI;IAoB3C;;OAEG;cACa,yBAAyB,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAU7E;;OAEG;cACa,uBAAuB,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAa3E,6EAA6E;cAC7D,WAAW,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB7D;;OAEG;cACa,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE;;OAEG;cACa,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBnE;;OAEG;cACa,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAuFpJ;;OAEG;cACa,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBlJ,qHAAqH;IACrH,SAAS,CAAC,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO;IAahF,gHAAgH;cAChG,0BAA0B,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG,oHAAoH;IAC9F,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAYlG;;;OAGG;cACa,QAAQ,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBjF;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO;IASzD,uDAAuD;cACvC,mBAAmB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAYxE,kHAAkH;cAClG,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBtE,6DAA6D;IAC7D,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IA0ChE,uDAAuD;IACvC,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAExD,sEAAsE;IAChD,aAAa,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrE,mHAAmH;IAC7F,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAMhF,6GAA6G;IACvF,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAM9E,+FAA+F;IACzE,uBAAuB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAiBzI;;;OAGG;cACa,aAAa,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAmCvE;;OAEG;cACa,kBAAkB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAOtD,eAAe,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzD,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIjF,4EAA4E;cAC5D,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA0BpF,0EAA0E;cAC1D,WAAW,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAqBjF;;;;;OAKG;cACa,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAkBrD,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;cAIhE,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAOtD;;;MAGE;cACc,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjD,6HAA6H;cAC7G,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAElD,2KAA2K;cAC3J,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEvD;;OAEG;cACa,aAAa,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhE,0JAA0J;cAC1I,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/D,yEAAyE;IACnD,aAAa;IASnC,oHAAoH;IAC9F,SAAS;IAM/B;;OAEG;IACmB,cAAc;IAOpC,8GAA8G;IACxF,WAAW;IAIjC,SAAS,KAAK,kBAAkB,IAAI,OAAO,CAAwE;IACnH,SAAS,KAAK,gBAAgB,IAAI,OAAO,CAA+J;IAExM,yEAAyE;IACzE,SAAS,CAAC,2BAA2B,IAAI,IAAI;IAK7C,yEAAyE;IACzE,SAAS,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,yBAAyB,EAAE,GAAG,IAAI;CA0E7G"}
+{"version":3,"file":"ElementSetTool.d.ts","sourceRoot":"","sources":["../../../src/tools/ElementSetTool.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAiB,iBAAiB,EAAQ,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE/H,OAAO,EAA0G,OAAO,EAAqB,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAEjL,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAY,aAAa,EAAE,cAAc,EAAa,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC1F,OAAO,EAAkE,yBAAyB,EAAyB,MAAM,kBAAkB,CAAC;AAGpJ;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,oFAAoF;IACpF,OAAO,IAAI;IACX,2CAA2C;IAC3C,QAAQ,IAAI;IACZ,mEAAmE;IACnE,YAAY,IAAI,CAAE,mDAAmD;IACrE,qFAAqF;IACrF,UAAU,IAAI;CACf;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;;EAIE;AACF,qBAAa,aAAa;IAUE,MAAM,EAAE,gBAAgB;IATlD;;OAEG;IACH,SAAgB,QAAQ,EAAE,SAAS,CAAM;IACzC;;OAEG;IACH,SAAgB,UAAU,EAAE,SAAS,EAAE,CAAM;IACtC,iBAAiB,UAAQ;gBACN,MAAM,EAAE,gBAAgB;IAElD,iKAAiK;IAC1J,SAAS;IAIhB,8DAA8D;IACvD,SAAS,CAAC,GAAG,EAAE,mBAAmB;IAKzC,IAAW,OAAO,YAAgC;IAClD,IAAW,KAAK,WAA0B;IAC1C,IAAW,MAAM,WAAmC;IAEpD,+CAA+C;IACxC,QAAQ,IAAI,gBAAgB;IAMnC,gDAAgD;IACzC,WAAW,IAAI,iBAAiB;IAKvC,iFAAiF;IAC1E,KAAK;IAMZ,OAAO,CAAC,qBAAqB;IAoB7B,+DAA+D;IACxD,QAAQ;IAaf,0DAA0D;IACnD,GAAG,CAAC,EAAE,EAAE,MAAM;IAErB,0DAA0D;IACnD,IAAI,CAAC,EAAE,EAAE,UAAU;IAE1B,mCAAmC;IAC5B,GAAG,CAAC,GAAG,EAAE,OAAO;IAevB,OAAO,CAAC,SAAS;IAmEV,MAAM,CAAC,GAAG,EAAE,OAAO;IAe1B,4FAA4F;IACrF,MAAM,CAAC,GAAG,EAAE,OAAO;CA+B3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,cAAe,SAAQ,aAAa;IACxD,OAAO,CAAC,OAAO,CAAC,CAAgB;IAChC,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,mFAAmF;IACnF,SAAS,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAChC,8EAA8E;IAC9E,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAEnC,0DAA0D;IAC1D,SAAS,KAAK,MAAM,IAAI,aAAa,CAIpC;IAED,8EAA8E;IAC9E,SAAS,KAAK,mBAAmB,IAAI,MAAM,CAAgE;IAE3G;;;OAGG;IACH,SAAS,KAAK,oBAAoB,IAAI,MAAM,CAAc;IAE1D;;;;OAIG;IACH,SAAS,KAAK,eAAe,IAAI,OAAO,CAAkB;IAE1D;;;OAGG;IACH,SAAS,KAAK,WAAW,IAAI,OAAO,CAAkB;IAEtD;;;OAGG;IACH,SAAS,KAAK,iBAAiB,IAAI,OAAO,CAAkB;IAE5D;;;;OAIG;IACH,SAAS,KAAK,iBAAiB,IAAI,OAAO,CAAoC;IAE9E;;;OAGG;IACH,SAAS,KAAK,qCAAqC,IAAI,OAAO,CAAiB;IAE/E;;;OAGG;IACH,SAAS,KAAK,oCAAoC,IAAI,OAAO,CAAiB;IAE9E;;OAEG;IACH,SAAS,KAAK,oBAAoB,IAAI,OAAO,CAAkC;IAE/E;;OAEG;IACH,SAAS,KAAK,gBAAgB,IAAI,OAAO,CAA8C;IAEvF;;OAEG;IACH,SAAS,KAAK,4BAA4B,IAAI,OAAO,CAAkB;IAEvE;;OAEG;IACH,SAAS,KAAK,0BAA0B,IAAI,OAAO,CAA8C;IAEjG;;;OAGG;IACH,SAAS,KAAK,YAAY,IAAI,OAAO,CAAkB;IAEvD;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,OAAO,CAAkB;IAEvD;;OAEG;IACH,SAAS,KAAK,sBAAsB,IAAI,OAAO,CAS9C;IAED;;;;OAIG;IACH,SAAS,KAAK,mBAAmB,IAAI,OAAO,CAA2D;IAEvG;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAExD;;MAEE;IACF,SAAS,CAAC,yBAAyB,IAAI,IAAI;IAoB3C;;OAEG;cACa,yBAAyB,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAU7E;;OAEG;cACa,uBAAuB,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAa3E,6EAA6E;cAC7D,WAAW,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB7D;;OAEG;cACa,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE;;OAEG;cACa,iBAAiB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBnE,+FAA+F;mBAC1E,4BAA4B;IAuHjD,uFAAuF;IACvF,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAsFzC;;OAEG;WACiB,kCAAkC,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,UAAU,KAAK,OAAO,EAAE,2BAA2B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAoB1P;;OAEG;cACa,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAKpJ;;OAEG;cACa,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBlJ,qHAAqH;IACrH,SAAS,CAAC,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO;IAahF,gHAAgH;cAChG,0BAA0B,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG,oHAAoH;IAC9F,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAYlG;;;OAGG;cACa,QAAQ,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBjF;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO;IASzD,uDAAuD;cACvC,mBAAmB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAYxE,kHAAkH;cAClG,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBtE,6DAA6D;IAC7D,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IA0ChE,uDAAuD;IACvC,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAExD,sEAAsE;IAChD,aAAa,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrE,mHAAmH;IAC7F,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAMhF,6GAA6G;IACvF,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAM9E,+FAA+F;IACzE,uBAAuB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAiBzI;;;OAGG;cACa,aAAa,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAmCvE;;OAEG;cACa,kBAAkB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAOtD,eAAe,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzD,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIjF,4EAA4E;cAC5D,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA0BpF,0EAA0E;cAC1D,WAAW,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAqBjF;;;;;OAKG;cACa,iBAAiB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAkBrD,cAAc,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD,gBAAgB,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;cAIhE,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAOtD;;;MAGE;cACc,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjD,6HAA6H;cAC7G,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAElD,2KAA2K;cAC3J,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEvD;;OAEG;cACa,aAAa,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhE,0JAA0J;cAC1I,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/D,yEAAyE;IACnD,aAAa;IASnC,oHAAoH;IAC9F,SAAS;IAM/B;;OAEG;IACmB,cAAc;IAOpC,8GAA8G;IACxF,WAAW;IAIjC,SAAS,KAAK,kBAAkB,IAAI,OAAO,CAAwE;IACnH,SAAS,KAAK,gBAAgB,IAAI,OAAO,CAA+J;IAExM,yEAAyE;IACzE,SAAS,CAAC,2BAA2B,IAAI,IAAI;IAK7C,yEAAyE;IACzE,SAAS,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,yBAAyB,EAAE,GAAG,IAAI;CA0E7G"}

package/lib/esm/tools/ElementSetTool.js

@@ -5,9 +5,9 @@
 /** @packageDocumentation
  * @module Tools
  */
-import { CompressedId64Set, Id64, OrderedId64Array } from "@itwin/core-bentley";
+import { BentleyStatus, CompressedId64Set, Id64, OrderedId64Array } from "@itwin/core-bentley";
 import { ColorDef, QueryRowFormat } from "@itwin/core-common";
-import { Point2d, Range2d } from "@itwin/core-geometry";
+import { ClipPlane, ClipPlaneContainment, ClipPrimitive, ClipUtilities, ClipVector, ConvexClipPlaneSet, Point2d, Point3d, Range2d } from "@itwin/core-geometry";
 import { AccuDrawHintBuilder } from "../AccuDraw";
 import { LocateFilterStatus, LocateResponse } from "../ElementLocateManager";
 import { IModelApp } from "../IModelApp";
@@ -18,6 +18,7 @@ import { PrimitiveTool } from "./PrimitiveTool";
 import { SelectionMethod } from "./SelectTool";
 import { BeButton, BeButtonEvent, BeModifierKeys, CoreTools, EventHandled } from "./Tool";
 import { ToolAssistance, ToolAssistanceImage, ToolAssistanceInputMethod } from "./ToolAssistance";
+import { ToolSettings } from "./ToolSettings";
 /** Identifies the source of the elements in the agenda.
  * @public
  */
@@ -103,6 +104,8 @@ export class ElementAgenda {
             return;
         }
         const group = this.groupMarks.pop();
+        if (undefined === group)
+            return;
         this.setEntriesHiliteState(false, group.start, this.length); // make sure removed entries aren't left hilited...
         this.elements.splice(group.start);
     }
@@ -415,12 +418,105 @@ export class ElementSetTool extends PrimitiveTool {
         await this.onAgendaModified();
         return true;
     }
-    /** Get element ids to process from drag box or crossing line selection.
-     * Sub-classes may override to support selection scopes or apply tool specific filtering.
-     */
-    async getDragSelectCandidates(vp, origin, corner, method, overlap) {
+    /** Get ids of spatial elements to process from a clip volume created by drag box selection. */
+    static async getVolumeSelectionCandidates(vp, origin, corner, allowOverlaps, filter) {
+        const contents = new Set();
+        if (!vp.view.isSpatialView())
+            return contents;
+        const boxRange = Range2d.createXYXY(origin.x, origin.y, corner.x, corner.y);
+        if (boxRange.isNull || boxRange.isAlmostZeroX || boxRange.isAlmostZeroY)
+            return contents;
+        const getClipPlane = (viewPt, viewDir, negate) => {
+            const point = vp.viewToWorld(Point3d.createFrom(viewPt));
+            const boresite = AccuDrawHintBuilder.getBoresite(point, vp);
+            const normal = viewDir.crossProduct(boresite.direction);
+            if (negate)
+                normal.negate(normal);
+            return ClipPlane.createNormalAndPoint(normal, point);
+        };
+        const planeSet = ConvexClipPlaneSet.createEmpty();
+        planeSet.addPlaneToConvexSet(getClipPlane(boxRange.low, vp.rotation.rowX(), true));
+        planeSet.addPlaneToConvexSet(getClipPlane(boxRange.low, vp.rotation.rowY(), true));
+        planeSet.addPlaneToConvexSet(getClipPlane(boxRange.high, vp.rotation.rowX(), false));
+        planeSet.addPlaneToConvexSet(getClipPlane(boxRange.high, vp.rotation.rowY(), false));
+        if (0 === planeSet.planes.length)
+            return contents;
+        const clip = ClipVector.createCapture([ClipPrimitive.createCapture(planeSet)]);
+        const viewRange = vp.computeViewRange();
+        const range = ClipUtilities.rangeOfClipperIntersectionWithRange(clip, viewRange);
+        if (range.isNull)
+            return contents;
+        // TODO: Possible to make UnionOfComplexClipPlaneSets from view clip and planes work and remove 2nd containment check?
+        const viewClip = (vp.viewFlags.clipVolume ? vp.view.getViewClip()?.clone() : undefined);
+        if (viewClip) {
+            const viewClipRange = ClipUtilities.rangeOfClipperIntersectionWithRange(viewClip, viewRange);
+            if (viewClipRange.isNull || !viewClipRange.intersectsRange(range))
+                return contents;
+        }
+        const candidates = [];
+        const categories = new Set();
+        try {
+            const viewedModels = [...vp.view.modelSelector.models].join(",");
+            const viewedCategories = [...vp.view.categorySelector.categories].join(",");
+            const ecsql = `SELECT e.ECInstanceId, Category.Id as category FROM bis.SpatialElement e JOIN bis.SpatialIndex i ON e.ECInstanceId=i.ECInstanceId WHERE Model.Id IN (${viewedModels}) AND Category.Id IN (${viewedCategories}) AND i.MinX <= ${range.xHigh} AND i.MinY <= ${range.yHigh} AND i.MinZ <= ${range.zHigh} AND i.MaxX >= ${range.xLow} AND i.MaxY >= ${range.yLow} AND i.MaxZ >= ${range.zLow}`;
+            const reader = vp.iModel.createQueryReader(ecsql, undefined, { rowFormat: QueryRowFormat.UseECSqlPropertyNames });
+            for await (const row of reader) {
+                candidates.push(row.ECInstanceId);
+                categories.add(row.category);
+            }
+        }
+        catch { }
+        if (0 === candidates.length)
+            return contents;
+        let offSubCategories;
+        if (0 !== categories.size) {
+            for (const categoryId of categories) {
+                const subcategories = vp.iModel.subcategories.getSubCategories(categoryId);
+                if (undefined === subcategories)
+                    continue;
+                for (const subCategoryId of subcategories) {
+                    const appearance = vp.iModel.subcategories.getSubCategoryAppearance(subCategoryId);
+                    if (undefined === appearance || (!appearance.invisible && !appearance.dontLocate))
+                        continue;
+                    if (undefined === offSubCategories)
+                        offSubCategories = new Array;
+                    offSubCategories.push(subCategoryId);
+                }
+            }
+        }
+        const requestProps = {
+            candidates,
+            clip: clip.toJSON(),
+            allowOverlaps,
+            viewFlags: vp.viewFlags.toJSON(),
+            offSubCategories,
+        };
+        const result = await vp.iModel.getGeometryContainment(requestProps);
+        if (BentleyStatus.SUCCESS !== result.status || undefined === result.candidatesContainment)
+            return contents;
+        result.candidatesContainment.forEach((status, index) => {
+            if (ClipPlaneContainment.StronglyOutside !== status && (undefined === filter || filter(candidates[index])))
+                contents.add(candidates[index]);
+        });
+        if (0 !== contents.size && viewClip) {
+            requestProps.clip = viewClip.toJSON();
+            requestProps.candidates.length = 0;
+            for (const id of contents)
+                requestProps.candidates.push(id);
+            contents.clear();
+            const resultViewClip = await vp.iModel.getGeometryContainment(requestProps);
+            if (BentleyStatus.SUCCESS !== resultViewClip.status || undefined === resultViewClip.candidatesContainment)
+                return contents;
+            resultViewClip.candidatesContainment.forEach((status, index) => {
+                if (ClipPlaneContainment.StronglyOutside !== status)
+                    contents.add(candidates[index]);
+            });
+        }
+        return contents;
+    }
+    /** Get ids of visible elements to process from drag box or crossing line selection. */
+    static getAreaSelectionCandidates(vp, origin, corner, method, allowOverlaps, filter) {
         let contents = new Set();
-        // TODO: Include option to use IModelConnection.getGeometryContainment instead of readPixels. No/Yes/2dOnly...
         const pts = [];
         pts[0] = new Point2d(Math.floor(origin.x + 0.5), Math.floor(origin.y + 0.5));
         pts[1] = new Point2d(Math.floor(corner.x + 0.5), Math.floor(corner.y + 0.5));
@@ -443,12 +539,12 @@ export class ElementSetTool extends PrimitiveTool {
                     return undefined; // no geometry at this location...
                 if (!vp.isPixelSelectable(pixel))
                     return undefined; // reality model, terrain, etc - not selectable
-                if (!this.isElementIdValid(pixel.elementId, ModifyElementSource.DragSelect))
+                if (undefined !== filter && !filter(pixel.elementId))
                     return undefined;
                 return pixel.elementId;
             };
             if (SelectionMethod.Box === method) {
-                const outline = overlap ? undefined : new Set();
+                const outline = allowOverlaps ? undefined : new Set();
                 const offset = sRange.clone();
                 offset.expandInPlace(-2);
                 for (testPoint.x = sRange.low.x; testPoint.x <= sRange.high.x; ++testPoint.x) {
@@ -490,6 +586,33 @@ export class ElementSetTool extends PrimitiveTool {
         }, true);
         return contents;
     }
+    /** Get ids of elements to process from drag box or crossing line selection using either the depth buffer or clip vector...
+     * @internal
+     */
+    static async getAreaOrVolumeSelectionCandidates(vp, origin, corner, method, allowOverlaps, filter, includeDecorationsForVolume) {
+        let contents;
+        if (ToolSettings.enableVolumeSelection && SelectionMethod.Box === method && vp.view.isSpatialView()) {
+            contents = await ElementSetTool.getVolumeSelectionCandidates(vp, origin, corner, allowOverlaps, filter);
+            // Use area select to identify pickable transients...
+            if (includeDecorationsForVolume) {
+                const acceptTransientsFilter = (id) => { return Id64.isTransient(id) && (undefined === filter || filter(id)); };
+                const transients = ElementSetTool.getAreaSelectionCandidates(vp, origin, corner, method, allowOverlaps, acceptTransientsFilter);
+                for (const id of transients)
+                    contents.add(id);
+            }
+        }
+        else {
+            contents = ElementSetTool.getAreaSelectionCandidates(vp, origin, corner, method, allowOverlaps, filter);
+        }
+        return contents;
+    }
+    /** Get element ids to process from drag box or crossing line selection.
+     * Sub-classes may override to support selection scopes or apply tool specific filtering.
+     */
+    async getDragSelectCandidates(vp, origin, corner, method, overlap) {
+        const filter = (id) => { return this.isElementIdValid(id, ModifyElementSource.DragSelect); };
+        return ElementSetTool.getAreaOrVolumeSelectionCandidates(vp, origin, corner, method, overlap, filter, IModelApp.locateManager.options.allowDecorations);
+    }
     /** Populate [[ElementSetTool.agenda]] by drag box or crossing line information.
      * @see [[ElementSetTool.getDragSelectCandidates]] to filter or augment the set of elements.
      */