@itwin/core-geometry 4.3.0-dev.9 → 4.3.1

package/lib/esm/serialization/SerializationHelpers.d.ts

@@ -0,0 +1,109 @@
+/** @packageDocumentation
+ * @module Serialization
+ */
+import { BSplineWrapMode } from "../bspline/KnotVector";
+/**
+ * `SerializationHelpers` namespace has helper classes for serializing and deserializing geometry.
+ * @internal
+ */
+export declare namespace SerializationHelpers {
+    interface BSplineParams {
+        numPoles: number;
+        order: number;
+        closed?: boolean;
+        knots: number[] | Float64Array;
+        wrapMode?: BSplineWrapMode;
+    }
+    interface BSplineCurveData {
+        poles: number[][] | Float64Array;
+        dim: number;
+        weights?: number[] | Float64Array;
+        params: BSplineParams;
+    }
+    interface BSplineSurfaceData {
+        poles: number[][][] | Float64Array;
+        dim: number;
+        weights?: number[][] | Float64Array;
+        uParams: BSplineParams;
+        vParams: BSplineParams;
+    }
+    interface BSplineDataOptions {
+        jsonPoles?: boolean;
+        jsonKnots?: boolean;
+        removeExtraKnots?: boolean;
+    }
+    /** Constructor with required data. Inputs are captured, not copied. */
+    function createBSplineCurveData(poles: number[][] | Float64Array, dim: number, knots: number[] | Float64Array, numPoles: number, order: number): BSplineCurveData;
+    /** Constructor with required data. Inputs are captured, not copied. */
+    function createBSplineSurfaceData(poles: number[][][] | Float64Array, dim: number, uKnots: number[] | Float64Array, uNumPoles: number, uOrder: number, vKnots: number[] | Float64Array, vNumPoles: number, vOrder: number): BSplineSurfaceData;
+    /** Clone curve data */
+    function cloneBSplineCurveData(source: BSplineCurveData): BSplineCurveData;
+    /** Clone surface data */
+    function cloneBSplineSurfaceData(source: BSplineSurfaceData): BSplineSurfaceData;
+    class Import {
+        /** copy knots, with options to control destination type and extraneous knot removal */
+        private static copyKnots;
+        /**
+         * Recognize the special legacy periodic B-spline data of mode BSplineWrapMode.OpenByRemovingKnots, and return the corresponding modern open clamped knots.
+         * * Note that the B-spline poles corresponding to the converted knots remain unchanged, but it is assumed that first and last poles are equal.
+         * * Example: the legacy 7-point quadratic circle periodic knots {-1/3 0 0 0 1/3 1/3 2/3 2/3 1 1 1 4/3} are converted to open knots {0 0 1/3 1/3 2/3 2/3 1 1}.
+         * * General form of knot vector (k = order, d = k-1 = degree, p = numPoles):
+         * * * legacy input: {k/2 periodically extended knots} {start knot multiplicity k} {p-k interior knots} {end knot multiplicity k} {d/2 periodically extended knots}
+         * * * converted output: {start knot multiplicity d} {p-k interior knots} {end knot multiplicity d}
+         * @param knots classic knot vector to test
+         * @param numPoles number of poles
+         * @param order B-spline order
+         * @param options for output type, extraneous knot removal
+         * @returns open knots if legacy periodic B-spline input data is recognized; otherwise, undefined
+         * @see Export.closeLegacyPeriodicKnots
+         */
+        private static openLegacyPeriodicKnots;
+        /** Prepare imported B-spline curve data for eventual conversion to BSplineCurve3d | BSplineCurve3dH:
+         * * Opens legacy "fake" periodic data by expanding knots
+         * * Opens true periodic data by expanding poles and weights
+         * @param data updated in place. If poles/weights/knots are updated, their respective arrays are reallocated.
+         * @param options output specifications
+         * @returns whether data was successfully prepared
+         */
+        static prepareBSplineCurveData(data: BSplineCurveData, options?: BSplineDataOptions): boolean;
+        /** Prepare imported B-spline surface data for eventual conversion to BSplineSurface3d | BSplineSurface3dH:
+         * * Opens legacy "fake" periodic data by expanding knots
+         * * Opens true periodic data by expanding poles and weights
+         * @param data updated in place. If poles/weights/knots are updated, their respective arrays are reallocated.
+         * @param options output specifications
+         * @returns whether data was successfully prepared
+         */
+        static prepareBSplineSurfaceData(data: BSplineSurfaceData, options?: BSplineDataOptions): boolean;
+    }
+    class Export {
+        /**
+         * Restore special legacy periodic B-spline knots opened via BSplineWrapMode.OpenByRemovingKnots logic.
+         * @param knots modern knot vector: {start knot multiplicity d} {p-k interior knots} {end knot multiplicity d}
+         * @param order B-spline order
+         * @param options for output type
+         * @param wrapMode wrap mode of the knots
+         * @returns legacy periodic knots (with classic extraneous start/end knot) if wrapMode recognized; otherwise, undefined
+         * @see Import.openLegacyPeriodicKnots
+         */
+        private static closeLegacyPeriodicKnots;
+        /**
+         * Prepare data from a B-spline curve for export.
+         *  * adds classic extraneous knot at start and end of knot vector
+         *  * re-closes periodic data based on BSplineWrapMode
+         * @param data updated in place. If poles/weights/knots are updated, their respective arrays are reallocated.
+         * @param options output specifications
+         * @returns whether data was successfully prepared
+         */
+        static prepareBSplineCurveData(data: BSplineCurveData, options?: BSplineDataOptions): boolean;
+        /**
+         * Prepare data from a B-spline surface for export.
+         *  * adds classic extraneous knot at start and end of knot vectors
+         *  * re-closes periodic data based on BSplineWrapMode
+         * @param data updated in place. If poles/weights/knots are updated, their respective arrays are reallocated.
+         * @param options output specifications
+         * @returns whether data was successfully prepared
+         */
+        static prepareBSplineSurfaceData(data: BSplineSurfaceData, options?: BSplineDataOptions): boolean;
+    }
+}
+//# sourceMappingURL=SerializationHelpers.d.ts.map

package/lib/esm/serialization/SerializationHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SerializationHelpers.d.ts","sourceRoot":"","sources":["../../../src/serialization/SerializationHelpers.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAc,MAAM,uBAAuB,CAAC;AAGpE;;;GAGG;AACH,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,aAAa;QAC5B,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;QAC/B,QAAQ,CAAC,EAAE,eAAe,CAAC;KAC5B;IACD,UAAiB,gBAAgB;QAC/B,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,YAAY,CAAC;QACjC,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;QAClC,MAAM,EAAE,aAAa,CAAC;KACvB;IACD,UAAiB,kBAAkB;QACjC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,YAAY,CAAC;QACnC,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,YAAY,CAAC;QACpC,OAAO,EAAE,aAAa,CAAC;QACvB,OAAO,EAAE,aAAa,CAAC;KACxB;IACD,UAAiB,kBAAkB;QACjC,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B;IAED,uEAAuE;IACvE,SAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAEvK;IAED,uEAAuE;IACvE,SAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAEpP;IAED,uBAAuB;IACvB,SAAgB,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAahF;IAED,yBAAyB;IACzB,SAAgB,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAoBtF;IAwKD,MAAa,MAAM;QACjB,uFAAuF;QACvF,OAAO,CAAC,MAAM,CAAC,SAAS;QAkBxB;;;;;;;;;;;;;WAaG;QACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;QAmBtC;;;;;;WAMG;eACW,uBAAuB,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO;QA+CpG;;;;;;WAMG;eACW,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO;KA0FzG;IAED,MAAa,MAAM;QACjB;;;;;;;;WAQG;QACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;QA0BvC;;;;;;;WAOG;eACW,uBAAuB,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO;QA6CpG;;;;;;;WAOG;eACW,yBAAyB,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO;KAgFzG;CACF"}