GLTFLoader.js 113 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913
  1. import {
  2. AnimationClip,
  3. Bone,
  4. Box3,
  5. BufferAttribute,
  6. BufferGeometry,
  7. ClampToEdgeWrapping,
  8. Color,
  9. ColorManagement,
  10. DirectionalLight,
  11. DoubleSide,
  12. FileLoader,
  13. FrontSide,
  14. Group,
  15. ImageBitmapLoader,
  16. InstancedMesh,
  17. InterleavedBuffer,
  18. InterleavedBufferAttribute,
  19. Interpolant,
  20. InterpolateDiscrete,
  21. InterpolateLinear,
  22. Line,
  23. LineBasicMaterial,
  24. LineLoop,
  25. LineSegments,
  26. LinearFilter,
  27. LinearMipmapLinearFilter,
  28. LinearMipmapNearestFilter,
  29. LinearSRGBColorSpace,
  30. Loader,
  31. LoaderUtils,
  32. Material,
  33. MathUtils,
  34. Matrix4,
  35. Mesh,
  36. MeshBasicMaterial,
  37. MeshPhysicalMaterial,
  38. MeshStandardMaterial,
  39. MirroredRepeatWrapping,
  40. NearestFilter,
  41. NearestMipmapLinearFilter,
  42. NearestMipmapNearestFilter,
  43. NumberKeyframeTrack,
  44. Object3D,
  45. OrthographicCamera,
  46. PerspectiveCamera,
  47. PointLight,
  48. Points,
  49. PointsMaterial,
  50. PropertyBinding,
  51. Quaternion,
  52. QuaternionKeyframeTrack,
  53. RepeatWrapping,
  54. Skeleton,
  55. SkinnedMesh,
  56. Sphere,
  57. SpotLight,
  58. Texture,
  59. TextureLoader,
  60. TriangleFanDrawMode,
  61. TriangleStripDrawMode,
  62. Vector2,
  63. Vector3,
  64. VectorKeyframeTrack,
  65. SRGBColorSpace,
  66. InstancedBufferAttribute
  67. } from 'three';
  68. import { toTrianglesDrawMode } from '../utils/BufferGeometryUtils.js';
  69. import { clone } from '../utils/SkeletonUtils.js';
  70. /**
  71. * A loader for the glTF 2.0 format.
  72. *
  73. * [glTF](https://www.khronos.org/gltf/) (GL Transmission Format) is an [open format specification]{@link https://github.com/KhronosGroup/glTF/tree/main/specification/2.0)
  74. * for efficient delivery and loading of 3D content. Assets may be provided either in JSON (.gltf) or binary (.glb)
  75. * format. External files store textures (.jpg, .png) and additional binary data (.bin). A glTF asset may deliver
  76. * one or more scenes, including meshes, materials, textures, skins, skeletons, morph targets, animations, lights,
  77. * and/or cameras.
  78. *
  79. * `GLTFLoader` uses {@link ImageBitmapLoader} whenever possible. Be advised that image bitmaps are not
  80. * automatically GC-collected when they are no longer referenced, and they require special handling during
  81. * the disposal process.
  82. *
  83. * `GLTFLoader` supports the following glTF 2.0 extensions:
  84. * - KHR_draco_mesh_compression
  85. * - KHR_materials_clearcoat
  86. * - KHR_materials_dispersion
  87. * - KHR_materials_ior
  88. * - KHR_materials_specular
  89. * - KHR_materials_transmission
  90. * - KHR_materials_iridescence
  91. * - KHR_materials_unlit
  92. * - KHR_materials_volume
  93. * - KHR_mesh_quantization
  94. * - KHR_lights_punctual
  95. * - KHR_texture_basisu
  96. * - KHR_texture_transform
  97. * - EXT_texture_webp
  98. * - EXT_meshopt_compression
  99. * - EXT_mesh_gpu_instancing
  100. *
  101. * The following glTF 2.0 extension is supported by an external user plugin:
  102. * - [KHR_materials_variants](https://github.com/takahirox/three-gltf-extensions)
  103. * - [MSFT_texture_dds](https://github.com/takahirox/three-gltf-extensions)
  104. * - [KHR_animation_pointer](https://github.com/needle-tools/three-animation-pointer)
  105. * - [NEEDLE_progressive](https://github.com/needle-tools/gltf-progressive)
  106. *
  107. * ```js
  108. * const loader = new GLTFLoader();
  109. *
  110. * // Optional: Provide a DRACOLoader instance to decode compressed mesh data
  111. * const dracoLoader = new DRACOLoader();
  112. * dracoLoader.setDecoderPath( '/examples/jsm/libs/draco/' );
  113. * loader.setDRACOLoader( dracoLoader );
  114. *
  115. * const gltf = await loader.loadAsync( 'models/gltf/duck/duck.gltf' );
  116. * scene.add( gltf.scene );
  117. * ```
  118. *
  119. * @augments Loader
  120. * @three_import import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js';
  121. */
  122. class GLTFLoader extends Loader {
  123. /**
  124. * Constructs a new glTF loader.
  125. *
  126. * @param {LoadingManager} [manager] - The loading manager.
  127. */
  128. constructor( manager ) {
  129. super( manager );
  130. this.dracoLoader = null;
  131. this.ktx2Loader = null;
  132. this.meshoptDecoder = null;
  133. this.pluginCallbacks = [];
  134. this.register( function ( parser ) {
  135. return new GLTFMaterialsClearcoatExtension( parser );
  136. } );
  137. this.register( function ( parser ) {
  138. return new GLTFMaterialsDispersionExtension( parser );
  139. } );
  140. this.register( function ( parser ) {
  141. return new GLTFTextureBasisUExtension( parser );
  142. } );
  143. this.register( function ( parser ) {
  144. return new GLTFTextureWebPExtension( parser );
  145. } );
  146. this.register( function ( parser ) {
  147. return new GLTFTextureAVIFExtension( parser );
  148. } );
  149. this.register( function ( parser ) {
  150. return new GLTFMaterialsSheenExtension( parser );
  151. } );
  152. this.register( function ( parser ) {
  153. return new GLTFMaterialsTransmissionExtension( parser );
  154. } );
  155. this.register( function ( parser ) {
  156. return new GLTFMaterialsVolumeExtension( parser );
  157. } );
  158. this.register( function ( parser ) {
  159. return new GLTFMaterialsIorExtension( parser );
  160. } );
  161. this.register( function ( parser ) {
  162. return new GLTFMaterialsEmissiveStrengthExtension( parser );
  163. } );
  164. this.register( function ( parser ) {
  165. return new GLTFMaterialsSpecularExtension( parser );
  166. } );
  167. this.register( function ( parser ) {
  168. return new GLTFMaterialsIridescenceExtension( parser );
  169. } );
  170. this.register( function ( parser ) {
  171. return new GLTFMaterialsAnisotropyExtension( parser );
  172. } );
  173. this.register( function ( parser ) {
  174. return new GLTFMaterialsBumpExtension( parser );
  175. } );
  176. this.register( function ( parser ) {
  177. return new GLTFLightsExtension( parser );
  178. } );
  179. this.register( function ( parser ) {
  180. return new GLTFMeshoptCompression( parser, EXTENSIONS.EXT_MESHOPT_COMPRESSION );
  181. } );
  182. this.register( function ( parser ) {
  183. return new GLTFMeshoptCompression( parser, EXTENSIONS.KHR_MESHOPT_COMPRESSION );
  184. } );
  185. this.register( function ( parser ) {
  186. return new GLTFMeshGpuInstancing( parser );
  187. } );
  188. }
  189. /**
  190. * Starts loading from the given URL and passes the loaded glTF asset
  191. * to the `onLoad()` callback.
  192. *
  193. * @param {string} url - The path/URL of the file to be loaded. This can also be a data URI.
  194. * @param {function(GLTFLoader~LoadObject)} onLoad - Executed when the loading process has been finished.
  195. * @param {onProgressCallback} onProgress - Executed while the loading is in progress.
  196. * @param {onErrorCallback} onError - Executed when errors occur.
  197. */
  198. load( url, onLoad, onProgress, onError ) {
  199. const scope = this;
  200. let resourcePath;
  201. if ( this.resourcePath !== '' ) {
  202. resourcePath = this.resourcePath;
  203. } else if ( this.path !== '' ) {
  204. // If a base path is set, resources will be relative paths from that plus the relative path of the gltf file
  205. // Example path = 'https://my-cnd-server.com/', url = 'assets/models/model.gltf'
  206. // resourcePath = 'https://my-cnd-server.com/assets/models/'
  207. // referenced resource 'model.bin' will be loaded from 'https://my-cnd-server.com/assets/models/model.bin'
  208. // referenced resource '../textures/texture.png' will be loaded from 'https://my-cnd-server.com/assets/textures/texture.png'
  209. const relativeUrl = LoaderUtils.extractUrlBase( url );
  210. resourcePath = LoaderUtils.resolveURL( relativeUrl, this.path );
  211. } else {
  212. resourcePath = LoaderUtils.extractUrlBase( url );
  213. }
  214. // Tells the LoadingManager to track an extra item, which resolves after
  215. // the model is fully loaded. This means the count of items loaded will
  216. // be incorrect, but ensures manager.onLoad() does not fire early.
  217. this.manager.itemStart( url );
  218. const _onError = function ( e ) {
  219. if ( onError ) {
  220. onError( e );
  221. } else {
  222. console.error( e );
  223. }
  224. scope.manager.itemError( url );
  225. scope.manager.itemEnd( url );
  226. };
  227. const loader = new FileLoader( this.manager );
  228. loader.setPath( this.path );
  229. loader.setResponseType( 'arraybuffer' );
  230. loader.setRequestHeader( this.requestHeader );
  231. loader.setWithCredentials( this.withCredentials );
  232. loader.load( url, function ( data ) {
  233. try {
  234. scope.parse( data, resourcePath, function ( gltf ) {
  235. onLoad( gltf );
  236. scope.manager.itemEnd( url );
  237. }, _onError );
  238. } catch ( e ) {
  239. _onError( e );
  240. }
  241. }, onProgress, _onError );
  242. }
  243. /**
  244. * Sets the given Draco loader to this loader. Required for decoding assets
  245. * compressed with the `KHR_draco_mesh_compression` extension.
  246. *
  247. * @param {DRACOLoader} dracoLoader - The Draco loader to set.
  248. * @return {GLTFLoader} A reference to this loader.
  249. */
  250. setDRACOLoader( dracoLoader ) {
  251. this.dracoLoader = dracoLoader;
  252. return this;
  253. }
  254. /**
  255. * Sets the given KTX2 loader to this loader. Required for loading KTX2
  256. * compressed textures.
  257. *
  258. * @param {KTX2Loader} ktx2Loader - The KTX2 loader to set.
  259. * @return {GLTFLoader} A reference to this loader.
  260. */
  261. setKTX2Loader( ktx2Loader ) {
  262. this.ktx2Loader = ktx2Loader;
  263. return this;
  264. }
  265. /**
  266. * Sets the given meshopt decoder. Required for decoding assets
  267. * compressed with the `EXT_meshopt_compression` extension.
  268. *
  269. * @param {Object} meshoptDecoder - The meshopt decoder to set.
  270. * @return {GLTFLoader} A reference to this loader.
  271. */
  272. setMeshoptDecoder( meshoptDecoder ) {
  273. this.meshoptDecoder = meshoptDecoder;
  274. return this;
  275. }
  276. /**
  277. * Registers a plugin callback. This API is internally used to implement the various
  278. * glTF extensions but can also used by third-party code to add additional logic
  279. * to the loader.
  280. *
  281. * @param {function(parser:GLTFParser)} callback - The callback function to register.
  282. * @return {GLTFLoader} A reference to this loader.
  283. */
  284. register( callback ) {
  285. if ( this.pluginCallbacks.indexOf( callback ) === - 1 ) {
  286. this.pluginCallbacks.push( callback );
  287. }
  288. return this;
  289. }
  290. /**
  291. * Unregisters a plugin callback.
  292. *
  293. * @param {Function} callback - The callback function to unregister.
  294. * @return {GLTFLoader} A reference to this loader.
  295. */
  296. unregister( callback ) {
  297. if ( this.pluginCallbacks.indexOf( callback ) !== - 1 ) {
  298. this.pluginCallbacks.splice( this.pluginCallbacks.indexOf( callback ), 1 );
  299. }
  300. return this;
  301. }
  302. /**
  303. * Parses the given glTF data and returns the resulting group.
  304. *
  305. * @param {string|ArrayBuffer} data - The raw glTF data.
  306. * @param {string} path - The URL base path.
  307. * @param {function(GLTFLoader~LoadObject)} onLoad - Executed when the loading process has been finished.
  308. * @param {onErrorCallback} onError - Executed when errors occur.
  309. */
  310. parse( data, path, onLoad, onError ) {
  311. let json;
  312. const extensions = {};
  313. const plugins = {};
  314. const textDecoder = new TextDecoder();
  315. if ( typeof data === 'string' ) {
  316. json = JSON.parse( data );
  317. } else if ( data instanceof ArrayBuffer ) {
  318. const magic = textDecoder.decode( new Uint8Array( data, 0, 4 ) );
  319. if ( magic === BINARY_EXTENSION_HEADER_MAGIC ) {
  320. try {
  321. extensions[ EXTENSIONS.KHR_BINARY_GLTF ] = new GLTFBinaryExtension( data );
  322. } catch ( error ) {
  323. if ( onError ) onError( error );
  324. return;
  325. }
  326. json = JSON.parse( extensions[ EXTENSIONS.KHR_BINARY_GLTF ].content );
  327. } else {
  328. json = JSON.parse( textDecoder.decode( data ) );
  329. }
  330. } else {
  331. json = data;
  332. }
  333. if ( json.asset === undefined || json.asset.version[ 0 ] < 2 ) {
  334. if ( onError ) onError( new Error( 'THREE.GLTFLoader: Unsupported asset. glTF versions >=2.0 are supported.' ) );
  335. return;
  336. }
  337. const parser = new GLTFParser( json, {
  338. path: path || this.resourcePath || '',
  339. crossOrigin: this.crossOrigin,
  340. requestHeader: this.requestHeader,
  341. manager: this.manager,
  342. ktx2Loader: this.ktx2Loader,
  343. meshoptDecoder: this.meshoptDecoder
  344. } );
  345. parser.fileLoader.setRequestHeader( this.requestHeader );
  346. for ( let i = 0; i < this.pluginCallbacks.length; i ++ ) {
  347. const plugin = this.pluginCallbacks[ i ]( parser );
  348. if ( ! plugin.name ) console.error( 'THREE.GLTFLoader: Invalid plugin found: missing name' );
  349. plugins[ plugin.name ] = plugin;
  350. // Workaround to avoid determining as unknown extension
  351. // in addUnknownExtensionsToUserData().
  352. // Remove this workaround if we move all the existing
  353. // extension handlers to plugin system
  354. extensions[ plugin.name ] = true;
  355. }
  356. if ( json.extensionsUsed ) {
  357. for ( let i = 0; i < json.extensionsUsed.length; ++ i ) {
  358. const extensionName = json.extensionsUsed[ i ];
  359. const extensionsRequired = json.extensionsRequired || [];
  360. switch ( extensionName ) {
  361. case EXTENSIONS.KHR_MATERIALS_UNLIT:
  362. extensions[ extensionName ] = new GLTFMaterialsUnlitExtension();
  363. break;
  364. case EXTENSIONS.KHR_DRACO_MESH_COMPRESSION:
  365. extensions[ extensionName ] = new GLTFDracoMeshCompressionExtension( json, this.dracoLoader );
  366. break;
  367. case EXTENSIONS.KHR_TEXTURE_TRANSFORM:
  368. extensions[ extensionName ] = new GLTFTextureTransformExtension();
  369. break;
  370. case EXTENSIONS.KHR_MESH_QUANTIZATION:
  371. extensions[ extensionName ] = new GLTFMeshQuantizationExtension();
  372. break;
  373. default:
  374. if ( extensionsRequired.indexOf( extensionName ) >= 0 && plugins[ extensionName ] === undefined ) {
  375. console.warn( 'THREE.GLTFLoader: Unknown extension "' + extensionName + '".' );
  376. }
  377. }
  378. }
  379. }
  380. parser.setExtensions( extensions );
  381. parser.setPlugins( plugins );
  382. parser.parse( onLoad, onError );
  383. }
  384. /**
  385. * Async version of {@link GLTFLoader#parse}.
  386. *
  387. * @async
  388. * @param {string|ArrayBuffer} data - The raw glTF data.
  389. * @param {string} path - The URL base path.
  390. * @return {Promise<GLTFLoader~LoadObject>} A Promise that resolves with the loaded glTF when the parsing has been finished.
  391. */
  392. parseAsync( data, path ) {
  393. const scope = this;
  394. return new Promise( function ( resolve, reject ) {
  395. scope.parse( data, path, resolve, reject );
  396. } );
  397. }
  398. }
  399. /* GLTFREGISTRY */
  400. function GLTFRegistry() {
  401. let objects = {};
  402. return {
  403. get: function ( key ) {
  404. return objects[ key ];
  405. },
  406. add: function ( key, object ) {
  407. objects[ key ] = object;
  408. },
  409. remove: function ( key ) {
  410. delete objects[ key ];
  411. },
  412. removeAll: function () {
  413. objects = {};
  414. }
  415. };
  416. }
  417. /*********************************/
  418. /********** EXTENSIONS ***********/
  419. /*********************************/
  420. const EXTENSIONS = {
  421. KHR_BINARY_GLTF: 'KHR_binary_glTF',
  422. KHR_DRACO_MESH_COMPRESSION: 'KHR_draco_mesh_compression',
  423. KHR_LIGHTS_PUNCTUAL: 'KHR_lights_punctual',
  424. KHR_MATERIALS_CLEARCOAT: 'KHR_materials_clearcoat',
  425. KHR_MATERIALS_DISPERSION: 'KHR_materials_dispersion',
  426. KHR_MATERIALS_IOR: 'KHR_materials_ior',
  427. KHR_MATERIALS_SHEEN: 'KHR_materials_sheen',
  428. KHR_MATERIALS_SPECULAR: 'KHR_materials_specular',
  429. KHR_MATERIALS_TRANSMISSION: 'KHR_materials_transmission',
  430. KHR_MATERIALS_IRIDESCENCE: 'KHR_materials_iridescence',
  431. KHR_MATERIALS_ANISOTROPY: 'KHR_materials_anisotropy',
  432. KHR_MATERIALS_UNLIT: 'KHR_materials_unlit',
  433. KHR_MATERIALS_VOLUME: 'KHR_materials_volume',
  434. KHR_TEXTURE_BASISU: 'KHR_texture_basisu',
  435. KHR_TEXTURE_TRANSFORM: 'KHR_texture_transform',
  436. KHR_MESH_QUANTIZATION: 'KHR_mesh_quantization',
  437. KHR_MATERIALS_EMISSIVE_STRENGTH: 'KHR_materials_emissive_strength',
  438. EXT_MATERIALS_BUMP: 'EXT_materials_bump',
  439. EXT_TEXTURE_WEBP: 'EXT_texture_webp',
  440. EXT_TEXTURE_AVIF: 'EXT_texture_avif',
  441. EXT_MESHOPT_COMPRESSION: 'EXT_meshopt_compression',
  442. KHR_MESHOPT_COMPRESSION: 'KHR_meshopt_compression',
  443. EXT_MESH_GPU_INSTANCING: 'EXT_mesh_gpu_instancing'
  444. };
  445. /**
  446. * Punctual Lights Extension
  447. *
  448. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
  449. *
  450. * @private
  451. */
  452. class GLTFLightsExtension {
  453. constructor( parser ) {
  454. this.parser = parser;
  455. this.name = EXTENSIONS.KHR_LIGHTS_PUNCTUAL;
  456. // Object3D instance caches
  457. this.cache = { refs: {}, uses: {} };
  458. }
  459. _markDefs() {
  460. const parser = this.parser;
  461. const nodeDefs = this.parser.json.nodes || [];
  462. for ( let nodeIndex = 0, nodeLength = nodeDefs.length; nodeIndex < nodeLength; nodeIndex ++ ) {
  463. const nodeDef = nodeDefs[ nodeIndex ];
  464. if ( nodeDef.extensions
  465. && nodeDef.extensions[ this.name ]
  466. && nodeDef.extensions[ this.name ].light !== undefined ) {
  467. parser._addNodeRef( this.cache, nodeDef.extensions[ this.name ].light );
  468. }
  469. }
  470. }
  471. _loadLight( lightIndex ) {
  472. const parser = this.parser;
  473. const cacheKey = 'light:' + lightIndex;
  474. let dependency = parser.cache.get( cacheKey );
  475. if ( dependency ) return dependency;
  476. const json = parser.json;
  477. const extensions = ( json.extensions && json.extensions[ this.name ] ) || {};
  478. const lightDefs = extensions.lights || [];
  479. const lightDef = lightDefs[ lightIndex ];
  480. let lightNode;
  481. const color = new Color( 0xffffff );
  482. if ( lightDef.color !== undefined ) color.setRGB( lightDef.color[ 0 ], lightDef.color[ 1 ], lightDef.color[ 2 ], LinearSRGBColorSpace );
  483. const range = lightDef.range !== undefined ? lightDef.range : 0;
  484. switch ( lightDef.type ) {
  485. case 'directional':
  486. lightNode = new DirectionalLight( color );
  487. lightNode.target.position.set( 0, 0, - 1 );
  488. lightNode.add( lightNode.target );
  489. break;
  490. case 'point':
  491. lightNode = new PointLight( color );
  492. lightNode.distance = range;
  493. break;
  494. case 'spot':
  495. lightNode = new SpotLight( color );
  496. lightNode.distance = range;
  497. // Handle spotlight properties.
  498. lightDef.spot = lightDef.spot || {};
  499. lightDef.spot.innerConeAngle = lightDef.spot.innerConeAngle !== undefined ? lightDef.spot.innerConeAngle : 0;
  500. lightDef.spot.outerConeAngle = lightDef.spot.outerConeAngle !== undefined ? lightDef.spot.outerConeAngle : Math.PI / 4.0;
  501. lightNode.angle = lightDef.spot.outerConeAngle;
  502. lightNode.penumbra = 1.0 - lightDef.spot.innerConeAngle / lightDef.spot.outerConeAngle;
  503. lightNode.target.position.set( 0, 0, - 1 );
  504. lightNode.add( lightNode.target );
  505. break;
  506. default:
  507. throw new Error( 'THREE.GLTFLoader: Unexpected light type: ' + lightDef.type );
  508. }
  509. // Some lights (e.g. spot) default to a position other than the origin. Reset the position
  510. // here, because node-level parsing will only override position if explicitly specified.
  511. lightNode.position.set( 0, 0, 0 );
  512. assignExtrasToUserData( lightNode, lightDef );
  513. if ( lightDef.intensity !== undefined ) lightNode.intensity = lightDef.intensity;
  514. lightNode.name = parser.createUniqueName( lightDef.name || ( 'light_' + lightIndex ) );
  515. dependency = Promise.resolve( lightNode );
  516. parser.cache.add( cacheKey, dependency );
  517. return dependency;
  518. }
  519. getDependency( type, index ) {
  520. if ( type !== 'light' ) return;
  521. return this._loadLight( index );
  522. }
  523. createNodeAttachment( nodeIndex ) {
  524. const self = this;
  525. const parser = this.parser;
  526. const json = parser.json;
  527. const nodeDef = json.nodes[ nodeIndex ];
  528. const lightDef = ( nodeDef.extensions && nodeDef.extensions[ this.name ] ) || {};
  529. const lightIndex = lightDef.light;
  530. if ( lightIndex === undefined ) return null;
  531. return this._loadLight( lightIndex ).then( function ( light ) {
  532. return parser._getNodeRef( self.cache, lightIndex, light );
  533. } );
  534. }
  535. }
  536. /**
  537. * Unlit Materials Extension
  538. *
  539. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit
  540. *
  541. * @private
  542. */
  543. class GLTFMaterialsUnlitExtension {
  544. constructor() {
  545. this.name = EXTENSIONS.KHR_MATERIALS_UNLIT;
  546. }
  547. getMaterialType() {
  548. return MeshBasicMaterial;
  549. }
  550. extendParams( materialParams, materialDef, parser ) {
  551. const pending = [];
  552. materialParams.color = new Color( 1.0, 1.0, 1.0 );
  553. materialParams.opacity = 1.0;
  554. const metallicRoughness = materialDef.pbrMetallicRoughness;
  555. if ( metallicRoughness ) {
  556. if ( Array.isArray( metallicRoughness.baseColorFactor ) ) {
  557. const array = metallicRoughness.baseColorFactor;
  558. materialParams.color.setRGB( array[ 0 ], array[ 1 ], array[ 2 ], LinearSRGBColorSpace );
  559. materialParams.opacity = array[ 3 ];
  560. }
  561. if ( metallicRoughness.baseColorTexture !== undefined ) {
  562. pending.push( parser.assignTexture( materialParams, 'map', metallicRoughness.baseColorTexture, SRGBColorSpace ) );
  563. }
  564. }
  565. return Promise.all( pending );
  566. }
  567. }
  568. /**
  569. * Materials Emissive Strength Extension
  570. *
  571. * Specification: https://github.com/KhronosGroup/glTF/blob/5768b3ce0ef32bc39cdf1bef10b948586635ead3/extensions/2.0/Khronos/KHR_materials_emissive_strength/README.md
  572. *
  573. * @private
  574. */
  575. class GLTFMaterialsEmissiveStrengthExtension {
  576. constructor( parser ) {
  577. this.parser = parser;
  578. this.name = EXTENSIONS.KHR_MATERIALS_EMISSIVE_STRENGTH;
  579. }
  580. extendMaterialParams( materialIndex, materialParams ) {
  581. const parser = this.parser;
  582. const materialDef = parser.json.materials[ materialIndex ];
  583. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  584. return Promise.resolve();
  585. }
  586. const emissiveStrength = materialDef.extensions[ this.name ].emissiveStrength;
  587. if ( emissiveStrength !== undefined ) {
  588. materialParams.emissiveIntensity = emissiveStrength;
  589. }
  590. return Promise.resolve();
  591. }
  592. }
  593. /**
  594. * Clearcoat Materials Extension
  595. *
  596. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_clearcoat
  597. *
  598. * @private
  599. */
  600. class GLTFMaterialsClearcoatExtension {
  601. constructor( parser ) {
  602. this.parser = parser;
  603. this.name = EXTENSIONS.KHR_MATERIALS_CLEARCOAT;
  604. }
  605. getMaterialType( materialIndex ) {
  606. const parser = this.parser;
  607. const materialDef = parser.json.materials[ materialIndex ];
  608. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  609. return MeshPhysicalMaterial;
  610. }
  611. extendMaterialParams( materialIndex, materialParams ) {
  612. const parser = this.parser;
  613. const materialDef = parser.json.materials[ materialIndex ];
  614. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  615. return Promise.resolve();
  616. }
  617. const pending = [];
  618. const extension = materialDef.extensions[ this.name ];
  619. if ( extension.clearcoatFactor !== undefined ) {
  620. materialParams.clearcoat = extension.clearcoatFactor;
  621. }
  622. if ( extension.clearcoatTexture !== undefined ) {
  623. pending.push( parser.assignTexture( materialParams, 'clearcoatMap', extension.clearcoatTexture ) );
  624. }
  625. if ( extension.clearcoatRoughnessFactor !== undefined ) {
  626. materialParams.clearcoatRoughness = extension.clearcoatRoughnessFactor;
  627. }
  628. if ( extension.clearcoatRoughnessTexture !== undefined ) {
  629. pending.push( parser.assignTexture( materialParams, 'clearcoatRoughnessMap', extension.clearcoatRoughnessTexture ) );
  630. }
  631. if ( extension.clearcoatNormalTexture !== undefined ) {
  632. pending.push( parser.assignTexture( materialParams, 'clearcoatNormalMap', extension.clearcoatNormalTexture ) );
  633. if ( extension.clearcoatNormalTexture.scale !== undefined ) {
  634. const scale = extension.clearcoatNormalTexture.scale;
  635. materialParams.clearcoatNormalScale = new Vector2( scale, scale );
  636. }
  637. }
  638. return Promise.all( pending );
  639. }
  640. }
  641. /**
  642. * Materials dispersion Extension
  643. *
  644. * Specification: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_materials_dispersion
  645. *
  646. * @private
  647. */
  648. class GLTFMaterialsDispersionExtension {
  649. constructor( parser ) {
  650. this.parser = parser;
  651. this.name = EXTENSIONS.KHR_MATERIALS_DISPERSION;
  652. }
  653. getMaterialType( materialIndex ) {
  654. const parser = this.parser;
  655. const materialDef = parser.json.materials[ materialIndex ];
  656. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  657. return MeshPhysicalMaterial;
  658. }
  659. extendMaterialParams( materialIndex, materialParams ) {
  660. const parser = this.parser;
  661. const materialDef = parser.json.materials[ materialIndex ];
  662. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  663. return Promise.resolve();
  664. }
  665. const extension = materialDef.extensions[ this.name ];
  666. materialParams.dispersion = extension.dispersion !== undefined ? extension.dispersion : 0;
  667. return Promise.resolve();
  668. }
  669. }
  670. /**
  671. * Iridescence Materials Extension
  672. *
  673. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_iridescence
  674. *
  675. * @private
  676. */
  677. class GLTFMaterialsIridescenceExtension {
  678. constructor( parser ) {
  679. this.parser = parser;
  680. this.name = EXTENSIONS.KHR_MATERIALS_IRIDESCENCE;
  681. }
  682. getMaterialType( materialIndex ) {
  683. const parser = this.parser;
  684. const materialDef = parser.json.materials[ materialIndex ];
  685. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  686. return MeshPhysicalMaterial;
  687. }
  688. extendMaterialParams( materialIndex, materialParams ) {
  689. const parser = this.parser;
  690. const materialDef = parser.json.materials[ materialIndex ];
  691. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  692. return Promise.resolve();
  693. }
  694. const pending = [];
  695. const extension = materialDef.extensions[ this.name ];
  696. if ( extension.iridescenceFactor !== undefined ) {
  697. materialParams.iridescence = extension.iridescenceFactor;
  698. }
  699. if ( extension.iridescenceTexture !== undefined ) {
  700. pending.push( parser.assignTexture( materialParams, 'iridescenceMap', extension.iridescenceTexture ) );
  701. }
  702. if ( extension.iridescenceIor !== undefined ) {
  703. materialParams.iridescenceIOR = extension.iridescenceIor;
  704. }
  705. if ( materialParams.iridescenceThicknessRange === undefined ) {
  706. materialParams.iridescenceThicknessRange = [ 100, 400 ];
  707. }
  708. if ( extension.iridescenceThicknessMinimum !== undefined ) {
  709. materialParams.iridescenceThicknessRange[ 0 ] = extension.iridescenceThicknessMinimum;
  710. }
  711. if ( extension.iridescenceThicknessMaximum !== undefined ) {
  712. materialParams.iridescenceThicknessRange[ 1 ] = extension.iridescenceThicknessMaximum;
  713. }
  714. if ( extension.iridescenceThicknessTexture !== undefined ) {
  715. pending.push( parser.assignTexture( materialParams, 'iridescenceThicknessMap', extension.iridescenceThicknessTexture ) );
  716. }
  717. return Promise.all( pending );
  718. }
  719. }
  720. /**
  721. * Sheen Materials Extension
  722. *
  723. * Specification: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_materials_sheen
  724. *
  725. * @private
  726. */
  727. class GLTFMaterialsSheenExtension {
  728. constructor( parser ) {
  729. this.parser = parser;
  730. this.name = EXTENSIONS.KHR_MATERIALS_SHEEN;
  731. }
  732. getMaterialType( materialIndex ) {
  733. const parser = this.parser;
  734. const materialDef = parser.json.materials[ materialIndex ];
  735. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  736. return MeshPhysicalMaterial;
  737. }
  738. extendMaterialParams( materialIndex, materialParams ) {
  739. const parser = this.parser;
  740. const materialDef = parser.json.materials[ materialIndex ];
  741. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  742. return Promise.resolve();
  743. }
  744. const pending = [];
  745. materialParams.sheenColor = new Color( 0, 0, 0 );
  746. materialParams.sheenRoughness = 0;
  747. materialParams.sheen = 1;
  748. const extension = materialDef.extensions[ this.name ];
  749. if ( extension.sheenColorFactor !== undefined ) {
  750. const colorFactor = extension.sheenColorFactor;
  751. materialParams.sheenColor.setRGB( colorFactor[ 0 ], colorFactor[ 1 ], colorFactor[ 2 ], LinearSRGBColorSpace );
  752. }
  753. if ( extension.sheenRoughnessFactor !== undefined ) {
  754. materialParams.sheenRoughness = extension.sheenRoughnessFactor;
  755. }
  756. if ( extension.sheenColorTexture !== undefined ) {
  757. pending.push( parser.assignTexture( materialParams, 'sheenColorMap', extension.sheenColorTexture, SRGBColorSpace ) );
  758. }
  759. if ( extension.sheenRoughnessTexture !== undefined ) {
  760. pending.push( parser.assignTexture( materialParams, 'sheenRoughnessMap', extension.sheenRoughnessTexture ) );
  761. }
  762. return Promise.all( pending );
  763. }
  764. }
  765. /**
  766. * Transmission Materials Extension
  767. *
  768. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_transmission
  769. * Draft: https://github.com/KhronosGroup/glTF/pull/1698
  770. *
  771. * @private
  772. */
  773. class GLTFMaterialsTransmissionExtension {
  774. constructor( parser ) {
  775. this.parser = parser;
  776. this.name = EXTENSIONS.KHR_MATERIALS_TRANSMISSION;
  777. }
  778. getMaterialType( materialIndex ) {
  779. const parser = this.parser;
  780. const materialDef = parser.json.materials[ materialIndex ];
  781. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  782. return MeshPhysicalMaterial;
  783. }
  784. extendMaterialParams( materialIndex, materialParams ) {
  785. const parser = this.parser;
  786. const materialDef = parser.json.materials[ materialIndex ];
  787. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  788. return Promise.resolve();
  789. }
  790. const pending = [];
  791. const extension = materialDef.extensions[ this.name ];
  792. if ( extension.transmissionFactor !== undefined ) {
  793. materialParams.transmission = extension.transmissionFactor;
  794. }
  795. if ( extension.transmissionTexture !== undefined ) {
  796. pending.push( parser.assignTexture( materialParams, 'transmissionMap', extension.transmissionTexture ) );
  797. }
  798. return Promise.all( pending );
  799. }
  800. }
  801. /**
  802. * Materials Volume Extension
  803. *
  804. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_volume
  805. *
  806. * @private
  807. */
  808. class GLTFMaterialsVolumeExtension {
  809. constructor( parser ) {
  810. this.parser = parser;
  811. this.name = EXTENSIONS.KHR_MATERIALS_VOLUME;
  812. }
  813. getMaterialType( materialIndex ) {
  814. const parser = this.parser;
  815. const materialDef = parser.json.materials[ materialIndex ];
  816. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  817. return MeshPhysicalMaterial;
  818. }
  819. extendMaterialParams( materialIndex, materialParams ) {
  820. const parser = this.parser;
  821. const materialDef = parser.json.materials[ materialIndex ];
  822. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  823. return Promise.resolve();
  824. }
  825. const pending = [];
  826. const extension = materialDef.extensions[ this.name ];
  827. materialParams.thickness = extension.thicknessFactor !== undefined ? extension.thicknessFactor : 0;
  828. if ( extension.thicknessTexture !== undefined ) {
  829. pending.push( parser.assignTexture( materialParams, 'thicknessMap', extension.thicknessTexture ) );
  830. }
  831. materialParams.attenuationDistance = extension.attenuationDistance || Infinity;
  832. const colorArray = extension.attenuationColor || [ 1, 1, 1 ];
  833. materialParams.attenuationColor = new Color().setRGB( colorArray[ 0 ], colorArray[ 1 ], colorArray[ 2 ], LinearSRGBColorSpace );
  834. return Promise.all( pending );
  835. }
  836. }
  837. /**
  838. * Materials ior Extension
  839. *
  840. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_ior
  841. *
  842. * @private
  843. */
  844. class GLTFMaterialsIorExtension {
  845. constructor( parser ) {
  846. this.parser = parser;
  847. this.name = EXTENSIONS.KHR_MATERIALS_IOR;
  848. }
  849. getMaterialType( materialIndex ) {
  850. const parser = this.parser;
  851. const materialDef = parser.json.materials[ materialIndex ];
  852. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  853. return MeshPhysicalMaterial;
  854. }
  855. extendMaterialParams( materialIndex, materialParams ) {
  856. const parser = this.parser;
  857. const materialDef = parser.json.materials[ materialIndex ];
  858. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  859. return Promise.resolve();
  860. }
  861. const extension = materialDef.extensions[ this.name ];
  862. materialParams.ior = extension.ior !== undefined ? extension.ior : 1.5;
  863. return Promise.resolve();
  864. }
  865. }
  866. /**
  867. * Materials specular Extension
  868. *
  869. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_specular
  870. *
  871. * @private
  872. */
  873. class GLTFMaterialsSpecularExtension {
  874. constructor( parser ) {
  875. this.parser = parser;
  876. this.name = EXTENSIONS.KHR_MATERIALS_SPECULAR;
  877. }
  878. getMaterialType( materialIndex ) {
  879. const parser = this.parser;
  880. const materialDef = parser.json.materials[ materialIndex ];
  881. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  882. return MeshPhysicalMaterial;
  883. }
  884. extendMaterialParams( materialIndex, materialParams ) {
  885. const parser = this.parser;
  886. const materialDef = parser.json.materials[ materialIndex ];
  887. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  888. return Promise.resolve();
  889. }
  890. const pending = [];
  891. const extension = materialDef.extensions[ this.name ];
  892. materialParams.specularIntensity = extension.specularFactor !== undefined ? extension.specularFactor : 1.0;
  893. if ( extension.specularTexture !== undefined ) {
  894. pending.push( parser.assignTexture( materialParams, 'specularIntensityMap', extension.specularTexture ) );
  895. }
  896. const colorArray = extension.specularColorFactor || [ 1, 1, 1 ];
  897. materialParams.specularColor = new Color().setRGB( colorArray[ 0 ], colorArray[ 1 ], colorArray[ 2 ], LinearSRGBColorSpace );
  898. if ( extension.specularColorTexture !== undefined ) {
  899. pending.push( parser.assignTexture( materialParams, 'specularColorMap', extension.specularColorTexture, SRGBColorSpace ) );
  900. }
  901. return Promise.all( pending );
  902. }
  903. }
  904. /**
  905. * Materials bump Extension
  906. *
  907. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/EXT_materials_bump
  908. *
  909. * @private
  910. */
  911. class GLTFMaterialsBumpExtension {
  912. constructor( parser ) {
  913. this.parser = parser;
  914. this.name = EXTENSIONS.EXT_MATERIALS_BUMP;
  915. }
  916. getMaterialType( materialIndex ) {
  917. const parser = this.parser;
  918. const materialDef = parser.json.materials[ materialIndex ];
  919. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  920. return MeshPhysicalMaterial;
  921. }
  922. extendMaterialParams( materialIndex, materialParams ) {
  923. const parser = this.parser;
  924. const materialDef = parser.json.materials[ materialIndex ];
  925. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  926. return Promise.resolve();
  927. }
  928. const pending = [];
  929. const extension = materialDef.extensions[ this.name ];
  930. materialParams.bumpScale = extension.bumpFactor !== undefined ? extension.bumpFactor : 1.0;
  931. if ( extension.bumpTexture !== undefined ) {
  932. pending.push( parser.assignTexture( materialParams, 'bumpMap', extension.bumpTexture ) );
  933. }
  934. return Promise.all( pending );
  935. }
  936. }
  937. /**
  938. * Materials anisotropy Extension
  939. *
  940. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_anisotropy
  941. *
  942. * @private
  943. */
  944. class GLTFMaterialsAnisotropyExtension {
  945. constructor( parser ) {
  946. this.parser = parser;
  947. this.name = EXTENSIONS.KHR_MATERIALS_ANISOTROPY;
  948. }
  949. getMaterialType( materialIndex ) {
  950. const parser = this.parser;
  951. const materialDef = parser.json.materials[ materialIndex ];
  952. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  953. return MeshPhysicalMaterial;
  954. }
  955. extendMaterialParams( materialIndex, materialParams ) {
  956. const parser = this.parser;
  957. const materialDef = parser.json.materials[ materialIndex ];
  958. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  959. return Promise.resolve();
  960. }
  961. const pending = [];
  962. const extension = materialDef.extensions[ this.name ];
  963. if ( extension.anisotropyStrength !== undefined ) {
  964. materialParams.anisotropy = extension.anisotropyStrength;
  965. }
  966. if ( extension.anisotropyRotation !== undefined ) {
  967. materialParams.anisotropyRotation = extension.anisotropyRotation;
  968. }
  969. if ( extension.anisotropyTexture !== undefined ) {
  970. pending.push( parser.assignTexture( materialParams, 'anisotropyMap', extension.anisotropyTexture ) );
  971. }
  972. return Promise.all( pending );
  973. }
  974. }
  975. /**
  976. * BasisU Texture Extension
  977. *
  978. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_basisu
  979. *
  980. * @private
  981. */
  982. class GLTFTextureBasisUExtension {
  983. constructor( parser ) {
  984. this.parser = parser;
  985. this.name = EXTENSIONS.KHR_TEXTURE_BASISU;
  986. }
  987. loadTexture( textureIndex ) {
  988. const parser = this.parser;
  989. const json = parser.json;
  990. const textureDef = json.textures[ textureIndex ];
  991. if ( ! textureDef.extensions || ! textureDef.extensions[ this.name ] ) {
  992. return null;
  993. }
  994. const extension = textureDef.extensions[ this.name ];
  995. const loader = parser.options.ktx2Loader;
  996. if ( ! loader ) {
  997. if ( json.extensionsRequired && json.extensionsRequired.indexOf( this.name ) >= 0 ) {
  998. throw new Error( 'THREE.GLTFLoader: setKTX2Loader must be called before loading KTX2 textures' );
  999. } else {
  1000. // Assumes that the extension is optional and that a fallback texture is present
  1001. return null;
  1002. }
  1003. }
  1004. return parser.loadTextureImage( textureIndex, extension.source, loader );
  1005. }
  1006. }
  1007. /**
  1008. * WebP Texture Extension
  1009. *
  1010. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_texture_webp
  1011. *
  1012. * @private
  1013. */
  1014. class GLTFTextureWebPExtension {
  1015. constructor( parser ) {
  1016. this.parser = parser;
  1017. this.name = EXTENSIONS.EXT_TEXTURE_WEBP;
  1018. }
  1019. loadTexture( textureIndex ) {
  1020. const name = this.name;
  1021. const parser = this.parser;
  1022. const json = parser.json;
  1023. const textureDef = json.textures[ textureIndex ];
  1024. if ( ! textureDef.extensions || ! textureDef.extensions[ name ] ) {
  1025. return null;
  1026. }
  1027. const extension = textureDef.extensions[ name ];
  1028. const source = json.images[ extension.source ];
  1029. let loader = parser.textureLoader;
  1030. if ( source.uri ) {
  1031. const handler = parser.options.manager.getHandler( source.uri );
  1032. if ( handler !== null ) loader = handler;
  1033. }
  1034. return parser.loadTextureImage( textureIndex, extension.source, loader );
  1035. }
  1036. }
  1037. /**
  1038. * AVIF Texture Extension
  1039. *
  1040. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_texture_avif
  1041. *
  1042. * @private
  1043. */
  1044. class GLTFTextureAVIFExtension {
  1045. constructor( parser ) {
  1046. this.parser = parser;
  1047. this.name = EXTENSIONS.EXT_TEXTURE_AVIF;
  1048. }
  1049. loadTexture( textureIndex ) {
  1050. const name = this.name;
  1051. const parser = this.parser;
  1052. const json = parser.json;
  1053. const textureDef = json.textures[ textureIndex ];
  1054. if ( ! textureDef.extensions || ! textureDef.extensions[ name ] ) {
  1055. return null;
  1056. }
  1057. const extension = textureDef.extensions[ name ];
  1058. const source = json.images[ extension.source ];
  1059. let loader = parser.textureLoader;
  1060. if ( source.uri ) {
  1061. const handler = parser.options.manager.getHandler( source.uri );
  1062. if ( handler !== null ) loader = handler;
  1063. }
  1064. return parser.loadTextureImage( textureIndex, extension.source, loader );
  1065. }
  1066. }
  1067. /**
  1068. * meshopt BufferView Compression Extension
  1069. *
  1070. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_meshopt_compression
  1071. *
  1072. * @private
  1073. */
  1074. class GLTFMeshoptCompression {
  1075. constructor( parser, name ) {
  1076. this.name = name;
  1077. this.parser = parser;
  1078. }
  1079. loadBufferView( index ) {
  1080. const json = this.parser.json;
  1081. const bufferView = json.bufferViews[ index ];
  1082. if ( bufferView.extensions && bufferView.extensions[ this.name ] ) {
  1083. const extensionDef = bufferView.extensions[ this.name ];
  1084. const buffer = this.parser.getDependency( 'buffer', extensionDef.buffer );
  1085. const decoder = this.parser.options.meshoptDecoder;
  1086. if ( ! decoder || ! decoder.supported ) {
  1087. if ( json.extensionsRequired && json.extensionsRequired.indexOf( this.name ) >= 0 ) {
  1088. throw new Error( 'THREE.GLTFLoader: setMeshoptDecoder must be called before loading compressed files' );
  1089. } else {
  1090. // Assumes that the extension is optional and that fallback buffer data is present
  1091. return null;
  1092. }
  1093. }
  1094. return buffer.then( function ( res ) {
  1095. const byteOffset = extensionDef.byteOffset || 0;
  1096. const byteLength = extensionDef.byteLength || 0;
  1097. const count = extensionDef.count;
  1098. const stride = extensionDef.byteStride;
  1099. const source = new Uint8Array( res, byteOffset, byteLength );
  1100. if ( decoder.decodeGltfBufferAsync ) {
  1101. return decoder.decodeGltfBufferAsync( count, stride, source, extensionDef.mode, extensionDef.filter ).then( function ( res ) {
  1102. return res.buffer;
  1103. } );
  1104. } else {
  1105. // Support for MeshoptDecoder 0.18 or earlier, without decodeGltfBufferAsync
  1106. return decoder.ready.then( function () {
  1107. const result = new ArrayBuffer( count * stride );
  1108. decoder.decodeGltfBuffer( new Uint8Array( result ), count, stride, source, extensionDef.mode, extensionDef.filter );
  1109. return result;
  1110. } );
  1111. }
  1112. } );
  1113. } else {
  1114. return null;
  1115. }
  1116. }
  1117. }
  1118. /**
  1119. * GPU Instancing Extension
  1120. *
  1121. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_mesh_gpu_instancing
  1122. *
  1123. * @private
  1124. */
  1125. class GLTFMeshGpuInstancing {
  1126. constructor( parser ) {
  1127. this.name = EXTENSIONS.EXT_MESH_GPU_INSTANCING;
  1128. this.parser = parser;
  1129. }
  1130. createNodeMesh( nodeIndex ) {
  1131. const json = this.parser.json;
  1132. const nodeDef = json.nodes[ nodeIndex ];
  1133. if ( ! nodeDef.extensions || ! nodeDef.extensions[ this.name ] ||
  1134. nodeDef.mesh === undefined ) {
  1135. return null;
  1136. }
  1137. const meshDef = json.meshes[ nodeDef.mesh ];
  1138. // No Points or Lines + Instancing support yet
  1139. for ( const primitive of meshDef.primitives ) {
  1140. if ( primitive.mode !== WEBGL_CONSTANTS.TRIANGLES &&
  1141. primitive.mode !== WEBGL_CONSTANTS.TRIANGLE_STRIP &&
  1142. primitive.mode !== WEBGL_CONSTANTS.TRIANGLE_FAN &&
  1143. primitive.mode !== undefined ) {
  1144. return null;
  1145. }
  1146. }
  1147. const extensionDef = nodeDef.extensions[ this.name ];
  1148. const attributesDef = extensionDef.attributes;
  1149. // @TODO: Can we support InstancedMesh + SkinnedMesh?
  1150. const pending = [];
  1151. const attributes = {};
  1152. for ( const key in attributesDef ) {
  1153. pending.push( this.parser.getDependency( 'accessor', attributesDef[ key ] ).then( accessor => {
  1154. attributes[ key ] = accessor;
  1155. return attributes[ key ];
  1156. } ) );
  1157. }
  1158. if ( pending.length < 1 ) {
  1159. return null;
  1160. }
  1161. pending.push( this.parser.createNodeMesh( nodeIndex ) );
  1162. return Promise.all( pending ).then( results => {
  1163. const nodeObject = results.pop();
  1164. const meshes = nodeObject.isGroup ? nodeObject.children : [ nodeObject ];
  1165. const count = results[ 0 ].count; // All attribute counts should be same
  1166. const instancedMeshes = [];
  1167. for ( const mesh of meshes ) {
  1168. // Temporal variables
  1169. const m = new Matrix4();
  1170. const p = new Vector3();
  1171. const q = new Quaternion();
  1172. const s = new Vector3( 1, 1, 1 );
  1173. const instancedMesh = new InstancedMesh( mesh.geometry, mesh.material, count );
  1174. for ( let i = 0; i < count; i ++ ) {
  1175. if ( attributes.TRANSLATION ) {
  1176. p.fromBufferAttribute( attributes.TRANSLATION, i );
  1177. }
  1178. if ( attributes.ROTATION ) {
  1179. q.fromBufferAttribute( attributes.ROTATION, i );
  1180. }
  1181. if ( attributes.SCALE ) {
  1182. s.fromBufferAttribute( attributes.SCALE, i );
  1183. }
  1184. instancedMesh.setMatrixAt( i, m.compose( p, q, s ) );
  1185. }
  1186. // Add instance attributes to the geometry, excluding TRS.
  1187. for ( const attributeName in attributes ) {
  1188. if ( attributeName === '_COLOR_0' ) {
  1189. const attr = attributes[ attributeName ];
  1190. instancedMesh.instanceColor = new InstancedBufferAttribute( attr.array, attr.itemSize, attr.normalized );
  1191. } else if ( attributeName !== 'TRANSLATION' &&
  1192. attributeName !== 'ROTATION' &&
  1193. attributeName !== 'SCALE' ) {
  1194. mesh.geometry.setAttribute( attributeName, attributes[ attributeName ] );
  1195. }
  1196. }
  1197. // Just in case
  1198. Object3D.prototype.copy.call( instancedMesh, mesh );
  1199. this.parser.assignFinalMaterial( instancedMesh );
  1200. instancedMeshes.push( instancedMesh );
  1201. }
  1202. if ( nodeObject.isGroup ) {
  1203. nodeObject.clear();
  1204. nodeObject.add( ... instancedMeshes );
  1205. return nodeObject;
  1206. }
  1207. return instancedMeshes[ 0 ];
  1208. } );
  1209. }
  1210. }
  1211. /* BINARY EXTENSION */
  1212. const BINARY_EXTENSION_HEADER_MAGIC = 'glTF';
  1213. const BINARY_EXTENSION_HEADER_LENGTH = 12;
  1214. const BINARY_EXTENSION_CHUNK_TYPES = { JSON: 0x4E4F534A, BIN: 0x004E4942 };
  1215. class GLTFBinaryExtension {
  1216. constructor( data ) {
  1217. this.name = EXTENSIONS.KHR_BINARY_GLTF;
  1218. this.content = null;
  1219. this.body = null;
  1220. const headerView = new DataView( data, 0, BINARY_EXTENSION_HEADER_LENGTH );
  1221. const textDecoder = new TextDecoder();
  1222. this.header = {
  1223. magic: textDecoder.decode( new Uint8Array( data.slice( 0, 4 ) ) ),
  1224. version: headerView.getUint32( 4, true ),
  1225. length: headerView.getUint32( 8, true )
  1226. };
  1227. if ( this.header.magic !== BINARY_EXTENSION_HEADER_MAGIC ) {
  1228. throw new Error( 'THREE.GLTFLoader: Unsupported glTF-Binary header.' );
  1229. } else if ( this.header.version < 2.0 ) {
  1230. throw new Error( 'THREE.GLTFLoader: Legacy binary file detected.' );
  1231. }
  1232. const chunkContentsLength = this.header.length - BINARY_EXTENSION_HEADER_LENGTH;
  1233. const chunkView = new DataView( data, BINARY_EXTENSION_HEADER_LENGTH );
  1234. let chunkIndex = 0;
  1235. while ( chunkIndex < chunkContentsLength ) {
  1236. const chunkLength = chunkView.getUint32( chunkIndex, true );
  1237. chunkIndex += 4;
  1238. const chunkType = chunkView.getUint32( chunkIndex, true );
  1239. chunkIndex += 4;
  1240. if ( chunkType === BINARY_EXTENSION_CHUNK_TYPES.JSON ) {
  1241. const contentArray = new Uint8Array( data, BINARY_EXTENSION_HEADER_LENGTH + chunkIndex, chunkLength );
  1242. this.content = textDecoder.decode( contentArray );
  1243. } else if ( chunkType === BINARY_EXTENSION_CHUNK_TYPES.BIN ) {
  1244. const byteOffset = BINARY_EXTENSION_HEADER_LENGTH + chunkIndex;
  1245. this.body = data.slice( byteOffset, byteOffset + chunkLength );
  1246. }
  1247. // Clients must ignore chunks with unknown types.
  1248. chunkIndex += chunkLength;
  1249. }
  1250. if ( this.content === null ) {
  1251. throw new Error( 'THREE.GLTFLoader: JSON content not found.' );
  1252. }
  1253. }
  1254. }
  1255. /**
  1256. * DRACO Mesh Compression Extension
  1257. *
  1258. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression
  1259. *
  1260. * @private
  1261. */
  1262. class GLTFDracoMeshCompressionExtension {
  1263. constructor( json, dracoLoader ) {
  1264. if ( ! dracoLoader ) {
  1265. throw new Error( 'THREE.GLTFLoader: No DRACOLoader instance provided.' );
  1266. }
  1267. this.name = EXTENSIONS.KHR_DRACO_MESH_COMPRESSION;
  1268. this.json = json;
  1269. this.dracoLoader = dracoLoader;
  1270. this.dracoLoader.preload();
  1271. }
  1272. decodePrimitive( primitive, parser ) {
  1273. const json = this.json;
  1274. const dracoLoader = this.dracoLoader;
  1275. const bufferViewIndex = primitive.extensions[ this.name ].bufferView;
  1276. const gltfAttributeMap = primitive.extensions[ this.name ].attributes;
  1277. const threeAttributeMap = {};
  1278. const attributeNormalizedMap = {};
  1279. const attributeTypeMap = {};
  1280. for ( const attributeName in gltfAttributeMap ) {
  1281. const threeAttributeName = ATTRIBUTES[ attributeName ] || attributeName.toLowerCase();
  1282. threeAttributeMap[ threeAttributeName ] = gltfAttributeMap[ attributeName ];
  1283. }
  1284. for ( const attributeName in primitive.attributes ) {
  1285. const threeAttributeName = ATTRIBUTES[ attributeName ] || attributeName.toLowerCase();
  1286. if ( gltfAttributeMap[ attributeName ] !== undefined ) {
  1287. const accessorDef = json.accessors[ primitive.attributes[ attributeName ] ];
  1288. const componentType = WEBGL_COMPONENT_TYPES[ accessorDef.componentType ];
  1289. attributeTypeMap[ threeAttributeName ] = componentType.name;
  1290. attributeNormalizedMap[ threeAttributeName ] = accessorDef.normalized === true;
  1291. }
  1292. }
  1293. return parser.getDependency( 'bufferView', bufferViewIndex ).then( function ( bufferView ) {
  1294. return new Promise( function ( resolve, reject ) {
  1295. dracoLoader.decodeDracoFile( bufferView, function ( geometry ) {
  1296. for ( const attributeName in geometry.attributes ) {
  1297. const attribute = geometry.attributes[ attributeName ];
  1298. const normalized = attributeNormalizedMap[ attributeName ];
  1299. if ( normalized !== undefined ) attribute.normalized = normalized;
  1300. }
  1301. resolve( geometry );
  1302. }, threeAttributeMap, attributeTypeMap, LinearSRGBColorSpace, reject );
  1303. } );
  1304. } );
  1305. }
  1306. }
  1307. /**
  1308. * Texture Transform Extension
  1309. *
  1310. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_transform
  1311. *
  1312. * @private
  1313. */
  1314. class GLTFTextureTransformExtension {
  1315. constructor() {
  1316. this.name = EXTENSIONS.KHR_TEXTURE_TRANSFORM;
  1317. }
  1318. extendTexture( texture, transform ) {
  1319. if ( ( transform.texCoord === undefined || transform.texCoord === texture.channel )
  1320. && transform.offset === undefined
  1321. && transform.rotation === undefined
  1322. && transform.scale === undefined ) {
  1323. // See https://github.com/mrdoob/three.js/issues/21819.
  1324. return texture;
  1325. }
  1326. texture = texture.clone();
  1327. if ( transform.texCoord !== undefined ) {
  1328. texture.channel = transform.texCoord;
  1329. }
  1330. if ( transform.offset !== undefined ) {
  1331. texture.offset.fromArray( transform.offset );
  1332. }
  1333. if ( transform.rotation !== undefined ) {
  1334. texture.rotation = transform.rotation;
  1335. }
  1336. if ( transform.scale !== undefined ) {
  1337. texture.repeat.fromArray( transform.scale );
  1338. }
  1339. texture.needsUpdate = true;
  1340. return texture;
  1341. }
  1342. }
  1343. /**
  1344. * Mesh Quantization Extension
  1345. *
  1346. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization
  1347. *
  1348. * @private
  1349. */
  1350. class GLTFMeshQuantizationExtension {
  1351. constructor() {
  1352. this.name = EXTENSIONS.KHR_MESH_QUANTIZATION;
  1353. }
  1354. }
  1355. /*********************************/
  1356. /********** INTERPOLATION ********/
  1357. /*********************************/
  1358. // Spline Interpolation
  1359. // Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#appendix-c-spline-interpolation
  1360. class GLTFCubicSplineInterpolant extends Interpolant {
  1361. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  1362. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  1363. }
  1364. copySampleValue_( index ) {
  1365. // Copies a sample value to the result buffer. See description of glTF
  1366. // CUBICSPLINE values layout in interpolate_() function below.
  1367. const result = this.resultBuffer,
  1368. values = this.sampleValues,
  1369. valueSize = this.valueSize,
  1370. offset = index * valueSize * 3 + valueSize;
  1371. for ( let i = 0; i !== valueSize; i ++ ) {
  1372. result[ i ] = values[ offset + i ];
  1373. }
  1374. return result;
  1375. }
  1376. interpolate_( i1, t0, t, t1 ) {
  1377. const result = this.resultBuffer;
  1378. const values = this.sampleValues;
  1379. const stride = this.valueSize;
  1380. const stride2 = stride * 2;
  1381. const stride3 = stride * 3;
  1382. const td = t1 - t0;
  1383. const p = ( t - t0 ) / td;
  1384. const pp = p * p;
  1385. const ppp = pp * p;
  1386. const offset1 = i1 * stride3;
  1387. const offset0 = offset1 - stride3;
  1388. const s2 = - 2 * ppp + 3 * pp;
  1389. const s3 = ppp - pp;
  1390. const s0 = 1 - s2;
  1391. const s1 = s3 - pp + p;
  1392. // Layout of keyframe output values for CUBICSPLINE animations:
  1393. // [ inTangent_1, splineVertex_1, outTangent_1, inTangent_2, splineVertex_2, ... ]
  1394. for ( let i = 0; i !== stride; i ++ ) {
  1395. const p0 = values[ offset0 + i + stride ]; // splineVertex_k
  1396. const m0 = values[ offset0 + i + stride2 ] * td; // outTangent_k * (t_k+1 - t_k)
  1397. const p1 = values[ offset1 + i + stride ]; // splineVertex_k+1
  1398. const m1 = values[ offset1 + i ] * td; // inTangent_k+1 * (t_k+1 - t_k)
  1399. result[ i ] = s0 * p0 + s1 * m0 + s2 * p1 + s3 * m1;
  1400. }
  1401. return result;
  1402. }
  1403. }
  1404. const _quaternion = new Quaternion();
  1405. class GLTFCubicSplineQuaternionInterpolant extends GLTFCubicSplineInterpolant {
  1406. interpolate_( i1, t0, t, t1 ) {
  1407. const result = super.interpolate_( i1, t0, t, t1 );
  1408. _quaternion.fromArray( result ).normalize().toArray( result );
  1409. return result;
  1410. }
  1411. }
  1412. /*********************************/
  1413. /********** INTERNALS ************/
  1414. /*********************************/
  1415. /* CONSTANTS */
  1416. const WEBGL_CONSTANTS = {
  1417. FLOAT: 5126,
  1418. //FLOAT_MAT2: 35674,
  1419. FLOAT_MAT3: 35675,
  1420. FLOAT_MAT4: 35676,
  1421. FLOAT_VEC2: 35664,
  1422. FLOAT_VEC3: 35665,
  1423. FLOAT_VEC4: 35666,
  1424. LINEAR: 9729,
  1425. REPEAT: 10497,
  1426. SAMPLER_2D: 35678,
  1427. POINTS: 0,
  1428. LINES: 1,
  1429. LINE_LOOP: 2,
  1430. LINE_STRIP: 3,
  1431. TRIANGLES: 4,
  1432. TRIANGLE_STRIP: 5,
  1433. TRIANGLE_FAN: 6,
  1434. UNSIGNED_BYTE: 5121,
  1435. UNSIGNED_SHORT: 5123
  1436. };
  1437. const WEBGL_COMPONENT_TYPES = {
  1438. 5120: Int8Array,
  1439. 5121: Uint8Array,
  1440. 5122: Int16Array,
  1441. 5123: Uint16Array,
  1442. 5125: Uint32Array,
  1443. 5126: Float32Array
  1444. };
  1445. const WEBGL_FILTERS = {
  1446. 9728: NearestFilter,
  1447. 9729: LinearFilter,
  1448. 9984: NearestMipmapNearestFilter,
  1449. 9985: LinearMipmapNearestFilter,
  1450. 9986: NearestMipmapLinearFilter,
  1451. 9987: LinearMipmapLinearFilter
  1452. };
  1453. const WEBGL_WRAPPINGS = {
  1454. 33071: ClampToEdgeWrapping,
  1455. 33648: MirroredRepeatWrapping,
  1456. 10497: RepeatWrapping
  1457. };
  1458. const WEBGL_TYPE_SIZES = {
  1459. 'SCALAR': 1,
  1460. 'VEC2': 2,
  1461. 'VEC3': 3,
  1462. 'VEC4': 4,
  1463. 'MAT2': 4,
  1464. 'MAT3': 9,
  1465. 'MAT4': 16
  1466. };
  1467. const ATTRIBUTES = {
  1468. POSITION: 'position',
  1469. NORMAL: 'normal',
  1470. TANGENT: 'tangent',
  1471. TEXCOORD_0: 'uv',
  1472. TEXCOORD_1: 'uv1',
  1473. TEXCOORD_2: 'uv2',
  1474. TEXCOORD_3: 'uv3',
  1475. COLOR_0: 'color',
  1476. WEIGHTS_0: 'skinWeight',
  1477. JOINTS_0: 'skinIndex',
  1478. };
  1479. const PATH_PROPERTIES = {
  1480. scale: 'scale',
  1481. translation: 'position',
  1482. rotation: 'quaternion',
  1483. weights: 'morphTargetInfluences'
  1484. };
  1485. const INTERPOLATION = {
  1486. CUBICSPLINE: undefined, // We use a custom interpolant (GLTFCubicSplineInterpolation) for CUBICSPLINE tracks. Each
  1487. // keyframe track will be initialized with a default interpolation type, then modified.
  1488. LINEAR: InterpolateLinear,
  1489. STEP: InterpolateDiscrete
  1490. };
  1491. const ALPHA_MODES = {
  1492. OPAQUE: 'OPAQUE',
  1493. MASK: 'MASK',
  1494. BLEND: 'BLEND'
  1495. };
  1496. /**
  1497. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#default-material
  1498. *
  1499. * @private
  1500. * @param {Object<string, Material>} cache
  1501. * @return {Material}
  1502. */
  1503. function createDefaultMaterial( cache ) {
  1504. if ( cache[ 'DefaultMaterial' ] === undefined ) {
  1505. cache[ 'DefaultMaterial' ] = new MeshStandardMaterial( {
  1506. color: 0xFFFFFF,
  1507. emissive: 0x000000,
  1508. metalness: 1,
  1509. roughness: 1,
  1510. transparent: false,
  1511. depthTest: true,
  1512. side: FrontSide
  1513. } );
  1514. }
  1515. return cache[ 'DefaultMaterial' ];
  1516. }
  1517. function addUnknownExtensionsToUserData( knownExtensions, object, objectDef ) {
  1518. // Add unknown glTF extensions to an object's userData.
  1519. for ( const name in objectDef.extensions ) {
  1520. if ( knownExtensions[ name ] === undefined ) {
  1521. object.userData.gltfExtensions = object.userData.gltfExtensions || {};
  1522. object.userData.gltfExtensions[ name ] = objectDef.extensions[ name ];
  1523. }
  1524. }
  1525. }
  1526. /**
  1527. *
  1528. * @private
  1529. * @param {Object3D|Material|BufferGeometry|Object|AnimationClip} object
  1530. * @param {GLTF.definition} gltfDef
  1531. */
  1532. function assignExtrasToUserData( object, gltfDef ) {
  1533. if ( gltfDef.extras !== undefined ) {
  1534. if ( typeof gltfDef.extras === 'object' ) {
  1535. Object.assign( object.userData, gltfDef.extras );
  1536. } else {
  1537. console.warn( 'THREE.GLTFLoader: Ignoring primitive type .extras, ' + gltfDef.extras );
  1538. }
  1539. }
  1540. }
  1541. /**
  1542. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#morph-targets
  1543. *
  1544. * @private
  1545. * @param {BufferGeometry} geometry
  1546. * @param {Array<GLTF.Target>} targets
  1547. * @param {GLTFParser} parser
  1548. * @return {Promise<BufferGeometry>}
  1549. */
  1550. function addMorphTargets( geometry, targets, parser ) {
  1551. let hasMorphPosition = false;
  1552. let hasMorphNormal = false;
  1553. let hasMorphColor = false;
  1554. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  1555. const target = targets[ i ];
  1556. if ( target.POSITION !== undefined ) hasMorphPosition = true;
  1557. if ( target.NORMAL !== undefined ) hasMorphNormal = true;
  1558. if ( target.COLOR_0 !== undefined ) hasMorphColor = true;
  1559. if ( hasMorphPosition && hasMorphNormal && hasMorphColor ) break;
  1560. }
  1561. if ( ! hasMorphPosition && ! hasMorphNormal && ! hasMorphColor ) return Promise.resolve( geometry );
  1562. const pendingPositionAccessors = [];
  1563. const pendingNormalAccessors = [];
  1564. const pendingColorAccessors = [];
  1565. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  1566. const target = targets[ i ];
  1567. if ( hasMorphPosition ) {
  1568. const pendingAccessor = target.POSITION !== undefined
  1569. ? parser.getDependency( 'accessor', target.POSITION )
  1570. : geometry.attributes.position;
  1571. pendingPositionAccessors.push( pendingAccessor );
  1572. }
  1573. if ( hasMorphNormal ) {
  1574. const pendingAccessor = target.NORMAL !== undefined
  1575. ? parser.getDependency( 'accessor', target.NORMAL )
  1576. : geometry.attributes.normal;
  1577. pendingNormalAccessors.push( pendingAccessor );
  1578. }
  1579. if ( hasMorphColor ) {
  1580. const pendingAccessor = target.COLOR_0 !== undefined
  1581. ? parser.getDependency( 'accessor', target.COLOR_0 )
  1582. : geometry.attributes.color;
  1583. pendingColorAccessors.push( pendingAccessor );
  1584. }
  1585. }
  1586. return Promise.all( [
  1587. Promise.all( pendingPositionAccessors ),
  1588. Promise.all( pendingNormalAccessors ),
  1589. Promise.all( pendingColorAccessors )
  1590. ] ).then( function ( accessors ) {
  1591. const morphPositions = accessors[ 0 ];
  1592. const morphNormals = accessors[ 1 ];
  1593. const morphColors = accessors[ 2 ];
  1594. if ( hasMorphPosition ) geometry.morphAttributes.position = morphPositions;
  1595. if ( hasMorphNormal ) geometry.morphAttributes.normal = morphNormals;
  1596. if ( hasMorphColor ) geometry.morphAttributes.color = morphColors;
  1597. geometry.morphTargetsRelative = true;
  1598. return geometry;
  1599. } );
  1600. }
  1601. /**
  1602. *
  1603. * @private
  1604. * @param {Mesh} mesh
  1605. * @param {GLTF.Mesh} meshDef
  1606. */
  1607. function updateMorphTargets( mesh, meshDef ) {
  1608. mesh.updateMorphTargets();
  1609. if ( meshDef.weights !== undefined ) {
  1610. for ( let i = 0, il = meshDef.weights.length; i < il; i ++ ) {
  1611. mesh.morphTargetInfluences[ i ] = meshDef.weights[ i ];
  1612. }
  1613. }
  1614. // .extras has user-defined data, so check that .extras.targetNames is an array.
  1615. if ( meshDef.extras && Array.isArray( meshDef.extras.targetNames ) ) {
  1616. const targetNames = meshDef.extras.targetNames;
  1617. if ( mesh.morphTargetInfluences.length === targetNames.length ) {
  1618. mesh.morphTargetDictionary = {};
  1619. for ( let i = 0, il = targetNames.length; i < il; i ++ ) {
  1620. mesh.morphTargetDictionary[ targetNames[ i ] ] = i;
  1621. }
  1622. } else {
  1623. console.warn( 'THREE.GLTFLoader: Invalid extras.targetNames length. Ignoring names.' );
  1624. }
  1625. }
  1626. }
  1627. function createPrimitiveKey( primitiveDef ) {
  1628. let geometryKey;
  1629. const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ];
  1630. if ( dracoExtension ) {
  1631. geometryKey = 'draco:' + dracoExtension.bufferView
  1632. + ':' + dracoExtension.indices
  1633. + ':' + createAttributesKey( dracoExtension.attributes );
  1634. } else {
  1635. geometryKey = primitiveDef.indices + ':' + createAttributesKey( primitiveDef.attributes ) + ':' + primitiveDef.mode;
  1636. }
  1637. if ( primitiveDef.targets !== undefined ) {
  1638. for ( let i = 0, il = primitiveDef.targets.length; i < il; i ++ ) {
  1639. geometryKey += ':' + createAttributesKey( primitiveDef.targets[ i ] );
  1640. }
  1641. }
  1642. return geometryKey;
  1643. }
  1644. function createAttributesKey( attributes ) {
  1645. let attributesKey = '';
  1646. const keys = Object.keys( attributes ).sort();
  1647. for ( let i = 0, il = keys.length; i < il; i ++ ) {
  1648. attributesKey += keys[ i ] + ':' + attributes[ keys[ i ] ] + ';';
  1649. }
  1650. return attributesKey;
  1651. }
  1652. function getNormalizedComponentScale( constructor ) {
  1653. // Reference:
  1654. // https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization#encoding-quantized-data
  1655. switch ( constructor ) {
  1656. case Int8Array:
  1657. return 1 / 127;
  1658. case Uint8Array:
  1659. return 1 / 255;
  1660. case Int16Array:
  1661. return 1 / 32767;
  1662. case Uint16Array:
  1663. return 1 / 65535;
  1664. default:
  1665. throw new Error( 'THREE.GLTFLoader: Unsupported normalized accessor component type.' );
  1666. }
  1667. }
  1668. function getImageURIMimeType( uri ) {
  1669. if ( uri.search( /\.jpe?g($|\?)/i ) > 0 || uri.search( /^data\:image\/jpeg/ ) === 0 ) return 'image/jpeg';
  1670. if ( uri.search( /\.webp($|\?)/i ) > 0 || uri.search( /^data\:image\/webp/ ) === 0 ) return 'image/webp';
  1671. if ( uri.search( /\.ktx2($|\?)/i ) > 0 || uri.search( /^data\:image\/ktx2/ ) === 0 ) return 'image/ktx2';
  1672. return 'image/png';
  1673. }
  1674. const _identityMatrix = new Matrix4();
  1675. /* GLTF PARSER */
  1676. class GLTFParser {
  1677. constructor( json = {}, options = {} ) {
  1678. this.json = json;
  1679. this.extensions = {};
  1680. this.plugins = {};
  1681. this.options = options;
  1682. // loader object cache
  1683. this.cache = new GLTFRegistry();
  1684. // associations between Three.js objects and glTF elements
  1685. this.associations = new Map();
  1686. // BufferGeometry caching
  1687. this.primitiveCache = {};
  1688. // Node cache
  1689. this.nodeCache = {};
  1690. // Object3D instance caches
  1691. this.meshCache = { refs: {}, uses: {} };
  1692. this.cameraCache = { refs: {}, uses: {} };
  1693. this.lightCache = { refs: {}, uses: {} };
  1694. this.sourceCache = {};
  1695. this.textureCache = {};
  1696. // Track node names, to ensure no duplicates
  1697. this.nodeNamesUsed = {};
  1698. // Use an ImageBitmapLoader if imageBitmaps are supported. Moves much of the
  1699. // expensive work of uploading a texture to the GPU off the main thread.
  1700. let isSafari = false;
  1701. let safariVersion = - 1;
  1702. let isFirefox = false;
  1703. let firefoxVersion = - 1;
  1704. if ( typeof navigator !== 'undefined' && typeof navigator.userAgent !== 'undefined' ) {
  1705. const userAgent = navigator.userAgent;
  1706. isSafari = /^((?!chrome|android).)*safari/i.test( userAgent ) === true;
  1707. const safariMatch = userAgent.match( /Version\/(\d+)/ );
  1708. safariVersion = isSafari && safariMatch ? parseInt( safariMatch[ 1 ], 10 ) : - 1;
  1709. isFirefox = userAgent.indexOf( 'Firefox' ) > - 1;
  1710. firefoxVersion = isFirefox ? userAgent.match( /Firefox\/([0-9]+)\./ )[ 1 ] : - 1;
  1711. }
  1712. if ( typeof createImageBitmap === 'undefined' || ( isSafari && safariVersion < 17 ) || ( isFirefox && firefoxVersion < 98 ) ) {
  1713. this.textureLoader = new TextureLoader( this.options.manager );
  1714. } else {
  1715. this.textureLoader = new ImageBitmapLoader( this.options.manager );
  1716. }
  1717. this.textureLoader.setCrossOrigin( this.options.crossOrigin );
  1718. this.textureLoader.setRequestHeader( this.options.requestHeader );
  1719. this.fileLoader = new FileLoader( this.options.manager );
  1720. this.fileLoader.setResponseType( 'arraybuffer' );
  1721. if ( this.options.crossOrigin === 'use-credentials' ) {
  1722. this.fileLoader.setWithCredentials( true );
  1723. }
  1724. }
  1725. setExtensions( extensions ) {
  1726. this.extensions = extensions;
  1727. }
  1728. setPlugins( plugins ) {
  1729. this.plugins = plugins;
  1730. }
  1731. parse( onLoad, onError ) {
  1732. const parser = this;
  1733. const json = this.json;
  1734. const extensions = this.extensions;
  1735. // Clear the loader cache
  1736. this.cache.removeAll();
  1737. this.nodeCache = {};
  1738. // Mark the special nodes/meshes in json for efficient parse
  1739. this._invokeAll( function ( ext ) {
  1740. return ext._markDefs && ext._markDefs();
  1741. } );
  1742. Promise.all( this._invokeAll( function ( ext ) {
  1743. return ext.beforeRoot && ext.beforeRoot();
  1744. } ) ).then( function () {
  1745. return Promise.all( [
  1746. parser.getDependencies( 'scene' ),
  1747. parser.getDependencies( 'animation' ),
  1748. parser.getDependencies( 'camera' ),
  1749. ] );
  1750. } ).then( function ( dependencies ) {
  1751. const result = {
  1752. scene: dependencies[ 0 ][ json.scene || 0 ],
  1753. scenes: dependencies[ 0 ],
  1754. animations: dependencies[ 1 ],
  1755. cameras: dependencies[ 2 ],
  1756. asset: json.asset,
  1757. parser: parser,
  1758. userData: {}
  1759. };
  1760. addUnknownExtensionsToUserData( extensions, result, json );
  1761. assignExtrasToUserData( result, json );
  1762. return Promise.all( parser._invokeAll( function ( ext ) {
  1763. return ext.afterRoot && ext.afterRoot( result );
  1764. } ) ).then( function () {
  1765. for ( const scene of result.scenes ) {
  1766. scene.updateMatrixWorld();
  1767. }
  1768. onLoad( result );
  1769. } );
  1770. } ).catch( onError );
  1771. }
  1772. /**
  1773. * Marks the special nodes/meshes in json for efficient parse.
  1774. *
  1775. * @private
  1776. */
  1777. _markDefs() {
  1778. const nodeDefs = this.json.nodes || [];
  1779. const skinDefs = this.json.skins || [];
  1780. const meshDefs = this.json.meshes || [];
  1781. // Nothing in the node definition indicates whether it is a Bone or an
  1782. // Object3D. Use the skins' joint references to mark bones.
  1783. for ( let skinIndex = 0, skinLength = skinDefs.length; skinIndex < skinLength; skinIndex ++ ) {
  1784. const joints = skinDefs[ skinIndex ].joints;
  1785. for ( let i = 0, il = joints.length; i < il; i ++ ) {
  1786. nodeDefs[ joints[ i ] ].isBone = true;
  1787. }
  1788. }
  1789. // Iterate over all nodes, marking references to shared resources,
  1790. // as well as skeleton joints.
  1791. for ( let nodeIndex = 0, nodeLength = nodeDefs.length; nodeIndex < nodeLength; nodeIndex ++ ) {
  1792. const nodeDef = nodeDefs[ nodeIndex ];
  1793. if ( nodeDef.mesh !== undefined ) {
  1794. this._addNodeRef( this.meshCache, nodeDef.mesh );
  1795. // Nothing in the mesh definition indicates whether it is
  1796. // a SkinnedMesh or Mesh. Use the node's mesh reference
  1797. // to mark SkinnedMesh if node has skin.
  1798. if ( nodeDef.skin !== undefined ) {
  1799. meshDefs[ nodeDef.mesh ].isSkinnedMesh = true;
  1800. }
  1801. }
  1802. if ( nodeDef.camera !== undefined ) {
  1803. this._addNodeRef( this.cameraCache, nodeDef.camera );
  1804. }
  1805. }
  1806. }
  1807. /**
  1808. * Counts references to shared node / Object3D resources. These resources
  1809. * can be reused, or "instantiated", at multiple nodes in the scene
  1810. * hierarchy. Mesh, Camera, and Light instances are instantiated and must
  1811. * be marked. Non-scenegraph resources (like Materials, Geometries, and
  1812. * Textures) can be reused directly and are not marked here.
  1813. *
  1814. * Example: CesiumMilkTruck sample model reuses "Wheel" meshes.
  1815. *
  1816. * @private
  1817. * @param {Object} cache
  1818. * @param {Object3D} index
  1819. */
  1820. _addNodeRef( cache, index ) {
  1821. if ( index === undefined ) return;
  1822. if ( cache.refs[ index ] === undefined ) {
  1823. cache.refs[ index ] = cache.uses[ index ] = 0;
  1824. }
  1825. cache.refs[ index ] ++;
  1826. }
  1827. /**
  1828. * Returns a reference to a shared resource, cloning it if necessary.
  1829. *
  1830. * @private
  1831. * @param {Object} cache
  1832. * @param {number} index
  1833. * @param {Object} object
  1834. * @return {Object}
  1835. */
  1836. _getNodeRef( cache, index, object ) {
  1837. if ( cache.refs[ index ] <= 1 ) return object;
  1838. const ref = object.clone();
  1839. // Propagates mappings to the cloned object, prevents mappings on the
  1840. // original object from being lost.
  1841. const updateMappings = ( original, clone ) => {
  1842. const mappings = this.associations.get( original );
  1843. if ( mappings != null ) {
  1844. this.associations.set( clone, mappings );
  1845. }
  1846. for ( const [ i, child ] of original.children.entries() ) {
  1847. updateMappings( child, clone.children[ i ] );
  1848. }
  1849. };
  1850. updateMappings( object, ref );
  1851. ref.name += '_instance_' + ( cache.uses[ index ] ++ );
  1852. return ref;
  1853. }
  1854. _invokeOne( func ) {
  1855. const extensions = Object.values( this.plugins );
  1856. extensions.push( this );
  1857. for ( let i = 0; i < extensions.length; i ++ ) {
  1858. const result = func( extensions[ i ] );
  1859. if ( result ) return result;
  1860. }
  1861. return null;
  1862. }
  1863. _invokeAll( func ) {
  1864. const extensions = Object.values( this.plugins );
  1865. extensions.unshift( this );
  1866. const pending = [];
  1867. for ( let i = 0; i < extensions.length; i ++ ) {
  1868. const result = func( extensions[ i ] );
  1869. if ( result ) pending.push( result );
  1870. }
  1871. return pending;
  1872. }
  1873. /**
  1874. * Requests the specified dependency asynchronously, with caching.
  1875. *
  1876. * @private
  1877. * @param {string} type
  1878. * @param {number} index
  1879. * @return {Promise<Object3D|Material|Texture|AnimationClip|ArrayBuffer|Object>}
  1880. */
  1881. getDependency( type, index ) {
  1882. const cacheKey = type + ':' + index;
  1883. let dependency = this.cache.get( cacheKey );
  1884. if ( ! dependency ) {
  1885. switch ( type ) {
  1886. case 'scene':
  1887. dependency = this.loadScene( index );
  1888. break;
  1889. case 'node':
  1890. dependency = this._invokeOne( function ( ext ) {
  1891. return ext.loadNode && ext.loadNode( index );
  1892. } );
  1893. break;
  1894. case 'mesh':
  1895. dependency = this._invokeOne( function ( ext ) {
  1896. return ext.loadMesh && ext.loadMesh( index );
  1897. } );
  1898. break;
  1899. case 'accessor':
  1900. dependency = this.loadAccessor( index );
  1901. break;
  1902. case 'bufferView':
  1903. dependency = this._invokeOne( function ( ext ) {
  1904. return ext.loadBufferView && ext.loadBufferView( index );
  1905. } );
  1906. break;
  1907. case 'buffer':
  1908. dependency = this.loadBuffer( index );
  1909. break;
  1910. case 'material':
  1911. dependency = this._invokeOne( function ( ext ) {
  1912. return ext.loadMaterial && ext.loadMaterial( index );
  1913. } );
  1914. break;
  1915. case 'texture':
  1916. dependency = this._invokeOne( function ( ext ) {
  1917. return ext.loadTexture && ext.loadTexture( index );
  1918. } );
  1919. break;
  1920. case 'skin':
  1921. dependency = this.loadSkin( index );
  1922. break;
  1923. case 'animation':
  1924. dependency = this._invokeOne( function ( ext ) {
  1925. return ext.loadAnimation && ext.loadAnimation( index );
  1926. } );
  1927. break;
  1928. case 'camera':
  1929. dependency = this.loadCamera( index );
  1930. break;
  1931. default:
  1932. dependency = this._invokeOne( function ( ext ) {
  1933. return ext != this && ext.getDependency && ext.getDependency( type, index );
  1934. } );
  1935. if ( ! dependency ) {
  1936. throw new Error( 'Unknown type: ' + type );
  1937. }
  1938. break;
  1939. }
  1940. this.cache.add( cacheKey, dependency );
  1941. }
  1942. return dependency;
  1943. }
  1944. /**
  1945. * Requests all dependencies of the specified type asynchronously, with caching.
  1946. *
  1947. * @private
  1948. * @param {string} type
  1949. * @return {Promise<Array<Object>>}
  1950. */
  1951. getDependencies( type ) {
  1952. let dependencies = this.cache.get( type );
  1953. if ( ! dependencies ) {
  1954. const parser = this;
  1955. const defs = this.json[ type + ( type === 'mesh' ? 'es' : 's' ) ] || [];
  1956. dependencies = Promise.all( defs.map( function ( def, index ) {
  1957. return parser.getDependency( type, index );
  1958. } ) );
  1959. this.cache.add( type, dependencies );
  1960. }
  1961. return dependencies;
  1962. }
  1963. /**
  1964. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#buffers-and-buffer-views
  1965. *
  1966. * @private
  1967. * @param {number} bufferIndex
  1968. * @return {Promise<ArrayBuffer>}
  1969. */
  1970. loadBuffer( bufferIndex ) {
  1971. const bufferDef = this.json.buffers[ bufferIndex ];
  1972. const loader = this.fileLoader;
  1973. if ( bufferDef.type && bufferDef.type !== 'arraybuffer' ) {
  1974. throw new Error( 'THREE.GLTFLoader: ' + bufferDef.type + ' buffer type is not supported.' );
  1975. }
  1976. // If present, GLB container is required to be the first buffer.
  1977. if ( bufferDef.uri === undefined && bufferIndex === 0 ) {
  1978. return Promise.resolve( this.extensions[ EXTENSIONS.KHR_BINARY_GLTF ].body );
  1979. }
  1980. const options = this.options;
  1981. return new Promise( function ( resolve, reject ) {
  1982. loader.load( LoaderUtils.resolveURL( bufferDef.uri, options.path ), resolve, undefined, function () {
  1983. reject( new Error( 'THREE.GLTFLoader: Failed to load buffer "' + bufferDef.uri + '".' ) );
  1984. } );
  1985. } );
  1986. }
  1987. /**
  1988. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#buffers-and-buffer-views
  1989. *
  1990. * @private
  1991. * @param {number} bufferViewIndex
  1992. * @return {Promise<ArrayBuffer>}
  1993. */
  1994. loadBufferView( bufferViewIndex ) {
  1995. const bufferViewDef = this.json.bufferViews[ bufferViewIndex ];
  1996. return this.getDependency( 'buffer', bufferViewDef.buffer ).then( function ( buffer ) {
  1997. const byteLength = bufferViewDef.byteLength || 0;
  1998. const byteOffset = bufferViewDef.byteOffset || 0;
  1999. return buffer.slice( byteOffset, byteOffset + byteLength );
  2000. } );
  2001. }
  2002. /**
  2003. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#accessors
  2004. *
  2005. * @private
  2006. * @param {number} accessorIndex
  2007. * @return {Promise<BufferAttribute|InterleavedBufferAttribute>}
  2008. */
  2009. loadAccessor( accessorIndex ) {
  2010. const parser = this;
  2011. const json = this.json;
  2012. const accessorDef = this.json.accessors[ accessorIndex ];
  2013. if ( accessorDef.bufferView === undefined && accessorDef.sparse === undefined ) {
  2014. const itemSize = WEBGL_TYPE_SIZES[ accessorDef.type ];
  2015. const TypedArray = WEBGL_COMPONENT_TYPES[ accessorDef.componentType ];
  2016. const normalized = accessorDef.normalized === true;
  2017. const array = new TypedArray( accessorDef.count * itemSize );
  2018. return Promise.resolve( new BufferAttribute( array, itemSize, normalized ) );
  2019. }
  2020. const pendingBufferViews = [];
  2021. if ( accessorDef.bufferView !== undefined ) {
  2022. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.bufferView ) );
  2023. } else {
  2024. pendingBufferViews.push( null );
  2025. }
  2026. if ( accessorDef.sparse !== undefined ) {
  2027. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.sparse.indices.bufferView ) );
  2028. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.sparse.values.bufferView ) );
  2029. }
  2030. return Promise.all( pendingBufferViews ).then( function ( bufferViews ) {
  2031. const bufferView = bufferViews[ 0 ];
  2032. const itemSize = WEBGL_TYPE_SIZES[ accessorDef.type ];
  2033. const TypedArray = WEBGL_COMPONENT_TYPES[ accessorDef.componentType ];
  2034. // For VEC3: itemSize is 3, elementBytes is 4, itemBytes is 12.
  2035. const elementBytes = TypedArray.BYTES_PER_ELEMENT;
  2036. const itemBytes = elementBytes * itemSize;
  2037. const byteOffset = accessorDef.byteOffset || 0;
  2038. const byteStride = accessorDef.bufferView !== undefined ? json.bufferViews[ accessorDef.bufferView ].byteStride : undefined;
  2039. const normalized = accessorDef.normalized === true;
  2040. let array, bufferAttribute;
  2041. // The buffer is not interleaved if the stride is the item size in bytes.
  2042. if ( byteStride && byteStride !== itemBytes ) {
  2043. // Each "slice" of the buffer, as defined by 'count' elements of 'byteStride' bytes, gets its own InterleavedBuffer
  2044. // This makes sure that IBA.count reflects accessor.count properly
  2045. const ibSlice = Math.floor( byteOffset / byteStride );
  2046. const ibCacheKey = 'InterleavedBuffer:' + accessorDef.bufferView + ':' + accessorDef.componentType + ':' + ibSlice + ':' + accessorDef.count;
  2047. let ib = parser.cache.get( ibCacheKey );
  2048. if ( ! ib ) {
  2049. array = new TypedArray( bufferView, ibSlice * byteStride, accessorDef.count * byteStride / elementBytes );
  2050. // Integer parameters to IB/IBA are in array elements, not bytes.
  2051. ib = new InterleavedBuffer( array, byteStride / elementBytes );
  2052. parser.cache.add( ibCacheKey, ib );
  2053. }
  2054. bufferAttribute = new InterleavedBufferAttribute( ib, itemSize, ( byteOffset % byteStride ) / elementBytes, normalized );
  2055. } else {
  2056. if ( bufferView === null ) {
  2057. array = new TypedArray( accessorDef.count * itemSize );
  2058. } else {
  2059. array = new TypedArray( bufferView, byteOffset, accessorDef.count * itemSize );
  2060. }
  2061. bufferAttribute = new BufferAttribute( array, itemSize, normalized );
  2062. }
  2063. // https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#sparse-accessors
  2064. if ( accessorDef.sparse !== undefined ) {
  2065. const itemSizeIndices = WEBGL_TYPE_SIZES.SCALAR;
  2066. const TypedArrayIndices = WEBGL_COMPONENT_TYPES[ accessorDef.sparse.indices.componentType ];
  2067. const byteOffsetIndices = accessorDef.sparse.indices.byteOffset || 0;
  2068. const byteOffsetValues = accessorDef.sparse.values.byteOffset || 0;
  2069. const sparseIndices = new TypedArrayIndices( bufferViews[ 1 ], byteOffsetIndices, accessorDef.sparse.count * itemSizeIndices );
  2070. const sparseValues = new TypedArray( bufferViews[ 2 ], byteOffsetValues, accessorDef.sparse.count * itemSize );
  2071. if ( bufferView !== null ) {
  2072. // Avoid modifying the original ArrayBuffer, if the bufferView wasn't initialized with zeroes.
  2073. bufferAttribute = new BufferAttribute( bufferAttribute.array.slice(), bufferAttribute.itemSize, bufferAttribute.normalized );
  2074. }
  2075. // Ignore normalized since we copy from sparse
  2076. bufferAttribute.normalized = false;
  2077. for ( let i = 0, il = sparseIndices.length; i < il; i ++ ) {
  2078. const index = sparseIndices[ i ];
  2079. bufferAttribute.setX( index, sparseValues[ i * itemSize ] );
  2080. if ( itemSize >= 2 ) bufferAttribute.setY( index, sparseValues[ i * itemSize + 1 ] );
  2081. if ( itemSize >= 3 ) bufferAttribute.setZ( index, sparseValues[ i * itemSize + 2 ] );
  2082. if ( itemSize >= 4 ) bufferAttribute.setW( index, sparseValues[ i * itemSize + 3 ] );
  2083. if ( itemSize >= 5 ) throw new Error( 'THREE.GLTFLoader: Unsupported itemSize in sparse BufferAttribute.' );
  2084. }
  2085. bufferAttribute.normalized = normalized;
  2086. }
  2087. return bufferAttribute;
  2088. } );
  2089. }
  2090. /**
  2091. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#textures
  2092. *
  2093. * @private
  2094. * @param {number} textureIndex
  2095. * @return {Promise<?Texture>}
  2096. */
  2097. loadTexture( textureIndex ) {
  2098. const json = this.json;
  2099. const options = this.options;
  2100. const textureDef = json.textures[ textureIndex ];
  2101. const sourceIndex = textureDef.source;
  2102. const sourceDef = json.images[ sourceIndex ];
  2103. let loader = this.textureLoader;
  2104. if ( sourceDef.uri ) {
  2105. const handler = options.manager.getHandler( sourceDef.uri );
  2106. if ( handler !== null ) loader = handler;
  2107. }
  2108. return this.loadTextureImage( textureIndex, sourceIndex, loader );
  2109. }
  2110. loadTextureImage( textureIndex, sourceIndex, loader ) {
  2111. const parser = this;
  2112. const json = this.json;
  2113. const textureDef = json.textures[ textureIndex ];
  2114. const sourceDef = json.images[ sourceIndex ];
  2115. const cacheKey = ( sourceDef.uri || sourceDef.bufferView ) + ':' + textureDef.sampler;
  2116. if ( this.textureCache[ cacheKey ] ) {
  2117. // See https://github.com/mrdoob/three.js/issues/21559.
  2118. return this.textureCache[ cacheKey ];
  2119. }
  2120. const promise = this.loadImageSource( sourceIndex, loader ).then( function ( texture ) {
  2121. texture.flipY = false;
  2122. texture.name = textureDef.name || sourceDef.name || '';
  2123. if ( texture.name === '' && typeof sourceDef.uri === 'string' && sourceDef.uri.startsWith( 'data:image/' ) === false ) {
  2124. texture.name = sourceDef.uri;
  2125. }
  2126. const samplers = json.samplers || {};
  2127. const sampler = samplers[ textureDef.sampler ] || {};
  2128. texture.magFilter = WEBGL_FILTERS[ sampler.magFilter ] || LinearFilter;
  2129. texture.minFilter = WEBGL_FILTERS[ sampler.minFilter ] || LinearMipmapLinearFilter;
  2130. texture.wrapS = WEBGL_WRAPPINGS[ sampler.wrapS ] || RepeatWrapping;
  2131. texture.wrapT = WEBGL_WRAPPINGS[ sampler.wrapT ] || RepeatWrapping;
  2132. texture.generateMipmaps = ! texture.isCompressedTexture && texture.minFilter !== NearestFilter && texture.minFilter !== LinearFilter;
  2133. parser.associations.set( texture, { textures: textureIndex } );
  2134. return texture;
  2135. } ).catch( function () {
  2136. return null;
  2137. } );
  2138. this.textureCache[ cacheKey ] = promise;
  2139. return promise;
  2140. }
  2141. loadImageSource( sourceIndex, loader ) {
  2142. const parser = this;
  2143. const json = this.json;
  2144. const options = this.options;
  2145. if ( this.sourceCache[ sourceIndex ] !== undefined ) {
  2146. return this.sourceCache[ sourceIndex ].then( ( texture ) => texture.clone() );
  2147. }
  2148. const sourceDef = json.images[ sourceIndex ];
  2149. const URL = self.URL || self.webkitURL;
  2150. let sourceURI = sourceDef.uri || '';
  2151. let isObjectURL = false;
  2152. if ( sourceDef.bufferView !== undefined ) {
  2153. // Load binary image data from bufferView, if provided.
  2154. sourceURI = parser.getDependency( 'bufferView', sourceDef.bufferView ).then( function ( bufferView ) {
  2155. isObjectURL = true;
  2156. const blob = new Blob( [ bufferView ], { type: sourceDef.mimeType } );
  2157. sourceURI = URL.createObjectURL( blob );
  2158. return sourceURI;
  2159. } );
  2160. } else if ( sourceDef.uri === undefined ) {
  2161. throw new Error( 'THREE.GLTFLoader: Image ' + sourceIndex + ' is missing URI and bufferView' );
  2162. }
  2163. const promise = Promise.resolve( sourceURI ).then( function ( sourceURI ) {
  2164. return new Promise( function ( resolve, reject ) {
  2165. let onLoad = resolve;
  2166. if ( loader.isImageBitmapLoader === true ) {
  2167. onLoad = function ( imageBitmap ) {
  2168. const texture = new Texture( imageBitmap );
  2169. texture.needsUpdate = true;
  2170. resolve( texture );
  2171. };
  2172. }
  2173. loader.load( LoaderUtils.resolveURL( sourceURI, options.path ), onLoad, undefined, reject );
  2174. } );
  2175. } ).then( function ( texture ) {
  2176. // Clean up resources and configure Texture.
  2177. if ( isObjectURL === true ) {
  2178. URL.revokeObjectURL( sourceURI );
  2179. }
  2180. assignExtrasToUserData( texture, sourceDef );
  2181. texture.userData.mimeType = sourceDef.mimeType || getImageURIMimeType( sourceDef.uri );
  2182. return texture;
  2183. } ).catch( function ( error ) {
  2184. console.error( 'THREE.GLTFLoader: Couldn\'t load texture', sourceURI );
  2185. throw error;
  2186. } );
  2187. this.sourceCache[ sourceIndex ] = promise;
  2188. return promise;
  2189. }
  2190. /**
  2191. * Asynchronously assigns a texture to the given material parameters.
  2192. *
  2193. * @private
  2194. * @param {Object} materialParams
  2195. * @param {string} mapName
  2196. * @param {Object} mapDef
  2197. * @param {string} [colorSpace]
  2198. * @return {Promise<Texture>}
  2199. */
  2200. assignTexture( materialParams, mapName, mapDef, colorSpace ) {
  2201. const parser = this;
  2202. return this.getDependency( 'texture', mapDef.index ).then( function ( texture ) {
  2203. if ( ! texture ) return null;
  2204. if ( mapDef.texCoord !== undefined && mapDef.texCoord > 0 ) {
  2205. texture = texture.clone();
  2206. texture.channel = mapDef.texCoord;
  2207. }
  2208. if ( parser.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ] ) {
  2209. const transform = mapDef.extensions !== undefined ? mapDef.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ] : undefined;
  2210. if ( transform ) {
  2211. const gltfReference = parser.associations.get( texture );
  2212. texture = parser.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ].extendTexture( texture, transform );
  2213. parser.associations.set( texture, gltfReference );
  2214. }
  2215. }
  2216. if ( colorSpace !== undefined ) {
  2217. texture.colorSpace = colorSpace;
  2218. }
  2219. materialParams[ mapName ] = texture;
  2220. return texture;
  2221. } );
  2222. }
  2223. /**
  2224. * Assigns final material to a Mesh, Line, or Points instance. The instance
  2225. * already has a material (generated from the glTF material options alone)
  2226. * but reuse of the same glTF material may require multiple threejs materials
  2227. * to accommodate different primitive types, defines, etc. New materials will
  2228. * be created if necessary, and reused from a cache.
  2229. *
  2230. * @private
  2231. * @param {Object3D} mesh Mesh, Line, or Points instance.
  2232. */
  2233. assignFinalMaterial( mesh ) {
  2234. const geometry = mesh.geometry;
  2235. let material = mesh.material;
  2236. const useDerivativeTangents = geometry.attributes.tangent === undefined;
  2237. const useVertexColors = geometry.attributes.color !== undefined;
  2238. const useFlatShading = geometry.attributes.normal === undefined;
  2239. if ( mesh.isPoints ) {
  2240. const cacheKey = 'PointsMaterial:' + material.uuid;
  2241. let pointsMaterial = this.cache.get( cacheKey );
  2242. if ( ! pointsMaterial ) {
  2243. pointsMaterial = new PointsMaterial();
  2244. Material.prototype.copy.call( pointsMaterial, material );
  2245. pointsMaterial.color.copy( material.color );
  2246. pointsMaterial.map = material.map;
  2247. pointsMaterial.sizeAttenuation = false; // glTF spec says points should be 1px
  2248. this.cache.add( cacheKey, pointsMaterial );
  2249. }
  2250. material = pointsMaterial;
  2251. } else if ( mesh.isLine ) {
  2252. const cacheKey = 'LineBasicMaterial:' + material.uuid;
  2253. let lineMaterial = this.cache.get( cacheKey );
  2254. if ( ! lineMaterial ) {
  2255. lineMaterial = new LineBasicMaterial();
  2256. Material.prototype.copy.call( lineMaterial, material );
  2257. lineMaterial.color.copy( material.color );
  2258. lineMaterial.map = material.map;
  2259. this.cache.add( cacheKey, lineMaterial );
  2260. }
  2261. material = lineMaterial;
  2262. }
  2263. // Clone the material if it will be modified
  2264. if ( useDerivativeTangents || useVertexColors || useFlatShading ) {
  2265. let cacheKey = 'ClonedMaterial:' + material.uuid + ':';
  2266. if ( useDerivativeTangents ) cacheKey += 'derivative-tangents:';
  2267. if ( useVertexColors ) cacheKey += 'vertex-colors:';
  2268. if ( useFlatShading ) cacheKey += 'flat-shading:';
  2269. let cachedMaterial = this.cache.get( cacheKey );
  2270. if ( ! cachedMaterial ) {
  2271. cachedMaterial = material.clone();
  2272. if ( useVertexColors ) cachedMaterial.vertexColors = true;
  2273. if ( useFlatShading ) cachedMaterial.flatShading = true;
  2274. if ( useDerivativeTangents ) {
  2275. // https://github.com/mrdoob/three.js/issues/11438#issuecomment-507003995
  2276. if ( cachedMaterial.normalScale ) cachedMaterial.normalScale.y *= - 1;
  2277. if ( cachedMaterial.clearcoatNormalScale ) cachedMaterial.clearcoatNormalScale.y *= - 1;
  2278. }
  2279. this.cache.add( cacheKey, cachedMaterial );
  2280. this.associations.set( cachedMaterial, this.associations.get( material ) );
  2281. }
  2282. material = cachedMaterial;
  2283. }
  2284. mesh.material = material;
  2285. }
  2286. getMaterialType( /* materialIndex */ ) {
  2287. return MeshStandardMaterial;
  2288. }
  2289. /**
  2290. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#materials
  2291. *
  2292. * @private
  2293. * @param {number} materialIndex
  2294. * @return {Promise<Material>}
  2295. */
  2296. loadMaterial( materialIndex ) {
  2297. const parser = this;
  2298. const json = this.json;
  2299. const extensions = this.extensions;
  2300. const materialDef = json.materials[ materialIndex ];
  2301. let materialType;
  2302. const materialParams = {};
  2303. const materialExtensions = materialDef.extensions || {};
  2304. const pending = [];
  2305. if ( materialExtensions[ EXTENSIONS.KHR_MATERIALS_UNLIT ] ) {
  2306. const kmuExtension = extensions[ EXTENSIONS.KHR_MATERIALS_UNLIT ];
  2307. materialType = kmuExtension.getMaterialType();
  2308. pending.push( kmuExtension.extendParams( materialParams, materialDef, parser ) );
  2309. } else {
  2310. // Specification:
  2311. // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#metallic-roughness-material
  2312. const metallicRoughness = materialDef.pbrMetallicRoughness || {};
  2313. materialParams.color = new Color( 1.0, 1.0, 1.0 );
  2314. materialParams.opacity = 1.0;
  2315. if ( Array.isArray( metallicRoughness.baseColorFactor ) ) {
  2316. const array = metallicRoughness.baseColorFactor;
  2317. materialParams.color.setRGB( array[ 0 ], array[ 1 ], array[ 2 ], LinearSRGBColorSpace );
  2318. materialParams.opacity = array[ 3 ];
  2319. }
  2320. if ( metallicRoughness.baseColorTexture !== undefined ) {
  2321. pending.push( parser.assignTexture( materialParams, 'map', metallicRoughness.baseColorTexture, SRGBColorSpace ) );
  2322. }
  2323. materialParams.metalness = metallicRoughness.metallicFactor !== undefined ? metallicRoughness.metallicFactor : 1.0;
  2324. materialParams.roughness = metallicRoughness.roughnessFactor !== undefined ? metallicRoughness.roughnessFactor : 1.0;
  2325. if ( metallicRoughness.metallicRoughnessTexture !== undefined ) {
  2326. pending.push( parser.assignTexture( materialParams, 'metalnessMap', metallicRoughness.metallicRoughnessTexture ) );
  2327. pending.push( parser.assignTexture( materialParams, 'roughnessMap', metallicRoughness.metallicRoughnessTexture ) );
  2328. }
  2329. materialType = this._invokeOne( function ( ext ) {
  2330. return ext.getMaterialType && ext.getMaterialType( materialIndex );
  2331. } );
  2332. pending.push( Promise.all( this._invokeAll( function ( ext ) {
  2333. return ext.extendMaterialParams && ext.extendMaterialParams( materialIndex, materialParams );
  2334. } ) ) );
  2335. }
  2336. if ( materialDef.doubleSided === true ) {
  2337. materialParams.side = DoubleSide;
  2338. }
  2339. const alphaMode = materialDef.alphaMode || ALPHA_MODES.OPAQUE;
  2340. if ( alphaMode === ALPHA_MODES.BLEND ) {
  2341. materialParams.transparent = true;
  2342. // See: https://github.com/mrdoob/three.js/issues/17706
  2343. materialParams.depthWrite = false;
  2344. } else {
  2345. materialParams.transparent = false;
  2346. if ( alphaMode === ALPHA_MODES.MASK ) {
  2347. materialParams.alphaTest = materialDef.alphaCutoff !== undefined ? materialDef.alphaCutoff : 0.5;
  2348. }
  2349. }
  2350. if ( materialDef.normalTexture !== undefined && materialType !== MeshBasicMaterial ) {
  2351. pending.push( parser.assignTexture( materialParams, 'normalMap', materialDef.normalTexture ) );
  2352. materialParams.normalScale = new Vector2( 1, 1 );
  2353. if ( materialDef.normalTexture.scale !== undefined ) {
  2354. const scale = materialDef.normalTexture.scale;
  2355. materialParams.normalScale.set( scale, scale );
  2356. }
  2357. }
  2358. if ( materialDef.occlusionTexture !== undefined && materialType !== MeshBasicMaterial ) {
  2359. pending.push( parser.assignTexture( materialParams, 'aoMap', materialDef.occlusionTexture ) );
  2360. if ( materialDef.occlusionTexture.strength !== undefined ) {
  2361. materialParams.aoMapIntensity = materialDef.occlusionTexture.strength;
  2362. }
  2363. }
  2364. if ( materialDef.emissiveFactor !== undefined && materialType !== MeshBasicMaterial ) {
  2365. const emissiveFactor = materialDef.emissiveFactor;
  2366. materialParams.emissive = new Color().setRGB( emissiveFactor[ 0 ], emissiveFactor[ 1 ], emissiveFactor[ 2 ], LinearSRGBColorSpace );
  2367. }
  2368. if ( materialDef.emissiveTexture !== undefined && materialType !== MeshBasicMaterial ) {
  2369. pending.push( parser.assignTexture( materialParams, 'emissiveMap', materialDef.emissiveTexture, SRGBColorSpace ) );
  2370. }
  2371. return Promise.all( pending ).then( function () {
  2372. const material = new materialType( materialParams );
  2373. if ( materialDef.name ) material.name = materialDef.name;
  2374. assignExtrasToUserData( material, materialDef );
  2375. parser.associations.set( material, { materials: materialIndex } );
  2376. if ( materialDef.extensions ) addUnknownExtensionsToUserData( extensions, material, materialDef );
  2377. return material;
  2378. } );
  2379. }
  2380. /**
  2381. * When Object3D instances are targeted by animation, they need unique names.
  2382. *
  2383. * @private
  2384. * @param {string} originalName
  2385. * @return {string}
  2386. */
  2387. createUniqueName( originalName ) {
  2388. const sanitizedName = PropertyBinding.sanitizeNodeName( originalName || '' );
  2389. if ( sanitizedName in this.nodeNamesUsed ) {
  2390. return sanitizedName + '_' + ( ++ this.nodeNamesUsed[ sanitizedName ] );
  2391. } else {
  2392. this.nodeNamesUsed[ sanitizedName ] = 0;
  2393. return sanitizedName;
  2394. }
  2395. }
  2396. /**
  2397. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#geometry
  2398. *
  2399. * Creates BufferGeometries from primitives.
  2400. *
  2401. * @private
  2402. * @param {Array<GLTF.Primitive>} primitives
  2403. * @return {Promise<Array<BufferGeometry>>}
  2404. */
  2405. loadGeometries( primitives ) {
  2406. const parser = this;
  2407. const extensions = this.extensions;
  2408. const cache = this.primitiveCache;
  2409. function createDracoPrimitive( primitive ) {
  2410. return extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ]
  2411. .decodePrimitive( primitive, parser )
  2412. .then( function ( geometry ) {
  2413. return addPrimitiveAttributes( geometry, primitive, parser );
  2414. } );
  2415. }
  2416. const pending = [];
  2417. for ( let i = 0, il = primitives.length; i < il; i ++ ) {
  2418. const primitive = primitives[ i ];
  2419. const cacheKey = createPrimitiveKey( primitive );
  2420. // See if we've already created this geometry
  2421. const cached = cache[ cacheKey ];
  2422. if ( cached ) {
  2423. // Use the cached geometry if it exists
  2424. pending.push( cached.promise );
  2425. } else {
  2426. let geometryPromise;
  2427. if ( primitive.extensions && primitive.extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ] ) {
  2428. // Use DRACO geometry if available
  2429. geometryPromise = createDracoPrimitive( primitive );
  2430. } else {
  2431. // Otherwise create a new geometry
  2432. geometryPromise = addPrimitiveAttributes( new BufferGeometry(), primitive, parser );
  2433. }
  2434. // Cache this geometry
  2435. cache[ cacheKey ] = { primitive: primitive, promise: geometryPromise };
  2436. pending.push( geometryPromise );
  2437. }
  2438. }
  2439. return Promise.all( pending );
  2440. }
  2441. /**
  2442. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#meshes
  2443. *
  2444. * @private
  2445. * @param {number} meshIndex
  2446. * @return {Promise<Group|Mesh|SkinnedMesh|Line|Points>}
  2447. */
  2448. loadMesh( meshIndex ) {
  2449. const parser = this;
  2450. const json = this.json;
  2451. const extensions = this.extensions;
  2452. const meshDef = json.meshes[ meshIndex ];
  2453. const primitives = meshDef.primitives;
  2454. const pending = [];
  2455. for ( let i = 0, il = primitives.length; i < il; i ++ ) {
  2456. const material = primitives[ i ].material === undefined
  2457. ? createDefaultMaterial( this.cache )
  2458. : this.getDependency( 'material', primitives[ i ].material );
  2459. pending.push( material );
  2460. }
  2461. pending.push( parser.loadGeometries( primitives ) );
  2462. return Promise.all( pending ).then( function ( results ) {
  2463. const materials = results.slice( 0, results.length - 1 );
  2464. const geometries = results[ results.length - 1 ];
  2465. const meshes = [];
  2466. for ( let i = 0, il = geometries.length; i < il; i ++ ) {
  2467. const geometry = geometries[ i ];
  2468. const primitive = primitives[ i ];
  2469. // 1. create Mesh
  2470. let mesh;
  2471. const material = materials[ i ];
  2472. if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLES ||
  2473. primitive.mode === WEBGL_CONSTANTS.TRIANGLE_STRIP ||
  2474. primitive.mode === WEBGL_CONSTANTS.TRIANGLE_FAN ||
  2475. primitive.mode === undefined ) {
  2476. // .isSkinnedMesh isn't in glTF spec. See ._markDefs()
  2477. mesh = meshDef.isSkinnedMesh === true
  2478. ? new SkinnedMesh( geometry, material )
  2479. : new Mesh( geometry, material );
  2480. if ( mesh.isSkinnedMesh === true ) {
  2481. // normalize skin weights to fix malformed assets (see #15319)
  2482. mesh.normalizeSkinWeights();
  2483. }
  2484. if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLE_STRIP ) {
  2485. mesh.geometry = toTrianglesDrawMode( mesh.geometry, TriangleStripDrawMode );
  2486. } else if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLE_FAN ) {
  2487. mesh.geometry = toTrianglesDrawMode( mesh.geometry, TriangleFanDrawMode );
  2488. }
  2489. } else if ( primitive.mode === WEBGL_CONSTANTS.LINES ) {
  2490. mesh = new LineSegments( geometry, material );
  2491. } else if ( primitive.mode === WEBGL_CONSTANTS.LINE_STRIP ) {
  2492. mesh = new Line( geometry, material );
  2493. } else if ( primitive.mode === WEBGL_CONSTANTS.LINE_LOOP ) {
  2494. mesh = new LineLoop( geometry, material );
  2495. } else if ( primitive.mode === WEBGL_CONSTANTS.POINTS ) {
  2496. mesh = new Points( geometry, material );
  2497. } else {
  2498. throw new Error( 'THREE.GLTFLoader: Primitive mode unsupported: ' + primitive.mode );
  2499. }
  2500. if ( Object.keys( mesh.geometry.morphAttributes ).length > 0 ) {
  2501. updateMorphTargets( mesh, meshDef );
  2502. }
  2503. mesh.name = parser.createUniqueName( meshDef.name || ( 'mesh_' + meshIndex ) );
  2504. assignExtrasToUserData( mesh, meshDef );
  2505. if ( primitive.extensions ) addUnknownExtensionsToUserData( extensions, mesh, primitive );
  2506. parser.assignFinalMaterial( mesh );
  2507. meshes.push( mesh );
  2508. }
  2509. for ( let i = 0, il = meshes.length; i < il; i ++ ) {
  2510. parser.associations.set( meshes[ i ], {
  2511. meshes: meshIndex,
  2512. primitives: i
  2513. } );
  2514. }
  2515. if ( meshes.length === 1 ) {
  2516. if ( meshDef.extensions ) addUnknownExtensionsToUserData( extensions, meshes[ 0 ], meshDef );
  2517. return meshes[ 0 ];
  2518. }
  2519. const group = new Group();
  2520. if ( meshDef.extensions ) addUnknownExtensionsToUserData( extensions, group, meshDef );
  2521. parser.associations.set( group, { meshes: meshIndex } );
  2522. for ( let i = 0, il = meshes.length; i < il; i ++ ) {
  2523. group.add( meshes[ i ] );
  2524. }
  2525. return group;
  2526. } );
  2527. }
  2528. /**
  2529. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#cameras
  2530. *
  2531. * @private
  2532. * @param {number} cameraIndex
  2533. * @return {Promise<Camera>|undefined}
  2534. */
  2535. loadCamera( cameraIndex ) {
  2536. let camera;
  2537. const cameraDef = this.json.cameras[ cameraIndex ];
  2538. const params = cameraDef[ cameraDef.type ];
  2539. if ( ! params ) {
  2540. console.warn( 'THREE.GLTFLoader: Missing camera parameters.' );
  2541. return;
  2542. }
  2543. if ( cameraDef.type === 'perspective' ) {
  2544. camera = new PerspectiveCamera( MathUtils.radToDeg( params.yfov ), params.aspectRatio || 1, params.znear || 1, params.zfar || 2e6 );
  2545. } else if ( cameraDef.type === 'orthographic' ) {
  2546. camera = new OrthographicCamera( - params.xmag, params.xmag, params.ymag, - params.ymag, params.znear, params.zfar );
  2547. }
  2548. if ( cameraDef.name ) camera.name = this.createUniqueName( cameraDef.name );
  2549. assignExtrasToUserData( camera, cameraDef );
  2550. return Promise.resolve( camera );
  2551. }
  2552. /**
  2553. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#skins
  2554. *
  2555. * @private
  2556. * @param {number} skinIndex
  2557. * @return {Promise<Skeleton>}
  2558. */
  2559. loadSkin( skinIndex ) {
  2560. const skinDef = this.json.skins[ skinIndex ];
  2561. const pending = [];
  2562. for ( let i = 0, il = skinDef.joints.length; i < il; i ++ ) {
  2563. pending.push( this._loadNodeShallow( skinDef.joints[ i ] ) );
  2564. }
  2565. if ( skinDef.inverseBindMatrices !== undefined ) {
  2566. pending.push( this.getDependency( 'accessor', skinDef.inverseBindMatrices ) );
  2567. } else {
  2568. pending.push( null );
  2569. }
  2570. return Promise.all( pending ).then( function ( results ) {
  2571. const inverseBindMatrices = results.pop();
  2572. const jointNodes = results;
  2573. // Note that bones (joint nodes) may or may not be in the
  2574. // scene graph at this time.
  2575. const bones = [];
  2576. const boneInverses = [];
  2577. for ( let i = 0, il = jointNodes.length; i < il; i ++ ) {
  2578. const jointNode = jointNodes[ i ];
  2579. if ( jointNode ) {
  2580. bones.push( jointNode );
  2581. const mat = new Matrix4();
  2582. if ( inverseBindMatrices !== null ) {
  2583. mat.fromArray( inverseBindMatrices.array, i * 16 );
  2584. }
  2585. boneInverses.push( mat );
  2586. } else {
  2587. console.warn( 'THREE.GLTFLoader: Joint "%s" could not be found.', skinDef.joints[ i ] );
  2588. }
  2589. }
  2590. return new Skeleton( bones, boneInverses );
  2591. } );
  2592. }
  2593. /**
  2594. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#animations
  2595. *
  2596. * @private
  2597. * @param {number} animationIndex
  2598. * @return {Promise<AnimationClip>}
  2599. */
  2600. loadAnimation( animationIndex ) {
  2601. const json = this.json;
  2602. const parser = this;
  2603. const animationDef = json.animations[ animationIndex ];
  2604. const animationName = animationDef.name ? animationDef.name : 'animation_' + animationIndex;
  2605. const pendingNodes = [];
  2606. const pendingInputAccessors = [];
  2607. const pendingOutputAccessors = [];
  2608. const pendingSamplers = [];
  2609. const pendingTargets = [];
  2610. for ( let i = 0, il = animationDef.channels.length; i < il; i ++ ) {
  2611. const channel = animationDef.channels[ i ];
  2612. const sampler = animationDef.samplers[ channel.sampler ];
  2613. const target = channel.target;
  2614. const name = target.node;
  2615. const input = animationDef.parameters !== undefined ? animationDef.parameters[ sampler.input ] : sampler.input;
  2616. const output = animationDef.parameters !== undefined ? animationDef.parameters[ sampler.output ] : sampler.output;
  2617. if ( target.node === undefined ) continue;
  2618. pendingNodes.push( this.getDependency( 'node', name ) );
  2619. pendingInputAccessors.push( this.getDependency( 'accessor', input ) );
  2620. pendingOutputAccessors.push( this.getDependency( 'accessor', output ) );
  2621. pendingSamplers.push( sampler );
  2622. pendingTargets.push( target );
  2623. }
  2624. return Promise.all( [
  2625. Promise.all( pendingNodes ),
  2626. Promise.all( pendingInputAccessors ),
  2627. Promise.all( pendingOutputAccessors ),
  2628. Promise.all( pendingSamplers ),
  2629. Promise.all( pendingTargets )
  2630. ] ).then( function ( dependencies ) {
  2631. const nodes = dependencies[ 0 ];
  2632. const inputAccessors = dependencies[ 1 ];
  2633. const outputAccessors = dependencies[ 2 ];
  2634. const samplers = dependencies[ 3 ];
  2635. const targets = dependencies[ 4 ];
  2636. const tracks = [];
  2637. for ( let i = 0, il = nodes.length; i < il; i ++ ) {
  2638. const node = nodes[ i ];
  2639. const inputAccessor = inputAccessors[ i ];
  2640. const outputAccessor = outputAccessors[ i ];
  2641. const sampler = samplers[ i ];
  2642. const target = targets[ i ];
  2643. if ( node === undefined ) continue;
  2644. if ( node.updateMatrix ) {
  2645. node.updateMatrix();
  2646. }
  2647. const createdTracks = parser._createAnimationTracks( node, inputAccessor, outputAccessor, sampler, target );
  2648. if ( createdTracks ) {
  2649. for ( let k = 0; k < createdTracks.length; k ++ ) {
  2650. tracks.push( createdTracks[ k ] );
  2651. }
  2652. }
  2653. }
  2654. const animation = new AnimationClip( animationName, undefined, tracks );
  2655. assignExtrasToUserData( animation, animationDef );
  2656. return animation;
  2657. } );
  2658. }
  2659. createNodeMesh( nodeIndex ) {
  2660. const json = this.json;
  2661. const parser = this;
  2662. const nodeDef = json.nodes[ nodeIndex ];
  2663. if ( nodeDef.mesh === undefined ) return null;
  2664. return parser.getDependency( 'mesh', nodeDef.mesh ).then( function ( mesh ) {
  2665. const node = parser._getNodeRef( parser.meshCache, nodeDef.mesh, mesh );
  2666. // if weights are provided on the node, override weights on the mesh.
  2667. if ( nodeDef.weights !== undefined ) {
  2668. node.traverse( function ( o ) {
  2669. if ( ! o.isMesh ) return;
  2670. for ( let i = 0, il = nodeDef.weights.length; i < il; i ++ ) {
  2671. o.morphTargetInfluences[ i ] = nodeDef.weights[ i ];
  2672. }
  2673. } );
  2674. }
  2675. return node;
  2676. } );
  2677. }
  2678. /**
  2679. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#nodes-and-hierarchy
  2680. *
  2681. * @private
  2682. * @param {number} nodeIndex
  2683. * @return {Promise<Object3D>}
  2684. */
  2685. loadNode( nodeIndex ) {
  2686. const json = this.json;
  2687. const parser = this;
  2688. const nodeDef = json.nodes[ nodeIndex ];
  2689. const nodePending = parser._loadNodeShallow( nodeIndex );
  2690. const childPending = [];
  2691. const childrenDef = nodeDef.children || [];
  2692. for ( let i = 0, il = childrenDef.length; i < il; i ++ ) {
  2693. childPending.push( parser.getDependency( 'node', childrenDef[ i ] ) );
  2694. }
  2695. const skeletonPending = nodeDef.skin === undefined
  2696. ? Promise.resolve( null )
  2697. : parser.getDependency( 'skin', nodeDef.skin );
  2698. return Promise.all( [
  2699. nodePending,
  2700. Promise.all( childPending ),
  2701. skeletonPending
  2702. ] ).then( function ( results ) {
  2703. const node = results[ 0 ];
  2704. const children = results[ 1 ];
  2705. const skeleton = results[ 2 ];
  2706. if ( skeleton !== null ) {
  2707. // This full traverse should be fine because
  2708. // child glTF nodes have not been added to this node yet.
  2709. node.traverse( function ( mesh ) {
  2710. if ( ! mesh.isSkinnedMesh ) return;
  2711. mesh.bind( skeleton, _identityMatrix );
  2712. } );
  2713. }
  2714. for ( let i = 0, il = children.length; i < il; i ++ ) {
  2715. node.add( children[ i ] );
  2716. }
  2717. return node;
  2718. } );
  2719. }
  2720. // ._loadNodeShallow() parses a single node.
  2721. // skin and child nodes are created and added in .loadNode() (no '_' prefix).
  2722. _loadNodeShallow( nodeIndex ) {
  2723. const json = this.json;
  2724. const extensions = this.extensions;
  2725. const parser = this;
  2726. // This method is called from .loadNode() and .loadSkin().
  2727. // Cache a node to avoid duplication.
  2728. if ( this.nodeCache[ nodeIndex ] !== undefined ) {
  2729. return this.nodeCache[ nodeIndex ];
  2730. }
  2731. const nodeDef = json.nodes[ nodeIndex ];
  2732. // reserve node's name before its dependencies, so the root has the intended name.
  2733. const nodeName = nodeDef.name ? parser.createUniqueName( nodeDef.name ) : '';
  2734. const pending = [];
  2735. const meshPromise = parser._invokeOne( function ( ext ) {
  2736. return ext.createNodeMesh && ext.createNodeMesh( nodeIndex );
  2737. } );
  2738. if ( meshPromise ) {
  2739. pending.push( meshPromise );
  2740. }
  2741. if ( nodeDef.camera !== undefined ) {
  2742. pending.push( parser.getDependency( 'camera', nodeDef.camera ).then( function ( camera ) {
  2743. return parser._getNodeRef( parser.cameraCache, nodeDef.camera, camera );
  2744. } ) );
  2745. }
  2746. parser._invokeAll( function ( ext ) {
  2747. return ext.createNodeAttachment && ext.createNodeAttachment( nodeIndex );
  2748. } ).forEach( function ( promise ) {
  2749. pending.push( promise );
  2750. } );
  2751. this.nodeCache[ nodeIndex ] = Promise.all( pending ).then( function ( objects ) {
  2752. let node;
  2753. // .isBone isn't in glTF spec. See ._markDefs
  2754. if ( nodeDef.isBone === true ) {
  2755. node = new Bone();
  2756. } else if ( objects.length > 1 ) {
  2757. node = new Group();
  2758. } else if ( objects.length === 1 ) {
  2759. node = objects[ 0 ];
  2760. } else {
  2761. node = new Object3D();
  2762. }
  2763. if ( node !== objects[ 0 ] ) {
  2764. for ( let i = 0, il = objects.length; i < il; i ++ ) {
  2765. node.add( objects[ i ] );
  2766. }
  2767. }
  2768. if ( nodeDef.name ) {
  2769. node.userData.name = nodeDef.name;
  2770. node.name = nodeName;
  2771. }
  2772. assignExtrasToUserData( node, nodeDef );
  2773. if ( nodeDef.extensions ) addUnknownExtensionsToUserData( extensions, node, nodeDef );
  2774. if ( nodeDef.matrix !== undefined ) {
  2775. const matrix = new Matrix4();
  2776. matrix.fromArray( nodeDef.matrix );
  2777. node.applyMatrix4( matrix );
  2778. } else {
  2779. if ( nodeDef.translation !== undefined ) {
  2780. node.position.fromArray( nodeDef.translation );
  2781. }
  2782. if ( nodeDef.rotation !== undefined ) {
  2783. node.quaternion.fromArray( nodeDef.rotation );
  2784. }
  2785. if ( nodeDef.scale !== undefined ) {
  2786. node.scale.fromArray( nodeDef.scale );
  2787. }
  2788. }
  2789. if ( ! parser.associations.has( node ) ) {
  2790. parser.associations.set( node, {} );
  2791. } else if ( nodeDef.mesh !== undefined && parser.meshCache.refs[ nodeDef.mesh ] > 1 ) {
  2792. const mapping = parser.associations.get( node );
  2793. parser.associations.set( node, { ...mapping } );
  2794. }
  2795. parser.associations.get( node ).nodes = nodeIndex;
  2796. return node;
  2797. } );
  2798. return this.nodeCache[ nodeIndex ];
  2799. }
  2800. /**
  2801. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#scenes
  2802. *
  2803. * @private
  2804. * @param {number} sceneIndex
  2805. * @return {Promise<Group>}
  2806. */
  2807. loadScene( sceneIndex ) {
  2808. const extensions = this.extensions;
  2809. const sceneDef = this.json.scenes[ sceneIndex ];
  2810. const parser = this;
  2811. // Loader returns Group, not Scene.
  2812. // See: https://github.com/mrdoob/three.js/issues/18342#issuecomment-578981172
  2813. const scene = new Group();
  2814. if ( sceneDef.name ) scene.name = parser.createUniqueName( sceneDef.name );
  2815. assignExtrasToUserData( scene, sceneDef );
  2816. if ( sceneDef.extensions ) addUnknownExtensionsToUserData( extensions, scene, sceneDef );
  2817. const nodeIds = sceneDef.nodes || [];
  2818. const pending = [];
  2819. for ( let i = 0, il = nodeIds.length; i < il; i ++ ) {
  2820. pending.push( parser.getDependency( 'node', nodeIds[ i ] ) );
  2821. }
  2822. return Promise.all( pending ).then( function ( nodes ) {
  2823. for ( let i = 0, il = nodes.length; i < il; i ++ ) {
  2824. const node = nodes[ i ];
  2825. // If the node already has a parent, it means it's being reused across multiple scenes.
  2826. // Clone it to avoid the second scene's add() removing it from the first scene.
  2827. // See: https://github.com/mrdoob/three.js/issues/27993
  2828. if ( node.parent !== null ) {
  2829. scene.add( clone( node ) );
  2830. } else {
  2831. scene.add( node );
  2832. }
  2833. }
  2834. // Removes dangling associations, associations that reference a node that
  2835. // didn't make it into the scene.
  2836. const reduceAssociations = ( node ) => {
  2837. const reducedAssociations = new Map();
  2838. for ( const [ key, value ] of parser.associations ) {
  2839. if ( key instanceof Material || key instanceof Texture ) {
  2840. reducedAssociations.set( key, value );
  2841. }
  2842. }
  2843. node.traverse( ( node ) => {
  2844. const mappings = parser.associations.get( node );
  2845. if ( mappings != null ) {
  2846. reducedAssociations.set( node, mappings );
  2847. }
  2848. } );
  2849. return reducedAssociations;
  2850. };
  2851. parser.associations = reduceAssociations( scene );
  2852. return scene;
  2853. } );
  2854. }
  2855. _createAnimationTracks( node, inputAccessor, outputAccessor, sampler, target ) {
  2856. const tracks = [];
  2857. const targetName = node.name ? node.name : node.uuid;
  2858. const targetNames = [];
  2859. if ( PATH_PROPERTIES[ target.path ] === PATH_PROPERTIES.weights ) {
  2860. node.traverse( function ( object ) {
  2861. if ( object.morphTargetInfluences ) {
  2862. targetNames.push( object.name ? object.name : object.uuid );
  2863. }
  2864. } );
  2865. } else {
  2866. targetNames.push( targetName );
  2867. }
  2868. let TypedKeyframeTrack;
  2869. switch ( PATH_PROPERTIES[ target.path ] ) {
  2870. case PATH_PROPERTIES.weights:
  2871. TypedKeyframeTrack = NumberKeyframeTrack;
  2872. break;
  2873. case PATH_PROPERTIES.rotation:
  2874. TypedKeyframeTrack = QuaternionKeyframeTrack;
  2875. break;
  2876. case PATH_PROPERTIES.translation:
  2877. case PATH_PROPERTIES.scale:
  2878. TypedKeyframeTrack = VectorKeyframeTrack;
  2879. break;
  2880. default:
  2881. switch ( outputAccessor.itemSize ) {
  2882. case 1:
  2883. TypedKeyframeTrack = NumberKeyframeTrack;
  2884. break;
  2885. case 2:
  2886. case 3:
  2887. default:
  2888. TypedKeyframeTrack = VectorKeyframeTrack;
  2889. break;
  2890. }
  2891. break;
  2892. }
  2893. const interpolation = sampler.interpolation !== undefined ? INTERPOLATION[ sampler.interpolation ] : InterpolateLinear;
  2894. const outputArray = this._getArrayFromAccessor( outputAccessor );
  2895. for ( let j = 0, jl = targetNames.length; j < jl; j ++ ) {
  2896. const track = new TypedKeyframeTrack(
  2897. targetNames[ j ] + '.' + PATH_PROPERTIES[ target.path ],
  2898. inputAccessor.array,
  2899. outputArray,
  2900. interpolation
  2901. );
  2902. // Override interpolation with custom factory method.
  2903. if ( sampler.interpolation === 'CUBICSPLINE' ) {
  2904. this._createCubicSplineTrackInterpolant( track );
  2905. }
  2906. tracks.push( track );
  2907. }
  2908. return tracks;
  2909. }
  2910. _getArrayFromAccessor( accessor ) {
  2911. let outputArray = accessor.array;
  2912. if ( accessor.normalized ) {
  2913. const scale = getNormalizedComponentScale( outputArray.constructor );
  2914. const scaled = new Float32Array( outputArray.length );
  2915. for ( let j = 0, jl = outputArray.length; j < jl; j ++ ) {
  2916. scaled[ j ] = outputArray[ j ] * scale;
  2917. }
  2918. outputArray = scaled;
  2919. }
  2920. return outputArray;
  2921. }
  2922. _createCubicSplineTrackInterpolant( track ) {
  2923. track.createInterpolant = function InterpolantFactoryMethodGLTFCubicSpline( result ) {
  2924. // A CUBICSPLINE keyframe in glTF has three output values for each input value,
  2925. // representing inTangent, splineVertex, and outTangent. As a result, track.getValueSize()
  2926. // must be divided by three to get the interpolant's sampleSize argument.
  2927. const interpolantType = ( this instanceof QuaternionKeyframeTrack ) ? GLTFCubicSplineQuaternionInterpolant : GLTFCubicSplineInterpolant;
  2928. return new interpolantType( this.times, this.values, this.getValueSize() / 3, result );
  2929. };
  2930. // Mark as CUBICSPLINE. `track.getInterpolation()` doesn't support custom interpolants.
  2931. track.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline = true;
  2932. }
  2933. }
  2934. /**
  2935. *
  2936. * @private
  2937. * @param {BufferGeometry} geometry
  2938. * @param {GLTF.Primitive} primitiveDef
  2939. * @param {GLTFParser} parser
  2940. */
  2941. function computeBounds( geometry, primitiveDef, parser ) {
  2942. const attributes = primitiveDef.attributes;
  2943. const box = new Box3();
  2944. if ( attributes.POSITION !== undefined ) {
  2945. const accessor = parser.json.accessors[ attributes.POSITION ];
  2946. const min = accessor.min;
  2947. const max = accessor.max;
  2948. // glTF requires 'min' and 'max', but VRM (which extends glTF) currently ignores that requirement.
  2949. if ( min !== undefined && max !== undefined ) {
  2950. box.set(
  2951. new Vector3( min[ 0 ], min[ 1 ], min[ 2 ] ),
  2952. new Vector3( max[ 0 ], max[ 1 ], max[ 2 ] )
  2953. );
  2954. if ( accessor.normalized ) {
  2955. const boxScale = getNormalizedComponentScale( WEBGL_COMPONENT_TYPES[ accessor.componentType ] );
  2956. box.min.multiplyScalar( boxScale );
  2957. box.max.multiplyScalar( boxScale );
  2958. }
  2959. } else {
  2960. console.warn( 'THREE.GLTFLoader: Missing min/max properties for accessor POSITION.' );
  2961. return;
  2962. }
  2963. } else {
  2964. return;
  2965. }
  2966. const targets = primitiveDef.targets;
  2967. if ( targets !== undefined ) {
  2968. const maxDisplacement = new Vector3();
  2969. const vector = new Vector3();
  2970. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  2971. const target = targets[ i ];
  2972. if ( target.POSITION !== undefined ) {
  2973. const accessor = parser.json.accessors[ target.POSITION ];
  2974. const min = accessor.min;
  2975. const max = accessor.max;
  2976. // glTF requires 'min' and 'max', but VRM (which extends glTF) currently ignores that requirement.
  2977. if ( min !== undefined && max !== undefined ) {
  2978. // we need to get max of absolute components because target weight is [-1,1]
  2979. vector.setX( Math.max( Math.abs( min[ 0 ] ), Math.abs( max[ 0 ] ) ) );
  2980. vector.setY( Math.max( Math.abs( min[ 1 ] ), Math.abs( max[ 1 ] ) ) );
  2981. vector.setZ( Math.max( Math.abs( min[ 2 ] ), Math.abs( max[ 2 ] ) ) );
  2982. if ( accessor.normalized ) {
  2983. const boxScale = getNormalizedComponentScale( WEBGL_COMPONENT_TYPES[ accessor.componentType ] );
  2984. vector.multiplyScalar( boxScale );
  2985. }
  2986. // Note: this assumes that the sum of all weights is at most 1. This isn't quite correct - it's more conservative
  2987. // to assume that each target can have a max weight of 1. However, for some use cases - notably, when morph targets
  2988. // are used to implement key-frame animations and as such only two are active at a time - this results in very large
  2989. // boxes. So for now we make a box that's sometimes a touch too small but is hopefully mostly of reasonable size.
  2990. maxDisplacement.max( vector );
  2991. } else {
  2992. console.warn( 'THREE.GLTFLoader: Missing min/max properties for accessor POSITION.' );
  2993. }
  2994. }
  2995. }
  2996. // As per comment above this box isn't conservative, but has a reasonable size for a very large number of morph targets.
  2997. box.expandByVector( maxDisplacement );
  2998. }
  2999. geometry.boundingBox = box;
  3000. const sphere = new Sphere();
  3001. box.getCenter( sphere.center );
  3002. sphere.radius = box.min.distanceTo( box.max ) / 2;
  3003. geometry.boundingSphere = sphere;
  3004. }
  3005. /**
  3006. *
  3007. * @private
  3008. * @param {BufferGeometry} geometry
  3009. * @param {GLTF.Primitive} primitiveDef
  3010. * @param {GLTFParser} parser
  3011. * @return {Promise<BufferGeometry>}
  3012. */
  3013. function addPrimitiveAttributes( geometry, primitiveDef, parser ) {
  3014. const attributes = primitiveDef.attributes;
  3015. const pending = [];
  3016. function assignAttributeAccessor( accessorIndex, attributeName ) {
  3017. return parser.getDependency( 'accessor', accessorIndex )
  3018. .then( function ( accessor ) {
  3019. geometry.setAttribute( attributeName, accessor );
  3020. } );
  3021. }
  3022. for ( const gltfAttributeName in attributes ) {
  3023. const threeAttributeName = ATTRIBUTES[ gltfAttributeName ] || gltfAttributeName.toLowerCase();
  3024. // Skip attributes already provided by e.g. Draco extension.
  3025. if ( threeAttributeName in geometry.attributes ) continue;
  3026. pending.push( assignAttributeAccessor( attributes[ gltfAttributeName ], threeAttributeName ) );
  3027. }
  3028. if ( primitiveDef.indices !== undefined && ! geometry.index ) {
  3029. const accessor = parser.getDependency( 'accessor', primitiveDef.indices ).then( function ( accessor ) {
  3030. geometry.setIndex( accessor );
  3031. } );
  3032. pending.push( accessor );
  3033. }
  3034. if ( ColorManagement.workingColorSpace !== LinearSRGBColorSpace && 'COLOR_0' in attributes ) {
  3035. console.warn( `THREE.GLTFLoader: Converting vertex colors from "srgb-linear" to "${ColorManagement.workingColorSpace}" not supported.` );
  3036. }
  3037. assignExtrasToUserData( geometry, primitiveDef );
  3038. computeBounds( geometry, primitiveDef, parser );
  3039. return Promise.all( pending ).then( function () {
  3040. return primitiveDef.targets !== undefined
  3041. ? addMorphTargets( geometry, primitiveDef.targets, parser )
  3042. : geometry;
  3043. } );
  3044. }
  3045. /**
  3046. * Loader result of `GLTFLoader`.
  3047. *
  3048. * @typedef {Object} GLTFLoader~LoadObject
  3049. * @property {Array<AnimationClip>} animations - An array of animation clips.
  3050. * @property {Object} asset - Meta data about the loaded asset.
  3051. * @property {Array<Camera>} cameras - An array of cameras.
  3052. * @property {GLTFParser} parser - A reference to the internal parser.
  3053. * @property {Group} scene - The default scene.
  3054. * @property {Array<Group>} scenes - glTF assets might define multiple scenes.
  3055. * @property {Object} userData - Additional data.
  3056. **/
  3057. export { GLTFLoader };
粤ICP备19079148号