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

2026 lines
78 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>BillboardCollection - 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>
BillboardCollection
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="BillboardCollection">
<a href="#BillboardCollection" class="doc-link"></a>
new Cesium.BillboardCollection<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/Scene/BillboardCollection.js#L142">Scene/BillboardCollection.js 142</a>
</div>
</h4>
</div>
<div class="description">
A renderable collection of billboards. Billboards are viewport-aligned
images positioned in the 3D scene.
<br /><br />
<div align='center'>
<img src='Images/Billboard.png' width='400' height='300' /><br />
Example billboards
</div>
<br /><br />
Billboards are added and removed from the collection using <a href="BillboardCollection.html#add"><code>BillboardCollection#add</code></a>
and <a href="BillboardCollection.html#remove"><code>BillboardCollection#remove</code></a>. Billboards in a collection automatically share textures
for images with the same identifier.
</div>
<h5>Performance:</h5>
<p class="description">For best performance, prefer a few collections, each with many billboards, to
many collections with only a few billboards each. Organize collections so that billboards
with the same update frequency are in the same collection, i.e., billboards that do not
change should be in one collection; billboards that change every frame should be in another
collection; and so on.</p>
<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">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>modelMatrix</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="default">
<code class="language-javascript">Matrix4.IDENTITY</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The 4x4 transformation matrix that transforms each billboard from model to world coordinates.</td>
</tr>
<tr>
<td class="name"><code>debugShowBoundingVolume</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. Determines if this primitive's commands' bounding spheres are shown.</td>
</tr>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Must be passed in for billboards that use the height reference property or will be depth tested against the globe.</td>
</tr>
<tr>
<td class="name"><code>blendOption</code></td>
<td class="type">
<span class="param-type"><a href="global.html#BlendOption">BlendOption</a></span>
</td>
<td class="default">
<code class="language-javascript">BlendOption.OPAQUE_AND_TRANSLUCENT</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The billboard blending option. The default
is used for rendering both opaque and translucent billboards. However, if either all of the billboards are completely opaque or all are completely translucent,
setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve performance by up to 2x.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines if the billboards in the collection will be shown.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Create a billboard collection with two billboards
const billboards = scene.primitives.add(new Cesium.BillboardCollection());
billboards.add({
position : new Cesium.Cartesian3(1.0, 2.0, 3.0),
image : 'url/to/image'
});
billboards.add({
position : new Cesium.Cartesian3(4.0, 5.0, 6.0),
image : 'url/to/another/image'
});</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Billboards.html">Cesium Sandcastle Billboard Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#add">BillboardCollection#add</a></li>
<li><a href="BillboardCollection.html#remove">BillboardCollection#remove</a></li>
<li><a href="Billboard.html">Billboard</a></li>
<li><a href="LabelCollection.html">LabelCollection</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="blendOption">
<a href="#blendOption" class="doc-link"></a>
blendOption<span class="type-signature"> : <a href="global.html#BlendOption">BlendOption</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L288">Scene/BillboardCollection.js 288</a>
</div>
</h4>
</div>
<div class="description">
The billboard blending option. The default is used for rendering both opaque and translucent billboards.
However, if either all of the billboards are completely opaque or all are completely translucent,
setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve
performance by up to 2x.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">BlendOption.OPAQUE_AND_TRANSLUCENT</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowBoundingVolume">
<a href="#debugShowBoundingVolume" class="doc-link"></a>
debugShowBoundingVolume<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L260">Scene/BillboardCollection.js 260</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not for production use nor is it optimized.
<p>
Draws the bounding sphere for each draw command in the primitive.
</p>
</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="debugShowTextureAtlas">
<a href="#debugShowTextureAtlas" class="doc-link"></a>
debugShowTextureAtlas<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L275">Scene/BillboardCollection.js 275</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not for production use nor is it optimized.
<p>
Draws the texture atlas for this BillboardCollection as a fullscreen quad.
</p>
</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="length">
<a href="#length" class="doc-link"></a>
length<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L353">Scene/BillboardCollection.js 353</a>
</div>
</h4>
</div>
<div class="description">
Returns the number of billboards in this collection. This is commonly used with
<a href="BillboardCollection.html#get"><code>BillboardCollection#get</code></a> to iterate over all the billboards
in the collection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="modelMatrix">
<a href="#modelMatrix" class="doc-link"></a>
modelMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L245">Scene/BillboardCollection.js 245</a>
</div>
</h4>
</div>
<div class="description">
The 4x4 transformation matrix that transforms each billboard in this collection from model to world coordinates.
When this is the identity matrix, the billboards are drawn in world coordinates, i.e., Earth's WGS84 coordinates.
Local reference frames can be used by providing a different transformation matrix, like that returned
by <a href="Transforms.html#.eastNorthUpToFixedFrame"><code>Transforms.eastNorthUpToFixedFrame</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Matrix4.html#.IDENTITY"><code>Matrix4.IDENTITY</code></a></code>
<h5>Example:</h5>
<pre><code class="language-javascript">const center = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883);
billboards.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(center);
billboards.add({
image : 'url/to/image',
position : new Cesium.Cartesian3(0.0, 0.0, 0.0) // center
});
billboards.add({
image : 'url/to/image',
position : new Cesium.Cartesian3(1000000.0, 0.0, 0.0) // east
});
billboards.add({
image : 'url/to/image',
position : new Cesium.Cartesian3(0.0, 1000000.0, 0.0) // north
});
billboards.add({
image : 'url/to/image',
position : new Cesium.Cartesian3(0.0, 0.0, 1000000.0) // up
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Transforms.html#.eastNorthUpToFixedFrame">Transforms.eastNorthUpToFixedFrame</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L211">Scene/BillboardCollection.js 211</a>
</div>
</h4>
</div>
<div class="description">
Determines if billboards in this collection will be shown.
</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="add">
<a href="#add" class="doc-link"></a>
add<span class="signature">(<span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType"><a href="Billboard.html">Billboard</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L474">Scene/BillboardCollection.js 474</a>
</div>
</h4>
</div>
<div class="description">
Creates and adds a billboard with the specified initial properties to the collection.
The added billboard is returned so it can be modified or removed from the collection later.
</div>
<h5>Performance:</h5>
<p class="description">Calling <code>add</code> is expected constant time. However, the collection's vertex buffer
is rewritten - an <code>O(n)</code> operation that also incurs CPU to GPU overhead. For
best performance, add as many billboards as possible before calling <code>update</code>.</p>
<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">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
A template describing the billboard's properties as shown in Example 1.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The billboard that was added to the collection.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1: Add a billboard, specifying all the default values.
const b = billboards.add({
show : true,
position : Cesium.Cartesian3.ZERO,
pixelOffset : Cesium.Cartesian2.ZERO,
eyeOffset : Cesium.Cartesian3.ZERO,
heightReference : Cesium.HeightReference.NONE,
horizontalOrigin : Cesium.HorizontalOrigin.CENTER,
verticalOrigin : Cesium.VerticalOrigin.CENTER,
scale : 1.0,
image : 'url/to/image',
imageSubRegion : undefined,
color : Cesium.Color.WHITE,
id : undefined,
rotation : 0.0,
alignedAxis : Cesium.Cartesian3.ZERO,
width : undefined,
height : undefined,
scaleByDistance : undefined,
translucencyByDistance : undefined,
pixelOffsetScaleByDistance : undefined,
sizeInMeters : false,
distanceDisplayCondition : undefined
});</code></pre>
<pre><code class="language-javascript">// Example 2: Specify only the billboard's cartographic position.
const b = billboards.add({
position : Cesium.Cartesian3.fromDegrees(longitude, latitude, height)
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#remove">BillboardCollection#remove</a></li>
<li><a href="BillboardCollection.html#removeAll">BillboardCollection#removeAll</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="contains">
<a href="#contains" class="doc-link"></a>
contains<span class="signature">(<span class="optional">billboard</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L584">Scene/BillboardCollection.js 584</a>
</div>
</h4>
</div>
<div class="description">
Check whether this collection contains a given billboard.
</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>billboard</code></td>
<td class="type">
<span class="param-type"><a href="Billboard.html">Billboard</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The billboard to check for.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if this collection contains the billboard, false otherwise.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#get">BillboardCollection#get</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L2400">Scene/BillboardCollection.js 2400</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy this object.
<br /><br />
Once an object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">billboards = billboards &amp;&amp; billboards.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#isDestroyed">BillboardCollection#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="get">
<a href="#get" class="doc-link"></a>
get<span class="signature">(index)</span> &rarr; <span class="type-signature returnType"><a href="Billboard.html">Billboard</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L615">Scene/BillboardCollection.js 615</a>
</div>
</h4>
</div>
<div class="description">
Returns the billboard in the collection at the specified index. Indices are zero-based
and increase as billboards are added. Removing a billboard shifts all billboards after
it to the left, changing their indices. This function is commonly used with
<a href="BillboardCollection.html#length"><code>BillboardCollection#length</code></a> to iterate over all the billboards
in the collection.
</div>
<h5>Performance:</h5>
<p class="description">Expected constant time. If billboards were removed from the collection and
<a href="BillboardCollection.html#update"><code>BillboardCollection#update</code></a> was not called, an implicit <code>O(n)</code>
operation is performed.</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The zero-based index of the billboard.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The billboard at the specified index.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Toggle the show property of every billboard in the collection
const len = billboards.length;
for (let i = 0; i &lt; len; ++i) {
const b = billboards.get(i);
b.show = !b.show;
}</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#length">BillboardCollection#length</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L2380">Scene/BillboardCollection.js 2380</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if this object was destroyed; otherwise, <code>false</code>.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#destroy">BillboardCollection#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="remove">
<a href="#remove" class="doc-link"></a>
remove<span class="signature">(billboard)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L507">Scene/BillboardCollection.js 507</a>
</div>
</h4>
</div>
<div class="description">
Removes a billboard from the collection.
</div>
<h5>Performance:</h5>
<p class="description">Calling <code>remove</code> is expected constant time. However, the collection's vertex buffer
is rewritten - an <code>O(n)</code> operation that also incurs CPU to GPU overhead. For
best performance, remove as many billboards as possible before calling <code>update</code>.
If you intend to temporarily hide a billboard, it is usually more efficient to call
<a href="Billboard.html#show"><code>Billboard#show</code></a> instead of removing and re-adding the billboard.</p>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>billboard</code></td>
<td class="type">
<span class="param-type"><a href="Billboard.html">Billboard</a></span>
</td>
<td class="description last">
The billboard to remove.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the billboard was removed; <code>false</code> if the billboard was not found in the collection.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const b = billboards.add(...);
billboards.remove(b); // Returns true</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#add">BillboardCollection#add</a></li>
<li><a href="BillboardCollection.html#removeAll">BillboardCollection#removeAll</a></li>
<li><a href="Billboard.html#show">Billboard#show</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="removeAll">
<a href="#removeAll" class="doc-link"></a>
removeAll<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L536">Scene/BillboardCollection.js 536</a>
</div>
</h4>
</div>
<div class="description">
Removes all billboards from the collection.
</div>
<h5>Performance:</h5>
<p class="description"><code>O(n)</code>. It is more efficient to remove all the billboards
from a collection and then add new ones than to create a new collection entirely.</p>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">billboards.add(...);
billboards.add(...);
billboards.removeAll();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="BillboardCollection.html#add">BillboardCollection#add</a></li>
<li><a href="BillboardCollection.html#remove">BillboardCollection#remove</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/BillboardCollection.js#L1821">Scene/BillboardCollection.js 1821</a>
</div>
</h4>
</div>
<div class="description">
Called when <a href="Viewer.html"><code>Viewer</code></a> or <a href="CesiumWidget.html"><code>CesiumWidget</code></a> render the scene to
get the draw commands needed to render this primitive.
<p>
Do not call this function directly. This is documented just to
list the exceptions that may be propagated when the scene is rendered:
</p>
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
: image with id must be in the atlas.
</div>
</li>
</ul>
<dl class="details">
</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>