@mapgis/webclient-cesium-plugin 17.2.4 → 17.2.6

package/documention/ModelFilterTool.html

@@ -0,0 +1,1053 @@
+<header id="page-title" class="page-title">
+    
+        <span class="page-title-main">类名</span>
+        <span class="page-title-sub">ModelFilterTool</span>
+    
+</header>
+
+
+
+
+
+<section>
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        
+
+
+    
+    <h4 class="name" id="ModelFilterTool">
+        <a class="href-link" href="#ModelFilterTool">#</a>
+        
+        <span class="code-name" id="ModelFilterTool" style="font-size:30px">
+            
+                new ModelFilterTool<span class="signature">(layer<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>模型空间过滤工具</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+            <th style="min-width: 100px;">默认值</th>
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>layer</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             <a link="MapGISM3DSet.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapGISM3DSet" MapGISM3DSet.html>MapGISM3DSet</a>
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>MapGISM3DSet对象</p></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>options</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Object
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>额外初始化参数</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>enableFrameFunction</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          true
+      
+      </td>
+  
+
+  <td class="description last"><p>启用帧函数，即每一帧执行过滤操作，针对lod的模型实时过滤</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>enableCartesian</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          false
+      
+      </td>
+  
+
+  <td class="description last"><p>是否使用笛卡尔坐标,[cartesian3,cartesian3,cartesian3,...]</p></td>
+</tr>
+
+
+  
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>示例</h5>
+    
+        <p class="code-caption"><h7>模型空间过滤</h7></p>
+    
+    
+        <pre class="prettyprint"><code>// 参考示例：
+http://192.168.82.91:8086/#/modules/cesium/analyse/modelAnalyse/model-filter
+
+// ES5引入方式
+const { ModelFilterTool } = zondy.cesium
+// ES6引入方式
+import { ModelFilterTool } from "@mapgis/webclient-cesium-plugin"
+
+// 1 初始化模型空间过滤工具
+const modelFilterTool = new zondy.cesium.ModelFilterTool(
+ // 获取到的MapGISM3DSet对象
+ layer,
+ // 额外初始化参数
+ {
+  //支持输入范围为笛卡尔坐标
+  enableCartesian: true
+})
+
+// 2 外包盒过滤
+modelFilterTool.filterWithBoundingVolume(
+  // 过滤范围，笛卡尔3坐标数组
+  []
+)
+
+// 3 外包盒过滤，带高度范围
+modelFilterTool.filterWithBoundingVolume(
+  // 过滤范围，笛卡尔3坐标数组
+  [],
+  // 外包盒最小高度
+  10,
+  // 外包盒最大高度
+  200
+)
+
+// 4 模型中心点过滤
+modelFilterTool.filterWithCenter(
+  // 过滤范围，笛卡尔3坐标数组
+  []
+)
+
+// 5 模型中心点过滤，带高度范围
+modelFilterTool.filterWithCenter(
+  // 过滤范围，笛卡尔3坐标数组
+  [],
+  // 最小高度范围
+  10,
+  // 最大高度范围
+  200
+)</code></pre>
+    
+
+
+
+                    </div>
+                </div>
+            </div>
+        
+    
+    </div>
+    
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <div class='vertical-section'>
+            <h3 id='function'>方法</h3>
+            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
+            <div class="members">
+            <div class="table-container">
+                <table class="params table">
+                    <thead>
+                    <tr>
+                        <th>名称</th>
+                        <th>返回值类型</th>
+                        <th>描述</th>
+                    </tr>
+                    </thead>
+                    <tbody>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#destroy">destroy</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>销毁工具</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#filterWithBoundingVolume">filterWithBoundingVolume</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>给定范围，如果模型的BoundingVolume和给定范围相交，则显示模型，否则不显示</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#filterWithCenter">filterWithCenter</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>给定范围，如果模型的中心点在给定范围内，则显示模型，否则不显示</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#removeFilter">removeFilter</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>撤销过滤</p></code></td>
+                            </tr>
+                        
+                    </tbody>
+                </table>
+            </div>
+            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="destroy">
+        <a class="href-link" href="#destroy">#</a>
+        
+        <span class="code-name" id="destroy" style="font-size:30px">
+            
+                destroy<span class="signature">()</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>销毁工具</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="filterWithBoundingVolume">
+        <a class="href-link" href="#filterWithBoundingVolume">#</a>
+        
+        <span class="code-name" id="filterWithBoundingVolume" style="font-size:30px">
+            
+                filterWithBoundingVolume<span class="signature">(positions<span class="signature-attributes">opt</span>, minHeight<span class="signature-attributes">opt</span>, maxHeight<span class="signature-attributes">opt</span>)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>给定范围，如果模型的BoundingVolume和给定范围相交，则显示模型，否则不显示</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+            <th style="min-width: 100px;">默认值</th>
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>positions</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+         Array.&lt;Cesium.Cartesian3>
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          []
+      
+      </td>
+  
+
+  <td class="description last"><p>给定过滤范围，默认经纬度高程坐标点数组，[Cesium.Cartographic, Cesium.Cartographic, Cesium.Cartographic, ...]</p></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>minHeight</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </td>
+  
+
+  <td class="description last"><p>过滤最小高度，如果最大或最小高度未传，则不进行高度过滤</p></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>maxHeight</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </td>
+  
+
+  <td class="description last"><p>过滤最大高度，如果最大或最小高度未传，则不进行高度过滤</p></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="filterWithCenter">
+        <a class="href-link" href="#filterWithCenter">#</a>
+        
+        <span class="code-name" id="filterWithCenter" style="font-size:30px">
+            
+                filterWithCenter<span class="signature">(positions<span class="signature-attributes">opt</span>, minHeight<span class="signature-attributes">opt</span>, maxHeight<span class="signature-attributes">opt</span>)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>给定范围，如果模型的中心点在给定范围内，则显示模型，否则不显示</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+            <th style="min-width: 100px;">默认值</th>
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>positions</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+         Array.&lt;Cesium.Cartesian3>
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          []
+      
+      </td>
+  
+
+  <td class="description last"><p>给定过滤范围，默认经纬度高程坐标点数组，[Cesium.Cartographic, Cesium.Cartographic, Cesium.Cartographic, ...]</p></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>minHeight</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </td>
+  
+
+  <td class="description last"><p>过滤最小高度，如果最大或最小高度未传，则不进行高度过滤</p></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>maxHeight</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </td>
+  
+
+  <td class="description last"><p>过滤最大高度，如果最大或最小高度未传，则不进行高度过滤</p></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="removeFilter">
+        <a class="href-link" href="#removeFilter">#</a>
+        
+        <span class="code-name" id="removeFilter" style="font-size:30px">
+            
+                removeFilter<span class="signature">()</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>撤销过滤</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+            </div>
+        </div>
+    
+
+    
+
+    
+</article>
+
+</section>