【杨琨】【添加注释】

Author: killer1992

src/service/3DPlot/Primitive/BasePlotPrimitive.js

@@ -5,7 +5,7 @@ import {getCenter, getCenterByCartesian} from "../Utils/PlotUtil"
  * @description 标绘图元基类
  * @author 基础平台-杨琨
  *
- * @param options - {Object} 额外参数
+ * @param options - {Object} 初始化参数
  * @param {Object} [options.element] SVG符号对象
  */
 class BasePlotPrimitive {

src/service/3DPlot/Primitive/RegularPrimitive/BaseRegularPrimitive.js

@@ -1,10 +1,12 @@
-/**
- * 标绘primitive基类
- * @property positions 坐标信息
- * @property show 是否显示
- */
 import BasePlotPrimitive from "../BasePlotPrimitive";
 
+/**
+ * @class module:3DPlot.BaseRegularPrimitive
+ * @description 标绘图元（规则图元）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 export default class BaseRegularPrimitive extends BasePlotPrimitive{
   constructor(options) {
     super(options);

src/service/3DPlot/Primitive/RegularPrimitive/KidneyAreaPrimitive.js

@@ -1,19 +1,24 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:17:52
- * @LastEditTime: 2022-03-31 11:59:14
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\RegularLine1Primitive.js
- */
 import RegularLine2Primitive from "./RegularLine2Primitive";
 import KidneyAreaElementInstance from "../ElementInstance/KidneyAreaElementInstance";
 
+/**
+ * @class module:3DPlot.KidneyAreaPrimitive
+ * @description 标绘图元（规则区二）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 export default class KidneyAreaPrimitive extends RegularLine2Primitive {
   constructor(options) {
     super(options);
   }
 
+  /**
+   * @description 重载了父类的生成Element对象的方法
+   * @private
+   *
+   * @param {function} callback 回调函数
+   */
   _elementInstance(callback) {
     new KidneyAreaElementInstance(this._elem, {
       ...this.getBaseSaveAttributesValues(),

src/service/3DPlot/Primitive/RegularPrimitive/RegularLine1Primitive.js

@@ -1,19 +1,25 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:17:52
- * @LastEditTime: 2022-05-20 10:38:22
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\RegularLine1Primitive.js
- */
 import BaseRegularPrimitive from "./BaseRegularPrimitive";
 import RegularLine1ElementInstance from "../ElementInstance/RegularLine1ElementInstance";
 
+/**
+ * @class module:3DPlot.RegularLine1Primitive
+ * @description 标绘图元（规则线一）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 class RegularLine1Primitive extends BaseRegularPrimitive {
   constructor(options) {
     super(options);
   }
 
+  /**
+   * @description 重载父类的update方法
+   * @function module:3DPlot.RegularLine1Primitive.update
+   * @public
+   *
+   * @param {Boolean} frameState 是否更新
+   * */
   update(frameState) {
     if (!this._elem || !this._elem.show) {
       return;
@@ -35,6 +41,12 @@ class RegularLine1Primitive extends BaseRegularPrimitive {
     }
   }
 
+  /**
+   * @description 重载父类的_createGeomInstance方法
+   * @private
+   *
+   * @param {function} callback 回调函数
+   * */
   _createGeomInstance(callback) {
     const webMercatorProjection = new Cesium.WebMercatorProjection();
 
@@ -53,6 +65,12 @@ class RegularLine1Primitive extends BaseRegularPrimitive {
     });
   }
 
+  /**
+   * @description 重载父类的_elementInstance方法
+   * @private
+   *
+   * @param {function} callback 回调函数
+   * */
   _elementInstance(callback) {
     new RegularLine1ElementInstance(
         this._elem,
@@ -62,6 +80,11 @@ class RegularLine1Primitive extends BaseRegularPrimitive {
     });
   }
 
+  /**
+   * @description 重载父类的initBaseSaveAttributes方法
+   * @function module:3DPlot.RegularLine1Primitive.initBaseSaveAttributes
+   * @public
+   * */
   initBaseSaveAttributes() {
     super.initBaseSaveAttributes()
     this.dimModAttitude = "1";
@@ -71,6 +94,13 @@ class RegularLine1Primitive extends BaseRegularPrimitive {
     this.wallGradColor = 'rgba(255,0,0,0.3)'
   }
 
+  /**
+   * @description 重载父类的getPrimitiveBaseSaveAttributes方法
+   * @function module:3DPlot.RegularLine1Primitive.getPrimitiveBaseSaveAttributes
+   * @public
+   *
+   * @return {Array} Attributes 属性字段数组
+   * */
   getPrimitiveBaseSaveAttributes() {
     return RegularLine1Primitive.extendPrimitiveAttributes.concat([]);
   }

src/service/3DPlot/Primitive/RegularPrimitive/RegularLine2Primitive.js

@@ -1,19 +1,24 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:17:52
- * @LastEditTime: 2022-04-01 16:40:35
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\RegularLine1Primitive.js
- */
 import RegularLine1Primitive from "./RegularLine1Primitive";
 import RegularLine2ElementInstance from "../ElementInstance/RegularLine2ElementInstance";
 
+/**
+ * @class module:3DPlot.RegularLine2Primitive
+ * @description 标绘图元（规则线二）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 class RegularLine2Primitive extends RegularLine1Primitive {
   constructor(options) {
     super(options);
   }
 
+  /**
+   * @description 重载父类的_elementInstance方法
+   * @private
+   *
+   * @param {function} callback 回调函数
+   * */
   _elementInstance(callback) {
     new RegularLine2ElementInstance(this._elem, {
       ...this.getBaseSaveAttributesValues(),
@@ -23,6 +28,11 @@ class RegularLine2Primitive extends RegularLine1Primitive {
     });
   }
 
+  /**
+   * @description 重载父类的initBaseSaveAttributes方法
+   * @function module:3DPlot.RegularLine2Primitive.initBaseSaveAttributes
+   * @public
+   * */
   initBaseSaveAttributes() {
     this.dimModHeight = this._modHeight
     this.isOpenWall = true
@@ -31,6 +41,13 @@ class RegularLine2Primitive extends RegularLine1Primitive {
     this.wallGradColor = 'rgba(255,0,0,0.3)'
   }
 
+  /**
+   * @description 重载父类的getPrimitiveBaseSaveAttributes方法
+   * @function module:3DPlot.RegularLine2Primitive.getPrimitiveBaseSaveAttributes
+   * @public
+   *
+   * @return {Array} Attributes 属性字段数组
+   * */
   getPrimitiveBaseSaveAttributes() {
     const attrs = super.getPrimitiveBaseSaveAttributes();
     return attrs.concat(RegularLine2Primitive.extendPrimitiveAttributes);

src/service/3DPlot/Primitive/RegularPrimitive/RegularPointPrimitive.js

@@ -1,14 +1,13 @@
-/*
- * @Author: your name
- * @Date: 2021-10-20 10:57:25
- * @LastEditTime: 2022-05-20 10:38:14
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\RegularPointPrimitive.js
- */
 import BaseRegularPrimitive from "./BaseRegularPrimitive";
 import RegularPointElementInstance from "../ElementInstance/RegularPointElementInstance";
 
+/**
+ * @class module:3DPlot.RegularPointPrimitive
+ * @description 标绘图元（规则点）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 class RegularPointPrimitive extends BaseRegularPrimitive {
     constructor(options) {
         super(options);
@@ -31,6 +30,12 @@ class RegularPointPrimitive extends BaseRegularPrimitive {
         this._isTranslate = false
     }
 
+    /**
+     * @description 重写父类的_elemPropsUpdateHandler方法
+     * @private
+     *
+     * @param {Object} event 事件对象
+     */
     _elemPropsUpdateHandler(event) {
         if (event.type === "positions") {
             this._positions = [];
@@ -47,6 +52,13 @@ class RegularPointPrimitive extends BaseRegularPrimitive {
 
     }
 
+    /**
+     * @description 重写父类的update方法
+     * @function module:3DPlot.RegularPointPrimitive.update
+     * @public
+     *
+     * @param {Boolean} frameState 是否更新
+     */
     update(frameState) {
         if (!this._elem || !this._elem.show) {
             return;
@@ -88,12 +100,24 @@ class RegularPointPrimitive extends BaseRegularPrimitive {
         return false;
     }
 
+    /**
+     * @description 重写父类的_createGeomInstance方法
+     * @private
+     *
+     * @param {function} callback 回调函数
+     */
     _createGeomInstance(callback) {
         this._elementInstance(function (instances) {
             callback(instances);
         });
     }
 
+    /**
+     * @description 重写父类的_elementInstancee方法
+     * @private
+     *
+     * @param {function} callback 回调函数
+     */
     _elementInstance(callback) {
         new RegularPointElementInstance(
             this._elem,
@@ -103,15 +127,33 @@ class RegularPointPrimitive extends BaseRegularPrimitive {
         });
     }
 
+    /**
+     * @description 重写父类的initBaseSaveAttributes方法
+     * @function module:3DPlot.RegularPointPrimitive.initBaseSaveAttributes
+     * @public
+     */
     initBaseSaveAttributes() {
         this.dimModHeight = 0;
         this.dimModAttitude = "1";
     }
 
+    /**
+     * @description 重写父类的getPrimitiveBaseSaveAttributes方法
+     * @function module:3DPlot.RegularPointPrimitive.getPrimitiveBaseSaveAttributes
+     * @public
+     *
+     * @return {Array} Attributes 属性字段数组
+     */
     getPrimitiveBaseSaveAttributes() {
         return RegularPointPrimitive.extendPrimitiveAttributes.concat([]);
     }
 
+    /**
+     * @description 重写父类的instancesToPrimitives方法
+     * @function module:3DPlot.RegularPointPrimitive.instancesToPrimitives
+     * @public
+     * @param {Array} instances 几何实例数组
+     */
     instancesToPrimitives(instances) {
         if (instances && instances.length > 0) {
             this.destroy()

src/service/3DPlot/Primitive/RegularPrimitive/RegularSurfacePrimitive.js

@@ -1,14 +1,13 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 11:03:09
- * @LastEditTime: 2022-05-23 15:49:43
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\RegularSurfacePrimitive.js
- */
 import RegularSurfaceElementInstance from '../ElementInstance/RegularSurfaceElementInstance';
 import RegularLine1Primitive from './RegularLine1Primitive';
 
+/**
+ * @class module:3DPlot.RegularSurfacePrimitive
+ * @description 标绘图元（规则区一）基类
+ * @author 基础平台-杨琨
+ *
+ * @param options - {Object} 初始化参数
+ */
 class RegularSurfacePrimitive extends RegularLine1Primitive {
     constructor(options) {
         super(options);
@@ -66,6 +65,13 @@ class RegularSurfacePrimitive extends RegularLine1Primitive {
         });
     }
 
+    /**
+     * @description 重写父类的update方法
+     * @function module:3DPlot.RegularSurfacePrimitive.update
+     * @public
+     *
+     * @param {Boolean} frameState 是否更新
+     */
     update(frameState) {
         if (!this._elem || !this._elem.show) {
             return;
@@ -93,6 +99,13 @@ class RegularSurfacePrimitive extends RegularLine1Primitive {
             this._primitive && this._primitive.update(frameState);   
         }
     }
+
+    /**
+     * @description 重写父类的_elementInstance方法
+     * @private
+     *
+     * @param {function} callback 回调函数
+     */
     _elementInstance(callback) {
         new RegularSurfaceElementInstance(this._elem, {
             ...this.getBaseSaveAttributesValues(),
@@ -102,10 +115,22 @@ class RegularSurfacePrimitive extends RegularLine1Primitive {
         });
     }
 
+    /**
+     * @description 重写父类的initBaseSaveAttributes方法
+     * @function module:3DPlot.RegularSurfacePrimitive.initBaseSaveAttributes
+     * @public
+     */
     initBaseSaveAttributes() {
         this.surfaceBorderWidth = 3;
     }
 
+    /**
+     * @description 重写父类的getPrimitiveBaseSaveAttributes方法
+     * @function module:3DPlot.RegularSurfacePrimitive.getPrimitiveBaseSaveAttributes
+     * @public
+     *
+     * @return {Array} Attributes 属性字段数组
+     */
     getPrimitiveBaseSaveAttributes() {
         return RegularSurfacePrimitive.extendPrimitiveAttributes.concat([]);
     }