wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/WallGraphics.html

1903 lines
73 KiB
HTML
Raw Normal View History

first commit
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>WallGraphics - 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>
WallGraphics
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="WallGraphics">
<a href="#WallGraphics" class="doc-link"></a>
new Cesium.WallGraphics<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L39">DataSources/WallGraphics.js 39</a>
</div>
</h4>
</div>
<div class="description">
Describes a two dimensional wall defined as a line strip and optional maximum and minimum heights.
The wall conforms to the curvature of the globe and can be placed along the surface or at altitude.
</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>options</code></td>
<td class="type">
<span class="param-type"><a href="WallGraphics.html#.ConstructorOptions">WallGraphics.ConstructorOptions</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object describing initialization options</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Wall.html">Cesium Sandcastle Wall Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Entity.html">Entity</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="definitionChanged">
<a href="#definitionChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> definitionChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L77">DataSources/WallGraphics.js 77</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised whenever a property or sub-property is changed or modified.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L179">DataSources/WallGraphics.js 179</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</code></a> Property specifying at what distance from the camera that this wall will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="fill">
<a href="#fill" class="doc-link"></a>
fill<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L128">DataSources/WallGraphics.js 128</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying whether the wall is filled with the provided material.
</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="granularity">
<a href="#granularity" class="doc-link"></a>
granularity<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L120">DataSources/WallGraphics.js 120</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the angular distance between points on the wall.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">{CesiumMath.RADIANS_PER_DEGREE}</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="material">
<a href="#material" class="doc-link"></a>
material<span class="type-signature"> : <a href="MaterialProperty.html">MaterialProperty</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L136">DataSources/WallGraphics.js 136</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the material used to fill the wall.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.WHITE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumHeights">
<a href="#maximumHeights" class="doc-link"></a>
maximumHeights<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L112">DataSources/WallGraphics.js 112</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying an array of heights to be used for the top of the wall instead of the height of each position.
If defined, the array must be the same length as <code>Wall#positions</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumHeights">
<a href="#minimumHeights" class="doc-link"></a>
minimumHeights<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L104">DataSources/WallGraphics.js 104</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying an array of heights to be used for the bottom of the wall instead of the surface of the globe.
If defined, the array must be the same length as <code>Wall#positions</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outline">
<a href="#outline" class="doc-link"></a>
outline<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L144">DataSources/WallGraphics.js 144</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying whether the wall is outlined.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineColor">
<a href="#outlineColor" class="doc-link"></a>
outlineColor<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L152">DataSources/WallGraphics.js 152</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="Color.html"><code>Color</code></a> of the outline.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.BLACK</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineWidth">
<a href="#outlineWidth" class="doc-link"></a>
outlineWidth<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L163">DataSources/WallGraphics.js 163</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the width of the outline.
<p>
Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="positions">
<a href="#positions" class="doc-link"></a>
positions<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L96">DataSources/WallGraphics.js 96</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the array of <a href="Cartesian3.html"><code>Cartesian3</code></a> positions which define the top of the wall.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadows">
<a href="#shadows" class="doc-link"></a>
shadows<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L172">DataSources/WallGraphics.js 172</a>
</div>
</h4>
</div>
<div class="description">
Get or sets the enum Property specifying whether the wall
casts or receives shadows from light sources.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ShadowMode.DISABLED</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L89">DataSources/WallGraphics.js 89</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the wall.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="WallGraphics.html">WallGraphics</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L190">DataSources/WallGraphics.js 190</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this instance.
</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>result</code></td>
<td class="type">
<span class="param-type"><a href="WallGraphics.html">WallGraphics</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if one was not provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="merge">
<a href="#merge" class="doc-link"></a>
merge<span class="signature">(source)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L215">DataSources/WallGraphics.js 215</a>
</div>
</h4>
</div>
<div class="description">
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
</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>source</code></td>
<td class="type">
<span class="param-type"><a href="WallGraphics.html">WallGraphics</a></span>
</td>
<td class="description last">
The object to be merged into this object.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.WallGraphics.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/WallGraphics.js#L8">DataSources/WallGraphics.js 8</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the WallGraphics constructor
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying the visibility of the wall.</td>
</tr>
<tr>
<td class="name"><code>positions</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying the array of <a href="Cartesian3.html"><code>Cartesian3</code></a> positions which define the top of the wall.</td>
</tr>
<tr>
<td class="name"><code>minimumHeights</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">Array.&lt;number></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying an array of heights to be used for the bottom of the wall instead of the globe surface.</td>
</tr>
<tr>
<td class="name"><code>maximumHeights</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">Array.&lt;number></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying an array of heights to be used for the top of the wall instead of the height of each position.</td>
</tr>
<tr>
<td class="name"><code>granularity</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Cesium.Math.RADIANS_PER_DEGREE
</td>
<td class="description last">A numeric Property specifying the angular distance between each latitude and longitude point.</td>
</tr>
<tr>
<td class="name"><code>fill</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying whether the wall is filled with the provided material.</td>
</tr>
<tr>
<td class="name"><code>material</code></td>
<td class="type">
<span class="param-type"><a href="MaterialProperty.html">MaterialProperty</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Color.WHITE
</td>
<td class="description last">A Property specifying the material used to fill the wall.</td>
</tr>
<tr>
<td class="name"><code>outline</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">A boolean Property specifying whether the wall is outlined.</td>
</tr>
<tr>
<td class="name"><code>outlineColor</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Color.BLACK
</td>
<td class="description last">A Property specifying the <a href="Color.html"><code>Color</code></a> of the outline.</td>
</tr>
<tr>
<td class="name"><code>outlineWidth</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1.0
</td>
<td class="description last">A numeric Property specifying the width of the outline.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
ShadowMode.DISABLED
</td>
<td class="description last">An enum Property specifying whether the wall casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying at what distance from the camera that this wall will be displayed.</td>
</tr>
</tbody>
</table>
</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>