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

package/lib/cjs/ViewDefinition.js

@@ -15,7 +15,7 @@ const Element_1 = require("./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
  */
 class ModelSelector extends Element_1.DefinitionElement {
     static get className() { return "ModelSelector"; }
@@ -30,6 +30,33 @@ class ModelSelector extends Element_1.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 (core_bentley_1.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));
@@ -80,7 +107,7 @@ exports.ModelSelector = ModelSelector;
 /** 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
  */
 class CategorySelector extends Element_1.DefinitionElement {
     static get className() { return "CategorySelector"; }
@@ -95,6 +122,33 @@ class CategorySelector extends Element_1.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 (core_bentley_1.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));
@@ -147,7 +201,7 @@ exports.CategorySelector = CategorySelector;
  * 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
  */
 class ViewDefinition extends Element_1.DefinitionElement {
     static get className() { return "ViewDefinition"; }
@@ -164,6 +218,40 @@ class ViewDefinition extends Element_1.DefinitionElement {
         if (!core_bentley_1.Id64.isValid(this.displayStyleId))
             throw new core_common_1.IModelError(core_bentley_1.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;
@@ -231,7 +319,7 @@ class ViewDefinition extends Element_1.DefinitionElement {
 }
 exports.ViewDefinition = ViewDefinition;
 /** Defines a view of one or more 3d models.
- * @public
+ * @public @preview
  */
 class ViewDefinition3d extends ViewDefinition {
     _details;
@@ -255,6 +343,59 @@ class ViewDefinition3d extends ViewDefinition {
         this.camera = new core_common_1.Camera(props.camera);
         this._details = new core_common_1.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: core_geometry_1.Angle.createRadians(instance.lensAngle).toJSON() };
+        elProps.angles = core_geometry_1.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;
@@ -280,7 +421,7 @@ exports.ViewDefinition3d = ViewDefinition3d;
  *        * ModelIds  -------> SpatialModels    <----------GeometricElement3d.Model
  *    * CategorySelector
  *        * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
- * @public
+ * @public @preview
  */
 class SpatialViewDefinition extends ViewDefinition3d {
     static get className() { return "SpatialViewDefinition"; }
@@ -301,6 +442,35 @@ 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);
@@ -366,7 +536,7 @@ class SpatialViewDefinition extends ViewDefinition3d {
 exports.SpatialViewDefinition = SpatialViewDefinition;
 /** 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
  */
 class OrthographicViewDefinition extends SpatialViewDefinition {
     static get className() { return "OrthographicViewDefinition"; }
@@ -432,7 +602,7 @@ class OrthographicViewDefinition extends SpatialViewDefinition {
 }
 exports.OrthographicViewDefinition = OrthographicViewDefinition;
 /** 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
  */
 class ViewDefinition2d extends ViewDefinition {
     _details;
@@ -461,6 +631,44 @@ 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);
@@ -472,7 +680,7 @@ class ViewDefinition2d extends ViewDefinition {
 }
 exports.ViewDefinition2d = ViewDefinition2d;
 /** Defines a view of a [[DrawingModel]].
- * @public
+ * @public @preview
  */
 class DrawingViewDefinition extends ViewDefinition2d {
     static get className() { return "DrawingViewDefinition"; }
@@ -524,10 +732,38 @@ class DrawingViewDefinition extends ViewDefinition2d {
 }
 exports.DrawingViewDefinition = DrawingViewDefinition;
 /** Defines a view of a [[SheetModel]].
- * @public
+ * @public @preview
  */
 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);
+    }
 }
 exports.SheetViewDefinition = SheetViewDefinition;
 /** A ViewDefinition used to display a 2d template model.
@@ -546,7 +782,7 @@ class TemplateViewDefinition3d extends ViewDefinition3d {
 exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
 /** 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
  */
 class AuxCoordSystem extends Element_1.DefinitionElement {
     static get className() { return "AuxCoordSystem"; }
@@ -560,7 +796,7 @@ class AuxCoordSystem extends Element_1.DefinitionElement {
 }
 exports.AuxCoordSystem = AuxCoordSystem;
 /** A 2d auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 class AuxCoordSystem2d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem2d"; }
@@ -583,7 +819,7 @@ class AuxCoordSystem2d extends AuxCoordSystem {
 }
 exports.AuxCoordSystem2d = AuxCoordSystem2d;
 /** A 3d auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 class AuxCoordSystem3d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem3d"; }
@@ -610,7 +846,7 @@ class AuxCoordSystem3d extends AuxCoordSystem {
 }
 exports.AuxCoordSystem3d = AuxCoordSystem3d;
 /** A spatial auxiliary coordinate system.
- * @public
+ * @public @preview
  */
 class AuxCoordSystemSpatial extends AuxCoordSystem3d {
     static get className() { return "AuxCoordSystemSpatial"; }
@@ -626,7 +862,7 @@ class AuxCoordSystemSpatial extends AuxCoordSystem3d {
 }
 exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
 /** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
- * @public
+ * @public @preview
  */
 class ViewAttachment extends Element_1.GraphicalElement2d {
     static get className() { return "ViewAttachment"; }