@pirireis/webglobeplugins 0.8.12 → 0.8.14

package/bearing-line/plugin.js

@@ -16,6 +16,23 @@ export const RINGPARTIAL_DRAW_MODE = Object.freeze({
 });
 
 
+/**
+     * @typedef {{key, long, lat, endLong, endLat, bearingAngle, radius,  rgba:[4numbers], rgbaMode, bigRadius, dashRatio, dashOpacity, circleDashAngle}} BearingLineItem
+     * @property {string} key   
+     * @property {number} long
+     * @property {number} lat
+     * @property {number} endLong
+     * @property {number} endLat 
+     * @property {number} bearingAngle 0-360
+     * @property {number} radius angle ring radius
+     * @property {number} altitude in meters effects all parts of the item
+     * @property {Array<numbers>} rgba [r,g,b,a] 0-1
+     * @property {number} rgbaMode 0 constant, 1 fading, 2 hides angle ring
+     * @property {number} bigRadius undefined means it will be calculated from long, lat, endLong, endLat
+     * @property {number} dashRatio 0-1
+     * @property {number} dashOpacity 0-1
+     * @property {number} circleDashAngle 0-360
+ */
 
 const textWriterGetOrThrow = mapGetOrThrow("BearingLine textContextInjection id does not exist in map")
 
@@ -110,21 +127,8 @@ export default class BearingLinePlugin {
 
 
     /**
-     * @typedef {{key, long, lat, endLong, endLat, bearingAngle, radius,  rgba:[4numbers], rgbaMode, bigRadius, dashRatio, dashOpacity, circleDashAngle}} item
-     * @property {string} key   
-     * @property {number} long
-     * @property {number} lat
-     * @property {number} endLong
-     * @property {number} endLat 
-     * @property {number} bearingAngle 0-360
-     * @property {number} radius angle ring radius
-     * @property {Array<4numbers>} rgba [r,g,b,a]
-     * @property {number} rgbaMode 0 constant, 1 fading, 2 hides angle ring
-     * @property {number} bigRadius undefined means it will be calculated from long, lat, endLong, endLat
-     * @property {number} dashRatio 0-1
-     * @property {number} dashOpacity 0-1
-     * @property {number} circleDashAngle 0-360
-     * @param {Array<item>} items 
+
+     * @param {Array<BearingLineItem>} items 
      * @param {Array<string>} textWriterIDs | textWritersMap keys to be used for writing text.
      */
     insertBulk(items, { textWriterIDs = [] } = {}) {
@@ -198,7 +202,7 @@ export default class BearingLinePlugin {
 
     /**
      * 
-     * @param {*} items some colums EXCEPT positional ones
+     * @param {Array<BearingLineItem>} items some colums EXCEPT positional ones
      * @param {string} propertyIDs 
      * @param {string} textWriterIDs 
      * Do NOT send empty data if property ID of this data is entered or NaN is loaded to the buffer, resulting in an unwanted behaviour.
@@ -262,7 +266,7 @@ export default class BearingLinePlugin {
         const endLat = radian(item.endLat)
         const endLong = radian(item.endLong)
         const altitude = (item.altitude ?? 0) / 1000;
-        const bigRadius = item.bigRadius ?? globe.Math.GetDist3D(item.long, item.lat, item.endLong, item.endLat);
+        const bigRadius = item.bigRadius ?? globe.Math.GetDist2D(item.long, item.lat, item.endLong, item.endLat);
         const radius = item.radius !== undefined ? item.radius : bigRadius * 0.2;
         const { long: bearingLong, lat: bearingLat } = globe.Math.FindPointByPolar(item.long, item.lat, bigRadius, item.bearingAngle)
         const startAngle2d = calculateStartAngle(long, lat, endLong, endLat);

package/circle-line-chain/plugin.js

@@ -37,6 +37,7 @@ import { sphereCoord } from '../util/geometry/index';
  * @property {string} key
  * @property {number} long
  * @property {number} lat  
+ * @property {number} altitude
  * @property {StyleProperties} circleProperties
  * 
  * @typedef {Object} Node
@@ -49,7 +50,9 @@ import { sphereCoord } from '../util/geometry/index';
  * @property { number} dashOpacity 0-1
  * @property { number} dashRatio 0-1
  * @property { number } circleDashAngle 0-360
- * @property {Array<Node>} nodes
+ * @property { number} altitude
+ * 
+ * //property {Array<Node>} nodes
  */
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pirireis/webglobeplugins",
-    "version": "0.8.12",
+    "version": "0.8.14",
     "main": "index.js",
     "author": "Toprak Nihat Deniz Ozturk",
     "license": "MIT"

package/rangerings/plugin.js

@@ -47,6 +47,31 @@ const coordOnSphere = (long, lat, globe, altitude = 0) => {
     return normalize(coord, 6378.137 + altitude);
 }
 
+
+/**
+ * 
+ * 
+ * @typedef {string} centerID
+ * 
+ * @typedef {Object} RangeRing
+ * @property {string} ringID
+ * @property {number} radius in range meters
+ * @property {number} padding badding range in meter
+ * 
+ * 
+ *  Array < centerID: string, long: number, lat: number, stepAngle: number, rgba: [4 numbers], rings: rings, hide, textHide
+ * @typedef {Object} RangeRingsItem
+ * @property {centerID} centerID
+ * @property {number} long
+ * @property {number} lat
+ * @property {number} stepAngle
+ * @property {number} altitude
+ * @property {number} hide
+ * @property {number} textHide
+ * @property {number} rgba
+ * @property {Array<RangeRing>} rings
+ */
+
 class RangeRings {
     constructor(id,
         {
@@ -102,8 +127,7 @@ class RangeRings {
 
     /**
      * @method insertBulk
-     * @typedef { Array < { ringID, radius, padding } >} rings
-     * @param { Array < centerID: string, long: number, lat: number, stepAngle: number, rgba: [4 numbers], rings: rings, hide, textHide } items
+     * @param { Array < RangeRingsItem> } items
     */
     insertBulk(items, { textWriterIDs = [] } = {}) {
         // Algorithm