@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/VisiblityAnalysis.html

@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>通视分析</p>
+        <p>通视分析工具，用于判断视点与目标点之间是否可见，并支持环视可视域分析。</p>
     </div>
     
 
@@ -429,10 +429,13 @@
     
         <h5>Example</h5>
         
+        <p class="code-caption"><h7>通视分析与环视分析</h7></p>
+    
 
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { VisiblityAnalysis } = zondy.cesium
+
 // ES6引入方式
 import { VisiblityAnalysis } from "@mapgis/webclient-cesium-plugin"
 
@@ -754,7 +757,7 @@ visiblity.destroy();</code></pre>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="unvisibleColor">unvisibleColor<span class="type-signature type cesium.color">Cesium.Color</span> </h4>
+        <h4 class="name" id="unVisiblityPosition">unVisiblityPosition<span class="type-signature type cesium.cartesian3">Cesium.Cartesian3</span> </h4>
     </div>
     
     
@@ -762,7 +765,7 @@ visiblity.destroy();</code></pre>
 <dd>
     
     <div class="description">
-        <p>设置不可视段颜色</p>
+        <p>遮挡点</p>
     </div>
     
     
@@ -799,7 +802,7 @@ visiblity.destroy();</code></pre>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="unVisiblityPosition">unVisiblityPosition<span class="type-signature type cesium.cartesian3">Cesium.Cartesian3</span> </h4>
+        <h4 class="name" id="unvisibleColor">unvisibleColor<span class="type-signature type cesium.color">Cesium.Color</span> </h4>
     </div>
     
     
@@ -807,7 +810,7 @@ visiblity.destroy();</code></pre>
 <dd>
     
     <div class="description">
-        <p>遮挡点</p>
+        <p>设置不可视段颜色</p>
     </div>
     
     
@@ -994,7 +997,7 @@ visiblity.destroy();</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/VisiblityAnalysis.js, line 239
+            engineExtensions/analysis/VisiblityAnalysis.js, line 217
         </div>
         
     </div>
@@ -1005,7 +1008,7 @@ visiblity.destroy();</code></pre>
     
     
     <div class="description">
-        <p>根据两点坐标判断两点之间是否可视，返回结果</p>
+        <p>根据视点和目标点判断两点之间是否互相可视。</p>
     </div>
     
 
@@ -1052,7 +1055,7 @@ visiblity.destroy();</code></pre>
             
             <td class="description last">
                 
-                <p>视点</p></td>
+                <p>视点。</p></td>
         </tr>
 	
 	
@@ -1075,7 +1078,7 @@ visiblity.destroy();</code></pre>
             
             <td class="description last">
                 
-                <p>目标点</p></td>
+                <p>目标点。</p></td>
         </tr>
 	
 	
@@ -1140,7 +1143,7 @@ visiblity.destroy();</code></pre>
                         
                     
             </td>
-            <td class="description last">visible 两点之间是否可视</td>
+            <td class="description last">两点之间是否可视。</td>
         </tr>
     
     </tbody>
@@ -1162,7 +1165,7 @@ visiblity.destroy();</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/VisiblityAnalysis.js, line 273
+            engineExtensions/analysis/VisiblityAnalysis.js, line 248
         </div>
         
     </div>
@@ -1475,7 +1478,7 @@ visiblity.destroy();</code></pre>
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:56:00 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>

package/{documention → documentation}/VolumeCloud.html

@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>体积云</p>
+        <p>体积云效果对象，用于在指定矩形范围内渲染可随相机高度动态调节的云层。</p>
     </div>
     
 
@@ -146,7 +146,7 @@
             
             <td class="description last">
                 
-                
+                <p>初始化参数</p>
                 
 
 <table class="params">
@@ -177,7 +177,7 @@
             <td class="type">
             
                 
-<span class="param-type">Boolean</span>
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
 
 
             
@@ -192,13 +192,11 @@
             <td class="description last">
                 
                     
-                        <span class="optional"> 可选</span>
-                    
                     
                         
                     
                 
-                <p>Cesium场景视图对象</p></td>
+                <p>Cesium 场景视图对象</p></td>
         </tr>
 	
 	
@@ -211,7 +209,7 @@
             <td class="type">
             
                 
-<span class="param-type">Number</span>
+<span class="param-type">Cesium.Rectangle</span>
 
 
             
@@ -220,7 +218,7 @@
             
                 <td class="default">
                 
-                    new Cesium.Rectangle.fromDegrees(-180, -90, 180, 90)
+                    Cesium.Rectangle.fromDegrees(-180, -90, 180, 90)
                 
                 </td>
             
@@ -234,7 +232,7 @@
                         
                     
                 
-                <p>云层的区域范围，默认为全球范围</p></td>
+                <p>云层覆盖范围，默认使用全球矩形</p></td>
         </tr>
 	
 	
@@ -270,7 +268,7 @@
                         
                     
                 
-                <p>云层的底部高度，取值范围为[0,20000]，单位米，默认值为7500</p></td>
+                <p>云层底部高度，单位米，取值范围建议为 <code>[0, 20000]</code></p></td>
         </tr>
 	
 	
@@ -306,7 +304,7 @@
                         
                     
                 
-                <p>云层的顶部高度，取值范围为[0,20000]，单位米，默认值为8000</p></td>
+                <p>云层顶部高度，单位米，取值范围建议为 <code>[0, 20000]</code></p></td>
         </tr>
 	
 	
@@ -342,7 +340,7 @@
                         
                     
                 
-                <p>云层的密度，取值范围为[0,1]，0最稀疏，1最密集，默认值为0.27</p></td>
+                <p>云层密度，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -378,7 +376,7 @@
                         
                     
                 
-                <p>云层移动速度，取值范围为[0,1]，0最慢，1最快，默认值为0.1</p></td>
+                <p>云层移动速度，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -414,7 +412,7 @@
                         
                     
                 
-                <p>云层移动方向，取值范围为[0,360],0为正北方向，顺时针方向旋转，默认值为90，为正东方向</p></td>
+                <p>云层移动方向，取值范围 <code>[0, 360]</code>，<code>0</code> 为正北方向，顺时针旋转</p></td>
         </tr>
 	
 	
@@ -427,7 +425,7 @@
             <td class="type">
             
                 
-<span class="param-type">Number</span>
+<span class="param-type">Boolean</span>
 
 
             
@@ -450,7 +448,7 @@
                         
                     
                 
-                <p>云层的显隐，默认值为true，可见</p></td>
+                <p>云层是否显示</p></td>
         </tr>
 	
 	
@@ -486,7 +484,7 @@
                         
                     
                 
-                <p>云层可见的最低相机高度，当相机高度小于minCameraHeight或者大于maxCameraHeigh时，云层将不可见，默认值为0</p></td>
+                <p>云层可见的最低相机高度；当相机高度超出 <code>[minCameraHeight, maxCameraHeight]</code> 时云层不可见</p></td>
         </tr>
 	
 	
@@ -522,7 +520,43 @@
                         
                     
                 
-                <p>云层可见的最高相机高度，当相机高度小于minCameraHeight或者大于maxCameraHeigh时，云层将不可见，默认值为25000</p></td>
+                <p>云层可见的最高相机高度；当相机高度超出 <code>[minCameraHeight, maxCameraHeight]</code> 时云层不可见</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>depthWrite</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>深度写入控制；开启后可支持体积光、SSR 等特效，使用大气雾或水面特效时通常需要关闭</p></td>
         </tr>
 	
 	
@@ -575,9 +609,22 @@
     
         <h5>Example</h5>
         
+        <p class="code-caption"><h7>创建体积云</h7></p>
+    
 
     
-    <pre class="prettyprint"><code>const volumeCloud = new VolumeCloud({
    viewer
+    <pre class="prettyprint"><code>// ES5引入方式
+const { VolumeCloud } = zondy.cesium
+
+// ES6引入方式
+import { VolumeCloud } from "@mapgis/webclient-cesium-plugin"
+
+const volumeCloud = new VolumeCloud({
+  viewer,
+  rectangle: Cesium.Rectangle.fromDegrees(110, 28, 116, 33),
+  minHeight: 7500,
+  maxHeight: 9000
+})</code></pre>
     
 
     
@@ -637,6 +684,51 @@
     
     
     
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="depthWrite">depthWrite<span class="type-signature type boolean">Boolean</span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>深度写入控制，默认值为true，开启深度写入支持体积光、SSR等特效；在使用大气雾、水面特效时需要关闭深度写入；</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
 </dl>
 
@@ -978,7 +1070,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/effects/VolumeCloud.js, line 249
+            engineExtensions/effects/VolumeCloud.js, line 277
         </div>
         
     </div>
@@ -1052,7 +1144,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:56:00 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>

package/{documention → documentation}/VolumeFluidSource.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="VolumeFluidSource">
             
-            new VolumeFluidSource<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new VolumeFluidSource<span class="signature">(<span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>全域流体源对象</p>
+        <p>全域流体源对象。</p>
     </div>
     
 
@@ -146,7 +146,14 @@
             
             <td class="description last">
                 
-                <p>实例化全域流体源对象所需的参数</p>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>创建全域流体源对象的参数。</p>
                 
 
 <table class="params">
@@ -200,7 +207,7 @@
                         
                     
                 
-                <p>全域流体源的强度（每小时多少毫米）</p></td>
+                <p>全域流体源强度，单位为毫米每小时。</p></td>
         </tr>
 	
 	
@@ -271,7 +278,7 @@
                         
                     
             </td>
-            <td class="description last">返回根据参数实例化的全域流体源对象</td>
+            <td class="description last">返回全域流体源对象实例。</td>
         </tr>
     
     </tbody>
@@ -286,7 +293,16 @@
     
 
     
-    <pre class="prettyprint"><code>// ES5引入方式
  intensity: 500000,
+    <pre class="prettyprint"><code>// ES5引入方式
+const { VolumeFluidSource } = zondy.cesium
+
+// ES6引入方式
+import { VolumeFluidSource } from "@mapgis/webclient-cesium-plugin"
+
+// 创建全域流体源对象
+const volumeFluidSource = new VolumeFluidSource({
+  intensity: 500000,
+})</code></pre>
     
 
     
@@ -320,7 +336,7 @@
 <dd>
     
     <div class="description">
-        <p>全域流体源的强度（每小时多少毫米）</p>
+        <p>获取或设置全域流体源强度。</p>
     </div>
     
     
@@ -371,7 +387,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:56:00 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>

package/{documention → documentation}/WFSLayerUtil.html

@@ -94,15 +94,14 @@
     </div>
 
     
-    <p class="summary"><h5>支持如下方法：</h5>
-<a href='#toPrimitive'>[1、将单个要素或要素集合转换为Cesium原生Primitive的方法]</a><br/></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
-        <p>WFS图层的工具类</p>
+        <p>WFS 图层适配工具。</p>
+<p>该工具用于把 WFS 图层查询结果转换为 Cesium primitive，适合在客户端先完成
+WFS 查询和渲染器赋值，再把结果送入三维场景。</p>
     </div>
     
 
@@ -182,7 +181,7 @@
     
         
         <div class="tag-source">
-            view/utils/WFSLayerUtil.js, line 43
+            view/utils/WFSLayerUtil.js, line 51
         </div>
         
     </div>
@@ -193,7 +192,7 @@
     
     
     <div class="description">
-        <p>将单个要素或要素集合转换为Cesium原生Primitive的方法</p>
+        <p>将一个或多个 WFS 要素转换为 Cesium primitive。</p>
     </div>
     
 
@@ -243,7 +242,7 @@
             
             <td class="description last">
                 
-                <p>单个要素或要素集合</p></td>
+                <p>单个要素或要素集合。</p></td>
         </tr>
 	
 	
@@ -308,7 +307,7 @@
                         
                     
             </td>
-            <td class="description last">转换后的Primitive数组</td>
+            <td class="description last">转换后的 primitive 数组。</td>
         </tr>
     
     </tbody>
@@ -321,7 +320,37 @@
         
 
     
-    <pre class="prettyprint"><code>const url = 'http://10.10.130.72:8089/igs/rest/services/Map/湖北省4326/WFSServer'
  const renderer = new SimpleRenderer({
    //...
  })
  // 创建wfsLayer对象
  const wfsLayer = new WFSLayer({
    url,
    sublayerId: 'Map_湖北省4326:t70',
  })
  // 请求获取要素集
  const featureSet = await wfsLayer.queryFeatures()
  const features = featureSet.features
  // 为要素集设置renderer
  RendererUtil.updateRenderer(features, renderer)
  // 将要素集转换为原生Primitive对象
  const primitives = WFSLayerUtil.toPrimitive(features, {
    viewer
  })
  // 将Primitive对象添加到场景中
  for (let i = 0; i < primitives.length; i++) {
    viewer.scene.primitives.add(primitives[i])
  }
+    <pre class="prettyprint"><code>// ES5引入方式
+const { WFSLayerUtil } = zondy.cesium.util
+
+// ES6引入方式
+import { WFSLayerUtil } from '@mapgis/webclient-cesium-plugin'
+
+const url = 'http://10.10.130.72:8089/igs/rest/services/Map/湖北省4326/WFSServer'
+const addWFS = async (url) => {
+  const renderer = new SimpleRenderer({
+    //...
+  })
+  // 创建wfsLayer对象
+  const wfsLayer = new WFSLayer({
+    url,
+    sublayerId: 'Map_湖北省4326:t70',
+  })
+  // 请求获取要素集
+  const featureSet = await wfsLayer.queryFeatures()
+  const features = featureSet.features
+  // 为要素集设置renderer
+  RendererUtil.updateRenderer(features, renderer)
+  // 将要素集转换为原生Primitive对象
+  const primitives = WFSLayerUtil.toPrimitive(features, {
+    viewer
+  })
+  // 将Primitive对象添加到场景中
+  for (let i = 0; i < primitives.length; i++) {
+    viewer.scene.primitives.add(primitives[i])
+  }
+}
+addWFS(url)</code></pre>
     
 
     
@@ -341,7 +370,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:56:00 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>