@itwin/core-geometry 5.0.0-dev.1 → 5.0.0-dev.100

package/lib/esm/serialization/IModelJsonSchema.js

@@ -48,9 +48,8 @@ import { RuledSweep } from "../solid/RuledSweep";
 import { Sphere } from "../solid/Sphere";
 import { TorusPipe } from "../solid/TorusPipe";
 import { SerializationHelpers } from "./SerializationHelpers";
-// cspell:word bagof
 /**
- * `ImodelJson` namespace has classes for serializing and deserialization json objects
+ * `IModelJson` namespace has classes for serializing and deserialization json objects
  * @public
  */
 export var IModelJson;
@@ -192,10 +191,19 @@ export var IModelJson;
             return defaultValue;
         }
         static parseAxesFromVectors(json, axisOrder, createDefaultIdentity) {
-            if (Array.isArray(json) && json.length === 2) {
-                const xVector = Vector3d.fromJSON(json[0]);
-                const yVector = Vector3d.fromJSON(json[1]);
-                const matrix = Matrix3d.createRigidFromColumns(xVector, yVector, axisOrder);
+            if (Array.isArray(json)) {
+                let matrix;
+                if (json.length === 2) { // square and normalize
+                    const xVector = Vector3d.fromJSON(json[0]);
+                    const yVector = Vector3d.fromJSON(json[1]);
+                    matrix = Matrix3d.createRigidFromColumns(xVector, yVector, axisOrder);
+                }
+                else if (json.length === 3) { // preserve axes
+                    const xVector = Vector3d.fromJSON(json[0]);
+                    const yVector = Vector3d.fromJSON(json[1]);
+                    const zVector = Vector3d.fromJSON(json[2]);
+                    matrix = Matrix3d.createColumnsInAxisOrder(axisOrder, xVector, yVector, zVector);
+                }
                 if (matrix)
                     return matrix;
             }
@@ -205,23 +213,23 @@ export var IModelJson;
         }
         /**
          * Look for orientation data and convert to Matrix3d.
-         * * Search order is:
-         * * * yawPitchRollAngles
-         * * * xyVectors
-         * * * zxVectors
+         * * Search order and interpretation:
+         * * * xyzVectors - general matrix, axes preserved
+         * * * yawPitchRollAngles - right-handed rotation via axial rotations
+         * * * xyVectors - right-handed rotation, xy-plane specified, axes squared and normalized
+         * * * zxVectors - right-handed rotation, zx-plane specified, axes squared and normalized
          * @param json [in] json source data
          * @param createDefaultIdentity [in] If true and no orientation is present, return an identity matrix.  If false and no orientation is present, return undefined.
          */
         static parseOrientation(json, createDefaultIdentity) {
-            if (json.yawPitchRollAngles) {
+            if (json.xyzVectors)
+                return Reader.parseAxesFromVectors(json.xyzVectors, AxisOrder.XYZ, createDefaultIdentity);
+            if (json.yawPitchRollAngles)
                 return Reader.parseYawPitchRollAnglesToMatrix3d(json.yawPitchRollAngles);
-            }
-            else if (json.xyVectors) {
+            if (json.xyVectors)
                 return Reader.parseAxesFromVectors(json.xyVectors, AxisOrder.XYZ, createDefaultIdentity);
-            }
-            else if (json.zxVectors) {
+            if (json.zxVectors)
                 return Reader.parseAxesFromVectors(json.zxVectors, AxisOrder.ZXY, createDefaultIdentity);
-            }
             if (createDefaultIdentity)
                 return Matrix3d.createIdentity();
             return undefined;
@@ -260,7 +268,7 @@ export var IModelJson;
                 return CoordinateXYZ.create(point);
             return undefined;
         }
-        /** Parse TransitionSpiral content (right side) to TransitionSpiral3d. */
+        /** Parse `transitionSpiral` content (right side) to TransitionSpiral3d. */
         static parseTransitionSpiral(data) {
             const axes = Reader.parseOrientation(data, true);
             const origin = Reader.parsePoint3dProperty(data, "origin");
@@ -315,13 +323,13 @@ export var IModelJson;
             }
             return newCurve;
         }
-        /** Parse `bcurve` content to an InterpolationCurve3d object. */
+        /** Parse `interpolationCurve` content to an InterpolationCurve3d object. */
         static parseInterpolationCurve(data) {
             if (data === undefined)
                 return undefined;
             return InterpolationCurve3d.create(data);
         }
-        /** Parse `bcurve` content to an Akima curve object. */
+        /** Parse `akimaCurve` content to an Akima curve object. */
         static parseAkimaCurve3d(data) {
             if (data === undefined)
                 return undefined;
@@ -368,12 +376,8 @@ export var IModelJson;
                 && data.hasOwnProperty("pointIndex") && Array.isArray(data.pointIndex)) {
                 const polyface = IndexedPolyface.create();
                 const numPerFace = data.hasOwnProperty("numPerFace") ? data.numPerFace : 0;
-                if (data.hasOwnProperty("twoSided")) {
-                    const q = data.twoSided;
-                    if (q === true || q === false) {
-                        polyface.twoSided = q;
-                    }
-                }
+                // default value is true!!
+                polyface.twoSided = this.parseBooleanProperty(data, "twoSided", true) ?? true;
                 if (data.hasOwnProperty("expectedClosure")) {
                     const q = data.expectedClosure;
                     if (Number.isFinite(q)) {
@@ -404,12 +408,20 @@ export var IModelJson;
                 for (const p of data.point)
                     polyface.addPointXYZ(p[0], p[1], p[2]);
                 SerializationHelpers.announceZeroBasedIndicesFromSignedOneBasedIndices(data.pointIndex, numPerFace, (i, v) => { polyface.addPointIndex(i, v); }, () => { polyface.terminateFacet(false); });
+                if (data.hasOwnProperty("edgeMateIndex") && Array.isArray(data.edgeMateIndex)) {
+                    const edgeMateIndex = [];
+                    if (!SerializationHelpers.announceCompressedZeroBasedReflexiveIndices(data.edgeMateIndex, numPerFace, SerializationHelpers.EdgeMateIndex.BlockSeparator, SerializationHelpers.EdgeMateIndex.NoEdgeMate, (i) => edgeMateIndex.push(i))) {
+                        assert(false, "unable to deserialize json edgeMateIndex array");
+                    }
+                    polyface.data.edgeMateIndex = edgeMateIndex;
+                }
                 if (!polyface.validateAllIndices())
                     return undefined;
                 if (data.hasOwnProperty("auxData"))
                     polyface.data.auxData = Reader.parsePolyfaceAuxData(data.auxData, numPerFace);
                 if (data.hasOwnProperty("tags"))
                     polyface.data.taggedNumericData = Reader.parseTaggedNumericProps(data.tags);
+                // NOTE: faceData is ignored
                 return polyface;
             }
             return undefined;
@@ -465,11 +477,8 @@ export var IModelJson;
             const radius = Reader.parseNumberProperty(json, "radius");
             const startRadius = Reader.parseNumberProperty(json, "startRadius", radius);
             const endRadius = Reader.parseNumberProperty(json, "endRadius", startRadius);
-            const capped = Reader.parseBooleanProperty(json, "capped", false);
-            if (start
-                && end
-                && startRadius !== undefined
-                && endRadius !== undefined) {
+            const capped = Reader.parseBooleanProperty(json, "capped");
+            if (start && end && startRadius !== undefined && endRadius !== undefined) {
                 if (axes === undefined) {
                     const axisVector = Vector3d.createStartEnd(start, end);
                     const frame = Matrix3d.createRigidHeadsUp(axisVector, AxisOrder.ZXY);
@@ -477,9 +486,7 @@ export var IModelJson;
                     const vectorY = frame.columnY();
                     return Cone.createBaseAndTarget(start, end, vectorX, vectorY, startRadius, endRadius, capped);
                 }
-                else {
-                    return Cone.createBaseAndTarget(start, end, axes.columnX(), axes.columnY(), startRadius, endRadius, capped);
-                }
+                return Cone.createBaseAndTarget(start, end, axes.columnX(), axes.columnY(), startRadius, endRadius, capped);
             }
             return undefined;
         }
@@ -565,23 +572,15 @@ export var IModelJson;
         /** Parse `SphereProps` to `Sphere` instance. */
         static parseSphere(json) {
             const center = Reader.parsePoint3dProperty(json, "center");
-            // optional unqualified radius . . .
             const radius = Reader.parseNumberProperty(json, "radius");
-            // optional specific X
             const radiusX = Reader.parseNumberProperty(json, "radiusX", radius);
-            // missing Y and Z both pick up radiusX  (which may have already been defaulted from unqualified radius)
             const radiusY = Reader.parseNumberProperty(json, "radiusY", radiusX);
-            const radiusZ = Reader.parseNumberProperty(json, "radiusZ", radiusX);
-            const latitudeStartEnd = Reader.parseAngleSweepProps(json, "latitudeStartEnd"); // this may be undefined!!
-            const axes = Reader.parseOrientation(json, true);
-            const capped = Reader.parseBooleanProperty(json, "capped", false);
-            if (center !== undefined
-                && radiusX !== undefined
-                && radiusY !== undefined
-                && radiusZ !== undefined
-                && capped !== undefined) {
+            const radiusZ = Reader.parseNumberProperty(json, "radiusZ", radiusY);
+            const latitudeStartEnd = Reader.parseAngleSweepProps(json, "latitudeStartEnd");
+            const axes = Reader.parseOrientation(json, false);
+            const capped = Reader.parseBooleanProperty(json, "capped");
+            if (center && radiusX && radiusY && radiusZ)
                 return Sphere.createFromAxesAndScales(center, axes, radiusX, radiusY, radiusZ, latitudeStartEnd, capped);
-            }
             return undefined;
         }
         /** Parse RuledSweepProps to RuledSweep instance. */
@@ -706,11 +705,6 @@ export var IModelJson;
         }
     }
     IModelJson.Reader = Reader;
-    // ISSUE: include 3d in names?
-    // ISSUE: would like shorter term than lineSegment
-    // ISSUE: is arc clear?
-    // ISSUE: label center, vectorX, vector90 on arc?
-    // ISSUE: sweep data on arc -- serialize as AngleSweep?
     /**
      * Class to deserialize json objects into GeometryQuery objects
      * @public
@@ -859,63 +853,86 @@ export var IModelJson;
             const centerB = data.getCenterB();
             const vectorX = data.getVectorX();
             const vectorY = data.getVectorY();
+            const xMag = vectorX.magnitude();
+            const yMag = vectorY.magnitude();
+            const xySameLength = Geometry.isSameCoordinate(xMag, yMag);
             const axisVector = Vector3d.createStartEnd(centerA, centerB);
+            // special case of cylinder
             if (Geometry.isSameCoordinate(radiusA, radiusB)
                 && vectorX.isPerpendicularTo(axisVector)
                 && vectorY.isPerpendicularTo(axisVector)
-                && Geometry.isSameCoordinate(vectorX.magnitude(), 1.0)
-                && Geometry.isSameCoordinate(vectorY.magnitude(), 1.0)) {
+                && xySameLength
+                && Geometry.isSameCoordinate(xMag, 1.0)) {
                 return {
                     cylinder: {
                         capped: data.capped,
-                        start: data.getCenterA().toJSON(),
-                        end: data.getCenterB().toJSON(),
+                        start: centerA.toJSON(),
+                        end: centerB.toJSON(),
                         radius: radiusA,
                     },
                 };
             }
+            const coneProps = {
+                capped: data.capped,
+                start: centerA.toJSON(),
+                end: centerB.toJSON(),
+            };
+            if (Geometry.isSameCoordinate(radiusA, radiusB)) {
+                coneProps.radius = radiusA;
+            }
             else {
-                const coneProps = {
-                    capped: data.capped,
-                    start: data.getCenterA().toJSON(),
-                    end: data.getCenterB().toJSON(),
-                    startRadius: data.getRadiusA(),
-                    endRadius: data.getRadiusB(),
-                };
-                Writer.insertOrientationFromXYVectors(coneProps, vectorX, vectorY, false);
-                return { cone: coneProps };
+                coneProps.startRadius = radiusA;
+                coneProps.endRadius = radiusB;
             }
+            // always specify an orthogonal frame for backwards compatibility
+            Writer.insertOrientationFromXYVectors(coneProps, vectorX, vectorY, false);
+            // specify a general matrix if elliptical sections
+            const ellipticalSections = !xySameLength || !vectorX.isPerpendicularTo(vectorY, true);
+            if (ellipticalSections)
+                coneProps.xyzVectors = [vectorX.toJSON(), vectorY.toJSON(), axisVector.toJSON()];
+            return { cone: coneProps };
         }
         /** Convert strongly typed instance to tagged json */
         handleSphere(data) {
             const xData = data.cloneVectorX().normalizeWithLength();
             const yData = data.cloneVectorY().normalizeWithLength();
             const zData = data.cloneVectorZ().normalizeWithLength();
+            if (!xData.v || !yData.v || !zData.v)
+                return undefined;
+            const rigid = Matrix3d.createIdentity();
+            const skew = Matrix3d.createIdentity();
+            if (!data.cloneLocalToWorld().matrix.factorRigidSkew(rigid, skew))
+                return undefined;
+            const value = { center: data.cloneCenter().toJSON() };
+            // always specify an orthogonal frame if !identity for backwards compatibility
+            if (!rigid.isIdentity)
+                value.zxVectors = [zData.v.toJSON(), xData.v.toJSON()];
+            // specify a general matrix if skew/mirror local frame
+            if (!skew.isDiagonal || skew.determinant() < 0.0)
+                value.xyzVectors = [xData.v.toJSON(), yData.v.toJSON(), zData.v.toJSON()];
             const latitudeSweep = data.cloneLatitudeSweep();
+            const fullSweep = latitudeSweep.isFullLatitudeSweep;
+            if (data.capped && !fullSweep)
+                value.capped = data.capped;
+            if (!fullSweep)
+                value.latitudeStartEnd = latitudeSweep.toJSON();
             const rX = xData.mag;
             const rY = yData.mag;
             const rZ = zData.mag;
-            if (xData.v && zData.v) {
-                const value = {
-                    center: data.cloneCenter().toJSON(),
-                };
-                if (!(data.getConstructiveFrame()).matrix.isIdentity)
-                    value.zxVectors = [zData.v.toJSON(), xData.v.toJSON()];
-                const fullSweep = latitudeSweep.isFullLatitudeSweep;
-                if (data.capped && !fullSweep)
-                    value.capped = data.capped;
-                if (Geometry.isSameCoordinate(rX, rY) && Geometry.isSameCoordinate(rX, rZ))
+            if (Geometry.isSameCoordinate(rX, rY)) {
+                if (Geometry.isSameCoordinate(rX, rZ))
                     value.radius = rX;
-                else {
+                else { // radiusY will pick up radiusX
                     value.radiusX = rX;
-                    value.radiusY = rY;
                     value.radiusZ = rZ;
                 }
-                if (!fullSweep)
-                    value.latitudeStartEnd = latitudeSweep.toJSON();
-                return { sphere: value };
             }
-            return undefined;
+            else {
+                value.radiusX = rX;
+                value.radiusY = rY;
+                value.radiusZ = rZ;
+            }
+            return { sphere: value };
         }
         /** Convert strongly typed instance to tagged json */
         handleTorusPipe(data) {
@@ -1117,6 +1134,7 @@ export var IModelJson;
             const normalIndex = [];
             const paramIndex = [];
             const colorIndex = [];
+            const edgeMateIndex = [];
             let n;
             while (visitor.moveToNextFacet()) {
                 n = visitor.indexCount;
@@ -1148,12 +1166,15 @@ export var IModelJson;
             if (pf.data.taggedNumericData) {
                 taggedNumericData = this.handleTaggedNumericData(pf.data.taggedNumericData);
             }
-            // assemble the contents in alphabetical order.
+            if (pf.data.edgeMateIndex) {
+                if (!SerializationHelpers.announceUncompressedZeroBasedReflexiveIndices(pf.data.edgeMateIndex, pf.facetStart, SerializationHelpers.EdgeMateIndex.BlockSeparator, SerializationHelpers.EdgeMateIndex.NoEdgeMate, (i) => edgeMateIndex.push(i))) {
+                    assert(false, "unable to serialize edgeMateIndex array to json");
+                }
+            }
             const contents = {};
             if (pf.expectedClosure !== 0)
                 contents.expectedClosure = pf.expectedClosure;
-            if (pf.twoSided)
-                contents.twoSided = true;
+            contents.twoSided = pf.twoSided;
             if (pf.data.auxData)
                 contents.auxData = this.handlePolyfaceAuxData(pf.data.auxData, pf);
             if (pf.data.color)
@@ -1172,6 +1193,9 @@ export var IModelJson;
             contents.pointIndex = pointIndex;
             if (taggedNumericData)
                 contents.tags = taggedNumericData;
+            if (pf.data.edgeMateIndex)
+                contents.edgeMateIndex = edgeMateIndex;
+            // NOTE: pf.data.face is not persistent
             return { indexedMesh: contents };
         }
         handleBSplineCurve(curve) {