450 lines
52 KiB
HTML
450 lines
52 KiB
HTML
|
<!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>Fog - 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>
|
||
|
|
Fog
|
||
|
|
<div class="titleCenterer"></div>
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="Fog">
|
||
|
|
<a href="#Fog" class="doc-link"></a>
|
||
|
|
new Cesium.Fog<span class="signature">()</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Fog.js#L13">Scene/Fog.js 13</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Blends the atmosphere to geometry far from the camera for horizon views. Allows for additional
|
||
|
|
performance improvements by rendering less geometry and dispatching less terrain requests.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Members</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="density">
|
||
|
|
<a href="#density" class="doc-link"></a>
|
||
|
|
density<span class="type-signature"> : Number</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Fog.js#L29">Scene/Fog.js 29</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
A scalar that determines the density of the fog. Terrain that is in full fog are culled.
|
||
|
|
The density of the fog increases as this number approaches 1.0 and becomes less dense as it approaches zero.
|
||
|
|
The more dense the fog is, the more aggressively the terrain is culled. For example, if the camera is a height of
|
||
|
|
1000.0m above the ellipsoid, increasing the value to 3.0e-3 will cause many tiles close to the viewer be culled.
|
||
|
|
Decreasing the value will push the fog further from the viewer, but decrease performance as more of the terrain is rendered.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="details-header">Default Value:</span>
|
||
|
|
<code class="language-javascript">2.0e-4</code>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</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/Fog.js#L19">Scene/Fog.js 19</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
<code>true</code> if fog is enabled, <code>false</code> otherwise.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="details-header">Default Value:</span>
|
||
|
|
<code class="language-javascript">true</code>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="minimumBrightness">
|
||
|
|
<a href="#minimumBrightness" class="doc-link"></a>
|
||
|
|
minimumBrightness<span class="type-signature"> : Number</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Fog.js#L45">Scene/Fog.js 45</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
The minimum brightness of the fog color from lighting. A value of 0.0 can cause the fog to be completely black. A value of 1.0 will not affect
|
||
|
|
the brightness at all.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="details-header">Default Value:</span>
|
||
|
|
<code class="language-javascript">0.03</code>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="screenSpaceErrorFactor">
|
||
|
|
<a href="#screenSpaceErrorFactor" class="doc-link"></a>
|
||
|
|
screenSpaceErrorFactor<span class="type-signature"> : Number</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Fog.js#L38">Scene/Fog.js 38</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
A factor used to increase the screen space error of terrain tiles when they are partially in fog. The effect is to reduce
|
||
|
|
the number of terrain tiles requested for rendering. If set to zero, the feature will be disabled. If the value is increased
|
||
|
|
for mountainous regions, less tiles will need to be requested, but the terrain meshes near the horizon may be a noticeably
|
||
|
|
lower resolution. If the value is increased in a relatively flat area, there will be little noticeable change on the horizon.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<span class="details-header">Default Value:</span>
|
||
|
|
<code class="language-javascript">2.0</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>
|