@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/SSR.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="SSR">
             
-            new SSR<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            new SSR<span class="signature">(options)</span>
         </h4>
     
         
@@ -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 Viewer实例</p></td>
+                <p>Cesium 场景视图对象</p></td>
         </tr>
 	
 	
@@ -232,7 +230,7 @@
                         
                     
                 
-                <p>用于获取法线纹理的函数，返回相机空间下的法线纹理，不需要倒影的区域法线数据为（0,0,0），一般该法线纹理每一帧都会更新，故使用回调函数的方式，方便获取最新数据</p></td>
+                <p>用于返回法线纹理的回调函数；法线数据需位于相机空间下，不需要倒影的区域应返回 <code>(0,0,0)</code> 法线</p></td>
         </tr>
 	
 	
@@ -412,7 +410,7 @@
                         
                     
                 
-                <p>标识法线纹理中是否包含了水面深度数据，用于支持自定义水面深度逻辑，深度数据使用alpha通道存储，默认为false，使用地形作为水面</p></td>
+                <p>标识法线纹理中是否包含水面深度数据；深度数据使用 alpha 通道存储，默认为 <code>false</code></p></td>
         </tr>
 	
 	
@@ -461,35 +459,6 @@
     
     
     
-    <h5>Returns:</h5>
-    
-
-
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-    
-        <tr>
-            
-            <td class="type">
-            
-                        Object
-                        
-                    
-            </td>
-            <td class="description last">返回根据参数实例化的反射对象</td>
-        </tr>
-    
-    </tbody>
-</table>
-
-    
     
     
         <h5>Example</h5>
@@ -498,7 +467,19 @@
     
 
     
-    <pre class="prettyprint"><code>// ES5引入方式
  viewer: viewer,
  normalMap: () => target.normalMap,
  alpha: 1,
  maxDistance: 1000,
+    <pre class="prettyprint"><code>// ES5引入方式
+const { SSR } = zondy.cesium
+
+// ES6引入方式
+import { SSR } from "@mapgis/webclient-cesium-plugin"
+
+// 创建屏幕空间反射对象
+const ssr = new SSR({
+  viewer,
+  normalMap: () => target.normalMap,
+  alpha: 1,
+  maxDistance: 1000
+})</code></pre>
     
 
     
@@ -719,7 +700,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/effects/SSR.js, line 101
+            engineExtensions/effects/SSR.js, line 97
         </div>
         
     </div>
@@ -793,7 +774,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:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>