ModelAnimationCollection.html 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>ModelAnimationCollection - Cesium Documentation</title>
  8. <!--[if lt IE 9]>
  9. <script src="javascript/html5.js"></script>
  10. <![endif]-->
  11. <link href="styles/jsdoc-default.css" rel="stylesheet">
  12. <link href="styles/prism.css" rel="stylesheet">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">
  17. <a href="index.html"><img src="images/CesiumLogo.png" class="cesiumLogo"></a>
  18. ModelAnimationCollection
  19. <div class="titleCenterer"></div>
  20. </h1>
  21. <section>
  22. <header>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <dt>
  27. <div class="nameContainer">
  28. <h4 class="name" id="ModelAnimationCollection">
  29. <a href="#ModelAnimationCollection" class="doc-link"></a>
  30. new Cesium.ModelAnimationCollection<span class="signature">()</span>
  31. <div class="source-link rightLinks">
  32. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L36">Scene/ModelAnimationCollection.js 36</a>
  33. </div>
  34. </h4>
  35. </div>
  36. </dt>
  37. <dd>
  38. <div class="description">
  39. A collection of active model animations. Access this using <a href="Model.html#activeAnimations"><code>Model#activeAnimations</code></a>.
  40. </div>
  41. <dl class="details">
  42. <h5>See:</h5>
  43. <ul class="see-list">
  44. <li><a href="Model.html#activeAnimations">Model#activeAnimations</a></li>
  45. </ul>
  46. </dl>
  47. </dd>
  48. </div>
  49. <h3 class="subsection-title">Members</h3>
  50. <dl>
  51. <dt>
  52. <div class="nameContainer">
  53. <h4 class="name" id="animationAdded">
  54. <a href="#animationAdded" class="doc-link"></a>
  55. animationAdded<span class="type-signature"> : <a href="Event.html">Event</a></span>
  56. <div class="source-link rightLinks">
  57. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L49">Scene/ModelAnimationCollection.js 49</a>
  58. </div>
  59. </h4>
  60. </div>
  61. </dt>
  62. <dd>
  63. <div class="description">
  64. The event fired when an animation is added to the collection. This can be used, for example, to keep a UI in sync.
  65. </div>
  66. <dl class="details">
  67. <span class="details-header">Default Value:</span>
  68. <code class="language-javascript">new Event()</code>
  69. <h5>Example:</h5>
  70. <pre><code class="language-javascript">model.activeAnimations.animationAdded.addEventListener(function(model, animation) { console.log('Animation added: ' + animation.name); });</code></pre>
  71. </dl>
  72. </dd>
  73. <dt>
  74. <div class="nameContainer">
  75. <h4 class="name" id="animationRemoved">
  76. <a href="#animationRemoved" class="doc-link"></a>
  77. animationRemoved<span class="type-signature"> : <a href="Event.html">Event</a></span>
  78. <div class="source-link rightLinks">
  79. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L63">Scene/ModelAnimationCollection.js 63</a>
  80. </div>
  81. </h4>
  82. </div>
  83. </dt>
  84. <dd>
  85. <div class="description">
  86. The event fired when an animation is removed from the collection. This can be used, for example, to keep a UI in sync.
  87. </div>
  88. <dl class="details">
  89. <span class="details-header">Default Value:</span>
  90. <code class="language-javascript">new Event()</code>
  91. <h5>Example:</h5>
  92. <pre><code class="language-javascript">model.activeAnimations.animationRemoved.addEventListener(function(model, animation) { console.log('Animation removed: ' + animation.name); });</code></pre>
  93. </dl>
  94. </dd>
  95. <dt>
  96. <div class="nameContainer">
  97. <h4 class="name" id="length">
  98. <a href="#length" class="doc-link"></a>
  99. <span class="type-signature attribute-readonly">readonly</span>length<span class="type-signature"> : Number</span>
  100. <div class="source-link rightLinks">
  101. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L79">Scene/ModelAnimationCollection.js 79</a>
  102. </div>
  103. </h4>
  104. </div>
  105. </dt>
  106. <dd>
  107. <div class="description">
  108. The number of animations in the collection.
  109. </div>
  110. <dl class="details">
  111. </dl>
  112. </dd>
  113. </dl>
  114. <h3 class="subsection-title">Methods</h3>
  115. <dl>
  116. <dt>
  117. <div class="nameContainer">
  118. <h4 class="name" id="add">
  119. <a href="#add" class="doc-link"></a>
  120. add<span class="signature">(options)</span> &rarr; <span class="type-signature returnType"><a href="ModelAnimation.html">ModelAnimation</a></span>
  121. <div class="source-link rightLinks">
  122. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L138">Scene/ModelAnimationCollection.js 138</a>
  123. </div>
  124. </h4>
  125. </div>
  126. </dt>
  127. <dd>
  128. <div class="description">
  129. Creates and adds an animation with the specified initial properties to the collection. <p> This raises the <a href="ModelAnimationCollection.html#animationAdded"><code>ModelAnimationCollection#animationAdded</code></a> event so, for example, a UI can stay in sync. </p>
  130. </div>
  131. <table class="params">
  132. <thead>
  133. <tr>
  134. <th>Name</th>
  135. <th>Type</th>
  136. <th class="last">Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td class="name"><code>options</code></td>
  142. <td class="type">
  143. <span class="param-type">Object</span>
  144. </td>
  145. <td class="description last">
  146. Object with the following properties:
  147. <table class="params">
  148. <thead>
  149. <tr>
  150. <th>Name</th>
  151. <th>Type</th>
  152. <th>Default</th>
  153. <th class="last">Description</th>
  154. </tr>
  155. </thead>
  156. <tbody>
  157. <tr>
  158. <td class="name"><code>name</code></td>
  159. <td class="type">
  160. <span class="param-type">String</span>
  161. </td>
  162. <td class="default">
  163. </td>
  164. <td class="description last">
  165. The glTF animation name that identifies the animation.</td>
  166. </tr>
  167. <tr>
  168. <td class="name"><code>startTime</code></td>
  169. <td class="type">
  170. <span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
  171. </td>
  172. <td class="default">
  173. </td>
  174. <td class="description last">
  175. <span class="optional">optional</span>
  176. The scene time to start playing the animation. When this is <code>undefined</code>, the animation starts at the next frame.</td>
  177. </tr>
  178. <tr>
  179. <td class="name"><code>delay</code></td>
  180. <td class="type">
  181. <span class="param-type">Number</span>
  182. </td>
  183. <td class="default">
  184. <code class="language-javascript">0.0</code>
  185. </td>
  186. <td class="description last">
  187. <span class="optional">optional</span>
  188. The delay, in seconds, from <code>startTime</code> to start playing.</td>
  189. </tr>
  190. <tr>
  191. <td class="name"><code>stopTime</code></td>
  192. <td class="type">
  193. <span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
  194. </td>
  195. <td class="default">
  196. </td>
  197. <td class="description last">
  198. <span class="optional">optional</span>
  199. The scene time to stop playing the animation. When this is <code>undefined</code>, the animation is played for its full duration.</td>
  200. </tr>
  201. <tr>
  202. <td class="name"><code>removeOnStop</code></td>
  203. <td class="type">
  204. <span class="param-type">Boolean</span>
  205. </td>
  206. <td class="default">
  207. <code class="language-javascript">false</code>
  208. </td>
  209. <td class="description last">
  210. <span class="optional">optional</span>
  211. When <code>true</code>, the animation is removed after it stops playing.</td>
  212. </tr>
  213. <tr>
  214. <td class="name"><code>speedup</code></td>
  215. <td class="type">
  216. <span class="param-type">Number</span>
  217. </td>
  218. <td class="default">
  219. <code class="language-javascript">1.0</code>
  220. </td>
  221. <td class="description last">
  222. <span class="optional">optional</span>
  223. Values greater than <code>1.0</code> increase the speed that the animation is played relative to the scene clock speed; values less than <code>1.0</code> decrease the speed.</td>
  224. </tr>
  225. <tr>
  226. <td class="name"><code>reverse</code></td>
  227. <td class="type">
  228. <span class="param-type">Boolean</span>
  229. </td>
  230. <td class="default">
  231. <code class="language-javascript">false</code>
  232. </td>
  233. <td class="description last">
  234. <span class="optional">optional</span>
  235. When <code>true</code>, the animation is played in reverse.</td>
  236. </tr>
  237. <tr>
  238. <td class="name"><code>loop</code></td>
  239. <td class="type">
  240. <span class="param-type"><a href="ModelAnimationLoop.html">ModelAnimationLoop</a></span>
  241. </td>
  242. <td class="default">
  243. <code class="language-javascript">ModelAnimationLoop.NONE</code>
  244. </td>
  245. <td class="description last">
  246. <span class="optional">optional</span>
  247. Determines if and how the animation is looped.</td>
  248. </tr>
  249. </tbody>
  250. </table>
  251. </td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <h5>Returns:</h5>
  256. <div class="param-desc">
  257. The animation that was added to the collection.
  258. </div>
  259. <h5>Throws:</h5>
  260. <ul>
  261. <li>
  262. <div class="param-desc">
  263. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  264. : Animations are not loaded. Wait for the <a href="Model.html#readyPromise"><code>Model#readyPromise</code></a> to resolve.
  265. </div>
  266. </li>
  267. <li>
  268. <div class="param-desc">
  269. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  270. : options.name must be a valid animation name.
  271. </div>
  272. </li>
  273. <li>
  274. <div class="param-desc">
  275. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  276. : options.speedup must be greater than zero.
  277. </div>
  278. </li>
  279. </ul>
  280. <dl class="details">
  281. <h5>Examples:</h5>
  282. <pre><code class="language-javascript">// Example 1. Add an animation model.activeAnimations.add({ name : 'animation name' });</code></pre>
  283. <pre><code class="language-javascript">// Example 2. Add an animation and provide all properties and events var startTime = Cesium.JulianDate.now(); var animation = model.activeAnimations.add({ name : 'another animation name', startTime : startTime, delay : 0.0, // Play at startTime (default) stopTime : Cesium.JulianDate.addSeconds(startTime, 4.0, new Cesium.JulianDate()), removeOnStop : false, // Do not remove when animation stops (default) speedup : 2.0, // Play at double speed reverse : true, // Play in reverse loop : Cesium.ModelAnimationLoop.REPEAT // Loop the animation }); animation.start.addEventListener(function(model, animation) { console.log('Animation started: ' + animation.name); }); animation.update.addEventListener(function(model, animation, time) { console.log('Animation updated: ' + animation.name + '. glTF animation time: ' + time); }); animation.stop.addEventListener(function(model, animation) { console.log('Animation stopped: ' + animation.name); });</code></pre>
  284. </dl>
  285. </dd>
  286. <dt>
  287. <div class="nameContainer">
  288. <h4 class="name" id="addAll">
  289. <a href="#addAll" class="doc-link"></a>
  290. addAll<span class="signature">(<span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="ModelAnimation.html">ModelAnimation</a>></span>
  291. <div class="source-link rightLinks">
  292. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L194">Scene/ModelAnimationCollection.js 194</a>
  293. </div>
  294. </h4>
  295. </div>
  296. </dt>
  297. <dd>
  298. <div class="description">
  299. Creates and adds an animation with the specified initial properties to the collection for each animation in the model. <p> This raises the <a href="ModelAnimationCollection.html#animationAdded"><code>ModelAnimationCollection#animationAdded</code></a> event for each model so, for example, a UI can stay in sync. </p>
  300. </div>
  301. <table class="params">
  302. <thead>
  303. <tr>
  304. <th>Name</th>
  305. <th>Type</th>
  306. <th class="last">Description</th>
  307. </tr>
  308. </thead>
  309. <tbody>
  310. <tr>
  311. <td class="name"><code>options</code></td>
  312. <td class="type">
  313. <span class="param-type">Object</span>
  314. </td>
  315. <td class="description last">
  316. <span class="optional">optional</span>
  317. Object with the following properties:
  318. <table class="params">
  319. <thead>
  320. <tr>
  321. <th>Name</th>
  322. <th>Type</th>
  323. <th>Default</th>
  324. <th class="last">Description</th>
  325. </tr>
  326. </thead>
  327. <tbody>
  328. <tr>
  329. <td class="name"><code>startTime</code></td>
  330. <td class="type">
  331. <span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
  332. </td>
  333. <td class="default">
  334. </td>
  335. <td class="description last">
  336. <span class="optional">optional</span>
  337. The scene time to start playing the animations. When this is <code>undefined</code>, the animations starts at the next frame.</td>
  338. </tr>
  339. <tr>
  340. <td class="name"><code>delay</code></td>
  341. <td class="type">
  342. <span class="param-type">Number</span>
  343. </td>
  344. <td class="default">
  345. <code class="language-javascript">0.0</code>
  346. </td>
  347. <td class="description last">
  348. <span class="optional">optional</span>
  349. The delay, in seconds, from <code>startTime</code> to start playing.</td>
  350. </tr>
  351. <tr>
  352. <td class="name"><code>stopTime</code></td>
  353. <td class="type">
  354. <span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
  355. </td>
  356. <td class="default">
  357. </td>
  358. <td class="description last">
  359. <span class="optional">optional</span>
  360. The scene time to stop playing the animations. When this is <code>undefined</code>, the animations are played for its full duration.</td>
  361. </tr>
  362. <tr>
  363. <td class="name"><code>removeOnStop</code></td>
  364. <td class="type">
  365. <span class="param-type">Boolean</span>
  366. </td>
  367. <td class="default">
  368. <code class="language-javascript">false</code>
  369. </td>
  370. <td class="description last">
  371. <span class="optional">optional</span>
  372. When <code>true</code>, the animations are removed after they stop playing.</td>
  373. </tr>
  374. <tr>
  375. <td class="name"><code>speedup</code></td>
  376. <td class="type">
  377. <span class="param-type">Number</span>
  378. </td>
  379. <td class="default">
  380. <code class="language-javascript">1.0</code>
  381. </td>
  382. <td class="description last">
  383. <span class="optional">optional</span>
  384. Values greater than <code>1.0</code> increase the speed that the animations play relative to the scene clock speed; values less than <code>1.0</code> decrease the speed.</td>
  385. </tr>
  386. <tr>
  387. <td class="name"><code>reverse</code></td>
  388. <td class="type">
  389. <span class="param-type">Boolean</span>
  390. </td>
  391. <td class="default">
  392. <code class="language-javascript">false</code>
  393. </td>
  394. <td class="description last">
  395. <span class="optional">optional</span>
  396. When <code>true</code>, the animations are played in reverse.</td>
  397. </tr>
  398. <tr>
  399. <td class="name"><code>loop</code></td>
  400. <td class="type">
  401. <span class="param-type"><a href="ModelAnimationLoop.html">ModelAnimationLoop</a></span>
  402. </td>
  403. <td class="default">
  404. <code class="language-javascript">ModelAnimationLoop.NONE</code>
  405. </td>
  406. <td class="description last">
  407. <span class="optional">optional</span>
  408. Determines if and how the animations are looped.</td>
  409. </tr>
  410. </tbody>
  411. </table>
  412. </td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <h5>Returns:</h5>
  417. <div class="param-desc">
  418. An array of <a href="ModelAnimation.html"><code>ModelAnimation</code></a> objects, one for each animation added to the collection. If there are no glTF animations, the array is empty.
  419. </div>
  420. <h5>Throws:</h5>
  421. <ul>
  422. <li>
  423. <div class="param-desc">
  424. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  425. : Animations are not loaded. Wait for the <a href="Model.html#readyPromise"><code>Model#readyPromise</code></a> to resolve.
  426. </div>
  427. </li>
  428. <li>
  429. <div class="param-desc">
  430. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  431. : options.speedup must be greater than zero.
  432. </div>
  433. </li>
  434. </ul>
  435. <dl class="details">
  436. <h5>Example:</h5>
  437. <pre><code class="language-javascript">model.activeAnimations.addAll({ speedup : 0.5, // Play at half-speed loop : Cesium.ModelAnimationLoop.REPEAT // Loop the animations });</code></pre>
  438. </dl>
  439. </dd>
  440. <dt>
  441. <div class="nameContainer">
  442. <h4 class="name" id="contains">
  443. <a href="#contains" class="doc-link"></a>
  444. contains<span class="signature">(animation)</span> &rarr; <span class="type-signature returnType">Boolean</span>
  445. <div class="source-link rightLinks">
  446. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L278">Scene/ModelAnimationCollection.js 278</a>
  447. </div>
  448. </h4>
  449. </div>
  450. </dt>
  451. <dd>
  452. <div class="description">
  453. Determines whether this collection contains a given animation.
  454. </div>
  455. <table class="params">
  456. <thead>
  457. <tr>
  458. <th>Name</th>
  459. <th>Type</th>
  460. <th class="last">Description</th>
  461. </tr>
  462. </thead>
  463. <tbody>
  464. <tr>
  465. <td class="name"><code>animation</code></td>
  466. <td class="type">
  467. <span class="param-type"><a href="ModelAnimation.html">ModelAnimation</a></span>
  468. </td>
  469. <td class="description last">
  470. The animation to check for.</td>
  471. </tr>
  472. </tbody>
  473. </table>
  474. <h5>Returns:</h5>
  475. <div class="param-desc">
  476. <code>true</code> if this collection contains the animation, <code>false</code> otherwise.
  477. </div>
  478. <dl class="details">
  479. </dl>
  480. </dd>
  481. <dt>
  482. <div class="nameContainer">
  483. <h4 class="name" id="get">
  484. <a href="#get" class="doc-link"></a>
  485. get<span class="signature">(index)</span> &rarr; <span class="type-signature returnType"><a href="ModelAnimation.html">ModelAnimation</a></span>
  486. <div class="source-link rightLinks">
  487. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L303">Scene/ModelAnimationCollection.js 303</a>
  488. </div>
  489. </h4>
  490. </div>
  491. </dt>
  492. <dd>
  493. <div class="description">
  494. Returns the animation in the collection at the specified index. Indices are zero-based and increase as animations are added. Removing an animation shifts all animations after it to the left, changing their indices. This function is commonly used to iterate over all the animations in the collection.
  495. </div>
  496. <table class="params">
  497. <thead>
  498. <tr>
  499. <th>Name</th>
  500. <th>Type</th>
  501. <th class="last">Description</th>
  502. </tr>
  503. </thead>
  504. <tbody>
  505. <tr>
  506. <td class="name"><code>index</code></td>
  507. <td class="type">
  508. <span class="param-type">Number</span>
  509. </td>
  510. <td class="description last">
  511. The zero-based index of the animation.</td>
  512. </tr>
  513. </tbody>
  514. </table>
  515. <h5>Returns:</h5>
  516. <div class="param-desc">
  517. The animation at the specified index.
  518. </div>
  519. <dl class="details">
  520. <h5>Example:</h5>
  521. <pre><code class="language-javascript">// Output the names of all the animations in the collection. var animations = model.activeAnimations; var length = animations.length; for (var i = 0; i &lt; length; ++i) { console.log(animations.get(i).name); }</code></pre>
  522. </dl>
  523. </dd>
  524. <dt>
  525. <div class="nameContainer">
  526. <h4 class="name" id="remove">
  527. <a href="#remove" class="doc-link"></a>
  528. remove<span class="signature">(animation)</span> &rarr; <span class="type-signature returnType">Boolean</span>
  529. <div class="source-link rightLinks">
  530. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L239">Scene/ModelAnimationCollection.js 239</a>
  531. </div>
  532. </h4>
  533. </div>
  534. </dt>
  535. <dd>
  536. <div class="description">
  537. Removes an animation from the collection. <p> This raises the <a href="ModelAnimationCollection.html#animationRemoved"><code>ModelAnimationCollection#animationRemoved</code></a> event so, for example, a UI can stay in sync. </p> <p> An animation can also be implicitly removed from the collection by setting <a href="ModelAnimation.html#removeOnStop"><code>ModelAnimation#removeOnStop</code></a> to <code>true</code>. The <a href="ModelAnimationCollection.html#animationRemoved"><code>ModelAnimationCollection#animationRemoved</code></a> event is still fired when the animation is removed. </p>
  538. </div>
  539. <table class="params">
  540. <thead>
  541. <tr>
  542. <th>Name</th>
  543. <th>Type</th>
  544. <th class="last">Description</th>
  545. </tr>
  546. </thead>
  547. <tbody>
  548. <tr>
  549. <td class="name"><code>animation</code></td>
  550. <td class="type">
  551. <span class="param-type"><a href="ModelAnimation.html">ModelAnimation</a></span>
  552. </td>
  553. <td class="description last">
  554. The animation to remove.</td>
  555. </tr>
  556. </tbody>
  557. </table>
  558. <h5>Returns:</h5>
  559. <div class="param-desc">
  560. <code>true</code> if the animation was removed; <code>false</code> if the animation was not found in the collection.
  561. </div>
  562. <dl class="details">
  563. <h5>Example:</h5>
  564. <pre><code class="language-javascript">var a = model.activeAnimations.add({ name : 'animation name' }); model.activeAnimations.remove(a); // Returns true</code></pre>
  565. </dl>
  566. </dd>
  567. <dt>
  568. <div class="nameContainer">
  569. <h4 class="name" id="removeAll">
  570. <a href="#removeAll" class="doc-link"></a>
  571. removeAll<span class="signature">()</span>
  572. <div class="source-link rightLinks">
  573. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ModelAnimationCollection.js#L260">Scene/ModelAnimationCollection.js 260</a>
  574. </div>
  575. </h4>
  576. </div>
  577. </dt>
  578. <dd>
  579. <div class="description">
  580. Removes all animations from the collection. <p> This raises the <a href="ModelAnimationCollection.html#animationRemoved"><code>ModelAnimationCollection#animationRemoved</code></a> event for each animation so, for example, a UI can stay in sync. </p>
  581. </div>
  582. <dl class="details">
  583. </dl>
  584. </dd>
  585. </dl>
  586. </article>
  587. </section>
  588. <footer>
  589. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
  590. </footer>
  591. </div>
  592. <div class="nav">
  593. <div class="menu">
  594. <input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
  595. <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="ArcGisImageServerTerrainProvider"><a href="ArcGisImageServerTerrainProvider.html">ArcGisImageServerTerrainProvider</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="CesiumInspector"><a href="CesiumInspector.html">CesiumInspector</a></li><li data-name="CesiumInspectorViewModel"><a href="CesiumInspectorViewModel.html">CesiumInspectorViewModel</a></li><li data-name="CesiumMath"><a href="CesiumMath.html">CesiumMath</a></li><li data-name="CesiumTerrainProvider"><a href="CesiumTerrainProvider.html">CesiumTerrainProvider</a></li><li data-name="CesiumWidget"><a href="CesiumWidget.html">CesiumWidget</a></li><li data-name="CheckerboardMaterialProperty"><a href="CheckerboardMaterialProperty.html">CheckerboardMaterialProperty</a></li><li data-name="CircleGeometry"><a href="CircleGeometry.html">CircleGeometry</a></li><li data-name="CircleOutlineGeometry"><a href="CircleOutlineGeometry.html">CircleOutlineGeometry</a></li><li data-name="Clock"><a href="Clock.html">Clock</a></li><li data-name="ClockRange"><a href="ClockRange.html">ClockRange</a></li><li data-name="ClockStep"><a href="ClockStep.html">ClockStep</a></li><li data-name="ClockViewModel"><a href="ClockViewModel.html">ClockViewModel</a></li><li data-name="clone"><a href="clone.html">clone</a></li><li data-name="Color"><a href="Color.html">Color</a></li><li data-name="ColorBlendMode"><a href="ColorBlendMode.html">ColorBlendMode</a></li><li data-name="ColorGeometryInstanceAttribute"><a href="ColorGeometryInstanceAttribute.html">ColorGeometryInstanceAttribute</a></li><li data-name="ColorMaterialProperty"><a href="ColorMaterialProperty.html">ColorMaterialProperty</a></li><li data-name="combine"><a href="combine.html">combine</a></li><li data-name="Command"><a href="Command.html">Command</a></li><li data-name="ComponentDatatype"><a href="ComponentDatatype.html">ComponentDatatype</a></li><li data-name="CompositeEntityCollection"><a href="CompositeEntityCollection.html">CompositeEntityCollection</a></li><li data-name="CompositeMaterialProperty"><a href="CompositeMaterialProperty.html">CompositeMaterialProperty</a></li><li data-name="CompositePositionProperty"><a href="CompositePositionProperty.html">CompositePositionProperty</a></li><li data-name="CompositeProperty"><a href="CompositeProperty.html">CompositeProperty</a></li><li data-name="ConstantPositionProperty"><a href="ConstantPositionProperty.html">ConstantPositionProperty</a></li><li data-name="ConstantProperty"><a href="ConstantProperty.html">ConstantProperty</a></li><li data-name="CornerType"><a href="CornerType.html">CornerType</a></li><li data-name="CorridorGeometry"><a href="CorridorGeometry.html">CorridorGeometry</a></li><li data-name="CorridorGeometryUpdater"><a href="CorridorGeometryUpdater.html">CorridorGeometryUpdater</a></li><li data-name="CorridorGraphics"><a href="CorridorGraphics.html">CorridorGraphics</a></li><li data-name="CorridorOutlineGeometry"><a href="CorridorOutlineGeometry.html">CorridorOutlineGeometry</a></li><li data-name="createCommand"><a href="createCommand.html">createCommand</a></li><li data-name="createGuid"><a href="createGuid.html">createGuid</a></li><li data-name="createOpenStreetMapImageryProvider"><a href="createOpenStreetMapImageryProvider.html">createOpenStreetMapImageryProvider</a></li><li data-name="createTangentSpaceDebugPrimitive"><a href="createTangentSpaceDebugPrimitive.html">createTangentSpaceDebugPrimitive</a></li><li data-name="createTaskProcessorWorker"><a href="createTaskProcessorWorker.html">createTaskProcessorWorker</a></li><li data-name="createTileMapServiceImageryProvider"><a href="createTileMapServiceImageryProvider.html">createTileMapServiceImageryProvider</a></li><li data-name="Credit"><a href="Credit.html">Credit</a></li><li data-name="CreditDisplay"><a href="CreditDisplay.html">CreditDisplay</a></li><li data-name="CubicRealPolynomial"><a href="CubicRealPolynomial.html">CubicRealPolynomial</a></li><li data-name="CullFace"><a href="CullFace.html">CullFace</a></li><li data-name="CullingVolume"><a href="CullingVolume.html">CullingVolume</a></li><li data-name="CustomDataSource"><a href="CustomDataSource.html">CustomDataSource</a></li><li data-name="CylinderGeometry"><a href="CylinderGeometry.html">CylinderGeometry</a></li><li data-name="CylinderGeometryUpdater"><a href="CylinderGeometryUpdater.html">CylinderGeometryUpdater</a></li><li data-name="CylinderGraphics"><a href="CylinderGraphics.html">CylinderGraphics</a></li><li data-name="CylinderOutlineGeometry"><a href="CylinderOutlineGeometry.html">CylinderOutlineGeometry</a></li><li data-name="CzmlDataSource"><a href="CzmlDataSource.html">CzmlDataSource</a></li><li data-name="DataSource"><a href="DataSource.html">DataSource</a></li><li data-name="DataSourceClock"><a href="DataSourceClock.html">DataSourceClock</a></li><li data-name="DataSourceCollection"><a href="DataSourceCollection.html">DataSourceCollection</a></li><li data-name="DataSourceDisplay"><a href="DataSourceDisplay.html">DataSourceDisplay</a></li><li data-name="DebugAppearance"><a href="DebugAppearance.html">DebugAppearance</a></li><li data-name="DebugCameraPrimitive"><a href="DebugCameraPrimitive.html">DebugCameraPrimitive</a></li><li data-name="DebugModelMatrixPrimitive"><a href="DebugModelMatrixPrimitive.html">DebugModelMatrixPrimitive</a></li><li data-name="DefaultProxy"><a href="DefaultProxy.html">DefaultProxy</a></li><li data-name="defaultValue"><a href="defaultValue.html">defaultValue</a></li><li data-name="defined"><a href="defined.html">defined</a></li><li data-name="DepthFunction"><a href="DepthFunction.html">DepthFunction</a></li><li data-name="destroyObject"><a href="destroyObject.html">destroyObject</a></li><li data-name="DeveloperError"><a href="DeveloperError.html">DeveloperError</a></li><li data-name="DiscardMissingTileImagePolicy"><a href="DiscardMissingTileImagePolicy.html">DiscardMissingTileImagePolicy</a></li><li data-name="DistanceDisplayCondition"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></li><li data-name="DistanceDisplayConditionGeometryInstanceAttribute"><a href="DistanceDisplayConditionGeometryInstanceAttribute.html">DistanceDisplayConditionGeometryInstanceAttribute</a></li><li data-name="DynamicGeometryUpdater"><a href="DynamicGeometryUpdater.html">DynamicGeometryUpdater</a></li><li data-name="EasingFunction"><a href="EasingFunction.html">EasingFunction</a></li><li data-name="EllipseGeometry"><a href="EllipseGeometry.html">EllipseGeometry</a></li><li data-name="EllipseGeometryUpdater"><a href="EllipseGeometryUpdater.html">EllipseGeometryUpdater</a></li><li data-name="EllipseGraphics"><a href="EllipseGraphics.html">EllipseGraphics</a></li><li data-name="EllipseOutlineGeometry"><a href="EllipseOutlineGeometry.html">EllipseOutlineGeometry</a></li><li data-name="Ellipsoid"><a href="Ellipsoid.html">Ellipsoid</a></li><li data-name="EllipsoidGeodesic"><a href="EllipsoidGeodesic.html">EllipsoidGeodesic</a></li><li data-name="EllipsoidGeometry"><a href="EllipsoidGeometry.html">EllipsoidGeometry</a></li><li data-name="EllipsoidGeometryUpdater"><a href="EllipsoidGeometryUpdater.html">EllipsoidGeometryUpdater</a></li><li data-name="EllipsoidGraphics"><a href="EllipsoidGraphics.html">EllipsoidGraphics</a></li><li data-name="EllipsoidOutlineGeometry"><a href="EllipsoidOutlineGeometry.html">EllipsoidOutlineGeometry</a></li><li data-name="EllipsoidSurfaceAppearance"><a href="EllipsoidSurfaceAppearance.html">EllipsoidSurfaceAppearance</a></li><li data-name="EllipsoidTangentPlane"><a href="EllipsoidTangentPlane.html">EllipsoidTangentPlane</a></li><li data-name="EllipsoidTerrainProvider"><a href="EllipsoidTerrainProvider.html">EllipsoidTerrainProvider</a></li><li data-name="Entity"><a href="Entity.html">Entity</a></li><li data-name="EntityCluster"><a href="EntityCluster.html">EntityCluster</a></li><li data-name="EntityCollection"><a href="EntityCollection.html">EntityCollection</a></li><li data-name="EntityView"><a href="EntityView.html">EntityView</a></li><li data-name="Event"><a href="Event.html">Event</a></li><li data-name="EventHelper"><a href="EventHelper.html">EventHelper</a></li><li data-name="ExtrapolationType"><a href="ExtrapolationType.html">ExtrapolationType</a></li><li data-name="FeatureDetection"><a href="FeatureDetection.html">FeatureDetection</a></li><li data-name="Fog"><a href="Fog.html">Fog</a></li><li data-name="formatError"><a href="formatError.html">formatError</a></li><li data-name="FrameRateMonitor"><a href="FrameRateMonitor.html">FrameRateMonitor</a></li><li data-name="Fullscreen"><a href="Fullscreen.html">Fullscreen</a></li><li data-name="FullscreenButton"><a href="FullscreenButton.html">FullscreenButton</a></li><li data-name="FullscreenButtonViewModel"><a href="FullscreenButtonViewModel.html">FullscreenButtonViewModel</a></li><li data-name="Geocoder"><a href="Geocoder.html">Geocoder</a></li><li data-name="GeocoderViewModel"><a href="GeocoderViewModel.html">GeocoderViewModel</a></li><li data-name="GeographicProjection"><a href="GeographicProjection.html">GeographicProjection</a></li><li data-name="GeographicTilingScheme"><a href="GeographicTilingScheme.html">GeographicTilingScheme</a></li><li data-name="GeoJsonDataSource"><a href="GeoJsonDataSource.html">GeoJsonDataSource</a></li><li data-name="Geometry"><a href="Geometry.html">Geometry</a></li><li data-name="GeometryAttribute"><a href="GeometryAttribute.html">GeometryAttribute</a></li><li data-name="GeometryAttributes"><a href="GeometryAttributes.html">GeometryAttributes</a></li><li data-name="GeometryInstance"><a href="GeometryInstance.html">GeometryInstance</a></li><li data-name="GeometryInstanceAttribute"><a href="GeometryInstanceAttribute.html">GeometryInstanceAttribute</a></li><li data-name="GeometryPipeline"><a href="GeometryPipeline.html">GeometryPipeline</a></li><li data-name="GeometryUpdater"><a href="GeometryUpdater.html">GeometryUpdater</a></li><li data-name="GeometryVisualizer"><a href="GeometryVisualizer.html">GeometryVisualizer</a></li><li data-name="getAbsoluteUri"><a href="getAbsoluteUri.html">getAbsoluteUri</a></li><li data-name="getBaseUri"><a href="getBaseUri.html">getBaseUri</a></li><li data-name="getExtensionFromUri"><a href="getExtensionFromUri.html">getExtensionFromUri</a></li><li data-name="GetFeatureInfoFormat"><a href="GetFeatureInfoFormat.html">GetFeatureInfoFormat</a></li><li data-name="getFilenameFromUri"><a href="getFilenameFromUri.html">getFilenameFromUri</a></li><li data-name="getImagePixels"><a href="getImagePixels.html">getImagePixels</a></li><li data-name="getTimestamp"><a href="getTimestamp.html">getTimestamp</a></li><li data-name="Globe"><a href="Globe.html">Globe</a></li><li data-name="GoogleEarthImageryProvider"><a href="GoogleEarthImageryProvider.html">GoogleEarthImageryProvider</a></li><li data-name="GregorianDate"><a href="GregorianDate.html">GregorianDate</a></li><li data-name="GridImageryProvider"><a href="GridImageryProvider.html">GridImageryProvider</a></li><li data-name="GridMaterialProperty"><a href="GridMaterialProperty.html">GridMaterialProperty</a></li><li data-name="GroundPrimitive"><a href="GroundPrimitive.html">GroundPrimitive</a></li><li data-name="HeadingPitchRange"><a href="HeadingPitchRange.html">HeadingPitchRange</a></li><li data-name="HeadingPitchRoll"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></li><li data-name="HeightmapTerrainData"><a href="HeightmapTerrainData.html">HeightmapTerrainData</a></li><li data-name="HeightReference"><a href="HeightReference.html">HeightReference</a></li><li data-name="HermitePolynomialApproximation"><a href="HermitePolynomialApproximation.html">HermitePolynomialApproximation</a></li><li data-name="HermiteSpline"><a href="HermiteSpline.html">HermiteSpline</a></li><li data-name="HomeButton"><a href="HomeButton.html">HomeButton</a></li><li data-name="HomeButtonViewModel"><a href="HomeButtonViewModel.html">HomeButtonViewModel</a></li><li data-name="HorizontalOrigin"><a href="HorizontalOrigin.html">HorizontalOrigin</a></li><li data-name="ImageMaterialProperty"><a href="ImageMaterialProperty.html">ImageMaterialProperty</a></li><li data-name="ImageryLayer"><a href="ImageryLayer.html">ImageryLayer</a></li><li data-name="ImageryLayerCollection"><a href="ImageryLayerCollection.html">ImageryLayerCollection</a></li><li data-name="ImageryLayerFeatureInfo"><a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a></li><li data-name="ImageryProvider"><a href="ImageryProvider.html">ImageryProvider</a></li><li data-name="IndexDatatype"><a href="IndexDatatype.html">IndexDatatype</a></li><li data-name="InfoBox"><a href="InfoBox.html">InfoBox</a></li><li data-name="InfoBoxViewModel"><a href="InfoBoxViewModel.html">InfoBoxViewModel</a></li><li data-name="InterpolationAlgorithm"><a href="InterpolationAlgorithm.html">InterpolationAlgorithm</a></li><li data-name="Intersect"><a href="Intersect.html">Intersect</a></li><li data-name="Intersections2D"><a href="Intersections2D.html">Intersections2D</a></li><li data-name="IntersectionTests"><a href="IntersectionTests.html">IntersectionTests</a></li><li data-name="Interval"><a href="Interval.html">Interval</a></li><li data-name="isArray"><a href="isArray.html">isArray</a></li><li data-name="isLeapYear"><a href="isLeapYear.html">isLeapYear</a></li><li data-name="Iso8601"><a href="Iso8601.html">Iso8601</a></li><li data-name="JulianDate"><a href="JulianDate.html">JulianDate</a></li><li data-name="KeyboardEventModifier"><a href="KeyboardEventModifier.html">KeyboardEventModifier</a></li><li data-name="KmlDataSource"><a href="KmlDataSource.html">KmlDataSource</a></li><li data-name="KmlFeatureData"><a href="KmlFeatureData.html">KmlFeatureData</a></li><li data-name="Label"><a href="Label.html">Label</a></li><li data-name="LabelCollection"><a href="LabelCollection.html">LabelCollection</a></li><li data-name="LabelGraphics"><a href="LabelGraphics.html">LabelGraphics</a></li><li data-name="LabelStyle"><a href="LabelStyle.html">LabelStyle</a></li><li data-name="LabelVisualizer"><a href="LabelVisualizer.html">LabelVisualizer</a></li><li data-name="LagrangePolynomialApproximation"><a href="LagrangePolynomialApproximation.html">LagrangePolynomialApproximation</a></li><li data-name="LeapSecond"><a href="LeapSecond.html">LeapSecond</a></li><li data-name="LinearApproximation"><a href="LinearApproximation.html">LinearApproximation</a></li><li data-name="LinearSpline"><a href="LinearSpline.html">LinearSpline</a></li><li data-name="loadArrayBuffer"><a href="loadArrayBuffer.html">loadArrayBuffer</a></li><li data-name="loadBlob"><a href="loadBlob.html">loadBlob</a></li><li data-name="loadImage"><a href="loadImage.html">loadImage</a></li><li data-name="loadImageViaBlob"><a href="loadImageViaBlob.html">loadImageViaBlob</a></li><li data-name="loadJson"><a href="loadJson.html">loadJson</a></li><li data-name="loadJsonp"><a href="loadJsonp.html">loadJsonp</a></li><li data-name="loadText"><a href="loadText.html">loadText</a></li><li data-name="loadWithXhr"><a href="loadWithXhr.html">loadWithXhr</a></li><li data-name="loadXML"><a href="loadXML.html">loadXML</a></li><li data-name="MapboxImageryProvider"><a href="MapboxImageryProvider.html">MapboxImageryProvider</a></li><li data-name="MapMode2D"><a href="MapMode2D.html">MapMode2D</a></li><li data-name="MapProjection"><a href="MapProjection.html">MapProjection</a></li><li data-name="Material"><a href="Material.html">Material</a></li><li data-name="MaterialAppearance"><a href="MaterialAppearance.html">MaterialAppearance</a></li><li data-name="MaterialProperty"><a href="MaterialProperty.html">MaterialProperty</a></li><li data-name="Matrix2"><a href="Matrix2.html">Matrix2</a></li><li data-name="Matrix3"><a href="Matrix3.html">Matrix3</a></li><li data-name="Matrix4"><a href="Matrix4.html">Matrix4</a></li><li data-name="mergeSort"><a href="mergeSort.html">mergeSort</a></li><li data-name="Model"><a href="Model.html">Model</a></li><li data-name="ModelAnimation"><a href="ModelAnimation.html">ModelAnimation</a></li><li data-name="ModelAnimationCollection"><a href="ModelAnimationCollection.html">ModelAnimationCollection</a></li><li data-name="ModelAnimationLoop"><a href="ModelAnimationLoop.html">ModelAnimationLoop</a></li><li data-name="ModelGraphics"><a href="ModelGraphics.html">ModelGraphics</a></li><li data-name="ModelMaterial"><a href="ModelMaterial.html">ModelMaterial</a></li><li data-name="ModelMesh"><a href="ModelMesh.html">ModelMesh</a></li><li data-name="ModelNode"><a href="ModelNode.html">ModelNode</a></li><li data-name="ModelVisualizer"><a href="ModelVisualizer.html">ModelVisualizer</a></li><li data-name="Moon"><a href="Moon.html">Moon</a></li><li data-name="NavigationHelpButton"><a href="NavigationHelpButton.html">NavigationHelpButton</a></li><li data-name="NavigationHelpButtonViewModel"><a href="NavigationHelpButtonViewModel.html">NavigationHelpButtonViewModel</a></li><li data-name="NearFarScalar"><a href="NearFarScalar.html">NearFarScalar</a></li><li data-name="NeverTileDiscardPolicy"><a href="NeverTileDiscardPolicy.html">NeverTileDiscardPolicy</a></li><li data-name="NodeTransformationProperty"><a href="NodeTransformationProperty.html">NodeTransformationProperty</a></li><li data-name="objectToQuery"><a href="objectToQuery.html">objectToQuery</a></li><li data-name="Occluder"><a href="Occluder.html">Occluder</a></li><li data-name="OrientedBoundingBox"><a href="OrientedBoundingBox.html">OrientedBoundingBox</a></li><li data-name="OrthographicFrustum"><a href="OrthographicFrustum.html">OrthographicFrustum</a></li><li data-name="Packable"><a href="Packable.html">Packable</a></li><li data-name="PackableForInterpolation"><a href="PackableForInterpolation.html">PackableForInterpolation</a></li><li data-name="PathGraphics"><a href="PathGraphics.html">PathGraphics</a></li><li data-name="PathVisualizer"><a href="PathVisualizer.html">PathVisualizer</a></li><li data-name="PerformanceWatchdog"><a href="PerformanceWatchdog.html">PerformanceWatchdog</a></li><li data-name="PerformanceWatchdogViewModel"><a href="PerformanceWatchdogViewModel.html">PerformanceWatchdogViewModel</a></li><li data-name="PerInstanceColorAppearance"><a href="PerInstanceColorAppearance.html">PerInstanceColorAppearance</a></li><li data-name="PerspectiveFrustum"><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li><li data-name="PerspectiveOffCenterFrustum"><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li><li data-name="PinBuilder"><a href="PinBuilder.html">PinBuilder</a></li><li data-name="PixelFormat"><a href="PixelFormat.html">PixelFormat</a></li><li data-name="Plane"><a href="Plane.html">Plane</a></li><li data-name="PointGraphics"><a href="PointGraphics.html">PointGraphics</a></li><li data-name="pointInsideTriangle"><a href="pointInsideTriangle.html">pointInsideTriangle</a></li><li data-name="PointPrimitive"><a href="PointPrimitive.html">PointPrimitive</a></li><li data-name="PointPrimitiveCollection"><a href="PointPrimitiveCollection.html">PointPrimitiveCollection</a></li><li data-name="PointVisualizer"><a href="PointVisualizer.html">PointVisualizer</a></li><li data-name="PolygonGeometry"><a href="PolygonGeometry.html">PolygonGeometry</a></li><li data-name="PolygonGeometryUpdater"><a href="PolygonGeometryUpdater.html">PolygonGeometryUpdater</a></li><li data-name="PolygonGraphics"><a href="PolygonGraphics.html">PolygonGraphics</a></li><li data-name="PolygonHierarchy"><a href="PolygonHierarchy.html">PolygonHierarchy</a></li><li data-name="PolygonOutlineGeometry"><a href="PolygonOutlineGeometry.html">PolygonOutlineGeometry</a></li><li data-name="Polyline"><a href="Polyline.html">Polyline</a></li><li data-name="PolylineArrowMaterialProperty"><a href="PolylineArrowMaterialProperty.html">PolylineArrowMaterialProperty</a></li><li data-name="PolylineCollection"><a href="PolylineCollection.html">PolylineCollection</a></li><li data-name="PolylineColorAppearance"><a href="PolylineColorAppearance.html">PolylineColorAppearance</a></li><li data-name="PolylineGeometry"><a href="PolylineGeometry.html">PolylineGeometry</a></li><li data-name="PolylineGeometryUpdater"><a href="PolylineGeometryUpdater.html">PolylineGeometryUpdater</a></li><li data-name="PolylineGlowMaterialProperty"><a href="PolylineGlowMaterialProperty.html">PolylineGlowMaterialProperty</a></li><li data-name="PolylineGraphics"><a href="PolylineGraphics.html">PolylineGraphics</a></li><li data-name="PolylineMaterialAppearance"><a href="PolylineMaterialAppearance.html">PolylineMaterialAppearance</a></li><li data-name="PolylineOutlineMaterialProperty"><a href="PolylineOutlineMaterialProperty.html">PolylineOutlineMaterialProperty</a></li><li data-name="PolylineVolumeGeometry"><a href="PolylineVolumeGeometry.html">PolylineVolumeGeometry</a></li><li data-name="PolylineVolumeGeometryUpdater"><a href="PolylineVolumeGeometryUpdater.html">PolylineVolumeGeometryUpdater</a></li><li data-name="PolylineVolumeGraphics"><a href="PolylineVolumeGraphics.html">PolylineVolumeGraphics</a></li><li data-name="PolylineVolumeOutlineGeometry"><a href="PolylineVolumeOutlineGeometry.html">PolylineVolumeOutlineGeometry</a></li><li data-name="PositionProperty"><a href="PositionProperty.html">PositionProperty</a></li><li data-name="PositionPropertyArray"><a href="PositionPropertyArray.html">PositionPropertyArray</a></li><li data-name="Primitive"><a href="Primitive.html">Primitive</a></li><li data-name="PrimitiveCollection"><a href="PrimitiveCollection.html">PrimitiveCollection</a></li><li data-name="PrimitiveType"><a href="PrimitiveType.html">PrimitiveType</a></li><li data-name="Property"><a href="Property.html">Property</a></li><li data-name="PropertyArray"><a href="PropertyArray.html">PropertyArray</a></li><li data-name="PropertyBag"><a href="PropertyBag.html">PropertyBag</a></li><li data-name="ProviderViewModel"><a href="ProviderViewModel.html">ProviderViewModel</a></li><li data-name="QuadraticRealPolynomial"><a href="QuadraticRealPolynomial.html">QuadraticRealPolynomial</a></li><li data-name="QuantizedMeshTerrainData"><a href="QuantizedMeshTerrainData.html">QuantizedMeshTerrainData</a></li><li data-name="QuarticRealPolynomial"><a href="QuarticRealPolynomial.html">QuarticRealPolynomial</a></li><li data-name="Quaternion"><a href="Quaternion.html">Quaternion</a></li><li data-name="QuaternionSpline"><a href="QuaternionSpline.html">QuaternionSpline</a></li><li data-name="queryToObject"><a href="queryToObject.html">queryToObject</a></li><li data-name="Queue"><a href="Queue.html">Queue</a></li><li data-name="Ray"><a href="Ray.html">Ray</a></li><li data-name="Rectangle"><a href="Rectangle.html">Rectangle</a></li><li data-name="RectangleGeometry"><a href="RectangleGeometry.html">RectangleGeometry</a></li><li data-name="RectangleGeometryUpdater"><a href="RectangleGeometryUpdater.html">RectangleGeometryUpdater</a></li><li data-name="RectangleGraphics"><a href="RectangleGraphics.html">RectangleGraphics</a></li><li data-name="RectangleOutlineGeometry"><a href="RectangleOutlineGeometry.html">RectangleOutlineGeometry</a></li><li data-name="ReferenceFrame"><a href="ReferenceFrame.html">ReferenceFrame</a></li><li data-name="ReferenceProperty"><a href="ReferenceProperty.html">ReferenceProperty</a></li><li data-name="requestAnimationFrame"><a href="requestAnimationFrame.html">requestAnimationFrame</a></li><li data-name="RequestErrorEvent"><a href="RequestErrorEvent.html">RequestErrorEvent</a></li><li data-name="Rotation"><a href="Rotation.html">Rotation</a></li><li data-name="RuntimeError"><a href="RuntimeError.html">RuntimeError</a></li><li data-name="SampledPositionProperty"><a href="SampledPositionProperty.html">SampledPositionProperty</a></li><li data-name="SampledProperty"><a href="SampledProperty.html">SampledProperty</a></li><li data-name="sampleTerrain"><a href="sampleTerrain.html">sampleTerrain</a></li><li data-name="Scene"><a href="Scene.html">Scene</a></li><li data-name="SceneMode"><a href="SceneMode.html">SceneMode</a></li><li data-name="SceneModePicker"><a href="SceneModePicker.html">SceneModePicker</a></li><li data-name="SceneModePickerViewModel"><a href="SceneModePickerViewModel.html">SceneModePickerViewModel</a></li><li data-name="SceneTransforms"><a href="SceneTransforms.html">SceneTransforms</a></li><li data-name="ScreenSpaceCameraController"><a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></li><li data-name="ScreenSpaceEventHandler"><a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></li><li data-name="ScreenSpaceEventType"><a href="ScreenSpaceEventType.html">ScreenSpaceEventType</a></li><li data-name="SelectionIndicator"><a href="SelectionIndicator.html">SelectionIndicator</a></li><li data-name="SelectionIndicatorViewModel"><a href="SelectionIndicatorViewModel.html">SelectionIndicatorViewModel</a></li><li data-name="ShadowMap"><a href="ShadowMap.html">ShadowMap</a></li><li data-name="ShadowMode"><a href="ShadowMode.html">ShadowMode</a></li><li data-name="ShowGeometryInstanceAttribute"><a href="ShowGeometryInstanceAttribute.html">ShowGeometryInstanceAttribute</a></li><li data-name="Simon1994PlanetaryPositions"><a href="Simon1994PlanetaryPositions.html">Simon1994PlanetaryPositions</a></li><li data-name="SimplePolylineGeometry"><a href="SimplePolylineGeometry.html">SimplePolylineGeometry</a></li><li data-name="SingleTileImageryProvider"><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li><li data-name="SkyAtmosphere"><a href="SkyAtmosphere.html">SkyAtmosphere</a></li><li data-name="SkyBox"><a href="SkyBox.html">SkyBox</a></li><li data-name="SphereGeometry"><a href="SphereGeometry.html">SphereGeometry</a></li><li data-name="SphereOutlineGeometry"><a href="SphereOutlineGeometry.html">SphereOutlineGeometry</a></li><li data-name="Spherical"><a href="Spherical.html">Spherical</a></li><li data-name="Spline"><a href="Spline.html">Spline</a></li><li data-name="StencilFunction"><a href="StencilFunction.html">StencilFunction</a></li><li data-name="StencilOperation"><a href="StencilOperation.html">StencilOperation</a></li><li data-name="StripeMaterialProperty"><a href="StripeMaterialProperty.html">StripeMaterialProperty</a></li><li data-name="StripeOrientation"><a href="StripeOrientation.html">StripeOrientation</a></li><li data-name="subdivideArray"><a href="subdivideArray.html">subdivideArray</a></li><li data-name="Sun"><a href="Sun.html">Sun</a></li><li data-name="SvgPathBindingHandler"><a href="SvgPathBindingHandler.html">SvgPathBindingHandler</a></li><li data-name="TaskProcessor"><a href="TaskProcessor.html">TaskProcessor</a></li><li data-name="TerrainData"><a href="TerrainData.html">TerrainData</a></li><li data-name="TerrainProvider"><a href="TerrainProvider.html">TerrainProvider</a></li><li data-name="throttleRequestByServer"><a href="throttleRequestByServer.html">throttleRequestByServer</a></li><li data-name="TileCoordinatesImageryProvider"><a href="TileCoordinatesImageryProvider.html">TileCoordinatesImageryProvider</a></li><li data-name="TileDiscardPolicy"><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></li><li data-name="TileProviderError"><a href="TileProviderError.html">TileProviderError</a></li><li data-name="TilingScheme"><a href="TilingScheme.html">TilingScheme</a></li><li data-name="TimeInterval"><a href="TimeInterval.html">TimeInterval</a></li><li data-name="TimeIntervalCollection"><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></li><li data-name="TimeIntervalCollectionPositionProperty"><a href="TimeIntervalCollectionPositionProperty.html">TimeIntervalCollectionPositionProperty</a></li><li data-name="TimeIntervalCollectionProperty"><a href="TimeIntervalCollectionProperty.html">TimeIntervalCollectionProperty</a></li><li data-name="Timeline"><a href="Timeline.html">Timeline</a></li><li data-name="TimeStandard"><a href="TimeStandard.html">TimeStandard</a></li><li data-name="ToggleButtonViewModel"><a href="ToggleButtonViewModel.html">ToggleButtonViewModel</a></li><li data-name="Transforms"><a href="Transforms.html">Transforms</a></li><li data-name="TranslationRotationScale"><a href="TranslationRotationScale.html">TranslationRotationScale</a></li><li data-name="TridiagonalSystemSolver"><a href="TridiagonalSystemSolver.html">TridiagonalSystemSolver</a></li><li data-name="TrustedServers"><a href="TrustedServers.html">TrustedServers</a></li><li data-name="UrlTemplateImageryProvider"><a href="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li><li data-name="VelocityOrientationProperty"><a href="VelocityOrientationProperty.html">VelocityOrientationProperty</a></li><li data-name="VelocityVectorProperty"><a href="VelocityVectorProperty.html">VelocityVectorProperty</a></li><li data-name="VertexFormat"><a href="VertexFormat.html">VertexFormat</a></li><li data-name="VerticalOrigin"><a href="VerticalOrigin.html">VerticalOrigin</a></li><li data-name="VideoSynchronizer"><a href="VideoSynchronizer.html">VideoSynchronizer</a></li><li data-name="Viewer"><a href="Viewer.html">Viewer</a></li><li data-name="viewerCesiumInspectorMixin"><a href="viewerCesiumInspectorMixin.html">viewerCesiumInspectorMixin</a></li><li data-name="viewerDragDropMixin"><a href="viewerDragDropMixin.html">viewerDragDropMixin</a></li><li data-name="viewerPerformanceWatchdogMixin"><a href="viewerPerformanceWatchdogMixin.html">viewerPerformanceWatchdogMixin</a></li><li data-name="ViewportQuad"><a href="ViewportQuad.html">ViewportQuad</a></li><li data-name="Visibility"><a href="Visibility.html">Visibility</a></li><li data-name="Visualizer"><a href="Visualizer.html">Visualizer</a></li><li data-name="VRButton"><a href="VRButton.html">VRButton</a></li><li data-name="VRButtonViewModel"><a href="VRButtonViewModel.html">VRButtonViewModel</a></li><li data-name="VRTheWorldTerrainProvider"><a href="VRTheWorldTerrainProvider.html">VRTheWorldTerrainProvider</a></li><li data-name="WallGeometry"><a href="WallGeometry.html">WallGeometry</a></li><li data-name="WallGeometryUpdater"><a href="WallGeometryUpdater.html">WallGeometryUpdater</a></li><li data-name="WallGraphics"><a href="WallGraphics.html">WallGraphics</a></li><li data-name="WallOutlineGeometry"><a href="WallOutlineGeometry.html">WallOutlineGeometry</a></li><li data-name="WebGLConstants"><a href="WebGLConstants.html">WebGLConstants</a></li><li data-name="WebMapServiceImageryProvider"><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li data-name="WebMapTileServiceImageryProvider"><a href="WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li><li data-name="WebMercatorProjection"><a href="WebMercatorProjection.html">WebMercatorProjection</a></li><li data-name="WebMercatorTilingScheme"><a href="WebMercatorTilingScheme.html">WebMercatorTilingScheme</a></li><li data-name="WindingOrder"><a href="WindingOrder.html">WindingOrder</a></li></ul>
  596. </div>
  597. </div>
  598. <script>
  599. if (window.frameElement) {
  600. document.body.className = 'embedded';
  601. var ele = document.createElement('a');
  602. ele.className = 'popout';
  603. ele.target = '_blank';
  604. ele.href = window.location.href;
  605. ele.title = 'Pop out';
  606. document.getElementById('main').appendChild(ele);
  607. }
  608. // Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
  609. Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
  610. if (/^https?:/i.test(a.getAttribute('href'))) {
  611. a.target='_blank';
  612. }
  613. });
  614. </script>
  615. <script src="javascript/prism.js"></script>
  616. <script src="javascript/cesiumDoc.js"></script>
  617. </body>
  618. </html>