Scene.html 109 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000
  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>Scene - 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. Scene
  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="Scene">
  29. <a href="#Scene" class="doc-link"></a>
  30. new Cesium.Scene<span class="signature">(<span class="optional">options</span>)</span>
  31. <div class="source-link rightLinks">
  32. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L206">Scene/Scene.js 206</a>
  33. </div>
  34. </h4>
  35. </div>
  36. </dt>
  37. <dd>
  38. <div class="description">
  39. The container for all 3D graphical objects and state in a Cesium virtual scene. Generally, a scene is not created directly; instead, it is implicitly created by <a href="CesiumWidget.html"><code>CesiumWidget</code></a>. <p> <em><code>contextOptions</code> parameter details:</em> </p> <p> The default values are: <code> { webgl : { alpha : false, depth : true, stencil : false, antialias : true, premultipliedAlpha : true, preserveDrawingBuffer : false, failIfMajorPerformanceCaveat : false }, allowTextureFilterAnisotropic : true } </code> </p> <p> The <code>webgl</code> property corresponds to the <a href="http://www.khronos.org/registry/webgl/specs/latest/#5.2">WebGLContextAttributes</a> object used to create the WebGL context. </p> <p> <code>webgl.alpha</code> defaults to false, which can improve performance compared to the standard WebGL default of true. If an application needs to composite Cesium above other HTML elements using alpha-blending, set <code>webgl.alpha</code> to true. </p> <p> The other <code>webgl</code> properties match the WebGL defaults for <a href="http://www.khronos.org/registry/webgl/specs/latest/#5.2">WebGLContextAttributes</a>. </p> <p> <code>allowTextureFilterAnisotropic</code> defaults to true, which enables anisotropic texture filtering when the WebGL extension is supported. Setting this to false will improve performance, but hurt visual quality, especially for horizon views. </p>
  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>options</code></td>
  52. <td class="type">
  53. <span class="param-type">Object</span>
  54. </td>
  55. <td class="description last">
  56. <span class="optional">optional</span>
  57. Object with the following properties:
  58. <table class="params">
  59. <thead>
  60. <tr>
  61. <th>Name</th>
  62. <th>Type</th>
  63. <th>Default</th>
  64. <th class="last">Description</th>
  65. </tr>
  66. </thead>
  67. <tbody>
  68. <tr>
  69. <td class="name"><code>canvas</code></td>
  70. <td class="type">
  71. <span class="param-type">Canvas</span>
  72. </td>
  73. <td class="default">
  74. </td>
  75. <td class="description last">
  76. The HTML canvas element to create the scene for.</td>
  77. </tr>
  78. <tr>
  79. <td class="name"><code>contextOptions</code></td>
  80. <td class="type">
  81. <span class="param-type">Object</span>
  82. </td>
  83. <td class="default">
  84. </td>
  85. <td class="description last">
  86. <span class="optional">optional</span>
  87. Context and WebGL creation properties. See details above.</td>
  88. </tr>
  89. <tr>
  90. <td class="name"><code>creditContainer</code></td>
  91. <td class="type">
  92. <span class="param-type">Element</span>
  93. </td>
  94. <td class="default">
  95. </td>
  96. <td class="description last">
  97. <span class="optional">optional</span>
  98. The HTML element in which the credits will be displayed.</td>
  99. </tr>
  100. <tr>
  101. <td class="name"><code>mapProjection</code></td>
  102. <td class="type">
  103. <span class="param-type"><a href="MapProjection.html">MapProjection</a></span>
  104. </td>
  105. <td class="default">
  106. <code class="language-javascript">new GeographicProjection()</code>
  107. </td>
  108. <td class="description last">
  109. <span class="optional">optional</span>
  110. The map projection to use in 2D and Columbus View modes.</td>
  111. </tr>
  112. <tr>
  113. <td class="name"><code>orderIndependentTranslucency</code></td>
  114. <td class="type">
  115. <span class="param-type">Boolean</span>
  116. </td>
  117. <td class="default">
  118. <code class="language-javascript">true</code>
  119. </td>
  120. <td class="description last">
  121. <span class="optional">optional</span>
  122. If true and the configuration supports it, use order independent translucency.</td>
  123. </tr>
  124. <tr>
  125. <td class="name"><code>scene3DOnly</code></td>
  126. <td class="type">
  127. <span class="param-type">Boolean</span>
  128. </td>
  129. <td class="default">
  130. <code class="language-javascript">false</code>
  131. </td>
  132. <td class="description last">
  133. <span class="optional">optional</span>
  134. If true, optimizes memory use and performance for 3D mode but disables the ability to use 2D or Columbus View.</td>
  135. </tr>
  136. <tr>
  137. <td class="name"><code>terrainExaggeration</code></td>
  138. <td class="type">
  139. <span class="param-type">Number</span>
  140. </td>
  141. <td class="default">
  142. <code class="language-javascript">1.0</code>
  143. </td>
  144. <td class="description last">
  145. <span class="optional">optional</span>
  146. A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.</td>
  147. </tr>
  148. <tr>
  149. <td class="name"><code>shadows</code></td>
  150. <td class="type">
  151. <span class="param-type">Boolean</span>
  152. </td>
  153. <td class="default">
  154. <code class="language-javascript">false</code>
  155. </td>
  156. <td class="description last">
  157. <span class="optional">optional</span>
  158. Determines if shadows are cast by the sun.</td>
  159. </tr>
  160. <tr>
  161. <td class="name"><code>mapMode2D</code></td>
  162. <td class="type">
  163. <span class="param-type"><a href="MapMode2D.html">MapMode2D</a></span>
  164. </td>
  165. <td class="default">
  166. <code class="language-javascript">MapMode2D.INFINITE_SCROLL</code>
  167. </td>
  168. <td class="description last">
  169. <span class="optional">optional</span>
  170. Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.</td>
  171. </tr>
  172. </tbody>
  173. </table>
  174. </td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <h5>Throws:</h5>
  179. <ul>
  180. <li>
  181. <div class="param-desc">
  182. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  183. : options and options.canvas are required.
  184. </div>
  185. </li>
  186. </ul>
  187. <dl class="details">
  188. <h5>Example:</h5>
  189. <pre><code class="language-javascript">// Create scene without anisotropic texture filtering var scene = new Cesium.Scene({ canvas : canvas, contextOptions : { allowTextureFilterAnisotropic : false } });</code></pre>
  190. <h5>See:</h5>
  191. <ul class="see-list">
  192. <li><a href="CesiumWidget.html">CesiumWidget</a></li>
  193. <li><a href="http://www.khronos.org/registry/webgl/specs/latest/#5.2">WebGLContextAttributes</a></li>
  194. </ul>
  195. </dl>
  196. </dd>
  197. </div>
  198. <h3 class="subsection-title">Members</h3>
  199. <dl>
  200. <dt>
  201. <div class="nameContainer">
  202. <h4 class="name" id="backgroundColor">
  203. <a href="#backgroundColor" class="doc-link"></a>
  204. backgroundColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
  205. <div class="source-link rightLinks">
  206. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L389">Scene/Scene.js 389</a>
  207. </div>
  208. </h4>
  209. </div>
  210. </dt>
  211. <dd>
  212. <div class="description">
  213. The background color, which is only visible if there is no sky box, i.e., <a href="Scene.html#skyBox"><code>Scene#skyBox</code></a> is undefined.
  214. </div>
  215. <dl class="details">
  216. <span class="details-header">Default Value:</span>
  217. <code class="language-javascript"><a href="Color.html#.BLACK"><code>Color.BLACK</code></a></code>
  218. <h5>See:</h5>
  219. <ul class="see-list">
  220. <li><a href="Scene.html#skyBox">Scene#skyBox</a></li>
  221. </ul>
  222. </dl>
  223. </dd>
  224. <dt>
  225. <div class="nameContainer">
  226. <h4 class="name" id="camera">
  227. <a href="#camera" class="doc-link"></a>
  228. <span class="type-signature attribute-readonly">readonly</span>camera<span class="type-signature"> : <a href="Camera.html">Camera</a></span>
  229. <div class="source-link rightLinks">
  230. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L761">Scene/Scene.js 761</a>
  231. </div>
  232. </h4>
  233. </div>
  234. </dt>
  235. <dd>
  236. <div class="description">
  237. Gets the camera.
  238. </div>
  239. <dl class="details">
  240. </dl>
  241. </dd>
  242. <dt>
  243. <div class="nameContainer">
  244. <h4 class="name" id="canvas">
  245. <a href="#canvas" class="doc-link"></a>
  246. <span class="type-signature attribute-readonly">readonly</span>canvas<span class="type-signature"> : Canvas</span>
  247. <div class="source-link rightLinks">
  248. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L632">Scene/Scene.js 632</a>
  249. </div>
  250. </h4>
  251. </div>
  252. </dt>
  253. <dd>
  254. <div class="description">
  255. Gets the canvas element to which this scene is bound.
  256. </div>
  257. <dl class="details">
  258. </dl>
  259. </dd>
  260. <dt>
  261. <div class="nameContainer">
  262. <h4 class="name" id="completeMorphOnUserInput">
  263. <a href="#completeMorphOnUserInput" class="doc-link"></a>
  264. completeMorphOnUserInput<span class="type-signature"> : Boolean</span>
  265. <div class="source-link rightLinks">
  266. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L322">Scene/Scene.js 322</a>
  267. </div>
  268. </h4>
  269. </div>
  270. </dt>
  271. <dd>
  272. <div class="description">
  273. Determines whether or not to instantly complete the scene transition animation on user input.
  274. </div>
  275. <dl class="details">
  276. <span class="details-header">Default Value:</span>
  277. <code class="language-javascript">true</code>
  278. </dl>
  279. </dd>
  280. <dt>
  281. <div class="nameContainer">
  282. <h4 class="name" id="debugCommandFilter">
  283. <a href="#debugCommandFilter" class="doc-link"></a>
  284. debugCommandFilter<span class="type-signature"> : function</span>
  285. <div class="source-link rightLinks">
  286. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L447">Scene/Scene.js 447</a>
  287. </div>
  288. </h4>
  289. </div>
  290. </dt>
  291. <dd>
  292. <div class="description">
  293. This property is for debugging only; it is not for production use. <p> A function that determines what commands are executed. As shown in the examples below, the function receives the command's <code>owner</code> as an argument, and returns a boolean indicating if the command should be executed. </p> <p> The default is <code>undefined</code>, indicating that all commands are executed. </p>
  294. </div>
  295. <dl class="details">
  296. <span class="details-header">Default Value:</span>
  297. <code class="language-javascript">undefined</code>
  298. <h5>Example:</h5>
  299. <pre><code class="language-javascript">// Do not execute any commands. scene.debugCommandFilter = function(command) { return false; }; // Execute only the billboard's commands. That is, only draw the billboard. var billboards = new Cesium.BillboardCollection(); scene.debugCommandFilter = function(command) { return command.owner === billboards; };</code></pre>
  300. </dl>
  301. </dd>
  302. <dt>
  303. <div class="nameContainer">
  304. <h4 class="name" id="debugFrustumStatistics">
  305. <a href="#debugFrustumStatistics" class="doc-link"></a>
  306. <span class="type-signature attribute-readonly">readonly</span>debugFrustumStatistics<span class="type-signature"> : Object</span>
  307. <div class="source-link rightLinks">
  308. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L941">Scene/Scene.js 941</a>
  309. </div>
  310. </h4>
  311. </div>
  312. </dt>
  313. <dd>
  314. <div class="description">
  315. This property is for debugging only; it is not for production use. <p> When <code>Scene.debugShowFrustums</code> is <code>true</code>, this contains properties with statistics about the number of command execute per frustum. <code>totalCommands</code> is the total number of commands executed, ignoring overlap. <code>commandsInFrustums</code> is an array with the number of times commands are executed redundantly, e.g., how many commands overlap two or three frustums. </p>
  316. </div>
  317. <dl class="details">
  318. <span class="details-header">Default Value:</span>
  319. <code class="language-javascript">undefined</code>
  320. </dl>
  321. </dd>
  322. <dt>
  323. <div class="nameContainer">
  324. <h4 class="name" id="debugShowCommands">
  325. <a href="#debugShowCommands" class="doc-link"></a>
  326. debugShowCommands<span class="type-signature"> : Boolean</span>
  327. <div class="source-link rightLinks">
  328. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L461">Scene/Scene.js 461</a>
  329. </div>
  330. </h4>
  331. </div>
  332. </dt>
  333. <dd>
  334. <div class="description">
  335. This property is for debugging only; it is not for production use. <p> When <code>true</code>, commands are randomly shaded. This is useful for performance analysis to see what parts of a scene or model are command-dense and could benefit from batching. </p>
  336. </div>
  337. <dl class="details">
  338. <span class="details-header">Default Value:</span>
  339. <code class="language-javascript">false</code>
  340. </dl>
  341. </dd>
  342. <dt>
  343. <div class="nameContainer">
  344. <h4 class="name" id="debugShowDepthFrustum">
  345. <a href="#debugShowDepthFrustum" class="doc-link"></a>
  346. debugShowDepthFrustum<span class="type-signature"> : Number</span>
  347. <div class="source-link rightLinks">
  348. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L516">Scene/Scene.js 516</a>
  349. </div>
  350. </h4>
  351. </div>
  352. </dt>
  353. <dd>
  354. <div class="description">
  355. This property is for debugging only; it is not for production use. <p> Indicates which frustum will have depth information displayed. </p>
  356. </div>
  357. <dl class="details">
  358. <span class="details-header">Default Value:</span>
  359. <code class="language-javascript">1</code>
  360. </dl>
  361. </dd>
  362. <dt>
  363. <div class="nameContainer">
  364. <h4 class="name" id="debugShowFramesPerSecond">
  365. <a href="#debugShowFramesPerSecond" class="doc-link"></a>
  366. debugShowFramesPerSecond<span class="type-signature"> : Boolean</span>
  367. <div class="source-link rightLinks">
  368. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L492">Scene/Scene.js 492</a>
  369. </div>
  370. </h4>
  371. </div>
  372. </dt>
  373. <dd>
  374. <div class="description">
  375. This property is for debugging only; it is not for production use. <p> Displays frames per second and time between frames. </p>
  376. </div>
  377. <dl class="details">
  378. <span class="details-header">Default Value:</span>
  379. <code class="language-javascript">false</code>
  380. </dl>
  381. </dd>
  382. <dt>
  383. <div class="nameContainer">
  384. <h4 class="name" id="debugShowFrustums">
  385. <a href="#debugShowFrustums" class="doc-link"></a>
  386. debugShowFrustums<span class="type-signature"> : Boolean</span>
  387. <div class="source-link rightLinks">
  388. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L478">Scene/Scene.js 478</a>
  389. </div>
  390. </h4>
  391. </div>
  392. </dt>
  393. <dd>
  394. <div class="description">
  395. This property is for debugging only; it is not for production use. <p> When <code>true</code>, commands are shaded based on the frustums they overlap. Commands in the closest frustum are tinted red, commands in the next closest are green, and commands in the farthest frustum are blue. If a command overlaps more than one frustum, the color components are combined, e.g., a command overlapping the first two frustums is tinted yellow. </p>
  396. </div>
  397. <dl class="details">
  398. <span class="details-header">Default Value:</span>
  399. <code class="language-javascript">false</code>
  400. </dl>
  401. </dd>
  402. <dt>
  403. <div class="nameContainer">
  404. <h4 class="name" id="debugShowGlobeDepth">
  405. <a href="#debugShowGlobeDepth" class="doc-link"></a>
  406. debugShowGlobeDepth<span class="type-signature"> : Boolean</span>
  407. <div class="source-link rightLinks">
  408. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L504">Scene/Scene.js 504</a>
  409. </div>
  410. </h4>
  411. </div>
  412. </dt>
  413. <dd>
  414. <div class="description">
  415. This property is for debugging only; it is not for production use. <p> Displays depth information for the indicated frustum. </p>
  416. </div>
  417. <dl class="details">
  418. <span class="details-header">Default Value:</span>
  419. <code class="language-javascript">false</code>
  420. </dl>
  421. </dd>
  422. <dt>
  423. <div class="nameContainer">
  424. <h4 class="name" id="drawingBufferHeight">
  425. <a href="#drawingBufferHeight" class="doc-link"></a>
  426. <span class="type-signature attribute-readonly">readonly</span>drawingBufferHeight<span class="type-signature"> : Number</span>
  427. <div class="source-link rightLinks">
  428. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L647">Scene/Scene.js 647</a>
  429. </div>
  430. </h4>
  431. </div>
  432. </dt>
  433. <dd>
  434. <div class="description">
  435. The drawingBufferWidth of the underlying GL context.
  436. </div>
  437. <dl class="details">
  438. <h5>See:</h5>
  439. <ul class="see-list">
  440. <li><a href="https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferWidth">drawingBufferWidth</a></li>
  441. </ul>
  442. </dl>
  443. </dd>
  444. <dt>
  445. <div class="nameContainer">
  446. <h4 class="name" id="drawingBufferWidth">
  447. <a href="#drawingBufferWidth" class="doc-link"></a>
  448. <span class="type-signature attribute-readonly">readonly</span>drawingBufferWidth<span class="type-signature"> : Number</span>
  449. <div class="source-link rightLinks">
  450. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L662">Scene/Scene.js 662</a>
  451. </div>
  452. </h4>
  453. </div>
  454. </dt>
  455. <dd>
  456. <div class="description">
  457. The drawingBufferHeight of the underlying GL context.
  458. </div>
  459. <dl class="details">
  460. <h5>See:</h5>
  461. <ul class="see-list">
  462. <li><a href="https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferHeight">drawingBufferHeight</a></li>
  463. </ul>
  464. </dl>
  465. </dd>
  466. <dt>
  467. <div class="nameContainer">
  468. <h4 class="name" id="farToNearRatio">
  469. <a href="#farToNearRatio" class="doc-link"></a>
  470. farToNearRatio<span class="type-signature"> : Number</span>
  471. <div class="source-link rightLinks">
  472. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L409">Scene/Scene.js 409</a>
  473. </div>
  474. </h4>
  475. </div>
  476. </dt>
  477. <dd>
  478. <div class="description">
  479. The far-to-near ratio of the multi-frustum. The default is 1,000.0.
  480. </div>
  481. <dl class="details">
  482. <span class="details-header">Default Value:</span>
  483. <code class="language-javascript">1000.0</code>
  484. </dl>
  485. </dd>
  486. <dt>
  487. <div class="nameContainer">
  488. <h4 class="name" id="fog">
  489. <a href="#fog" class="doc-link"></a>
  490. fog<span class="type-signature"> : <a href="Fog.html">Fog</a></span>
  491. <div class="source-link rightLinks">
  492. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L556">Scene/Scene.js 556</a>
  493. </div>
  494. </h4>
  495. </div>
  496. </dt>
  497. <dd>
  498. <div class="description">
  499. Blends the atmosphere to geometry far from the camera for horizon views. Allows for additional performance improvements by rendering less geometry and dispatching less terrain requests.
  500. </div>
  501. <dl class="details">
  502. </dl>
  503. </dd>
  504. <dt>
  505. <div class="nameContainer">
  506. <h4 class="name" id="fxaa">
  507. <a href="#fxaa" class="doc-link"></a>
  508. fxaa<span class="type-signature"> : Boolean</span>
  509. <div class="source-link rightLinks">
  510. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L525">Scene/Scene.js 525</a>
  511. </div>
  512. </h4>
  513. </div>
  514. </dt>
  515. <dd>
  516. <div class="description">
  517. When <code>true</code>, enables Fast Approximate Anti-aliasing even when order independent translucency is unsupported.
  518. </div>
  519. <dl class="details">
  520. <span class="details-header">Default Value:</span>
  521. <code class="language-javascript">true</code>
  522. </dl>
  523. </dd>
  524. <dt>
  525. <div class="nameContainer">
  526. <h4 class="name" id="globe">
  527. <a href="#globe" class="doc-link"></a>
  528. globe<span class="type-signature"> : <a href="Globe.html">Globe</a></span>
  529. <div class="source-link rightLinks">
  530. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L717">Scene/Scene.js 717</a>
  531. </div>
  532. </h4>
  533. </div>
  534. </dt>
  535. <dd>
  536. <div class="description">
  537. Gets or sets the depth-test ellipsoid.
  538. </div>
  539. <dl class="details">
  540. </dl>
  541. </dd>
  542. <dt>
  543. <div class="nameContainer">
  544. <h4 class="name" id="groundPrimitives">
  545. <a href="#groundPrimitives" class="doc-link"></a>
  546. <span class="type-signature attribute-readonly">readonly</span>groundPrimitives<span class="type-signature"> : <a href="PrimitiveCollection.html">PrimitiveCollection</a></span>
  547. <div class="source-link rightLinks">
  548. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L748">Scene/Scene.js 748</a>
  549. </div>
  550. </h4>
  551. </div>
  552. </dt>
  553. <dd>
  554. <div class="description">
  555. Gets the collection of ground primitives.
  556. </div>
  557. <dl class="details">
  558. </dl>
  559. </dd>
  560. <dt>
  561. <div class="nameContainer">
  562. <h4 class="name" id="id">
  563. <a href="#id" class="doc-link"></a>
  564. <span class="type-signature attribute-readonly">readonly</span>id<span class="type-signature"> : String</span>
  565. <div class="source-link rightLinks">
  566. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L979">Scene/Scene.js 979</a>
  567. </div>
  568. </h4>
  569. </div>
  570. </dt>
  571. <dd>
  572. <div class="description">
  573. Gets the unique identifier for this scene.
  574. </div>
  575. <dl class="details">
  576. </dl>
  577. </dd>
  578. <dt>
  579. <div class="nameContainer">
  580. <h4 class="name" id="imageryLayers">
  581. <a href="#imageryLayers" class="doc-link"></a>
  582. <span class="type-signature attribute-readonly">readonly</span>imageryLayers<span class="type-signature"> : <a href="ImageryLayerCollection.html">ImageryLayerCollection</a></span>
  583. <div class="source-link rightLinks">
  584. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L834">Scene/Scene.js 834</a>
  585. </div>
  586. </h4>
  587. </div>
  588. </dt>
  589. <dd>
  590. <div class="description">
  591. Gets the collection of image layers that will be rendered on the globe.
  592. </div>
  593. <dl class="details">
  594. </dl>
  595. </dd>
  596. <dt>
  597. <div class="nameContainer">
  598. <h4 class="name" id="mapMode2D">
  599. <a href="#mapMode2D" class="doc-link"></a>
  600. mapMode2D<span class="type-signature"> : Boolean</span>
  601. <div class="source-link rightLinks">
  602. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L1077">Scene/Scene.js 1077</a>
  603. </div>
  604. </h4>
  605. </div>
  606. </dt>
  607. <dd>
  608. <div class="description">
  609. Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
  610. </div>
  611. <dl class="details">
  612. </dl>
  613. </dd>
  614. <dt>
  615. <div class="nameContainer">
  616. <h4 class="name" id="mapProjection">
  617. <a href="#mapProjection" class="doc-link"></a>
  618. <span class="type-signature attribute-readonly">readonly</span>mapProjection<span class="type-signature"> : <a href="MapProjection.html">MapProjection</a></span>
  619. <div class="source-link rightLinks">
  620. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L790">Scene/Scene.js 790</a>
  621. </div>
  622. </h4>
  623. </div>
  624. </dt>
  625. <dd>
  626. <div class="description">
  627. Get the map projection to use in 2D and Columbus View modes.
  628. </div>
  629. <dl class="details">
  630. <span class="details-header">Default Value:</span>
  631. <code class="language-javascript">new GeographicProjection()</code>
  632. </dl>
  633. </dd>
  634. <dt>
  635. <div class="nameContainer">
  636. <h4 class="name" id="maximumAliasedLineWidth">
  637. <a href="#maximumAliasedLineWidth" class="doc-link"></a>
  638. <span class="type-signature attribute-readonly">readonly</span>maximumAliasedLineWidth<span class="type-signature"> : Number</span>
  639. <div class="source-link rightLinks">
  640. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L677">Scene/Scene.js 677</a>
  641. </div>
  642. </h4>
  643. </div>
  644. </dt>
  645. <dd>
  646. <div class="description">
  647. The maximum aliased line width, in pixels, supported by this WebGL implementation. It will be at least one.
  648. </div>
  649. <dl class="details">
  650. <h5>See:</h5>
  651. <ul class="see-list">
  652. <li><a href="https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml">glGet</a> with <code>ALIASED_LINE_WIDTH_RANGE</code>.</li>
  653. </ul>
  654. </dl>
  655. </dd>
  656. <dt>
  657. <div class="nameContainer">
  658. <h4 class="name" id="maximumCubeMapSize">
  659. <a href="#maximumCubeMapSize" class="doc-link"></a>
  660. <span class="type-signature attribute-readonly">readonly</span>maximumCubeMapSize<span class="type-signature"> : Number</span>
  661. <div class="source-link rightLinks">
  662. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L692">Scene/Scene.js 692</a>
  663. </div>
  664. </h4>
  665. </div>
  666. </dt>
  667. <dd>
  668. <div class="description">
  669. The maximum length in pixels of one edge of a cube map, supported by this WebGL implementation. It will be at least 16.
  670. </div>
  671. <dl class="details">
  672. <h5>See:</h5>
  673. <ul class="see-list">
  674. <li><a href="https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml">glGet</a> with <code>GL_MAX_CUBE_MAP_TEXTURE_SIZE</code>.</li>
  675. </ul>
  676. </dl>
  677. </dd>
  678. <dt>
  679. <div class="nameContainer">
  680. <h4 class="name" id="mode">
  681. <a href="#mode" class="doc-link"></a>
  682. mode<span class="type-signature"> : <a href="SceneMode.html">SceneMode</a></span>
  683. <div class="source-link rightLinks">
  684. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L991">Scene/Scene.js 991</a>
  685. </div>
  686. </h4>
  687. </div>
  688. </dt>
  689. <dd>
  690. <div class="description">
  691. Gets or sets the current mode of the scene.
  692. </div>
  693. <dl class="details">
  694. <span class="details-header">Default Value:</span>
  695. <code class="language-javascript"><a href="SceneMode.html#.SCENE3D"><code>SceneMode.SCENE3D</code></a></code>
  696. </dl>
  697. </dd>
  698. <dt>
  699. <div class="nameContainer">
  700. <h4 class="name" id="moon">
  701. <a href="#moon" class="doc-link"></a>
  702. moon<span class="type-signature"> : <a href="Moon.html">Moon</a></span>
  703. <div class="source-link rightLinks">
  704. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L379">Scene/Scene.js 379</a>
  705. </div>
  706. </h4>
  707. </div>
  708. </dt>
  709. <dd>
  710. <div class="description">
  711. The <a href="Moon.html"><code>Moon</code></a>
  712. </div>
  713. <dl class="details">
  714. <span class="details-header">Default Value:</span>
  715. <code class="language-javascript">undefined</code>
  716. </dl>
  717. </dd>
  718. <dt>
  719. <div class="nameContainer">
  720. <h4 class="name" id="morphComplete">
  721. <a href="#morphComplete" class="doc-link"></a>
  722. morphComplete<span class="type-signature"> : <a href="Event.html">Event</a></span>
  723. <div class="source-link rightLinks">
  724. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L336">Scene/Scene.js 336</a>
  725. </div>
  726. </h4>
  727. </div>
  728. </dt>
  729. <dd>
  730. <div class="description">
  731. The event fired at the completion of a scene transition.
  732. </div>
  733. <dl class="details">
  734. <span class="details-header">Default Value:</span>
  735. <code class="language-javascript">Event()</code>
  736. </dl>
  737. </dd>
  738. <dt>
  739. <div class="nameContainer">
  740. <h4 class="name" id="morphStart">
  741. <a href="#morphStart" class="doc-link"></a>
  742. morphStart<span class="type-signature"> : <a href="Event.html">Event</a></span>
  743. <div class="source-link rightLinks">
  744. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L329">Scene/Scene.js 329</a>
  745. </div>
  746. </h4>
  747. </div>
  748. </dt>
  749. <dd>
  750. <div class="description">
  751. The event fired at the beginning of a scene transition.
  752. </div>
  753. <dl class="details">
  754. <span class="details-header">Default Value:</span>
  755. <code class="language-javascript">Event()</code>
  756. </dl>
  757. </dd>
  758. <dt>
  759. <div class="nameContainer">
  760. <h4 class="name" id="morphTime">
  761. <a href="#morphTime" class="doc-link"></a>
  762. morphTime<span class="type-signature"> : Number</span>
  763. <div class="source-link rightLinks">
  764. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L402">Scene/Scene.js 402</a>
  765. </div>
  766. </h4>
  767. </div>
  768. </dt>
  769. <dd>
  770. <div class="description">
  771. The current morph transition time between 2D/Columbus View and 3D, with 0.0 being 2D or Columbus View and 1.0 being 3D.
  772. </div>
  773. <dl class="details">
  774. <span class="details-header">Default Value:</span>
  775. <code class="language-javascript">1.0</code>
  776. </dl>
  777. </dd>
  778. <dt>
  779. <div class="nameContainer">
  780. <h4 class="name" id="nearToFarDistance2D">
  781. <a href="#nearToFarDistance2D" class="doc-link"></a>
  782. nearToFarDistance2D<span class="type-signature"> : Number</span>
  783. <div class="source-link rightLinks">
  784. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L418">Scene/Scene.js 418</a>
  785. </div>
  786. </h4>
  787. </div>
  788. </dt>
  789. <dd>
  790. <div class="description">
  791. Determines the uniform depth size in meters of each frustum of the multifrustum in 2D. If a primitive or model close to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the other hand, increasing this will increase performance but may cause z-fighting among primitives close to thesurface.
  792. </div>
  793. <dl class="details">
  794. <span class="details-header">Default Value:</span>
  795. <code class="language-javascript">1.75e6</code>
  796. </dl>
  797. </dd>
  798. <dt>
  799. <div class="nameContainer">
  800. <h4 class="name" id="orderIndependentTranslucency">
  801. <a href="#orderIndependentTranslucency" class="doc-link"></a>
  802. <span class="type-signature attribute-readonly">readonly</span>orderIndependentTranslucency<span class="type-signature"> : Boolean</span>
  803. <div class="source-link rightLinks">
  804. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L967">Scene/Scene.js 967</a>
  805. </div>
  806. </h4>
  807. </div>
  808. </dt>
  809. <dd>
  810. <div class="description">
  811. Gets whether or not the scene has order independent translucency enabled. Note that this only reflects the original construction option, and there are other factors that could prevent OIT from functioning on a given system configuration.
  812. </div>
  813. <dl class="details">
  814. </dl>
  815. </dd>
  816. <dt>
  817. <div class="nameContainer">
  818. <h4 class="name" id="pickPositionSupported">
  819. <a href="#pickPositionSupported" class="doc-link"></a>
  820. <span class="type-signature attribute-readonly">readonly</span>pickPositionSupported<span class="type-signature"> : Boolean</span>
  821. <div class="source-link rightLinks">
  822. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L705">Scene/Scene.js 705</a>
  823. </div>
  824. </h4>
  825. </div>
  826. </dt>
  827. <dd>
  828. <div class="description">
  829. Returns true if the pickPosition function is supported.
  830. </div>
  831. <dl class="details">
  832. </dl>
  833. </dd>
  834. <dt>
  835. <div class="nameContainer">
  836. <h4 class="name" id="postRender">
  837. <a href="#postRender" class="doc-link"></a>
  838. <span class="type-signature attribute-readonly">readonly</span>postRender<span class="type-signature"> : <a href="Event.html">Event</a></span>
  839. <div class="source-link rightLinks">
  840. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L906">Scene/Scene.js 906</a>
  841. </div>
  842. </h4>
  843. </div>
  844. </dt>
  845. <dd>
  846. <div class="description">
  847. Gets the event that will be raised at the end of each call to <code>render</code>. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
  848. </div>
  849. <dl class="details">
  850. </dl>
  851. </dd>
  852. <dt>
  853. <div class="nameContainer">
  854. <h4 class="name" id="preRender">
  855. <a href="#preRender" class="doc-link"></a>
  856. <span class="type-signature attribute-readonly">readonly</span>preRender<span class="type-signature"> : <a href="Event.html">Event</a></span>
  857. <div class="source-link rightLinks">
  858. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L892">Scene/Scene.js 892</a>
  859. </div>
  860. </h4>
  861. </div>
  862. </dt>
  863. <dd>
  864. <div class="description">
  865. Gets the event that will be raised at the start of each call to <code>render</code>. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
  866. </div>
  867. <dl class="details">
  868. </dl>
  869. </dd>
  870. <dt>
  871. <div class="nameContainer">
  872. <h4 class="name" id="primitives">
  873. <a href="#primitives" class="doc-link"></a>
  874. <span class="type-signature attribute-readonly">readonly</span>primitives<span class="type-signature"> : <a href="PrimitiveCollection.html">PrimitiveCollection</a></span>
  875. <div class="source-link rightLinks">
  876. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L735">Scene/Scene.js 735</a>
  877. </div>
  878. </h4>
  879. </div>
  880. </dt>
  881. <dd>
  882. <div class="description">
  883. Gets the collection of primitives.
  884. </div>
  885. <dl class="details">
  886. </dl>
  887. </dd>
  888. <dt>
  889. <div class="nameContainer">
  890. <h4 class="name" id="renderError">
  891. <a href="#renderError" class="doc-link"></a>
  892. <span class="type-signature attribute-readonly">readonly</span>renderError<span class="type-signature"> : <a href="Event.html">Event</a></span>
  893. <div class="source-link rightLinks">
  894. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L878">Scene/Scene.js 878</a>
  895. </div>
  896. </h4>
  897. </div>
  898. </dt>
  899. <dd>
  900. <div class="description">
  901. Gets the event that will be raised when an error is thrown inside the <code>render</code> function. The Scene instance and the thrown error are the only two parameters passed to the event handler. By default, errors are not rethrown after this event is raised, but that can be changed by setting the <code>rethrowRenderErrors</code> property.
  902. </div>
  903. <dl class="details">
  904. </dl>
  905. </dd>
  906. <dt>
  907. <div class="nameContainer">
  908. <h4 class="name" id="rethrowRenderErrors">
  909. <a href="#rethrowRenderErrors" class="doc-link"></a>
  910. rethrowRenderErrors<span class="type-signature"> : Boolean</span>
  911. <div class="source-link rightLinks">
  912. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L313">Scene/Scene.js 313</a>
  913. </div>
  914. </h4>
  915. </div>
  916. </dt>
  917. <dd>
  918. <div class="description">
  919. Exceptions occurring in <code>render</code> are always caught in order to raise the <code>renderError</code> event. If this property is true, the error is rethrown after the event is raised. If this property is false, the <code>render</code> function returns normally after raising the event.
  920. </div>
  921. <dl class="details">
  922. <span class="details-header">Default Value:</span>
  923. <code class="language-javascript">false</code>
  924. </dl>
  925. </dd>
  926. <dt>
  927. <div class="nameContainer">
  928. <h4 class="name" id="scene3DOnly">
  929. <a href="#scene3DOnly" class="doc-link"></a>
  930. <span class="type-signature attribute-readonly">readonly</span>scene3DOnly<span class="type-signature"> : Boolean</span>
  931. <div class="source-link rightLinks">
  932. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L953">Scene/Scene.js 953</a>
  933. </div>
  934. </h4>
  935. </div>
  936. </dt>
  937. <dd>
  938. <div class="description">
  939. Gets whether or not the scene is optimized for 3D only viewing.
  940. </div>
  941. <dl class="details">
  942. </dl>
  943. </dd>
  944. <dt>
  945. <div class="nameContainer">
  946. <h4 class="name" id="screenSpaceCameraController">
  947. <a href="#screenSpaceCameraController" class="doc-link"></a>
  948. <span class="type-signature attribute-readonly">readonly</span>screenSpaceCameraController<span class="type-signature"> : <a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></span>
  949. <div class="source-link rightLinks">
  950. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L775">Scene/Scene.js 775</a>
  951. </div>
  952. </h4>
  953. </div>
  954. </dt>
  955. <dd>
  956. <div class="description">
  957. Gets the controller for camera input handling.
  958. </div>
  959. <dl class="details">
  960. </dl>
  961. </dd>
  962. <dt>
  963. <div class="nameContainer">
  964. <h4 class="name" id="shadowMap">
  965. <a href="#shadowMap" class="doc-link"></a>
  966. shadowMap<span class="type-signature"> : <a href="ShadowMap.html">ShadowMap</a></span>
  967. <div class="source-link rightLinks">
  968. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L565">Scene/Scene.js 565</a>
  969. </div>
  970. </h4>
  971. </div>
  972. </dt>
  973. <dd>
  974. <div class="description">
  975. The shadow map in the scene. When enabled, models, primitives, and the globe may cast and receive shadows. By default the light source of the shadow map is the sun.
  976. </div>
  977. <dl class="details">
  978. </dl>
  979. </dd>
  980. <dt>
  981. <div class="nameContainer">
  982. <h4 class="name" id="skyAtmosphere">
  983. <a href="#skyAtmosphere" class="doc-link"></a>
  984. skyAtmosphere<span class="type-signature"> : <a href="SkyAtmosphere.html">SkyAtmosphere</a></span>
  985. <div class="source-link rightLinks">
  986. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L354">Scene/Scene.js 354</a>
  987. </div>
  988. </h4>
  989. </div>
  990. </dt>
  991. <dd>
  992. <div class="description">
  993. The sky atmosphere drawn around the globe.
  994. </div>
  995. <dl class="details">
  996. <span class="details-header">Default Value:</span>
  997. <code class="language-javascript">undefined</code>
  998. </dl>
  999. </dd>
  1000. <dt>
  1001. <div class="nameContainer">
  1002. <h4 class="name" id="skyBox">
  1003. <a href="#skyBox" class="doc-link"></a>
  1004. skyBox<span class="type-signature"> : <a href="SkyBox.html">SkyBox</a></span>
  1005. <div class="source-link rightLinks">
  1006. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L346">Scene/Scene.js 346</a>
  1007. </div>
  1008. </h4>
  1009. </div>
  1010. </dt>
  1011. <dd>
  1012. <div class="description">
  1013. The <a href="SkyBox.html"><code>SkyBox</code></a> used to draw the stars.
  1014. </div>
  1015. <dl class="details">
  1016. <span class="details-header">Default Value:</span>
  1017. <code class="language-javascript">undefined</code>
  1018. <h5>See:</h5>
  1019. <ul class="see-list">
  1020. <li><a href="Scene.html#backgroundColor">Scene#backgroundColor</a></li>
  1021. </ul>
  1022. </dl>
  1023. </dd>
  1024. <dt>
  1025. <div class="nameContainer">
  1026. <h4 class="name" id="sun">
  1027. <a href="#sun" class="doc-link"></a>
  1028. sun<span class="type-signature"> : <a href="Sun.html">Sun</a></span>
  1029. <div class="source-link rightLinks">
  1030. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L362">Scene/Scene.js 362</a>
  1031. </div>
  1032. </h4>
  1033. </div>
  1034. </dt>
  1035. <dd>
  1036. <div class="description">
  1037. The <a href="Sun.html"><code>Sun</code></a>.
  1038. </div>
  1039. <dl class="details">
  1040. <span class="details-header">Default Value:</span>
  1041. <code class="language-javascript">undefined</code>
  1042. </dl>
  1043. </dd>
  1044. <dt>
  1045. <div class="nameContainer">
  1046. <h4 class="name" id="sunBloom">
  1047. <a href="#sunBloom" class="doc-link"></a>
  1048. sunBloom<span class="type-signature"> : Boolean</span>
  1049. <div class="source-link rightLinks">
  1050. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L370">Scene/Scene.js 370</a>
  1051. </div>
  1052. </h4>
  1053. </div>
  1054. </dt>
  1055. <dd>
  1056. <div class="description">
  1057. Uses a bloom filter on the sun when enabled.
  1058. </div>
  1059. <dl class="details">
  1060. <span class="details-header">Default Value:</span>
  1061. <code class="language-javascript">true</code>
  1062. </dl>
  1063. </dd>
  1064. <dt>
  1065. <div class="nameContainer">
  1066. <h4 class="name" id="terrainExaggeration">
  1067. <a href="#terrainExaggeration" class="doc-link"></a>
  1068. terrainExaggeration<span class="type-signature"> : Number</span>
  1069. <div class="source-link rightLinks">
  1070. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L1034">Scene/Scene.js 1034</a>
  1071. </div>
  1072. </h4>
  1073. </div>
  1074. </dt>
  1075. <dd>
  1076. <div class="description">
  1077. Gets the scalar used to exaggerate the terrain.
  1078. </div>
  1079. <dl class="details">
  1080. </dl>
  1081. </dd>
  1082. <dt>
  1083. <div class="nameContainer">
  1084. <h4 class="name" id="terrainProvider">
  1085. <a href="#terrainProvider" class="doc-link"></a>
  1086. terrainProvider<span class="type-signature"> : <a href="TerrainProvider.html">TerrainProvider</a></span>
  1087. <div class="source-link rightLinks">
  1088. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L846">Scene/Scene.js 846</a>
  1089. </div>
  1090. </h4>
  1091. </div>
  1092. </dt>
  1093. <dd>
  1094. <div class="description">
  1095. The terrain provider providing surface geometry for the globe.
  1096. </div>
  1097. <dl class="details">
  1098. </dl>
  1099. </dd>
  1100. <dt>
  1101. <div class="nameContainer">
  1102. <h4 class="name" id="terrainProviderChanged">
  1103. <a href="#terrainProviderChanged" class="doc-link"></a>
  1104. <span class="type-signature attribute-readonly">readonly</span>terrainProviderChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
  1105. <div class="source-link rightLinks">
  1106. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L862">Scene/Scene.js 862</a>
  1107. </div>
  1108. </h4>
  1109. </div>
  1110. </dt>
  1111. <dd>
  1112. <div class="description">
  1113. Gets an event that's raised when the terrain provider is changed
  1114. </div>
  1115. <dl class="details">
  1116. </dl>
  1117. </dd>
  1118. <dt>
  1119. <div class="nameContainer">
  1120. <h4 class="name" id="useDepthPicking">
  1121. <a href="#useDepthPicking" class="doc-link"></a>
  1122. useDepthPicking<span class="type-signature"> : Boolean</span>
  1123. <div class="source-link rightLinks">
  1124. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L533">Scene/Scene.js 533</a>
  1125. </div>
  1126. </h4>
  1127. </div>
  1128. </dt>
  1129. <dd>
  1130. <div class="description">
  1131. When <code>true</code>, enables picking using the depth buffer.
  1132. </div>
  1133. <dl class="details">
  1134. <span class="details-header">Default Value:</span>
  1135. <code class="language-javascript">true</code>
  1136. </dl>
  1137. </dd>
  1138. <dt>
  1139. <div class="nameContainer">
  1140. <h4 class="name" id="useWebVR">
  1141. <a href="#useWebVR" class="doc-link"></a>
  1142. useWebVR<span class="type-signature"> : Boolean</span>
  1143. <div class="source-link rightLinks">
  1144. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L1047">Scene/Scene.js 1047</a>
  1145. </div>
  1146. </h4>
  1147. </div>
  1148. </dt>
  1149. <dd>
  1150. <div class="description">
  1151. When <code>true</code>, splits the scene into two viewports with steroscopic views for the left and right eyes. Used for cardboard and WebVR.
  1152. </div>
  1153. <dl class="details">
  1154. <span class="details-header">Default Value:</span>
  1155. <code class="language-javascript">false</code>
  1156. </dl>
  1157. </dd>
  1158. </dl>
  1159. <h3 class="subsection-title">Methods</h3>
  1160. <dl>
  1161. <dt>
  1162. <div class="nameContainer">
  1163. <h4 class="name" id="completeMorph">
  1164. <a href="#completeMorph" class="doc-link"></a>
  1165. completeMorph<span class="signature">()</span>
  1166. <div class="source-link rightLinks">
  1167. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2753">Scene/Scene.js 2753</a>
  1168. </div>
  1169. </h4>
  1170. </div>
  1171. </dt>
  1172. <dd>
  1173. <div class="description">
  1174. Instantly completes an active transition.
  1175. </div>
  1176. <dl class="details">
  1177. </dl>
  1178. </dd>
  1179. <dt>
  1180. <div class="nameContainer">
  1181. <h4 class="name" id="destroy">
  1182. <a href="#destroy" class="doc-link"></a>
  1183. destroy<span class="signature">()</span> &rarr; <span class="type-signature returnType">undefined</span>
  1184. <div class="source-link rightLinks">
  1185. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2837">Scene/Scene.js 2837</a>
  1186. </div>
  1187. </h4>
  1188. </div>
  1189. </dt>
  1190. <dd>
  1191. <div class="description">
  1192. Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. <br /><br /> Once an object is destroyed, it should not be used; calling any function other than <code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore, assign the return value (<code>undefined</code>) to the object as done in the example.
  1193. </div>
  1194. <h5>Returns:</h5>
  1195. <h5>Throws:</h5>
  1196. <ul>
  1197. <li>
  1198. <div class="param-desc">
  1199. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  1200. : This object was destroyed, i.e., destroy() was called.
  1201. </div>
  1202. </li>
  1203. </ul>
  1204. <dl class="details">
  1205. <h5>Example:</h5>
  1206. <pre><code class="language-javascript">scene = scene &amp;&amp; scene.destroy();</code></pre>
  1207. <h5>See:</h5>
  1208. <ul class="see-list">
  1209. <li><a href="Scene.html#isDestroyed">Scene#isDestroyed</a></li>
  1210. </ul>
  1211. </dl>
  1212. </dd>
  1213. <dt>
  1214. <div class="nameContainer">
  1215. <h4 class="name" id="drillPick">
  1216. <a href="#drillPick" class="doc-link"></a>
  1217. drillPick<span class="signature">(windowPosition, <span class="optional">limit</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;Object></span>
  1218. <div class="source-link rightLinks">
  1219. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2686">Scene/Scene.js 2686</a>
  1220. </div>
  1221. </h4>
  1222. </div>
  1223. </dt>
  1224. <dd>
  1225. <div class="description">
  1226. Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position. Other properties may also be set depending on the type of primitive. The primitives in the list are ordered by their visual order in the scene (front to back).
  1227. </div>
  1228. <table class="params">
  1229. <thead>
  1230. <tr>
  1231. <th>Name</th>
  1232. <th>Type</th>
  1233. <th class="last">Description</th>
  1234. </tr>
  1235. </thead>
  1236. <tbody>
  1237. <tr>
  1238. <td class="name"><code>windowPosition</code></td>
  1239. <td class="type">
  1240. <span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
  1241. </td>
  1242. <td class="description last">
  1243. Window coordinates to perform picking on.</td>
  1244. </tr>
  1245. <tr>
  1246. <td class="name"><code>limit</code></td>
  1247. <td class="type">
  1248. <span class="param-type">Number</span>
  1249. </td>
  1250. <td class="description last">
  1251. <span class="optional">optional</span>
  1252. If supplied, stop drilling after collecting this many picks.</td>
  1253. </tr>
  1254. </tbody>
  1255. </table>
  1256. <h5>Returns:</h5>
  1257. <div class="param-desc">
  1258. Array of objects, each containing 1 picked primitives.
  1259. </div>
  1260. <h5>Throws:</h5>
  1261. <ul>
  1262. <li>
  1263. <div class="param-desc">
  1264. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  1265. : windowPosition is undefined.
  1266. </div>
  1267. </li>
  1268. </ul>
  1269. <dl class="details">
  1270. <h5>Example:</h5>
  1271. <pre><code class="language-javascript">var pickedObjects = scene.drillPick(new Cesium.Cartesian2(100.0, 200.0));</code></pre>
  1272. </dl>
  1273. </dd>
  1274. <dt>
  1275. <div class="nameContainer">
  1276. <h4 class="name" id="isDestroyed">
  1277. <a href="#isDestroyed" class="doc-link"></a>
  1278. isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
  1279. <div class="source-link rightLinks">
  1280. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2815">Scene/Scene.js 2815</a>
  1281. </div>
  1282. </h4>
  1283. </div>
  1284. </dt>
  1285. <dd>
  1286. <div class="description">
  1287. 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.
  1288. </div>
  1289. <h5>Returns:</h5>
  1290. <div class="param-desc">
  1291. <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  1292. </div>
  1293. <dl class="details">
  1294. <h5>See:</h5>
  1295. <ul class="see-list">
  1296. <li><a href="Scene.html#destroy">Scene#destroy</a></li>
  1297. </ul>
  1298. </dl>
  1299. </dd>
  1300. <dt>
  1301. <div class="nameContainer">
  1302. <h4 class="name" id="morphTo2D">
  1303. <a href="#morphTo2D" class="doc-link"></a>
  1304. morphTo2D<span class="signature">(<span class="optional">duration</span>)</span>
  1305. <div class="source-link rightLinks">
  1306. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2761">Scene/Scene.js 2761</a>
  1307. </div>
  1308. </h4>
  1309. </div>
  1310. </dt>
  1311. <dd>
  1312. <div class="description">
  1313. Asynchronously transitions the scene to 2D.
  1314. </div>
  1315. <table class="params">
  1316. <thead>
  1317. <tr>
  1318. <th>Name</th>
  1319. <th>Type</th>
  1320. <th>Default</th>
  1321. <th class="last">Description</th>
  1322. </tr>
  1323. </thead>
  1324. <tbody>
  1325. <tr>
  1326. <td class="name"><code>duration</code></td>
  1327. <td class="type">
  1328. <span class="param-type">Number</span>
  1329. </td>
  1330. <td class="default">
  1331. <code class="language-javascript">2.0</code>
  1332. </td>
  1333. <td class="description last">
  1334. <span class="optional">optional</span>
  1335. The amount of time, in seconds, for transition animations to complete.</td>
  1336. </tr>
  1337. </tbody>
  1338. </table>
  1339. <dl class="details">
  1340. </dl>
  1341. </dd>
  1342. <dt>
  1343. <div class="nameContainer">
  1344. <h4 class="name" id="morphTo3D">
  1345. <a href="#morphTo3D" class="doc-link"></a>
  1346. morphTo3D<span class="signature">(<span class="optional">duration</span>)</span>
  1347. <div class="source-link rightLinks">
  1348. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2793">Scene/Scene.js 2793</a>
  1349. </div>
  1350. </h4>
  1351. </div>
  1352. </dt>
  1353. <dd>
  1354. <div class="description">
  1355. Asynchronously transitions the scene to 3D.
  1356. </div>
  1357. <table class="params">
  1358. <thead>
  1359. <tr>
  1360. <th>Name</th>
  1361. <th>Type</th>
  1362. <th>Default</th>
  1363. <th class="last">Description</th>
  1364. </tr>
  1365. </thead>
  1366. <tbody>
  1367. <tr>
  1368. <td class="name"><code>duration</code></td>
  1369. <td class="type">
  1370. <span class="param-type">Number</span>
  1371. </td>
  1372. <td class="default">
  1373. <code class="language-javascript">2.0</code>
  1374. </td>
  1375. <td class="description last">
  1376. <span class="optional">optional</span>
  1377. The amount of time, in seconds, for transition animations to complete.</td>
  1378. </tr>
  1379. </tbody>
  1380. </table>
  1381. <dl class="details">
  1382. </dl>
  1383. </dd>
  1384. <dt>
  1385. <div class="nameContainer">
  1386. <h4 class="name" id="morphToColumbusView">
  1387. <a href="#morphToColumbusView" class="doc-link"></a>
  1388. morphToColumbusView<span class="signature">(<span class="optional">duration</span>)</span>
  1389. <div class="source-link rightLinks">
  1390. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2777">Scene/Scene.js 2777</a>
  1391. </div>
  1392. </h4>
  1393. </div>
  1394. </dt>
  1395. <dd>
  1396. <div class="description">
  1397. Asynchronously transitions the scene to Columbus View.
  1398. </div>
  1399. <table class="params">
  1400. <thead>
  1401. <tr>
  1402. <th>Name</th>
  1403. <th>Type</th>
  1404. <th>Default</th>
  1405. <th class="last">Description</th>
  1406. </tr>
  1407. </thead>
  1408. <tbody>
  1409. <tr>
  1410. <td class="name"><code>duration</code></td>
  1411. <td class="type">
  1412. <span class="param-type">Number</span>
  1413. </td>
  1414. <td class="default">
  1415. <code class="language-javascript">2.0</code>
  1416. </td>
  1417. <td class="description last">
  1418. <span class="optional">optional</span>
  1419. The amount of time, in seconds, for transition animations to complete.</td>
  1420. </tr>
  1421. </tbody>
  1422. </table>
  1423. <dl class="details">
  1424. </dl>
  1425. </dd>
  1426. <dt>
  1427. <div class="nameContainer">
  1428. <h4 class="name" id="pick">
  1429. <a href="#pick" class="doc-link"></a>
  1430. pick<span class="signature">(windowPosition)</span> &rarr; <span class="type-signature returnType">Object</span>
  1431. <div class="source-link rightLinks">
  1432. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2558">Scene/Scene.js 2558</a>
  1433. </div>
  1434. </h4>
  1435. </div>
  1436. </dt>
  1437. <dd>
  1438. <div class="description">
  1439. Returns an object with a `primitive` property that contains the first (top) primitive in the scene at a particular window coordinate or undefined if nothing is at the location. Other properties may potentially be set depending on the type of primitive.
  1440. </div>
  1441. <table class="params">
  1442. <thead>
  1443. <tr>
  1444. <th>Name</th>
  1445. <th>Type</th>
  1446. <th class="last">Description</th>
  1447. </tr>
  1448. </thead>
  1449. <tbody>
  1450. <tr>
  1451. <td class="name"><code>windowPosition</code></td>
  1452. <td class="type">
  1453. <span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
  1454. </td>
  1455. <td class="description last">
  1456. Window coordinates to perform picking on.</td>
  1457. </tr>
  1458. </tbody>
  1459. </table>
  1460. <h5>Returns:</h5>
  1461. <div class="param-desc">
  1462. Object containing the picked primitive.
  1463. </div>
  1464. <h5>Throws:</h5>
  1465. <ul>
  1466. <li>
  1467. <div class="param-desc">
  1468. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  1469. : windowPosition is undefined.
  1470. </div>
  1471. </li>
  1472. </ul>
  1473. <dl class="details">
  1474. </dl>
  1475. </dd>
  1476. <dt>
  1477. <div class="nameContainer">
  1478. <h4 class="name" id="pickPosition">
  1479. <a href="#pickPosition" class="doc-link"></a>
  1480. pickPosition<span class="signature">(windowPosition, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
  1481. <div class="source-link rightLinks">
  1482. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/Scene.js#L2609">Scene/Scene.js 2609</a>
  1483. </div>
  1484. </h4>
  1485. </div>
  1486. </dt>
  1487. <dd>
  1488. <div class="description">
  1489. Returns the cartesian position reconstructed from the depth buffer and window position.
  1490. </div>
  1491. <table class="params">
  1492. <thead>
  1493. <tr>
  1494. <th>Name</th>
  1495. <th>Type</th>
  1496. <th class="last">Description</th>
  1497. </tr>
  1498. </thead>
  1499. <tbody>
  1500. <tr>
  1501. <td class="name"><code>windowPosition</code></td>
  1502. <td class="type">
  1503. <span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
  1504. </td>
  1505. <td class="description last">
  1506. Window coordinates to perform picking on.</td>
  1507. </tr>
  1508. <tr>
  1509. <td class="name"><code>result</code></td>
  1510. <td class="type">
  1511. <span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
  1512. </td>
  1513. <td class="description last">
  1514. <span class="optional">optional</span>
  1515. The object on which to restore the result.</td>
  1516. </tr>
  1517. </tbody>
  1518. </table>
  1519. <h5>Returns:</h5>
  1520. <div class="param-desc">
  1521. The cartesian position.
  1522. </div>
  1523. <h5>Throws:</h5>
  1524. <ul>
  1525. <li>
  1526. <div class="param-desc">
  1527. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  1528. : Picking from the depth buffer is not supported. Check pickPositionSupported.
  1529. </div>
  1530. </li>
  1531. <li>
  1532. <div class="param-desc">
  1533. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  1534. : 2D is not supported. An orthographic projection matrix is not invertible.
  1535. </div>
  1536. </li>
  1537. </ul>
  1538. <dl class="details">
  1539. </dl>
  1540. </dd>
  1541. </dl>
  1542. </article>
  1543. </section>
  1544. <footer>
  1545. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
  1546. </footer>
  1547. </div>
  1548. <div class="nav">
  1549. <div class="menu">
  1550. <input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
  1551. <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>
  1552. </div>
  1553. </div>
  1554. <script>
  1555. if (window.frameElement) {
  1556. document.body.className = 'embedded';
  1557. var ele = document.createElement('a');
  1558. ele.className = 'popout';
  1559. ele.target = '_blank';
  1560. ele.href = window.location.href;
  1561. ele.title = 'Pop out';
  1562. document.getElementById('main').appendChild(ele);
  1563. }
  1564. // Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
  1565. Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
  1566. if (/^https?:/i.test(a.getAttribute('href'))) {
  1567. a.target='_blank';
  1568. }
  1569. });
  1570. </script>
  1571. <script src="javascript/prism.js"></script>
  1572. <script src="javascript/cesiumDoc.js"></script>
  1573. </body>
  1574. </html>