@vesium/plot 1.0.1-beta.26 → 1.0.1-beta.28

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Xiankq <https://github.com/xiankq>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,58 @@
-../../README.md
+# @vesium/plot [![NPM version](https://img.shields.io/npm/v/@vesium/plot?color=a1b858)](https://www.npmjs.com/package/@vesium/plot)
+
+> This is an additional library to [Vesium](https://github.com/GeoVueJS/vesium).
+
+---
+
+
+<p align="center">
+<img src="./assets/logo.svg" align="center" width="15%" />
+</p>
+
+<h1 align="center">Vesium</h1>
+
+<p align="center">Vue component and composition-api library for Cesium.</p>
+
+<p align="center">
+<a href="https://www.npmjs.com/package/@vesium/core" target="__blank"><img src="https://img.shields.io/npm/v/@vesium/core?color=a1b858&label=" alt="NPM version"></a>
+<a href="https://www.npmjs.com/package/@vesium/core" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vesium/core?color=50a36f&label="></a>
+<a href="https://github.com/GeoVueJS/vesium" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/GeoVueJS/vesium?style=social"></a>
+</p>
+
+> 🚧 This project is under development, and the API may change frequently.
+
+## Features
+
+- 🎯 **Intuitive** - VueUse-style API design, familiar to Vue developers
+- 💪 **Type Strong** - Written in TypeScript, with full TS support
+- 🏪 **Modular** - Tree-shakeable ESM modules
+- 🌐 **Full Featured** - Comprehensive Cesium functionality support
+- 🎮 **Interactive** - Rich interactive capabilities with map elements
+- ⚡️ **Lightweight** - No bloated dependencies
+
+## Install
+
+```bash
+# npm
+npm i cesium @vueuse/core vesium
+
+# yarn
+yarn add cesium @vueuse/core vesium
+
+# pnpm
+pnpm add cesium @vueuse/core vesium
+```
+
+<template>
+  <div ref="cesiumContainer" style="width: 100%; height: 100%" />
+</template>
+```
+
+## 🌸 Credits
+
+- [VueUse](https://github.com/vueuse/vueuse) - Collection of Vue Composition Utilities
+- [Cesium](https://github.com/CesiumGS/cesium) - An open-source JavaScript library for world-class 3D globes and maps
+
+## 📄 License
+
+[MIT](./LICENSE) License © 2025 [GeoVueJS](https://github.com/GeoVueJS)

package/dist/index.cjs

@@ -15,25 +15,30 @@ var PlotAction = /* @__PURE__ */ ((PlotAction2) => {
   PlotAction2[PlotAction2["ACTIVE"] = 2] = "ACTIVE";
   return PlotAction2;
 })(PlotAction || {});
+class PlotSkeletonEntity extends cesium.Entity {
+  constructor(options) {
+    super(options);
+  }
+}
 function control() {
   return {
-    diabled: ({ active }) => !active,
+    disabled: ({ active }) => !active,
     cursor: "pointer",
     dragCursor: "crosshair",
-    onDrag({ viewer, sample, packable, context, index, lockCamera }) {
+    onDrag({ viewer, sampled, packable, context, index, lockCamera }) {
       lockCamera();
       const position = shared.canvasCoordToCartesian(context.endPosition, viewer.scene);
       if (position) {
         const positions = [...packable.positions ?? []];
         positions[index] = position;
-        sample.setSample({
+        sampled.setSample({
           time: packable.time,
           derivative: packable.derivative,
           positions
         });
       }
     },
-    onKeyPressed({ viewer, keyEvent, sample, packable, index }) {
+    onKeyPressed({ viewer, keyEvent, sampled, packable, index }) {
       var _a;
       const height = (_a = shared.toCartographic(viewer.camera.position)) == null ? void 0 : _a.height;
       if (!height || !["ArrowUp", "ArrowRight", "ArrowDown", "ArrowLeft"].includes(keyEvent.key))
@@ -62,7 +67,7 @@ function control() {
       cartographic.latitude += distance * Math.cos(newHeading);
       cartographic.longitude += distance * Math.sin(newHeading);
       positions[index] = shared.toCartesian3(cartographic);
-      sample.setSample({
+      sampled.setSample({
         time: packable.time,
         derivative: packable.derivative,
         positions
@@ -90,7 +95,7 @@ function control() {
 function interval() {
   let dragIndex = -1;
   return {
-    diabled: ({ active, defining }) => !active || defining,
+    disabled: ({ active, defining }) => !active || defining,
     cursor: "pointer",
     dragCursor: "crosshair",
     format(packable) {
@@ -103,7 +108,7 @@ function interval() {
         return cesium.Cartesian3.midpoint(position, next, new cesium.Cartesian3());
       });
     },
-    onDrag({ viewer, sample, packable, context, index, lockCamera, dragging }) {
+    onDrag({ viewer, sampled, packable, context, index, lockCamera, dragging }) {
       lockCamera();
       const position = shared.canvasCoordToCartesian(context.endPosition, viewer.scene);
       if (!position) {
@@ -119,7 +124,7 @@ function interval() {
       if (!dragging) {
         dragIndex = -1;
       }
-      sample.setSample({
+      sampled.setSample({
         time: packable.time,
         derivative: packable.derivative,
         positions
@@ -150,7 +155,7 @@ function interval() {
 function intervalNonclosed() {
   let dragIndex = -1;
   return {
-    diabled: ({ active, defining }) => !active || defining,
+    disabled: ({ active, defining }) => !active || defining,
     cursor: "pointer",
     dragCursor: "crosshair",
     format(packable) {
@@ -158,11 +163,13 @@ function intervalNonclosed() {
       if (_positions.length < 2) {
         return [];
       }
-      return _positions.slice(0, _positions.length - 1).map((position, i) => {
-        return cesium.Cartesian3.midpoint(position, _positions[i + 1], new cesium.Cartesian3());
-      });
+      const midpoints = [];
+      for (let i = 0; i < _positions.length - 1; i++) {
+        midpoints.push(cesium.Cartesian3.midpoint(_positions[i], _positions[i + 1], new cesium.Cartesian3()));
+      }
+      return midpoints;
     },
-    onDrag({ viewer, sample, packable, context, index, lockCamera, dragging }) {
+    onDrag({ viewer, sampled, packable, context, index, lockCamera, dragging }) {
       lockCamera();
       const position = shared.canvasCoordToCartesian(context.endPosition, viewer.scene);
       if (!position) {
@@ -178,7 +185,7 @@ function intervalNonclosed() {
       if (!dragging) {
         dragIndex = -1;
       }
-      sample.setSample({
+      sampled.setSample({
         time: packable.time,
         derivative: packable.derivative,
         positions
@@ -208,7 +215,7 @@ const svg = `data:image/svg+xml;utf8,${encodeURIComponent(
 )}`;
 function moved() {
   return {
-    diabled: ({ active, defining }) => !active || defining,
+    disabled: ({ active, defining }) => !active || defining,
     cursor: "pointer",
     dragCursor: "crosshair",
     format(packable) {
@@ -222,7 +229,7 @@ function moved() {
         return [shared.toCartesian3(center)];
       }
     },
-    onDrag({ viewer, sample, packable, context, lockCamera, dragging }) {
+    onDrag({ viewer, sampled, packable, context, lockCamera, dragging }) {
       dragging && lockCamera();
       const startPosition = shared.canvasCoordToCartesian(context.startPosition, viewer.scene);
       const endPosition = shared.canvasCoordToCartesian(context.endPosition, viewer.scene);
@@ -231,7 +238,7 @@ function moved() {
       }
       const offset = cesium.Cartesian3.subtract(endPosition, startPosition, new cesium.Cartesian3());
       const positions = [...packable.positions ?? []];
-      sample.setSample({
+      sampled.setSample({
         time: packable.time,
         derivative: packable.derivative,
         positions: positions.map((position) => cesium.Cartesian3.add(position, offset, new cesium.Cartesian3()))
@@ -401,16 +408,20 @@ const _PlotScheme = class _PlotScheme {
     this.complete = options.complete;
     this.forceComplete = options.forceComplete;
     this.definingCursor = options.definingCursor ?? "crosshair";
-    this.skeletons = ((_a = options.skeletons) == null ? void 0 : _a.map((item) => shared.isFunction(item) ? item() : item)) ?? [];
+    this.skeletons = ((_a = options.skeletons) == null ? void 0 : _a.map((item) => item())) ?? [];
     this.render = options.render;
   }
-  static getRecordTypes() {
+  static getCacheTypes() {
     return [...this._record.keys()];
   }
-  static getRecord(type) {
+  static getCache(type) {
     return _PlotScheme._record.get(type);
   }
-  static setRecord(scheme) {
+  /**
+   * 设置标绘方案
+   * @param scheme
+   */
+  static setCache(scheme) {
     shared.assertError(!scheme.type, "`scheme.type` is required");
     _PlotScheme._record.set(scheme.type, scheme);
   }
@@ -419,7 +430,7 @@ const _PlotScheme = class _PlotScheme {
    */
   static resolve(maybeScheme) {
     if (typeof maybeScheme === "string") {
-      const _scheme = _PlotScheme.getRecord(maybeScheme);
+      const _scheme = _PlotScheme.getCache(maybeScheme);
       core.assert(!!_scheme, `scheme ${maybeScheme} not found`);
       return _scheme;
     } else if (!(maybeScheme instanceof _PlotScheme)) {
@@ -684,31 +695,45 @@ class Plot {
     shared.createCesiumAttribute(this, "disabled", !!options.disabled);
     shared.createCesiumAttribute(this, "defining", true);
     shared.createCesiumAttribute(this, "scheme", PlotScheme.resolve(options.scheme), { readonly: true });
-    const sample = options.sample instanceof SampledPlotProperty ? options.sample : new SampledPlotProperty(options.sample);
-    shared.createCesiumProperty(this, "sample", sample);
+    const sampled = options.sampled instanceof SampledPlotProperty ? options.sampled : new SampledPlotProperty(options.sampled);
+    shared.createCesiumProperty(this, "sampled", sampled);
     shared.createCesiumAttribute(this, "entities", []);
     shared.createCesiumAttribute(this, "primitives", []);
     shared.createCesiumAttribute(this, "groundPrimitives", []);
     shared.createCesiumAttribute(this, "skeletonEntities", []);
   }
+  /**
+   * An event that is raised when a property is changed.
+   */
   get definitionChanged() {
     return this._definitionChanged;
   }
+  /**
+   * 当前标绘是否处于定义态
+   */
   isDefining() {
     return this.defining;
   }
+  /**
+   * 获取当前标绘的entity数组
+   */
   getEntities() {
     return [...this.entities];
   }
+  /**
+   * 获取当前标绘的primitive数组
+   */
   getPrimitives() {
     return [...this.primitives];
   }
+  /**
+   * 获取当前标绘的贴地primitive数组
+   */
   getGroundPrimitives() {
     return [...this.groundPrimitives];
   }
   /**
-   * 获取该标绘的骨架点entity数组
-   *
+   * 获取当前标绘标绘的骨架点entity数组
    */
   getSkeletonEntities() {
     return [...this.skeletonEntities];
@@ -747,15 +772,15 @@ function useRender(plots, current, getCurrentTime) {
     () => plots.value.map((item) => item.definitionChanged),
     (_scope, key, newValue, oldValue) => {
       if (key === "entities") {
-        const { added, removed } = shared.arrayDifference(newValue, oldValue);
+        const { added, removed } = shared.arrayDiff(newValue, oldValue);
         added.forEach((item) => entityScope.add(item));
         removed.forEach((item) => entityScope.remove(item));
       } else if (key === "primitives") {
-        const { added, removed } = shared.arrayDifference(newValue, oldValue);
+        const { added, removed } = shared.arrayDiff(newValue, oldValue);
         added.forEach((item) => primitiveScope.add(item));
         removed.forEach((item) => primitiveScope.remove(item));
       } else if (key === "groundPrimitives") {
-        const { added, removed } = shared.arrayDifference(newValue, oldValue);
+        const { added, removed } = shared.arrayDiff(newValue, oldValue);
         added.forEach((item) => groundPrimitiveScope.add(item));
         removed.forEach((item) => groundPrimitiveScope.remove(item));
       }
@@ -764,7 +789,7 @@ function useRender(plots, current, getCurrentTime) {
   const update = shared.throttle(async (plot) => {
     var _a, _b;
     const reslut = await ((_b = (_a = plot.scheme).render) == null ? void 0 : _b.call(_a, {
-      packable: plot.sample.getValue(getCurrentTime()),
+      packable: plot.sampled.getValue(getCurrentTime()),
       mouse: plot.defining ? mouseCartesian.value : void 0,
       defining: plot.defining,
       previous: {
@@ -783,7 +808,7 @@ function useRender(plots, current, getCurrentTime) {
   core$1.useCesiumEventListener(
     () => plots.value.map((item) => item.definitionChanged),
     (plot, key) => {
-      if (["disabled", "defining", "scheme", "sample", "time"].includes(key)) {
+      if (["disabled", "defining", "scheme", "sampled", "time"].includes(key)) {
         update(plot);
       }
     }
@@ -802,7 +827,7 @@ function useSampled(current, getCurrentTime) {
   const doubleClicking = vue.ref(false);
   const packable = vue.computed(() => {
     var _a;
-    return (_a = current.value) == null ? void 0 : _a.sample.getValue(getCurrentTime());
+    return (_a = current.value) == null ? void 0 : _a.sampled.getValue(getCurrentTime());
   });
   core$1.useScreenSpaceEventHandler(
     cesium.ScreenSpaceEventType.LEFT_CLICK,
@@ -815,7 +840,7 @@ function useSampled(current, getCurrentTime) {
       if (doubleClicking.value) {
         return;
       }
-      const { scheme, defining, sample } = current.value;
+      const { scheme, defining, sampled } = current.value;
       if (!defining) {
         return;
       }
@@ -825,7 +850,7 @@ function useSampled(current, getCurrentTime) {
       }
       (_a = packable.value).positions ?? (_a.positions = []);
       packable.value.positions.push(position);
-      sample.setSample(packable.value);
+      sampled.setSample(packable.value);
       const completed = (_b = scheme.complete) == null ? void 0 : _b.call(scheme, packable.value);
       completed && (current.value.defining = false);
     }
@@ -859,7 +884,7 @@ function useSampled(current, getCurrentTime) {
       if (!current.value || !packable.value) {
         return;
       }
-      const { defining, sample } = current.value;
+      const { defining, sampled } = current.value;
       if (!defining) {
         return;
       }
@@ -868,7 +893,7 @@ function useSampled(current, getCurrentTime) {
         return;
       }
       packable.value.positions.splice(packable.value.positions.length - 1, 1);
-      sample.setSample(packable.value);
+      sampled.setSample(packable.value);
     }
   );
   const definingCursorCss = vue.ref();
@@ -891,17 +916,12 @@ function useSampled(current, getCurrentTime) {
     var _a;
     return (_a = current.value) == null ? void 0 : _a.definitionChanged;
   }, (plot, key) => {
-    if (key === "defining" || key === "sample") {
+    if (key === "defining" || key === "sampled") {
       setDefiningCursorCss();
     }
   });
   vue.watch(current, () => setDefiningCursorCss());
 }
-class PlotSkeletonEntity extends cesium.Entity {
-  constructor(options) {
-    super(options);
-  }
-}
 function useSkeleton(plots, current, getCurrentTime) {
   const viewer = core$1.useViewer();
   const dataSource = core$1.useDataSource(new cesium.CustomDataSource());
@@ -921,14 +941,14 @@ function useSkeleton(plots, current, getCurrentTime) {
     if (destroyed || plot.disabled) {
       plot.skeletonEntities = [];
     } else {
-      const packable = plot.sample.getValue(getCurrentTime());
+      const packable = plot.sampled.getValue(getCurrentTime());
       const defining = plot.defining;
       const active = current.value === plot;
       const skeletons = plot.scheme.skeletons;
       skeletons.forEach((skeleton) => {
         var _a;
-        const diabled = shared.isFunction(skeleton.diabled) ? skeleton.diabled({ active, defining }) : skeleton.diabled;
-        if (diabled) {
+        const disabled = shared.isFunction(skeleton.disabled) ? skeleton.disabled({ active, defining }) : skeleton.disabled;
+        if (disabled) {
           return;
         }
         const positions = ((_a = skeleton.format) == null ? void 0 : _a.call(skeleton, packable)) ?? (packable == null ? void 0 : packable.positions) ?? [];
@@ -989,10 +1009,10 @@ function useSkeleton(plots, current, getCurrentTime) {
         activeEntity.value = entity;
         const skeleton = entity.skeleton;
         const index = entity.index;
-        const packable = plot.sample.getValue(getCurrentTime());
+        const packable = plot.sampled.getValue(getCurrentTime());
         (_a = skeleton.onDrag) == null ? void 0 : _a.call(skeleton, {
           viewer: viewer.value,
-          sample: plot.sample,
+          sampled: plot.sampled,
           packable,
           active: current.value === plot,
           index,
@@ -1012,10 +1032,10 @@ function useSkeleton(plots, current, getCurrentTime) {
       const plot = entity.plot;
       const skeleton = entity.skeleton;
       const index = entity.index;
-      const packable = plot.sample.getValue(getCurrentTime());
+      const packable = plot.sampled.getValue(getCurrentTime());
       (_a = skeleton.onKeyPressed) == null ? void 0 : _a.call(skeleton, {
         viewer: viewer.value,
-        sample: plot.sample,
+        sampled: plot.sampled,
         packable,
         index,
         keyEvent
@@ -1041,10 +1061,10 @@ function useSkeleton(plots, current, getCurrentTime) {
         const plot = entity.plot;
         const skeleton = entity.skeleton;
         const index = entity.index;
-        const packable = plot.sample.getValue(getCurrentTime());
+        const packable = plot.sampled.getValue(getCurrentTime());
         (_a = skeleton.onLeftClick) == null ? void 0 : _a.call(skeleton, {
           viewer: viewer.value,
-          sample: plot.sample,
+          sampled: plot.sampled,
           packable,
           active: current.value === plot,
           defining: plot.defining,
@@ -1061,11 +1081,11 @@ function useSkeleton(plots, current, getCurrentTime) {
     removed.forEach((plot) => update(plot, true));
   });
   core$1.useCesiumEventListener(() => plots.value.map((plot) => plot.definitionChanged), (plot, key, newValue, oldValue) => {
-    if (["disabled", "defining", "scheme", "sample", "time"].includes(key)) {
+    if (["disabled", "defining", "scheme", "sampled", "time"].includes(key)) {
       update(plot);
     }
     if (key === "skeletonEntities") {
-      const { added, removed } = shared.arrayDifference(newValue, oldValue);
+      const { added, removed } = shared.arrayDiff(newValue, oldValue);
       added.forEach((item) => entityScope.add(item));
       removed.forEach((item) => entityScope.remove(item));
     }
@@ -1094,11 +1114,11 @@ function usePlot(options) {
   core$1.useCesiumEventListener([
     () => {
       var _a;
-      return (_a = current.value) == null ? void 0 : _a.sample.definitionChanged;
+      return (_a = current.value) == null ? void 0 : _a.sampled.definitionChanged;
     }
   ], () => {
     var _a;
-    packable.value = (_a = current.value) == null ? void 0 : _a.sample.getValue(getCurrentTime());
+    packable.value = (_a = current.value) == null ? void 0 : _a.sampled.getValue(getCurrentTime());
   });
   useSampled(current, getCurrentTime);
   useRender(plots, current, getCurrentTime);
@@ -1124,7 +1144,7 @@ function usePlot(options) {
     var _a, _b;
     if (previous) {
       if (previous.defining) {
-        const packable2 = previous.sample.getValue(getCurrentTime());
+        const packable2 = previous.sampled.getValue(getCurrentTime());
         const completed = (_b = (_a = previous.scheme).forceComplete) == null ? void 0 : _b.call(_a, packable2);
         if (completed) {
           previous.defining = false;