npm - @mapgis/webclient-cesium-plugin - Versions diffs - 17.8.0 → 17.10.9 - Mend

@mapgis/webclient-cesium-plugin 17.8.0 → 17.10.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (227) hide show

package/{documention → documentation}/CuttingTool.html RENAMED Viewed

@@ -94,27 +94,12 @@
     </div>
-    <p class="summary"><h5>请参考以下示例：</h5>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/modelAnalyse/model-cutting' target='_blank'>1、动态剖切</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/geologyAnalyse/model-banding' target='_blank'>2、地质体封边</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/terrainAnalyse/terrain-excavation' target='_blank'>3、地形开挖</a>
-<h5>支持如下方法：</h5>
-<a href='#createModelCuttingPlane'>[1、创建模型裁剪面]</a><br/>
-<a href='#changePlaneColor'>[2、修改辅助剖切面颜色]</a><br/>
-<a href='#createModelCuttingPlaneFromLine'>[3、通过直线，绘制模型裁剪面]</a><br/>
-<a href='#createModelCuttingPlaneFromPolyline'>[4、通过折线，绘制模型裁剪面，请提两个以上的点，否则不执行剖切分析]</a><br/>
-<a href='#createModelCuttingVolume'>[5、通过边界区域，以及最小最大高程，构建裁剪体]</a><br/>
-<a href='#createModelCuttingPolygon'>[6、多边形几何裁剪]</a><br/>
-<a href='#removeAll'>[7、移除所有裁剪面]</a><br/>
-<a href='#enabled'>[8、开关当前被CuttingTool管理的裁剪体]</a><br/>
-<a href='#showCuttingPlane'>[9、显示或隐藏所有辅助剖切面(体)]</a><br/></p>
 </dt>
 <dd>
     <div class="description">
-        <p>三维场景裁剪工具集</p>
+        <p>三维场景裁剪工具集，用于对模型图层执行剖切、裁剪体构建，以及可选的地形开挖联动。</p>
     </div>
@@ -166,7 +151,7 @@
-                <p>三维视图对象，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html' target='_blank'>详见Cesium.Viewer</a></p></td>
+                <p>三维视图对象，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html' target='_blank'>详见 Cesium.Viewer</a>。</p></td>
         </tr>
@@ -194,9 +179,9 @@
-                <p>要剖切的图层对象数组，
-详见<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/MapGISM3DSet.html' target='_blank'>《Cesium.MapGISM3DSet》</a>
-<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/Cesium3DTileset.html' target='_blank'>《Cesium.Cesium3DTileset》</a></p></td>
+                <p>要剖切的图层对象数组。
+支持 <a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/MapGISM3DSet.html' target='_blank'>《Cesium.MapGISM3DSet》</a>
+和 <a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/Cesium3DTileset.html' target='_blank'>《Cesium.Cesium3DTileset》</a>。</p></td>
         </tr>
@@ -226,7 +211,7 @@
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -272,7 +257,8 @@
-                <p>发生错误时的回调函数，type：错误类型，msg：错误信息。0：点数量小于2；1：为凹多边形，不支持；2：有空对象；3：格式不是笛卡尔对象；4：裁剪体高度不正确</p></td>
+                <p>发生错误时的回调函数，<code>type</code> 为错误类型，<code>msg</code> 为错误信息。
+错误类型约定为：<code>0</code> 点数量小于 2，<code>1</code> 为凹多边形不支持，<code>2</code> 有空对象，<code>3</code> 不是笛卡尔点对象，<code>4</code> 裁剪体高度不正确。</p></td>
         </tr>
@@ -302,7 +288,7 @@
-                <p>是否支持开挖地形</p></td>
+                <p>是否在创建裁剪体时同步对地形执行开挖。</p></td>
         </tr>
@@ -353,6 +339,29 @@
+        <h5>Example</h5>
+        <p class="code-caption"><h7>初始化模型裁剪工具</h7></p>
+    <pre class="prettyprint"><code>// ES5引入方式
+const { CuttingTool } = zondy.cesium
+// ES6引入方式
+import { CuttingTool } from '@mapgis/webclient-cesium-plugin'
+// 参考示例：
+// http://10.10.130.72:8086/#/modules/cesium/analyse/modelAnalyse/model-cutting
+// http://10.10.130.72:8086/#/modules/cesium/analyse/geologyAnalyse/model-banding
+// http://10.10.130.72:8086/#/modules/cesium/analyse/terrainAnalyse/terrain-excavation
+const cuttingTool = new CuttingTool(viewer, layerList, {
+  isCuttingTerrain: false
+})</code></pre>
 </dd>
@@ -413,6 +422,52 @@
+</dl>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="terrainExcavate">terrainExcavate<span class="type-signature type terrainexcavatetool"><a href="TerrainExcavateTool.html">TerrainExcavateTool</a></span> </h4>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>地形剖切工具实例
+用于地形裁剪和开挖的工具实例，可通过此属性访问 TerrainExcavateTool 的所有功能。</p>
+    </div>
+<dl class="details">
 </dl>
@@ -439,7 +494,7 @@
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 330
+            engineExtensions/tools/CuttingTool.js, line 276
         </div>
     </div>
@@ -450,7 +505,7 @@
     <div class="description">
-        <p>修改辅助剖切面颜色<a id='changePlaneColor'/></p>
+        <p>修改已有辅助剖切面或辅助裁剪体的显示颜色。<a id='changePlaneColor'/></p>
     </div>
@@ -512,7 +567,7 @@
-                <p>辅助面颜色</p></td>
+                <p>辅助面颜色。</p></td>
         </tr>
@@ -570,7 +625,7 @@
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 87
+            engineExtensions/tools/CuttingTool.js, line 78
         </div>
     </div>
@@ -581,7 +636,7 @@
     <div class="description">
-        <p>创建模型裁剪面，支持MapGISM3DSet和Cesium3DTileset<a id='createModelCuttingPlane'/></p>
+        <p>创建单个模型裁剪面，支持 MapGISM3DSet 和 Cesium3DTileset。<a id='createModelCuttingPlane'/></p>
     </div>
@@ -633,7 +688,7 @@
-                <p>裁剪面的法线</p></td>
+                <p>裁剪面的法线方向。</p></td>
         </tr>
@@ -663,7 +718,7 @@
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -717,7 +772,7 @@
-                <p>裁剪面的初始距离</p></td>
+                <p>裁剪面的初始距离。</p></td>
         </tr>
@@ -753,7 +808,7 @@
-                <p>辅助面宽度缩放比例</p></td>
+                <p>辅助面的宽度缩放比例。</p></td>
         </tr>
@@ -789,7 +844,7 @@
-                <p>辅助面高度缩放比例</p></td>
+                <p>辅助面的高度缩放比例。</p></td>
         </tr>
@@ -825,7 +880,7 @@
-                <p>裁剪方向，false：原方向，true：反向</p></td>
+                <p>裁剪方向，<code>false</code> 表示原方向，<code>true</code> 表示反向。</p></td>
         </tr>
@@ -861,7 +916,7 @@
-                <p>辅助面颜色</p></td>
+                <p>辅助面颜色。</p></td>
         </tr>
@@ -897,7 +952,7 @@
-                <p>是否显示辅助面</p></td>
+                <p>是否显示辅助面。</p></td>
         </tr>
@@ -961,7 +1016,7 @@
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 359
+            engineExtensions/tools/CuttingTool.js, line 304
         </div>
     </div>
@@ -972,7 +1027,7 @@
     <div class="description">
-        <p>通过直线，绘制模型裁剪面，支持MapGISM3DSet和Cesium3DTileset<a id='createModelCuttingPlaneFromLine'/></p>
+        <p>通过一条直线定义模型裁剪面，支持 MapGISM3DSet 和 Cesium3DTileset。<a id='createModelCuttingPlaneFromLine'/></p>
     </div>
@@ -1024,7 +1079,7 @@
-                <p>直线起始点 A，必须为角度制的经纬度值</p></td>
+                <p>直线起始点 A，必须为角度制经纬度点。</p></td>
         </tr>
@@ -1052,7 +1107,7 @@
-                <p>直线终止点 B，必须为角度制的经纬度值</p></td>
+                <p>直线终止点 B，必须为角度制经纬度点。</p></td>
         </tr>
@@ -1082,7 +1137,7 @@
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -1136,7 +1191,7 @@
-                <p>辅助面宽度缩放比例</p></td>
+                <p>辅助面宽度缩放比例。</p></td>
         </tr>
@@ -1172,7 +1227,7 @@
-                <p>辅助面高度缩放比例</p></td>
+                <p>辅助面高度缩放比例。</p></td>
         </tr>
@@ -1208,7 +1263,7 @@
-                <p>辅助面颜色</p></td>
+                <p>辅助面颜色。</p></td>
         </tr>
@@ -1244,7 +1299,7 @@
-                <p>是否显示辅助面</p></td>
+                <p>是否显示辅助面。</p></td>
         </tr>
@@ -1280,7 +1335,7 @@
-                <p>裁剪方向，false为原方向，true为反方向</p></td>
+                <p>裁剪方向，<code>false</code> 为原方向，<code>true</code> 为反方向。</p></td>
         </tr>
@@ -1344,7 +1399,7 @@
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 374
+            engineExtensions/tools/CuttingTool.js, line 321
         </div>
     </div>
@@ -1355,7 +1410,7 @@
     <div class="description">
-        <p>通过折线，绘制模型裁剪面，请提两个以上的点，否则不执行剖切分析，支持MapGISM3DSet和Cesium3DTileset<a id='createModelCuttingPlaneFromPolyline'/></p>
+        <p>通过折线定义模型裁剪面，至少需要两个点，支持 MapGISM3DSet 和 Cesium3DTileset。<a id='createModelCuttingPlaneFromPolyline'/></p>
     </div>
@@ -1407,7 +1462,7 @@
-                <p>折线的点坐标</p></td>
+                <p>折线点坐标数组。</p></td>
         </tr>
@@ -1437,7 +1492,7 @@
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -1491,7 +1546,8 @@
-                <p>辅助面宽度缩放比例(剖切对象为模型时，才会有有效辅助面，辅助面相关配置才会生效)</p></td>
+                <p>辅助面宽度缩放比例。
+仅当剖切对象为模型时，辅助面相关配置才会生效。</p></td>
         </tr>
@@ -1527,7 +1583,7 @@
-                <p>辅助面高度缩放比例</p></td>
+                <p>辅助面高度缩放比例。</p></td>
         </tr>
@@ -1563,7 +1619,7 @@
-                <p>辅助面颜色</p></td>
+                <p>辅助面颜色。</p></td>
         </tr>
@@ -1599,7 +1655,7 @@
-                <p>是否显示辅助面</p></td>
+                <p>是否显示辅助面。</p></td>
         </tr>
@@ -1635,7 +1691,7 @@
-                <p>裁剪方向，true为原方向，false为反方向</p></td>
+                <p>裁剪方向，<code>false</code> 为反方向裁剪，<code>true</code> 为原方向裁剪。</p></td>
         </tr>
@@ -1699,7 +1755,7 @@
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 558
+            engineExtensions/tools/CuttingTool.js, line 483
         </div>
     </div>
@@ -1710,8 +1766,8 @@
     <div class="description">
-        <p>多边形几何裁剪<br/><a id='createModelCuttingPolygon'/>
-通过边界区域，以及高程，构建裁剪几何体。支持凹多边形裁剪，但对封边效果支持不好，仅支持MapGISM3DSet</p>
+        <p>多边形几何裁剪。<a id='createModelCuttingPolygon'/>
+通过边界区域和高程范围构建裁剪几何体。支持凹多边形裁剪，但封边效果仅对 MapGISM3DSet 支持较好。</p>
     </div>
@@ -1758,7 +1814,7 @@
             <td class="description last">
-                <p>区域边界点数组,点需要按照顺时针方向选取。要求是经纬度坐标</p></td>
+                <p>区域边界点数组，点需要按顺时针方向选取，且要求为经纬度坐标。</p></td>
         </tr>
@@ -1781,7 +1837,7 @@
             <td class="description last">
-                <p>最小高程</p></td>
+                <p>最小高程。</p></td>
         </tr>
@@ -1804,7 +1860,7 @@
             <td class="description last">
-                <p>最大高程</p></td>
+                <p>最大高程。</p></td>
         </tr>
@@ -1827,7 +1883,7 @@
             <td class="description last">
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -1881,7 +1937,7 @@
-                <p>可选参数，配置裁剪体的颜色，以及透明度</p></td>
+                <p>配置裁剪体颜色及透明度。</p></td>
         </tr>
@@ -1917,7 +1973,7 @@
-                <p>裁剪方向，true：去除裁剪区域内的部分，false：去除裁剪区域外的部分</p></td>
+                <p>裁剪方向，<code>true</code> 表示去除裁剪区域内的部分，<code>false</code> 表示去除裁剪区域外的部分。</p></td>
         </tr>
@@ -1953,7 +2009,7 @@
-                <p>是否显示辅助面</p></td>
+                <p>是否显示辅助面。</p></td>
         </tr>
@@ -2006,26 +2062,25 @@
         <h5>Example</h5>
+        <p class="code-caption"><h7>多边形几何裁剪</h7></p>
-    <pre class="prettyprint"><code>var cutTool = new Cesium.CuttingTool(viewer, layerList);
+    <pre class="prettyprint"><code>var cutTool = new Cesium.CuttingTool(viewer, layerList)
 var positions = [
-    113.0406, 30.0378,
-    113.0595, 30.0378,
-    113.0595, 30.0297,
-    113.0762, 30.0297,
-    113.0762, 30.0179,
-    113.0595, 30.0179,
-    113.0595, 30.0099,
-    113.0406, 30.0099
-];
+  113.0406, 30.0378,
+  113.0595, 30.0378,
+  113.0595, 30.0297,
+  113.0762, 30.0297,
+  113.0762, 30.0179,
+  113.0595, 30.0179,
+  113.0595, 30.0099,
+  113.0406, 30.0099
+]
 cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-    //裁剪方向，false：原方向，true反方向
-    unionClippingRegions: false,
-    //配置裁剪体的颜色，以及透明度
-    color: new Cesium.Color(1, 1, 1, 0.2),
-    //是否显示裁剪体
-    showCuttingPlane: true
+  unionClippingRegions: false,
+  color: new Cesium.Color(1, 1, 1, 0.2),
+  showCuttingPlane: true
 })</code></pre>
@@ -2043,7 +2098,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 518
+            engineExtensions/tools/CuttingTool.js, line 444
         </div>
     </div>
@@ -2054,7 +2109,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
     <div class="description">
-        <p>通过边界区域，以及最小最大高程，构建裁剪体，支持MapGISM3DSet和Cesium3DTileset<a id='createModelCuttingVolume'/></p>
+        <p>根据边界区域与高程范围构建裁剪体，支持 MapGISM3DSet 和 Cesium3DTileset。<a id='createModelCuttingVolume'/></p>
     </div>
@@ -2101,7 +2156,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
             <td class="description last">
-                <p>区域边界点数组,点需要按照顺时针方向选取</p></td>
+                <p>区域边界点数组，点需要按顺时针方向选取。</p></td>
         </tr>
@@ -2124,7 +2179,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
             <td class="description last">
-                <p>最小高程</p></td>
+                <p>最小高程。</p></td>
         </tr>
@@ -2147,7 +2202,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
             <td class="description last">
-                <p>最大高程</p></td>
+                <p>最大高程。</p></td>
         </tr>
@@ -2170,7 +2225,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
             <td class="description last">
-                <p>可选参数</p>
+                <p>可选参数。</p>
 <table class="params">
@@ -2224,7 +2279,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-                <p>可选参数，配置裁剪体的颜色，以及透明度</p></td>
+                <p>配置裁剪体颜色及透明度。</p></td>
         </tr>
@@ -2260,7 +2315,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-                <p>裁剪方向，true：去除裁剪区域内的部分，false：去除裁剪区域外的部分</p></td>
+                <p>裁剪方向，<code>true</code> 表示去除裁剪区域内的部分，<code>false</code> 表示去除裁剪区域外的部分。</p></td>
         </tr>
@@ -2296,7 +2351,44 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-                <p>是否显示辅助面(剖切对象为模型时，才会有有效辅助面，辅助面相关配置才会生效)</p></td>
+                <p>是否显示辅助面。
+仅当剖切对象为模型时，辅助面相关配置才会生效。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>isFill</code></td>
+            <td class="type">
+<span class="param-type">Boolean</span>
+            </td>
+                <td class="default">
+                    true
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>是否显示地形开挖封边，<code>true</code> 表示显示侧边和底面，<code>false</code> 表示隐藏侧边和底面。</p></td>
         </tr>
@@ -2332,7 +2424,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-                <p>地形封边底面颜色纹理资源路径</p></td>
+                <p>地形封边底面纹理资源路径。</p></td>
         </tr>
@@ -2368,7 +2460,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
-                <p>地形封边剖面颜色纹理资源路径</p></td>
+                <p>地形封边剖面纹理资源路径。</p></td>
         </tr>
@@ -2432,7 +2524,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 741
+            engineExtensions/tools/CuttingTool.js, line 653
         </div>
     </div>
@@ -2443,7 +2535,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
     <div class="description">
-        <p>开关当前被CuttingTool管理的裁剪体<a id='enabled'/></p>
+        <p>统一开关当前由 CuttingTool 管理的裁剪效果。<a id='enabled'/></p>
     </div>
@@ -2490,7 +2582,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
             <td class="description last">
-                </td>
+                <p><code>true</code> 表示启用裁剪效果，<code>false</code> 表示关闭裁剪效果。</p></td>
         </tr>
@@ -2548,7 +2640,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 682
+            engineExtensions/tools/CuttingTool.js, line 592
         </div>
     </div>
@@ -2559,7 +2651,7 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
     <div class="description">
-        <p>移除所有裁剪面<a id='removeAll'/></p>
+        <p>移除当前工具管理的所有裁剪面、裁剪体以及地形开挖结果。<a id='removeAll'/></p>
     </div>
@@ -2608,11 +2700,13 @@ cutTool.createModelCuttingPolygon(positions, -1000, 500, {
         <h5>Example</h5>
+        <p class="code-caption"><h7>清理裁剪结果</h7></p>
-    <pre class="prettyprint"><code>var cutTool = new Cesium.CuttingTool(viewer, layerList);
+    <pre class="prettyprint"><code>var cutTool = new Cesium.CuttingTool(viewer, layerList)
-cutTool.removeAll();</code></pre>
+cutTool.removeAll()</code></pre>
@@ -2629,7 +2723,7 @@ cutTool.removeAll();</code></pre>
         <div class="tag-source">
-            engineExtensions/tools/CuttingTool.js, line 759
+            engineExtensions/tools/CuttingTool.js, line 673
         </div>
     </div>
@@ -2640,7 +2734,8 @@ cutTool.removeAll();</code></pre>
     <div class="description">
-        <p>控制已有的剖切面辅助面的显隐状（在添加模型裁剪面时，辅助面的显隐需通过配置可选参数options.showCuttingPlane来设置）<a id='showCuttingPlane'/></p>
+        <p>控制已创建辅助剖切面或辅助裁剪体的显隐状态。<a id='showCuttingPlane'/>
+在新增模型裁剪面时，辅助面的初始显隐仍需通过 <code>options.showCuttingPlane</code> 配置。</p>
     </div>
@@ -2702,7 +2797,7 @@ cutTool.removeAll();</code></pre>
-                <p>显示或隐藏所有辅助剖切面(体)，true为显示所有辅助剖切面(体)，false为隐藏所有辅助剖切面(体)</p></td>
+                <p><code>true</code> 表示显示全部辅助剖切面（体），<code>false</code> 表示隐藏全部辅助剖切面（体）。</p></td>
         </tr>
@@ -2763,7 +2858,7 @@ cutTool.removeAll();</code></pre>
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Wed Feb 04 2026 18:31:34 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>