@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/RouteAnimationTool.html

@@ -94,15 +94,14 @@
     </div>
 
     
-    <p class="summary"><p>请参考以下示例:<br>
-<a href='#example6'>1、模型沿地形漫游</a><br></p></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
-        <p>路径漫游工具（支持实例化多个工具）</p>
+        <p>路径漫游工具。</p>
+<p>该工具负责管理路径漫游实体、视角控制、状态切换与事件抛发，
+支持在同一场景中实例化多个独立的漫游工具。</p>
     </div>
     
 
@@ -164,7 +163,7 @@
                         
                     
                 
-                <p>场景视图，<a href='http://192.168.82.91:8086/static/modules/cesium/api/cesium/index.html' target='_blank'>详见Cesium.Viewer</a></p></td>
+                <p>场景视图对象。</p></td>
         </tr>
 	
 	
@@ -200,7 +199,7 @@
                         
                     
                 
-                <p>额外初始化参数</p>
+                <p>额外初始化参数。</p>
                 
 
 <table class="params">
@@ -254,7 +253,7 @@
                         
                     
                 
-                <p>路径漫游路径对象</p></td>
+                <p>路径漫游路径对象。</p></td>
         </tr>
 	
 	
@@ -290,7 +289,7 @@
                         
                     
                 
-                <p>路径漫游标牌对象</p></td>
+                <p>路径漫游标牌对象。</p></td>
         </tr>
 	
 	
@@ -326,7 +325,7 @@
                         
                     
                 
-                <p>路径漫游模型对象</p></td>
+                <p>路径漫游模型对象。</p></td>
         </tr>
 	
 	
@@ -362,7 +361,7 @@
                         
                     
                 
-                <p>路径漫游控制对象</p></td>
+                <p>路径漫游控制对象。</p></td>
         </tr>
 	
 	
@@ -398,7 +397,7 @@
                         
                     
                 
-                <p>路径漫游视角对象</p></td>
+                <p>路径漫游视角对象。</p></td>
         </tr>
 	
 	
@@ -460,6 +459,7 @@ http://192.168.82.91:8086/#/modules/cesium/analyse/commonAnalyse/path-roaming
 
 // ES5引入方式
 const { RouteAnimationTool } = zondy.cesium
+
 // ES6引入方式
 import { RouteAnimationTool } from "@mapgis/webclient-cesium-plugin"
 
@@ -467,8 +467,7 @@ import { RouteAnimationTool } from "@mapgis/webclient-cesium-plugin"
 const pathPositions = [...]
 
 // 2 定义漫游工具对象
-animationTool = new RouteAnimationTool(viewer, {
-  //类型指定为routes
+const animationTool = new RouteAnimationTool(viewer, {
   path: new RouteAnimationPath({
    positions: pathPositions,
    speeds: [5],
@@ -788,6 +787,169 @@ animationTool.stop()</code></pre>
         
         <dl>
             
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="addPathPoint">
+            
+            addPathPoint<span class="signature">(position, elapsedTime, speed)</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 234
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>追加路径点。</p>
+<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>position</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Cesium.Cartesian3</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>新增路径点坐标。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>elapsedTime</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>新增路径点的时间间隔。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>speed</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>新增路径点对应速度。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    
+    
+</dd>
+
+        
+            
 <dt>
     <div class="nameContainer">
         <h4 class="name" id="pause">
@@ -797,7 +959,7 @@ animationTool.stop()</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 177
+            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 170
         </div>
         
     </div>
@@ -808,7 +970,7 @@ animationTool.stop()</code></pre>
     
     
     <div class="description">
-        <p>控制动画的暂停</p>
+        <p>暂停漫游。</p>
     </div>
     
 
@@ -868,7 +1030,7 @@ animationTool.stop()</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 206
+            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 199
         </div>
         
     </div>
@@ -879,7 +1041,7 @@ animationTool.stop()</code></pre>
     
     
     <div class="description">
-        <p>控制动画继续播放</p>
+        <p>继续播放已暂停的漫游。</p>
     </div>
     
 
@@ -934,12 +1096,12 @@ animationTool.stop()</code></pre>
     <div class="nameContainer">
         <h4 class="name" id="start">
             
-            start<span class="signature">()</span>
+            start<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 126
+            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 117
         </div>
         
     </div>
@@ -950,7 +1112,7 @@ animationTool.stop()</code></pre>
     
     
     <div class="description">
-        <p>开始漫游</p>
+        <p>开始漫游。</p>
     </div>
     
 
@@ -995,6 +1157,35 @@ animationTool.stop()</code></pre>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        *
+                        
+                    
+            </td>
+            <td class="description last">漫游启动结果。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1005,12 +1196,12 @@ animationTool.stop()</code></pre>
     <div class="nameContainer">
         <h4 class="name" id="stop">
             
-            stop<span class="signature">()</span>
+            stop<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 149
+            engineExtensions/tools/routeAnimationTool/RouteAnimationTool.js, line 142
         </div>
         
     </div>
@@ -1021,7 +1212,7 @@ animationTool.stop()</code></pre>
     
     
     <div class="description">
-        <p>结束漫游</p>
+        <p>结束漫游。</p>
     </div>
     
 
@@ -1066,6 +1257,35 @@ animationTool.stop()</code></pre>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        *
+                        
+                    
+            </td>
+            <td class="description last">漫游结束结果。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -1084,7 +1304,7 @@ animationTool.stop()</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 Fri Sep 18 2026 14:59:30 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>