@itwin/core-geometry 4.4.0-dev.9 → 4.5.0-dev.0

package/lib/esm/curve/LineString3d.js

@@ -17,7 +17,6 @@ import { PlaneAltitudeRangeContext } from "./internalContexts/PlaneAltitudeRange
 import { LineSegment3d } from "./LineSegment3d";
 import { OffsetOptions } from "./OffsetOptions";
 import { StrokeCountMap } from "./Query/StrokeCountMap";
-/* eslint-disable @typescript-eslint/naming-convention, no-empty */
 /**
  * Starting with baseIndex and moving index by stepDirection:
  * If the vector from baseIndex to baseIndex +1 crossed with vectorA can be normalized, accumulate it (scaled) to normal.
@@ -136,10 +135,7 @@ class LineString3d extends CurvePrimitive {
         result.addPoints(points);
         return result;
     }
-    /**
-     * Create a linestring, capturing the given GrowableXYZArray as the points.
-     * Point3d, Point2d, `[1,2,3]', array of any of those, or GrowableXYZArray
-     */
+    /** Create a linestring, capturing the given GrowableXYZArray as the points. */
     static createCapture(points) {
         return new LineString3d(points);
     }
@@ -163,7 +159,7 @@ class LineString3d extends CurvePrimitive {
         return result;
     }
     /**
-     * Add points to the linestring.
+     * Add copies of points to the linestring.
      * Valid inputs are:
      * * a Point2d
      * * a point3d
@@ -549,24 +545,33 @@ class LineString3d extends CurvePrimitive {
         return result;
     }
     /**
-     * Convert a segment index and local fraction to a global fraction.
+     * Convert a segment index and local fraction to a global linestring fraction.
      * @param index index of segment being evaluated
      * @param localFraction local fraction in [0,1] within the segment
+     * @param numSegment number N of segments in the linestring
      * @return global fraction f in [0,1] such that the segment is parameterized by index/N <= f <= (index+1)/N.
      */
-    segmentIndexAndLocalFractionToGlobalFraction(index, localFraction) {
-        const numSegment = this._points.length - 1;
+    static mapLocalToGlobalFraction(index, localFraction, numSegment) {
         if (numSegment < 1)
             return 0.0;
         return (index + localFraction) / numSegment;
     }
+    /**
+     * Convert a segment index and local fraction to a global linestring fraction.
+     * @param index index of segment being evaluated
+     * @param localFraction local fraction in [0,1] within the segment
+     * @return global fraction f in [0,1] such that the segment is parameterized by index/N <= f <= (index+1)/N.
+     */
+    segmentIndexAndLocalFractionToGlobalFraction(index, localFraction) {
+        return LineString3d.mapLocalToGlobalFraction(index, localFraction, this._points.length - 1);
+    }
     /**
      * Convert a global fraction to a segment index and local fraction.
      * @param globalFraction a fraction f in [0,1] in the linestring parameterization, where the i_th segment
      * (0 <= i < N) is parameterized by i/N <= f <= (i+1)/N.
+     * @returns segment index and local fraction
      */
-    globalFractionToSegmentIndexAndLocalFraction(globalFraction) {
-        const numSegment = this._points.length - 1;
+    static mapGlobalToLocalFraction(globalFraction, numSegment) {
         if (numSegment < 1)
             return { index: 0, fraction: 0.0 };
         const scaledGlobalFraction = globalFraction * numSegment;
@@ -577,8 +582,17 @@ class LineString3d extends CurvePrimitive {
             segmentIndex = numSegment - 1;
         else // globalFraction in [0,1]
             segmentIndex = Math.floor(scaledGlobalFraction);
-        const localFraction = scaledGlobalFraction - segmentIndex;
-        return { index: segmentIndex, fraction: localFraction };
+        return { index: segmentIndex, fraction: scaledGlobalFraction - segmentIndex };
+    }
+    /**
+     * Convert a global linestring fraction to a segment index and local fraction.
+     * @param globalFraction a fraction f in [0,1] in the linestring parameterization, where the i_th segment
+     * (0 <= i < N) is parameterized by i/N <= f <= (i+1)/N.
+     * @param numSegment number N of segments in the linestring
+     * @returns segment index and local fraction
+     */
+    globalFractionToSegmentIndexAndLocalFraction(globalFraction) {
+        return LineString3d.mapGlobalToLocalFraction(globalFraction, this._points.length - 1);
     }
     /** Return a frenet frame, using nearby points to estimate a plane. */
     fractionToFrenetFrame(fraction, result) {
@@ -659,6 +673,10 @@ class LineString3d extends CurvePrimitive {
     numPoints() {
         return this._points.length;
     }
+    /** Return the number of edges in this linestring. */
+    numEdges() {
+        return this._points.length > 0 ? this._points.length - 1 : 0;
+    }
     /** Evaluate the end point of the linestring. */
     endPoint() {
         if (this._points.length === 0)
@@ -1244,9 +1262,9 @@ class LineString3d extends CurvePrimitive {
         return result;
     }
     /** Return (if possible) a specific segment of the linestring */
-    getIndexedSegment(index) {
+    getIndexedSegment(index, result) {
         if (index >= 0 && index + 1 < this._points.length)
-            return LineSegment3d.create(this._points.getPoint3dAtCheckedPointIndex(index), this._points.getPoint3dAtCheckedPointIndex(index + 1));
+            return LineSegment3d.create(this._points.getPoint3dAtCheckedPointIndex(index), this._points.getPoint3dAtCheckedPointIndex(index + 1), result);
         return undefined;
     }
     /** Returns true if first and last points are within metric tolerance. */
@@ -1356,6 +1374,26 @@ class LineString3d extends CurvePrimitive {
     projectedParameterRange(ray, lowHigh) {
         return PlaneAltitudeRangeContext.findExtremeFractionsAlongDirection(this, ray, lowHigh);
     }
+    /**
+     * Convert the segment detail to a linestring detail:
+     * * `detail.childDetail` is set to a clone of the input segment detail (optionally populating pre-allocated `child` object).
+     * * `childDetail.a` is set to `segmentIndex`.
+     * * `detail.fraction` is set to the global linestring parameter.
+     * * `detail.curve` is set to the parent linestring.
+     * @param detail segment location detail, converted in place
+     * @param segmentIndex index of segment in the linestring
+     * @param numSegment linestring segment count
+     * @param parent optional linestring primitive
+     * @param child optional pre-allocated detail to use to clone the child data
+     * @returns reference to input detail, with both linestring and segment data
+     */
+    static convertLocalToGlobalDetail(detail, segmentIndex, numSegment, parent, child) {
+        detail.childDetail = detail.clone(child);
+        detail.childDetail.a = segmentIndex;
+        detail.fraction = this.mapLocalToGlobalFraction(segmentIndex, detail.fraction, numSegment);
+        detail.curve = parent;
+        return detail;
+    }
 }
 LineString3d._workPointA = Point3d.create();
 LineString3d._workPointB = Point3d.create();