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

@mapgis/webclient-cesium-plugin 17.8.0 → 17.10.9

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

Files changed (227) hide show

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

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="FluidFoam">
-            new FluidFoam<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new FluidFoam<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>
@@ -236,7 +243,7 @@
-                <p>白浪的密度，值越大则单位面积内的白浪数量越多，反之亦然</p></td>
+                <p>白浪密度；值越大单位面积内的白浪数量越多。</p></td>
         </tr>
@@ -272,7 +279,7 @@
-                <p>白浪的大小，值越大则浪花越大，反之亦然</p></td>
+                <p>白浪大小；值越大浪花越大。</p></td>
         </tr>
@@ -308,7 +315,7 @@
-                <p>白浪的强度，值越大则白浪的覆盖面积越大，反之亦然</p></td>
+                <p>白浪强度；值越大白浪覆盖面积越大。</p></td>
         </tr>
@@ -344,7 +351,7 @@
-                <p>浪花的颜色</p></td>
+                <p>浪花颜色。</p></td>
         </tr>
@@ -415,7 +422,7 @@
             </td>
-            <td class="description last">返回根据参数实例化的流体白浪对象</td>
+            <td class="description last">返回流体白浪效果配置对象实例。</td>
         </tr>
     </tbody>
@@ -430,7 +437,20 @@
-    <pre class="prettyprint"><code>// ES5引入方式
  show: false,
  density: 5,
  size: 3,
  intensity: 2,
  color: Cesium.Color.YELLOW
+    <pre class="prettyprint"><code>// ES5引入方式
+const { FluidFoam } = zondy.cesium
+// ES6引入方式
+import { FluidFoam } from "@mapgis/webclient-cesium-plugin"
+// 创建流体白浪对象
+const fluidFoam = new FluidFoam({
+  show: false,
+  density: 5,
+  size: 3,
+  intensity: 2,
+  color: Cesium.Color.YELLOW
+})</code></pre>
@@ -464,7 +484,7 @@
 <dd>
     <div class="description">
-        <p>白浪的颜色</p>
+        <p>获取或设置白浪颜色。</p>
     </div>
@@ -509,7 +529,7 @@
 <dd>
     <div class="description">
-        <p>白浪的密度</p>
+        <p>获取或设置白浪密度。</p>
     </div>
@@ -554,7 +574,7 @@
 <dd>
     <div class="description">
-        <p>白浪的强度</p>
+        <p>获取或设置白浪强度。</p>
     </div>
@@ -599,7 +619,7 @@
 <dd>
     <div class="description">
-        <p>白浪的显隐</p>
+        <p>获取或设置白浪效果的显隐状态。</p>
     </div>
@@ -644,7 +664,7 @@
 <dd>
     <div class="description">
-        <p>白浪的大小</p>
+        <p>获取或设置白浪大小。</p>
     </div>
@@ -695,7 +715,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>

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

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="FluidReflection">
-            new FluidReflection<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new FluidReflection<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">
@@ -169,6 +176,40 @@
 	<tbody>
+        <tr>
+                <td class="name"><code>fluid</code></td>
+            <td class="type">
+<span class="param-type"><a href="Fluid.html">Fluid</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>关联的流体模拟对象；初始化时会由 <code>Fluid</code> 自动注入。</p></td>
+        </tr>
         <tr>
                 <td class="name"><code>show</code></td>
@@ -186,7 +227,7 @@
                 <td class="default">
-                    true
+                    false
                 </td>
@@ -200,7 +241,7 @@
-                <p>是否显示流体反射</p></td>
+                <p>是否显示流体反射。</p></td>
         </tr>
@@ -236,7 +277,7 @@
-                <p>反射的透明度，取值在0到1之间，其中0为完全透明，1为完全不透明</p></td>
+                <p>反射透明度；取值范围为 <code>[0, 1]</code>。</p></td>
         </tr>
@@ -272,7 +313,7 @@
-                <p>反射可见的最大距离，大于最大距离的反射内容将不会显示</p></td>
+                <p>反射的最大可见距离。</p></td>
         </tr>
@@ -308,7 +349,7 @@
-                <p>反射的厚度</p></td>
+                <p>反射厚度容差。</p></td>
         </tr>
@@ -379,7 +420,7 @@
             </td>
-            <td class="description last">返回根据参数实例化的流体反射对象</td>
+            <td class="description last">返回流体反射效果对象实例。</td>
         </tr>
     </tbody>
@@ -394,7 +435,19 @@
-    <pre class="prettyprint"><code>// ES5引入方式
  show: false,
  opacity: 1,
  maxDistance: 10000,
  thickness: 2,
+    <pre class="prettyprint"><code>// ES5引入方式
+const { FluidReflection } = zondy.cesium
+// ES6引入方式
+import { FluidReflection } from "@mapgis/webclient-cesium-plugin"
+// 创建流体反射对象
+const fluidReflection = new FluidReflection({
+  show: false,
+  opacity: 1,
+  maxDistance: 10000,
+  thickness: 2,
+})</code></pre>
@@ -428,7 +481,7 @@
 <dd>
     <div class="description">
-        <p>反射的最大可见距离</p>
+        <p>获取或设置流体反射的最大可见距离。</p>
     </div>
@@ -473,7 +526,7 @@
 <dd>
     <div class="description">
-        <p>反射的透明度</p>
+        <p>获取或设置流体反射透明度。</p>
     </div>
@@ -518,7 +571,7 @@
 <dd>
     <div class="description">
-        <p>反射的显隐</p>
+        <p>获取或设置流体反射效果的显隐状态。</p>
     </div>
@@ -563,7 +616,7 @@
 <dd>
     <div class="description">
-        <p>反射的厚度</p>
+        <p>获取或设置流体反射厚度容差。</p>
     </div>
@@ -614,7 +667,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>

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

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="FluidShadow">
-            new FluidShadow<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new FluidShadow<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">
@@ -169,6 +176,40 @@
 	<tbody>
+        <tr>
+                <td class="name"><code>fluid</code></td>
+            <td class="type">
+<span class="param-type"><a href="Fluid.html">Fluid</a></span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">
+                        <span class="optional"> 可选</span>
+                <p>关联的流体模拟对象；初始化时会由 <code>Fluid</code> 自动注入。</p></td>
+        </tr>
         <tr>
                 <td class="name"><code>softShadows</code></td>
@@ -200,7 +241,7 @@
-                <p>是否开启软阴影，开启后则会缓解阴影边缘锯齿问题，该功能的性能损耗较大</p></td>
+                <p>是否开启软阴影；开启后可缓解阴影边缘锯齿，但性能开销较大。</p></td>
         </tr>
@@ -236,7 +277,7 @@
-                <p>阴影的明暗程度，取值在0到1之间，其中0为完全暗淡，1为完全黑暗</p></td>
+                <p>阴影明暗程度；取值范围为 <code>[0, 1]</code>。</p></td>
         </tr>
@@ -272,7 +313,7 @@
-                <p>阴影可见的最大距离，小于最大距离的阴影内容将不会显示</p></td>
+                <p>阴影的最大可见距离。</p></td>
         </tr>
@@ -308,7 +349,7 @@
-                <p>阴影贴图的大小，值越大则阴影的质量越高，但性能损耗也越大</p></td>
+                <p>阴影贴图尺寸；值越大阴影质量越高，但性能开销也越大。</p></td>
         </tr>
@@ -379,7 +420,7 @@
             </td>
-            <td class="description last">返回根据参数实例化的流体阴影对象</td>
+            <td class="description last">返回流体阴影效果配置对象实例。</td>
         </tr>
     </tbody>
@@ -394,7 +435,19 @@
-    <pre class="prettyprint"><code>// ES5引入方式
  softShadows: true,
  darkness: 0.3,
  maximumDistance: 10000,
  size: 2048,
+    <pre class="prettyprint"><code>// ES5引入方式
+const { FluidShadow } = zondy.cesium
+// ES6引入方式
+import { FluidShadow } from "@mapgis/webclient-cesium-plugin"
+// 创建流体阴影对象
+const fluidShadow = new FluidShadow({
+  softShadows: true,
+  darkness: 0.3,
+  maximumDistance: 10000,
+  size: 2048,
+})</code></pre>
@@ -428,7 +481,7 @@
 <dd>
     <div class="description">
-        <p>阴影的明暗程度</p>
+        <p>获取或设置阴影的明暗程度。</p>
     </div>
@@ -473,7 +526,7 @@
 <dd>
     <div class="description">
-        <p>阴影贴图的最大距离，较大的阴影距离可能会导致较低的阴影质量</p>
+        <p>获取或设置阴影贴图的最大可见距离。</p>
     </div>
@@ -518,7 +571,7 @@
 <dd>
     <div class="description">
-        <p>阴影贴图的长宽（以像素为单位）</p>
+        <p>获取或设置阴影贴图尺寸。</p>
     </div>
@@ -563,7 +616,7 @@
 <dd>
     <div class="description">
-        <p>是否开启软阴影（该功能对性能损失较大）</p>
+        <p>获取或设置是否开启软阴影。</p>
     </div>
@@ -614,7 +667,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>

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

@@ -302,7 +302,7 @@
         <div class="tag-source">
-            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 45
+            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 44
         </div>
     </div>
@@ -445,7 +445,14 @@
-    <pre class="prettyprint"><code>// 以添加一个点流体源为例，首先实例化一个点流体源对象
  position: Cesium.Cartesian3.fromDegrees(113, 30),
  radius: 50,
  flow: 20,
+    <pre class="prettyprint"><code>// 以添加一个点流体源为例，首先实例化一个点流体源对象
+const pointFluidSource = new PointFluidSource({
+  position: Cesium.Cartesian3.fromDegrees(113, 30),
+  radius: 50,
+  flow: 20,
+})
+// 将点流体源添加到流体模拟对象的流体源集合中
+fluid.fluidSources.add(pointFluidSource)</code></pre>
@@ -462,7 +469,7 @@
         <div class="tag-source">
-            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 102
+            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 101
         </div>
     </div>
@@ -610,7 +617,7 @@
         <div class="tag-source">
-            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 89
+            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 88
         </div>
     </div>
@@ -758,7 +765,7 @@
         <div class="tag-source">
-            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 58
+            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 57
         </div>
     </div>
@@ -906,7 +913,7 @@
         <div class="tag-source">
-            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 73
+            engineExtensions/simulation/fluid/FluidSourceCollection.js, line 72
         </div>
     </div>
@@ -980,7 +987,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>