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

3226 lines
94 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>ParticleSystem - 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>
ParticleSystem
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ParticleSystem">
<a href="#ParticleSystem" class="doc-link"></a>
new Cesium.ParticleSystem<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/ParticleSystem.js#L58">Scene/ParticleSystem.js 58</a>
</div>
</h4>
</div>
<div class="description">
A ParticleSystem manages the updating and display of a collection of particles.
</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>
Whether to display the particle system.</td>
</tr>
<tr>
<td class="name"><code>updateCallback</code></td>
<td class="type">
<span class="param-type"><a href="ParticleSystem.html#.updateCallback">ParticleSystem.updateCallback</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The callback function to be called each frame to update a particle.</td>
</tr>
<tr>
<td class="name"><code>emitter</code></td>
<td class="type">
<span class="param-type"><a href="ParticleEmitter.html">ParticleEmitter</a></span>
</td>
<td class="default">
<code class="language-javascript">new CircleEmitter(0.5)</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The particle emitter for this system.</td>
</tr>
<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 the particle system from model to world coordinates.</td>
</tr>
<tr>
<td class="name"><code>emitterModelMatrix</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 the particle system emitter within the particle systems local coordinate system.</td>
</tr>
<tr>
<td class="name"><code>emissionRate</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">5</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The number of particles to emit per second.</td>
</tr>
<tr>
<td class="name"><code>bursts</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ParticleBurst.html">ParticleBurst</a>></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
An array of <a href="ParticleBurst.html"><code>ParticleBurst</code></a>, emitting bursts of particles at periodic times.</td>
</tr>
<tr>
<td class="name"><code>loop</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>
Whether the particle system should loop its bursts when it is complete.</td>
</tr>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the scale to apply to the image of the particle for the duration of its particleLife.</td>
</tr>
<tr>
<td class="name"><code>startScale</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The initial scale to apply to the image of the particle at the beginning of its life.</td>
</tr>
<tr>
<td class="name"><code>endScale</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The final scale to apply to the image of the particle at the end of its life.</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
<code class="language-javascript">Color.WHITE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the color of a particle for the duration of its particleLife.</td>
</tr>
<tr>
<td class="name"><code>startColor</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The color of the particle at the beginning of its life.</td>
</tr>
<tr>
<td class="name"><code>endColor</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The color of the particle at the end of its life.</td>
</tr>
<tr>
<td class="name"><code>image</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.</td>
</tr>
<tr>
<td class="name"><code>imageSize</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
<code class="language-javascript">new Cartesian2(1.0, 1.0)</code>
</td>
<td class="description last">
<span class="optional">optional</span>
If set, overrides the minimumImageSize and maximumImageSize inputs that scale the particle image's dimensions in pixels.</td>
</tr>
<tr>
<td class="name"><code>minimumImageSize</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels.</td>
</tr>
<tr>
<td class="name"><code>maximumImageSize</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.</td>
</tr>
<tr>
<td class="name"><code>sizeInMeters</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets if the size of particles is in meters or pixels. <code>true</code> to size the particles in meters; otherwise, the size is in pixels.</td>
</tr>
<tr>
<td class="name"><code>speed</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
If set, overrides the minimumSpeed and maximumSpeed inputs with this value.</td>
</tr>
<tr>
<td class="name"><code>minimumSpeed</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen.</td>
</tr>
<tr>
<td class="name"><code>maximumSpeed</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen.</td>
</tr>
<tr>
<td class="name"><code>lifetime</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">Number.MAX_VALUE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
How long the particle system will emit particles, in seconds.</td>
</tr>
<tr>
<td class="name"><code>particleLife</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">5.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value.</td>
</tr>
<tr>
<td class="name"><code>minimumParticleLife</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen.</td>
</tr>
<tr>
<td class="name"><code>maximumParticleLife</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen.</td>
</tr>
<tr>
<td class="name"><code>mass</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the minimum and maximum mass of particles in kilograms.</td>
</tr>
<tr>
<td class="name"><code>minimumMass</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the minimum bound for the mass of a particle in kilograms. A particle's actual mass will be chosen as a random amount above this value.</td>
</tr>
<tr>
<td class="name"><code>maximumMass</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Sets the maximum mass of particles in kilograms. A particle's actual mass will be chosen as a random amount below this value.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://cesium.com/learn/cesiumjs-learn/cesiumjs-particle-systems/">Particle Systems Tutorial</a></li>
<li><a href="https://sandcastle.cesium.com/?src=Particle%2520System.html&label=Showcases">Particle Systems Tutorial Demo</a></li>
<li><a href="https://sandcastle.cesium.com/?src=Particle%2520System%2520Fireworks.html&label=Showcases">Particle Systems Fireworks Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="bursts">
<a href="#bursts" class="doc-link"></a>
bursts<span class="type-signature"> : Array.&lt;<a href="ParticleBurst.html">ParticleBurst</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L209">Scene/ParticleSystem.js 209</a>
</div>
</h4>
</div>
<div class="description">
An array of <a href="ParticleBurst.html"><code>ParticleBurst</code></a>, emitting bursts of particles at periodic times.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="complete">
<a href="#complete" class="doc-link"></a>
complete<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/Scene/ParticleSystem.js#L522">Scene/ParticleSystem.js 522</a>
</div>
</h4>
</div>
<div class="description">
Fires an event when the particle system has reached the end of its lifetime.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="emissionRate">
<a href="#emissionRate" class="doc-link"></a>
emissionRate<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L330">Scene/ParticleSystem.js 330</a>
</div>
</h4>
</div>
<div class="description">
The number of particles to emit per second.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">5</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="emitter">
<a href="#emitter" class="doc-link"></a>
emitter<span class="type-signature"> : <a href="ParticleEmitter.html">ParticleEmitter</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L192">Scene/ParticleSystem.js 192</a>
</div>
</h4>
</div>
<div class="description">
The particle emitter for this
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">CircleEmitter</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="emitterModelMatrix">
<a href="#emitterModelMatrix" class="doc-link"></a>
emitterModelMatrix<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/ParticleSystem.js#L243">Scene/ParticleSystem.js 243</a>
</div>
</h4>
</div>
<div class="description">
The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Matrix4.IDENTITY</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="endColor">
<a href="#endColor" class="doc-link"></a>
endColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L279">Scene/ParticleSystem.js 279</a>
</div>
</h4>
</div>
<div class="description">
The color of the particle at the end of its life.
</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="endScale">
<a href="#endScale" class="doc-link"></a>
endScale<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L313">Scene/ParticleSystem.js 313</a>
</div>
</h4>
</div>
<div class="description">
The final scale to apply to the image of the particle at the end of its life.
</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="image">
<a href="#image" class="doc-link"></a>
image<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L87">Scene/ParticleSystem.js 87</a>
</div>
</h4>
</div>
<div class="description">
The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="isComplete">
<a href="#isComplete" class="doc-link"></a>
isComplete<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L532">Scene/ParticleSystem.js 532</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the particle system has reached the end of its lifetime; <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="lifetime">
<a href="#lifetime" class="doc-link"></a>
lifetime<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L506">Scene/ParticleSystem.js 506</a>
</div>
</h4>
</div>
<div class="description">
How long the particle system will emit particles, in seconds.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Number.MAX_VALUE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="loop">
<a href="#loop" class="doc-link"></a>
loop<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L80">Scene/ParticleSystem.js 80</a>
</div>
</h4>
</div>
<div class="description">
Whether the particle system should loop it's bursts when it is complete.
</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="maximumImageSize">
<a href="#maximumImageSize" class="doc-link"></a>
maximumImageSize<span class="type-signature"> : <a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L470">Scene/ParticleSystem.js 470</a>
</div>
</h4>
</div>
<div class="description">
Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Cartesian2(1.0, 1.0)</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumMass">
<a href="#maximumMass" class="doc-link"></a>
maximumMass<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L434">Scene/ParticleSystem.js 434</a>
</div>
</h4>
</div>
<div class="description">
Sets the maximum mass of particles in kilograms.
</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="maximumParticleLife">
<a href="#maximumParticleLife" class="doc-link"></a>
maximumParticleLife<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L399">Scene/ParticleSystem.js 399</a>
</div>
</h4>
</div>
<div class="description">
Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">5.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumSpeed">
<a href="#maximumSpeed" class="doc-link"></a>
maximumSpeed<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L365">Scene/ParticleSystem.js 365</a>
</div>
</h4>
</div>
<div class="description">
Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen.
</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="minimumImageSize">
<a href="#minimumImageSize" class="doc-link"></a>
minimumImageSize<span class="type-signature"> : <a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L451">Scene/ParticleSystem.js 451</a>
</div>
</h4>
</div>
<div class="description">
Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Cartesian2(1.0, 1.0)</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumMass">
<a href="#minimumMass" class="doc-link"></a>
minimumMass<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L417">Scene/ParticleSystem.js 417</a>
</div>
</h4>
</div>
<div class="description">
Sets the minimum mass of particles in kilograms.
</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="minimumParticleLife">
<a href="#minimumParticleLife" class="doc-link"></a>
minimumParticleLife<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L382">Scene/ParticleSystem.js 382</a>
</div>
</h4>
</div>
<div class="description">
Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">5.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumSpeed">
<a href="#minimumSpeed" class="doc-link"></a>
minimumSpeed<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L348">Scene/ParticleSystem.js 348</a>
</div>
</h4>
</div>
<div class="description">
Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen.
</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="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/ParticleSystem.js#L224">Scene/ParticleSystem.js 224</a>
</div>
</h4>
</div>
<div class="description">
The 4x4 transformation matrix that transforms the particle system from model to world coordinates.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Matrix4.IDENTITY</code>
</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/ParticleSystem.js#L66">Scene/ParticleSystem.js 66</a>
</div>
</h4>
</div>
<div class="description">
Whether to display the particle system.
</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="sizeInMeters">
<a href="#sizeInMeters" class="doc-link"></a>
sizeInMeters<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L489">Scene/ParticleSystem.js 489</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets if the particle size is in meters or pixels. <code>true</code> to size particles in meters; otherwise, the size is in pixels.
</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="startColor">
<a href="#startColor" class="doc-link"></a>
startColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L262">Scene/ParticleSystem.js 262</a>
</div>
</h4>
</div>
<div class="description">
The color of the particle at the beginning of its life.
</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="startScale">
<a href="#startScale" class="doc-link"></a>
startScale<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L296">Scene/ParticleSystem.js 296</a>
</div>
</h4>
</div>
<div class="description">
The initial scale to apply to the image of the particle at the beginning of its life.
</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="updateCallback">
<a href="#updateCallback" class="doc-link"></a>
updateCallback<span class="type-signature"> : <a href="ParticleSystem.html#.updateCallback">ParticleSystem.updateCallback</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L73">Scene/ParticleSystem.js 73</a>
</div>
</h4>
</div>
<div class="description">
An array of force callbacks. The callback is passed a <a href="Particle.html"><code>Particle</code></a> and the difference from the last time
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<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/ParticleSystem.js#L887">Scene/ParticleSystem.js 887</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>See:</h5>
<ul class="see-list">
<li><a href="ParticleSystem.html#isDestroyed">ParticleSystem#isDestroyed</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/ParticleSystem.js#L871">Scene/ParticleSystem.js 871</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="ParticleSystem.html#destroy">ParticleSystem#destroy</a></li>
</ul>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".updateCallback">
<a href="#.updateCallback" class="doc-link"></a>
Cesium.ParticleSystem.updateCallback<span class="signature">(particle, dt)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ParticleSystem.js#L893">Scene/ParticleSystem.js 893</a>
</div>
</h4>
</div>
<div class="description">
A function used to modify attributes of the particle at each time step. This can include force modifications,
color, sizing, etc.
</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>particle</code></td>
<td class="type">
<span class="param-type"><a href="Particle.html">Particle</a></span>
</td>
<td class="description last">
The particle being updated.</td>
</tr>
<tr>
<td class="name"><code>dt</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The time in seconds since the last update.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">function applyGravity(particle, dt) {
const position = particle.position;
const gravityVector = Cesium.Cartesian3.normalize(position, new Cesium.Cartesian3());
Cesium.Cartesian3.multiplyByScalar(gravityVector, GRAVITATIONAL_CONSTANT * dt, gravityVector);
particle.velocity = Cesium.Cartesian3.add(particle.velocity, gravityVector, particle.velocity);
}</code></pre>
</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>