【杨琨】【添加注释】

Author: killer1992

src/service/3DPlot/Draw/DrawPlotObjectFactory3D.js

@@ -1,11 +1,3 @@
-/*
- * @Author: your name
- * @Date: 2021-09-17 11:24:51
- * @LastEditTime: 2022-05-23 14:22:22
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\base\Draw\DrawObjectFactory.js
- */
 import SimpleFactory from "../../../service/PlotUtilBase/SimpleFactory";
 import DrawPoint from "./DrawPoint";
 import DrawPolyline from "./DrawPolyline";

src/service/3DPlot/Draw/DrawPoint.js

@@ -1,16 +1,18 @@
-/*
- * @Author: your name
- * @Date: 2021-09-17 11:51:33
- * @LastEditTime: 2021-12-27 11:54:35
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Draw\DrawRegularPoint.js
- */
-
 import DrawObject from "../../../service/PlotBase/Draw/DrawObject";
 import {PrimitiveFactory} from "../Primitive/PrimitiveFactory";
 import {CesiumUtil} from "../Utils/CesiumUtil";
 
+/**
+ * @class module:3DPlot.DrawPoint
+ * @description 绘制点工具
+ * @author 基础平台-杨琨
+ *
+ * @param {Object} viewer 三维视图容器对象
+ * @param {Object} symbol 标绘符号对象
+ * @param {Object} plotLayer 标绘图层
+ * @param options - {Object} 额外参数
+ * @param {Function} [options.addedPlot] 添加标绘图元完成后的回调函数
+ */
 export default class DrawPoint extends DrawObject {
     constructor(viewer, symbol, plotLayer, options) {
         super();
@@ -24,6 +26,10 @@ export default class DrawPoint extends DrawObject {
         this._addedPlot = addedPlot;
     }
 
+    /**
+     * @description 添加点击事件
+     * @function module:3DPlot.DrawPoint.addHooks
+     */
     addHooks() {
         const viewer = this._viewer;
         const symbol = this._symbol;
@@ -69,6 +75,10 @@ export default class DrawPoint extends DrawObject {
         this._handler = handler;
     }
 
+    /**
+     * @description 移除点击事件
+     * @function module:3DPlot.DrawPoint.removeHooks
+     */
     removeHooks() {
         const handler = this._handler;
         handler.destroy();

src/service/3DPlot/Draw/DrawPolyline.js

@@ -1,12 +1,3 @@
-/*
- * @Author: your name
- * @Date: 2021-09-17 11:51:33
- * @LastEditTime: 2022-03-30 11:04:29
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Draw\DrawRegularPoint.js
- */
-
 import DrawObject from "../../../service/PlotBase/Draw/DrawObject";
 import PrimitiveFactory from "../Primitive/index";
 import {CesiumUtil} from "../Utils/CesiumUtil";
@@ -31,6 +22,17 @@ function look(viewer, center, offset) {
   }, 100);
 }
 
+/**
+ * @class module:3DPlot.DrawPolyline
+ * @description 绘制线工具
+ * @author 基础平台-杨琨
+ *
+ * @param {Object} viewer 三维视图容器对象
+ * @param {Object} symbol 标绘符号对象
+ * @param {Object} plotLayer 标绘图层
+ * @param options - {Object} 额外参数
+ * @param {Function} [options.addedPlot] 添加标绘图元完成后的回调函数
+ */
 export default class DrawPolyline extends DrawObject {
   constructor(viewer, symbol, plotLayer, options) {
     super();
@@ -48,7 +50,7 @@ export default class DrawPolyline extends DrawObject {
 
   /**
    * @description 添加点击事件
-   * @private
+   * @function module:3DPlot.DrawPolyline.addHooks
    */
   addHooks() {
     const viewer = this._viewer;
@@ -124,6 +126,10 @@ export default class DrawPolyline extends DrawObject {
     this._handler = handler;
   }
 
+  /**
+   * @description 移除点击事件
+   * @function module:3DPlot.DrawPolyline.removeHooks
+   */
   removeHooks() {
     const handler = this._handler;
     this._primitive = null;

src/service/3DPlot/EditTool/EditTool.js

@@ -6,11 +6,14 @@ import Point from "../../PlotUtilBase/Geometry/Point"
 import * as turf from "@turf/turf";
 
 /**
- * @class module:3DPlot.PlotLayer3D
- * @description 行业标绘图层
+ * @class module:3DPlot.EditTool
+ * @description 三维编辑工具
  * @author 基础平台-杨琨
  *
- * @param {PlotLayer3D} layer
+ * @param {Object} layer 标绘图层
+ * @param options - {Object} 额外参数
+ * @param {Object} [options.positionIcon] 位置控制点的绘制参数，参考cesium的billboard参数
+ * @param {Object} [options.shapeIcon] 形状控制点的绘制参数，参考cesium的billboard参数
  */
 export default class EditTool {
     constructor(layer, options) {
@@ -347,6 +350,10 @@ export default class EditTool {
         // this._dragging = false;
     }
 
+    /**
+     * @description 启用编辑工具
+     * @function module:3DPlot.EditTool.enable
+     */
     enable() {
         this._plotLayer.on("selected", this.onSelected);
         this._billboards = new Cesium.BillboardCollection();
@@ -369,6 +376,10 @@ export default class EditTool {
         );
     }
 
+    /**
+     * @description 停用编辑工具
+     * @function module:3DPlot.EditTool.disable
+     */
     disable() {
         this._leftDownHandler = CesiumUtil.destroyEventHandler(
             this._leftDownHandler
@@ -402,6 +413,8 @@ export default class EditTool {
 
     /**
      * @description 获取几何中心点
+     * @private
+     *
      * @param positions - {Array} 必选项，点数组
      * @return {Object} center 中心点
      */
@@ -416,6 +429,8 @@ export default class EditTool {
 
     /**
      * @description 设置位置控制点
+     * @private
+     *
      * @param position - {Cartesian3} 必选项，控制点坐标
      * @param name - {String} 可选项，控制点名称
      * @param primitive - {Object} 必选项，标绘图元
@@ -447,6 +462,8 @@ export default class EditTool {
 
     /**
      * @description 设置形状控制点
+     * @private
+     *
      * @param positions - {Array} 必选项，控制点坐标
      * @param options - {Object} 可选项，额外参数
      * @param {Number} [options.height = 0] 可选项，控制点高度