【杨琨】【添加注释】

Author: killer1992

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

@@ -117,7 +117,7 @@ class BasePlotPrimitive {
 
     /**
      * @description 标绘图元更新方法，有这个方法，则被cesium视为一个primitive
-     * @function module:3DPlot.BasePlotPrimitive.setAdjustScale
+     * @function module:3DPlot.BasePlotPrimitive.update
      * @public
      *
      * @param {Boolean} frameState 是否更新
@@ -150,6 +150,10 @@ class BasePlotPrimitive {
         this._primitive && this._primitive.update(frameState);
     }
 
+    /**
+     * @description 生成cesium的geometry对象方法
+     * @private
+     * */
     _createGeomInstance() {
         return [];
     }
@@ -220,7 +224,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 从json导入数据
-     * @function @function module:3DPlot.BasePlotPrimitive.fromGeoJSON
+     * @function module:3DPlot.BasePlotPrimitive.fromGeoJSON
      * @public
      *
      * @param {Object} geoJson 要导入的数据
@@ -250,7 +254,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 初始化保存属性（必须和extend扩展数组对应）
-     * @function @function module:3DPlot.BasePlotPrimitive.initBaseSaveAttributes
+     * @function module:3DPlot.BasePlotPrimitive.initBaseSaveAttributes
      * @public
      */
     initBaseSaveAttributes() {
@@ -259,7 +263,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 获取需要保存的字段数组
-     * @function @function module:3DPlot.BasePlotPrimitive.initBaseSaveAttributes
+     * @function module:3DPlot.BasePlotPrimitive.initBaseSaveAttributes
      * @public
      *
      * @return {Array} Attributes 字段数组
@@ -270,7 +274,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 获取需要保存的属性组对象
-     * @function @function module:3DPlot.BasePlotPrimitive.getBaseSaveAttributesValues
+     * @function module:3DPlot.BasePlotPrimitive.getBaseSaveAttributesValues
      * @public
      *
      * @return {Object} v 属性组对象
@@ -286,7 +290,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 检验是否需要开启透明度渲染
-     * @function @function module:3DPlot.BasePlotPrimitive.isTranslucentInstance
+     * @function module:3DPlot.BasePlotPrimitive.isTranslucentInstance
      * @public
      *
      * @param {Array} geomInstance 几何实例数组
@@ -301,7 +305,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 实体转换
-     * @function @function module:3DPlot.BasePlotPrimitive.instancesToPrimitives
+     * @function module:3DPlot.BasePlotPrimitive.instancesToPrimitives
      * @public
      *
      * @param {Array} instances 几何实例数组
@@ -325,7 +329,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 墙实体转换
-     * @function @function module:3DPlot.BasePlotPrimitive.wallInstancesToPrimitive
+     * @function module:3DPlot.BasePlotPrimitive.wallInstancesToPrimitive
      * @public
      *
      * @param {Array} wallInstances 墙的几何实例数组
@@ -368,7 +372,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 更新实体状态
-     * @function @function module:3DPlot.BasePlotPrimitive.updatePrimitive
+     * @function module:3DPlot.BasePlotPrimitive.updatePrimitive
      * @public
      *
      * @param {Boolean} flag 是否更新
@@ -384,7 +388,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 作用选中后透明度效果
-     * @function @function @function module:3DPlot.BasePlotPrimitive.applySelectStatus
+     * @function @function module:3DPlot.BasePlotPrimitive.applySelectStatus
      * @public
      *
      * @param {Array} geomInstances 几何实例数组
@@ -401,7 +405,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 获取渐变材料的canvas
-     * @function @function @function module:3DPlot.BasePlotPrimitive.getColorRamp
+     * @function @function module:3DPlot.BasePlotPrimitive.getColorRamp
      * @public
      *
      * @param {Array} elevationRamp 渐变范围
@@ -428,7 +432,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 设置标绘图元样式，必须通过此方法设置，修改样式的属性无效
-     * @function @function @function module:3DPlot.BasePlotPrimitive.setStyle
+     * @function @function module:3DPlot.BasePlotPrimitive.setStyle
      * @public
      *
      * @param key {String} 样式名
@@ -443,7 +447,7 @@ class BasePlotPrimitive {
 
     /**
      * @description: 获取标绘图元样式
-     * @function @function @function module:3DPlot.BasePlotPrimitive.getStyle
+     * @function @function module:3DPlot.BasePlotPrimitive.getStyle
      * @public
      *
      * @return {Object} style 图元样式

src/service/3DPlot/Primitive/ElementInstance/IrregularElementInstance.js

@@ -1,4 +1,4 @@
-import { defined } from "../../../../service/PlotUtilBase/Check";
+import { defined } from "../../../PlotUtilBase/Check";
 import RegularLineElementInstance from "./RegularLineElementInstance";
 import GeomUtil from "../../../../service/PlotUtilBase/Geometry/GeomUtil";
 

src/service/3DPlot/Primitive/IrregularPrimitive/BaseIrregularPrimitive.js

@@ -1,21 +1,28 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:17:42
- * @LastEditTime: 2022-04-01 09:46:07
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\IrregularPrimitive\BaseIrregularPrimitive.js
- */
 import Point from "../../../../service/PlotUtilBase/Geometry/Point";
 import {Vector2} from "../../../PlotUtilBase/Math/Vector2";
 import BasePlotPrimitive from "../BasePlotPrimitive";
 import IrregularElementInstance from "../ElementInstance/IrregularElementInstance";
 
+/**
+ * @class module:3DPlot.BaseIrregularPrimitive
+ * @description 非规则标绘图元基类
+ * @author 基础平台-杨琨
+ *
+ * @param {Object} options 初始化参数
+ */
 class BaseIrregularPrimitive extends BasePlotPrimitive {
     constructor(options) {
         super(options);
     }
 
+    /**
+     * @function module:3DPlot.BaseIrregularPrimitive.update
+     * @description 重载父类的update方法
+     * @public
+     * @override
+     *
+     * @param {Boolean} frameState 是否更新
+     */
     update(frameState) {
         if (!this._elem || !this._elem.show) {
             return;
@@ -39,8 +46,9 @@ class BaseIrregularPrimitive extends BasePlotPrimitive {
 
     /**
      * @description: 处理最后两点绘制不闭合
-     * @param {*} coords
-     * @return {*}
+     * @private
+     *
+     * @param {Array} coords 坐标点数组
      */
     _closeCoordsPath(coords) {
         if (!coords || coords.length < 3) return;
@@ -57,6 +65,13 @@ class BaseIrregularPrimitive extends BasePlotPrimitive {
         }
     }
 
+    /**
+     * @description 重载父类的_createGeomInstance方法
+     * @private
+     * @override
+     *
+     * @param {function} callback 回调函数
+     * */
     _createGeomInstance(callback) {
         const webMercatorProjection = new Cesium.WebMercatorProjection();
         const projectPos = this._positions.map((s) => {
@@ -76,6 +91,12 @@ class BaseIrregularPrimitive extends BasePlotPrimitive {
         });
     }
 
+    /**
+     * @description 处理非规则几何方法
+     * @private
+     *
+     * @param {function} callback 回调函数
+     * */
     _elementInstance(callback) {
         new IrregularElementInstance(this._elem, {
             ...this.getBaseSaveAttributesValues(),
@@ -85,6 +106,12 @@ class BaseIrregularPrimitive extends BasePlotPrimitive {
         });
     }
 
+    /**
+     * @description: 重载父类的initBaseSaveAttributes方法
+     * @function module:3DPlot.BaseIrregularPrimitive.initBaseSaveAttributes
+     * @public
+     * @override
+     */
     initBaseSaveAttributes() {
         this.dimModHeight = this._modHeight;
         this.isOpenWall = true;
@@ -93,6 +120,14 @@ class BaseIrregularPrimitive extends BasePlotPrimitive {
         this.wallGradColor = "rgba(255,0,0,0.3)";
     }
 
+    /**
+     * @description: 重载父类的getPrimitiveBaseSaveAttributes方法
+     * @function module:3DPlot.BaseIrregularPrimitive.initBaseSaveAttributes
+     * @public
+     * @override
+     *
+     * @return {Array} Attributes 字段数组
+     */
     getPrimitiveBaseSaveAttributes() {
         return BaseIrregularPrimitive.extendPrimitiveAttributes.concat([]);
     }