@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/ShadowRateAnalysis.html

@@ -71,8 +71,6 @@
     
     </h2>
     
-        <div class="class-description"><p>ShadowRateAnalysis</p></div>
-    
 </header>  
 
 <article>
@@ -85,12 +83,12 @@
     <div class="nameContainer">
         <h4 class="name" id="ShadowRateAnalysis">
             
-            new ShadowRateAnalysis<span class="signature">(viewer, options)</span>
+            new ShadowRateAnalysis<span class="signature">(viewer, <span class="optional">options</span>)</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/ShadowRateAnalysis.js, line 229
+            engineExtensions/analysis/ShadowRateAnalysis.js, line 139
         </div>
         
     </div>
@@ -100,6 +98,13 @@
 <dd>
     
     
+    <div class="description">
+        <p>阴影率分析工具。</p>
+<p>该类用于在指定时间范围内，对一个多边形区域内不同高度的采样点进行逐时刻阴影检测，
+并将阴影率结果以点元颜色的方式绘制到场景中。分析过程中会临时接管 <code>viewer</code> 的阴影、光照和时钟配置，
+在分析结束或日照播放结束后恢复原始状态。</p>
+    </div>
+    
 
     
     
@@ -118,6 +123,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -134,17 +141,27 @@
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<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>
+                    
+                    
+                        
+                    
+                
+                <p>三维场景视图对象。通常可通过 <code>new Cesium.Viewer(...)</code> 创建获得，
+也可在 <code>SceneView</code>的'底层引擎视图对象创建完毕事件（innerView-created）'回调的event.innerView参数中获取。分析过程中会基于该对象的场景、时钟和 Primitive 集合执行计算与绘制。</p></td>
         </tr>
 	
 	
@@ -164,10 +181,23 @@
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>附加选项</p>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>阴影率分析配置项。</p>
                 
 
 <table class="params">
@@ -198,7 +228,7 @@
             <td class="type">
             
                 
-<span class="param-type">Array.&lt;Cartesian3></span>
+<span class="param-type">Array.&lt;Cesium.Cartesian3></span>
 
 
             
@@ -207,6 +237,8 @@
             
                 <td class="default">
                 
+                    []
+                
                 </td>
             
             
@@ -219,7 +251,7 @@
                         
                     
                 
-                <p>点序列,世界坐标Cartesian3数组，可直接使用交互绘制的回调结果,必选</p></td>
+                <p>分析区域顶点数组，使用世界坐标 <code>Cartesian3</code> 表示。通常可直接使用交互绘制面要素时返回的顶点结果。</p></td>
         </tr>
 	
 	
@@ -232,7 +264,7 @@
             <td class="type">
             
                 
-<span class="param-type">JulianDate</span>
+<span class="param-type">Cesium.JulianDate</span>
 
 
             
@@ -253,7 +285,7 @@
                         
                     
                 
-                <p>时间段开始时间,必选</p></td>
+                <p>分析时间段开始时间。执行 <code>shadowRate</code> 或 <code>sunLightEffect</code> 前应确保已设置该值。</p></td>
         </tr>
 	
 	
@@ -266,7 +298,7 @@
             <td class="type">
             
                 
-<span class="param-type">JulianDate</span>
+<span class="param-type">Cesium.JulianDate</span>
 
 
             
@@ -287,7 +319,7 @@
                         
                     
                 
-                <p>时间段结束时间,必选</p></td>
+                <p>分析时间段结束时间。执行 <code>shadowRate</code> 或 <code>sunLightEffect</code> 前应确保已设置该值。</p></td>
         </tr>
 	
 	
@@ -323,7 +355,7 @@
                         
                     
                 
-                <p>时间倍率，用于控制时间流逝速度；数值越小得到的分析结果越精确，消耗时间越长，反之同理</p></td>
+                <p>时钟时间倍率，用于控制时间流逝速度。倍率越小分析越精细但耗时越长，倍率越大分析速度越快但结果会更粗略。</p></td>
         </tr>
 	
 	
@@ -359,7 +391,7 @@
                         
                     
                 
-                <p>配置绘制点的间隔，单位米</p></td>
+                <p>采样点的水平间距与高度步长，单位为米。</p></td>
         </tr>
 	
 	
@@ -395,7 +427,7 @@
                         
                     
                 
-                <p>配置绘制顶点的大小，单位像素</p></td>
+                <p>结果点元绘制大小，单位为像素。</p></td>
         </tr>
 	
 	
@@ -408,7 +440,7 @@
             <td class="type">
             
                 
-<span class="param-type">Array</span>
+<span class="param-type">Array.&lt;Object></span>
 
 
             
@@ -429,13 +461,7 @@
                         
                     
                 
-                <p>颜色表,默认色表：http://10.10.130.72:8200/NoneSpatialData/image/阴影率分析色表.png
-，将阴影率与点元颜色映射，传入方式举例：<br/>
-colorScheme=[<br/>
-    {color:'rgba(0, 255, 0, 1)',rate:0},<br/>
-    {color:'rgba(255, 255, 0, 1)',rate:0.5},<br/>
-    {color:'rgba(255, 0, 0, 1)',rate:1}<br/>
-]</p></td>
+                <p>阴影率颜色映射表。每项至少包含 <code>color</code> 与 <code>rate</code> 字段，用于将阴影率映射为点元颜色。</p></td>
         </tr>
 	
 	
@@ -471,7 +497,7 @@ colorScheme=[<br/>
                         
                     
                 
-                <p>插值点最小高度，单位米</p></td>
+                <p>参与分析的最小采样高度，单位为米。</p></td>
         </tr>
 	
 	
@@ -507,7 +533,7 @@ colorScheme=[<br/>
                         
                     
                 
-                <p>插值点最大高度，单位米</p></td>
+                <p>参与分析的最大采样高度，单位为米。</p></td>
         </tr>
 	
 	
@@ -560,9 +586,33 @@ colorScheme=[<br/>
     
         <h5>Example</h5>
         
+        <p class="code-caption">创建阴影率分析实例并执行分析</p>
+    
 
     
-    <pre class="prettyprint"><code>const { ShadowRateAnalysis } = zondy.cesium
          startTime: Cesium.JulianDate.fromDate(startTimeDate),
          endTime: Cesium.JulianDate.fromDate(endTimeDate),
          spacing: 5,
          pointSize: 10,
          minHeight: 10,
          maxHeight: 50,
   });
         name: 'build',
         position: Cesium.Cartesian3.fromDegrees(115.1771, 20.2834, 500),
         model: {
          uri: '../../SampleData/models/Building/build.glb',
          heightReference: Cesium.HeightReference.CLAMP_TO_GROUND,
          minimumPixelSize: 10,
          scale: 200
      }
   });
         destination: Cesium.Cartesian3.fromDegrees(115.1771, 20.2834, 1000), //经度，纬度，视角高度
         duration: 0
   });
  {
      "x": -2545958.6505201817,
      "y": 5416460.046735503,
      "z": 2197304.570977404
  },
  {
      "x": -2546028.547171191,
      "y": 5416621.283669859,
      "z": 2196829.2727668337
  },
  {
      "x": -2546502.8935825536,
      "y": 5416402.67652554,
      "z": 2196818.5454125707
  },
  {
      "x": -2546411.1078572497,
      "y": 5416239.747866453,
      "z": 2197323.1835109163
  },
  {
      "x": -2545958.6505201817,
      "y": 5416460.046735503,
      "z": 2197304.570977404
  }
+    <pre class="prettyprint"><code>// ES5 引入方式
+const { ShadowRateAnalysis } = zondy.cesium
+
+// ES6 引入方式
+import { ShadowRateAnalysis } from '@mapgis/webclient-cesium-plugin'
+
+const startTimeDate = new Date('2024/04/01 05:00:00')
+const endTimeDate = new Date('2024/04/01 15:00:00')
+
+const analysis = new ShadowRateAnalysis(viewer, {
+  startTime: Cesium.JulianDate.fromDate(startTimeDate),
+  endTime: Cesium.JulianDate.fromDate(endTimeDate),
+  spacing: 5,
+  pointSize: 10,
+  minHeight: 10,
+  maxHeight: 50,
+})
+
+analysis.pointsArray = points
+analysis.shadowRate()
+
+如需仅播放日照效果，可调用：
+analysis.sunLightEffect()</code></pre>
     
 
     
@@ -588,7 +638,7 @@ colorScheme=[<br/>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="colorScheme">colorScheme<span class="type-signature type array">Array</span> </h4>
+        <h4 class="name" id="colorScheme">colorScheme<span class="type-signature type array.<object>">Array.&lt;Object></span> </h4>
     </div>
     
     
@@ -596,7 +646,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>颜色表</p>
+        <p>阴影率颜色映射表。</p>
+<p>数组项通常包含 <code>color</code> 与 <code>rate</code> 字段，用于将阴影率结果映射为结果点元颜色。</p>
     </div>
     
     
@@ -633,7 +684,7 @@ colorScheme=[<br/>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="endTime">endTime<span class="type-signature type juliandate">JulianDate</span> </h4>
+        <h4 class="name" id="endTime">endTime<span class="type-signature type cesium.juliandate">Cesium.JulianDate</span> </h4>
     </div>
     
     
@@ -641,7 +692,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>时间段结束时间</p>
+        <p>阴影率分析或日照播放的结束时间。</p>
+<p>该属性会直接用于设置 <code>viewer.clock.stopTime</code>，决定本次分析的总时长。</p>
     </div>
     
     
@@ -686,7 +738,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>绘制点最大高度</p>
+        <p>参与分析的最大采样高度。</p>
+<p>该值决定三维采样点集的终止高度，单位为米。</p>
     </div>
     
     
@@ -731,7 +784,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>绘制点最小高度</p>
+        <p>参与分析的最小采样高度。</p>
+<p>该值决定三维采样点集的起始高度，单位为米。</p>
     </div>
     
     
@@ -776,7 +830,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>时间倍率</p>
+        <p>分析或播放过程使用的时钟时间倍率。</p>
+<p>值越小，时间推进越细，阴影率结果通常越精确但执行耗时越长。</p>
     </div>
     
     
@@ -813,7 +868,7 @@ colorScheme=[<br/>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="pointsArray">pointsArray<span class="type-signature type array">Array</span> </h4>
+        <h4 class="name" id="pointSize">pointSize<span class="type-signature type number">Number</span> </h4>
     </div>
     
     
@@ -821,7 +876,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>点坐标数组</p>
+        <p>结果点元的显示大小。</p>
+<p>该值仅影响分析结果的可视化表现，单位为像素。</p>
     </div>
     
     
@@ -858,7 +914,7 @@ colorScheme=[<br/>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="pointSize">pointSize<span class="type-signature type number">Number</span> </h4>
+        <h4 class="name" id="pointsArray">pointsArray<span class="type-signature type array.<cesium.cartesian3>">Array.&lt;Cesium.Cartesian3></span> </h4>
     </div>
     
     
@@ -866,7 +922,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>绘制点大小</p>
+        <p>当前分析范围的顶点数组。</p>
+<p>该属性用于定义参与阴影率分析的多边形边界，坐标值应为 <code>Cesium.Cartesian3</code> 世界坐标数组。</p>
     </div>
     
     
@@ -911,7 +968,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>绘制点的间隔</p>
+        <p>采样点间距与高度步长。</p>
+<p>该值同时影响平面格网密度和垂向采样层间距，单位为米。</p>
     </div>
     
     
@@ -948,7 +1006,7 @@ colorScheme=[<br/>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="startTime">startTime<span class="type-signature type juliandate">JulianDate</span> </h4>
+        <h4 class="name" id="startTime">startTime<span class="type-signature type cesium.juliandate">Cesium.JulianDate</span> </h4>
     </div>
     
     
@@ -956,7 +1014,8 @@ colorScheme=[<br/>
 <dd>
     
     <div class="description">
-        <p>时间段开始时间</p>
+        <p>阴影率分析或日照播放的开始时间。</p>
+<p>该属性会直接用于设置 <code>viewer.clock.startTime</code> 与 <code>viewer.clock.currentTime</code>。</p>
     </div>
     
     
@@ -1003,12 +1062,12 @@ colorScheme=[<br/>
     <div class="nameContainer">
         <h4 class="name" id="clear">
             
-            clear<span class="signature">()</span>
+            clear<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/ShadowRateAnalysis.js, line 463
+            engineExtensions/analysis/ShadowRateAnalysis.js, line 421
         </div>
         
     </div>
@@ -1019,7 +1078,8 @@ colorScheme=[<br/>
     
     
     <div class="description">
-        <p>清空绘制结果</p>
+        <p>清空当前分析结果的点元绘制内容。</p>
+<p>该方法只移除当前实例绘制到场景中的结果点，不会重置分析参数。</p>
     </div>
     
 
@@ -1064,6 +1124,35 @@ colorScheme=[<br/>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1074,12 +1163,12 @@ colorScheme=[<br/>
     <div class="nameContainer">
         <h4 class="name" id="destroy">
             
-            destroy<span class="signature">()</span>
+            destroy<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/ShadowRateAnalysis.js, line 470
+            engineExtensions/analysis/ShadowRateAnalysis.js, line 433
         </div>
         
     </div>
@@ -1090,7 +1179,8 @@ colorScheme=[<br/>
     
     
     <div class="description">
-        <p>销毁</p>
+        <p>销毁阴影率分析实例。</p>
+<p>调用后会将该实例创建的点元集合从场景中移除，并释放对象引用；销毁后的实例不应继续使用。</p>
     </div>
     
 
@@ -1135,6 +1225,35 @@ colorScheme=[<br/>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1145,12 +1264,12 @@ colorScheme=[<br/>
     <div class="nameContainer">
         <h4 class="name" id="shadowRate">
             
-            shadowRate<span class="signature">()</span>
+            shadowRate<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/ShadowRateAnalysis.js, line 279
+            engineExtensions/analysis/ShadowRateAnalysis.js, line 231
         </div>
         
     </div>
@@ -1161,7 +1280,10 @@ colorScheme=[<br/>
     
     
     <div class="description">
-        <p>开始阴影率分析</p>
+        <p>执行阴影率分析并绘制结果点。</p>
+<p>调用前应确保 <code>pointsArray</code>、<code>startTime</code> 和 <code>endTime</code> 已正确设置。
+该方法会根据分析范围与高度范围生成采样点，驱动 GPU 模块逐时刻统计阴影结果，
+并在分析结束后将结果以点元颜色绘制到场景中。</p>
     </div>
     
 
@@ -1206,6 +1328,35 @@ colorScheme=[<br/>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1216,12 +1367,12 @@ colorScheme=[<br/>
     <div class="nameContainer">
         <h4 class="name" id="sunLightEffect">
             
-            sunLightEffect<span class="signature">()</span>
+            sunLightEffect<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/ShadowRateAnalysis.js, line 341
+            engineExtensions/analysis/ShadowRateAnalysis.js, line 294
         </div>
         
     </div>
@@ -1232,7 +1383,9 @@ colorScheme=[<br/>
     
     
     <div class="description">
-        <p>开始播放日照效果</p>
+        <p>播放指定时间段内的日照阴影效果。</p>
+<p>该方法不会计算阴影率统计结果，而是仅驱动场景时钟播放日照变化，
+并在播放结束后恢复分析前的阴影和光照状态。</p>
     </div>
     
 
@@ -1277,6 +1430,35 @@ colorScheme=[<br/>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1295,7 +1477,7 @@ colorScheme=[<br/>
 
 
         <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 Fri Sep 18 2026 14:59:30 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>