ScreenSpaceCameraController.html 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872
  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>ScreenSpaceCameraController - 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. ScreenSpaceCameraController
  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="ScreenSpaceCameraController">
  29. <a href="#ScreenSpaceCameraController" class="doc-link"></a>
  30. new Cesium.ScreenSpaceCameraController<span class="signature">(scene)</span>
  31. <div class="source-link rightLinks">
  32. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L63">Scene/ScreenSpaceCameraController.js 63</a>
  33. </div>
  34. </h4>
  35. </div>
  36. </dt>
  37. <dd>
  38. <div class="description">
  39. Modifies the camera position and orientation based on mouse input to a canvas.
  40. </div>
  41. <table class="params">
  42. <thead>
  43. <tr>
  44. <th>Name</th>
  45. <th>Type</th>
  46. <th class="last">Description</th>
  47. </tr>
  48. </thead>
  49. <tbody>
  50. <tr>
  51. <td class="name"><code>scene</code></td>
  52. <td class="type">
  53. <span class="param-type"><a href="Scene.html">Scene</a></span>
  54. </td>
  55. <td class="description last">
  56. The scene.</td>
  57. </tr>
  58. </tbody>
  59. </table>
  60. <dl class="details">
  61. </dl>
  62. </dd>
  63. </div>
  64. <h3 class="subsection-title">Members</h3>
  65. <dl>
  66. <dt>
  67. <div class="nameContainer">
  68. <h4 class="name" id="bounceAnimationTime">
  69. <a href="#bounceAnimationTime" class="doc-link"></a>
  70. bounceAnimationTime<span class="type-signature"> : Number</span>
  71. <div class="source-link rightLinks">
  72. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L154">Scene/ScreenSpaceCameraController.js 154</a>
  73. </div>
  74. </h4>
  75. </div>
  76. </dt>
  77. <dd>
  78. <div class="description">
  79. Sets the duration, in seconds, of the bounce back animations in 2D and Columbus view.
  80. </div>
  81. <dl class="details">
  82. <span class="details-header">Default Value:</span>
  83. <code class="language-javascript">3.0</code>
  84. </dl>
  85. </dd>
  86. <dt>
  87. <div class="nameContainer">
  88. <h4 class="name" id="enableCollisionDetection">
  89. <a href="#enableCollisionDetection" class="doc-link"></a>
  90. enableCollisionDetection<span class="type-signature"> : Boolean</span>
  91. <div class="source-link rightLinks">
  92. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L264">Scene/ScreenSpaceCameraController.js 264</a>
  93. </div>
  94. </h4>
  95. </div>
  96. </dt>
  97. <dd>
  98. <div class="description">
  99. Enables or disables camera collision detection with terrain.
  100. </div>
  101. <dl class="details">
  102. <span class="details-header">Default Value:</span>
  103. <code class="language-javascript">true</code>
  104. </dl>
  105. </dd>
  106. <dt>
  107. <div class="nameContainer">
  108. <h4 class="name" id="enableInputs">
  109. <a href="#enableInputs" class="doc-link"></a>
  110. enableInputs<span class="type-signature"> : Boolean</span>
  111. <div class="source-link rightLinks">
  112. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L82">Scene/ScreenSpaceCameraController.js 82</a>
  113. </div>
  114. </h4>
  115. </div>
  116. </dt>
  117. <dd>
  118. <div class="description">
  119. If true, inputs are allowed conditionally with the flags enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook. If false, all inputs are disabled. NOTE: This setting is for temporary use cases, such as camera flights and drag-selection of regions (see Picking demo). It is typically set to false at the start of such events, and set true on completion. To keep inputs disabled past the end of camera flights, you must use the other booleans (enableTranslate, enableZoom, enableRotate, enableTilt, and enableLook).
  120. </div>
  121. <dl class="details">
  122. <span class="details-header">Default Value:</span>
  123. <code class="language-javascript">true</code>
  124. </dl>
  125. </dd>
  126. <dt>
  127. <div class="nameContainer">
  128. <h4 class="name" id="enableLook">
  129. <a href="#enableLook" class="doc-link"></a>
  130. enableLook<span class="type-signature"> : Boolean</span>
  131. <div class="source-link rightLinks">
  132. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L116">Scene/ScreenSpaceCameraController.js 116</a>
  133. </div>
  134. </h4>
  135. </div>
  136. </dt>
  137. <dd>
  138. <div class="description">
  139. If true, allows the user to use free-look. If false, the camera view direction can only be changed through translating or rotating. This flag only applies in 3D and Columbus view modes.
  140. </div>
  141. <dl class="details">
  142. <span class="details-header">Default Value:</span>
  143. <code class="language-javascript">true</code>
  144. </dl>
  145. </dd>
  146. <dt>
  147. <div class="nameContainer">
  148. <h4 class="name" id="enableRotate">
  149. <a href="#enableRotate" class="doc-link"></a>
  150. enableRotate<span class="type-signature"> : Boolean</span>
  151. <div class="source-link rightLinks">
  152. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L102">Scene/ScreenSpaceCameraController.js 102</a>
  153. </div>
  154. </h4>
  155. </div>
  156. </dt>
  157. <dd>
  158. <div class="description">
  159. If true, allows the user to rotate the camera. If false, the camera is locked to the current heading. This flag only applies in 2D and 3D.
  160. </div>
  161. <dl class="details">
  162. <span class="details-header">Default Value:</span>
  163. <code class="language-javascript">true</code>
  164. </dl>
  165. </dd>
  166. <dt>
  167. <div class="nameContainer">
  168. <h4 class="name" id="enableTilt">
  169. <a href="#enableTilt" class="doc-link"></a>
  170. enableTilt<span class="type-signature"> : Boolean</span>
  171. <div class="source-link rightLinks">
  172. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L109">Scene/ScreenSpaceCameraController.js 109</a>
  173. </div>
  174. </h4>
  175. </div>
  176. </dt>
  177. <dd>
  178. <div class="description">
  179. If true, allows the user to tilt the camera. If false, the camera is locked to the current heading. This flag only applies in 3D and Columbus view.
  180. </div>
  181. <dl class="details">
  182. <span class="details-header">Default Value:</span>
  183. <code class="language-javascript">true</code>
  184. </dl>
  185. </dd>
  186. <dt>
  187. <div class="nameContainer">
  188. <h4 class="name" id="enableTranslate">
  189. <a href="#enableTranslate" class="doc-link"></a>
  190. enableTranslate<span class="type-signature"> : Boolean</span>
  191. <div class="source-link rightLinks">
  192. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L89">Scene/ScreenSpaceCameraController.js 89</a>
  193. </div>
  194. </h4>
  195. </div>
  196. </dt>
  197. <dd>
  198. <div class="description">
  199. If true, allows the user to pan around the map. If false, the camera stays locked at the current position. This flag only applies in 2D and Columbus view modes.
  200. </div>
  201. <dl class="details">
  202. <span class="details-header">Default Value:</span>
  203. <code class="language-javascript">true</code>
  204. </dl>
  205. </dd>
  206. <dt>
  207. <div class="nameContainer">
  208. <h4 class="name" id="enableZoom">
  209. <a href="#enableZoom" class="doc-link"></a>
  210. enableZoom<span class="type-signature"> : Boolean</span>
  211. <div class="source-link rightLinks">
  212. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L95">Scene/ScreenSpaceCameraController.js 95</a>
  213. </div>
  214. </h4>
  215. </div>
  216. </dt>
  217. <dd>
  218. <div class="description">
  219. If true, allows the user to zoom in and out. If false, the camera is locked to the current distance from the ellipsoid.
  220. </div>
  221. <dl class="details">
  222. <span class="details-header">Default Value:</span>
  223. <code class="language-javascript">true</code>
  224. </dl>
  225. </dd>
  226. <dt>
  227. <div class="nameContainer">
  228. <h4 class="name" id="inertiaSpin">
  229. <a href="#inertiaSpin" class="doc-link"></a>
  230. inertiaSpin<span class="type-signature"> : Number</span>
  231. <div class="source-link rightLinks">
  232. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L124">Scene/ScreenSpaceCameraController.js 124</a>
  233. </div>
  234. </h4>
  235. </div>
  236. </dt>
  237. <dd>
  238. <div class="description">
  239. A parameter in the range <code>[0, 1)</code> used to determine how long the camera will continue to spin because of inertia. With value of zero, the camera will have no inertia.
  240. </div>
  241. <dl class="details">
  242. <span class="details-header">Default Value:</span>
  243. <code class="language-javascript">0.9</code>
  244. </dl>
  245. </dd>
  246. <dt>
  247. <div class="nameContainer">
  248. <h4 class="name" id="inertiaTranslate">
  249. <a href="#inertiaTranslate" class="doc-link"></a>
  250. inertiaTranslate<span class="type-signature"> : Number</span>
  251. <div class="source-link rightLinks">
  252. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L132">Scene/ScreenSpaceCameraController.js 132</a>
  253. </div>
  254. </h4>
  255. </div>
  256. </dt>
  257. <dd>
  258. <div class="description">
  259. A parameter in the range <code>[0, 1)</code> used to determine how long the camera will continue to translate because of inertia. With value of zero, the camera will have no inertia.
  260. </div>
  261. <dl class="details">
  262. <span class="details-header">Default Value:</span>
  263. <code class="language-javascript">0.9</code>
  264. </dl>
  265. </dd>
  266. <dt>
  267. <div class="nameContainer">
  268. <h4 class="name" id="inertiaZoom">
  269. <a href="#inertiaZoom" class="doc-link"></a>
  270. inertiaZoom<span class="type-signature"> : Number</span>
  271. <div class="source-link rightLinks">
  272. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L140">Scene/ScreenSpaceCameraController.js 140</a>
  273. </div>
  274. </h4>
  275. </div>
  276. </dt>
  277. <dd>
  278. <div class="description">
  279. A parameter in the range <code>[0, 1)</code> used to determine how long the camera will continue to zoom because of inertia. With value of zero, the camera will have no inertia.
  280. </div>
  281. <dl class="details">
  282. <span class="details-header">Default Value:</span>
  283. <code class="language-javascript">0.8</code>
  284. </dl>
  285. </dd>
  286. <dt>
  287. <div class="nameContainer">
  288. <h4 class="name" id="lookEventTypes">
  289. <a href="#lookEventTypes" class="doc-link"></a>
  290. lookEventTypes<span class="type-signature"> : <a href="CameraEventType.html">CameraEventType</a>|Array|undefined</span>
  291. <div class="source-link rightLinks">
  292. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L233">Scene/ScreenSpaceCameraController.js 233</a>
  293. </div>
  294. </h4>
  295. </div>
  296. </dt>
  297. <dd>
  298. <div class="description">
  299. The input that allows the user to change the direction the camera is viewing. This only applies in 3D and Columbus view modes. <p> The type came be a <a href="CameraEventType.html"><code>CameraEventType</code></a>, <code>undefined</code>, an object with <code>eventType</code> and <code>modifier</code> properties with types <code>CameraEventType</code> and <a href="KeyboardEventModifier.html"><code>KeyboardEventModifier</code></a>, or an array of any of the preceding. </p>
  300. </div>
  301. <dl class="details">
  302. <span class="details-header">Default Value:</span>
  303. <code class="language-javascript">{ eventType : <a href="CameraEventType.html#.LEFT_DRAG"><code>CameraEventType.LEFT_DRAG</code></a>, modifier : <a href="KeyboardEventModifier.html#.SHIFT"><code>KeyboardEventModifier.SHIFT</code></a> }</code>
  304. </dl>
  305. </dd>
  306. <dt>
  307. <div class="nameContainer">
  308. <h4 class="name" id="maximumMovementRatio">
  309. <a href="#maximumMovementRatio" class="doc-link"></a>
  310. maximumMovementRatio<span class="type-signature"> : Number</span>
  311. <div class="source-link rightLinks">
  312. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L148">Scene/ScreenSpaceCameraController.js 148</a>
  313. </div>
  314. </h4>
  315. </div>
  316. </dt>
  317. <dd>
  318. <div class="description">
  319. A parameter in the range <code>[0, 1)</code> used to limit the range of various user inputs to a percentage of the window width/height per animation frame. This helps keep the camera under control in low-frame-rate situations.
  320. </div>
  321. <dl class="details">
  322. <span class="details-header">Default Value:</span>
  323. <code class="language-javascript">0.1</code>
  324. </dl>
  325. </dd>
  326. <dt>
  327. <div class="nameContainer">
  328. <h4 class="name" id="maximumZoomDistance">
  329. <a href="#maximumZoomDistance" class="doc-link"></a>
  330. maximumZoomDistance<span class="type-signature"> : Number</span>
  331. <div class="source-link rightLinks">
  332. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L166">Scene/ScreenSpaceCameraController.js 166</a>
  333. </div>
  334. </h4>
  335. </div>
  336. </dt>
  337. <dd>
  338. <div class="description">
  339. The maximum magnitude, in meters, of the camera position when zooming. Defaults to positive infinity.
  340. </div>
  341. <dl class="details">
  342. <span class="details-header">Default Value:</span>
  343. <code class="language-javascript"><code>Number.POSITIVE_INFINITY</code></code>
  344. </dl>
  345. </dd>
  346. <dt>
  347. <div class="nameContainer">
  348. <h4 class="name" id="minimumCollisionTerrainHeight">
  349. <a href="#minimumCollisionTerrainHeight" class="doc-link"></a>
  350. minimumCollisionTerrainHeight<span class="type-signature"> : Number</span>
  351. <div class="source-link rightLinks">
  352. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L249">Scene/ScreenSpaceCameraController.js 249</a>
  353. </div>
  354. </h4>
  355. </div>
  356. </dt>
  357. <dd>
  358. <div class="description">
  359. The minimum height the camera must be before testing for collision with terrain.
  360. </div>
  361. <dl class="details">
  362. <span class="details-header">Default Value:</span>
  363. <code class="language-javascript">10000.0</code>
  364. </dl>
  365. </dd>
  366. <dt>
  367. <div class="nameContainer">
  368. <h4 class="name" id="minimumPickingTerrainHeight">
  369. <a href="#minimumPickingTerrainHeight" class="doc-link"></a>
  370. minimumPickingTerrainHeight<span class="type-signature"> : Number</span>
  371. <div class="source-link rightLinks">
  372. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L242">Scene/ScreenSpaceCameraController.js 242</a>
  373. </div>
  374. </h4>
  375. </div>
  376. </dt>
  377. <dd>
  378. <div class="description">
  379. The minimum height the camera must be before picking the terrain instead of the ellipsoid.
  380. </div>
  381. <dl class="details">
  382. <span class="details-header">Default Value:</span>
  383. <code class="language-javascript">150000.0</code>
  384. </dl>
  385. </dd>
  386. <dt>
  387. <div class="nameContainer">
  388. <h4 class="name" id="minimumTrackBallHeight">
  389. <a href="#minimumTrackBallHeight" class="doc-link"></a>
  390. minimumTrackBallHeight<span class="type-signature"> : Number</span>
  391. <div class="source-link rightLinks">
  392. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L257">Scene/ScreenSpaceCameraController.js 257</a>
  393. </div>
  394. </h4>
  395. </div>
  396. </dt>
  397. <dd>
  398. <div class="description">
  399. The minimum height the camera must be before switching from rotating a track ball to free look when clicks originate on the sky on in space.
  400. </div>
  401. <dl class="details">
  402. <span class="details-header">Default Value:</span>
  403. <code class="language-javascript">7500000.0</code>
  404. </dl>
  405. </dd>
  406. <dt>
  407. <div class="nameContainer">
  408. <h4 class="name" id="minimumZoomDistance">
  409. <a href="#minimumZoomDistance" class="doc-link"></a>
  410. minimumZoomDistance<span class="type-signature"> : Number</span>
  411. <div class="source-link rightLinks">
  412. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L160">Scene/ScreenSpaceCameraController.js 160</a>
  413. </div>
  414. </h4>
  415. </div>
  416. </dt>
  417. <dd>
  418. <div class="description">
  419. The minimum magnitude, in meters, of the camera position when zooming. Defaults to 1.0.
  420. </div>
  421. <dl class="details">
  422. <span class="details-header">Default Value:</span>
  423. <code class="language-javascript">1.0</code>
  424. </dl>
  425. </dd>
  426. <dt>
  427. <div class="nameContainer">
  428. <h4 class="name" id="rotateEventTypes">
  429. <a href="#rotateEventTypes" class="doc-link"></a>
  430. rotateEventTypes<span class="type-signature"> : <a href="CameraEventType.html">CameraEventType</a>|Array|undefined</span>
  431. <div class="source-link rightLinks">
  432. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L199">Scene/ScreenSpaceCameraController.js 199</a>
  433. </div>
  434. </h4>
  435. </div>
  436. </dt>
  437. <dd>
  438. <div class="description">
  439. The input that allows the user to rotate around the globe or another object. This only applies in 3D and Columbus view modes. <p> The type came be a <a href="CameraEventType.html"><code>CameraEventType</code></a>, <code>undefined</code>, an object with <code>eventType</code> and <code>modifier</code> properties with types <code>CameraEventType</code> and <a href="KeyboardEventModifier.html"><code>KeyboardEventModifier</code></a>, or an array of any of the preceding. </p>
  440. </div>
  441. <dl class="details">
  442. <span class="details-header">Default Value:</span>
  443. <code class="language-javascript"><a href="CameraEventType.html#.LEFT_DRAG"><code>CameraEventType.LEFT_DRAG</code></a></code>
  444. </dl>
  445. </dd>
  446. <dt>
  447. <div class="nameContainer">
  448. <h4 class="name" id="tiltEventTypes">
  449. <a href="#tiltEventTypes" class="doc-link"></a>
  450. tiltEventTypes<span class="type-signature"> : <a href="CameraEventType.html">CameraEventType</a>|Array|undefined</span>
  451. <div class="source-link rightLinks">
  452. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L216">Scene/ScreenSpaceCameraController.js 216</a>
  453. </div>
  454. </h4>
  455. </div>
  456. </dt>
  457. <dd>
  458. <div class="description">
  459. The input that allows the user to tilt in 3D and Columbus view or twist in 2D. <p> The type came be a <a href="CameraEventType.html"><code>CameraEventType</code></a>, <code>undefined</code>, an object with <code>eventType</code> and <code>modifier</code> properties with types <code>CameraEventType</code> and <a href="KeyboardEventModifier.html"><code>KeyboardEventModifier</code></a>, or an array of any of the preceding. </p>
  460. </div>
  461. <dl class="details">
  462. <span class="details-header">Default Value:</span>
  463. <code class="language-javascript">[<a href="CameraEventType.html#.MIDDLE_DRAG"><code>CameraEventType.MIDDLE_DRAG</code></a>, <a href="CameraEventType.html#.PINCH"><code>CameraEventType.PINCH</code></a>, { eventType : <a href="CameraEventType.html#.LEFT_DRAG"><code>CameraEventType.LEFT_DRAG</code></a>, modifier : <a href="KeyboardEventModifier.html#.CTRL"><code>KeyboardEventModifier.CTRL</code></a> }, { eventType : <a href="CameraEventType.html#.RIGHT_DRAG"><code>CameraEventType.RIGHT_DRAG</code></a>, modifier : <a href="KeyboardEventModifier.html#.CTRL"><code>KeyboardEventModifier.CTRL</code></a> }]</code>
  464. </dl>
  465. </dd>
  466. <dt>
  467. <div class="nameContainer">
  468. <h4 class="name" id="translateEventTypes">
  469. <a href="#translateEventTypes" class="doc-link"></a>
  470. translateEventTypes<span class="type-signature"> : <a href="CameraEventType.html">CameraEventType</a>|Array|undefined</span>
  471. <div class="source-link rightLinks">
  472. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L177">Scene/ScreenSpaceCameraController.js 177</a>
  473. </div>
  474. </h4>
  475. </div>
  476. </dt>
  477. <dd>
  478. <div class="description">
  479. The input that allows the user to pan around the map. This only applies in 2D and Columbus view modes. <p> The type came be a <a href="CameraEventType.html"><code>CameraEventType</code></a>, <code>undefined</code>, an object with <code>eventType</code> and <code>modifier</code> properties with types <code>CameraEventType</code> and <a href="KeyboardEventModifier.html"><code>KeyboardEventModifier</code></a>, or an array of any of the preceding. </p>
  480. </div>
  481. <dl class="details">
  482. <span class="details-header">Default Value:</span>
  483. <code class="language-javascript"><a href="CameraEventType.html#.LEFT_DRAG"><code>CameraEventType.LEFT_DRAG</code></a></code>
  484. </dl>
  485. </dd>
  486. <dt>
  487. <div class="nameContainer">
  488. <h4 class="name" id="zoomEventTypes">
  489. <a href="#zoomEventTypes" class="doc-link"></a>
  490. zoomEventTypes<span class="type-signature"> : <a href="CameraEventType.html">CameraEventType</a>|Array|undefined</span>
  491. <div class="source-link rightLinks">
  492. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L188">Scene/ScreenSpaceCameraController.js 188</a>
  493. </div>
  494. </h4>
  495. </div>
  496. </dt>
  497. <dd>
  498. <div class="description">
  499. The input that allows the user to zoom in/out. <p> The type came be a <a href="CameraEventType.html"><code>CameraEventType</code></a>, <code>undefined</code>, an object with <code>eventType</code> and <code>modifier</code> properties with types <code>CameraEventType</code> and <a href="KeyboardEventModifier.html"><code>KeyboardEventModifier</code></a>, or an array of any of the preceding. </p>
  500. </div>
  501. <dl class="details">
  502. <span class="details-header">Default Value:</span>
  503. <code class="language-javascript">[<a href="CameraEventType.html#.RIGHT_DRAG"><code>CameraEventType.RIGHT_DRAG</code></a>, <a href="CameraEventType.html#.WHEEL"><code>CameraEventType.WHEEL</code></a>, <a href="CameraEventType.html#.PINCH"><code>CameraEventType.PINCH</code></a>]</code>
  504. </dl>
  505. </dd>
  506. </dl>
  507. <h3 class="subsection-title">Methods</h3>
  508. <dl>
  509. <dt>
  510. <div class="nameContainer">
  511. <h4 class="name" id="destroy">
  512. <a href="#destroy" class="doc-link"></a>
  513. destroy<span class="signature">()</span> &rarr; <span class="type-signature returnType">undefined</span>
  514. <div class="source-link rightLinks">
  515. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L1940">Scene/ScreenSpaceCameraController.js 1940</a>
  516. </div>
  517. </h4>
  518. </div>
  519. </dt>
  520. <dd>
  521. <div class="description">
  522. Removes mouse listeners held by 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.
  523. </div>
  524. <h5>Returns:</h5>
  525. <h5>Throws:</h5>
  526. <ul>
  527. <li>
  528. <div class="param-desc">
  529. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  530. : This object was destroyed, i.e., destroy() was called.
  531. </div>
  532. </li>
  533. </ul>
  534. <dl class="details">
  535. <h5>Example:</h5>
  536. <pre><code class="language-javascript">controller = controller &amp;&amp; controller.destroy();</code></pre>
  537. <h5>See:</h5>
  538. <ul class="see-list">
  539. <li><a href="ScreenSpaceCameraController.html#isDestroyed">ScreenSpaceCameraController#isDestroyed</a></li>
  540. </ul>
  541. </dl>
  542. </dd>
  543. <dt>
  544. <div class="nameContainer">
  545. <h4 class="name" id="isDestroyed">
  546. <a href="#isDestroyed" class="doc-link"></a>
  547. isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
  548. <div class="source-link rightLinks">
  549. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/ScreenSpaceCameraController.js#L1919">Scene/ScreenSpaceCameraController.js 1919</a>
  550. </div>
  551. </h4>
  552. </div>
  553. </dt>
  554. <dd>
  555. <div class="description">
  556. 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.
  557. </div>
  558. <h5>Returns:</h5>
  559. <div class="param-desc">
  560. <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  561. </div>
  562. <dl class="details">
  563. <h5>See:</h5>
  564. <ul class="see-list">
  565. <li><a href="ScreenSpaceCameraController.html#destroy">ScreenSpaceCameraController#destroy</a></li>
  566. </ul>
  567. </dl>
  568. </dd>
  569. </dl>
  570. </article>
  571. </section>
  572. <footer>
  573. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
  574. </footer>
  575. </div>
  576. <div class="nav">
  577. <div class="menu">
  578. <input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
  579. <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>
  580. </div>
  581. </div>
  582. <script>
  583. if (window.frameElement) {
  584. document.body.className = 'embedded';
  585. var ele = document.createElement('a');
  586. ele.className = 'popout';
  587. ele.target = '_blank';
  588. ele.href = window.location.href;
  589. ele.title = 'Pop out';
  590. document.getElementById('main').appendChild(ele);
  591. }
  592. // Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
  593. Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
  594. if (/^https?:/i.test(a.getAttribute('href'))) {
  595. a.target='_blank';
  596. }
  597. });
  598. </script>
  599. <script src="javascript/prism.js"></script>
  600. <script src="javascript/cesiumDoc.js"></script>
  601. </body>
  602. </html>