@mapgis/webclient-cesium-plugin 17.2.4 → 17.2.6

package/documention/GlobeIndependentTranslucency.html

@@ -0,0 +1,1170 @@
+<header id="page-title" class="page-title">
+    
+        <span class="page-title-main">类名</span>
+        <span class="page-title-sub">GlobeIndependentTranslucency</span>
+    
+</header>
+
+
+
+
+
+<section>
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        
+
+
+    
+    <h4 class="name" id="GlobeIndependentTranslucency">
+        <a class="href-link" href="#GlobeIndependentTranslucency">#</a>
+        
+        <span class="code-name" id="GlobeIndependentTranslucency" style="font-size:30px">
+            
+                new GlobeIndependentTranslucency<span class="signature">(viewer)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>单独控制地表透明度和影像图层的透明度，能够在开启地表透明后使部分影像图层不受地表透明的影响。</p>
+<p>实例化该类的对象同时也能够使用原生的地表透明参数，能够直接在实例化对象上修改 <code>GlobeTranslucency</code> 的参数（原生的
+viewer.scene.globe.translucency依然能够使用，但两者同时使用时会造成相互干扰，推荐仅使用GlobeIndependentTranslucency来实现地表透明），
+使用原生的地表透明方式还是该类的地表透明方式由 <a class="mapgis-link-name" title="GlobeIndependentTranslucency#imageryLayers" GlobeIndependentTranslucency.html#imageryLayers><code>GlobeIndependentTranslucency#imageryLayers</code></a> 数组是否为空来区分。</p>
+<p>1. 当 <a class="mapgis-link-name" title="GlobeIndependentTranslucency#imageryLayers" GlobeIndependentTranslucency.html#imageryLayers><code>GlobeIndependentTranslucency#imageryLayers</code></a> 不为空数组时，使用该类的地表透明方式，此时能够设置并生效的地表透明参数如下：</p>
+<ul>
+<li><code>globeFaceAlpha</code>：地表的透明度，若设置该参数则<code>globeFaceAlphaByDistance</code>不生效；</li>
+<li><code>globeFaceAlphaByDistance</code>：地表的透明度根据视点距离的变化范围，当<code>globeFaceAlpha</code>为<code>undefined</code>时生效；</li>
+</ul>
+<p>2. 当 <a class="mapgis-link-name" title="GlobeIndependentTranslucency#imageryLayers" GlobeIndependentTranslucency.html#imageryLayers><code>GlobeIndependentTranslucency#imageryLayers</code></a> 为空数组时，使用原生的地表透明方式，此时能够设置并生效的地表透明参数如下：</p>
+<ul>
+<li><code>frontFaceAlpha</code>：地表正面的透明度；</li>
+<li><code>frontFaceAlphaByDistance </code>：地表正面的透明度根据视点距离的变化范围；</li>
+<li><code>backFaceAlpha</code>：地表背面的透明度；</li>
+<li><code>backFaceAlphaByDistance</code>：地表背面的透明度根据视点距离的变化范围；</li>
+<li><code>rectangle</code>：将地表透明的区域限制在一个矩形范围内。</li>
+</ul>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>viewer</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Viewer
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"><p>显示三维地球场景的对象</p></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>示例</h5>
+    
+    
+        <pre class="prettyprint"><code>// 初始化视图对象，若不指定影像图层则会默认使用SingleTileImageryProvider加载一张地表影像图
    new Cesium.SingleTileImageryProvider({
        url: 'http://192.168.82.89:8089/igs/rest/services/Tile/湖北省_4326_custom_1-8/TileServer/tileImage/2/0/0?f=image',
        rectangle: Cesium.Rectangle.fromDegrees(108.34522, 25.48750, 116.13094, 33.27322)
    })
    position: Cesium.Cartesian3.fromDegrees(114.0, 30.5, -40000),
    box: {
        dimensions: new Cesium.Cartesian3(4.0e5, 4.0e5, 3.0e4),
        material: Cesium.Color.RED,
        outline: true,
        outlineColor: Cesium.Color.BLACK
    }
    position: Cesium.Cartesian3.fromDegrees(114.0, 30.5, 40000),,
    box: {
        dimensions: new Cesium.Cartesian3(2.0e5, 2.0e5, 3.0e4),
        material: Cesium.Color.GREEN.withAlpha(0.5),
        outline: true,
        outlineColor: Cesium.Color.BLACK
    }
+    
+
+
+
+                    </div>
+                </div>
+            </div>
+        
+    
+    </div>
+    
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <div class='vertical-section'>
+            <h3 id='member'>成员变量</h3>
+            <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4>
+            <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="#backFaceAlpha">backFaceAlpha</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表背面的透明度</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#backFaceAlphaByDistance">backFaceAlphaByDistance</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表背面的透明度根据视点距离的变化范围</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#enabled">enabled</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>是否开启地表透明</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#frontFaceAlpha">frontFaceAlpha</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表正面的透明度</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#frontFaceAlphaByDistance">frontFaceAlphaByDistance</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表正面的透明度根据视点距离的变化范围</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#globeFaceAlpha">globeFaceAlpha</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表的透明度，若设置该参数则<code>globeFaceAlphaByDistance</code>不生效</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#globeFaceAlphaByDistance">globeFaceAlphaByDistance</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>地表的透明度根据视点距离的变化范围，在<code>globeFaceAlpha</code>为<code>undefined</code>时生效</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#imageryLayers">imageryLayers</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+         Array.&lt;Cesium.ImageryLayer>
+    
+</span>
+
+
+
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>需要单独控制透明度的影像图层，可以通过数组的形式传入一个或多个影像图层对象</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#rectangle">rectangle</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+<span class="param-type">
+    
+             Cesium.Rectangle
+    
+</span>
+
+
+
+                                    </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="members">
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="backFaceAlpha">
+    <a class="href-link" href="#backFaceAlpha">#</a>
+    
+    <span class="code-name">
+        backFaceAlpha
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表背面的透明度</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>1.0</li>
+        </ul></dd>
+    
+    
+
+    
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>GlobeTranslucency#backFaceAlpha</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="backFaceAlphaByDistance">
+    <a class="href-link" href="#backFaceAlphaByDistance">#</a>
+    
+    <span class="code-name">
+        backFaceAlphaByDistance
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表背面的透明度根据视点距离的变化范围</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>undefined</li>
+        </ul></dd>
+    
+    
+
+    
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>GlobeTranslucency#backFaceAlphaByDistance</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="enabled">
+    <a class="href-link" href="#enabled">#</a>
+    
+    <span class="code-name">
+        enabled
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>是否开启地表透明</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>false</li>
+        </ul></dd>
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="frontFaceAlpha">
+    <a class="href-link" href="#frontFaceAlpha">#</a>
+    
+    <span class="code-name">
+        frontFaceAlpha
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表正面的透明度</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>1.0</li>
+        </ul></dd>
+    
+    
+
+    
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>GlobeTranslucency#frontFaceAlpha</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="frontFaceAlphaByDistance">
+    <a class="href-link" href="#frontFaceAlphaByDistance">#</a>
+    
+    <span class="code-name">
+        frontFaceAlphaByDistance
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表正面的透明度根据视点距离的变化范围</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>undefined</li>
+        </ul></dd>
+    
+    
+
+    
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>GlobeTranslucency#frontFaceAlphaByDistance</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="globeFaceAlpha">
+    <a class="href-link" href="#globeFaceAlpha">#</a>
+    
+    <span class="code-name">
+        globeFaceAlpha
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表的透明度，若设置该参数则<code>globeFaceAlphaByDistance</code>不生效</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>undefined</li>
+        </ul></dd>
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+    <h5>示例</h5>
+    
+    
+        <pre class="prettyprint"><code>let independentTranslucency = new Cesium.GlobeIndependentTranslucency(viewer);
+    
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Cesium.NearFarScalar
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="globeFaceAlphaByDistance">
+    <a class="href-link" href="#globeFaceAlphaByDistance">#</a>
+    
+    <span class="code-name">
+        globeFaceAlphaByDistance
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>地表的透明度根据视点距离的变化范围，在<code>globeFaceAlpha</code>为<code>undefined</code>时生效</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>new Cesium.NearFarScalar(3.0e5, 0.0, 3.0e6, 1.0)</li>
+        </ul></dd>
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+    <h5>示例</h5>
+    
+    
+        <pre class="prettyprint"><code>let independentTranslucency = new Cesium.GlobeIndependentTranslucency(viewer);
+    
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+         Array.&lt;Cesium.ImageryLayer>
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="imageryLayers">
+    <a class="href-link" href="#imageryLayers">#</a>
+    
+    <span class="code-name">
+        imageryLayers
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>需要单独控制透明度的影像图层，可以通过数组的形式传入一个或多个影像图层对象</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li>[]</li>
+        </ul></dd>
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+    <h5>示例</h5>
+    
+    
+        <pre class="prettyprint"><code>let independentTranslucency = new Cesium.GlobeIndependentTranslucency(viewer);
+    
+
+
+</div>
+            
+                <div class="member">
+
+    <span class="method-parameter is-pulled-right">
+        <label>类型:</label>
+        
+<span class="param-type">
+    
+             Cesium.Rectangle
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="rectangle">
+    <a class="href-link" href="#rectangle">#</a>
+    
+    <span class="code-name">
+        rectangle
+    </span>
+    
+</h4>
+
+
+
+
+<div class="description">
+    <p>限制地表透明在一个矩形范围内</p>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default"><ul class="dummy">
+            <li><code>Cesium.Rectangle.MAX_VALUE</code></li>
+        </ul></dd>
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+</div>
+            
+            </div>
+        </div>
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>