@itwin/core-frontend 5.9.0-dev.8 → 5.10.0-dev.1

package/lib/esm/ViewState.js

@@ -7,7 +7,7 @@
  */
 import { assert, BeEvent, dispose, expectDefined, Id64, JsonUtils } from "@itwin/core-bentley";
 import { Angle, AxisOrder, Constant, Geometry, Map4d, Matrix3d, Plane3dByOriginAndUnitNormal, Point2d, Point3d, Range2d, Range3d, Ray3d, Transform, Vector2d, Vector3d, YawPitchRollAngles, } from "@itwin/core-geometry";
-import { Camera, Cartographic, Frustum, GlobeMode, GridOrientationType, IModelReadRpcInterface, Npc, ViewDetails, ViewDetails3d, } from "@itwin/core-common";
+import { Camera, Cartographic, Frustum, GlobeMode, GridOrientationType, IModelReadRpcInterface, Npc, resolveNavPropId, ViewDetails, ViewDetails3d, } from "@itwin/core-common";
 import { AuxCoordSystem2dState, AuxCoordSystem3dState, AuxCoordSystemState } from "./AuxCoordSys";
 import { DisplayStyle3dState } from "./DisplayStyleState";
 import { ElementState } from "./EntityState";
@@ -175,8 +175,12 @@ export class ViewState extends ElementState {
     /** Convert to JSON representation. */
     toJSON() {
         const json = super.toJSON();
-        json.categorySelectorId = this.categorySelector.id;
-        json.displayStyleId = this.displayStyle.id;
+        json.categorySelector = { id: this.categorySelector.id };
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        json.categorySelectorId = this.categorySelector.id; // for backward compatibility
+        json.displayStyle = { id: this.displayStyle.id };
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        json.displayStyleId = this.displayStyle.id; // for backward compatibility
         json.isPrivate = this.isPrivate;
         json.description = this.description;
         return json;
@@ -283,10 +287,40 @@ export class ViewState extends ElementState {
             func(ref);
         }
     }
+    /** Iterate all [[TileTreeReference]]s associated with this view.
+     * This is a superset of [[getRealityModelTreeRefs]], it includes non-reality models as well.
+     * @see [[getRealityModelTreeRefs]] for only reality model tile tree references.
+     */
     *getTileTreeRefs() {
         yield* this.getModelTreeRefs();
         yield* this.displayStyle.getTileTreeRefs();
     }
+    /** Iterate the reality models in this view, including both context reality models attached to the
+     * [[DisplayStyleState]] and persistent reality models. Each yielded [[ViewRealityModel]] provides the
+     * [[TileTreeReference]] along with a display name and description when available.
+     *
+     * Context reality models that are marked invisible are excluded. Persistent reality models whose
+     * tile trees have not yet loaded are also excluded.
+     * @see [[DisplayStyleState.realityModels]] for context reality models only.
+     * @see [[getTileTreeRefs]] for all tile tree references in this view.
+     * @beta
+     */
+    *getRealityModelTreeRefs() {
+        // Yield visible context reality models from the display style.
+        for (const model of this.displayStyle.realityModels) {
+            if (!model.invisible)
+                yield { treeRef: model.treeRef, name: model.name, description: model.description };
+        }
+        // Yield persistent reality models (e.g., ScalableMeshModel) from the model selector.
+        for (const ref of this.getModelTreeRefs()) {
+            const modelId = ref.treeOwner.tileTree?.modelId;
+            if (modelId !== undefined) {
+                const loadedModel = this.iModel.models.getLoaded(modelId);
+                if (loadedModel?.asSpatialModel?.isRealityModel)
+                    yield { treeRef: ref, name: loadedModel.name, description: undefined };
+            }
+        }
+    }
     /** Disclose *all* TileTrees currently in use by this view. This set may include trees not reported by [[forEachTileTreeRef]] - e.g., those used by view attachments, map-draped terrain, etc.
      * @internal
      */
@@ -1799,7 +1833,8 @@ export class ViewState2d extends ViewState {
         this.origin = Point2d.fromJSON(props.origin);
         this.delta = Point2d.fromJSON(props.delta);
         this.angle = Angle.fromJSON(props.angle);
-        this._baseModelId = Id64.fromJSON(props.baseModelId);
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        this._baseModelId = Id64.fromJSON(resolveNavPropId(props.baseModel, props.baseModelId));
         this._details = new ViewDetails(this.jsonProperties);
     }
     toJSON() {
@@ -1807,7 +1842,9 @@ export class ViewState2d extends ViewState {
         val.origin = this.origin;
         val.delta = this.delta;
         val.angle = this.angle;
-        val.baseModelId = this.baseModelId;
+        val.baseModel = { id: this.baseModelId };
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        val.baseModelId = this.baseModelId; // for backward compatibility
         return val;
     }
     /** See [[ViewState.is3d]]. */