【杨琨】【添加注释】

Author: killer1992

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

@@ -1,15 +1,24 @@
-/*
- * @Description:
- * @Author: zk
- * @Date: 2022-01-12 13:59:36
- * @LastEditors: Do not edit
- * @LastEditTime: 2022-03-31 10:31:38
- */
 import { defined } from "../../../../service/PlotUtilBase/Check";
 import RegularLineElementInstance from "./RegularLineElementInstance";
 import GeomUtil from "../../../../service/PlotUtilBase/Geometry/GeomUtil";
 
+/**
+ * @class module:3DPlot.IrregularElementInstance
+ * @description SVG的非规则符号解析器
+ * @author 基础平台-杨琨
+ */
 export default class IrregularElementInstance extends RegularLineElementInstance {
+
+  /**
+   * @function module:3DPlot.IrregularElementInstance.svgToGeomInstances
+   * @description 重载父类的svgToGeomInstances方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} options 额外参数
+   * @param {function} callback 回调函数
+   */
   svgToGeomInstances(elem, options, callback) {
     const instances = this.pathElemToGeomInstance(elem, options);
     let wallGeomInstances;
@@ -21,6 +30,15 @@ export default class IrregularElementInstance extends RegularLineElementInstance
     callback({ instances, wallGeomInstances });
   }
 
+  /**
+   * @function module:3DPlot.IrregularElementInstance.pathElemToGeomInstance
+   * @description 重载父类的pathElemToGeomInstance方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG的path符号对象
+   * @param {Object} options 额外参数
+   */
   pathElemToGeomInstance(elem, options) {
     const instances = [];
     const coords = elem.cacheCoords || elem.getCoords();

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

@@ -1,14 +1,23 @@
-/*
- * @Author: your name
- * @Date: 2021-11-04 15:54:38
- * @LastEditTime: 2022-05-20 19:54:49
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\KidneyAreaElementInstance.js
- */
 import RegularLine1ElementInstance from "./RegularLine1ElementInstance";
 import {CesiumGeomUtil} from "../../Utils/CesiumUtil";
+
+/**
+ * @class module:3DPlot.KidneyAreaElementInstance
+ * @description SVG的二类线符号解析基类
+ * @author 基础平台-杨琨
+ */
 export default class KidneyAreaElementInstance extends RegularLine1ElementInstance {
+
+  /**
+   * @function module:3DPlot.KidneyAreaElementInstance.transfromGeoCesium
+   * @description: 重载父类的transfromGeoCesium方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} cesgeo 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   transfromGeoCesium(elem, cesgeo, options) {
     CesiumGeomUtil.degreesWithHeightToWorldCoords(
         cesgeo,

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

@@ -1,22 +1,38 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:26:48
- * @LastEditTime: 2022-05-23 09:13:04
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\RegularLine1ElementInstance.js
- */
-
 import { CesiumGeomUtil, CesiumUtil } from "../../Utils/CesiumUtil";
 import MainElement from "../../../../service/PlotBase/SvgLoader/element/extend/MainElement";
 import RegularLineElementInstance from "./RegularLineElementInstance";
 
+/**
+ * @class module:3DPlot.RegularLine1ElementInstance
+ * @description SVG的一类线符号解析器
+ * @author 基础平台-杨琨
+ */
 export default class RegularLine1ElementInstance extends RegularLineElementInstance {
+
+  /**
+   * @function module:3DPlot.RegularLineElementInstance.pathElemToWallGeomInstance
+   * @description 重载父类的pathElemToWallGeomInstance方法
+   * @public
+   * @override
+   *
+   * @param {Object} pathElem SVG的path符号对象
+   * @param {Object} options 额外参数
+   */
   pathElemToWallGeomInstance(pathElem, options) {
     if (!(pathElem instanceof MainElement)) return undefined;
     return super.pathElemToWallGeomInstance(pathElem, options);
   }
 
+  /**
+   * @function module:3DPlot.SvgElementInstance.transfromGeoCesium
+   * @description: 重载父类的transfromGeoCesium方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} cesgeo 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   transfromGeoCesium(elem, cesgeo, options) {
     super.transfromGeoCesium(elem, cesgeo, options);
     const {dimModAttitude}=options
@@ -25,6 +41,14 @@ export default class RegularLine1ElementInstance extends RegularLineElementInsta
     }
   }
 
+  /**
+   * @description: 对三维几何体机型坐标系转化，墨卡托转经纬度
+   * @private
+   *
+   * @param {Object} ele SVG符号对象
+   * @param {Object} cesGeom 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   _rotatePart(ele, cesGeom, options) {
     const { dimModHeight } = options;
     if (ele instanceof MainElement) return;

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

@@ -1,11 +1,8 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:26:48
- * @LastEditTime: 2022-02-23 10:16:10
- * @LastEditors: Do not edit
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\RegularLine1ElementInstance.js
- */
 import RegularLineElementInstance from "./RegularLineElementInstance";
 
+/**
+ * @class module:3DPlot.RegularLine2ElementInstance
+ * @description SVG的二类线符号解析器
+ * @author 基础平台-杨琨
+ */
 export default class RegularLine2ElementInstance extends RegularLineElementInstance {}

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

@@ -1,17 +1,25 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:26:48
- * @LastEditTime: 2022-05-20 17:14:28
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\RegularLine1ElementInstance.js
- */
 import SvgElementInstance from "./SvgElementInstance";
 import { CesiumGeomUtil, CesiumUtil } from "../../Utils/CesiumUtil";
 import MainElement from "../../../../service/PlotBase/SvgLoader/element/extend/MainElement";
 import { defined } from "../../../PlotUtilBase/Check";
 
+/**
+ * @class module:3DPlot.RegularLineElementInstance
+ * @description SVG的线符号解析基类
+ * @author 基础平台-杨琨
+ */
 export default class RegularLineElementInstance extends SvgElementInstance {
+
+  /**
+   * @function module:3DPlot.RegularLineElementInstance.svgToGeomInstances
+   * @description 重载父类的svgToGeomInstances方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} options 额外参数
+   * @param {function} callback 回调函数
+   */
   svgToGeomInstances(elem, options, callback) {
     let that = this;
     super.svgToGeomInstances(elem, options, function (instances, wallOffsetHeights) {
@@ -21,10 +29,13 @@ export default class RegularLineElementInstance extends SvgElementInstance {
   }
 
   /**
-   * 生成墙
-   * @param {*} elem
-   * @param {*} options
-   * @returns
+   * @function module:3DPlot.RegularLineElementInstance.generateWallGeometryInstances
+   * @description 生成三维墙体几何对象
+   * @public
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} options 额外参数
+   * @param {Array} wallOffsetHeights 开启高程采样是墙体的抬高高度数组
    */
   generateWallGeometryInstances(elem, options, wallOffsetHeights) {
     if (!options.isOpenWall) return undefined;
@@ -55,6 +66,15 @@ export default class RegularLineElementInstance extends SvgElementInstance {
     return instances;
   }
 
+  /**
+   * @function module:3DPlot.RegularLineElementInstance.pathElemToWallGeomInstance
+   * @description 生成三维墙的CesiumGeometry对象
+   * @public
+   *
+   * @param {Object} pathElem SVG的path符号对象
+   * @param {Object} options 额外参数
+   * @param {Array} wallOffsetHeights 开启高程采样是墙体的抬高高度数组
+   */
   pathElemToWallGeomInstance(pathElem, options, wallOffsetHeights) {
     const wallHeight = options.dimModHeight;
     const wallColor = options.wallColor;
@@ -123,6 +143,15 @@ export default class RegularLineElementInstance extends SvgElementInstance {
     return instances;
   }
 
+  /**
+   * @function module:3DPlot.RegularLineElementInstance.pathElemToGeomInstance
+   * @description 重载父类的pathElemToGeomInstance方法
+   * @public
+   * @override
+   *
+   * @param {Object} pathElem SVG的path符号对象
+   * @param {Object} options 额外参数
+   */
   pathElemToGeomInstance(pathElem, options) {
     const instances = [];
     const style=pathElem.getContextStyle()
@@ -182,6 +211,15 @@ export default class RegularLineElementInstance extends SvgElementInstance {
     return instances;
   }
 
+  /**
+   * @function module:3DPlot.SvgElementInstance.transformExtrudeGeometry
+   * @description: 重载父类的transformExtrudeGeometry方法
+   * @public
+   * @override
+   *
+   * @param {Object} geometry 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   transformExtrudeGeometry(geometry,options) {
     if (!defined(geometry)) return;
 
@@ -200,6 +238,16 @@ export default class RegularLineElementInstance extends SvgElementInstance {
     }
   }
 
+  /**
+   * @function module:3DPlot.SvgElementInstance.transfromGeoCesium
+   * @description: 重载父类的transfromGeoCesium方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} cesGeom 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   transfromGeoCesium(elem,cesGeom, options) {
     CesiumGeomUtil.degreesWithHeightToWorldCoords(
       cesGeom,

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

@@ -1,16 +1,23 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 10:29:02
- * @LastEditTime: 2022-05-20 10:25:10
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\RegularPointElementInstance.js\
- */
 import SvgElementInstance from "./SvgElementInstance";
 import {CesiumGeomUtil} from "../../Utils/CesiumUtil";
 
+/**
+ * @class module:3DPlot.RegularPointElementInstance
+ * @description SVG的点符号解析器
+ * @author 基础平台-杨琨
+ */
 export default class RegularPointElementInstance extends SvgElementInstance {
 
+  /**
+   * @function module:3DPlot.SvgElementInstance.transformExtrudeGeometry
+   * @description: 重载父类的transfromGeoCesium方法
+   * @public
+   * @override
+   *
+   * @param {Object} elem SVG符号对象
+   * @param {Object} cesgeo 三维几何体对象
+   * @param {Object} options 额外参数
+   */
   transfromGeoCesium(elem,cesgeo, options) {
     const { dimModHeight, dimModAttitude } = options;
 

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

@@ -1,16 +1,24 @@
-/*
- * @Author: your name
- * @Date: 2021-10-25 11:15:18
- * @LastEditTime: 2022-05-23 19:01:26
- * @LastEditors: zk
- * @Description: In User Settings Edit
- * @FilePath: \MapGISPlotBase\src\3DPlot\Primitive\ElementInstance\RegularSurfaceElementInstance.js
- */
 import Bounds from "../../../../service/PlotUtilBase/Geometry/Bound";
 import {CesiumUtil} from "../../Utils/CesiumUtil";
 import SvgElementInstance from "./SvgElementInstance";
 
+/**
+ * @class module:3DPlot.RegularSurfaceElementInstance
+ * @description SVG的一类区符号解析基类
+ * @author 基础平台-杨琨
+ */
 export default class RegularSurfaceElementInstance extends SvgElementInstance {
+
+    /**
+     * @function module:3DPlot.SvgElementInstance.svgToGeomInstances
+     * @description 重载父类的svgToGeomInstances方法
+     * @public
+     * @override
+     *
+     * @param {Object} elem SVG符号对象
+     * @param {Object} options 额外参数
+     * @param {function} callback 回调函数
+     */
     svgToGeomInstances(elem, options, callback) {
         const {surfaceBorderWidth} = options
         this.polylineOutInstance = null;
@@ -52,6 +60,14 @@ export default class RegularSurfaceElementInstance extends SvgElementInstance {
         });
     }
 
+    /**
+     * @function module:3DPlot.SvgElementInstance.pathElemToGeomInstance
+     * @description 重载父类的pathElemToGeomInstance方法
+     * @public
+     * @override
+     *
+     * @param {Object} elem path元素的符号对象
+     */
     pathElemToGeomInstance(elem) {
         const _parts = elem.cacheCoords || elem.getCoords();
 

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

@@ -1,12 +1,9 @@
-/*
- * @class: 
- * @Description: 
- * @Author: zk
- * @Date: 2022-05-23 16:44:52
- * @LastEditors: zk
- * @LastEditTime: 2022-05-23 16:44:52
- */
-
 import SimpleLineElementInstance from "./SimpleLineElementInstance";
+
+/**
+ * @class module:3DPlot.SimpleAreaForKidneyElementInstance
+ * @description SVG的新规则区符号解析基类
+ * @author 基础平台-杨琨
+ */
 export default class SimpleAreaForKidneyElementInstance extends SimpleLineElementInstance {
 }