2226 lines
77 KiB
HTML
2226 lines
77 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>PrimitiveCollection - 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>
|
||
|
PrimitiveCollection
|
||
|
<div class="titleCenterer"></div>
|
||
|
</h1>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<section>
|
||
|
|
||
|
<header>
|
||
|
|
||
|
</header>
|
||
|
|
||
|
<article>
|
||
|
<div class="container-overview">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="PrimitiveCollection">
|
||
|
<a href="#PrimitiveCollection" class="doc-link"></a>
|
||
|
new Cesium.PrimitiveCollection<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/PrimitiveCollection.js#L29">Scene/PrimitiveCollection.js 29</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
A collection of primitives. This is most often used with <a href="Scene.html#primitives"><code>Scene#primitives</code></a>,
|
||
|
but <code>PrimitiveCollection</code> is also a primitive itself so collections can
|
||
|
be added to collections forming a hierarchy.
|
||
|
</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">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>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 primitives in the collection will be shown.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>destroyPrimitives</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 primitives in the collection are destroyed when they are removed.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">const billboards = new Cesium.BillboardCollection();
|
||
|
const labels = new Cesium.LabelCollection();
|
||
|
|
||
|
const collection = new Cesium.PrimitiveCollection();
|
||
|
collection.add(billboards);
|
||
|
|
||
|
scene.primitives.add(collection); // Add collection
|
||
|
scene.primitives.add(labels); // Add regular primitive</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h3 class="subsection-title">Members</h3>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="destroyPrimitives">
|
||
|
<a href="#destroyPrimitives" class="doc-link"></a>
|
||
|
destroyPrimitives<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L70">Scene/PrimitiveCollection.js 70</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if primitives in the collection are destroyed when they are removed by
|
||
|
<a href="PrimitiveCollection.html#destroy"><code>PrimitiveCollection#destroy</code></a> or <a href="PrimitiveCollection.html#remove"><code>PrimitiveCollection#remove</code></a> or implicitly
|
||
|
by <a href="PrimitiveCollection.html#removeAll"><code>PrimitiveCollection#removeAll</code></a>.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">true</code>
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Examples:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">// Example 1. Primitives are destroyed by default.
|
||
|
const primitives = new Cesium.PrimitiveCollection();
|
||
|
const labels = primitives.add(new Cesium.LabelCollection());
|
||
|
primitives = primitives.destroy();
|
||
|
const b = labels.isDestroyed(); // true</code></pre>
|
||
|
|
||
|
<pre><code class="language-javascript">// Example 2. Do not destroy primitives in a collection.
|
||
|
const primitives = new Cesium.PrimitiveCollection();
|
||
|
primitives.destroyPrimitives = false;
|
||
|
const labels = primitives.add(new Cesium.LabelCollection());
|
||
|
primitives = primitives.destroy();
|
||
|
const b = labels.isDestroyed(); // false
|
||
|
labels = labels.destroy(); // explicitly destroy</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="length">
|
||
|
<a href="#length" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> length<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L82">Scene/PrimitiveCollection.js 82</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Gets the number of primitives in the collection.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</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/PrimitiveCollection.js#L44">Scene/PrimitiveCollection.js 44</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if primitives 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">(primitive, <span class="optional">index</span>)</span> → <span class="type-signature returnType">Object</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L101">Scene/PrimitiveCollection.js 101</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Adds a primitive to the collection.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to add.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>index</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The index to add the layer at. If omitted, the primitive will be added at the bottom of all existing primitives.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The primitive 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>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">const billboards = scene.primitives.add(new Cesium.BillboardCollection());</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="contains">
|
||
|
<a href="#contains" class="doc-link"></a>
|
||
|
contains<span class="signature">(<span class="optional">primitive</span>)</span> → <span class="type-signature returnType">Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L211">Scene/PrimitiveCollection.js 211</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if this collection contains a primitive.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to check for.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
<code>true</code> if the primitive is in the collection; <code>false</code> if the primitive is <code>undefined</code> or 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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#get">PrimitiveCollection#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/PrimitiveCollection.js#L463">Scene/PrimitiveCollection.js 463</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Destroys the WebGL resources held by each primitive in this collection. Explicitly destroying this
|
||
|
collection allows for deterministic release of WebGL resources, instead of relying on the garbage
|
||
|
collector to destroy this collection.
|
||
|
<br /><br />
|
||
|
Since destroying a collection destroys all the contained primitives, only destroy a collection
|
||
|
when you are sure no other code is still using any of the contained primitives.
|
||
|
<br /><br />
|
||
|
Once this collection 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">primitives = primitives && primitives.destroy();</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#isDestroyed">PrimitiveCollection#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> → <span class="type-signature returnType">Object</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L354">Scene/PrimitiveCollection.js 354</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Returns the primitive in the collection at the specified index.
|
||
|
</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>index</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The zero-based index of the primitive to return.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The primitive at the <code>index</code>.
|
||
|
</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 primitive in the collection.
|
||
|
const primitives = scene.primitives;
|
||
|
const length = primitives.length;
|
||
|
for (let i = 0; i < length; ++i) {
|
||
|
const p = primitives.get(i);
|
||
|
p.show = !p.show;
|
||
|
}</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#length">PrimitiveCollection#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> → <span class="type-signature returnType">Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L439">Scene/PrimitiveCollection.js 439</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">
|
||
|
True if this object was destroyed; otherwise, false.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#destroy">PrimitiveCollection#destroy</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="lower">
|
||
|
<a href="#lower" class="doc-link"></a>
|
||
|
lower<span class="signature">(<span class="optional">primitive</span>)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L295">Scene/PrimitiveCollection.js 295</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Lowers a primitive "down one" in the collection. If all primitives in the collection are drawn
|
||
|
on the globe surface, this visually moves the primitive down one.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to lower.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: primitive is not in this collection.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#lowerToBottom">PrimitiveCollection#lowerToBottom</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#raise">PrimitiveCollection#raise</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#raiseToTop">PrimitiveCollection#raiseToTop</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="lowerToBottom">
|
||
|
<a href="#lowerToBottom" class="doc-link"></a>
|
||
|
lowerToBottom<span class="signature">(<span class="optional">primitive</span>)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L321">Scene/PrimitiveCollection.js 321</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Lowers a primitive to the "bottom" of the collection. If all primitives in the collection are drawn
|
||
|
on the globe surface, this visually moves the primitive to the bottom.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to lower to the bottom.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: primitive is not in this collection.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#lower">PrimitiveCollection#lower</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#raise">PrimitiveCollection#raise</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#raiseToTop">PrimitiveCollection#raiseToTop</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="raise">
|
||
|
<a href="#raise" class="doc-link"></a>
|
||
|
raise<span class="signature">(<span class="optional">primitive</span>)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L243">Scene/PrimitiveCollection.js 243</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Raises a primitive "up one" in the collection. If all primitives in the collection are drawn
|
||
|
on the globe surface, this visually moves the primitive up one.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to raise.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: primitive is not in this collection.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#raiseToTop">PrimitiveCollection#raiseToTop</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#lower">PrimitiveCollection#lower</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#lowerToBottom">PrimitiveCollection#lowerToBottom</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="raiseToTop">
|
||
|
<a href="#raiseToTop" class="doc-link"></a>
|
||
|
raiseToTop<span class="signature">(<span class="optional">primitive</span>)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L269">Scene/PrimitiveCollection.js 269</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Raises a primitive to the "top" of the collection. If all primitives in the collection are drawn
|
||
|
on the globe surface, this visually moves the primitive to the top.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to raise the top.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: primitive is not in this collection.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#raise">PrimitiveCollection#raise</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#lower">PrimitiveCollection#lower</a></li>
|
||
|
|
||
|
<li><a href="PrimitiveCollection.html#lowerToBottom">PrimitiveCollection#lowerToBottom</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="remove">
|
||
|
<a href="#remove" class="doc-link"></a>
|
||
|
remove<span class="signature">(<span class="optional">primitive</span>)</span> → <span class="type-signature returnType">Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PrimitiveCollection.js#L149">Scene/PrimitiveCollection.js 149</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Removes a primitive from the collection.
|
||
|
</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>primitive</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Object</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The primitive to remove.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
<code>true</code> if the primitive was removed; <code>false</code> if the primitive is <code>undefined</code> or 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 billboards = scene.primitives.add(new Cesium.BillboardCollection());
|
||
|
scene.primitives.remove(billboards); // Returns true</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#destroyPrimitives">PrimitiveCollection#destroyPrimitives</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/PrimitiveCollection.js#L189">Scene/PrimitiveCollection.js 189</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Removes all primitives 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>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="PrimitiveCollection.html#destroyPrimitives">PrimitiveCollection#destroyPrimitives</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</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>
|