@itwin/core-backend 5.1.0-dev.3 → 5.1.0-dev.32

package/lib/esm/ViewDefinition.js

@@ -5,14 +5,14 @@
 /** @packageDocumentation
  * @module ViewDefinitions
  */
-import { Id64, IModelStatus, JsonUtils } from "@itwin/core-bentley";
+import { DbResult, Id64, IModelStatus, JsonUtils } from "@itwin/core-bentley";
 import { Angle, Matrix3d, Point2d, Point3d, StandardViewIndex, Transform, Vector3d, YawPitchRollAngles, } from "@itwin/core-geometry";
 import { BisCodeSpec, Camera, Code, ConcreteEntityTypes, IModelError, RelatedElement, ViewDetails, ViewDetails3d, } from "@itwin/core-common";
 import { DefinitionElement, GraphicalElement2d, SpatialLocationElement } from "./Element";
 /** Holds the list of Ids of GeometricModels displayed by a [[SpatialViewDefinition]]. Multiple SpatialViewDefinitions may point to the same ModelSelector.
  * @see [ModelSelectorState]($frontend)
  * See [how to create a ModelSelector]$(docs/learning/backend/CreateElements.md#ModelSelector).
- * @public
+ * @public @preview
  */
 export class ModelSelector extends DefinitionElement {
     static get className() { return "ModelSelector"; }
@@ -27,6 +27,33 @@ export class ModelSelector extends DefinitionElement {
         val.models = this.models;
         return val;
     }
+    /**
+     * ModelSelector custom HandledProps includes 'models'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "models", source: "Class" },
+    ];
+    /**
+     * ModelSelector deserializes 'models'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        elProps.models = props.iModel.withPreparedStatement("SELECT TargetECInstanceId FROM Bis.ModelSelectorRefersToModels WHERE SourceECInstanceId=?", (statement) => {
+            statement.bindId(1, instance.id);
+            const ids = [];
+            while (DbResult.BE_SQLITE_ROW === statement.step()) {
+                ids.push(statement.getValue(0).getId());
+            }
+            return ids;
+        });
+        return elProps;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         this.models.forEach((modelId) => referenceIds.addModel(modelId));
@@ -76,7 +103,7 @@ export class ModelSelector extends DefinitionElement {
 /** Holds a list of Ids of Categories to be displayed in a view.
  * @see [CategorySelectorState]($frontend)
  * See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).
- * @public
+ * @public @preview
  */
 export class CategorySelector extends DefinitionElement {
     static get className() { return "CategorySelector"; }
@@ -91,6 +118,33 @@ export class CategorySelector extends DefinitionElement {
         val.categories = this.categories;
         return val;
     }
+    /**
+     * CategorySelector custom HandledProps includes 'categories'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "categories", source: "Class" },
+    ];
+    /**
+     * CategorySelector deserializes 'categories'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        elProps.categories = props.iModel.withPreparedStatement("SELECT TargetECInstanceId FROM Bis.CategorySelectorRefersToCategories WHERE SourceECInstanceId=?", (statement) => {
+            statement.bindId(1, instance.id);
+            const ids = [];
+            while (DbResult.BE_SQLITE_ROW === statement.step()) {
+                ids.push(statement.getValue(0).getId());
+            }
+            return ids;
+        });
+        return elProps;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         this.categories.forEach((categoryId) => referenceIds.addElement(categoryId));
@@ -142,7 +196,7 @@ export class CategorySelector extends DefinitionElement {
  * plus additional view-specific parameters in their [[Element.jsonProperties]].
  * Subclasses of ViewDefinition determine which model(s) are viewed.
  * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
- * @public
+ * @public @preview
  */
 export class ViewDefinition extends DefinitionElement {
     static get className() { return "ViewDefinition"; }
@@ -159,6 +213,40 @@ export class ViewDefinition extends DefinitionElement {
         if (!Id64.isValid(this.displayStyleId))
             throw new IModelError(IModelStatus.BadArg, `displayStyleId is invalid`);
     }
+    /**
+     * ViewDefinition custom HandledProps includes 'categorySelector', and 'displayStyle'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "categorySelector", source: "Class" },
+        { propertyName: "displayStyle", source: "Class" },
+    ];
+    /**
+     * ViewDefinition deserializes 'categorySelector', and 'displayStyle'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        if (instance.isPrivate !== undefined)
+            elProps.isPrivate = instance.isPrivate;
+        elProps.categorySelectorId = instance.categorySelector.id;
+        elProps.displayStyleId = instance.displayStyle.id;
+        return elProps;
+    }
+    /**
+     * ViewDefinition serializes 'categorySelector', and 'displayStyle'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const inst = super.serialize(props, _iModel);
+        inst.categorySelector.id = props.categorySelectorId;
+        inst.displayStyle.id = props.displayStyleId;
+        return inst;
+    }
     toJSON() {
         const json = super.toJSON();
         json.categorySelectorId = this.categorySelectorId;
@@ -225,7 +313,7 @@ export class ViewDefinition extends DefinitionElement {
     }
 }
 /** Defines a view of one or more 3d models.
- * @public
+ * @public @preview
  */
 export class ViewDefinition3d extends ViewDefinition {
     _details;
@@ -249,6 +337,59 @@ export class ViewDefinition3d extends ViewDefinition {
         this.camera = new Camera(props.camera);
         this._details = new ViewDetails3d(this.jsonProperties);
     }
+    /**
+     * ViewDefinition3d custom HandledProps includes 'eyePoint', 'focusDistance', 'lensAngle', 'yaw', 'pitch', 'roll',
+     * 'origin', 'extents', and 'isCameraOn'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "eyePoint", source: "Class" },
+        { propertyName: "focusDistance", source: "Class" },
+        { propertyName: "lensAngle", source: "Class" },
+        { propertyName: "yaw", source: "Class" },
+        { propertyName: "roll", source: "Class" },
+        { propertyName: "pitch", source: "Class" },
+        { propertyName: "origin", source: "Class" },
+        { propertyName: "extents", source: "Class" },
+        { propertyName: "isCameraOn", source: "Class" },
+    ];
+    /**
+     * ViewDefinition3d deserializes 'eyePoint', 'focusDistance', 'lensAngle', 'yaw', 'pitch', 'roll',
+     * 'origin', 'extents', and 'isCameraOn'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const instance = props.row;
+        const elProps = super.deserialize(props);
+        // ViewDefinition3dProps
+        elProps.cameraOn = instance.isCameraOn;
+        elProps.origin = [instance.origin.x, instance.origin.y, instance.origin.z];
+        elProps.extents = [instance.extents.x, instance.extents.y, instance.extents.z];
+        elProps.camera = { eye: [instance.eyePoint.x, instance.eyePoint.y, instance.eyePoint.z], focusDist: instance.focusDistance, lens: Angle.createRadians(instance.lensAngle).toJSON() };
+        elProps.angles = YawPitchRollAngles.createDegrees(instance.yaw ?? 0, instance.pitch ?? 0, instance.roll ?? 0).toJSON();
+        return elProps;
+    }
+    /**
+     * ViewDefinition3d serializes 'eyePoint', 'focusDistance', 'lensAngle', 'yaw', 'pitch', 'roll',
+     * 'origin', 'extents', and 'isCameraOn'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const row = super.serialize(props, _iModel);
+        row.isCameraOn = props.cameraOn;
+        row.eyePoint = props.camera.eye;
+        row.focusDistance = props.camera.focusDist;
+        row.lensAngle = props.camera.lens;
+        if (props.angles) {
+            row.yaw = props.angles.yaw;
+            row.roll = props.angles.roll;
+            row.pitch = props.angles.pitch;
+        }
+        return row;
+    }
     toJSON() {
         const val = super.toJSON();
         val.cameraOn = this.cameraOn;
@@ -273,7 +414,7 @@ export class ViewDefinition3d extends ViewDefinition {
  *        * ModelIds  -------> SpatialModels    <----------GeometricElement3d.Model
  *    * CategorySelector
  *        * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
- * @public
+ * @public @preview
  */
 export class SpatialViewDefinition extends ViewDefinition3d {
     static get className() { return "SpatialViewDefinition"; }
@@ -294,6 +435,35 @@ export class SpatialViewDefinition extends ViewDefinition3d {
         json.modelSelectorId = this.modelSelectorId;
         return json;
     }
+    /**
+     * SpatialViewDefinition custom HandledProps includes 'modelSelector'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "modelSelector", source: "Class" },
+    ];
+    /**
+     * SpatialViewDefinition deserializes 'modelSelector'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        elProps.modelSelectorId = instance.modelSelector.id;
+        return elProps;
+    }
+    /**
+     * SpatialViewDefinition serializes 'modelSelector'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const inst = super.serialize(props, _iModel);
+        inst.modelSelector.id = props.modelSelectorId;
+        return inst;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         referenceIds.addElement(this.modelSelectorId);
@@ -358,7 +528,7 @@ export class SpatialViewDefinition extends ViewDefinition3d {
 }
 /** Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
  * See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
- * @public
+ * @public @preview
  */
 export class OrthographicViewDefinition extends SpatialViewDefinition {
     static get className() { return "OrthographicViewDefinition"; }
@@ -423,7 +593,7 @@ export class OrthographicViewDefinition extends SpatialViewDefinition {
     }
 }
 /** Defines a view of a single 2d model. Each 2d model has its own coordinate system, so only one may appear per view.
- * @public
+ * @public @preview
  */
 export class ViewDefinition2d extends ViewDefinition {
     _details;
@@ -452,6 +622,44 @@ export class ViewDefinition2d extends ViewDefinition {
         val.angle = this.angle;
         return val;
     }
+    /**
+     * ViewDefinition2d custom HandledProps includes 'baseModel', 'origin', 'extents', and 'rotationAngle'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "baseModel", source: "Class" },
+        { propertyName: "origin", source: "Class" },
+        { propertyName: "extents", source: "Class" },
+        { propertyName: "rotationAngle", source: "Class" },
+    ];
+    /**
+     * ViewDefinition2d deserializes 'baseModel', 'origin', 'extents', and 'rotationAngle'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        elProps.baseModelId = instance.baseModel.id;
+        elProps.origin = [instance.origin.x, instance.origin.y];
+        elProps.delta = [instance.extents.x, instance.extents.y];
+        elProps.angle = instance.rotationAngle;
+        return elProps;
+    }
+    /**
+     * ViewDefinition2d serializes 'baseModel', 'origin', 'extents', and 'rotationAngle'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, _iModel) {
+        const inst = super.serialize(props, _iModel);
+        inst.baseModel.id = props.baseModelId;
+        inst.origin = props.origin;
+        inst.extents = props.delta;
+        inst.rotationAngle = props.angle;
+        return inst;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         referenceIds.addElement(this.baseModelId);
@@ -462,7 +670,7 @@ export class ViewDefinition2d extends ViewDefinition {
     loadDisplayStyle2d() { return this.iModel.elements.getElement(this.displayStyleId); }
 }
 /** Defines a view of a [[DrawingModel]].
- * @public
+ * @public @preview
  */
 export class DrawingViewDefinition extends ViewDefinition2d {
     static get className() { return "DrawingViewDefinition"; }
@@ -513,10 +721,38 @@ export class DrawingViewDefinition extends ViewDefinition2d {
     }
 }
 /** Defines a view of a [[SheetModel]].
- * @public
+ * @public @preview
  */
 export class SheetViewDefinition extends ViewDefinition2d {
     static get className() { return "SheetViewDefinition"; }
+    constructor(props, iModel) {
+        super(props, iModel);
+    }
+    /** Create a SheetViewDefinition */
+    static create(args) {
+        const { baseModelId, categorySelectorId, displayStyleId, range } = args;
+        const props = {
+            classFullName: this.classFullName,
+            model: args.definitionModelId,
+            code: this.createCode(args.iModel, args.definitionModelId, args.name),
+            baseModelId,
+            categorySelectorId,
+            displayStyleId,
+            origin: { x: range.low.x, y: range.low.y },
+            delta: range.diagonal(),
+            angle: 0,
+        };
+        return new SheetViewDefinition(props, args.iModel);
+    }
+    /** Insert a SheetViewDefinition into an IModelDb */
+    static insert(args) {
+        const view = this.create(args);
+        return args.iModel.elements.insertElement(view.toJSON());
+    }
+    /** Create a SheetViewDefinition from JSON props */
+    static fromJSON(props, iModel) {
+        return new SheetViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
+    }
 }
 /** A ViewDefinition used to display a 2d template model.
  * @internal
@@ -532,7 +768,7 @@ export class TemplateViewDefinition3d extends ViewDefinition3d {
 }
 /** An auxiliary coordinate system element. Auxiliary coordinate systems can be used by views to show
  * coordinate information in different units and/or orientations.
- * @public
+ * @public @preview
  */
 export class AuxCoordSystem extends DefinitionElement {
     static get className() { return "AuxCoordSystem"; }
@@ -545,7 +781,7 @@ export class AuxCoordSystem extends DefinitionElement {
     }
 }
 /** A 2d auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 export class AuxCoordSystem2d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem2d"; }
@@ -567,7 +803,7 @@ export class AuxCoordSystem2d extends AuxCoordSystem {
     }
 }
 /** A 3d auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 export class AuxCoordSystem3d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem3d"; }
@@ -593,7 +829,7 @@ export class AuxCoordSystem3d extends AuxCoordSystem {
     }
 }
 /** A spatial auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 export class AuxCoordSystemSpatial extends AuxCoordSystem3d {
     static get className() { return "AuxCoordSystemSpatial"; }
@@ -608,7 +844,7 @@ export class AuxCoordSystemSpatial extends AuxCoordSystem3d {
     }
 }
 /** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
- * @public
+ * @public @preview
  */
 export class ViewAttachment extends GraphicalElement2d {
     static get className() { return "ViewAttachment"; }