@wemap/geo 3.1.19 → 3.1.20

package/package.json

@@ -12,7 +12,7 @@
         "directory": "packages/geo"
     },
     "name": "@wemap/geo",
-    "version": "3.1.19",
+    "version": "3.1.20",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -33,5 +33,5 @@
         "lodash.isnumber": "^3.0.3",
         "lodash.isstring": "^4.0.1"
     },
-    "gitHead": "4a4167fd2159c856b90e6a566595ae5945f92d2e"
+    "gitHead": "f7c26f0b16ec1d0d3ec5ca7efe6440424e18d3fb"
 }

package/src/Constants.js

@@ -10,7 +10,7 @@ const Constants = {
     EPS_DEG_MM: 1e-8,
 
     /**
-     * epsilon in meters which corresponds to q millimeter
+     * epsilon in meters which corresponds to 1 millimeter
      */
     EPS_MM: 1e-3
 };

package/src/Utils.js

@@ -66,6 +66,61 @@ class Utils {
         return sampledRoute;
     }
 
+    /**
+     * Trim a route of Coordinates
+     * @param {Array.<Coordinates>} route ordered points
+     * @param {Coordinates} startPosition position where the trim starts. startPosition has to be on the route.
+     * @param {*} maxLength max route length
+     */
+    static trimRoute(route, startPosition = route[0], length = Number.MAX_VALUE) {
+
+        const newRoute = [];
+        let previousPoint;
+
+        let currentPointIndex;
+        let cumulativeDistance = 0;
+
+        for (currentPointIndex = 1; currentPointIndex < route.length; currentPointIndex++) {
+
+            const p1 = route[currentPointIndex - 1];
+            const p2 = route[currentPointIndex];
+
+            if (startPosition.equalsTo(p1)) {
+                newRoute.push(p1);
+                previousPoint = p1;
+                break;
+            }
+
+            const proj = startPosition.getSegmentProjection(p1, p2);
+            if (proj && proj.equalsTo(startPosition) && !proj.equalsTo(p2)) {
+                newRoute.push(proj);
+                previousPoint = proj;
+                break;
+            }
+        }
+
+        if (!newRoute.length) {
+            throw new Error('startPosition is not on the route');
+        }
+
+        while (currentPointIndex < route.length) {
+            const currentPoint = route[currentPointIndex];
+            const dist = previousPoint.distanceTo(currentPoint);
+            if (cumulativeDistance + dist >= length) {
+                const bearing = previousPoint.bearingTo(currentPoint);
+                const remainingLength = length - cumulativeDistance;
+                const end = previousPoint.destinationPoint(remainingLength, bearing);
+                newRoute.push(end);
+                break;
+            }
+            newRoute.push(currentPoint);
+            previousPoint = currentPoint;
+            cumulativeDistance += dist;
+            currentPointIndex++;
+        }
+
+        return newRoute;
+    }
 }
 
 export default Utils;

package/src/Utils.spec.js

@@ -49,4 +49,57 @@ describe('Geo Utils', () => {
         expect(samples.length).equals(2);
 
     });
+
+    it('trimRoute', () => {
+
+        let newRoute;
+
+        const p1 = new Coordinates(45.0, 5.0);
+        const p2 = p1.destinationPoint(100, Math.PI / 4);
+        const p3 = p2.destinationPoint(49.9, Math.PI / 2);
+        const route = [p1, p2, p3];
+
+        expect(() => Utils.trimRoute(route, new Coordinates(0, 0))).throw(Error);
+
+        newRoute = Utils.trimRoute(route);
+        expect(newRoute.length).equals(3);
+        for (let i = 0; i < newRoute.length - 1; i++) {
+            expect(newRoute[i].equalsTo(route[i])).true;
+        }
+
+        newRoute = Utils.trimRoute(route, p1, 100);
+        expect(newRoute.length).equals(2);
+        expect(newRoute[0].equalsTo(p1)).true;
+        expect(newRoute[1].equalsTo(p2)).true;
+
+        newRoute = Utils.trimRoute(route, p1, 90);
+        expect(newRoute.length).equals(2);
+        expect(newRoute[0].equalsTo(p1)).true;
+        expect(newRoute[1].equalsTo(p1.destinationPoint(90, Math.PI / 4))).true;
+
+        newRoute = Utils.trimRoute(route, p2, 10);
+        expect(newRoute.length).equals(2);
+        expect(newRoute[0].equalsTo(p2)).true;
+        expect(newRoute[1].equalsTo(p2.destinationPoint(10, Math.PI / 2))).true;
+
+        const p4 = p1.destinationPoint(20, Math.PI / 4);
+        newRoute = Utils.trimRoute(route, p4);
+        expect(newRoute.length).equals(3);
+        expect(newRoute[0].equalsTo(p4)).true;
+        expect(newRoute[1].equalsTo(p2)).true;
+        expect(newRoute[2].equalsTo(p3)).true;
+
+        const p5 = p2.destinationPoint(20, Math.PI / 2);
+        newRoute = Utils.trimRoute(route, p4, 100);
+        expect(newRoute.length).equals(3);
+        expect(newRoute[0].equalsTo(p4)).true;
+        expect(newRoute[1].equalsTo(p2)).true;
+        expect(newRoute[2].equalsTo(p5)).true;
+
+        newRoute = Utils.trimRoute(route, p4, 200);
+        expect(newRoute.length).equals(3);
+        expect(newRoute[0].equalsTo(p4)).true;
+        expect(newRoute[1].equalsTo(p2)).true;
+        expect(newRoute[2].equalsTo(p3)).true;
+    });
 });