@mapgis/webclient-cesium-plugin 17.8.0 → 17.10.9

package/{documention → documentation}/Fluid.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 26
+            engineExtensions/simulation/fluid/Fluid.js, line 33
         </div>
         
     </div>
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>流体模拟对象</p>
+        <p>流体模拟对象。</p>
     </div>
     
 
@@ -146,7 +146,7 @@
             
             <td class="description last">
                 
-                <p>实例化流体模拟对象所需的参数</p>
+                <p>创建流体模拟对象的参数。</p>
                 
 
 <table class="params">
@@ -192,13 +192,11 @@
             <td class="description last">
                 
                     
-                        <span class="optional"> 可选</span>
-                    
                     
                         
                     
                 
-                <p>场景视图对象</p></td>
+                <p>场景视图对象。</p></td>
         </tr>
 	
 	
@@ -226,13 +224,11 @@
             <td class="description last">
                 
                     
-                        <span class="optional"> 可选</span>
-                    
                     
                         
                     
                 
-                <p>流体模拟的地理范围</p></td>
+                <p>流体模拟的地理范围。</p></td>
         </tr>
 	
 	
@@ -266,7 +262,7 @@
                         
                     
                 
-                <p>模拟精度，单位米，表示间隔多少米采样一个点模拟。当用户不指定时，内部会根据模拟区域的范围大小自动计算一个模拟精度。理论上采样精度越高，模拟结果越精细，但模拟性能也会随之降低。同时受限于浏览器限制，纹理大小有上限，采样间隔不能太小</p></td>
+                <p>模拟采样精度，单位为米；值越小模拟越精细，但计算开销也越大。</p></td>
         </tr>
 	
 	
@@ -302,7 +298,7 @@
                         
                     
                 
-                <p>流体可视化的采样模式，可取值有两个：'linear'、'nearest'，分别为线性采样和临近采样，对于模拟区域内存在类似建筑物等垂直突变物体的情况，建议采用临近采样模式，默认值为临近采样'nearest'</p></td>
+                <p>流体可视化采样模式，可选 <code>'linear'</code> 或 <code>'nearest'</code>；存在建筑等垂直突变物体时建议使用 <code>'nearest'</code>。</p></td>
         </tr>
 	
 	
@@ -336,7 +332,7 @@
                         
                     
                 
-                <p>流体模拟的色表（使用方法详见下方示例）</p></td>
+                <p>流体模拟色表，键为深度值、值为对应的 <code>Cesium.Color</code>。</p></td>
         </tr>
 	
 	
@@ -372,20 +368,20 @@
                         
                     
                 
-                <p>流体模拟的粒子效果对象</p></td>
+                <p>流体粒子效果对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>fluidReflection</code></td>
+                <td class="name"><code>foam</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type"><a href="FluidReflection.html">FluidReflection</a></span>
+<span class="param-type"><a href="FluidFoam.html">FluidFoam</a></span>
 
 
             
@@ -394,7 +390,7 @@
             
                 <td class="default">
                 
-                    new FluidReflection()
+                    new FluidFoam()
                 
                 </td>
             
@@ -408,14 +404,50 @@
                         
                     
                 
-                <p>流体模拟的反射效果对象</p></td>
+                <p>流体白浪效果对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>fluidShadow</code></td>
+                <td class="name"><code>specular</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type"><a href="FluidSpecular.html">FluidSpecular</a></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    new FluidSpecular()
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>流体高光效果对象。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>shadow</code></td>
             
             
             <td class="type">
@@ -444,20 +476,20 @@
                         
                     
                 
-                <p>流体模拟的阴影效果对象</p></td>
+                <p>流体阴影效果对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>fluidSpecular</code></td>
+                <td class="name"><code>reflection</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type"><a href="FluidSpecular.html">FluidSpecular</a></span>
+<span class="param-type"><a href="FluidReflection.html">FluidReflection</a></span>
 
 
             
@@ -466,7 +498,7 @@
             
                 <td class="default">
                 
-                    new FluidSpecular()
+                    new FluidReflection()
                 
                 </td>
             
@@ -480,20 +512,20 @@
                         
                     
                 
-                <p>流体模拟的高光效果对象</p></td>
+                <p>流体反射效果对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>fluidFoam</code></td>
+                <td class="name"><code>underfluidCaustic</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type"><a href="FluidFoam.html">FluidFoam</a></span>
+<span class="param-type"><a href="UnderfluidCaustic.html">UnderfluidCaustic</a></span>
 
 
             
@@ -502,7 +534,79 @@
             
                 <td class="default">
                 
-                    new FluidFoam()
+                    new UnderfluidCaustic()
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>流体水下焦散后处理特效对象。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>underfluidDistortion</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type"><a href="UnderfluidDistortion.html">UnderfluidDistortion</a></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    new UnderfluidDistortion()
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>流体水下扭曲后处理特效对象。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>underfluidFog</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type"><a href="UnderfluidFog.html">UnderfluidFog</a></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    new UnderfluidFog()
                 
                 </td>
             
@@ -516,20 +620,20 @@
                         
                     
                 
-                <p>流体模拟的白浪效果对象</p></td>
+                <p>流体水下雾后处理特效对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>underwater</code></td>
+                <td class="name"><code>underfluidGodRay</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type"><a href="Underwater.html">Underwater</a></span>
+<span class="param-type"><a href="UnderfluidGodRay.html">UnderfluidGodRay</a></span>
 
 
             
@@ -538,7 +642,7 @@
             
                 <td class="default">
                 
-                    new Underwater()
+                    new UnderfluidGodRay()
                 
                 </td>
             
@@ -552,20 +656,20 @@
                         
                     
                 
-                <p>流体模拟的水下效果对象</p></td>
+                <p>流体水下体积光后处理特效对象。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>show</code></td>
+                <td class="name"><code>fluidSurfaceDistortion</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type">Boolean</span>
+<span class="param-type"><a href="FluidSurfaceDistortion.html">FluidSurfaceDistortion</a></span>
 
 
             
@@ -574,7 +678,77 @@
             
                 <td class="default">
                 
-                    true
+                    new FluidSurfaceDistortion()
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>流体表面扭曲后处理特效对象。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>fluidSurfaceFoam</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type"><a href="FluidSurfaceFoam.html">FluidSurfaceFoam</a></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    new FluidSurfaceFoam()
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>流体表面泡沫后处理特效对象。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>speed</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
                 
                 </td>
             
@@ -588,7 +762,7 @@
                         
                     
                 
-                <p>是否显示流体模拟</p></td>
+                <p>流体流动速度；未提供时按当前采样精度自动计算。</p></td>
         </tr>
 	
 	
@@ -659,7 +833,7 @@
                         
                     
             </td>
-            <td class="description last">返回根据参数实例化的流体模拟对象</td>
+            <td class="description last">返回流体模拟对象实例。</td>
         </tr>
     
     </tbody>
@@ -681,7 +855,7 @@
     
 
     
-    <pre class="prettyprint"><code>// ES5引入方式
  show: true,
  samplePrecision: 10,
+    <pre class="prettyprint"><code>// ES5引入方式
  viewer,
  rectangle: Cesium.Rectangle.fromDegrees(113, 29, 114, 30),
  samplePrecision: 10,
  speed: 15
     
 
     
@@ -715,7 +889,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟渲染的色表（使用方法详见上方示例）</p>
+        <p>获取或设置流体模拟渲染的色表。</p>
     </div>
     
     
@@ -760,7 +934,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟的粒子对象</p>
+        <p>获取或设置流体模拟的粒子效果对象。</p>
     </div>
     
     
@@ -805,7 +979,97 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟的源集合对象</p>
+        <p>获取或设置流体模拟的流体源集合对象。</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="fluidSurfaceDistortion">fluidSurfaceDistortion<span class="type-signature type fluidsurfacedistortion"><a href="FluidSurfaceDistortion.html">FluidSurfaceDistortion</a></span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>获取或设置流体表面扭曲后处理特效对象。</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="fluidSurfaceFoam">fluidSurfaceFoam<span class="type-signature type fluidsurfacefoam"><a href="FluidSurfaceFoam.html">FluidSurfaceFoam</a></span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>获取或设置流体表面泡沫后处理特效对象。</p>
     </div>
     
     
@@ -850,7 +1114,7 @@
 <dd>
     
     <div class="description">
-        <p>白浪特效对象</p>
+        <p>获取或设置白浪特效对象。</p>
     </div>
     
     
@@ -895,7 +1159,7 @@
 <dd>
     
     <div class="description">
-        <p>不参与流体模拟的对象</p>
+        <p>获取或设置不参与流体模拟的对象集合。</p>
     </div>
     
     
@@ -940,7 +1204,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟对象是否创建准备就绪</p>
+        <p>获取流体模拟对象是否已准备就绪。</p>
     </div>
     
     
@@ -985,7 +1249,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟对象是否创建准备就绪的回调方法</p>
+        <p>获取流体模拟对象准备就绪后的 Promise。</p>
     </div>
     
     
@@ -1030,7 +1294,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟的范围</p>
+        <p>获取流体模拟的范围。</p>
     </div>
     
     
@@ -1075,7 +1339,7 @@
 <dd>
     
     <div class="description">
-        <p>流体反射特效对象</p>
+        <p>获取或设置流体反射特效对象。</p>
     </div>
     
     
@@ -1120,7 +1384,7 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟的采样精度</p>
+        <p>获取流体模拟的采样精度。</p>
     </div>
     
     
@@ -1165,7 +1429,7 @@
 <dd>
     
     <div class="description">
-        <p>阴影特效对象</p>
+        <p>获取或设置阴影特效对象。</p>
     </div>
     
     
@@ -1210,7 +1474,7 @@
 <dd>
     
     <div class="description">
-        <p>是否显示流体模拟结果</p>
+        <p>获取或设置是否显示流体模拟结果。</p>
     </div>
     
     
@@ -1255,7 +1519,7 @@
 <dd>
     
     <div class="description">
-        <p>高光特效对象</p>
+        <p>获取或设置高光特效对象。</p>
     </div>
     
     
@@ -1300,7 +1564,142 @@
 <dd>
     
     <div class="description">
-        <p>流体模拟流动速度</p>
+        <p>获取或设置流体模拟流动速度。</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="underfluidCaustic">underfluidCaustic<span class="type-signature type underfluidcaustic"><a href="UnderfluidCaustic.html">UnderfluidCaustic</a></span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>获取或设置流体水下焦散后处理特效对象。</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="underfluidDistortion">underfluidDistortion<span class="type-signature type underfluiddistortion"><a href="UnderfluidDistortion.html">UnderfluidDistortion</a></span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>获取或设置流体水下扭曲后处理特效对象。</p>
+    </div>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="underfluidFog">underfluidFog<span class="type-signature type underfluidfog"><a href="UnderfluidFog.html">UnderfluidFog</a></span> </h4>
+    </div>
+    
+    
+</dt>
+<dd>
+    
+    <div class="description">
+        <p>获取或设置流体水下雾后处理特效对象。</p>
     </div>
     
     
@@ -1337,7 +1736,7 @@
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="underwater">underwater<span class="type-signature type underwater"><a href="Underwater.html">Underwater</a></span> </h4>
+        <h4 class="name" id="underfluidGodRay">underfluidGodRay<span class="type-signature type underfluidgodray"><a href="UnderfluidGodRay.html">UnderfluidGodRay</a></span> </h4>
     </div>
     
     
@@ -1345,7 +1744,7 @@
 <dd>
     
     <div class="description">
-        <p>水下特效对象</p>
+        <p>获取或设置流体水下体积光后处理特效对象。</p>
     </div>
     
     
@@ -1397,7 +1796,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1562
+            engineExtensions/simulation/fluid/Fluid.js, line 1620
         </div>
         
     </div>
@@ -1408,7 +1807,7 @@
     
     
     <div class="description">
-        <p>添加刚体到流体模拟中</p>
+        <p>添加刚体对象到流体模拟中。</p>
     </div>
     
 
@@ -1455,7 +1854,7 @@
             
             <td class="description last">
                 
-                <p>添加流体模拟刚体的参数</p>
+                <p>添加流体模拟刚体的参数。</p>
                 
 
 <table class="params">
@@ -1501,7 +1900,7 @@
                         
                     
                 
-                <p>需要添加到流体模拟的刚体对象数组</p></td>
+                <p>需要添加到流体模拟的刚体对象数组。</p></td>
         </tr>
 	
 	
@@ -1531,7 +1930,7 @@
                         
                     
                 
-                <p>添加刚体成功后的回调</p></td>
+                <p>同步完成后的回调函数。</p></td>
         </tr>
 	
 	
@@ -1603,7 +2002,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1629
+            engineExtensions/simulation/fluid/Fluid.js, line 1687
         </div>
         
     </div>
@@ -1614,7 +2013,7 @@
     
     
     <div class="description">
-        <p>销毁流体模拟对象</p>
+        <p>销毁流体模拟对象及其关联资源。</p>
     </div>
     
 
@@ -1682,7 +2081,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1618
+            engineExtensions/simulation/fluid/Fluid.js, line 1676
         </div>
         
     </div>
@@ -1693,7 +2092,7 @@
     
     
     <div class="description">
-        <p>暂停流体模拟</p>
+        <p>暂停流体模拟。</p>
     </div>
     
 
@@ -1761,7 +2160,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1588
+            engineExtensions/simulation/fluid/Fluid.js, line 1646
         </div>
         
     </div>
@@ -1772,7 +2171,7 @@
     
     
     <div class="description">
-        <p>从流体模拟中移除刚体</p>
+        <p>从流体模拟中移除刚体对象。</p>
     </div>
     
 
@@ -1819,7 +2218,7 @@
             
             <td class="description last">
                 
-                <p>移除流体模拟刚体的参数</p>
+                <p>移除流体模拟刚体的参数。</p>
                 
 
 <table class="params">
@@ -1865,7 +2264,7 @@
                         
                     
                 
-                <p>需要从流体模拟中删除的刚体对象数组</p></td>
+                <p>需要从流体模拟中删除的刚体对象数组。</p></td>
         </tr>
 	
 	
@@ -1895,7 +2294,7 @@
                         
                     
                 
-                <p>移除刚体成功后的回调</p></td>
+                <p>同步完成后的回调函数。</p></td>
         </tr>
 	
 	
@@ -1967,7 +2366,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1608
+            engineExtensions/simulation/fluid/Fluid.js, line 1666
         </div>
         
     </div>
@@ -1978,7 +2377,7 @@
     
     
     <div class="description">
-        <p>开始流体模拟</p>
+        <p>恢复流体模拟运行。</p>
     </div>
     
 
@@ -2046,7 +2445,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/simulation/fluid/Fluid.js, line 1508
+            engineExtensions/simulation/fluid/Fluid.js, line 1566
         </div>
         
     </div>
@@ -2057,7 +2456,7 @@
     
     
     <div class="description">
-        <p>触发更新高度图的接口，当场景有变化需要做同步时需要调用</p>
+        <p>触发高度图同步更新。</p>
     </div>
     
 
@@ -2104,7 +2503,7 @@
             
             <td class="description last">
                 
-                <p>更新流体模拟的参数</p>
+                <p>更新流体模拟的参数。</p>
                 
 
 <table class="params">
@@ -2150,7 +2549,7 @@
                         
                     
                 
-                <p>添加流体模拟成功后的回调</p></td>
+                <p>同步完成后的回调函数。</p></td>
         </tr>
 	
 	
@@ -2217,7 +2616,7 @@
 
 
         <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>