@itwin/core-frontend 5.2.0-dev.2 → 5.2.0-dev.21

package/lib/esm/IModelConnection.js

@@ -5,9 +5,9 @@
 /** @packageDocumentation
  * @module IModelConnection
  */
-import { assert, BeEvent, GeoServiceStatus, Id64, IModelStatus, Logger, OneAtATimeAction, OpenMode, TransientIdSequence, } from "@itwin/core-bentley";
+import { assert, BeEvent, expectDefined, GeoServiceStatus, Id64, IModelStatus, Logger, OneAtATimeAction, OpenMode, TransientIdSequence, } from "@itwin/core-bentley";
 import { Cartographic, CodeScopeSpec, CodeSpec, EcefLocation, ECSqlReader, FontMap, GeoCoordStatus, IModel, IModelError, IModelReadRpcInterface, mapToGeoServiceStatus, Placement2d, Placement3d, QueryBinder, QueryRowFormat, RpcManager, SnapshotIModelRpcInterface, ViewStoreRpc, } from "@itwin/core-common";
-import { Point3d, Transform } from "@itwin/core-geometry";
+import { Point3d, Range3d, Transform } from "@itwin/core-geometry";
 import { FrontendLoggerCategory } from "./common/FrontendLoggerCategory";
 import { GeoServices } from "./GeoServices";
 import { IModelApp } from "./IModelApp";
@@ -129,7 +129,6 @@ export class IModelConnection extends IModel {
         if (undefined !== ctor)
             return ctor;
         // it's not registered, we need to query its class hierarchy.
-        ctor = defaultClass; // in case we cant find a registered class that handles this class
         // wait until we get the full list of base classes from backend
         if (this.isOpen) {
             const baseClasses = await IModelReadRpcInterface.getClientForRouting(this.routingContext.token).getClassHierarchy(this.getRpcProps(), className);
@@ -147,12 +146,12 @@ export class IModelConnection extends IModel {
                 return true; // stop
             });
         }
-        return ctor; // either the baseClass handler or defaultClass if we didn't find a registered baseClass
+        return ctor ?? defaultClass; // either the baseClass handler or defaultClass if we didn't find a registered baseClass
     }
     /** @internal */
     constructor(iModelProps) {
         super(iModelProps);
-        super.initialize(iModelProps.name, iModelProps);
+        super.initialize(iModelProps.name ?? "<undefined>", iModelProps);
         this.models = new IModelConnection.Models(this);
         this.elements = new IModelConnection.Elements(this);
         this.codeSpecs = new IModelConnection.CodeSpecs(this);
@@ -298,7 +297,7 @@ export class IModelConnection extends IModel {
     async spatialToCartographicFromGcs(spatial, result) {
         if (!this.isGeoLocated && this.noGcsDefined)
             throw new IModelError(GeoServiceStatus.NoGeoLocation, "iModel is not GeoLocated");
-        const geoConverter = this.geoServices.getConverter();
+        const geoConverter = expectDefined(this.geoServices.getConverter());
         const coordResponse = await geoConverter.getGeoCoordinatesFromIModelCoordinates([spatial]);
         if (1 !== coordResponse.geoCoords.length || GeoCoordStatus.NoGCSDefined === coordResponse.geoCoords[0].s)
             throw new IModelError(GeoServiceStatus.NoGeoLocation, "iModel is not GeoLocated");
@@ -377,7 +376,7 @@ export class IModelConnection extends IModel {
     async cartographicToSpatialFromGcs(cartographic, result) {
         if (!this.isGeoLocated && this.noGcsDefined)
             throw new IModelError(GeoServiceStatus.NoGeoLocation, "iModel is not GeoLocated");
-        const geoConverter = this.geoServices.getConverter();
+        const geoConverter = expectDefined(this.geoServices.getConverter());
         const geoCoord = Point3d.create(cartographic.longitudeDegrees, cartographic.latitudeDegrees, cartographic.height); // x is longitude in degrees, y is latitude in degrees, z is height in meters...
         const coordResponse = await geoConverter.getIModelCoordinatesFromGeoCoordinates([geoCoord]);
         if (1 !== coordResponse.iModelCoords.length || GeoCoordStatus.NoGCSDefined === coordResponse.iModelCoords[0].s)
@@ -565,7 +564,7 @@ export class SnapshotConnection extends IModelConnection {
     /** Type guard for instanceof [[SnapshotConnection]] */
     isSnapshotConnection() { return true; }
     /** The Guid that identifies this iModel. */
-    get iModelId() { return super.iModelId; } // GuidString | undefined for the superclass, but required for SnapshotConnection
+    get iModelId() { return expectDefined(super.iModelId); } // GuidString | undefined for the superclass, but required for SnapshotConnection
     /** Returns `true` if [[close]] has already been called. */
     get isClosed() { return this._isClosed ? true : false; }
     _isClosed;
@@ -625,6 +624,73 @@ export class SnapshotConnection extends IModelConnection {
     /** The collection of loaded ModelState objects for an [[IModelConnection]]. */
     class Models {
         _iModel;
+        _modelExtentsQuery = `
+      SELECT
+        Model.Id AS ECInstanceId,
+        iModel_bbox_union(
+          iModel_placement_aabb(
+            iModel_placement(
+              iModel_point(Origin.X, Origin.Y, 0),
+              iModel_angles(Rotation, 0, 0),
+              iModel_bbox(
+                BBoxLow.X, BBoxLow.Y, -1,
+                BBoxHigh.X, BBoxHigh.Y, 1
+              )
+            )
+          )
+        ) AS bbox
+      FROM bis.GeometricElement2d
+      WHERE InVirtualSet(:ids64, Model.Id) AND Origin.X IS NOT NULL
+      GROUP BY Model.Id
+      UNION
+      SELECT
+        ge.Model.Id AS ECInstanceId,
+        iModel_bbox(
+          min(i.MinX), min(i.MinY), min(i.MinZ),
+          max(i.MaxX), max(i.MaxY), max(i.MaxZ)
+        ) AS bbox
+      FROM bis.SpatialIndex AS i, bis.GeometricElement3d AS ge, bis.GeometricModel3d AS gm
+      WHERE InVirtualSet(:ids64, ge.Model.Id) AND ge.ECInstanceId=i.ECInstanceId AND InVirtualSet(:ids64, gm.ECInstanceId) AND (gm.$->isNotSpatiallyLocated?=false OR gm.$->isNotSpatiallyLocated? IS NULL)
+      GROUP BY ge.Model.Id
+      UNION
+      SELECT
+        ge.Model.Id AS ECInstanceId,
+        iModel_bbox_union(
+          iModel_placement_aabb(
+            iModel_placement(
+              iModel_point(ge.Origin.X, ge.Origin.Y, ge.Origin.Z),
+              iModel_angles(ge.Yaw, ge.Pitch, ge.Roll),
+              iModel_bbox(
+                ge.BBoxLow.X, ge.BBoxLow.Y, ge.BBoxLow.Z,
+                ge.BBoxHigh.X, ge.BBoxHigh.Y, ge.BBoxHigh.Z
+              )
+            )
+          )
+        ) AS bbox
+      FROM bis.GeometricElement3d AS ge, bis.GeometricModel3d as gm
+      WHERE InVirtualSet(:ids64, ge.Model.Id) AND ge.Origin.X IS NOT NULL AND InVirtualSet(:ids64, gm.ECInstanceId) AND gm.$->isNotSpatiallyLocated?=true
+      GROUP BY ge.Model.Id`;
+        _modelExistenceQuery = `
+      WITH
+      GeometricModels AS(
+        SELECT
+          ECInstanceId
+        FROM bis.GeometricModel
+        WHERE InVirtualSet(: ids64, ECInstanceId)
+      )
+      SELECT
+        ECInstanceId,
+        true AS isGeometricModel
+      FROM GeometricModels
+      UNION ALL
+      SELECT
+        ECInstanceId,
+        false AS isGeometricModel
+      FROM bis.Model
+      WHERE InVirtualSet(: ids64, ECInstanceId)
+      AND ECInstanceId NOT IN(SELECT ECInstanceId FROM GeometricModels)`;
+        _loadedExtents = [];
+        _geometryChangedListener;
         _loaded = new Map();
         /** @internal */
         get loaded() { return this._loaded; }
@@ -635,6 +701,20 @@ export class SnapshotConnection extends IModelConnection {
         /** @internal */
         constructor(_iModel) {
             this._iModel = _iModel;
+            IModelConnection.onOpen.addListener(() => {
+                if (this._iModel.isBriefcaseConnection()) {
+                    this._geometryChangedListener = (changes) => {
+                        this._loadedExtents = this._loadedExtents.filter((extent) => !changes.some((change) => change.id === extent.id));
+                    };
+                    this._iModel.txns.onModelGeometryChanged.addListener(this._geometryChangedListener);
+                }
+            });
+            IModelConnection.onClose.addListener(() => {
+                if (this._iModel.isBriefcaseConnection() && this._geometryChangedListener) {
+                    this._iModel.txns.onModelGeometryChanged.removeListener(this._geometryChangedListener);
+                    this._geometryChangedListener = undefined;
+                }
+            });
         }
         /** The Id of the [RepositoryModel]($backend). */
         get repositoryModelId() { return "0x1"; }
@@ -687,7 +767,7 @@ export class SnapshotConnection extends IModelConnection {
             try {
                 for (const props of modelProps) {
                     const ctor = await this._iModel.findClassFor(props.classFullName, ModelState);
-                    if (undefined === this.getLoaded(props.id)) { // do not overwrite if someone else loads it while we await
+                    if (undefined !== ctor && undefined !== props.id && undefined === this.getLoaded(props.id)) { // do not overwrite if someone else loads it while we await
                         const modelState = new ctor(props, this._iModel); // create a new instance of the appropriate ModelState subclass
                         this._loaded.set(modelState.id, modelState); // save it in loaded set
                     }
@@ -711,8 +791,11 @@ export class SnapshotConnection extends IModelConnection {
          * @see [[queryExtents]] for a similar function that does not throw and produces a deterministically-ordered result.
          */
         async queryModelRanges(modelIds) {
-            const iModel = this._iModel;
-            return iModel.isOpen ? IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token).queryModelRanges(iModel.getRpcProps(), [...Id64.toIdSet(modelIds)]) : [];
+            const results = await this.queryExtents([...Id64.toIdSet(modelIds)]);
+            if (results.length === 1 && results[0].status !== IModelStatus.Success) {
+                throw new IModelError(results[0].status, "error querying model range");
+            }
+            return results.filter((x) => x.status === IModelStatus.Success).map((x) => x.extents);
         }
         /** For each [GeometricModel]($backend) specified by Id, attempts to obtain the union of the volumes of all geometric elements within that model.
          * @param modelIds The Id or Ids of the geometric models for which to obtain the extents.
@@ -721,12 +804,71 @@ export class SnapshotConnection extends IModelConnection {
          * why the extents could not be obtained (e.g., because the Id did not identify a [GeometricModel]($backend)).
          */
         async queryExtents(modelIds) {
-            const iModel = this._iModel;
-            if (!iModel.isOpen)
+            if (!this._iModel.isOpen)
                 return [];
             if (typeof modelIds === "string")
                 modelIds = [modelIds];
-            return IModelReadRpcInterface.getClientForRouting(iModel.routingContext.token).queryModelExtents(iModel.getRpcProps(), modelIds);
+            const modelExtents = [];
+            for (const modelId of modelIds) {
+                if (!Id64.isValidId64(modelId)) {
+                    modelExtents.push({ id: modelId, extents: Range3d.createNull(), status: IModelStatus.InvalidId });
+                }
+            }
+            const getUnloadedModelIds = () => modelIds.filter((modelId) => !modelExtents.some((loadedExtent) => loadedExtent.id === modelId));
+            let remainingModelIds = getUnloadedModelIds();
+            for (const modelId of remainingModelIds) {
+                const modelExtent = this._loadedExtents.find((extent) => modelId === extent.id);
+                if (modelExtent) {
+                    modelExtents.push(modelExtent);
+                }
+            }
+            remainingModelIds = getUnloadedModelIds();
+            if (remainingModelIds.length > 0) {
+                const params = new QueryBinder();
+                params.bindIdSet("ids64", remainingModelIds);
+                const extentsQueryReader = this._iModel.createQueryReader(this._modelExtentsQuery, params, {
+                    rowFormat: QueryRowFormat.UseECSqlPropertyNames,
+                });
+                for await (const row of extentsQueryReader) {
+                    const byteArray = new Uint8Array(Object.values(row.bbox));
+                    const extents = Range3d.fromArrayBuffer(byteArray.buffer);
+                    const extent = { id: row.ECInstanceId, extents, status: IModelStatus.Success };
+                    modelExtents.push(extent);
+                    this._loadedExtents.push(extent);
+                }
+            }
+            remainingModelIds = getUnloadedModelIds();
+            if (remainingModelIds.length > 0) {
+                const params = new QueryBinder();
+                params.bindIdSet("ids64", remainingModelIds);
+                const modelExistenceQueryReader = this._iModel.createQueryReader(this._modelExistenceQuery, params, {
+                    rowFormat: QueryRowFormat.UseECSqlPropertyNames,
+                });
+                for await (const row of modelExistenceQueryReader) {
+                    let extent;
+                    if (row.isGeometricModel) {
+                        extent = { id: row.ECInstanceId, extents: Range3d.createNull(), status: IModelStatus.Success };
+                    }
+                    else {
+                        extent = { id: row.ECInstanceId, extents: Range3d.createNull(), status: IModelStatus.WrongModel };
+                    }
+                    modelExtents.push(extent);
+                    this._loadedExtents.push(extent);
+                }
+            }
+            return modelIds.map((modelId) => {
+                let extent = modelExtents.find((loadedExtent) => loadedExtent.id === modelId);
+                if (extent === undefined) {
+                    extent = { id: modelId, extents: Range3d.createNull(), status: IModelStatus.NotFound };
+                    this._loadedExtents.push(extent);
+                    return extent;
+                }
+                else if (extent.status === IModelStatus.InvalidId) {
+                    extent.id = "0";
+                    return extent;
+                }
+                return extent;
+            });
         }
         /** Query for a set of ModelProps of the specified ModelQueryParams.
          * @param queryParams The query parameters. The `limit` and `offset` members should be used to page results.
@@ -1014,7 +1156,7 @@ export class SnapshotConnection extends IModelConnection {
             const views = [];
             const viewProps = await this.queryProps(queryParams);
             viewProps.forEach((viewProp) => {
-                views.push({ id: viewProp.id, name: viewProp.code.value, class: viewProp.classFullName });
+                views.push({ id: viewProp.id, name: viewProp.code.value ?? "", class: viewProp.classFullName });
             });
             return views;
         }
@@ -1047,7 +1189,7 @@ export class SnapshotConnection extends IModelConnection {
             const ctor = await this._iModel.findClassFor(className, undefined);
             if (undefined === ctor)
                 throw new IModelError(IModelStatus.WrongClass, "Invalid ViewState class", () => viewProps);
-            const viewState = ctor.createFromProps(viewProps, this._iModel);
+            const viewState = expectDefined(ctor.createFromProps(viewProps, this._iModel));
             await viewState.load(); // loads models for ModelSelector
             return viewState;
         }