qd-changjing/public/static/Build/Documentation/GlobeTranslucency.html

676 lines
59 KiB
HTML
Raw Permalink Normal View History

2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>GlobeTranslucency - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
GlobeTranslucency
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GlobeTranslucency">
<a href="#GlobeTranslucency" class="doc-link"></a>
new Cesium.GlobeTranslucency<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L13">Scene/GlobeTranslucency.js 13</a>
</div>
</h4>
</div>
<div class="description">
Properties for controlling globe translucency.
</div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="backFaceAlpha">
<a href="#backFaceAlpha" class="doc-link"></a>
backFaceAlpha<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L155">Scene/GlobeTranslucency.js 155</a>
</div>
</h4>
</div>
<div class="description">
A constant translucency to apply to back faces of the globe.
<br /><br />
<a href="GlobeTranslucency.html#enabled"><code>GlobeTranslucency#enabled</code></a> must be set to true for this option to take effect.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
<h5>Example:</h5>
<pre><code class="language-javascript">// Set back face translucency to 0.5.
globe.translucency.backFaceAlpha = 0.5;
globe.translucency.enabled = true;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GlobeTranslucency.html#enabled">GlobeTranslucency#enabled</a></li>
<li><a href="GlobeTranslucency.html#backFaceAlphaByDistance">GlobeTranslucency#backFaceAlphaByDistance</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="backFaceAlphaByDistance">
<a href="#backFaceAlphaByDistance" class="doc-link"></a>
backFaceAlphaByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L198">Scene/GlobeTranslucency.js 198</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets near and far translucency properties of back faces of the globe based on the distance to the camera.
The translucency will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the translucency remains clamped to the nearest bound. If undefined,
backFaceAlphaByDistance will be disabled.
<br /><br />
<a href="GlobeTranslucency.html#enabled"><code>GlobeTranslucency#enabled</code></a> must be set to true for this option to take effect.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1.
// Set back face translucency to 0.5 when the
// camera is 1500 meters from the surface and 1.0
// as the camera distance approaches 8.0e6 meters.
globe.translucency.backFaceAlphaByDistance = new Cesium.NearFarScalar(1.5e2, 0.5, 8.0e6, 1.0);
globe.translucency.enabled = true;</code></pre>
<pre><code class="language-javascript">// Example 2.
// Disable back face translucency by distance
globe.translucency.backFaceAlphaByDistance = undefined;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GlobeTranslucency.html#enabled">GlobeTranslucency#enabled</a></li>
<li><a href="GlobeTranslucency.html#backFaceAlpha">GlobeTranslucency#backFaceAlpha</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="enabled">
<a href="#enabled" class="doc-link"></a>
enabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L45">Scene/GlobeTranslucency.js 45</a>
</div>
</h4>
</div>
<div class="description">
When true, the globe is rendered as a translucent surface.
<br /><br />
The alpha is computed by blending <a href="Globe.html#material"><code>Globe#material</code></a>, <a href="Globe.html#imageryLayers"><code>Globe#imageryLayers</code></a>,
and <a href="Globe.html#baseColor"><code>Globe#baseColor</code></a>, all of which may contain translucency, and then multiplying by
<a href="GlobeTranslucency.html#frontFaceAlpha"><code>GlobeTranslucency#frontFaceAlpha</code></a> and <a href="GlobeTranslucency.html#frontFaceAlphaByDistance"><code>GlobeTranslucency#frontFaceAlphaByDistance</code></a> for front faces and
<a href="GlobeTranslucency.html#backFaceAlpha"><code>GlobeTranslucency#backFaceAlpha</code></a> and <a href="GlobeTranslucency.html#backFaceAlphaByDistance"><code>GlobeTranslucency#backFaceAlphaByDistance</code></a> for back faces.
When the camera is underground back faces and front faces are swapped, i.e. back-facing geometry
is considered front facing.
<br /><br />
Translucency is disabled by default.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GlobeTranslucency.html#frontFaceAlpha">GlobeTranslucency#frontFaceAlpha</a></li>
<li><a href="GlobeTranslucency.html#frontFaceAlphaByDistance">GlobeTranslucency#frontFaceAlphaByDistance</a></li>
<li><a href="GlobeTranslucency.html#backFaceAlpha">GlobeTranslucency#backFaceAlpha</a></li>
<li><a href="GlobeTranslucency.html#backFaceAlphaByDistance">GlobeTranslucency#backFaceAlphaByDistance</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="frontFaceAlpha">
<a href="#frontFaceAlpha" class="doc-link"></a>
frontFaceAlpha<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L75">Scene/GlobeTranslucency.js 75</a>
</div>
</h4>
</div>
<div class="description">
A constant translucency to apply to front faces of the globe.
<br /><br />
<a href="GlobeTranslucency.html#enabled"><code>GlobeTranslucency#enabled</code></a> must be set to true for this option to take effect.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
<h5>Example:</h5>
<pre><code class="language-javascript">// Set front face translucency to 0.5.
globe.translucency.frontFaceAlpha = 0.5;
globe.translucency.enabled = true;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GlobeTranslucency.html#enabled">GlobeTranslucency#enabled</a></li>
<li><a href="GlobeTranslucency.html#frontFaceAlphaByDistance">GlobeTranslucency#frontFaceAlphaByDistance</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="frontFaceAlphaByDistance">
<a href="#frontFaceAlphaByDistance" class="doc-link"></a>
frontFaceAlphaByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L118">Scene/GlobeTranslucency.js 118</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets near and far translucency properties of front faces of the globe based on the distance to the camera.
The translucency will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the translucency remains clamped to the nearest bound. If undefined,
frontFaceAlphaByDistance will be disabled.
<br /><br />
<a href="GlobeTranslucency.html#enabled"><code>GlobeTranslucency#enabled</code></a> must be set to true for this option to take effect.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1.
// Set front face translucency to 0.5 when the
// camera is 1500 meters from the surface and 1.0
// as the camera distance approaches 8.0e6 meters.
globe.translucency.frontFaceAlphaByDistance = new Cesium.NearFarScalar(1.5e2, 0.5, 8.0e6, 1.0);
globe.translucency.enabled = true;</code></pre>
<pre><code class="language-javascript">// Example 2.
// Disable front face translucency by distance
globe.translucency.frontFaceAlphaByDistance = undefined;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GlobeTranslucency.html#enabled">GlobeTranslucency#enabled</a></li>
<li><a href="GlobeTranslucency.html#frontFaceAlpha">GlobeTranslucency#frontFaceAlpha</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangle">
<a href="#rectangle" class="doc-link"></a>
rectangle<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GlobeTranslucency.js#L226">Scene/GlobeTranslucency.js 226</a>
</div>
</h4>
</div>
<div class="description">
A property specifying a <a href="Rectangle.html"><code>Rectangle</code></a> used to limit translucency to a cartographic area.
Defaults to the maximum extent of cartographic coordinates.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Rectangle.html#.MAX_VALUE"><code>Rectangle.MAX_VALUE</code></a></code>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>