@itwin/core-frontend 4.1.0-dev.6 → 4.1.0-dev.62

package/lib/esm/GeoServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeoServices.js","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qBAAqB;AACrB,OAAO,EACL,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,GACjD,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACwB,cAAc,EAAsD,sBAAsB,GACxH,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAclE,SAAS,aAAa,CAAC,GAAW,EAAE,GAAW;IAC7C,OAAO,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,mBAAmB;IAepB,QAAQ,CAAC,KAAe,EAAE,MAAsB;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC1B;aAAM;YACL,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAmB,IAAgC;QA3BzC,WAAM,GAA6B,MAAM,CAAC;QAKpD,kDAAkD;QACxC,iBAAY,GAAG,IAAI,OAAO,EAAc,CAAC;QACnD,oGAAoG;QACjF,gBAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QAoBpD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,mBAAmB,IAAI,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAA0B,aAAa,EAAE,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,WAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9E,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YAClD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO;SACR;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,uFAAuF;QACvF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,EAAc,CAAC;QAE9C,+HAA+H;QAC/H,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,kGAAkG;QAClG,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,EAAE;YACnE,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,YAAY,EAAE,CAAC;YACjF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7D,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ;oBACvB,OAAO;gBAET,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;oBACpC,MAAM,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,OAAO,cAAc,EAAE,2BAA2B,QAAQ,CAAC,MAAM,yBAAyB,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC;gBAE/J,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACvC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM;wBACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC5C;YACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACf,MAAM,CAAC,YAAY,CAAC,GAAG,sBAAsB,CAAC,OAAO,cAAc,EAAE,GAAG,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEvB,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO;YACxB,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,8DAA8D;QAEzF,kEAAkE;QAClE,WAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,+DAA+D;IAC/D,gDAAgD;IACtC,OAAO,CAAC,MAAkB;QAClC,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;gBACtB,EAAE,UAAU,CAAC;iBACV,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,0HAA0H;IAC1H,2EAA2E;IACjE,YAAY,CAAC,MAAkB;QACvC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,UAAU,EAAE,CAAC;YAE3D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACtB;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC9B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;YAC1B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,8DAA8D;YACjF,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;QACvB,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM;YAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;QAE1D,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAEM,UAAU,CAAC,MAAkB;QAClC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,OAA+B,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE;gBACX,IAAI,CAAC,OAAO;oBACV,OAAO,GAAG,EAAE,CAAC;gBAEf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;CACF;AAYD;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAIvB,gBAAgB;IAChB,YAAY,MAAwB,EAAE,WAAwC;QAC5E,MAAM,KAAK,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;QAE1F,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,MAAM;YACN,aAAa,EAAE,KAAK,EAAE,SAAmB,EAAE,EAAE;gBAC3C,MAAM,OAAO,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBAC7C,MAAM,GAAG,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,YAAY,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,MAAM;YACN,aAAa,EAAE,KAAK,EAAE,YAAsB,EAAE,EAAE;gBAC9C,MAAM,OAAO,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;gBAChD,MAAM,GAAG,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,SAAS,CAAC;YAC5B,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,qBAAqB,CAAC,SAAqB;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,uBAAuB,CAAC,YAAwB;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,YAAY,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,SAAqB;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,MAAM;YAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,YAAwB;QAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC7D,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,MAAM;YACxB,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,4CAA4C,CAAC,SAAqB;QACvE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,WAAW;IAGtB,gBAAgB;IAChB,YAAY,MAAwB;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,WAAyC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelConnection\r\n */\r\n\r\n// cspell:ignore GCRS\r\nimport {\r\n  assert, BeEvent, Dictionary, Logger, SortedArray,\r\n} from \"@itwin/core-bentley\";\r\nimport { WritableXYAndZ, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\nimport {\r\n  GeoCoordinatesResponseProps, GeoCoordStatus, GeographicCRSProps, IModelCoordinatesResponseProps, IModelReadRpcInterface, PointWithStatus,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { FrontendLoggerCategory } from \"./FrontendLoggerCategory\";\r\n\r\n/** Options used to create a [[CoordinateConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface CoordinateConverterOptions {\r\n  /** The iModel for which to perform the conversions. */\r\n  iModel: IModelConnection;\r\n  /** Asynchronously convert each point. The resultant array should have the same number and order of points as the input. */\r\n  requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  /** Maximum number of points to include in each request. Default: 300. */\r\n  maxPointsPerRequest?: number;\r\n}\r\n\r\nfunction compareXYAndZ(lhs: XYAndZ, rhs: XYAndZ): number {\r\n  return lhs.x - rhs.x || lhs.y - rhs.y || lhs.z - rhs.z;\r\n}\r\n\r\nfunction cloneXYAndZ(xyz: XYAndZ): XYAndZ {\r\n  return { x: xyz.x, y: xyz.y, z: xyz.z };\r\n}\r\n\r\ntype CoordinateConverterState =\r\n  // No pending requests.\r\n  \"idle\" |\r\n  // We have scheduled a requestAnimationFrame to dispatch all pending requests.\r\n  \"scheduled\" |\r\n  // We have dispatched all requests that were pending at the most recent requestAnimationFrame callback.\r\n  \"in-flight\";\r\n\r\n/** Performs conversion of coordinates from one coordinate system to another.\r\n * A [[GeoConverter]] has a pair of these for converting between iModel coordinates and geographic coordinates.\r\n * Uses a cache to avoid repeatedly requesting the same points, and a batching strategy to avoid making frequent small requests.\r\n * The cache stores every point that was ever converted by [[convert]]. It is currently permitted to grow to unbounded size.\r\n * The batching works as follows:\r\n *  When a conversion is requested via [[convert]], if all the requested points are in the cache, they are returned immediately.\r\n *  Otherwise, any points not in the cache and not in the current in-flight request (if any) are placed onto the queue of pending requests.\r\n *  A pending request is scheduled if one hasn't already been scheduled, via requestAnimationFrame.\r\n *  In the animation frame callback, the pending requests are split into batches of no more than options.maxPointsPerRequest and dispatched to the backend.\r\n *  Once the response is received, the results are loaded into and returned from the cache.\r\n *  If more calls to convert occurred while the request was in flight, another request is dispatched.\r\n * @internal exported strictly for tests.\r\n */\r\nexport class CoordinateConverter {\r\n  protected readonly _cache: Dictionary<XYAndZ, PointWithStatus>;\r\n  protected _state: CoordinateConverterState = \"idle\";\r\n  // The accumulated set of points to be converted by the next request.\r\n  protected _pending: SortedArray<XYAndZ>;\r\n  // The set of points that were included in the current in-flight request, if any.\r\n  protected _inflight: SortedArray<XYAndZ>;\r\n  // An event fired when the next request completes.\r\n  protected _onCompleted = new BeEvent<() => void>();\r\n  // Used for creating cache keys (XYAndZ) from XYZProps without having to allocate temporary objects.\r\n  protected readonly _scratchXYZ = { x: 0, y: 0, z: 0 };\r\n  protected readonly _maxPointsPerRequest: number;\r\n  protected readonly _iModel: IModelConnection;\r\n  protected readonly _requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n\r\n  protected toXYAndZ(input: XYZProps, output: WritableXYAndZ): XYAndZ {\r\n    if (Array.isArray(input)) {\r\n      output.x = input[0] ?? 0;\r\n      output.y = input[1] ?? 0;\r\n      output.z = input[2] ?? 0;\r\n    } else {\r\n      output.x = input.x ?? 0;\r\n      output.y = input.y ?? 0;\r\n      output.z = input.z ?? 0;\r\n    }\r\n\r\n    return output;\r\n  }\r\n\r\n  public constructor(opts: CoordinateConverterOptions) {\r\n    this._maxPointsPerRequest = Math.max(1, opts.maxPointsPerRequest ?? 300);\r\n    this._iModel = opts.iModel;\r\n    this._requestPoints = opts.requestPoints;\r\n\r\n    this._cache = new Dictionary<XYAndZ, PointWithStatus>(compareXYAndZ, cloneXYAndZ);\r\n    this._pending = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n    this._inflight = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n  }\r\n\r\n  protected async dispatch(): Promise<void> {\r\n    assert(this._state === \"scheduled\");\r\n    if (this._iModel.isClosed || this._pending.isEmpty) {\r\n      this._state = \"idle\";\r\n      this._onCompleted.raiseEvent();\r\n      return;\r\n    }\r\n\r\n    this._state = \"in-flight\";\r\n\r\n    // Ensure subsequently-enqueued requests listen for the *next* response to be received.\r\n    const onCompleted = this._onCompleted;\r\n    this._onCompleted = new BeEvent<() => void>();\r\n\r\n    // Pending requests are now in flight. Start a new list of pending requests. It's cheaper to swap than to allocate new objects.\r\n    const inflight = this._pending;\r\n    this._pending = this._inflight;\r\n    assert(this._pending.isEmpty);\r\n    this._inflight = inflight;\r\n\r\n    // Split requests if necessary to avoid requesting more than the maximum allowed number of points.\r\n    const promises: Array<Promise<void>> = [];\r\n    for (let i = 0; i < inflight.length; i += this._maxPointsPerRequest) {\r\n      const requests = inflight.slice(i, i + this._maxPointsPerRequest).extractArray();\r\n      const promise = this._requestPoints(requests).then((results) => {\r\n        if (this._iModel.isClosed)\r\n          return;\r\n\r\n        if (results.length !== requests.length)\r\n          Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, `requested conversion of ${requests.length} points, but received ${results.length} points`);\r\n\r\n        for (let j = 0; j < results.length; j++) {\r\n          if (j < requests.length)\r\n            this._cache.set(requests[j], results[j]);\r\n        }\r\n      }).catch((err) => {\r\n        Logger.logException(`${FrontendLoggerCategory.Package}.geoservices`, err);\r\n      });\r\n\r\n      promises.push(promise);\r\n    }\r\n\r\n    await Promise.all(promises);\r\n\r\n    assert(this._state === \"in-flight\");\r\n    this._state = \"idle\";\r\n    this._inflight.clear();\r\n\r\n    // If any more pending conversions arrived while awaiting this request, schedule another request.\r\n    if (!this._pending.isEmpty)\r\n      this.scheduleDispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n\r\n    // Resolve promises of all callers who were awaiting this request.\r\n    onCompleted.raiseEvent();\r\n  }\r\n\r\n  // Add any points not present in cache to pending request list.\r\n  // Return the number of points present in cache.\r\n  protected enqueue(points: XYZProps[]): number {\r\n    let numInCache = 0;\r\n    for (const point of points) {\r\n      const xyz = this.toXYAndZ(point, this._scratchXYZ);\r\n      if (this._cache.get(xyz))\r\n        ++numInCache;\r\n      else if (!this._inflight.contains(xyz))\r\n        this._pending.insert(xyz);\r\n    }\r\n\r\n    return numInCache;\r\n  }\r\n\r\n  // Obtain converted points from the cache. The assumption is that every point in `inputs` is already present in the cache.\r\n  // Any point not present will be returned unconverted with an error status.\r\n  protected getFromCache(inputs: XYZProps[]): PointWithStatus[] {\r\n    const outputs: PointWithStatus[] = [];\r\n    for (const input of inputs) {\r\n      const xyz = this.toXYAndZ(input, this._scratchXYZ);\r\n      let output = this._cache.get(xyz);\r\n      if (!output)\r\n        output = { p: { ...xyz }, s: GeoCoordStatus.CSMapError };\r\n\r\n      outputs.push(output);\r\n    }\r\n\r\n    return outputs;\r\n  }\r\n\r\n  protected async scheduleDispatch(): Promise<void> {\r\n    if (\"idle\" === this._state) {\r\n      this._state = \"scheduled\";\r\n      requestAnimationFrame(() => {\r\n        this.dispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      });\r\n    }\r\n\r\n    return new Promise((resolve) => {\r\n      this._onCompleted.addOnce(() => resolve());\r\n    });\r\n  }\r\n\r\n  public async convert(inputs: XYZProps[]): Promise<{ points: PointWithStatus[], fromCache: number }> {\r\n    const fromCache = this.enqueue(inputs);\r\n    assert(fromCache >= 0);\r\n    assert(fromCache <= inputs.length);\r\n\r\n    if (fromCache === inputs.length)\r\n      return { points: this.getFromCache(inputs), fromCache };\r\n\r\n    await this.scheduleDispatch();\r\n\r\n    return { points: this.getFromCache(inputs), fromCache };\r\n  }\r\n\r\n  public findCached(inputs: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    const result: Array<PointWithStatus | undefined> = [];\r\n    let missing: XYZProps[] | undefined;\r\n    for (const input of inputs) {\r\n      const key = this.toXYAndZ(input, this._scratchXYZ);\r\n      const output = this._cache.get(key);\r\n      result.push(output);\r\n      if (!output) {\r\n        if (!missing)\r\n          missing = [];\r\n\r\n        missing.push(input);\r\n      }\r\n    }\r\n\r\n    return { result, missing };\r\n  }\r\n}\r\n\r\n/** Response to a request to obtain imodel coordinates from cache.\r\n * @internal\r\n */\r\nexport interface CachedIModelCoordinatesResponseProps {\r\n  /** An array of the same length as the input array, with undefined entries at indices corresponding to points not found in cache. */\r\n  result: Array<PointWithStatus | undefined>;\r\n  /** An array of points in the input array which were not found in the cache, or undefined if all points were found in the cache. */\r\n  missing?: XYZProps[];\r\n}\r\n\r\n/** An object capable of communicating with the backend to convert between coordinates in a geographic coordinate system and coordinates in an [[IModelConnection]]'s own coordinate system.\r\n * @see [[GeoServices.getConverter]] to obtain a converter.\r\n * @see [GeographicCRS]($common) for more information about geographic coordinate reference systems.\r\n * @public\r\n */\r\nexport class GeoConverter {\r\n  private readonly _geoToIModel: CoordinateConverter;\r\n  private readonly _iModelToGeo: CoordinateConverter;\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelConnection, datumOrGCRS: string | GeographicCRSProps) {\r\n    const datum = typeof datumOrGCRS === \"object\" ? JSON.stringify(datumOrGCRS) : datumOrGCRS;\r\n\r\n    this._geoToIModel = new CoordinateConverter({\r\n      iModel,\r\n      requestPoints: async (geoCoords: XYAndZ[]) => {\r\n        const request = { source: datum, geoCoords };\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getIModelCoordinatesFromGeoCoordinates(iModel.getRpcProps(), request);\r\n        return response.iModelCoords;\r\n      },\r\n    });\r\n\r\n    this._iModelToGeo = new CoordinateConverter({\r\n      iModel,\r\n      requestPoints: async (iModelCoords: XYAndZ[]) => {\r\n        const request = { target: datum, iModelCoords };\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getGeoCoordinatesFromIModelCoordinates(iModel.getRpcProps(), request);\r\n        return response.geoCoords;\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Convert the specified geographic coordinates into iModel coordinates. */\r\n  public async convertToIModelCoords(geoPoints: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getIModelCoordinatesFromGeoCoordinates(geoPoints);\r\n    return result.iModelCoords;\r\n  }\r\n\r\n  /** Convert the specified iModel coordinates into geographic coordinates. */\r\n  public async convertFromIModelCoords(iModelCoords: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getGeoCoordinatesFromIModelCoordinates(iModelCoords);\r\n    return result.geoCoords;\r\n  }\r\n\r\n  /** @internal */\r\n  public async getIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): Promise<IModelCoordinatesResponseProps> {\r\n    const result = await this._geoToIModel.convert(geoPoints);\r\n    return {\r\n      iModelCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public async getGeoCoordinatesFromIModelCoordinates(iModelPoints: XYZProps[]): Promise<GeoCoordinatesResponseProps> {\r\n    const result = await this._iModelToGeo.convert(iModelPoints);\r\n    return {\r\n      geoCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public getCachedIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    return this._geoToIModel.findCached(geoPoints);\r\n  }\r\n}\r\n\r\n/** The Geographic Services available for an [[IModelConnection]].\r\n * @see [[IModelConnection.geoServices]] to obtain the GeoServices for a specific iModel.\r\n * @public\r\n */\r\nexport class GeoServices {\r\n  private _iModel: IModelConnection;\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelConnection) {\r\n    this._iModel = iModel;\r\n  }\r\n\r\n  /** Obtain a converter that can convert between a geographic coordinate system and the iModel's own coordinate system.\r\n   * @param datumOrGCRS The name or JSON representation of the geographic coordinate system datum - for example, \"WGS84\".\r\n   * @returns a converter, or `undefined` if the iModel is not open.\r\n   * @note A [[BlankConnection]] has no connection to a backend, so it is never \"open\"; therefore it always returns `undefined`.\r\n   */\r\n  public getConverter(datumOrGCRS?: string | GeographicCRSProps): GeoConverter | undefined {\r\n    return this._iModel.isOpen ? new GeoConverter(this._iModel, datumOrGCRS ? datumOrGCRS : \"\") : undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GeoServices.js","sourceRoot":"","sources":["../../src/GeoServices.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qBAAqB;AACrB,OAAO,EACL,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,GACjD,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACoD,cAAc,EACvE,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAazE,SAAS,aAAa,CAAC,GAAW,EAAE,GAAW;IAC7C,OAAO,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC1C,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,mBAAmB;IAmB9B,IAAW,MAAM;QACf,OAAO,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC;IAChC,CAAC;IAES,QAAQ,CAAC,KAAe,EAAE,MAAsB;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC1B;aAAM;YACL,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAmB,IAAgC;QAnCzC,WAAM,GAA6B,MAAM,CAAC;QAKpD,kDAAkD;QACxC,iBAAY,GAAG,IAAI,OAAO,EAAc,CAAC;QACnD,oGAAoG;QACjF,gBAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QAItD,qFAAqF;QACrF,iIAAiI;QACjI,gGAAgG;QACtF,4BAAuB,GAAG,KAAK,CAAC;QAqBxC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,mBAAmB,IAAI,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAA0B,aAAa,EAAE,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,IAAI,WAAW,CAAS,aAAa,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9E,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACnD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO;SACR;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,uFAAuF;QACvF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,EAAc,CAAC;QAE9C,+HAA+H;QAC/H,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,kGAAkG;QAClG,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,EAAE;YACnE,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,YAAY,EAAE,CAAC;YACjF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7D,IAAI,IAAI,CAAC,eAAe,EAAE;oBACxB,OAAO;gBAET,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;oBACpC,MAAM,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,OAAO,cAAc,EAAE,2BAA2B,QAAQ,CAAC,MAAM,yBAAyB,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC;gBAE/J,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACvC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM;wBACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC5C;YACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACf,MAAM,CAAC,YAAY,CAAC,GAAG,sBAAsB,CAAC,OAAO,cAAc,EAAE,GAAG,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACxB;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEvB,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAC1D,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;YACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,8DAA8D;SACxF;QAED,kEAAkE;QAClE,WAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,+DAA+D;IAC/D,gDAAgD;IACtC,OAAO,CAAC,MAAkB;QAClC,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;gBACtB,EAAE,UAAU,CAAC;iBACV,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;;gBAEpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,0HAA0H;IAC1H,2EAA2E;IACjE,YAAY,CAAC,MAAkB;QACvC,MAAM,OAAO,GAAsB,EAAE,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM;gBACT,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,UAAU,EAAE,CAAC;YAE3D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACtB;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,gBAAgB;QAC9B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;YAC1B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,8DAA8D;YACjF,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;QACvB,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM;YAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;QAE1D,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE9B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAEM,UAAU,CAAC,MAAkB;QAClC,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,IAAI,OAA+B,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE;gBACX,IAAI,CAAC,OAAO;oBACV,OAAO,GAAG,EAAE,CAAC;gBAEf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;CACF;AAsBD;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAQvB,gBAAgB;IAChB,YAAY,IAAyB;QANrC;;WAEG;QACa,2BAAsB,GAAG,IAAI,OAAO,EAAc,CAAC;QAIjE,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,SAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SACrG,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,mBAAmB,CAAC;YAC1C,cAAc;YACd,aAAa,EAAE,KAAK,EAAE,YAAsB,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAC;SAC7G,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,qBAAqB,CAAC,SAAqB;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,4EAA4E;IACrE,KAAK,CAAC,uBAAuB,CAAC,YAAwB;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sCAAsC,CAAC,YAAY,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,SAAqB;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,MAAM;YAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sCAAsC,CAAC,YAAwB;QAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,MAAM;YACxB,SAAS,EAAE,MAAM,CAAC,SAAS;SAC5B,CAAC;IACJ,CAAC;IAEO,eAAe;QACrB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM;YACtD,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC;IAED,gBAAgB;IACT,4CAA4C,CAAC,SAAqB;QACvE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;CACF;AAKD;;;GAGG;AACH,MAAM,OAAO,WAAW;IActB,gBAAgB;IAChB,YAAmB,OAA2B;QAb9C;;;;;;;;;WASG;QACc,WAAM,GAAG,IAAI,GAAG,EAAwB,CAAC;QAIxD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,MAAwB;QACpD,OAAO,IAAI,WAAW,CAAC;YACrB,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ;YACrC,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAChC,MAAM,GAAG,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,YAAY,CAAC;YAC/B,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,sBAAsB,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpF,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,sCAAsC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjG,OAAO,QAAQ,CAAC,SAAS,CAAC;YAC5B,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,WAAyC;QAC3D,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAElG,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAElC,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC5C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelConnection\r\n */\r\n\r\n// cspell:ignore GCRS\r\nimport {\r\n  assert, BeEvent, Dictionary, Logger, SortedArray,\r\n} from \"@itwin/core-bentley\";\r\nimport { WritableXYAndZ, XYAndZ, XYZProps } from \"@itwin/core-geometry\";\r\nimport {\r\n  GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeoCoordStatus, GeographicCRSProps, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps,\r\n  IModelReadRpcInterface, PointWithStatus,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"./IModelConnection\";\r\nimport { FrontendLoggerCategory } from \"./common/FrontendLoggerCategory\";\r\n\r\n/** Options used to create a [[CoordinateConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface CoordinateConverterOptions {\r\n  isIModelClosed: () => boolean;\r\n  /** Asynchronously convert each point. The resultant array should have the same number and order of points as the input. */\r\n  requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  /** Maximum number of points to include in each request. Default: 300. */\r\n  maxPointsPerRequest?: number;\r\n}\r\n\r\nfunction compareXYAndZ(lhs: XYAndZ, rhs: XYAndZ): number {\r\n  return lhs.x - rhs.x || lhs.y - rhs.y || lhs.z - rhs.z;\r\n}\r\n\r\nfunction cloneXYAndZ(xyz: XYAndZ): XYAndZ {\r\n  return { x: xyz.x, y: xyz.y, z: xyz.z };\r\n}\r\n\r\ntype CoordinateConverterState =\r\n  // No pending requests.\r\n  \"idle\" |\r\n  // We have scheduled a requestAnimationFrame to dispatch all pending requests.\r\n  \"scheduled\" |\r\n  // We have dispatched all requests that were pending at the most recent requestAnimationFrame callback.\r\n  \"in-flight\";\r\n\r\n/** Performs conversion of coordinates from one coordinate system to another.\r\n * A [[GeoConverter]] has a pair of these for converting between iModel coordinates and geographic coordinates.\r\n * Uses a cache to avoid repeatedly requesting the same points, and a batching strategy to avoid making frequent small requests.\r\n * The cache stores every point that was ever converted by [[convert]]. It is currently permitted to grow to unbounded size.\r\n * The batching works as follows:\r\n *  When a conversion is requested via [[convert]], if all the requested points are in the cache, they are returned immediately.\r\n *  Otherwise, any points not in the cache and not in the current in-flight request (if any) are placed onto the queue of pending requests.\r\n *  A pending request is scheduled if one hasn't already been scheduled, via requestAnimationFrame.\r\n *  In the animation frame callback, the pending requests are split into batches of no more than options.maxPointsPerRequest and dispatched to the backend.\r\n *  Once the response is received, the results are loaded into and returned from the cache.\r\n *  If more calls to convert occurred while the request was in flight, another request is dispatched.\r\n * @internal exported strictly for tests.\r\n */\r\nexport class CoordinateConverter {\r\n  protected readonly _cache: Dictionary<XYAndZ, PointWithStatus>;\r\n  protected _state: CoordinateConverterState = \"idle\";\r\n  // The accumulated set of points to be converted by the next request.\r\n  protected _pending: SortedArray<XYAndZ>;\r\n  // The set of points that were included in the current in-flight request, if any.\r\n  protected _inflight: SortedArray<XYAndZ>;\r\n  // An event fired when the next request completes.\r\n  protected _onCompleted = new BeEvent<() => void>();\r\n  // Used for creating cache keys (XYAndZ) from XYZProps without having to allocate temporary objects.\r\n  protected readonly _scratchXYZ = { x: 0, y: 0, z: 0 };\r\n  protected readonly _maxPointsPerRequest: number;\r\n  protected readonly _isIModelClosed: () => boolean;\r\n  protected readonly _requestPoints: (points: XYAndZ[]) => Promise<PointWithStatus[]>;\r\n  // If true, [[dispatch]] will schedule another dispatch after it receives a response.\r\n  // This is needed when all the points requested after the most recent dispatch were included in the currently-in-flight request -\r\n  // _pending will be empty but new callers will be awaiting the results of the in-flight request.\r\n  protected _redispatchOnCompletion = false;\r\n\r\n  public get isIdle(): boolean {\r\n    return \"idle\" === this._state;\r\n  }\r\n\r\n  protected toXYAndZ(input: XYZProps, output: WritableXYAndZ): XYAndZ {\r\n    if (Array.isArray(input)) {\r\n      output.x = input[0] ?? 0;\r\n      output.y = input[1] ?? 0;\r\n      output.z = input[2] ?? 0;\r\n    } else {\r\n      output.x = input.x ?? 0;\r\n      output.y = input.y ?? 0;\r\n      output.z = input.z ?? 0;\r\n    }\r\n\r\n    return output;\r\n  }\r\n\r\n  public constructor(opts: CoordinateConverterOptions) {\r\n    this._maxPointsPerRequest = Math.max(1, opts.maxPointsPerRequest ?? 300);\r\n    this._isIModelClosed = opts.isIModelClosed;\r\n    this._requestPoints = opts.requestPoints;\r\n\r\n    this._cache = new Dictionary<XYAndZ, PointWithStatus>(compareXYAndZ, cloneXYAndZ);\r\n    this._pending = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n    this._inflight = new SortedArray<XYAndZ>(compareXYAndZ, false, cloneXYAndZ);\r\n  }\r\n\r\n  protected async dispatch(): Promise<void> {\r\n    assert(this._state === \"scheduled\");\r\n    if (this._isIModelClosed() || this._pending.isEmpty) {\r\n      this._state = \"idle\";\r\n      this._onCompleted.raiseEvent();\r\n      return;\r\n    }\r\n\r\n    this._state = \"in-flight\";\r\n\r\n    // Ensure subsequently-enqueued requests listen for the *next* response to be received.\r\n    const onCompleted = this._onCompleted;\r\n    this._onCompleted = new BeEvent<() => void>();\r\n\r\n    // Pending requests are now in flight. Start a new list of pending requests. It's cheaper to swap than to allocate new objects.\r\n    const inflight = this._pending;\r\n    this._pending = this._inflight;\r\n    assert(this._pending.isEmpty);\r\n    this._inflight = inflight;\r\n\r\n    // Split requests if necessary to avoid requesting more than the maximum allowed number of points.\r\n    const promises: Array<Promise<void>> = [];\r\n    for (let i = 0; i < inflight.length; i += this._maxPointsPerRequest) {\r\n      const requests = inflight.slice(i, i + this._maxPointsPerRequest).extractArray();\r\n      const promise = this._requestPoints(requests).then((results) => {\r\n        if (this._isIModelClosed())\r\n          return;\r\n\r\n        if (results.length !== requests.length)\r\n          Logger.logError(`${FrontendLoggerCategory.Package}.geoservices`, `requested conversion of ${requests.length} points, but received ${results.length} points`);\r\n\r\n        for (let j = 0; j < results.length; j++) {\r\n          if (j < requests.length)\r\n            this._cache.set(requests[j], results[j]);\r\n        }\r\n      }).catch((err) => {\r\n        Logger.logException(`${FrontendLoggerCategory.Package}.geoservices`, err);\r\n      });\r\n\r\n      promises.push(promise);\r\n    }\r\n\r\n    await Promise.all(promises);\r\n\r\n    assert(this._state === \"in-flight\");\r\n    this._state = \"idle\";\r\n    this._inflight.clear();\r\n\r\n    // If any more pending conversions arrived while awaiting this request, schedule another request.\r\n    if (!this._pending.isEmpty || this._redispatchOnCompletion) {\r\n      this._redispatchOnCompletion = false;\r\n      this.scheduleDispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    }\r\n\r\n    // Resolve promises of all callers who were awaiting this request.\r\n    onCompleted.raiseEvent();\r\n  }\r\n\r\n  // Add any points not present in cache to pending request list.\r\n  // Return the number of points present in cache.\r\n  protected enqueue(points: XYZProps[]): number {\r\n    let numInCache = 0;\r\n    for (const point of points) {\r\n      const xyz = this.toXYAndZ(point, this._scratchXYZ);\r\n      if (this._cache.get(xyz))\r\n        ++numInCache;\r\n      else if (this._inflight.contains(xyz))\r\n        this._redispatchOnCompletion = true;\r\n      else\r\n        this._pending.insert(xyz);\r\n    }\r\n\r\n    return numInCache;\r\n  }\r\n\r\n  // Obtain converted points from the cache. The assumption is that every point in `inputs` is already present in the cache.\r\n  // Any point not present will be returned unconverted with an error status.\r\n  protected getFromCache(inputs: XYZProps[]): PointWithStatus[] {\r\n    const outputs: PointWithStatus[] = [];\r\n    for (const input of inputs) {\r\n      const xyz = this.toXYAndZ(input, this._scratchXYZ);\r\n      let output = this._cache.get(xyz);\r\n      if (!output)\r\n        output = { p: { ...xyz }, s: GeoCoordStatus.CSMapError };\r\n\r\n      outputs.push(output);\r\n    }\r\n\r\n    return outputs;\r\n  }\r\n\r\n  protected async scheduleDispatch(): Promise<void> {\r\n    if (\"idle\" === this._state) {\r\n      this._state = \"scheduled\";\r\n      requestAnimationFrame(() => {\r\n        this.dispatch(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      });\r\n    }\r\n\r\n    return new Promise((resolve) => {\r\n      this._onCompleted.addOnce(() => resolve());\r\n    });\r\n  }\r\n\r\n  public async convert(inputs: XYZProps[]): Promise<{ points: PointWithStatus[], fromCache: number }> {\r\n    const fromCache = this.enqueue(inputs);\r\n    assert(fromCache >= 0);\r\n    assert(fromCache <= inputs.length);\r\n\r\n    if (fromCache === inputs.length)\r\n      return { points: this.getFromCache(inputs), fromCache };\r\n\r\n    await this.scheduleDispatch();\r\n\r\n    return { points: this.getFromCache(inputs), fromCache };\r\n  }\r\n\r\n  public findCached(inputs: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    const result: Array<PointWithStatus | undefined> = [];\r\n    let missing: XYZProps[] | undefined;\r\n    for (const input of inputs) {\r\n      const key = this.toXYAndZ(input, this._scratchXYZ);\r\n      const output = this._cache.get(key);\r\n      result.push(output);\r\n      if (!output) {\r\n        if (!missing)\r\n          missing = [];\r\n\r\n        missing.push(input);\r\n      }\r\n    }\r\n\r\n    return { result, missing };\r\n  }\r\n}\r\n\r\n/** Response to a request to obtain imodel coordinates from cache.\r\n * @internal\r\n */\r\nexport interface CachedIModelCoordinatesResponseProps {\r\n  /** An array of the same length as the input array, with undefined entries at indices corresponding to points not found in cache. */\r\n  result: Array<PointWithStatus | undefined>;\r\n  /** An array of points in the input array which were not found in the cache, or undefined if all points were found in the cache. */\r\n  missing?: XYZProps[];\r\n}\r\n\r\n/** Options used to create a [[GeoConverter]].\r\n * @internal exported strictly for tests.\r\n */\r\nexport interface GeoConverterOptions {\r\n  readonly datum: string;\r\n  isIModelClosed: () => boolean;\r\n  toIModelCoords: (request: IModelCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n  fromIModelCoords: (request: GeoCoordinatesRequestProps) => Promise<PointWithStatus[]>;\r\n}\r\n\r\n/** An object capable of communicating with the backend to convert between coordinates in a geographic coordinate system and coordinates in an [[IModelConnection]]'s own coordinate system.\r\n * @see [[GeoServices.getConverter]] to obtain a converter.\r\n * @see [GeographicCRS]($common) for more information about geographic coordinate reference systems.\r\n * @public\r\n */\r\nexport class GeoConverter {\r\n  private readonly _geoToIModel: CoordinateConverter;\r\n  private readonly _iModelToGeo: CoordinateConverter;\r\n  /** Used for removing this converter from GeoServices' cache after all requests are completed.\r\n   * @internal\r\n   */\r\n  public readonly onAllRequestsCompleted = new BeEvent<() => void>();\r\n\r\n  /** @internal */\r\n  constructor(opts: GeoConverterOptions) {\r\n    const isIModelClosed = opts.isIModelClosed;\r\n    this._geoToIModel = new CoordinateConverter({\r\n      isIModelClosed,\r\n      requestPoints: async (geoCoords: XYAndZ[]) => opts.toIModelCoords({ source: opts.datum, geoCoords }),\r\n    });\r\n\r\n    this._iModelToGeo = new CoordinateConverter({\r\n      isIModelClosed,\r\n      requestPoints: async (iModelCoords: XYAndZ[]) => opts.fromIModelCoords({ target: opts.datum, iModelCoords }),\r\n    });\r\n  }\r\n\r\n  /** Convert the specified geographic coordinates into iModel coordinates. */\r\n  public async convertToIModelCoords(geoPoints: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getIModelCoordinatesFromGeoCoordinates(geoPoints);\r\n    return result.iModelCoords;\r\n  }\r\n\r\n  /** Convert the specified iModel coordinates into geographic coordinates. */\r\n  public async convertFromIModelCoords(iModelCoords: XYZProps[]): Promise<PointWithStatus[]> {\r\n    const result = await this.getGeoCoordinatesFromIModelCoordinates(iModelCoords);\r\n    return result.geoCoords;\r\n  }\r\n\r\n  /** @internal */\r\n  public async getIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): Promise<IModelCoordinatesResponseProps> {\r\n    const result = await this._geoToIModel.convert(geoPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      iModelCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public async getGeoCoordinatesFromIModelCoordinates(iModelPoints: XYZProps[]): Promise<GeoCoordinatesResponseProps> {\r\n    const result = await this._iModelToGeo.convert(iModelPoints);\r\n    this.checkCompletion();\r\n    return {\r\n      geoCoords: result.points,\r\n      fromCache: result.fromCache,\r\n    };\r\n  }\r\n\r\n  private checkCompletion(): void {\r\n    if (this._geoToIModel.isIdle && this._iModelToGeo.isIdle)\r\n      this.onAllRequestsCompleted.raiseEvent();\r\n  }\r\n\r\n  /** @internal */\r\n  public getCachedIModelCoordinatesFromGeoCoordinates(geoPoints: XYZProps[]): CachedIModelCoordinatesResponseProps {\r\n    return this._geoToIModel.findCached(geoPoints);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type GeoServicesOptions = Omit<GeoConverterOptions, \"datum\">;\r\n\r\n/** The Geographic Services available for an [[IModelConnection]].\r\n * @see [[IModelConnection.geoServices]] to obtain the GeoServices for a specific iModel.\r\n * @public\r\n */\r\nexport class GeoServices {\r\n  private readonly _options: GeoServicesOptions;\r\n  /** Each GeoConverter has its own independent request queue and cache of previously-converted points.\r\n   * Some callers like RealityTileTree obtain a single GeoConverter and reuse it throughout their own lifetime. Therefore they benefit from both batching and caching, and\r\n   * the cache gets deleted once the RealityTileTree becomes disused.\r\n   *\r\n   * Other callers like IModelConnection.spatialToCartographic obtain a new GeoConverter every time they need one, use it to convert a single point(!), and then discard the converter.\r\n   * This entirely prevents batching - e.g., calling spatialToCartographic 20 times in one frame results in 20 http requests.\r\n   * To address that, we cache each GeoConverter returned by getConverter until it has converted at least one point and has no further outstanding conversion requests.\r\n   * In this way, the converter lives for as long as (and no longer than) any caller is awaiting conversion to/from its datum - it and its cache are deleted once it becomes disused.\r\n   * This makes the coordinate caching generally less useful, but at least bounded - and maximizes batching of requests.\r\n   */\r\n  private readonly _cache = new Map<string, GeoConverter>();\r\n\r\n  /** @internal */\r\n  public constructor(options: GeoServicesOptions) {\r\n    this._options = options;\r\n  }\r\n\r\n  /** @internal */\r\n  public static createForIModel(iModel: IModelConnection): GeoServices {\r\n    return new GeoServices({\r\n      isIModelClosed: () => iModel.isClosed,\r\n      toIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getIModelCoordinatesFromGeoCoordinates(iModel.getRpcProps(), request);\r\n        return response.iModelCoords;\r\n      },\r\n      fromIModelCoords: async (request) => {\r\n        const rpc = IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token);\r\n        const response = await rpc.getGeoCoordinatesFromIModelCoordinates(iModel.getRpcProps(), request);\r\n        return response.geoCoords;\r\n      },\r\n    });\r\n  }\r\n\r\n  /** Obtain a converter that can convert between a geographic coordinate system and the iModel's own coordinate system.\r\n   * @param datumOrGCRS The name or JSON representation of the geographic coordinate system datum - for example, \"WGS84\".\r\n   * @returns a converter, or `undefined` if the iModel is not open.\r\n   * @note A [[BlankConnection]] has no connection to a backend, so it is never \"open\"; therefore it always returns `undefined`.\r\n   */\r\n  public getConverter(datumOrGCRS?: string | GeographicCRSProps): GeoConverter | undefined {\r\n    if (this._options.isIModelClosed())\r\n      return undefined;\r\n\r\n    const datum = (typeof datumOrGCRS === \"object\" ? JSON.stringify(datumOrGCRS) : datumOrGCRS) ?? \"\";\r\n\r\n    let converter = this._cache.get(datum);\r\n    if (!converter) {\r\n      converter = new GeoConverter({ ...this._options, datum });\r\n      this._cache.set(datum, converter);\r\n\r\n      converter.onAllRequestsCompleted.addOnce(() => {\r\n        if (converter === this._cache.get(datum))\r\n          this._cache.delete(datum);\r\n      });\r\n    }\r\n\r\n    return converter;\r\n  }\r\n}\r\n"]}

package/lib/esm/GraphicalEditingScope.d.ts

@@ -2,7 +2,7 @@
  * @module IModelConnection
  */
 import { BeEvent, Id64String } from "@itwin/core-bentley";
-import { EditingScopeNotifications, ElementGeometryChange, IpcAppChannel, ModelGeometryChanges, ModelGeometryChangesProps } from "@itwin/core-common";
+import { EditingScopeNotifications, ElementGeometryChange, ModelGeometryChanges, ModelGeometryChangesProps } from "@itwin/core-common";
 import { BriefcaseNotificationHandler } from "./BriefcaseTxns";
 import { BriefcaseConnection } from "./BriefcaseConnection";
 /** Represents a period of time within an [interactive editing]($docs/learning/InteractiveEditing.md) session during which the
@@ -32,7 +32,7 @@ import { BriefcaseConnection } from "./BriefcaseConnection";
  * @public
  */
 export declare class GraphicalEditingScope extends BriefcaseNotificationHandler implements EditingScopeNotifications {
-    get briefcaseChannelName(): IpcAppChannel;
+    get briefcaseChannelName(): "itwinjs-core/editing-scope";
     /** Maps model Id to accumulated changes to geometric elements within the associated model. */
     private readonly _geometryChanges;
     private _disposed;

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

@@ -1 +1 @@
-{"version":3,"file":"GraphicalEditingScope.d.ts","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAkE,UAAU,EAAe,MAAM,qBAAqB,CAAC;AAE/I,OAAO,EACL,yBAAyB,EAAE,qBAAqB,EAAE,aAAa,EAAE,oBAAoB,EAAE,yBAAyB,EACjH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAc5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,qBAAsB,SAAQ,4BAA6B,YAAW,yBAAyB;IAC1G,IAAW,oBAAoB,kBAAyC;IAExE,8FAA8F;IAC9F,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuC;IACxE,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAElC,iDAAiD;IACjD,SAAgB,MAAM,EAAE,mBAAmB,CAAC;IAE5C;;OAEG;IACH,gBAAuB,OAAO,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAEvF;;;OAGG;IACH,SAAgB,SAAS,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAElF;;;OAGG;IACH,SAAgB,QAAQ,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAEjF,sEAAsE;IACtE,SAAgB,iBAAiB,oBAAyB,SAAS,oBAAoB,CAAC,SAAS,qBAAqB,KAAK,IAAI,EAAI;IAEnI;;OAEG;WACiB,KAAK,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmBtF;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBlC,yGAAyG;IAClG,0BAA0B,CAAC,OAAO,EAAE,UAAU,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,SAAS;IAInG,4EAA4E;IACrE,kBAAkB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;IAI3D,gBAAgB;IAChB,IAAW,UAAU,YAEpB;IAED,OAAO,CAAG,sBAAsB;IAWhC,OAAO;IAMP,OAAO,CAAC,OAAO;IAef,gBAAgB;IACT,qBAAqB,CAAC,KAAK,EAAE,yBAAyB,EAAE;CAiChE"}
+{"version":3,"file":"GraphicalEditingScope.d.ts","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAkE,UAAU,EAAe,MAAM,qBAAqB,CAAC;AAE/I,OAAO,EACL,yBAAyB,EAAE,qBAAqB,EAAkB,oBAAoB,EAAE,yBAAyB,EAClH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAc5D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,qBAAsB,SAAQ,4BAA6B,YAAW,yBAAyB;IAC1G,IAAW,oBAAoB,iCAA0C;IAEzE,8FAA8F;IAC9F,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuC;IACxE,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAElC,iDAAiD;IACjD,SAAgB,MAAM,EAAE,mBAAmB,CAAC;IAE5C;;OAEG;IACH,gBAAuB,OAAO,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAEvF;;;OAGG;IACH,SAAgB,SAAS,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAElF;;;OAGG;IACH,SAAgB,QAAQ,kBAAuB,qBAAqB,KAAK,IAAI,EAAI;IAEjF,sEAAsE;IACtE,SAAgB,iBAAiB,oBAAyB,SAAS,oBAAoB,CAAC,SAAS,qBAAqB,KAAK,IAAI,EAAI;IAEnI;;OAEG;WACiB,KAAK,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmBtF;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBlC,yGAAyG;IAClG,0BAA0B,CAAC,OAAO,EAAE,UAAU,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,SAAS;IAInG,4EAA4E;IACrE,kBAAkB,IAAI,QAAQ,CAAC,oBAAoB,CAAC;IAI3D,gBAAgB;IAChB,IAAW,UAAU,YAEpB;IAED,OAAO,CAAG,sBAAsB;IAWhC,OAAO;IAMP,OAAO,CAAC,OAAO;IAef,gBAAgB;IACT,qBAAqB,CAAC,KAAK,EAAE,yBAAyB,EAAE;CAiChE"}

package/lib/esm/GraphicalEditingScope.js

@@ -6,7 +6,7 @@
  * @module IModelConnection
  */
 import { assert, BeEvent, compareStrings, DbOpcode, DuplicatePolicy, SortedArray } from "@itwin/core-bentley";
-import { IpcAppChannel, ModelGeometryChanges, } from "@itwin/core-common";
+import { ipcAppChannels, ModelGeometryChanges, } from "@itwin/core-common";
 import { BriefcaseNotificationHandler } from "./BriefcaseTxns";
 import { IpcApp } from "./IpcApp";
 class ModelChanges extends SortedArray {
@@ -43,7 +43,7 @@ class ModelChanges extends SortedArray {
  * @public
  */
 class GraphicalEditingScope extends BriefcaseNotificationHandler {
-    get briefcaseChannelName() { return IpcAppChannel.EditingScope; }
+    get briefcaseChannelName() { return ipcAppChannels.editingScope; }
     /** Don't call this directly - use BriefcaseConnection.enterEditingScope.
      * @internal
      */

package/lib/esm/GraphicalEditingScope.js.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicalEditingScope.js","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,eAAe,EAAmC,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAE/I,OAAO,EAC6C,aAAa,EAAE,oBAAoB,GACtF,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,YAAa,SAAQ,WAAkC;IAI3D,YAAmB,YAAwB,EAAE,KAAc;QACzD,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,qBAAsB,SAAQ,4BAA4B;IACrE,IAAW,oBAAoB,KAAK,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;IA8BxE;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAA2B;QACnD,IAAI,MAAM,CAAC,YAAY;YACrB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,gIAAgI;QAChI,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI;YACF,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/F,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,4CAA4C;SACnE;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,CAAC;SACT;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI;YACrD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAExF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI;YACF,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACjC;gBAAS;YACR,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpG,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;YACrB,IAAI;gBACF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;aAChC;oBAAS;gBACR,IAAI,CAAC,OAAO,EAAE,CAAC;aAChB;SACF;IACH,CAAC;IAED,yGAAyG;IAClG,0BAA0B,CAAC,OAAmB;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEO,CAAE,sBAAsB;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAChD,MAAM;gBACJ,EAAE,EAAE,GAAG;gBACP,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,QAAQ,EAAE,KAAK;aAChB,CAAC;SACH;IACH,CAAC;IAED,YAAoB,MAA2B;QAC7C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAnGpB,8FAA8F;QAC7E,qBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAChE,cAAS,GAAG,KAAK,CAAC;QAW1B;;;WAGG;QACa,cAAS,GAAG,IAAI,OAAO,EAA0C,CAAC;QAElF;;;WAGG;QACa,aAAQ,GAAG,IAAI,OAAO,EAA0C,CAAC;QAEjF,sEAAsE;QACtD,sBAAiB,GAAG,IAAI,OAAO,EAAmF,CAAC;QA0EjI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEtB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;IACH,CAAC;IAED,gBAAgB;IACT,qBAAqB,CAAC,KAAkC;QAC7D,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAClC,IAAI,UAA+B,CAAC;QAEpC,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,4CAA4C;YAC5C,IAAI,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACtD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC/B,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,QAAQ,EAAE;gBACjD,IAAI,CAAC,IAAI,EAAE;oBACT,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;iBACpH;qBAAM;oBACL,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;oBAC9C,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACtC;gBAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC3B,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI,EAAE;oBAC1C,IAAI,SAAS,KAAK,UAAU;wBAC1B,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;oBACrC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;iBAClC;aACF;SACF;QAED,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;;AAhJD;;GAEG;AACoB,6BAAO,GAAG,IAAI,OAAO,EAA0C,AAAxD,CAAyD;SAd5E,qBAAqB","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 IModelConnection\r\n */\r\n\r\nimport { assert, BeEvent, compareStrings, DbOpcode, DuplicatePolicy, GuidString, Id64Set, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  EditingScopeNotifications, ElementGeometryChange, IpcAppChannel, ModelGeometryChanges, ModelGeometryChangesProps, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseNotificationHandler } from \"./BriefcaseTxns\";\r\nimport { BriefcaseConnection } from \"./BriefcaseConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\n\r\nclass ModelChanges extends SortedArray<ElementGeometryChange> {\r\n  public geometryGuid: GuidString;\r\n  public readonly range: Range3d;\r\n\r\n  public constructor(geometryGuid: GuidString, range: Range3d) {\r\n    super((lhs, rhs) => compareStrings(lhs.id, rhs.id), DuplicatePolicy.Replace);\r\n    this.geometryGuid = geometryGuid;\r\n    this.range = range;\r\n  }\r\n}\r\n\r\n/** Represents a period of time within an [interactive editing]($docs/learning/InteractiveEditing.md) session during which the\r\n * geometry of elements being displayed in one or more [[Viewport]]s is being modified. Outside of such a scope, whenever the\r\n * geometry within a [GeometricModel]($backend) changes new [[Tile]]s must be generated to reflect those changes in a viewport.\r\n * Regenerating entire tiles each time individual elements change can be time-consuming, which may introduce an unacceptable delay\r\n * between making a modification and seeing its result on the screen.\r\n *\r\n * Within the context of a graphical editing scope, no new tiles are generated. Instead, the geometry for any deleted or modified elements\r\n * is hidden in the tile graphics, and additional temporary graphics are displayed for any newly-inserted or modified elements. Only when the\r\n * scope exits are new tiles produced.\r\n *\r\n * The application decides when to enter and exit a graphical editing scope. A single interactive editing session may involve any number of\r\n * editing scopes. Typically, applications will enter a new editing scope (after first exiting a previous scope, if one exists):\r\n *  - When switching from a non-graphical workflow to one that involves editing geometry; or\r\n *  - When changing which geometric model is being edited; or\r\n *  - After performing an operation that creates or modifies a \"large\" number (perhaps hundreds?) of elements.\r\n *\r\n * An application should typically exit any graphical editing scope before:\r\n *  - Pulling changesets; or\r\n *  - Switching from a graphical editing workflow to some non-graphical workflow.\r\n *\r\n * Graphical editing scopes are only supported for [[BriefcaseConnection]]s opened in read-write mode that contain version 1.0.11 or newer of the BisCore schema.\r\n * @see [[BriefcaseConnection.enterEditingScope]] to create a scope for a briefcase.\r\n * @see [[BriefcaseConnection.editingScope]] to obtain a briefcase's current scope.\r\n * @see [[exit]] to terminate a scope.\r\n * @public\r\n */\r\nexport class GraphicalEditingScope extends BriefcaseNotificationHandler implements EditingScopeNotifications {\r\n  public get briefcaseChannelName() { return IpcAppChannel.EditingScope; }\r\n\r\n  /** Maps model Id to accumulated changes to geometric elements within the associated model. */\r\n  private readonly _geometryChanges = new Map<Id64String, ModelChanges>();\r\n  private _disposed = false;\r\n  private _cleanup?: RemoveFunction;\r\n\r\n  /** The connection to the iModel being edited. */\r\n  public readonly iModel: BriefcaseConnection;\r\n\r\n  /** Event raised when a new scope is created for any [[BriefcaseConnection]].\r\n   * @see [[onExiting]] and [[onExited]] for complementary events.\r\n   */\r\n  public static readonly onEnter = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope is about to exit.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExited]] for an event raised after the scope exits.\r\n   */\r\n  public readonly onExiting = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope has exited.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExiting]] for an event raised just before the scope is exited.\r\n   */\r\n  public readonly onExited = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised after geometric changes are written to the iModel. */\r\n  public readonly onGeometryChanges = new BeEvent<(changes: Iterable<ModelGeometryChanges>, scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Don't call this directly - use BriefcaseConnection.enterEditingScope.\r\n   * @internal\r\n   */\r\n  public static async enter(imodel: BriefcaseConnection): Promise<GraphicalEditingScope> {\r\n    if (imodel.editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    // Register the scope synchronously, in case enter() is called again for same iModel while awaiting asynchronous initialization.\r\n    const scope = new GraphicalEditingScope(imodel);\r\n    try {\r\n      const scopeStarted = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(imodel.key, true);\r\n      assert(scopeStarted); // If it didn't, the backend threw an error.\r\n    } catch (e) {\r\n      scope.dispose();\r\n      throw e;\r\n    }\r\n\r\n    this.onEnter.raiseEvent(scope);\r\n\r\n    return scope;\r\n  }\r\n\r\n  /** Exits this editing scope. The associated [[BriefcaseConnection]]'s `editingScope` will be reset to `undefined`.\r\n   * @throws Error if the scope could not be exited, e.g., if it has already been exited.\r\n   * @see [[BriefcaseConnection.enterEditingScope]] to enter an editing scope.\r\n   */\r\n  public async exit(): Promise<void> {\r\n    if (this._disposed || this.iModel.editingScope !== this)\r\n      throw new Error(\"Cannot exit editing scope after it is disconnected from the iModel\");\r\n\r\n    this._disposed = true;\r\n    try {\r\n      this.onExiting.raiseEvent(this);\r\n    } finally {\r\n      const scopeExited = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(this.iModel.key, false);\r\n      assert(!scopeExited);\r\n      try {\r\n        this.onExited.raiseEvent(this);\r\n      } finally {\r\n        this.dispose();\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Obtain all geometric changes to elements within the specified model accumulated within this scope. */\r\n  public getGeometryChangesForModel(modelId: Id64String): Iterable<ElementGeometryChange> | undefined {\r\n    return this._geometryChanges.get(modelId);\r\n  }\r\n\r\n  /** Obtain all geometric changes to models accumulated within this scope. */\r\n  public getGeometryChanges(): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => this.geometryChangeIterator() };\r\n  }\r\n\r\n  /** @internal */\r\n  public get isDisposed() {\r\n    return this._disposed;\r\n  }\r\n\r\n  private * geometryChangeIterator(): Iterator<ModelGeometryChanges> {\r\n    for (const [key, value] of this._geometryChanges) {\r\n      yield {\r\n        id: key,\r\n        geometryGuid: value.geometryGuid,\r\n        range: value.range,\r\n        elements: value,\r\n      };\r\n    }\r\n  }\r\n\r\n  private constructor(iModel: BriefcaseConnection) {\r\n    super(iModel.key);\r\n    this.iModel = iModel;\r\n    this._cleanup = this.registerImpl();\r\n  }\r\n\r\n  private dispose(): void {\r\n    this._disposed = true;\r\n\r\n    this.onExiting.clear();\r\n    this.onGeometryChanges.clear();\r\n    this.onExited.clear();\r\n\r\n    this._geometryChanges.clear();\r\n\r\n    if (this._cleanup) {\r\n      this._cleanup();\r\n      this._cleanup = undefined;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public notifyGeometryChanged(props: ModelGeometryChangesProps[]) {\r\n    const changes = ModelGeometryChanges.iterable(props);\r\n    const modelIds: Id64String[] = [];\r\n    let deletedIds: Id64Set | undefined;\r\n\r\n    for (const modelChanges of changes) {\r\n      // ###TODO do we care about the model range?\r\n      let list = this._geometryChanges.get(modelChanges.id);\r\n      modelIds.push(modelChanges.id);\r\n      for (const elementChange of modelChanges.elements) {\r\n        if (!list) {\r\n          this._geometryChanges.set(modelChanges.id, list = new ModelChanges(modelChanges.geometryGuid, modelChanges.range));\r\n        } else {\r\n          list.geometryGuid = modelChanges.geometryGuid;\r\n          modelChanges.range.clone(list.range);\r\n        }\r\n\r\n        list.insert(elementChange);\r\n        if (DbOpcode.Delete === elementChange.type) {\r\n          if (undefined === deletedIds)\r\n            deletedIds = new Set<Id64String>();\r\n          deletedIds.add(elementChange.id);\r\n        }\r\n      }\r\n    }\r\n\r\n    if (deletedIds) {\r\n      this.iModel.selectionSet.remove(deletedIds);\r\n      this.iModel.hilited.setHilite(deletedIds, false);\r\n    }\r\n\r\n    this.onGeometryChanges.raiseEvent(changes, this);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GraphicalEditingScope.js","sourceRoot":"","sources":["../../src/GraphicalEditingScope.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,eAAe,EAAmC,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAE/I,OAAO,EAC6C,cAAc,EAAE,oBAAoB,GACvF,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,YAAa,SAAQ,WAAkC;IAI3D,YAAmB,YAAwB,EAAE,KAAc;QACzD,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,qBAAsB,SAAQ,4BAA4B;IACrE,IAAW,oBAAoB,KAAK,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IA8BzE;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAA2B;QACnD,IAAI,MAAM,CAAC,YAAY;YACrB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAEvF,gIAAgI;QAChI,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI;YACF,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC/F,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,4CAA4C;SACnE;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,CAAC;SACT;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAE/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI;YACrD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAExF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI;YACF,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACjC;gBAAS;YACR,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACpG,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;YACrB,IAAI;gBACF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;aAChC;oBAAS;gBACR,IAAI,CAAC,OAAO,EAAE,CAAC;aAChB;SACF;IACH,CAAC;IAED,yGAAyG;IAClG,0BAA0B,CAAC,OAAmB;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEO,CAAE,sBAAsB;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAChD,MAAM;gBACJ,EAAE,EAAE,GAAG;gBACP,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,QAAQ,EAAE,KAAK;aAChB,CAAC;SACH;IACH,CAAC;IAED,YAAoB,MAA2B;QAC7C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAnGpB,8FAA8F;QAC7E,qBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAChE,cAAS,GAAG,KAAK,CAAC;QAW1B;;;WAGG;QACa,cAAS,GAAG,IAAI,OAAO,EAA0C,CAAC;QAElF;;;WAGG;QACa,aAAQ,GAAG,IAAI,OAAO,EAA0C,CAAC;QAEjF,sEAAsE;QACtD,sBAAiB,GAAG,IAAI,OAAO,EAAmF,CAAC;QA0EjI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEtB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;IACH,CAAC;IAED,gBAAgB;IACT,qBAAqB,CAAC,KAAkC;QAC7D,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAClC,IAAI,UAA+B,CAAC;QAEpC,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,4CAA4C;YAC5C,IAAI,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACtD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC/B,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,QAAQ,EAAE;gBACjD,IAAI,CAAC,IAAI,EAAE;oBACT,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;iBACpH;qBAAM;oBACL,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;oBAC9C,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACtC;gBAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAC3B,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI,EAAE;oBAC1C,IAAI,SAAS,KAAK,UAAU;wBAC1B,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;oBACrC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;iBAClC;aACF;SACF;QAED,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;;AAhJD;;GAEG;AACoB,6BAAO,GAAG,IAAI,OAAO,EAA0C,AAAxD,CAAyD;SAd5E,qBAAqB","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 IModelConnection\r\n */\r\n\r\nimport { assert, BeEvent, compareStrings, DbOpcode, DuplicatePolicy, GuidString, Id64Set, Id64String, SortedArray } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport {\r\n  EditingScopeNotifications, ElementGeometryChange, ipcAppChannels, ModelGeometryChanges, ModelGeometryChangesProps, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { BriefcaseNotificationHandler } from \"./BriefcaseTxns\";\r\nimport { BriefcaseConnection } from \"./BriefcaseConnection\";\r\nimport { IpcApp } from \"./IpcApp\";\r\n\r\nclass ModelChanges extends SortedArray<ElementGeometryChange> {\r\n  public geometryGuid: GuidString;\r\n  public readonly range: Range3d;\r\n\r\n  public constructor(geometryGuid: GuidString, range: Range3d) {\r\n    super((lhs, rhs) => compareStrings(lhs.id, rhs.id), DuplicatePolicy.Replace);\r\n    this.geometryGuid = geometryGuid;\r\n    this.range = range;\r\n  }\r\n}\r\n\r\n/** Represents a period of time within an [interactive editing]($docs/learning/InteractiveEditing.md) session during which the\r\n * geometry of elements being displayed in one or more [[Viewport]]s is being modified. Outside of such a scope, whenever the\r\n * geometry within a [GeometricModel]($backend) changes new [[Tile]]s must be generated to reflect those changes in a viewport.\r\n * Regenerating entire tiles each time individual elements change can be time-consuming, which may introduce an unacceptable delay\r\n * between making a modification and seeing its result on the screen.\r\n *\r\n * Within the context of a graphical editing scope, no new tiles are generated. Instead, the geometry for any deleted or modified elements\r\n * is hidden in the tile graphics, and additional temporary graphics are displayed for any newly-inserted or modified elements. Only when the\r\n * scope exits are new tiles produced.\r\n *\r\n * The application decides when to enter and exit a graphical editing scope. A single interactive editing session may involve any number of\r\n * editing scopes. Typically, applications will enter a new editing scope (after first exiting a previous scope, if one exists):\r\n *  - When switching from a non-graphical workflow to one that involves editing geometry; or\r\n *  - When changing which geometric model is being edited; or\r\n *  - After performing an operation that creates or modifies a \"large\" number (perhaps hundreds?) of elements.\r\n *\r\n * An application should typically exit any graphical editing scope before:\r\n *  - Pulling changesets; or\r\n *  - Switching from a graphical editing workflow to some non-graphical workflow.\r\n *\r\n * Graphical editing scopes are only supported for [[BriefcaseConnection]]s opened in read-write mode that contain version 1.0.11 or newer of the BisCore schema.\r\n * @see [[BriefcaseConnection.enterEditingScope]] to create a scope for a briefcase.\r\n * @see [[BriefcaseConnection.editingScope]] to obtain a briefcase's current scope.\r\n * @see [[exit]] to terminate a scope.\r\n * @public\r\n */\r\nexport class GraphicalEditingScope extends BriefcaseNotificationHandler implements EditingScopeNotifications {\r\n  public get briefcaseChannelName() { return ipcAppChannels.editingScope; }\r\n\r\n  /** Maps model Id to accumulated changes to geometric elements within the associated model. */\r\n  private readonly _geometryChanges = new Map<Id64String, ModelChanges>();\r\n  private _disposed = false;\r\n  private _cleanup?: RemoveFunction;\r\n\r\n  /** The connection to the iModel being edited. */\r\n  public readonly iModel: BriefcaseConnection;\r\n\r\n  /** Event raised when a new scope is created for any [[BriefcaseConnection]].\r\n   * @see [[onExiting]] and [[onExited]] for complementary events.\r\n   */\r\n  public static readonly onEnter = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope is about to exit.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExited]] for an event raised after the scope exits.\r\n   */\r\n  public readonly onExiting = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised when this scope has exited.\r\n   * @see [[onEnter]] for the complementary event.\r\n   * @see [[onExiting]] for an event raised just before the scope is exited.\r\n   */\r\n  public readonly onExited = new BeEvent<(scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Event raised after geometric changes are written to the iModel. */\r\n  public readonly onGeometryChanges = new BeEvent<(changes: Iterable<ModelGeometryChanges>, scope: GraphicalEditingScope) => void>();\r\n\r\n  /** Don't call this directly - use BriefcaseConnection.enterEditingScope.\r\n   * @internal\r\n   */\r\n  public static async enter(imodel: BriefcaseConnection): Promise<GraphicalEditingScope> {\r\n    if (imodel.editingScope)\r\n      throw new Error(\"Cannot create an editing scope for an iModel that already has one\");\r\n\r\n    // Register the scope synchronously, in case enter() is called again for same iModel while awaiting asynchronous initialization.\r\n    const scope = new GraphicalEditingScope(imodel);\r\n    try {\r\n      const scopeStarted = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(imodel.key, true);\r\n      assert(scopeStarted); // If it didn't, the backend threw an error.\r\n    } catch (e) {\r\n      scope.dispose();\r\n      throw e;\r\n    }\r\n\r\n    this.onEnter.raiseEvent(scope);\r\n\r\n    return scope;\r\n  }\r\n\r\n  /** Exits this editing scope. The associated [[BriefcaseConnection]]'s `editingScope` will be reset to `undefined`.\r\n   * @throws Error if the scope could not be exited, e.g., if it has already been exited.\r\n   * @see [[BriefcaseConnection.enterEditingScope]] to enter an editing scope.\r\n   */\r\n  public async exit(): Promise<void> {\r\n    if (this._disposed || this.iModel.editingScope !== this)\r\n      throw new Error(\"Cannot exit editing scope after it is disconnected from the iModel\");\r\n\r\n    this._disposed = true;\r\n    try {\r\n      this.onExiting.raiseEvent(this);\r\n    } finally {\r\n      const scopeExited = await IpcApp.appFunctionIpc.toggleGraphicalEditingScope(this.iModel.key, false);\r\n      assert(!scopeExited);\r\n      try {\r\n        this.onExited.raiseEvent(this);\r\n      } finally {\r\n        this.dispose();\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Obtain all geometric changes to elements within the specified model accumulated within this scope. */\r\n  public getGeometryChangesForModel(modelId: Id64String): Iterable<ElementGeometryChange> | undefined {\r\n    return this._geometryChanges.get(modelId);\r\n  }\r\n\r\n  /** Obtain all geometric changes to models accumulated within this scope. */\r\n  public getGeometryChanges(): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => this.geometryChangeIterator() };\r\n  }\r\n\r\n  /** @internal */\r\n  public get isDisposed() {\r\n    return this._disposed;\r\n  }\r\n\r\n  private * geometryChangeIterator(): Iterator<ModelGeometryChanges> {\r\n    for (const [key, value] of this._geometryChanges) {\r\n      yield {\r\n        id: key,\r\n        geometryGuid: value.geometryGuid,\r\n        range: value.range,\r\n        elements: value,\r\n      };\r\n    }\r\n  }\r\n\r\n  private constructor(iModel: BriefcaseConnection) {\r\n    super(iModel.key);\r\n    this.iModel = iModel;\r\n    this._cleanup = this.registerImpl();\r\n  }\r\n\r\n  private dispose(): void {\r\n    this._disposed = true;\r\n\r\n    this.onExiting.clear();\r\n    this.onGeometryChanges.clear();\r\n    this.onExited.clear();\r\n\r\n    this._geometryChanges.clear();\r\n\r\n    if (this._cleanup) {\r\n      this._cleanup();\r\n      this._cleanup = undefined;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public notifyGeometryChanged(props: ModelGeometryChangesProps[]) {\r\n    const changes = ModelGeometryChanges.iterable(props);\r\n    const modelIds: Id64String[] = [];\r\n    let deletedIds: Id64Set | undefined;\r\n\r\n    for (const modelChanges of changes) {\r\n      // ###TODO do we care about the model range?\r\n      let list = this._geometryChanges.get(modelChanges.id);\r\n      modelIds.push(modelChanges.id);\r\n      for (const elementChange of modelChanges.elements) {\r\n        if (!list) {\r\n          this._geometryChanges.set(modelChanges.id, list = new ModelChanges(modelChanges.geometryGuid, modelChanges.range));\r\n        } else {\r\n          list.geometryGuid = modelChanges.geometryGuid;\r\n          modelChanges.range.clone(list.range);\r\n        }\r\n\r\n        list.insert(elementChange);\r\n        if (DbOpcode.Delete === elementChange.type) {\r\n          if (undefined === deletedIds)\r\n            deletedIds = new Set<Id64String>();\r\n          deletedIds.add(elementChange.id);\r\n        }\r\n      }\r\n    }\r\n\r\n    if (deletedIds) {\r\n      this.iModel.selectionSet.remove(deletedIds);\r\n      this.iModel.hilited.setHilite(deletedIds, false);\r\n    }\r\n\r\n    this.onGeometryChanges.raiseEvent(changes, this);\r\n  }\r\n}\r\n"]}

package/lib/esm/HitDetail.d.ts

@@ -1,9 +1,13 @@
+/** @packageDocumentation
+ * @module LocatingElements
+ */
+import { Id64String } from "@itwin/core-bentley";
 import { CurvePrimitive, Point3d, Transform, Vector3d, XYZProps } from "@itwin/core-geometry";
 import { GeometryClass } from "@itwin/core-common";
 import { IModelConnection } from "./IModelConnection";
 import { Sprite } from "./Sprites";
 import { DecorateContext } from "./ViewContext";
-import { ScreenViewport } from "./Viewport";
+import { ScreenViewport, Viewport } from "./Viewport";
 /**
  * @public
  * @extensions
@@ -88,45 +92,112 @@ export declare enum HitDetailType {
     Snap = 2,
     Intersection = 3
 }
-/** A HitDetail stores the result when locating geometry displayed in a view.
- * It holds an approximate location on an element (or decoration) from a *pick*.
+/** Describes the [ViewAttachment]($backend), if any, from which the hit represented by a [[HitDetail]] originated.
+ * @note Only [[SheetViewState]]s contain view attachments.
+ * @beta
+ */
+export interface ViewAttachmentHitInfo {
+    /** The element Id of the [ViewAttachment]($backend) from which the hit originated. */
+    readonly id: Id64String;
+    /** The viewport that renders the contents of the attached view into the [[ScreenViewport]].
+     * @alpha
+     */
+    readonly viewport: Viewport;
+}
+/** Arguments supplied to the [[HitDetail]] constructor.
  * @public
- * @extensions
  */
-export declare class HitDetail {
+export interface HitDetailProps {
+    /** The point in world coordinates that was used as the initial locate point. */
     readonly testPoint: Point3d;
+    /** The viewport in which the locate operation was performed. */
     readonly viewport: ScreenViewport;
+    /** The procedure that requested the locate operation. */
     readonly hitSource: HitSource;
+    /** The approximate location in world coordinates on the geometry identified by this HitDetail. */
     readonly hitPoint: Point3d;
-    readonly sourceId: string;
+    /** The source of the geometry. This may be a persistent element Id, or a transient Id used for, e.g., pickable decorations. */
+    readonly sourceId: Id64String;
+    /** The hit geometry priority/classification. */
     readonly priority: HitPriority;
+    /** The xy distance to the hit in view coordinates. */
     readonly distXY: number;
+    /** The distance in view coordinates between the hit and the near plane. */
     readonly distFraction: number;
-    readonly subCategoryId?: string | undefined;
-    readonly geometryClass?: GeometryClass | undefined;
-    readonly modelId?: string | undefined;
-    private readonly _iModel?;
-    /** @internal chiefly for debugging. */
+    /** The [SubCategory]($backend) to which the hit geometry belongs. */
+    readonly subCategoryId?: Id64String;
+    /** The class of the hit geometry. */
+    readonly geometryClass?: GeometryClass;
+    /** The Id of the [[ModelState]] from which the hit originated. */
+    readonly modelId?: string;
+    /** The IModelConnection from which the hit originated.
+     * This should almost always be left undefined, unless the hit is known to have originated from an iModel
+     * other than the one associated with the viewport.
+     * @internal
+     */
+    readonly sourceIModel?: IModelConnection;
+    /** @internal chiefly for debugging */
     readonly tileId?: string;
-    /** @alpha */
-    readonly isClassifier: boolean;
-    /** Create a new HitDetail from the inputs to and results of a locate operation.
-     * @param testPoint The world coordinate space point that was used as the locate point.
-     * @param viewport The view the locate operation was performed in.
-     * @param hitSource The procedure that requested the locate operation.
-     * @param hitPoint The approximate world coordinate location on the geometry identified by this HitDetail.
-     * @param sourceId The source of the geometry, either a persistent element id or pickable decoration id.
-     * @param priority The hit geometry priority/classification.
-     * @param distXY The xy distance to hit in view coordinates.
-     * @param distFraction The near plane distance fraction to hit.
-     * @param subCategoryId The SubCategory for a persistent element hit.
-     * @param geometryClass The GeometryClass for a persistent element hit.
-     * @param iModel The IModelConnection from which the hit originated. This should almost always be left undefined, unless the hit is known to have originated from an iModel other than the one associated with the viewport.
-     * @param modelId Optionally the Id of the [[ModelState]] from which the hit originated.
-     * @param tileId Optionally the Id of the Tile from which the hit originated.
-     * @param isClassifier Optionally whether the hit originated from a reality model classification.
+    /** True if the hit originated from a reality model classifier.
+     * @alpha
+     */
+    readonly isClassifier?: boolean;
+    /** Information about the [ViewAttachment]($backend) within which the hit geometry resides, if any.
+     * @note Only [[SheetViewState]]s can have view attachments.
+     * @beta
+     */
+    readonly viewAttachment?: ViewAttachmentHitInfo;
+}
+/** A HitDetail stores the result when locating geometry displayed in a view.
+ * It holds an approximate location on an element (or decoration) from a *pick*.
+ * @public
+ * @extensions
+ */
+export declare class HitDetail {
+    private readonly _props;
+    /** The point in world coordinates that was used as the initial locate point. */
+    get testPoint(): Point3d;
+    /** The viewport in which the locate operation was performed. */
+    get viewport(): ScreenViewport;
+    /** The procedure that requested the locate operation. */
+    get hitSource(): HitSource;
+    /** The approximate location in world coordinates on the geometry identified by this HitDetail. */
+    get hitPoint(): Point3d;
+    /** The source of the geometry. This may be a persistent element Id, or a transient Id used for, e.g., pickable decorations. */
+    get sourceId(): Id64String;
+    /** The hit geometry priority/classification. */
+    get priority(): HitPriority;
+    /** The xy distance to the hit in view coordinates. */
+    get distXY(): number;
+    /** The distance in view coordinates between the hit and the near plane. */
+    get distFraction(): number;
+    /** The [SubCategory]($backend) to which the hit geometry belongs. */
+    get subCategoryId(): Id64String | undefined;
+    /** The class of the hit geometry. */
+    get geometryClass(): GeometryClass | undefined;
+    /** The Id of the [[ModelState]] from which the hit originated. */
+    get modelId(): string | undefined;
+    /** The IModelConnection from which the hit originated.
+     * This should almost always be left undefined, unless the hit is known to have originated from an iModel
+     * other than the one associated with the viewport.
+     * @internal
+     */
+    get sourceIModel(): IModelConnection | undefined;
+    /** @internal chiefly for debugging */
+    get tileId(): string | undefined;
+    /** True if the hit originated from a reality model classifier.
+     * @alpha
+     */
+    get isClassifier(): boolean | undefined;
+    /** Information about the [ViewAttachment]($backend) within which the hit geometry resides, if any.
+     * @note Only [[SheetViewState]]s can have view attachments.
+     * @beta
      */
-    constructor(testPoint: Point3d, viewport: ScreenViewport, hitSource: HitSource, hitPoint: Point3d, sourceId: string, priority: HitPriority, distXY: number, distFraction: number, subCategoryId?: string | undefined, geometryClass?: GeometryClass | undefined, modelId?: string | undefined, iModel?: IModelConnection, tileId?: string, isClassifier?: boolean);
+    get viewAttachment(): ViewAttachmentHitInfo | undefined;
+    /** Create a new HitDetail from the inputs to and results of a locate operation. */
+    constructor(props: HitDetailProps);
+    /** @deprecated in 4.1. Use the overload that takes a [[HitDetailProps]]. */
+    constructor(testPoint: Point3d, viewport: ScreenViewport, hitSource: HitSource, hitPoint: Point3d, sourceId: string, priority: HitPriority, distXY: number, distFraction: number, subCategoryId?: string, geometryClass?: GeometryClass, modelId?: string, sourceIModel?: IModelConnection, tileId?: string, isClassifier?: boolean);
     /** Get the type of HitDetail.
      * @returns HitDetailType.Hit if this is a HitDetail, HitDetailType.Snap if it is a SnapDetail
      */

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

@@ -1 +1 @@
-{"version":3,"file":"HitDetail.d.ts","sourceRoot":"","sources":["../../src/HitDetail.ts"],"names":[],"mappings":"AAQA,OAAO,EAAS,cAAc,EAAqC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACxI,OAAO,EAAE,aAAa,EAAc,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAe,MAAM,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C;;;GAGG;AACH,oBAAY,QAAQ;IAClB,OAAO,IAAI;IACX,eAAe,IAAS;IACxB,QAAQ,IAAS;IACjB,MAAM,IAAS;IACf,MAAM,KAAS;IACf,QAAQ,KAAS;IACjB,YAAY,KAAS;CACtB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,IAAI,IAAI;IACR,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,YAAY,IAAI;IAChB,QAAQ,IAAI;IACZ,aAAa,IAAI;IACjB,SAAS,IAAI;IACb,WAAW,IAAI;IACf,UAAU,IAAI;IACd,YAAY,IAAI;CACjB;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,IAAI,IAAI;IACR,KAAK,IAAI;IACT,OAAO,IAAI;IACX,KAAK,IAAI;IACT,GAAG,IAAI;IACP,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,QAAQ,IAAI;IACZ,UAAU,IAAI;IACd,aAAa,IAAI;IACjB,cAAc,IAAI;IAClB,aAAa,IAAI;IACjB,gBAAgB,IAAI;IACpB,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,GAAG,IAAI;IACP,IAAI,IAAI;IACR,YAAY,IAAI;CACjB;AAED;;;;GAIG;AACH,qBAAa,SAAS;aAuBe,SAAS,EAAE,OAAO;aAAkB,QAAQ,EAAE,cAAc;aAAkB,SAAS,EAAE,SAAS;aACnH,QAAQ,EAAE,OAAO;aAAkB,QAAQ,EAAE,MAAM;aAAkB,QAAQ,EAAE,WAAW;aAAkB,MAAM,EAAE,MAAM;aAAkB,YAAY,EAAE,MAAM;aAChK,aAAa,CAAC;aAA0B,aAAa,CAAC;aAAiC,OAAO,CAAC;IAxBjH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAmB;IAC5C,uCAAuC;IACvC,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChC,aAAa;IACb,SAAgB,YAAY,EAAE,OAAO,CAAC;IAEtC;;;;;;;;;;;;;;;OAeG;gBACgC,SAAS,EAAE,OAAO,EAAkB,QAAQ,EAAE,cAAc,EAAkB,SAAS,EAAE,SAAS,EACnH,QAAQ,EAAE,OAAO,EAAkB,QAAQ,EAAE,MAAM,EAAkB,QAAQ,EAAE,WAAW,EAAkB,MAAM,EAAE,MAAM,EAAkB,YAAY,EAAE,MAAM,EAChK,aAAa,CAAC,oBAAQ,EAAkB,aAAa,CAAC,2BAAe,EAAkB,OAAO,CAAC,oBAAQ,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO;IAM7L;;OAEG;IACI,UAAU,IAAI,aAAa;IAElC;;OAEG;IACI,QAAQ,IAAI,OAAO;IAE1B,+EAA+E;IACxE,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO;IAC/C,yFAAyF;IACzF,IAAW,YAAY,IAAI,OAAO,CAA+E;IAEjH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,QAAQ,IAAI,OAAO,CAA8D;IAE5F,2CAA2C;IACpC,KAAK,IAAI,SAAS;IAKzB,gFAAgF;IACzE,IAAI,CAAC,QAAQ,EAAE,eAAe;IAIrC,kDAAkD;IACrC,UAAU,IAAI,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;IAOxD;;;OAGG;IACH,IAAW,MAAM,IAAI,gBAAgB,CAA6E;IAElH;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAAiD;CAC3F;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,SAAS;IAsBI,QAAQ,EAAE,QAAQ;IAA4B,IAAI,EAAE,QAAQ;IArBvG,2DAA2D;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IACvB,gCAAgC;IAChC,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,6DAA6D;IAC7D,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,gCAAgC;IACzB,SAAS,CAAC,EAAE,cAAc,CAAC;IAClC,kCAAkC;IAC3B,MAAM,CAAC,EAAE,QAAQ,CAAC;IACzB,yCAAyC;IAClC,QAAQ,CAAC,EAAE,WAAW,CAAC;IAC9B,yCAAyC;IAClC,cAAc,CAAC,EAAE,iBAAiB,CAAC;IAE1C;;;;;OAKG;gBACgB,IAAI,EAAE,SAAS,EAAS,QAAQ,GAAE,QAA2B,EAAS,IAAI,GAAE,QAAwB,EAAE,SAAS,CAAC,EAAE,QAAQ;IAO7I,mCAAmC;IACnB,UAAU,IAAI,aAAa;IAC3C,gFAAgF;IAChE,QAAQ,IAAI,OAAO;IACnC,qGAAqG;IACrG,IAAW,KAAK,IAAI,OAAO,CAAwC;IACnE,gLAAgL;IAChL,IAAW,eAAe,IAAI,OAAO,CAA6D;IAClG,6BAA6B;IACtB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ;IAMlD,mEAAmE;IAC5D,iBAAiB,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,WAAW,GAAG,IAAI;IA8B5G,sCAAsC;IACtB,KAAK,IAAI,UAAU;IAa5B,iBAAiB,CAAC,aAAa,GAAE,OAAc,GAAG,cAAc,GAAG,SAAS;IAoBnE,IAAI,CAAC,OAAO,EAAE,eAAe;IAgC7C,OAAO,CAAC,MAAM,CAAC,gBAAgB;CAYhC;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,UAAU;aAC6D,cAAc,EAAE,cAAc;aAAkB,OAAO,EAAE,MAAM;gBAAtJ,IAAI,EAAE,UAAU,EAAE,IAAI,sBAA0B,EAAE,SAAS,EAAE,QAAQ,EAAkB,cAAc,EAAE,cAAc,EAAkB,OAAO,EAAE,MAAM;IAMzJ,IAAI,CAAC,OAAO,EAAE,eAAe;CAsB9C;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,SAAS,SAAS;IAC/B,IAAI,EAAE,CAAC,EAAE,CAAM;IACf,OAAO,SAAM;IACpB,IAAW,MAAM,IAAI,MAAM,CAA6B;IACjD,KAAK,IAAI,IAAI;IAKb,eAAe,IAAI,IAAI;IAE9B;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAO5C,uFAAuF;IAChF,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI;IAMzC,SAAS,IAAI,IAAI;IAOjB,UAAU,IAAI,CAAC,GAAG,SAAS;IAK3B,aAAa,IAAI,CAAC,GAAG,SAAS;IAE9B,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI;IAQlC,4CAA4C;IACrC,gBAAgB;IAEvB,gCAAgC;IACzB,SAAS,CAAC,MAAM,EAAE,MAAM;IAa/B,mFAAmF;IAC5E,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAchD,OAAO,CAAC,oBAAoB;IAgB5B,gDAAgD;IACzC,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAkCpF,2FAA2F;IACpF,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM;IAiBhC,4DAA4D;IACrD,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI;CAM1C"}
+{"version":3,"file":"HitDetail.d.ts","sourceRoot":"","sources":["../../src/HitDetail.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAgB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAS,cAAc,EAAqC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACxI,OAAO,EAAE,aAAa,EAAc,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAe,MAAM,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtD;;;GAGG;AACH,oBAAY,QAAQ;IAClB,OAAO,IAAI;IACX,eAAe,IAAS;IACxB,QAAQ,IAAS;IACjB,MAAM,IAAS;IACf,MAAM,KAAS;IACf,QAAQ,KAAS;IACjB,YAAY,KAAS;CACtB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,IAAI,IAAI;IACR,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,YAAY,IAAI;IAChB,QAAQ,IAAI;IACZ,aAAa,IAAI;IACjB,SAAS,IAAI;IACb,WAAW,IAAI;IACf,UAAU,IAAI;IACd,YAAY,IAAI;CACjB;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,IAAI,IAAI;IACR,KAAK,IAAI;IACT,OAAO,IAAI;IACX,KAAK,IAAI;IACT,GAAG,IAAI;IACP,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;CACT;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,QAAQ,IAAI;IACZ,UAAU,IAAI;IACd,aAAa,IAAI;IACjB,cAAc,IAAI;IAClB,aAAa,IAAI;IACjB,gBAAgB,IAAI;IACpB,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,GAAG,IAAI;IACP,IAAI,IAAI;IACR,YAAY,IAAI;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,kGAAkG;IAClG,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,+HAA+H;IAC/H,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,qEAAqE;IACrE,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAC;IACpC,qCAAqC;IACrC,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IACzC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CACjD;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IAExC,gFAAgF;IAChF,IAAW,SAAS,IAAI,OAAO,CAAkC;IACjE,gEAAgE;IAChE,IAAW,QAAQ,IAAI,cAAc,CAAiC;IACtE,yDAAyD;IACzD,IAAW,SAAS,IAAI,SAAS,CAAkC;IACnE,kGAAkG;IAClG,IAAW,QAAQ,IAAI,OAAO,CAAiC;IAC/D,+HAA+H;IAC/H,IAAW,QAAQ,IAAI,UAAU,CAAiC;IAClE,gDAAgD;IAChD,IAAW,QAAQ,IAAI,WAAW,CAAiC;IACnE,sDAAsD;IACtD,IAAW,MAAM,IAAI,MAAM,CAA+B;IAC1D,2EAA2E;IAC3E,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,qEAAqE;IACrE,IAAW,aAAa,IAAI,UAAU,GAAG,SAAS,CAAsC;IACxF,qCAAqC;IACrC,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAAsC;IAC3F,kEAAkE;IAClE,IAAW,OAAO,IAAI,MAAM,GAAG,SAAS,CAAgC;IACxE;;;;OAIG;IACH,IAAW,YAAY,IAAI,gBAAgB,GAAG,SAAS,CAAqC;IAC5F,sCAAsC;IACtC,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,GAAG,SAAS,CAAqC;IACnF;;;OAGG;IACH,IAAW,cAAc,IAAI,qBAAqB,GAAG,SAAS,CAAuC;IAErG,mFAAmF;gBAChE,KAAK,EAAE,cAAc;IAExC,4EAA4E;gBACzD,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO;IA8C1U;;OAEG;IACI,UAAU,IAAI,aAAa;IAElC;;OAEG;IACI,QAAQ,IAAI,OAAO;IAE1B,+EAA+E;IACxE,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO;IAC/C,yFAAyF;IACzF,IAAW,YAAY,IAAI,OAAO,CAA+E;IAEjH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,QAAQ,IAAI,OAAO,CAA6D;IAE3F,2CAA2C;IACpC,KAAK,IAAI,SAAS;IAIzB,gFAAgF;IACzE,IAAI,CAAC,QAAQ,EAAE,eAAe;IAIrC,kDAAkD;IACrC,UAAU,IAAI,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;IAOxD;;;OAGG;IACH,IAAW,MAAM,IAAI,gBAAgB,CAEpC;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;CACF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,SAAS;IAsBI,QAAQ,EAAE,QAAQ;IAA4B,IAAI,EAAE,QAAQ;IArBvG,2DAA2D;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IACvB,gCAAgC;IAChC,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,6DAA6D;IAC7D,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,gCAAgC;IACzB,SAAS,CAAC,EAAE,cAAc,CAAC;IAClC,kCAAkC;IAC3B,MAAM,CAAC,EAAE,QAAQ,CAAC;IACzB,yCAAyC;IAClC,QAAQ,CAAC,EAAE,WAAW,CAAC;IAC9B,yCAAyC;IAClC,cAAc,CAAC,EAAE,iBAAiB,CAAC;IAE1C;;;;;OAKG;gBACgB,IAAI,EAAE,SAAS,EAAS,QAAQ,GAAE,QAA2B,EAAS,IAAI,GAAE,QAAwB,EAAE,SAAS,CAAC,EAAE,QAAQ;IAO7I,mCAAmC;IACnB,UAAU,IAAI,aAAa;IAC3C,gFAAgF;IAChE,QAAQ,IAAI,OAAO;IACnC,qGAAqG;IACrG,IAAW,KAAK,IAAI,OAAO,CAAwC;IACnE,gLAAgL;IAChL,IAAW,eAAe,IAAI,OAAO,CAA6D;IAClG,6BAA6B;IACtB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ;IAMlD,mEAAmE;IAC5D,iBAAiB,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,WAAW,GAAG,IAAI;IA8B5G,sCAAsC;IACtB,KAAK,IAAI,UAAU;IAa5B,iBAAiB,CAAC,aAAa,GAAE,OAAc,GAAG,cAAc,GAAG,SAAS;IAoBnE,IAAI,CAAC,OAAO,EAAE,eAAe;IAgC7C,OAAO,CAAC,MAAM,CAAC,gBAAgB;CAYhC;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,UAAU;aAC6D,cAAc,EAAE,cAAc;aAAkB,OAAO,EAAE,MAAM;gBAAtJ,IAAI,EAAE,UAAU,EAAE,IAAI,sBAA0B,EAAE,SAAS,EAAE,QAAQ,EAAkB,cAAc,EAAE,cAAc,EAAkB,OAAO,EAAE,MAAM;IAMzJ,IAAI,CAAC,OAAO,EAAE,eAAe;CAsB9C;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,SAAS,SAAS;IAC/B,IAAI,EAAE,CAAC,EAAE,CAAM;IACf,OAAO,SAAM;IACpB,IAAW,MAAM,IAAI,MAAM,CAA6B;IACjD,KAAK,IAAI,IAAI;IAKb,eAAe,IAAI,IAAI;IAE9B;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAO5C,uFAAuF;IAChF,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI;IAMzC,SAAS,IAAI,IAAI;IAOjB,UAAU,IAAI,CAAC,GAAG,SAAS;IAK3B,aAAa,IAAI,CAAC,GAAG,SAAS;IAE9B,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI;IAQlC,4CAA4C;IACrC,gBAAgB;IAEvB,gCAAgC;IACzB,SAAS,CAAC,MAAM,EAAE,MAAM;IAa/B,mFAAmF;IAC5E,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAchD,OAAO,CAAC,oBAAoB;IAgB5B,gDAAgD;IACzC,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAkCpF,2FAA2F;IACpF,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM;IAiBhC,4DAA4D;IACrD,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI;CAM1C"}

package/lib/esm/HitDetail.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module LocatingElements
  */
-import { Id64 } from "@itwin/core-bentley";
+import { assert, Id64 } from "@itwin/core-bentley";
 import { Arc3d, LineSegment3d, LineString3d, Path, Point3d } from "@itwin/core-geometry";
 import { LinePixels } from "@itwin/core-common";
 import { IModelApp } from "./IModelApp";
@@ -108,37 +108,87 @@ export var HitDetailType;
  * @extensions
  */
 export class HitDetail {
-    /** Create a new HitDetail from the inputs to and results of a locate operation.
-     * @param testPoint The world coordinate space point that was used as the locate point.
-     * @param viewport The view the locate operation was performed in.
-     * @param hitSource The procedure that requested the locate operation.
-     * @param hitPoint The approximate world coordinate location on the geometry identified by this HitDetail.
-     * @param sourceId The source of the geometry, either a persistent element id or pickable decoration id.
-     * @param priority The hit geometry priority/classification.
-     * @param distXY The xy distance to hit in view coordinates.
-     * @param distFraction The near plane distance fraction to hit.
-     * @param subCategoryId The SubCategory for a persistent element hit.
-     * @param geometryClass The GeometryClass for a persistent element hit.
-     * @param iModel The IModelConnection from which the hit originated. This should almost always be left undefined, unless the hit is known to have originated from an iModel other than the one associated with the viewport.
-     * @param modelId Optionally the Id of the [[ModelState]] from which the hit originated.
-     * @param tileId Optionally the Id of the Tile from which the hit originated.
-     * @param isClassifier Optionally whether the hit originated from a reality model classification.
+    /** The point in world coordinates that was used as the initial locate point. */
+    get testPoint() { return this._props.testPoint; }
+    /** The viewport in which the locate operation was performed. */
+    get viewport() { return this._props.viewport; }
+    /** The procedure that requested the locate operation. */
+    get hitSource() { return this._props.hitSource; }
+    /** The approximate location in world coordinates on the geometry identified by this HitDetail. */
+    get hitPoint() { return this._props.hitPoint; }
+    /** The source of the geometry. This may be a persistent element Id, or a transient Id used for, e.g., pickable decorations. */
+    get sourceId() { return this._props.sourceId; }
+    /** The hit geometry priority/classification. */
+    get priority() { return this._props.priority; }
+    /** The xy distance to the hit in view coordinates. */
+    get distXY() { return this._props.distXY; }
+    /** The distance in view coordinates between the hit and the near plane. */
+    get distFraction() { return this._props.distFraction; }
+    /** The [SubCategory]($backend) to which the hit geometry belongs. */
+    get subCategoryId() { return this._props.subCategoryId; }
+    /** The class of the hit geometry. */
+    get geometryClass() { return this._props.geometryClass; }
+    /** The Id of the [[ModelState]] from which the hit originated. */
+    get modelId() { return this._props.modelId; }
+    /** The IModelConnection from which the hit originated.
+     * This should almost always be left undefined, unless the hit is known to have originated from an iModel
+     * other than the one associated with the viewport.
+     * @internal
      */
-    constructor(testPoint, viewport, hitSource, hitPoint, sourceId, priority, distXY, distFraction, subCategoryId, geometryClass, modelId, iModel, tileId, isClassifier) {
-        this.testPoint = testPoint;
-        this.viewport = viewport;
-        this.hitSource = hitSource;
-        this.hitPoint = hitPoint;
-        this.sourceId = sourceId;
-        this.priority = priority;
-        this.distXY = distXY;
-        this.distFraction = distFraction;
-        this.subCategoryId = subCategoryId;
-        this.geometryClass = geometryClass;
-        this.modelId = modelId;
-        this._iModel = iModel;
-        this.tileId = tileId;
-        this.isClassifier = undefined !== isClassifier ? isClassifier : false;
+    get sourceIModel() { return this._props.sourceIModel; }
+    /** @internal chiefly for debugging */
+    get tileId() { return this._props.tileId; }
+    /** True if the hit originated from a reality model classifier.
+     * @alpha
+     */
+    get isClassifier() { return this._props.isClassifier; }
+    /** Information about the [ViewAttachment]($backend) within which the hit geometry resides, if any.
+     * @note Only [[SheetViewState]]s can have view attachments.
+     * @beta
+     */
+    get viewAttachment() { return this._props.viewAttachment; }
+    /** @internal */
+    constructor(arg0, viewport, hitSource, hitPoint, sourceId, priority, distXY, distFraction, subCategoryId, geometryClass, modelId, sourceIModel, tileId, isClassifier) {
+        if (arg0 instanceof Point3d) {
+            assert(undefined !== viewport && undefined !== hitSource && undefined !== hitPoint && undefined !== sourceId);
+            assert(undefined !== priority && undefined !== distXY && undefined !== distFraction);
+            this._props = {
+                testPoint: arg0,
+                viewport,
+                hitSource,
+                hitPoint,
+                sourceId,
+                priority,
+                distXY,
+                distFraction,
+                subCategoryId,
+                geometryClass,
+                modelId,
+                sourceIModel,
+                tileId,
+                isClassifier,
+            };
+        }
+        else {
+            // Tempting to use { ...arg0 } but spread operator omits getters so, e.g., if input is a HitDetail we would lose all the properties.
+            this._props = {
+                testPoint: arg0.testPoint,
+                viewport: arg0.viewport,
+                hitSource: arg0.hitSource,
+                hitPoint: arg0.hitPoint,
+                sourceId: arg0.sourceId,
+                priority: arg0.priority,
+                distXY: arg0.distXY,
+                distFraction: arg0.distFraction,
+                subCategoryId: arg0.subCategoryId,
+                geometryClass: arg0.geometryClass,
+                modelId: arg0.modelId,
+                sourceIModel: arg0.sourceIModel,
+                tileId: arg0.tileId,
+                isClassifier: arg0.isClassifier,
+                viewAttachment: arg0.viewAttachment,
+            };
+        }
     }
     /** Get the type of HitDetail.
      * @returns HitDetailType.Hit if this is a HitDetail, HitDetailType.Snap if it is a SnapDetail
@@ -157,11 +207,10 @@ export class HitDetail {
         return this.modelId === this.sourceId;
     }
     // return whether the hit point is from map.
-    get isMapHit() { return undefined !== this.viewport.mapLayerFromHit(this); }
+    get isMapHit() { return 0 !== this.viewport.mapLayerFromHit(this).length; }
     /** Create a deep copy of this HitDetail */
     clone() {
-        const val = new HitDetail(this.testPoint, this.viewport, this.hitSource, this.hitPoint, this.sourceId, this.priority, this.distXY, this.distFraction, this.subCategoryId, this.geometryClass, this.modelId, this._iModel, this.tileId, this.isClassifier);
-        return val;
+        return new HitDetail(this);
     }
     /** Draw this HitDetail as a Decoration. Causes the picked element to *flash* */
     draw(_context) {
@@ -178,11 +227,15 @@ export class HitDetail {
      * for example, if a [[TiledGraphicsProvider]] is used to display graphics from a different iModel in the viewport.
      * This HitDetail's element, subcategory, and model Ids are defined in the context of this IModelConnection.
      */
-    get iModel() { return undefined !== this._iModel ? this._iModel : this.viewport.iModel; }
+    get iModel() {
+        return this.sourceIModel ?? this.viewport.iModel;
+    }
     /** Returns true if this hit originated from an [[IModelConnection]] other than the one associated with the [[Viewport]].
      * @see [[iModel]].
      */
-    get isExternalIModelHit() { return this.iModel !== this.viewport.iModel; }
+    get isExternalIModelHit() {
+        return this.iModel !== this.viewport.iModel;
+    }
 }
 /** A SnapDetail is generated from the result of a snap request. In addition to the HitDetail about the reason the element was *picked*,
  * it holds the *exact* point on the element from the snapping logic, plus additional information that varies with the type of element and snap mode.
@@ -197,7 +250,7 @@ export class SnapDetail extends HitDetail {
      * @param snapPoint The snapped point in the element
      */
     constructor(from, snapMode = SnapMode.Nearest, heat = SnapHeat.None, snapPoint) {
-        super(from.testPoint, from.viewport, from.hitSource, from.hitPoint, from.sourceId, from.priority, from.distXY, from.distFraction, from.subCategoryId, from.geometryClass, from.modelId, from.iModel, from.tileId, from.isClassifier);
+        super(from);
         this.snapMode = snapMode;
         this.heat = heat;
         this.snapPoint = Point3d.fromJSON(snapPoint ? snapPoint : from.hitPoint);