@vesium/plot 1.0.1-beta.48 → 1.0.1-beta.49

package/dist/index.mjs

@@ -7,30 +7,49 @@ import { assert, watchArray, promiseTimeout, onKeyStroke } from "@vueuse/core";
 import { shallowRef, watch, computed, ref, watchEffect, toValue, nextTick, shallowReactive } from "vue";
 const _PlotScheme = class _PlotScheme {
   constructor(options) {
+    /**
+     * 标绘类型。应当是全局唯一的字符串，会作为键名缓存
+     */
     __publicField(this, "type");
     /**
-     * 是否立即执行完成标绘操作
-     *
-     * 每次控制点发生变变化时，执行该回调函数，如果返回`true`则标绘完成
+     * 判断是否立即完成标绘.
+     * 每次控制点发生变变化时，执行该回调函数，返回`true`则完成标绘
      */
     __publicField(this, "complete");
     /**
-     * 双击时，是否执行完成标绘操作
+     * 判断是否允许手动完成标绘。
+     * 每次控制点发生变变化时，执行该回调函数，返回`true`则后续左键双击即完成标绘
      */
-    __publicField(this, "forceComplete");
+    __publicField(this, "allowManualComplete");
     /**
+     * 处于定义态时鼠标的样式
      * @default 'crosshair'
      */
     __publicField(this, "definingCursor");
+    /**
+     * 当前标绘的框架点数据
+     */
     __publicField(this, "skeletons");
+    /**
+     * 初始化时创建`Entity`的函数，创建后的`Entity`会作为配置项传入`render`中
+     */
     __publicField(this, "initEntites");
+    /**
+     * 初始化时创建`Primitive`的函数，创建后的`Primitive`会作为配置项传入`render`中
+     */
     __publicField(this, "initPrimitives");
+    /**
+     * 初始化时创建贴地`Primitive`的函数，创建后的`Primitive`会作为配置项传入`render`中
+     */
     __publicField(this, "initGroundPrimitives");
+    /**
+     * 当标绘数据变化时，会触发`render`回调，返回的数据会被添加到cesium中
+     */
     __publicField(this, "render");
     var _a;
     this.type = options.type;
     this.complete = options.complete;
-    this.forceComplete = options.forceComplete;
+    this.allowManualComplete = options.allowManualComplete;
     this.definingCursor = options.definingCursor ?? "crosshair";
     this.skeletons = ((_a = options.skeletons) == null ? void 0 : _a.map((item) => item())) ?? [];
     this.initEntites = options.initEntites;
@@ -38,16 +57,31 @@ const _PlotScheme = class _PlotScheme {
     this.initGroundPrimitives = options.initGroundPrimitives;
     this.render = options.render;
   }
+  /**
+   * 标绘方案缓存。
+   * 每次标绘时都会将`PlotScheme.type`作为键名缓存，
+   * 后续可用过`PlotScheme.getCache(type)`获取完整的`PlotScheme`配置。
+   */
   static getCacheTypes() {
     return [...this._record.keys()];
   }
+  /**
+   * 通过`PlotScheme.type`获取缓存中的`PlotScheme`配置。
+   */
   static getCache(type) {
     return _PlotScheme._record.get(type);
   }
+  /**
+   * 缓存标绘方案。
+   */
   static setCache(scheme) {
     assertError(!scheme.type, "`scheme.type` is required");
     _PlotScheme._record.set(scheme.type, scheme);
   }
+  /**
+   * 解析传入的maybeScheme，maybeScheme可能是一个完整的PlotScheme，也可能是缓存中的`PlotScheme.type`，并返回 PlotScheme 实例。
+   * 若传入的是`PlotScheme.type`字符串，并且缓存中不存在该标绘方案，则抛出错误。
+   */
   static resolve(maybeScheme) {
     if (typeof maybeScheme === "string") {
       const _scheme = _PlotScheme.getCache(maybeScheme);
@@ -227,8 +261,7 @@ const _SampledPlotProperty = class _SampledPlotProperty {
     return result;
   }
   /**
-   * 设置样本数据
-   *
+   * 设置样本数据，如果传入的数据不含时间，则会存入时间最早的集合中
    * @param value 样本数据对象，包含时间、位置和导数信息
    */
   setSample(value) {
@@ -294,6 +327,9 @@ const _SampledPlotProperty = class _SampledPlotProperty {
       TimeInterval.contains(interval2, time) && this.removeSample(time);
     }
   }
+  /**
+   * 判断两个property是否相等
+   */
   equals(other) {
     return other === this;
   }
@@ -318,6 +354,9 @@ class PlotFeature {
      * @internal
      */
     __publicField(this, "_defining");
+    /**
+     * @internal
+     */
     __publicField(this, "_disabled");
     /**
      * @internal
@@ -374,6 +413,12 @@ class PlotFeature {
       plot._defining = value;
     }
   }
+  /**
+   * 获取禁用状态
+   *
+   * 当为 `true` 时，标绘实例将停止响应交互和更新；
+   * 为 `false` 时恢复正常功能。
+   */
   get disabled() {
     return this._disabled;
   }
@@ -421,64 +466,6 @@ class PlotFeature {
     this._skeletons = value;
   }
 }
-class PlotFeatureCollection {
-  constructor(options = {}) {
-    /**
-     * @internal
-     */
-    __publicField(this, "_id");
-    /**
-     * @internal
-     */
-    __publicField(this, "_isDestroyed");
-    const { id } = options;
-    this._id = id || createGuid();
-    this._isDestroyed = false;
-  }
-  get id() {
-    return this._id;
-  }
-  get collectionChanged() {
-    return this._collectionChanged;
-  }
-  get values() {
-    return Array.from(this._values);
-  }
-  add(value) {
-    if (this._isDestroyed) {
-      throw new Error(`PlotFeatureCollection is isDestroyed`);
-    }
-    return this._values.has(value) ? false : !!this._values.add(value);
-  }
-  remove(value) {
-    return this._values.delete(value);
-  }
-  get entities() {
-    return this._dataSource.entities;
-  }
-  get primitives() {
-    return this._primitives;
-  }
-  get groundPrimitives() {
-    return this._groundPrimitives;
-  }
-  get skeletons() {
-    return this._skeletonDataSource.entities;
-  }
-  isDestroyed() {
-    return this._isDestroyed;
-  }
-  destroy() {
-    if (!this._isDestroyed) {
-      this._viewer.dataSources.remove(this._dataSource);
-      this._viewer.dataSources.remove(this._skeletonDataSource);
-      this._viewer.scene.primitives.remove(this._primitives);
-      this._viewer.scene.groundPrimitives.remove(this._groundPrimitives);
-      this._viewer.dataSources.remove(this._skeletonDataSource);
-      this._isDestroyed = true;
-    }
-  }
-}
 var PlotAction = /* @__PURE__ */ ((PlotAction2) => {
   PlotAction2[PlotAction2["IDLE"] = 0] = "IDLE";
   PlotAction2[PlotAction2["HOVER"] = 1] = "HOVER";
@@ -625,7 +612,7 @@ function useSampled(current, getCurrentTime) {
       if (!position) {
         return;
       }
-      const completed = (_a = scheme.forceComplete) == null ? void 0 : _a.call(scheme, packable.value);
+      const completed = (_a = scheme.allowManualComplete) == null ? void 0 : _a.call(scheme, packable.value);
       completed && PlotFeature.setDefining(current.value, false);
     }
   );
@@ -902,7 +889,7 @@ function usePlot(options) {
     if (previous) {
       if (previous.defining) {
         const packable2 = previous.sampled.getValue(getCurrentTime());
-        const completed = (_b = (_a = previous.scheme).forceComplete) == null ? void 0 : _b.call(_a, packable2);
+        const completed = (_b = (_a = previous.scheme).allowManualComplete) == null ? void 0 : _b.call(_a, packable2);
         if (completed) {
           PlotFeature.setDefining(previous, false);
           operateResolve == null ? void 0 : operateResolve(previous);
@@ -1248,7 +1235,7 @@ async function area(positions, options) {
 }
 const schemeMeasureArea = new PlotScheme({
   type: "measureArea",
-  forceComplete: (packable) => packable.positions.length >= 3,
+  allowManualComplete: (packable) => packable.positions.length >= 3,
   skeletons: [
     control,
     interval
@@ -1360,7 +1347,7 @@ const schemeLabel = new PlotScheme({
 });
 const schemePolygon = new PlotScheme({
   type: "polygon",
-  forceComplete: (packable) => packable.positions.length >= 3,
+  allowManualComplete: (packable) => packable.positions.length >= 3,
   skeletons: [
     control,
     interval,
@@ -1410,7 +1397,7 @@ const schemePolygon = new PlotScheme({
 const schemePolyline = new PlotScheme(
   {
     type: "polyline",
-    forceComplete: (packable) => packable.positions.length >= 2,
+    allowManualComplete: (packable) => packable.positions.length >= 2,
     skeletons: [
       control,
       intervalNonclosed,
@@ -1471,7 +1458,6 @@ const schemeRectangle = new PlotScheme({
 export {
   PlotAction,
   PlotFeature,
-  PlotFeatureCollection,
   PlotScheme,
   PlotSkeletonEntity,
   SampledPlotProperty,