@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/cjs/ViewDefinition.js

@@ -6,7 +6,6 @@
 /** @packageDocumentation
  * @module ViewDefinitions
  */
-var _a, _b, _c, _d;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LightLocation = exports.ViewAttachment = exports.AuxCoordSystemSpatial = exports.AuxCoordSystem3d = exports.AuxCoordSystem2d = exports.AuxCoordSystem = exports.TemplateViewDefinition3d = exports.TemplateViewDefinition2d = exports.SheetViewDefinition = exports.DrawingViewDefinition = exports.ViewDefinition2d = exports.OrthographicViewDefinition = exports.SpatialViewDefinition = exports.ViewDefinition3d = exports.ViewDefinition = exports.CategorySelector = exports.ModelSelector = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
@@ -20,6 +19,8 @@ const Element_1 = require("./Element");
  */
 class ModelSelector extends Element_1.DefinitionElement {
     static get className() { return "ModelSelector"; }
+    /** The array of modelIds of the GeometricModels displayed by this ModelSelector */
+    models;
     constructor(props, iModel) {
         super(props, iModel);
         this.models = props.models;
@@ -29,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));
@@ -83,6 +111,8 @@ exports.ModelSelector = ModelSelector;
  */
 class CategorySelector extends Element_1.DefinitionElement {
     static get className() { return "CategorySelector"; }
+    /** The array of element Ids of the Categories selected by this CategorySelector */
+    categories;
     constructor(props, iModel) {
         super(props, iModel);
         this.categories = props.categories;
@@ -92,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));
@@ -146,8 +203,12 @@ exports.CategorySelector = CategorySelector;
  * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
  * @public
  */
-class ViewDefinition extends (_b = Element_1.DefinitionElement) {
+class ViewDefinition extends Element_1.DefinitionElement {
     static get className() { return "ViewDefinition"; }
+    /** The element Id of the [[CategorySelector]] for this ViewDefinition */
+    categorySelectorId;
+    /** The element Id of the [[DisplayStyle]] for this ViewDefinition */
+    displayStyleId;
     constructor(props, iModel) {
         super(props, iModel);
         this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
@@ -157,6 +218,40 @@ class ViewDefinition extends (_b = 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;
@@ -173,6 +268,14 @@ class ViewDefinition extends (_b = Element_1.DefinitionElement) {
         }
     }
     /** @beta */
+    static requiredReferenceKeys = [...super.requiredReferenceKeys, "categorySelectorId", "displayStyleId"];
+    /** @alpha */
+    static requiredReferenceKeyTypeMap = {
+        ...super.requiredReferenceKeyTypeMap,
+        categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
+        displayStyleId: core_common_1.ConcreteEntityTypes.Element,
+    };
+    /** @beta */
     static onCloned(context, sourceElementProps, targetElementProps) {
         super.onCloned(context, sourceElementProps, targetElementProps);
         if (context.isBetweenIModels && targetElementProps.jsonProperties && targetElementProps.jsonProperties.viewDetails) {
@@ -215,20 +318,22 @@ class ViewDefinition extends (_b = Element_1.DefinitionElement) {
     }
 }
 exports.ViewDefinition = ViewDefinition;
-_a = ViewDefinition;
-/** @beta */
-ViewDefinition.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "categorySelectorId", "displayStyleId"];
-/** @alpha */
-ViewDefinition.requiredReferenceKeyTypeMap = {
-    ...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
-    categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
-    displayStyleId: core_common_1.ConcreteEntityTypes.Element,
-};
 /** Defines a view of one or more 3d models.
  * @public
  */
 class ViewDefinition3d extends ViewDefinition {
+    _details;
     static get className() { return "ViewDefinition3d"; }
+    /** If true, camera is used. Otherwise, use an orthographic projection. */
+    cameraOn;
+    /** The lower left back corner of the view frustum. */
+    origin;
+    /** The extent (size) of the view frustum, in meters, along its x,y,z axes. */
+    extents;
+    /** Rotation from world coordinates to view coordinates. */
+    angles;
+    /** The camera used for this view, if `cameraOn` is true. */
+    camera;
     constructor(props, iModel) {
         super(props, iModel);
         this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
@@ -238,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;
@@ -265,8 +423,10 @@ exports.ViewDefinition3d = ViewDefinition3d;
  *        * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
  * @public
  */
-class SpatialViewDefinition extends (_d = ViewDefinition3d) {
+class SpatialViewDefinition extends ViewDefinition3d {
     static get className() { return "SpatialViewDefinition"; }
+    /** The Id of the [[ModelSelector]] for this SpatialViewDefinition. */
+    modelSelectorId;
     constructor(props, iModel) {
         super(props, iModel);
         this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
@@ -275,17 +435,53 @@ class SpatialViewDefinition extends (_d = ViewDefinition3d) {
     }
     /** Construct a SpatialViewDefinition from its JSON representation. */
     static fromJSON(props, iModel) {
-        return new _c({ ...props, classFullName: this.classFullName }, iModel);
+        return new SpatialViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
     }
     toJSON() {
         const json = super.toJSON();
         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);
     }
+    /** @beta */
+    static requiredReferenceKeys = [...super.requiredReferenceKeys, "modelSelectorId"];
+    /** @alpha */
+    static requiredReferenceKeyTypeMap = {
+        ...super.requiredReferenceKeyTypeMap,
+        modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
+    };
     /** Load this view's ModelSelector from the IModelDb. */
     loadModelSelector() { return this.iModel.elements.getElement(this.modelSelectorId); }
     /**
@@ -324,7 +520,7 @@ class SpatialViewDefinition extends (_d = ViewDefinition3d) {
             cameraOn: true,
             camera: { lens: { radians: cameraAngle }, focusDist: cameraDistance, eye: cameraLocation },
         };
-        return new _c(viewDefinitionProps, iModelDb);
+        return new SpatialViewDefinition(viewDefinitionProps, iModelDb);
     }
     /**
      * Insert an SpatialViewDefinition with the camera turned on.
@@ -338,14 +534,6 @@ class SpatialViewDefinition extends (_d = ViewDefinition3d) {
     }
 }
 exports.SpatialViewDefinition = SpatialViewDefinition;
-_c = SpatialViewDefinition;
-/** @beta */
-SpatialViewDefinition.requiredReferenceKeys = [...Reflect.get(_d, "requiredReferenceKeys", _c), "modelSelectorId"];
-/** @alpha */
-SpatialViewDefinition.requiredReferenceKeyTypeMap = {
-    ...Reflect.get(_d, "requiredReferenceKeyTypeMap", _c),
-    modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
-};
 /** 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
@@ -417,7 +605,16 @@ exports.OrthographicViewDefinition = OrthographicViewDefinition;
  * @public
  */
 class ViewDefinition2d extends ViewDefinition {
+    _details;
     static get className() { return "ViewDefinition2d"; }
+    /** The Id of the Model displayed by this view. */
+    baseModelId;
+    /** The lower-left corner of this view in Model coordinates. */
+    origin;
+    /** The delta (size) of this view, in meters, aligned with view x,y. */
+    delta;
+    /** The rotation of this view. */
+    angle;
     constructor(props, iModel) {
         super(props, iModel);
         this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
@@ -434,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);
@@ -523,7 +758,13 @@ exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
  */
 class AuxCoordSystem extends Element_1.DefinitionElement {
     static get className() { return "AuxCoordSystem"; }
-    constructor(props, iModel) { super(props, iModel); }
+    type;
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.type = props.type;
+        this.description = props.description;
+    }
 }
 exports.AuxCoordSystem = AuxCoordSystem;
 /** A 2d auxiliary coordinate system.
@@ -531,7 +772,13 @@ exports.AuxCoordSystem = AuxCoordSystem;
  */
 class AuxCoordSystem2d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem2d"; }
-    constructor(props, iModel) { super(props, iModel); }
+    origin;
+    angle;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.origin = props.origin ? core_geometry_1.Point2d.fromJSON(props.origin) : undefined;
+        this.angle = props.angle ? core_geometry_1.Angle.fromJSON(props.angle).degrees : undefined;
+    }
     /** Create a Code for a AuxCoordSystem2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem2d element and provides the scope for its name.
@@ -548,7 +795,17 @@ exports.AuxCoordSystem2d = AuxCoordSystem2d;
  */
 class AuxCoordSystem3d extends AuxCoordSystem {
     static get className() { return "AuxCoordSystem3d"; }
-    constructor(props, iModel) { super(props, iModel); }
+    origin;
+    yaw;
+    pitch;
+    roll;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.origin = props.origin ? core_geometry_1.Point3d.fromJSON(props.origin) : undefined;
+        this.yaw = props.yaw ? core_geometry_1.Angle.fromJSON(props.yaw).degrees : undefined;
+        this.pitch = props.pitch ? core_geometry_1.Angle.fromJSON(props.pitch).degrees : undefined;
+        this.roll = props.roll ? core_geometry_1.Angle.fromJSON(props.roll).degrees : undefined;
+    }
     /** Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
      * @param iModel  The IModelDb
      * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem3d element and provides the scope for its name.
@@ -581,6 +838,7 @@ exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
  */
 class ViewAttachment extends Element_1.GraphicalElement2d {
     static get className() { return "ViewAttachment"; }
+    view;
     constructor(props, iModel) {
         super(props, iModel);
         this.view = new core_common_1.RelatedElement(props.view);
@@ -597,7 +855,12 @@ exports.ViewAttachment = ViewAttachment;
  */
 class LightLocation extends Element_1.SpatialLocationElement {
     static get className() { return "LightLocation"; }
-    constructor(props, iModel) { super(props, iModel); }
+    /** Whether this light is currently turned on. */
+    enabled;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.enabled = props.enabled;
+    }
 }
 exports.LightLocation = LightLocation;
 //# sourceMappingURL=ViewDefinition.js.map