3.7.0 Change Notes

Table of contents:

• AppUi
  • Static manager classes
  • ViewSelector enhancements
• Mesh intersection with ray
• Deprecations
  • @itwin/core-backend
  • @itwin/core-frontend

AppUi

Static manager classes

In an effort to reduce usage complexity and discoverability of this package, many *Manager classes are now exposed through the UiFramework entry point. The direct classes access is being deprecated.

Each initialize method have been made internal and were always called automatically internally, call to these method can be safely removed from external code.

Below is a list of the changes from this move, some of these new access point may be reworked to further reduce the complexity, so they are marked @beta. Already @deprecated method were not moved to the new interfaces.

ViewSelector Enhancements

Search functionality has been added to the ViewSelector component, allowing for additional ease when navigating between iModel views. Search functionality is optional and enabled by default. To disable search functionality, set ViewSelectorProps.searchBox to false.

Mesh intersection with ray

New functionality computes the intersection(s) of a Ray3d with a Polyface. By default, PolyfaceQuery.intersectRay3d returns a FacetLocationDetail for the first found facet that intersects the infinite line parameterized by the ray. A callback can be specified in the optional FacetIntersectOptions parameter to customize intersection processing, e.g., to filter and collect multiple intersections. Other options control whether to populate the returned detail with interpolated auxiliary vertex data: normals, uv parameters, colors, and/or the barycentric scale factors used to interpolate such data.

There is also new support for intersecting a Ray3d with a triangle or a polygon. BarycentricTriangle.intersectRay3d and BarycentricTriangle.intersectSegment return a TriangleLocationDetail for the intersection point of the plane of the triangle with the infinite line parameterized by a ray or segment. Similarly, PolygonOps.intersectRay3d returns a PolygonLocationDetail for the intersection point in the plane of the polygon. Both returned detail objects contain properties classifying where the intersection point lies with respect to the triangle/polygon, including isInsideOrOn and closest edge data.

Deprecations

@itwin/core-backend

• IModelDb.query and ECDb.query is deprecated in favor of using IModelDb.createQueryReader and ECDb.createQueryReader, respectively, and iterating over the query using the returned ECSqlReader. The createQueryReader methods accept the same parameters as the now deprecated query methods.
  E.g.,

  const reader = myIModelDb.createQueryReader("SELECT ECInstanceId FROM bis.Element", undefined, undefined);
  while (await reader.step()) {
      currentId = reader.current.ecinstanceid;
      // do something with the id
  }
  

• IModelDb.queryRowCount and ECDb.queryRowCount are deprecated. Use a subquery to count rows instead.
  E.g.,

  const reader = myDb.createQueryReader(`SELECT count(*) FROM (<query-whose-rows-to-count>)`)
  await reader.step();
  const numRows: number = reader.current[0];
  

• IModelDb.restartQuery and ECDb.restartQuery are deprecated. Instead, create a new ECSqlReader using createQueryReader and pass in the restart token as part of the config argument: E.g., { restartToken: myToken } or new QueryOptionsBuilder().setRestartToken(myToken).getOptions().

@itwin/core-frontend

• IModelConnection.query is deprecated in favor of using IModelConnection.createQueryReader and iterating over the query using the returned ECSqlReader. createQueryReader accepts the same parameters as the now deprecated query method.
  E.g.,

  const reader = myIModelConnection.createQueryReader("SELECT ECInstanceId FROM bis.Element", undefined, undefined);
  while (await reader.step()) {
      currentId = reader.current.ecinstanceid;
      // do something with the id
  }
  

• IModelConnection.queryRowCount is deprecated. Use a subquery to count rows instead.
  E.g.,

  const reader = myIModelConnection.createQueryReader(`SELECT count(*) FROM (<query-whose-rows-to-count>)`)
  await reader.step();
  const numRows: number = reader.current[0];
  

• IModelConnection.restartQuery is deprecated. Instead, create a new ECSqlReader using createQueryReader and pass in the restart token as part of the config argument: E.g., { restartToken: myToken } or new QueryOptionsBuilder().setRestartToken(myToken).getOptions().

Last Updated: 20 June, 2023