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

@mapgis/webclient-cesium-plugin 17.8.1 → 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}/PostProcessStageLibrary.html RENAMED Viewed

@@ -88,7 +88,7 @@
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 13
+            engineExtensions/effects/PostProcessStageLibrary.js, line 25
         </div>
     </div>
@@ -148,12 +148,19 @@
         <h5>Example</h5>
+        <p class="code-caption"><h7>使用后处理阶段扩展库</h7></p>
     <pre class="prettyprint"><code>// ES5引入方式
-const { PostProcessStageLibrary } = zondy
+const { PostProcessStageLibrary } = zondy.cesium
 // ES6引入方式
-import { PostProcessStageLibrary } from "@mapgis/webclient-cesium-plugin"</code></pre>
+import { PostProcessStageLibrary } from "@mapgis/webclient-cesium-plugin"
+const snowStage = viewer.scene.postProcessStages.add(
+  PostProcessStageLibrary.createSnowStage({ viewer })
+)</code></pre>
@@ -190,7 +197,7 @@ import { PostProcessStageLibrary } from "@mapgis/webclient-cesium-plugin"</code>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 497
+            engineExtensions/effects/PostProcessStageLibrary.js, line 499
         </div>
     </div>
@@ -549,7 +556,7 @@ atmosphereFog.uniforms.lightDensity = 0.4 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 545
+            engineExtensions/effects/PostProcessStageLibrary.js, line 541
         </div>
     </div>
@@ -836,7 +843,7 @@ customAtmosphere.uniforms.height = 0.5 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 357
+            engineExtensions/effects/PostProcessStageLibrary.js, line 353
         </div>
     </div>
@@ -1268,7 +1275,7 @@ dof.uniforms.backFocalDistance = 400 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 138
+            engineExtensions/effects/PostProcessStageLibrary.js, line 155
         </div>
     </div>
@@ -1592,7 +1599,7 @@ fog.uniforms.alpha = 0.7 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 262
+            engineExtensions/effects/PostProcessStageLibrary.js, line 270
         </div>
     </div>
@@ -1917,7 +1924,7 @@ godRay.uniforms.sampleCount = 400 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 217
+            engineExtensions/effects/PostProcessStageLibrary.js, line 228
         </div>
     </div>
@@ -2242,7 +2249,7 @@ heightFog.uniforms.height = 700 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 455
+            engineExtensions/effects/PostProcessStageLibrary.js, line 443
         </div>
     </div>
@@ -2462,6 +2469,42 @@ heightFog.uniforms.height = 700 // 修改相关参数</code></pre>
         </tr>
+        <tr>
+                <td class="name"><code>maxVisibleHeight</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="default">
+                    Infinity
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>镜头光斑的最大可视高度，当相机高度超过此值时不显示光斑效果</p></td>
+        </tr>
 	</tbody>
 </table>
             </td>
@@ -2566,7 +2609,7 @@ lensFlare.uniforms.intensity = 2 // 修改相关参数</code></pre>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 94
+            engineExtensions/effects/PostProcessStageLibrary.js, line 111
         </div>
     </div>
@@ -2993,14 +3036,14 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".createSnowpackStage">
+        <h4 class="name" id=".createSnowStage">
-            PostProcessStageLibrary.createSnowpackStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+            PostProcessStageLibrary.createSnowStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
         </h4>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 181
+            engineExtensions/effects/PostProcessStageLibrary.js, line 67
         </div>
     </div>
@@ -3011,7 +3054,7 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
     <div class="description">
-        <p>创建积雪后处理特效对象</p>
+        <p>创建降雪后处理特效对象</p>
     </div>
@@ -3115,7 +3158,7 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
         <tr>
-                <td class="name"><code>density</code></td>
+                <td class="name"><code>size</code></td>
             <td class="type">
@@ -3130,7 +3173,7 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
                 <td class="default">
-                    0.15
+                    5
                 </td>
@@ -3144,14 +3187,14 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
-                <p>积雪的厚度程度</p></td>
+                <p>雪花的大小</p></td>
         </tr>
         <tr>
-                <td class="name"><code>alpha</code></td>
+                <td class="name"><code>scale</code></td>
             <td class="type">
@@ -3166,7 +3209,7 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
                 <td class="default">
-                    1.0
+                    5
                 </td>
@@ -3180,7 +3223,79 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
-                <p>积雪的透明度</p></td>
+                <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">
+                    5
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>雪花下降的速度</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>showIceFog</code></td>
+            <td class="type">
+<span class="param-type">Number</span>
+            </td>
+                <td class="default">
+                    true
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>是否开启场景冰雾效果（该效果表达的是一种悬浮在空气中的大量微小冰晶组成的雾，可以使降雪场景更加逼真）</p></td>
         </tr>
@@ -3251,7 +3366,7 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
             </td>
-            <td class="description last">积雪后处理特效对象</td>
+            <td class="description last">降雪后处理特效对象</td>
         </tr>
     </tbody>
@@ -3262,17 +3377,20 @@ rain.uniforms.speed = 20 // 修改相关参数</code></pre>
         <h5>Example</h5>
-        <p class="code-caption"><h7 id='createSnowpackStage'>创建积雪后处理特效对象</h7></p>
+        <p class="code-caption"><h7 id='createSnowStage'>创建降雪后处理特效对象</h7></p>
-    <pre class="prettyprint"><code>const snowpack = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createSnowpackStage({
+    <pre class="prettyprint"><code>const snow = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createSnowStage({
   viewer,
-  density: 0.7,
-  alpha: 1.0,
+  size: 5,
+  scale: 5,
+  speed: 5
 }))
-snowpack.enabled = false // 关闭后处理特效
-snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
+snow.enabled = false // 关闭后处理特效
+snow.uniforms.size = 10 // 修改相关参数
+snow.uniforms.scale = 3 // 修改相关参数
+snow.uniforms.speed = 3 // 修改相关参数</code></pre>
@@ -3282,14 +3400,14 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".createSnowStage">
+        <h4 class="name" id=".createSnowpackStage">
-            PostProcessStageLibrary.createSnowStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+            PostProcessStageLibrary.createSnowpackStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
         </h4>
         <div class="tag-source">
-            engineExtensions/effects/PostProcessStageLibrary.js, line 50
+            engineExtensions/effects/PostProcessStageLibrary.js, line 192
         </div>
     </div>
@@ -3300,7 +3418,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
     <div class="description">
-        <p>创建降雪后处理特效对象</p>
+        <p>创建积雪后处理特效对象</p>
     </div>
@@ -3404,79 +3522,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
         <tr>
-                <td class="name"><code>size</code></td>
-            <td class="type">
-<span class="param-type">Number</span>
-            </td>
-                <td class="default">
-                    5
-                </td>
-            <td class="description last">
-                        <span class="optional"> 可选</span>
-                <p>雪花的大小</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>scale</code></td>
-            <td class="type">
-<span class="param-type">Number</span>
-            </td>
-                <td class="default">
-                    5
-                </td>
-            <td class="description last">
-                        <span class="optional"> 可选</span>
-                <p>降雪场景的缩放系数</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>speed</code></td>
+                <td class="name"><code>density</code></td>
             <td class="type">
@@ -3491,7 +3537,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
                 <td class="default">
-                    5
+                    0.15
                 </td>
@@ -3505,14 +3551,14 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
-                <p>雪花下降的速度</p></td>
+                <p>积雪的厚度程度</p></td>
         </tr>
         <tr>
-                <td class="name"><code>showIceFog</code></td>
+                <td class="name"><code>alpha</code></td>
             <td class="type">
@@ -3527,7 +3573,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
                 <td class="default">
-                    true
+                    1.0
                 </td>
@@ -3541,7 +3587,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
-                <p>是否开启场景冰雾效果（该效果表达的是一种悬浮在空气中的大量微小冰晶组成的雾，可以使降雪场景更加逼真）</p></td>
+                <p>积雪的透明度</p></td>
         </tr>
@@ -3612,7 +3658,7 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
             </td>
-            <td class="description last">降雪后处理特效对象</td>
+            <td class="description last">积雪后处理特效对象</td>
         </tr>
     </tbody>
@@ -3623,20 +3669,2980 @@ snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
         <h5>Example</h5>
-        <p class="code-caption"><h7 id='createSnowStage'>创建降雪后处理特效对象</h7></p>
+        <p class="code-caption"><h7 id='createSnowpackStage'>创建积雪后处理特效对象</h7></p>
-    <pre class="prettyprint"><code>const snow = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createSnowStage({
+    <pre class="prettyprint"><code>const snowpack = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createSnowpackStage({
   viewer,
-  size: 5,
-  scale: 5,
-  speed: 5
+  density: 0.7,
+  alpha: 1.0,
 }))
-snow.enabled = false // 关闭后处理特效
-snow.uniforms.size = 10 // 修改相关参数
-snow.uniforms.scale = 3 // 修改相关参数
-snow.uniforms.speed = 3 // 修改相关参数</code></pre>
+snowpack.enabled = false // 关闭后处理特效
+snowpack.uniforms.density = 0.5 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createUnderwaterCausticStage">
+            PostProcessStageLibrary.createUnderwaterCausticStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 639
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水下焦散后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>intensity</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    1.0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>焦散强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>scale</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.003
+                </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">
+                    0.15
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>焦散动画速度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>maxVisibleDistance</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    5000.0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>最大可视距离，超过此距离焦散效果将逐渐消失。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>normalTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面法线纹理。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水下焦散后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createUnderwaterCausticStage'>创建水下焦散后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const caustic = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createUnderwaterCausticStage({
+  viewer,
+  intensity: 1.0,
+  scale: 0.003
+}))
+caustic.enabled = false // 关闭后处理特效
+caustic.uniforms.intensity = 0.8 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createUnderwaterDistortionStage">
+            PostProcessStageLibrary.createUnderwaterDistortionStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 1106
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水下扭曲后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>distortionStrength</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.5
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>扭曲强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水下扭曲后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createUnderwaterDistortionStage'>创建水下扭曲后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const distortion = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createUnderwaterDistortionStage({
+  viewer,
+  distortionStrength: 0.5
+}))
+distortion.enabled = false // 关闭后处理特效
+distortion.uniforms.distortionStrength = 0.8 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createUnderwaterFogStage">
+            PostProcessStageLibrary.createUnderwaterFogStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 831
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水下雾后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>nearFogColor</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Color</span>
+            </td>
+                <td class="default">
+                    Cesium.Color.fromBytes(13, 115, 166)
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>近处雾颜色。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>farFogColor</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Color</span>
+            </td>
+                <td class="default">
+                    Cesium.Color.fromBytes(5, 30, 50)
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>远处雾颜色。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>maxFogDistance</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    1000.0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>最大雾化距离。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>intensity</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    1.5
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>雾强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>normalTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面法线纹理。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水下雾后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createUnderwaterFogStage'>创建水下雾后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const fog = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createUnderwaterFogStage({
+  viewer,
+  maxFogDistance: 1000.0,
+  intensity: 1.5
+}))
+fog.enabled = false // 关闭后处理特效
+fog.uniforms.intensity = 1.0 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createUnderwaterGodRayStage">
+            PostProcessStageLibrary.createUnderwaterGodRayStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 922
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水下体积光后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>intensity</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.3
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>体积光整体强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>density</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.5
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>光线密度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>decay</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.85
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>光线衰减。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>exposure</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.3
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>曝光强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水下体积光后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createUnderwaterGodRayStage'>创建水下体积光后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const godRay = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createUnderwaterGodRayStage({
+  viewer,
+  intensity: 0.3,
+  density: 0.5
+}))
+godRay.enabled = false // 关闭后处理特效
+godRay.uniforms.intensity = 0.5 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createWaterDepthStage">
+            PostProcessStageLibrary.createWaterDepthStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 1043
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水深显示后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>normalTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>水面法线纹理。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>depthColorTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>水深颜色查找纹理。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水深显示后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createWaterDepthStage'>创建水深显示后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const multipleColorTable = {
+  0: new Cesium.Color(1.0, 0.0, 0.0, 0.2),
+  50: new Cesium.Color(0.0, 1.0, 0.0, 0.45),
+  100: new Cesium.Color(0.0, 0.0, 1.0, 0.75),
+}
+const textureData = []
+const colorEntries = Object.entries(multipleColorTable)
+colorEntries.forEach(([depth, color]) => {
+  textureData.push(
+    Number(depth), 0.0, 0.0, 0.0,
+    color.red, color.green, color.blue, color.alpha
+  )
+})
+const depthColorTexture = new Cesium.Texture({
+  context: viewer.scene.context,
+  source: {
+    arrayBufferView: Float32Array.from(textureData),
+    width: colorEntries.length * 2,
+    height: 1,
+  },
+  pixelFormat: Cesium.PixelFormat.RGBA,
+  pixelDatatype: Cesium.PixelDatatype.FLOAT,
+  sampler: new Cesium.Sampler({
+    wrapS: Cesium.TextureWrap.CLAMP_TO_EDGE,
+    wrapT: Cesium.TextureWrap.CLAMP_TO_EDGE,
+    magnificationFilter: Cesium.TextureMagnificationFilter.NEAREST,
+    minificationFilter: Cesium.TextureMinificationFilter.NEAREST,
+  }),
+})
+const waterDepthStage = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createWaterDepthStage({
+  viewer,
+  enabled: true,
+  waterLevel: 1000.0,
+  normalTexture: waterSurface.normalFramebuffer._colorTextures[0],
+  depthColorTexture,
+}))
+waterDepthStage.enabled = false // 关闭后处理特效</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createWaterSurfaceDistortionStage">
+            PostProcessStageLibrary.createWaterSurfaceDistortionStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 1189
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水面扭曲后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>distortionStrength</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.5
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>扭曲强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>normalTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面法线纹理。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>enableShallowWaterDistortion</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>是否开启浅水扰动效果。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水面扭曲后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createWaterSurfaceDistortionStage'>创建水面扭曲后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const surfaceDistortion = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createWaterSurfaceDistortionStage({
+  viewer,
+  distortionStrength: 0.5
+}))
+surfaceDistortion.enabled = false // 关闭后处理特效
+surfaceDistortion.uniforms.distortionStrength = 0.8 // 修改相关参数</code></pre>
+</dd>
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".createWaterSurfaceFoamStage">
+            PostProcessStageLibrary.createWaterSurfaceFoamStage<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.PostProcessStage}</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/PostProcessStageLibrary.js, line 734
+        </div>
+    </div>
+</dt>
+<dd>
+    <div class="description">
+        <p>创建水面泡沫后处理阶段</p>
+    </div>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">
+                <p>附加参数</p>
+<table class="params">
+    <thead>
+	<tr>
+		<th>Name</th>
+		<th>Type</th>
+		<th>Default</th>
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	<tbody>
+        <tr>
+                <td class="name"><code>viewer</code></td>
+            <td class="type">
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                <p>场景视图对象</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>intensity</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.7
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>泡沫整体强度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterDepthThreshold</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    600.0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>参与泡沫计算的最大水深阈值。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>foamWaterDepthThreshold</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    100.0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>泡沫最明显区域的水深阈值。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>noiseScale</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.05
+                </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">
+                    2
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>泡沫流动速度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>contrast</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0.4
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>泡沫纹理对比度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>waterLevel</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="default">
+                    0
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面高度。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>normalTexture</code></td>
+            <td class="type">
+<span class="param-type">Cesium.Texture</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>水面法线纹理。</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>targetObject</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>目标对象（支持 Fluid 或 WaterSurface 类型，用于动态判断水下状态和获取水面高度）。</p></td>
+        </tr>
+	</tbody>
+</table>
+            </td>
+        </tr>
+	</tbody>
+</table>
+<dl class="details">
+</dl>
+    <h5>Returns:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td class="type">
+                        Cesium.PostProcessStage
+            </td>
+            <td class="description last">水面泡沫后处理阶段实例。</td>
+        </tr>
+    </tbody>
+</table>
+        <h5>Example</h5>
+        <p class="code-caption"><h7 id='createWaterSurfaceFoamStage'>创建水面泡沫后处理阶段</h7></p>
+    <pre class="prettyprint"><code>const foam = viewer.scene.postProcessStages.add(PostProcessStageLibrary.createWaterSurfaceFoamStage({
+  viewer,
+  intensity: 0.7,
+  waterDepthThreshold: 600.0
+}))
+foam.enabled = false // 关闭后处理特效
+foam.uniforms.intensity = 0.5 // 修改相关参数</code></pre>
@@ -3656,7 +6662,7 @@ snow.uniforms.speed = 3 // 修改相关参数</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:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>