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/Underwater.html → documentation/WaterSurfaceDistortion.html} RENAMED Viewed

@@ -58,7 +58,7 @@
     <div class="navigationDiv">
     </div>
     <div class="main content-wrapper examples-container">
-        <h1 class="page-title" data-filename="Underwater.html">Class: Underwater</h1>
+        <h1 class="page-title" data-filename="WaterSurfaceDistortion.html">Class: WaterSurfaceDistortion</h1>
@@ -66,7 +66,7 @@
 <section>
 <header>
-    <h2></span>Underwater
+    <h2></span>WaterSurfaceDistortion
     </h2>
@@ -81,14 +81,14 @@
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="Underwater">
+        <h4 class="name" id="WaterSurfaceDistortion">
-            new Underwater<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new WaterSurfaceDistortion<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>
         <div class="tag-source">
-            engineExtensions/effects/Underwater.js, line 1
+            engineExtensions/effects/waterSurface/WaterSurfaceDistortion.js, line 3
         </div>
     </div>
@@ -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">
@@ -171,13 +178,13 @@
         <tr>
-                <td class="name"><code>show</code></td>
+                <td class="name"><code>viewer</code></td>
             <td class="type">
-<span class="param-type">Boolean</span>
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
@@ -186,8 +193,6 @@
                 <td class="default">
-                    true
                 </td>
@@ -200,20 +205,20 @@
-                <p>是否显示流体水下特效</p></td>
+                <p>场景视图对象；若未提供，将在初始化时从 <code>targetObject</code> 获取。</p></td>
         </tr>
         <tr>
-                <td class="name"><code>color</code></td>
+                <td class="name"><code>targetObject</code></td>
             <td class="type">
-<span class="param-type">Cesium.Color</span>
+<span class="param-type">Object</span>
@@ -222,8 +227,6 @@
                 <td class="default">
-                    Cesium.Color.Blue
                 </td>
@@ -236,20 +239,20 @@
-                <p>水下的模糊颜色</p></td>
+                <p>目标对象，通常为 <code>WaterSurface</code> 实例。</p></td>
         </tr>
         <tr>
-                <td class="name"><code>nearFarScalar</code></td>
+                <td class="name"><code>show</code></td>
             <td class="type">
-<span class="param-type">Cesium.NearFarScalar</span>
+<span class="param-type">Boolean</span>
@@ -258,7 +261,7 @@
                 <td class="default">
-                    new Cesium.Cartesian4(0,0,1000,1)
+                    true
                 </td>
@@ -272,20 +275,20 @@
-                <p>水下的远近距离对应模糊效果的透明度，会和模糊颜色的透明度叠加，Cesium.Cartesian4的四个分量表示:(近段距离，近段透明度，远端距离，远端透明度)默认参数为透明度0到1会在距离为0到1000之间插值</p></td>
+                <p>是否启用水面扭曲效果。</p></td>
         </tr>
         <tr>
-                <td class="name"><code>causticsColor</code></td>
+                <td class="name"><code>distortionStrength</code></td>
             <td class="type">
-<span class="param-type">Cesium.Color</span>
+<span class="param-type">Number</span>
@@ -294,7 +297,7 @@
                 <td class="default">
-                    Cesium.Color.WHITE
+                    0.5
                 </td>
@@ -308,20 +311,20 @@
-                <p>焦散效果的颜色</p></td>
+                <p>扭曲强度。</p></td>
         </tr>
         <tr>
-                <td class="name"><code>causticsScale</code></td>
+                <td class="name"><code>enableShallowWaterDistortion</code></td>
             <td class="type">
-<span class="param-type">Number</span>
+<span class="param-type">Boolean</span>
@@ -330,7 +333,7 @@
                 <td class="default">
-                    0.5
+                    true
                 </td>
@@ -344,7 +347,7 @@
-                <p>焦散效果的大小，取值范围为[0,1]</p></td>
+                <p>是否启用浅水区域扰动效果。</p></td>
         </tr>
@@ -415,7 +418,7 @@
             </td>
-            <td class="description last">返回根据参数实例化的流体水下特效对象</td>
+            <td class="description last">返回水面扭曲后处理特效实例。</td>
         </tr>
     </tbody>
@@ -426,11 +429,21 @@
         <h5>Example</h5>
-        <p class="code-caption"><h7>创建流体水下特效对象</h7></p>
+        <p class="code-caption"><h7>创建水面扭曲对象</h7></p>
-    <pre class="prettyprint"><code>// ES5引入方式
  nearFarScalar: new Cesium.NearFarScalar(0,0,100,1),
+    <pre class="prettyprint"><code>// ES5引入方式
+const { WaterSurfaceDistortion } = zondy.cesium
+// ES6引入方式
+import { WaterSurfaceDistortion } from "@mapgis/webclient-cesium-plugin"
+const distortion = new WaterSurfaceDistortion({
+  viewer,
+  targetObject: waterSurface,
+  distortionStrength: 0.8
+})</code></pre>
@@ -456,7 +469,7 @@
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="causticsColor">causticsColor<span class="type-signature type cesium.color">Cesium.Color</span> </h4>
+        <h4 class="name" id="distortionStrength">distortionStrength<span class="type-signature type number">Number</span> </h4>
     </div>
@@ -464,7 +477,7 @@
 <dd>
     <div class="description">
-        <p>水下特效的焦散颜色</p>
+        <p>获取或设置水面扭曲强度。</p>
     </div>
@@ -501,7 +514,7 @@
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="causticsScale">causticsScale<span class="type-signature type number">Number</span> </h4>
+        <h4 class="name" id="enableShallowWaterDistortion">enableShallowWaterDistortion<span class="type-signature type boolean">Boolean</span> </h4>
     </div>
@@ -509,7 +522,7 @@
 <dd>
     <div class="description">
-        <p>水下特效的焦散大小</p>
+        <p>获取或设置是否启用浅水扰动效果。</p>
     </div>
@@ -546,7 +559,7 @@
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="color">color<span class="type-signature type cesium.color">Cesium.Color</span> </h4>
+        <h4 class="name" id="show">show<span class="type-signature type boolean">Boolean</span> </h4>
     </div>
@@ -554,7 +567,7 @@
 <dd>
     <div class="description">
-        <p>水下特效的颜色</p>
+        <p>获取或设置水面扭曲效果的显隐状态。</p>
     </div>
@@ -587,29 +600,39 @@
 </dd>
+        </dl>
+        <h3 class="subsection-title">Methods</h3>
+        <dl>
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="nearFarScalar">nearFarScalar<span class="type-signature type cesium.nearfarscalar">Cesium.NearFarScalar</span> </h4>
-    </div>
+        <h4 class="name" id="destroy">
+            destroy<span class="signature">()</span>
+        </h4>
+        <div class="tag-source">
+            engineExtensions/effects/waterSurface/WaterSurfaceDistortion.js, line 95
+        </div>
+    </div>
 </dt>
 <dd>
     <div class="description">
-        <p>水下特效的远近距离对应模糊效果的透明度</p>
+        <p>销毁水面扭曲特效实例。</p>
     </div>
-<dl class="details">
@@ -618,44 +641,21 @@
+<dl class="details">
-</dl>
-</dd>
-<dt>
-    <div class="nameContainer">
-        <h4 class="name" id="show">show<span class="type-signature type boolean">Boolean</span> </h4>
-    </div>
-</dt>
-<dd>
-    <div class="description">
-        <p>水下特效的显隐</p>
-    </div>
-<dl class="details">
@@ -663,26 +663,24 @@
+</dl>
-</dl>
 </dd>
         </dl>
@@ -695,7 +693,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:56:00 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>