@wemap/geo 8.1.0-alpha.0 → 9.0.0-alpha.0

package/index.d.ts

@@ -1,27 +1,78 @@
+import { Quaternion_t, Vector3_t } from '@wemap/maths';
 declare module '@wemap/geo' {
 
+    export type Level_t = null | number | [number, number];
+
     export class Level {
-        val: number | null;
-        isRange: boolean;
-        low: number | null;
-        up: number | null;
-        constructor(arg1: number, arg2?: number);
-        static fromString(str: string): Level;
+        static checkType(level: Level_t): void;
+        static isRange(level: Level_t): boolean;
+        static clone(level: Level_t): Level_t;
+        static fromString(str: string): Level_t;
+        static contains(container: Level_t, targeted: Level_t): boolean;
+        static intersect(first: Level_t, second: Level_t): Level_t;
+        static union(first: Level_t, second: Level_t): Level_t;
+        static multiplyBy(level: Level_t, factor: number): Level_t;
+        static toString(level: Level_t): string;
+        static equalsTo(first: Level_t, second: Level_t): boolean;
+        static diff(first: Level_t, second: Level_t): null | number;
+
+        /** @deprecated */
+        static fromLegacy(level: (null | { isRange: boolean, val?: number, low?: number, up?: number })): Level_t;
     }
 
+    type CoordinatesCompressedJson = [number, number] |
+    [number, number, number] |
+    [number, number, number, number] |
+    [number, number, null, number] |
+    [number, number, number, [number, number]];
+
     export class Coordinates {
         lat: number;
         lng: number;
         alt: number | null;
-        level: Level | null;
+        level: Level_t | null;
 
-        constructor(lat: number, lng: number, alt?: number | null, level?: Level | null);
+        constructor(lat: number, lng: number, alt?: number | null, level?: Level_t | null);
 
+        clone(): Coordinates;
+        wrap(): void;
+        static equalsTo(pos1: Coordinates, pos2: Coordinates, eps?: number, epsAlt?: number): boolean;
+        equalsTo(other: Coordinates): boolean;
+
+        destinationPoint(distance: number, bearing: number, elevation?: number): Coordinates;
+        move(distance: number, bearing: number, elevation?: number): void;
         distanceTo(other: Coordinates): number;
+        static distanceBetween(point1: Coordinates, point2: Coordinates): number;
         bearingTo(other: Coordinates): number;
-        static fromJson(json: any): Coordinates;
-        toJson(): any;
+
+        enuToEcefRotation: Quaternion_t;
+        ecefToEnuRotation: Quaternion_t;
+        ecef: Vector3_t;
+        static fromEcef(ecef: Vector3_t): Coordinates;
+
+        getSegmentProjection(p1: Coordinates, p2: Coordinates): Coordinates | null;
+
         toString(): string;
+        toJson(): { lat: number, lng: number, alt?: number, level?: number | [number, number] };
+        toCompressedJson(): CoordinatesCompressedJson;
+        static fromJson(json: { lat: number, lng: number, alt?: number, level?: number | [number, number] }): Coordinates;
+        static fromCompressedJson(json: CoordinatesCompressedJson): Coordinates;
+
+        /** @deprecated */
+        toLegacyJson(): any;
+        /** @deprecated */
+        toLegacyCompressedJson():
+            [number, number] |
+            [number, number, number] |
+            [number, number, number, string] |
+            [number, number, null, string];
+        /** @deprecated */
+        static fromLegacyCompressedJson(json:
+            [number, number] |
+            [number, number, number] |
+            [number, number, number, string] |
+            [number, number, null, string]): Coordinates;
+
     }
 
     export class GeoRef {

package/package.json

@@ -13,7 +13,7 @@
         "directory": "packages/geo"
     },
     "name": "@wemap/geo",
-    "version": "8.1.0-alpha.0",
+    "version": "9.0.0-alpha.0",
     "bugs": {
         "url": "https://github.com/wemap/wemap-modules-js/issues"
     },
@@ -29,7 +29,7 @@
     "license": "ISC",
     "dependencies": {
         "@wemap/logger": "^8.0.1",
-        "@wemap/maths": "^8.1.0-alpha.0"
+        "@wemap/maths": "^8.1.0"
     },
-    "gitHead": "9e87dcdc938ef2e2469bc18b3e88a25eb5b16c53"
+    "gitHead": "fc17cf617195c987813ede500bf67dd0f135cf34"
 }

package/src/coordinates/Coordinates.js

@@ -1,3 +1,5 @@
+import Logger from '@wemap/logger';
+
 import {
     deg2rad, Vector3, Quaternion, rad2deg, wrap
 } from '@wemap/maths';
@@ -27,7 +29,7 @@ class Coordinates {
     /** @type {Number|null} */
     _alt = null;
 
-    /** @type {Level|null} */
+    /** @type {null|number|[number, number]} */
     _level = null;
 
     /** @type {[Number, Number, Number]|null} */
@@ -39,7 +41,7 @@ class Coordinates {
      * @param {Number} lat
      * @param {Number} lng
      * @param {?(Number|null)} alt
-     * @param {?(Level|null)} level
+     * @param {?(null|number|[number, number])} level
      */
     constructor(lat, lng, alt = null, level = null) {
         this.lat = lat;
@@ -78,7 +80,7 @@ class Coordinates {
         return this._alt;
     }
 
-    /** @type {Level|null} */
+    /** @type {null|number|[number, number]} */
     get level() {
         return this._level;
     }
@@ -129,16 +131,10 @@ class Coordinates {
         this._ecef = null;
     }
 
-    /** @type {Level|null} */
+    /** @type {null|number|[number, number]} */
     set level(level) {
-        if (level instanceof Level) {
-            this._level = level;
-        } else {
-            if (typeof level !== 'undefined' && level !== null) {
-                throw new Error('level argument is not a Level object');
-            }
-            this._level = null;
-        }
+        Level.checkType(level);
+        this._level = level;
     }
 
     /**
@@ -147,8 +143,8 @@ class Coordinates {
      */
     clone() {
         const output = new Coordinates(this.lat, this.lng, this.alt);
-        if (this.level) {
-            output.level = this.level.clone();
+        if (this.level !== null) {
+            output.level = Level.clone(this.level);
         }
         return output;
     }
@@ -429,7 +425,7 @@ class Coordinates {
             str += ', ' + this._alt.toFixed(2);
         }
         if (this._level !== null) {
-            str += ', [' + this._level.toString() + ']';
+            str += ', [' + Level.toString(this._level) + ']';
         }
         str += ']';
         return str;
@@ -447,7 +443,24 @@ class Coordinates {
             output.alt = this.alt;
         }
         if (this.level !== null) {
-            output.level = this.level.toString();
+            output.level = this.level;
+        }
+        return output;
+    }
+
+    /**
+     * @returns {!Object}
+     */
+    toLegacyJson() {
+        const output = {
+            lat: this.lat,
+            lng: this.lng
+        };
+        if (this.alt !== null) {
+            output.alt = this.alt;
+        }
+        if (this.level !== null) {
+            output.level = Level.toString(this.level);
         }
         return output;
     }
@@ -457,7 +470,11 @@ class Coordinates {
      * @returns {!Coordinates}
      */
     static fromJson(json) {
-        return new Coordinates(json.lat, json.lng, json.alt, Level.fromString(json.level));
+        if (typeof json.level === 'string') {
+            Logger.warn('Still using legacy level format. Please update your project.');
+            return new Coordinates(json.lat, json.lng, json.alt, Level.fromString(json.level));
+        }
+        return new Coordinates(json.lat, json.lng, json.alt, json.level);
     }
 
     /**
@@ -469,7 +486,22 @@ class Coordinates {
             output.push(this.alt);
         }
         if (this.level !== null) {
-            output.push(this.level.toString());
+            output.push(this.level);
+        }
+        return output;
+    }
+
+    /**
+     * @returns {!Object}
+     * @deprecated
+     */
+    toLegacyCompressedJson() {
+        const output = [this.lat, this.lng];
+        if (this.alt !== null || this.level !== null) {
+            output.push(this.alt);
+        }
+        if (this.level !== null) {
+            output.push(Level.toString(this.level));
         }
         return output;
     }
@@ -479,6 +511,21 @@ class Coordinates {
      * @returns {!Coordinates}
      */
     static fromCompressedJson(json) {
+        const coords = new Coordinates(json[0], json[1]);
+        if (json.length > 2) {
+            coords.alt = json[2];
+        }
+        if (json.length > 3) {
+            coords.level = json[3];
+        }
+        return coords;
+    }
+
+    /**
+     * @param {!Object} json
+     * @returns {!Coordinates}
+     */
+    static fromLegacyCompressedJson(json) {
         const coords = new Coordinates(json[0], json[1]);
         if (json.length > 2) {
             coords.alt = json[2];

package/src/coordinates/Coordinates.spec.js

@@ -2,7 +2,6 @@ import chai from 'chai';
 import chaiAlmost from 'chai-almost';
 
 import Coordinates from './Coordinates.js';
-import Level from './Level.js';
 import Constants from '../Constants.js';
 
 const expect = chai.expect;
@@ -26,18 +25,17 @@ describe('Coordinates', () => {
 
         expect(() => new Coordinates(45, 5, null, null)).not.throw(Error);
         expect(() => new Coordinates(45, 5, null, true)).throw(Error);
-        expect(() => new Coordinates(45, 5, null, new Level(1))).not.throw(Error);
-        expect(() => new Coordinates(45, 5, null, new Level(1, 2))).not.throw(Error);
-        expect(() => new Coordinates(45, 5, 0, new Level(1))).not.throw(Error);
+        expect(() => new Coordinates(45, 5, null, 1)).not.throw(Error);
+        expect(() => new Coordinates(45, 5, null, [1, 2])).not.throw(Error);
+        expect(() => new Coordinates(45, 5, 0, 1)).not.throw(Error);
 
-        const level = new Level(2);
-        const position = new Coordinates(45, 5, 0, level);
+        const position = new Coordinates(45, 5, 0, 2);
         expect(position.lat).equals(45);
         expect(position.latitude).equals(45);
         expect(position.lng).equals(5);
         expect(position.longitude).equals(5);
         expect(position.alt).equals(0);
-        expect(position.level).equals(level);
+        expect(position.level).equals(2);
 
     });
 
@@ -46,11 +44,11 @@ describe('Coordinates', () => {
         position.lat = 45;
         position.lng = 5;
         position.alt = 0;
-        position.level = new Level(2);
+        position.level = 2;
         expect(position.lat).equals(45);
         expect(position.lng).equals(5);
         expect(position.alt).equals(0);
-        expect(Level.equalsTo(position.level, new Level(2))).true;
+        expect(position.level).equals(2);
         expect(position._ecef).equals(null);
         expect(position.ecef).is.not.null;
 
@@ -65,14 +63,14 @@ describe('Coordinates', () => {
     });
 
     it('clone', () => {
-        const level = new Level(0);
+        const level = [1, 2];
         const position = new Coordinates(45, 5, 0, level);
         const clonePosition = position.clone();
 
         expect(clonePosition.lat).equals(45);
         expect(clonePosition.lng).equals(5);
         expect(clonePosition.alt).equals(0);
-        expect(Level.equalsTo(clonePosition.level, level)).true;
+        expect(clonePosition.level).deep.equals(level);
         expect(clonePosition.level).not.equals(level);
     });
 
@@ -82,14 +80,14 @@ describe('Coordinates', () => {
         position = new Coordinates(0, 0);
         expect(Coordinates.equalsTo(position, new Coordinates(0, 0))).true;
         expect(Coordinates.equalsTo(position, new Coordinates(0, 0, 0))).false;
-        expect(Coordinates.equalsTo(position, new Coordinates(0, 0, null, new Level(0)))).false;
+        expect(Coordinates.equalsTo(position, new Coordinates(0, 0, null, 0))).false;
         expect(Coordinates.equalsTo(position, new Coordinates(0, 0, null, null))).true;
 
 
-        position = new Coordinates(45, 5, 0, new Level(0));
-        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 0, new Level(0)))).true;
-        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 1, new Level(0)))).false;
-        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 0, new Level(1)))).false;
+        position = new Coordinates(45, 5, 0, 0);
+        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 0, 0))).true;
+        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 1, 0))).false;
+        expect(Coordinates.equalsTo(position, new Coordinates(45, 5, 0, 1))).false;
         expect(Coordinates.equalsTo(position, {
             lat: 45,
             lng: 5
@@ -102,21 +100,21 @@ describe('Coordinates', () => {
         expect(Coordinates.equalsTo(null, position)).false;
         expect(Coordinates.equalsTo(null, null)).true;
 
-        expect(position.equalsTo(new Coordinates(45, 5, 0, new Level(0)))).true;
-        expect(position.equalsTo(new Coordinates(45, 5, 0, new Level(1)))).false;
+        expect(position.equalsTo(new Coordinates(45, 5, 0, 0))).true;
+        expect(position.equalsTo(new Coordinates(45, 5, 0, 1))).false;
     });
 
     it('toString', () => {
         expect(new Coordinates(45, 5).toString()).equals('[45.0000000, 5.0000000]');
         expect(new Coordinates(45, 5, 0).toString()).equals('[45.0000000, 5.0000000, 0.00]');
         expect(new Coordinates(45, 5, 1).toString()).equals('[45.0000000, 5.0000000, 1.00]');
-        expect(new Coordinates(45, 5, null, new Level(0)).toString())
+        expect(new Coordinates(45, 5, null, 0).toString())
             .equals('[45.0000000, 5.0000000, [0]]');
-        expect(new Coordinates(45, 5, null, new Level(1)).toString())
+        expect(new Coordinates(45, 5, null, 1).toString())
             .equals('[45.0000000, 5.0000000, [1]]');
-        expect(new Coordinates(45, 5, 2, new Level(1)).toString())
+        expect(new Coordinates(45, 5, 2, 1).toString())
             .equals('[45.0000000, 5.0000000, 2.00, [1]]');
-        expect(new Coordinates(45, 5, 2, new Level(1, 2)).toString())
+        expect(new Coordinates(45, 5, 2, [1, 2]).toString())
             .equals('[45.0000000, 5.0000000, 2.00, [1;2]]');
     });
 
@@ -124,18 +122,18 @@ describe('Coordinates', () => {
     it('move/destination', () => {
         let position;
 
-        position = new Coordinates(0, 0, 0, new Level(0)).move(100000, 0);
-        expect(Coordinates.equalsTo(position, new Coordinates(0.8983152841195214, 0, 0, new Level(0)))).true;
+        position = new Coordinates(0, 0, 0, 0).move(100000, 0);
+        expect(Coordinates.equalsTo(position, new Coordinates(0.8983152841195214, 0, 0, 0))).true;
 
-        position = new Coordinates(0, 0, 0, new Level(0)).move(100000, Math.PI / 2);
-        expect(Coordinates.equalsTo(position, new Coordinates(0, 0.8983152841195212, 0, new Level(0)))).true;
+        position = new Coordinates(0, 0, 0, 0).move(100000, Math.PI / 2);
+        expect(Coordinates.equalsTo(position, new Coordinates(0, 0.8983152841195212, 0, 0))).true;
 
         position = new Coordinates(0, 0, 0).move(100000, 0, 10);
         expect(Coordinates.equalsTo(position, new Coordinates(0.8983152841195214, 0, 10))).true;
 
         expect(() => new Coordinates(0, 0).move(100000, 0, 10)).throw(Error);
 
-        const level = new Level(1);
+        const level = [1, 2];
         position = new Coordinates(0, 0, null, level);
         const newPosition = position.destinationPoint(100000, 0);
         expect(newPosition).not.equals(position);
@@ -246,13 +244,26 @@ describe('Coordinates', () => {
             alt: 2
         });
 
-        expect(new Coordinates(5, -10, null, new Level(1, 2)).toJson()).to.deep.equal({
+        expect(new Coordinates(5, -10, null, [1, 2]).toJson()).to.deep.equal({
+            lat: 5,
+            lng: -10,
+            level: [1, 2]
+        });
+
+        expect(new Coordinates(5, -10, null, [1, 2]).toLegacyJson()).to.deep.equal({
             lat: 5,
             lng: -10,
             level: '1;2'
         });
 
-        expect(new Coordinates(5, -10, 3, new Level(1, 2)).toJson()).to.deep.equal({
+        expect(new Coordinates(5, -10, 3, [1, 2]).toJson()).to.deep.equal({
+            lat: 5,
+            lng: -10,
+            alt: 3,
+            level: [1, 2]
+        });
+
+        expect(new Coordinates(5, -10, 3, [1, 2]).toLegacyJson()).to.deep.equal({
             lat: 5,
             lng: -10,
             alt: 3,
@@ -267,10 +278,10 @@ describe('Coordinates', () => {
         position = new Coordinates(5, -10, 2);
         expect(Coordinates.equalsTo(Coordinates.fromJson(position.toJson()), position)).true;
 
-        position = new Coordinates(5, -10, null, new Level(1, 2));
+        position = new Coordinates(5, -10, null, [1, 2]);
         expect(Coordinates.equalsTo(Coordinates.fromJson(position.toJson()), position)).true;
 
-        position = new Coordinates(5, -10, 3, new Level(1, 2));
+        position = new Coordinates(5, -10, 3, [1, 2]);
         expect(Coordinates.equalsTo(Coordinates.fromJson(position.toJson()), position)).true;
 
     });