@vcmap/core 5.0.0-rc.3 → 5.0.0-rc.30

package/src/{vcs/vcm/util → util}/viewpoint.js

@@ -1,9 +1,8 @@
-import { EasingFunction } from '@vcmap/cesium';
+import { EasingFunction } from '@vcmap-cesium/engine';
 import { parseBoolean, parseNumber } from '@vcsuite/parsers';
 import Projection, { wgs84Projection } from './projection.js';
-import VcsObject from '../object.js';
+import VcsObject from '../vcsObject.js';
 import Extent from './extent.js';
-import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * compares two numeric properties
@@ -11,7 +10,6 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @param {number} right
  * @param {number} epsilon
  * @returns {boolean}
- * @export
  */
 export function propertyEqualsEpsilon(left, right, epsilon) {
   return Math.abs(left - right) <= epsilon;
@@ -23,29 +21,29 @@ export function propertyEqualsEpsilon(left, right, epsilon) {
  * @param {number} right angle in degree
  * @param {number} epsilon in degree
  * @returns {boolean}
- * @export
  */
 export function angleEqualsEpsilon(left, right, epsilon) {
-  const diff = (left - right) - Math.trunc((left - right) / 360) * 360;
+  const diff = left - right - Math.trunc((left - right) / 360) * 360;
   return Math.abs(diff) <= epsilon;
 }
 
-
 /**
  * compares two coordinates componentwise
  * @param {import("ol/coordinate").Coordinate} left
  * @param {import("ol/coordinate").Coordinate} right
  * @param {number} epsilon
  * @returns {boolean}
- * @export
  */
 export function coordinateEqualsEpsilon(left, right, epsilon) {
-  return left !== null && right !== null &&
-    left.every((val, idx) => propertyEqualsEpsilon(val, right[idx], epsilon));
+  return (
+    left !== null &&
+    right !== null &&
+    left.every((val, idx) => propertyEqualsEpsilon(val, right[idx], epsilon))
+  );
 }
 
 /**
- * @typedef {VcsObjectOptions} ViewPointOptions
+ * @typedef {VcsObjectOptions} ViewpointOptions
  * @property {import("ol/coordinate").Coordinate|undefined} cameraPosition - ol3 coordinate array with xyz coordinates (z value is mandatory)
  * @property {import("ol/coordinate").Coordinate|undefined} groundPosition - ol3 coordinate array with xyz coordinates (z value is optional)
  * @property {number|undefined} distance - distance between the camera position and the target
@@ -61,15 +59,16 @@ export function coordinateEqualsEpsilon(left, right, epsilon) {
 /**
  * A Viewpoint Object
  * @class
- * @export
  * @extends {VcsObject}
  * @api stable
  */
-class ViewPoint extends VcsObject {
-  static get className() { return 'vcs.vcm.util.ViewPoint'; }
+class Viewpoint extends VcsObject {
+  static get className() {
+    return 'Viewpoint';
+  }
 
   /**
-   * @param {ViewPointOptions} options
+   * @param {ViewpointOptions} options
    */
   constructor(options) {
     super(options);
@@ -81,8 +80,11 @@ class ViewPoint extends VcsObject {
      * @api
      */
     this.cameraPosition = null;
-    if (Array.isArray(options.cameraPosition) && options.cameraPosition.length === 3) {
-      this.cameraPosition = options.cameraPosition.map(c => Number(c));
+    if (
+      Array.isArray(options.cameraPosition) &&
+      options.cameraPosition.length === 3
+    ) {
+      this.cameraPosition = options.cameraPosition.map((c) => Number(c));
     }
 
     /**
@@ -93,7 +95,7 @@ class ViewPoint extends VcsObject {
      */
     this.groundPosition = null;
     if (Array.isArray(options.groundPosition)) {
-      this.groundPosition = options.groundPosition.map(c => Number(c));
+      this.groundPosition = options.groundPosition.map((c) => Number(c));
     }
 
     /**
@@ -102,7 +104,10 @@ class ViewPoint extends VcsObject {
      * @type {?number}
      * @api
      */
-    this.distance = parseNumber(options.distance, this.cameraPosition ? this.cameraPosition[2] : 1000);
+    this.distance = parseNumber(
+      options.distance,
+      this.cameraPosition ? this.cameraPosition[2] : 1000,
+    );
 
     /**
      * heading, angle between 0 and 360 degree 0° = North, 90° = east ...
@@ -147,16 +152,18 @@ class ViewPoint extends VcsObject {
 
   /**
    * The current easing function
-   * @type {import("@vcmap/cesium").EasingFunction.Callback|null}
+   * @type {import("@vcmap-cesium/engine").EasingFunction.Callback|null}
    * @api
    * @readonly
    */
   get easingFunction() {
-    return this.easingFunctionName ? EasingFunction[this.easingFunctionName] : null;
+    return this.easingFunctionName
+      ? EasingFunction[this.easingFunctionName]
+      : null;
   }
 
   /**
-   * @returns {ViewPointOptions} returns a options object. This object can be used to reconstruct a new viewpoint
+   * @returns {ViewpointOptions} returns a options object. This object can be used to reconstruct a new viewpoint
    * @api stable
    */
   toJSON() {
@@ -176,11 +183,11 @@ class ViewPoint extends VcsObject {
 
   /**
    * clones the viewpoint
-   * @returns {ViewPoint} viewpoint
+   * @returns {Viewpoint} viewpoint
    * @api stable
    */
   clone() {
-    return new ViewPoint(this.toJSON());
+    return new Viewpoint(this.toJSON());
   }
 
   /**
@@ -189,7 +196,10 @@ class ViewPoint extends VcsObject {
    * @api stable
    */
   toString() {
-    const stringRep = `ViewPoint: [Ground:${String(this.groundPosition ? this.groundPosition : null)}]` +
+    const stringRep =
+      `Viewpoint: [Ground:${String(
+        this.groundPosition ? this.groundPosition : null,
+      )}]` +
       `[Camera:${String(this.cameraPosition ? this.cameraPosition : null)}]` +
       `[Distance:${this.distance}]` +
       `[heading:${this.distance}]` +
@@ -201,13 +211,14 @@ class ViewPoint extends VcsObject {
   /**
    * Creates a viewpoint based on an extent
    * @param {import("ol/extent").Extent|Extent} extent
-   * @returns {?ViewPoint}
+   * @returns {?Viewpoint}
    * @api
    */
-  static createViewPointFromExtent(extent) {
-    const extentCoordinates = extent instanceof Extent ?
-      extent.getCoordinatesInProjection(wgs84Projection) :
-      extent;
+  static createViewpointFromExtent(extent) {
+    const extentCoordinates =
+      extent instanceof Extent
+        ? extent.getCoordinatesInProjection(wgs84Projection)
+        : extent;
 
     if (extentCoordinates && extentCoordinates.length === 4) {
       const minx = extentCoordinates[0];
@@ -221,10 +232,10 @@ class ViewPoint extends VcsObject {
       if (delta < 0.001) {
         distance = 400;
       } else {
-        distance = (delta) * 300000;
+        distance = delta * 300000;
       }
 
-      return new ViewPoint({
+      return new Viewpoint({
         name: 'viewpointFromExtend',
         distance,
         groundPosition: center,
@@ -238,18 +249,18 @@ class ViewPoint extends VcsObject {
   }
 
   /**
-   * creates a new ViewPoint Object from url Paramter
+   * creates a new Viewpoint Object from url Paramter
    * @param {Object} urlParameter
-   * @returns {ViewPoint}
+   * @returns {Viewpoint}
    */
   static parseURLparameter(urlParameter) {
     let { cameraPosition, groundPosition } = urlParameter;
     if (cameraPosition != null) {
-      cameraPosition = cameraPosition.split(',').map(c => Number(c));
+      cameraPosition = cameraPosition.split(',').map((c) => Number(c));
     }
 
     if (groundPosition != null) {
-      groundPosition = groundPosition.split(',').map(c => Number(c));
+      groundPosition = groundPosition.split(',').map((c) => Number(c));
     }
 
     if (urlParameter.epsg != null) {
@@ -257,10 +268,18 @@ class ViewPoint extends VcsObject {
       const srcProjection = new Projection({ epsg, proj4: proj4String });
       const destProjection = wgs84Projection;
       if (groundPosition) {
-        groundPosition = Projection.transform(destProjection, srcProjection, groundPosition);
+        groundPosition = Projection.transform(
+          destProjection,
+          srcProjection,
+          groundPosition,
+        );
       }
       if (cameraPosition) {
-        cameraPosition = Projection.transform(destProjection, srcProjection, cameraPosition);
+        cameraPosition = Projection.transform(
+          destProjection,
+          srcProjection,
+          cameraPosition,
+        );
       }
     }
 
@@ -273,7 +292,7 @@ class ViewPoint extends VcsObject {
       roll: Number(urlParameter.roll),
     };
 
-    return new ViewPoint(options);
+    return new Viewpoint(options);
   }
 
   /**
@@ -283,15 +302,17 @@ class ViewPoint extends VcsObject {
    * @returns {boolean}
    */
   isValid() {
-    const hasCamera = this.cameraPosition &&
+    const hasCamera =
+      this.cameraPosition &&
       Array.isArray(this.cameraPosition) &&
       this.cameraPosition.length === 3 &&
-      this.cameraPosition.every(position => Number.isFinite(position));
-    const hasGround = this.groundPosition &&
+      this.cameraPosition.every((position) => Number.isFinite(position));
+    const hasGround =
+      this.groundPosition &&
       Array.isArray(this.groundPosition) &&
       this.groundPosition.length > 1 &&
       this.groundPosition.length < 4 &&
-      this.groundPosition.every(position => Number.isFinite(position));
+      this.groundPosition.every((position) => Number.isFinite(position));
     if (!hasGround && !hasCamera) {
       return false;
     }
@@ -312,25 +333,30 @@ class ViewPoint extends VcsObject {
 
   /**
    * compares the provided Viewpoint with this viewpoint componentwise
-   * @param {ViewPoint} other
+   * @param {Viewpoint} other
    * @param {number} [epsilon=0]
    * @returns {boolean}
    */
   equals(other, epsilon = 0) {
-    return other === this || (
-      other !== null &&
-      propertyEqualsEpsilon(other.distance, this.distance, epsilon) &&
-      angleEqualsEpsilon(other.heading, this.heading, epsilon) &&
-      angleEqualsEpsilon(other.pitch, this.pitch, epsilon) &&
-      angleEqualsEpsilon(other.roll, this.roll, epsilon) &&
-      (
-        coordinateEqualsEpsilon(other.cameraPosition, this.cameraPosition, epsilon) ||
-        coordinateEqualsEpsilon(other.groundPosition, this.groundPosition, epsilon)
-      )
+    return (
+      other === this ||
+      (other !== null &&
+        propertyEqualsEpsilon(other.distance, this.distance, epsilon) &&
+        angleEqualsEpsilon(other.heading, this.heading, epsilon) &&
+        angleEqualsEpsilon(other.pitch, this.pitch, epsilon) &&
+        angleEqualsEpsilon(other.roll, this.roll, epsilon) &&
+        (coordinateEqualsEpsilon(
+          other.cameraPosition,
+          this.cameraPosition,
+          epsilon,
+        ) ||
+          coordinateEqualsEpsilon(
+            other.groundPosition,
+            this.groundPosition,
+            epsilon,
+          )))
     );
   }
 }
 
-export default ViewPoint;
-
-VcsClassRegistry.registerClass(ViewPoint.className, ViewPoint);
+export default Viewpoint;