@pirireis/webglobeplugins 0.6.6 → 0.6.8

package/bearing-line/plugin.js

@@ -30,7 +30,7 @@ export default class Plugin {
     /**
      * 
      * @param {*} id 
-     * @param {Map<[K ,ContextTextWriter]} textContextInjectionMap  import { ContextTextWriter } from '@pirireis/webglobeplugins/write-text/context-text';
+     * @param {Map<[K ,{writer:ContextTextWriter, coordsAdaptor, textAdaptor}]} textContextInjectionMap  import { ContextTextWriter } from '@pirireis/webglobeplugins/write-text/context-text';
      * 
      */
 
@@ -38,6 +38,7 @@ export default class Plugin {
         this.id = id;
         this._opacity = opacity;
         this.bufferOrchestrator = new BufferOrchestrator({ capacity: 10 });
+        this._checkTextContextInjectionMap(textContextInjectionMap);
         this._textContextInjectionMap = textContextInjectionMap;
         this.drawVRM = drawVRM;
         this.drawBearingLine = drawBearingLine;
@@ -63,6 +64,15 @@ export default class Plugin {
         this.globe.DrawRender();
     }
 
+    _checkTextContextInjectionMap(textContextInjectionMap) {
+        if (!(textContextInjectionMap instanceof Map)) throw new TypeError("textContextInjectionMap is not instance of Map");
+        textContextInjectionMap.forEach((v) => {
+            if (typeof v !== 'object') throw new TypeError("textContextInjectionMap format is wrong");
+            if (typeof v.coordsAdaptor !== 'function') throw new TypeError("textContextInjectionMap coordsAdaptor format is wrong");
+            if (typeof v.textAdaptor !== 'function') throw new TypeError("textContextInjectionMap textAdaptor format is wrong");
+            if (!(v.writer instanceof ContextTextWriter)) throw new TypeError("textContextInjectionMap writer is not instance of ContextTextWriter");
+        })
+    }
 
     setDoDrawAngleRing(bool) {
         if (bool === this.drawAngleRing) return;
@@ -225,7 +235,7 @@ export default class Plugin {
      */
     insertBulk(items, textWriterInjectionSubSetIDs = []) {
         const { globe, bufferOrchestrator, bufferManagersCompMap } = this;// angleTextContext, distanceTextContext,
-        const textWriterInjectionSubSets = textWriterInjectionSubSetIDs.map((id) => this._textContextInjectionMap.get(id));
+        const textWriterInjectionSubSets = this._getTextWriterInjectionSubSet(textWriterInjectionSubSetIDs);
         const data = []
         for (let item of items) {
             this._insertTexts(item, textWriterInjectionSubSets);
@@ -259,7 +269,7 @@ export default class Plugin {
      * @param {Array<string>} textWriterInjectionSubSetIDs | textContextInjectionMap keys to be used for writing text.
      */
     updateCoordinatesBulk(items, textWriterInjectionSubSetIDs = []) { //TODO
-        const injectionsSubSet = textWriterInjectionSubSetIDs.map((id) => this._textContextInjectionMap.get(id));
+        const injectionsSubSet = this._getTextWriterInjectionSubSet(textWriterInjectionSubSetIDs);
         const { globe, bufferOrchestrator, bufferManagersCompMap, } = this;
         const data = []
         for (let item of items) {
@@ -275,24 +285,23 @@ export default class Plugin {
     /**
      * 
      * @param {*} items some colums EXCEPT positional ones
-     * @param {*} propertyIDs 
-     * @param {*} textWriterInjectionSubSetIDs 
+     * @param {string} propertyIDs 
+     * @param {string} textWriterInjectionSubSetIDs 
      * 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.
      */
     updatePartial(items, propertyIDs = [], textWriterInjectionSubSetIDs = []) { // textWriterInjectionSubSetIDs = []
         if (propertyIDs.length === 0) console.warn("updatePartial is called with no target propertyIDs");
         const { _textContextInjectionMap, bufferOrchestrator, bufferManagersCompMap } = this;
-        const writers = textWriterInjectionSubSetIDs.map((x) => _textContextInjectionMap.get(x));
+        const writers = this._getTextWriterInjectionSubSet(textWriterInjectionSubSetIDs); // TODO:filter out rgba? this might be a bug
         for (let item of items) { this._insertTexts(item, writers) }
         bufferOrchestrator.updateBulk(items, bufferManagersCompMap, propertyIDs);
         // patch to update text opacity
         for (const property of propertyIDs) {
             if (property === "rgba") {
-                this._textContextInjectionMap.forEach((v) => {
+                _textContextInjectionMap.forEach((v) => {
                     const { writer } = v;
                     writer.updateOpacityBulk(items, (e) => e.key, (e) => e.rgba[3]);
                 })
-
             }
         }
         this.globe.DrawRender();
@@ -397,6 +406,17 @@ export default class Plugin {
         });
     }
 
+    textContextInjection
+    _getTextWriterInjectionSubSet(textWriterIds) {
+        const { _textContextInjectionMap } = this;
+        const result = [];
+        for (const id of textWriterIds) {
+            const writerAndAdaptors = _textContextInjectionMap.get(id);
+            if (writerAndAdaptors === undefined) throw new Error("textContextInjection id does not exist in map:" + id);
+            result.push(writerAndAdaptors)
+        }
+        return result;
+    }
 }
 
 

package/circle-line-chain/plugin.js

@@ -3,6 +3,7 @@ import { CircleCache } from '../programs/line-on-globe/circle';
 import { BufferOrchestrator, BufferManager } from "../util/account";
 import { ChainListMap } from "./chain-list-map";
 import { keyMethod } from "./util";
+import { ContextTextWriter3 } from '../write-text/context-text3';
 // TODO: Add update buffer and update text mehods on add, delete, update methods
 
 
@@ -45,6 +46,7 @@ export class CircleLineChainPlugin {
         textDataPreAdaptor = null
     } = {}) {
         this.id = id;
+        this._checkTextContextWriterInjectionMap(textContextWriterInjectionMap);
         this._textContextWriterInjectionMap = textContextWriterInjectionMap;
         this._textContextWriterInjectionMap.forEach((writer) => writer.setKeyAdaptor((v, i, c, properties) => v.__identity__));
         this._opacity = 1;
@@ -62,6 +64,12 @@ export class CircleLineChainPlugin {
         this._initOrchestrations()
     }
 
+    _checkTextContextWriterInjectionMap(textContextWriterInjectionMap) {
+        if (!(textContextWriterInjectionMap instanceof Map)) throw new Error("textContextWriterInjectionMap is not an instance of Map");
+        textContextWriterInjectionMap.forEach((v) => {
+            if (!(v instanceof ContextTextWriter3)) throw new Error("textContextWriterInjectionMap element is not an instance of ContextTextWriter3");
+        });
+    }
 
     _initOrchestrations() {
         const { gl, globe } = this;
@@ -290,7 +298,6 @@ export class CircleLineChainPlugin {
             chainKeysToReconstuct.push(chainKey);
         });
         this._textContextWriterInjectionMap.forEach((writer) => writer.deleteTextBulk(bufferKeys));
-        // if (textWriterIDs) this._updateTexts(chainKeysToReconstuct, textWriterIDs)
         this.bufferOrchestrator.deleteBulk(bufferKeys, this.bufferManagersCompMap);
         this._reconstructChains(chainKeysToReconstuct);
         this._updateTexts(chainKeysToReconstuct, textWriterIDs);
@@ -308,12 +315,23 @@ export class CircleLineChainPlugin {
     // implicit
 
     _updateTexts(chainKeys, textWriterIDs) {
-        const textWriters = textWriterIDs.map((v) => this._textContextWriterInjectionMap.get(v));
+        if (textWriterIDs.length === 0) return;
+        const textWriters = this._getTextWriterInjectionSubSet(textWriterIDs)
         chainKeys.forEach((chainKey) => {
             this._chainListMap.textUpdate(chainKey, textWriters, this._textDataPreAdaptor);
         })
     }
 
+    _getTextWriterInjectionSubSet(textWriterIds) {
+        const { _textContextWriterInjectionMap } = this;
+        const result = [];
+        for (const id of textWriterIds) {
+            const w = _textContextWriterInjectionMap.get(id);
+            if (w === undefined) throw new Error("textContextInjection id does not exist in map:" + id);
+            result.push(w)
+        }
+        return result;
+    }
 
 
     _reconstructChains(chainKeys) {

package/package.json

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

package/util/check/typecheck.js

@@ -0,0 +1,10 @@
+
+
+export const isHexColor = (hexColor) => /^#[0-9A-F]{6}$/i.test(hexColor);
+export const isHexColorWithOpacity = (hexColor) => /^#[0-9A-F]{6}[0-9a-f]{0,2}$/i.test(hexColor);
+
+export const doesOwnProperties = (properties, errorMessage) => (object) => {
+    properties.array.forEach(element => {
+        if (!Object.hasOwn(object, element)) throw new TypeError(errorMessage + ' ' + element);
+    });
+}

package/write-text/context-text3.js

@@ -42,6 +42,7 @@ export class ContextTextWriter3 {
         this.style = style;
         this.doDraw = doDraw;
 
+        this._checkParameterTypes(textAdaptor, coordinatesAdaptor, keyAdaptor, opacityAdaptor, angleAdaptor, xOffset, yOffset);
 
         this.textAdaptor = textAdaptor;
         this.coordinatesAdaptor = coordinatesAdaptor;
@@ -63,6 +64,16 @@ export class ContextTextWriter3 {
         this.yOffset = yOffset;
     }
 
+    _checkParameterTypes(textAdaptor, coordinatesAdaptor, keyAdaptor, opacityAdaptor, angleAdaptor, xOffset, yOffset) {
+        if (textAdaptor !== null) if (!(textAdaptor instanceof Function)) throw new Error("textAdaptor is not an instance of a Function");
+        if (coordinatesAdaptor !== null) if (!(coordinatesAdaptor instanceof Function)) throw new Error("coordinatesAdaptor is not an instance of a Function");
+        if (keyAdaptor !== null) if (!(keyAdaptor instanceof Function)) throw new Error("keyAdaptor is not an instance of a Function");
+        if (opacityAdaptor !== null) if (!(opacityAdaptor instanceof Function)) throw new Error("opacityAdaptor is not an instance of a Function");
+        if (angleAdaptor !== null) if (!(angleAdaptor instanceof Function)) throw new Error("angleAdaptor is not an instance of a Function");
+        if (typeof xOffset !== "number") throw new Error("xOffset type is not a number");
+        if (typeof yOffset !== "number") throw new Error("yOffset type is not a number");
+    }
+
     setKeyAdaptor(adaptor) {
         this.keyAdaptor = adaptor;
     }

package/write-text/util.js

@@ -0,0 +1,12 @@
+import { doesOwnProperties, isHexColor } from "../util/check/typecheck";
+
+const fontCheckTypes = doesOwnProperties(["name", "textColor", "hollowColor", "size", "bold", "italic"], "font does not have");
+const fontCheckColors = (textColor, hollowColor) => isHexColor(textColor) && isHexColor(hollowColor);
+
+export const isTextFont = (textFont) => {
+    fontCheckTypes(textFont);
+    fontCheckColors(textFont.textColor, textFont.hollowColor);
+    if (!(textFont.size instanceof Number)) throw new TypeError("textFont size is not a number");
+
+}
+