GLTFLoader.js 101 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957
  1. ( function () {
  2. class GLTFLoader extends THREE.Loader {
  3. constructor( manager ) {
  4. super( manager );
  5. this.dracoLoader = null;
  6. this.ktx2Loader = null;
  7. this.meshoptDecoder = null;
  8. this.pluginCallbacks = [];
  9. this.register( function ( parser ) {
  10. return new GLTFMaterialsClearcoatExtension( parser );
  11. } );
  12. this.register( function ( parser ) {
  13. return new GLTFTextureBasisUExtension( parser );
  14. } );
  15. this.register( function ( parser ) {
  16. return new GLTFTextureWebPExtension( parser );
  17. } );
  18. this.register( function ( parser ) {
  19. return new GLTFMaterialsSheenExtension( parser );
  20. } );
  21. this.register( function ( parser ) {
  22. return new GLTFMaterialsTransmissionExtension( parser );
  23. } );
  24. this.register( function ( parser ) {
  25. return new GLTFMaterialsVolumeExtension( parser );
  26. } );
  27. this.register( function ( parser ) {
  28. return new GLTFMaterialsIorExtension( parser );
  29. } );
  30. this.register( function ( parser ) {
  31. return new GLTFMaterialsSpecularExtension( parser );
  32. } );
  33. this.register( function ( parser ) {
  34. return new GLTFLightsExtension( parser );
  35. } );
  36. this.register( function ( parser ) {
  37. return new GLTFMeshoptCompression( parser );
  38. } );
  39. }
  40. load( url, onLoad, onProgress, onError ) {
  41. const scope = this;
  42. let resourcePath;
  43. if ( this.resourcePath !== '' ) {
  44. resourcePath = this.resourcePath;
  45. } else if ( this.path !== '' ) {
  46. resourcePath = this.path;
  47. } else {
  48. resourcePath = THREE.LoaderUtils.extractUrlBase( url );
  49. } // Tells the LoadingManager to track an extra item, which resolves after
  50. // the model is fully loaded. This means the count of items loaded will
  51. // be incorrect, but ensures manager.onLoad() does not fire early.
  52. this.manager.itemStart( url );
  53. const _onError = function ( e ) {
  54. if ( onError ) {
  55. onError( e );
  56. } else {
  57. console.error( e );
  58. }
  59. scope.manager.itemError( url );
  60. scope.manager.itemEnd( url );
  61. };
  62. const loader = new THREE.FileLoader( this.manager );
  63. loader.setPath( this.path );
  64. loader.setResponseType( 'arraybuffer' );
  65. loader.setRequestHeader( this.requestHeader );
  66. loader.setWithCredentials( this.withCredentials );
  67. loader.load( url, function ( data ) {
  68. try {
  69. scope.parse( data, resourcePath, function ( gltf ) {
  70. onLoad( gltf );
  71. scope.manager.itemEnd( url );
  72. }, _onError );
  73. } catch ( e ) {
  74. _onError( e );
  75. }
  76. }, onProgress, _onError );
  77. }
  78. setDRACOLoader( dracoLoader ) {
  79. this.dracoLoader = dracoLoader;
  80. return this;
  81. }
  82. setDDSLoader() {
  83. throw new Error( 'THREE.GLTFLoader: "MSFT_texture_dds" no longer supported. Please update to "KHR_texture_basisu".' );
  84. }
  85. setKTX2Loader( ktx2Loader ) {
  86. this.ktx2Loader = ktx2Loader;
  87. return this;
  88. }
  89. setMeshoptDecoder( meshoptDecoder ) {
  90. this.meshoptDecoder = meshoptDecoder;
  91. return this;
  92. }
  93. register( callback ) {
  94. if ( this.pluginCallbacks.indexOf( callback ) === - 1 ) {
  95. this.pluginCallbacks.push( callback );
  96. }
  97. return this;
  98. }
  99. unregister( callback ) {
  100. if ( this.pluginCallbacks.indexOf( callback ) !== - 1 ) {
  101. this.pluginCallbacks.splice( this.pluginCallbacks.indexOf( callback ), 1 );
  102. }
  103. return this;
  104. }
  105. parse( data, path, onLoad, onError ) {
  106. let content;
  107. const extensions = {};
  108. const plugins = {};
  109. if ( typeof data === 'string' ) {
  110. content = data;
  111. } else {
  112. const magic = THREE.LoaderUtils.decodeText( new Uint8Array( data, 0, 4 ) );
  113. if ( magic === BINARY_EXTENSION_HEADER_MAGIC ) {
  114. try {
  115. extensions[ EXTENSIONS.KHR_BINARY_GLTF ] = new GLTFBinaryExtension( data );
  116. } catch ( error ) {
  117. if ( onError ) onError( error );
  118. return;
  119. }
  120. content = extensions[ EXTENSIONS.KHR_BINARY_GLTF ].content;
  121. } else {
  122. content = THREE.LoaderUtils.decodeText( new Uint8Array( data ) );
  123. }
  124. }
  125. const json = JSON.parse( content );
  126. if ( json.asset === undefined || json.asset.version[ 0 ] < 2 ) {
  127. if ( onError ) onError( new Error( 'THREE.GLTFLoader: Unsupported asset. glTF versions >=2.0 are supported.' ) );
  128. return;
  129. }
  130. const parser = new GLTFParser( json, {
  131. path: path || this.resourcePath || '',
  132. crossOrigin: this.crossOrigin,
  133. requestHeader: this.requestHeader,
  134. manager: this.manager,
  135. ktx2Loader: this.ktx2Loader,
  136. meshoptDecoder: this.meshoptDecoder
  137. } );
  138. parser.fileLoader.setRequestHeader( this.requestHeader );
  139. for ( let i = 0; i < this.pluginCallbacks.length; i ++ ) {
  140. const plugin = this.pluginCallbacks[ i ]( parser );
  141. plugins[ plugin.name ] = plugin; // Workaround to avoid determining as unknown extension
  142. // in addUnknownExtensionsToUserData().
  143. // Remove this workaround if we move all the existing
  144. // extension handlers to plugin system
  145. extensions[ plugin.name ] = true;
  146. }
  147. if ( json.extensionsUsed ) {
  148. for ( let i = 0; i < json.extensionsUsed.length; ++ i ) {
  149. const extensionName = json.extensionsUsed[ i ];
  150. const extensionsRequired = json.extensionsRequired || [];
  151. switch ( extensionName ) {
  152. case EXTENSIONS.KHR_MATERIALS_UNLIT:
  153. extensions[ extensionName ] = new GLTFMaterialsUnlitExtension();
  154. break;
  155. case EXTENSIONS.KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS:
  156. extensions[ extensionName ] = new GLTFMaterialsPbrSpecularGlossinessExtension();
  157. break;
  158. case EXTENSIONS.KHR_DRACO_MESH_COMPRESSION:
  159. extensions[ extensionName ] = new GLTFDracoMeshCompressionExtension( json, this.dracoLoader );
  160. break;
  161. case EXTENSIONS.KHR_TEXTURE_TRANSFORM:
  162. extensions[ extensionName ] = new GLTFTextureTransformExtension();
  163. break;
  164. case EXTENSIONS.KHR_MESH_QUANTIZATION:
  165. extensions[ extensionName ] = new GLTFMeshQuantizationExtension();
  166. break;
  167. default:
  168. if ( extensionsRequired.indexOf( extensionName ) >= 0 && plugins[ extensionName ] === undefined ) {
  169. console.warn( 'THREE.GLTFLoader: Unknown extension "' + extensionName + '".' );
  170. }
  171. }
  172. }
  173. }
  174. parser.setExtensions( extensions );
  175. parser.setPlugins( plugins );
  176. parser.parse( onLoad, onError );
  177. }
  178. }
  179. /* GLTFREGISTRY */
  180. function GLTFRegistry() {
  181. let objects = {};
  182. return {
  183. get: function ( key ) {
  184. return objects[ key ];
  185. },
  186. add: function ( key, object ) {
  187. objects[ key ] = object;
  188. },
  189. remove: function ( key ) {
  190. delete objects[ key ];
  191. },
  192. removeAll: function () {
  193. objects = {};
  194. }
  195. };
  196. }
  197. /*********************************/
  198. /********** EXTENSIONS ***********/
  199. /*********************************/
  200. const EXTENSIONS = {
  201. KHR_BINARY_GLTF: 'KHR_binary_glTF',
  202. KHR_DRACO_MESH_COMPRESSION: 'KHR_draco_mesh_compression',
  203. KHR_LIGHTS_PUNCTUAL: 'KHR_lights_punctual',
  204. KHR_MATERIALS_CLEARCOAT: 'KHR_materials_clearcoat',
  205. KHR_MATERIALS_IOR: 'KHR_materials_ior',
  206. KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS: 'KHR_materials_pbrSpecularGlossiness',
  207. KHR_MATERIALS_SHEEN: 'KHR_materials_sheen',
  208. KHR_MATERIALS_SPECULAR: 'KHR_materials_specular',
  209. KHR_MATERIALS_TRANSMISSION: 'KHR_materials_transmission',
  210. KHR_MATERIALS_UNLIT: 'KHR_materials_unlit',
  211. KHR_MATERIALS_VOLUME: 'KHR_materials_volume',
  212. KHR_TEXTURE_BASISU: 'KHR_texture_basisu',
  213. KHR_TEXTURE_TRANSFORM: 'KHR_texture_transform',
  214. KHR_MESH_QUANTIZATION: 'KHR_mesh_quantization',
  215. EXT_TEXTURE_WEBP: 'EXT_texture_webp',
  216. EXT_MESHOPT_COMPRESSION: 'EXT_meshopt_compression'
  217. };
  218. /**
  219. * Punctual Lights Extension
  220. *
  221. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
  222. */
  223. class GLTFLightsExtension {
  224. constructor( parser ) {
  225. this.parser = parser;
  226. this.name = EXTENSIONS.KHR_LIGHTS_PUNCTUAL; // THREE.Object3D instance caches
  227. this.cache = {
  228. refs: {},
  229. uses: {}
  230. };
  231. }
  232. _markDefs() {
  233. const parser = this.parser;
  234. const nodeDefs = this.parser.json.nodes || [];
  235. for ( let nodeIndex = 0, nodeLength = nodeDefs.length; nodeIndex < nodeLength; nodeIndex ++ ) {
  236. const nodeDef = nodeDefs[ nodeIndex ];
  237. if ( nodeDef.extensions && nodeDef.extensions[ this.name ] && nodeDef.extensions[ this.name ].light !== undefined ) {
  238. parser._addNodeRef( this.cache, nodeDef.extensions[ this.name ].light );
  239. }
  240. }
  241. }
  242. _loadLight( lightIndex ) {
  243. const parser = this.parser;
  244. const cacheKey = 'light:' + lightIndex;
  245. let dependency = parser.cache.get( cacheKey );
  246. if ( dependency ) return dependency;
  247. const json = parser.json;
  248. const extensions = json.extensions && json.extensions[ this.name ] || {};
  249. const lightDefs = extensions.lights || [];
  250. const lightDef = lightDefs[ lightIndex ];
  251. let lightNode;
  252. const color = new THREE.Color( 0xffffff );
  253. if ( lightDef.color !== undefined ) color.fromArray( lightDef.color );
  254. const range = lightDef.range !== undefined ? lightDef.range : 0;
  255. switch ( lightDef.type ) {
  256. case 'directional':
  257. lightNode = new THREE.DirectionalLight( color );
  258. lightNode.target.position.set( 0, 0, - 1 );
  259. lightNode.add( lightNode.target );
  260. break;
  261. case 'point':
  262. lightNode = new THREE.PointLight( color );
  263. lightNode.distance = range;
  264. break;
  265. case 'spot':
  266. lightNode = new THREE.SpotLight( color );
  267. lightNode.distance = range; // Handle spotlight properties.
  268. lightDef.spot = lightDef.spot || {};
  269. lightDef.spot.innerConeAngle = lightDef.spot.innerConeAngle !== undefined ? lightDef.spot.innerConeAngle : 0;
  270. lightDef.spot.outerConeAngle = lightDef.spot.outerConeAngle !== undefined ? lightDef.spot.outerConeAngle : Math.PI / 4.0;
  271. lightNode.angle = lightDef.spot.outerConeAngle;
  272. lightNode.penumbra = 1.0 - lightDef.spot.innerConeAngle / lightDef.spot.outerConeAngle;
  273. lightNode.target.position.set( 0, 0, - 1 );
  274. lightNode.add( lightNode.target );
  275. break;
  276. default:
  277. throw new Error( 'THREE.GLTFLoader: Unexpected light type: ' + lightDef.type );
  278. } // Some lights (e.g. spot) default to a position other than the origin. Reset the position
  279. // here, because node-level parsing will only override position if explicitly specified.
  280. lightNode.position.set( 0, 0, 0 );
  281. lightNode.decay = 2;
  282. if ( lightDef.intensity !== undefined ) lightNode.intensity = lightDef.intensity;
  283. lightNode.name = parser.createUniqueName( lightDef.name || 'light_' + lightIndex );
  284. dependency = Promise.resolve( lightNode );
  285. parser.cache.add( cacheKey, dependency );
  286. return dependency;
  287. }
  288. createNodeAttachment( nodeIndex ) {
  289. const self = this;
  290. const parser = this.parser;
  291. const json = parser.json;
  292. const nodeDef = json.nodes[ nodeIndex ];
  293. const lightDef = nodeDef.extensions && nodeDef.extensions[ this.name ] || {};
  294. const lightIndex = lightDef.light;
  295. if ( lightIndex === undefined ) return null;
  296. return this._loadLight( lightIndex ).then( function ( light ) {
  297. return parser._getNodeRef( self.cache, lightIndex, light );
  298. } );
  299. }
  300. }
  301. /**
  302. * Unlit Materials Extension
  303. *
  304. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit
  305. */
  306. class GLTFMaterialsUnlitExtension {
  307. constructor() {
  308. this.name = EXTENSIONS.KHR_MATERIALS_UNLIT;
  309. }
  310. getMaterialType() {
  311. return THREE.MeshBasicMaterial;
  312. }
  313. extendParams( materialParams, materialDef, parser ) {
  314. const pending = [];
  315. materialParams.color = new THREE.Color( 1.0, 1.0, 1.0 );
  316. materialParams.opacity = 1.0;
  317. const metallicRoughness = materialDef.pbrMetallicRoughness;
  318. if ( metallicRoughness ) {
  319. if ( Array.isArray( metallicRoughness.baseColorFactor ) ) {
  320. const array = metallicRoughness.baseColorFactor;
  321. materialParams.color.fromArray( array );
  322. materialParams.opacity = array[ 3 ];
  323. }
  324. if ( metallicRoughness.baseColorTexture !== undefined ) {
  325. pending.push( parser.assignTexture( materialParams, 'map', metallicRoughness.baseColorTexture ) );
  326. }
  327. }
  328. return Promise.all( pending );
  329. }
  330. }
  331. /**
  332. * Clearcoat Materials Extension
  333. *
  334. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_clearcoat
  335. */
  336. class GLTFMaterialsClearcoatExtension {
  337. constructor( parser ) {
  338. this.parser = parser;
  339. this.name = EXTENSIONS.KHR_MATERIALS_CLEARCOAT;
  340. }
  341. getMaterialType( materialIndex ) {
  342. const parser = this.parser;
  343. const materialDef = parser.json.materials[ materialIndex ];
  344. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  345. return THREE.MeshPhysicalMaterial;
  346. }
  347. extendMaterialParams( materialIndex, materialParams ) {
  348. const parser = this.parser;
  349. const materialDef = parser.json.materials[ materialIndex ];
  350. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  351. return Promise.resolve();
  352. }
  353. const pending = [];
  354. const extension = materialDef.extensions[ this.name ];
  355. if ( extension.clearcoatFactor !== undefined ) {
  356. materialParams.clearcoat = extension.clearcoatFactor;
  357. }
  358. if ( extension.clearcoatTexture !== undefined ) {
  359. pending.push( parser.assignTexture( materialParams, 'clearcoatMap', extension.clearcoatTexture ) );
  360. }
  361. if ( extension.clearcoatRoughnessFactor !== undefined ) {
  362. materialParams.clearcoatRoughness = extension.clearcoatRoughnessFactor;
  363. }
  364. if ( extension.clearcoatRoughnessTexture !== undefined ) {
  365. pending.push( parser.assignTexture( materialParams, 'clearcoatRoughnessMap', extension.clearcoatRoughnessTexture ) );
  366. }
  367. if ( extension.clearcoatNormalTexture !== undefined ) {
  368. pending.push( parser.assignTexture( materialParams, 'clearcoatNormalMap', extension.clearcoatNormalTexture ) );
  369. if ( extension.clearcoatNormalTexture.scale !== undefined ) {
  370. const scale = extension.clearcoatNormalTexture.scale;
  371. materialParams.clearcoatNormalScale = new THREE.Vector2( scale, scale );
  372. }
  373. }
  374. return Promise.all( pending );
  375. }
  376. }
  377. /**
  378. * Sheen Materials Extension
  379. *
  380. * Specification: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_materials_sheen
  381. */
  382. class GLTFMaterialsSheenExtension {
  383. constructor( parser ) {
  384. this.parser = parser;
  385. this.name = EXTENSIONS.KHR_MATERIALS_SHEEN;
  386. }
  387. getMaterialType( materialIndex ) {
  388. const parser = this.parser;
  389. const materialDef = parser.json.materials[ materialIndex ];
  390. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  391. return THREE.MeshPhysicalMaterial;
  392. }
  393. extendMaterialParams( materialIndex, materialParams ) {
  394. const parser = this.parser;
  395. const materialDef = parser.json.materials[ materialIndex ];
  396. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  397. return Promise.resolve();
  398. }
  399. const pending = [];
  400. materialParams.sheenTint = new THREE.Color( 0, 0, 0 );
  401. materialParams.sheenRoughness = 0;
  402. materialParams.sheen = 1;
  403. const extension = materialDef.extensions[ this.name ];
  404. if ( extension.sheenColorFactor !== undefined ) {
  405. materialParams.sheenTint.fromArray( extension.sheenColorFactor );
  406. }
  407. if ( extension.sheenRoughnessFactor !== undefined ) {
  408. materialParams.sheenRoughness = extension.sheenRoughnessFactor;
  409. } // TODO sheenColorTexture and sheenRoughnessTexture
  410. return Promise.all( pending );
  411. }
  412. }
  413. /**
  414. * Transmission Materials Extension
  415. *
  416. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_transmission
  417. * Draft: https://github.com/KhronosGroup/glTF/pull/1698
  418. */
  419. class GLTFMaterialsTransmissionExtension {
  420. constructor( parser ) {
  421. this.parser = parser;
  422. this.name = EXTENSIONS.KHR_MATERIALS_TRANSMISSION;
  423. }
  424. getMaterialType( materialIndex ) {
  425. const parser = this.parser;
  426. const materialDef = parser.json.materials[ materialIndex ];
  427. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  428. return THREE.MeshPhysicalMaterial;
  429. }
  430. extendMaterialParams( materialIndex, materialParams ) {
  431. const parser = this.parser;
  432. const materialDef = parser.json.materials[ materialIndex ];
  433. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  434. return Promise.resolve();
  435. }
  436. const pending = [];
  437. const extension = materialDef.extensions[ this.name ];
  438. if ( extension.transmissionFactor !== undefined ) {
  439. materialParams.transmission = extension.transmissionFactor;
  440. }
  441. if ( extension.transmissionTexture !== undefined ) {
  442. pending.push( parser.assignTexture( materialParams, 'transmissionMap', extension.transmissionTexture ) );
  443. }
  444. return Promise.all( pending );
  445. }
  446. }
  447. /**
  448. * Materials Volume Extension
  449. *
  450. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_volume
  451. */
  452. class GLTFMaterialsVolumeExtension {
  453. constructor( parser ) {
  454. this.parser = parser;
  455. this.name = EXTENSIONS.KHR_MATERIALS_VOLUME;
  456. }
  457. getMaterialType( materialIndex ) {
  458. const parser = this.parser;
  459. const materialDef = parser.json.materials[ materialIndex ];
  460. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  461. return THREE.MeshPhysicalMaterial;
  462. }
  463. extendMaterialParams( materialIndex, materialParams ) {
  464. const parser = this.parser;
  465. const materialDef = parser.json.materials[ materialIndex ];
  466. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  467. return Promise.resolve();
  468. }
  469. const pending = [];
  470. const extension = materialDef.extensions[ this.name ];
  471. materialParams.thickness = extension.thicknessFactor !== undefined ? extension.thicknessFactor : 0;
  472. if ( extension.thicknessTexture !== undefined ) {
  473. pending.push( parser.assignTexture( materialParams, 'thicknessMap', extension.thicknessTexture ) );
  474. }
  475. materialParams.attenuationDistance = extension.attenuationDistance || 0;
  476. const colorArray = extension.attenuationColor || [ 1, 1, 1 ];
  477. materialParams.attenuationTint = new THREE.Color( colorArray[ 0 ], colorArray[ 1 ], colorArray[ 2 ] );
  478. return Promise.all( pending );
  479. }
  480. }
  481. /**
  482. * Materials ior Extension
  483. *
  484. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_ior
  485. */
  486. class GLTFMaterialsIorExtension {
  487. constructor( parser ) {
  488. this.parser = parser;
  489. this.name = EXTENSIONS.KHR_MATERIALS_IOR;
  490. }
  491. getMaterialType( materialIndex ) {
  492. const parser = this.parser;
  493. const materialDef = parser.json.materials[ materialIndex ];
  494. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  495. return THREE.MeshPhysicalMaterial;
  496. }
  497. extendMaterialParams( materialIndex, materialParams ) {
  498. const parser = this.parser;
  499. const materialDef = parser.json.materials[ materialIndex ];
  500. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  501. return Promise.resolve();
  502. }
  503. const extension = materialDef.extensions[ this.name ];
  504. materialParams.ior = extension.ior !== undefined ? extension.ior : 1.5;
  505. return Promise.resolve();
  506. }
  507. }
  508. /**
  509. * Materials specular Extension
  510. *
  511. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_specular
  512. */
  513. class GLTFMaterialsSpecularExtension {
  514. constructor( parser ) {
  515. this.parser = parser;
  516. this.name = EXTENSIONS.KHR_MATERIALS_SPECULAR;
  517. }
  518. getMaterialType( materialIndex ) {
  519. const parser = this.parser;
  520. const materialDef = parser.json.materials[ materialIndex ];
  521. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) return null;
  522. return THREE.MeshPhysicalMaterial;
  523. }
  524. extendMaterialParams( materialIndex, materialParams ) {
  525. const parser = this.parser;
  526. const materialDef = parser.json.materials[ materialIndex ];
  527. if ( ! materialDef.extensions || ! materialDef.extensions[ this.name ] ) {
  528. return Promise.resolve();
  529. }
  530. const pending = [];
  531. const extension = materialDef.extensions[ this.name ];
  532. materialParams.specularIntensity = extension.specularFactor !== undefined ? extension.specularFactor : 1.0;
  533. if ( extension.specularTexture !== undefined ) {
  534. pending.push( parser.assignTexture( materialParams, 'specularIntensityMap', extension.specularTexture ) );
  535. }
  536. const colorArray = extension.specularColorFactor || [ 1, 1, 1 ];
  537. materialParams.specularTint = new THREE.Color( colorArray[ 0 ], colorArray[ 1 ], colorArray[ 2 ] );
  538. if ( extension.specularColorTexture !== undefined ) {
  539. pending.push( parser.assignTexture( materialParams, 'specularTintMap', extension.specularColorTexture ).then( function ( texture ) {
  540. texture.encoding = THREE.sRGBEncoding;
  541. } ) );
  542. }
  543. return Promise.all( pending );
  544. }
  545. }
  546. /**
  547. * BasisU THREE.Texture Extension
  548. *
  549. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_basisu
  550. */
  551. class GLTFTextureBasisUExtension {
  552. constructor( parser ) {
  553. this.parser = parser;
  554. this.name = EXTENSIONS.KHR_TEXTURE_BASISU;
  555. }
  556. loadTexture( textureIndex ) {
  557. const parser = this.parser;
  558. const json = parser.json;
  559. const textureDef = json.textures[ textureIndex ];
  560. if ( ! textureDef.extensions || ! textureDef.extensions[ this.name ] ) {
  561. return null;
  562. }
  563. const extension = textureDef.extensions[ this.name ];
  564. const source = json.images[ extension.source ];
  565. const loader = parser.options.ktx2Loader;
  566. if ( ! loader ) {
  567. if ( json.extensionsRequired && json.extensionsRequired.indexOf( this.name ) >= 0 ) {
  568. throw new Error( 'THREE.GLTFLoader: setKTX2Loader must be called before loading KTX2 textures' );
  569. } else {
  570. // Assumes that the extension is optional and that a fallback texture is present
  571. return null;
  572. }
  573. }
  574. return parser.loadTextureImage( textureIndex, source, loader );
  575. }
  576. }
  577. /**
  578. * WebP THREE.Texture Extension
  579. *
  580. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_texture_webp
  581. */
  582. class GLTFTextureWebPExtension {
  583. constructor( parser ) {
  584. this.parser = parser;
  585. this.name = EXTENSIONS.EXT_TEXTURE_WEBP;
  586. this.isSupported = null;
  587. }
  588. loadTexture( textureIndex ) {
  589. const name = this.name;
  590. const parser = this.parser;
  591. const json = parser.json;
  592. const textureDef = json.textures[ textureIndex ];
  593. if ( ! textureDef.extensions || ! textureDef.extensions[ name ] ) {
  594. return null;
  595. }
  596. const extension = textureDef.extensions[ name ];
  597. const source = json.images[ extension.source ];
  598. let loader = parser.textureLoader;
  599. if ( source.uri ) {
  600. const handler = parser.options.manager.getHandler( source.uri );
  601. if ( handler !== null ) loader = handler;
  602. }
  603. return this.detectSupport().then( function ( isSupported ) {
  604. if ( isSupported ) return parser.loadTextureImage( textureIndex, source, loader );
  605. if ( json.extensionsRequired && json.extensionsRequired.indexOf( name ) >= 0 ) {
  606. throw new Error( 'THREE.GLTFLoader: WebP required by asset but unsupported.' );
  607. } // Fall back to PNG or JPEG.
  608. return parser.loadTexture( textureIndex );
  609. } );
  610. }
  611. detectSupport() {
  612. if ( ! this.isSupported ) {
  613. this.isSupported = new Promise( function ( resolve ) {
  614. const image = new Image(); // Lossy test image. Support for lossy images doesn't guarantee support for all
  615. // WebP images, unfortunately.
  616. image.src = 'data:image/webp;base64,UklGRiIAAABXRUJQVlA4IBYAAAAwAQCdASoBAAEADsD+JaQAA3AAAAAA';
  617. image.onload = image.onerror = function () {
  618. resolve( image.height === 1 );
  619. };
  620. } );
  621. }
  622. return this.isSupported;
  623. }
  624. }
  625. /**
  626. * meshopt BufferView Compression Extension
  627. *
  628. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/EXT_meshopt_compression
  629. */
  630. class GLTFMeshoptCompression {
  631. constructor( parser ) {
  632. this.name = EXTENSIONS.EXT_MESHOPT_COMPRESSION;
  633. this.parser = parser;
  634. }
  635. loadBufferView( index ) {
  636. const json = this.parser.json;
  637. const bufferView = json.bufferViews[ index ];
  638. if ( bufferView.extensions && bufferView.extensions[ this.name ] ) {
  639. const extensionDef = bufferView.extensions[ this.name ];
  640. const buffer = this.parser.getDependency( 'buffer', extensionDef.buffer );
  641. const decoder = this.parser.options.meshoptDecoder;
  642. if ( ! decoder || ! decoder.supported ) {
  643. if ( json.extensionsRequired && json.extensionsRequired.indexOf( this.name ) >= 0 ) {
  644. throw new Error( 'THREE.GLTFLoader: setMeshoptDecoder must be called before loading compressed files' );
  645. } else {
  646. // Assumes that the extension is optional and that fallback buffer data is present
  647. return null;
  648. }
  649. }
  650. return Promise.all( [ buffer, decoder.ready ] ).then( function ( res ) {
  651. const byteOffset = extensionDef.byteOffset || 0;
  652. const byteLength = extensionDef.byteLength || 0;
  653. const count = extensionDef.count;
  654. const stride = extensionDef.byteStride;
  655. const result = new ArrayBuffer( count * stride );
  656. const source = new Uint8Array( res[ 0 ], byteOffset, byteLength );
  657. decoder.decodeGltfBuffer( new Uint8Array( result ), count, stride, source, extensionDef.mode, extensionDef.filter );
  658. return result;
  659. } );
  660. } else {
  661. return null;
  662. }
  663. }
  664. }
  665. /* BINARY EXTENSION */
  666. const BINARY_EXTENSION_HEADER_MAGIC = 'glTF';
  667. const BINARY_EXTENSION_HEADER_LENGTH = 12;
  668. const BINARY_EXTENSION_CHUNK_TYPES = {
  669. JSON: 0x4E4F534A,
  670. BIN: 0x004E4942
  671. };
  672. class GLTFBinaryExtension {
  673. constructor( data ) {
  674. this.name = EXTENSIONS.KHR_BINARY_GLTF;
  675. this.content = null;
  676. this.body = null;
  677. const headerView = new DataView( data, 0, BINARY_EXTENSION_HEADER_LENGTH );
  678. this.header = {
  679. magic: THREE.LoaderUtils.decodeText( new Uint8Array( data.slice( 0, 4 ) ) ),
  680. version: headerView.getUint32( 4, true ),
  681. length: headerView.getUint32( 8, true )
  682. };
  683. if ( this.header.magic !== BINARY_EXTENSION_HEADER_MAGIC ) {
  684. throw new Error( 'THREE.GLTFLoader: Unsupported glTF-Binary header.' );
  685. } else if ( this.header.version < 2.0 ) {
  686. throw new Error( 'THREE.GLTFLoader: Legacy binary file detected.' );
  687. }
  688. const chunkContentsLength = this.header.length - BINARY_EXTENSION_HEADER_LENGTH;
  689. const chunkView = new DataView( data, BINARY_EXTENSION_HEADER_LENGTH );
  690. let chunkIndex = 0;
  691. while ( chunkIndex < chunkContentsLength ) {
  692. const chunkLength = chunkView.getUint32( chunkIndex, true );
  693. chunkIndex += 4;
  694. const chunkType = chunkView.getUint32( chunkIndex, true );
  695. chunkIndex += 4;
  696. if ( chunkType === BINARY_EXTENSION_CHUNK_TYPES.JSON ) {
  697. const contentArray = new Uint8Array( data, BINARY_EXTENSION_HEADER_LENGTH + chunkIndex, chunkLength );
  698. this.content = THREE.LoaderUtils.decodeText( contentArray );
  699. } else if ( chunkType === BINARY_EXTENSION_CHUNK_TYPES.BIN ) {
  700. const byteOffset = BINARY_EXTENSION_HEADER_LENGTH + chunkIndex;
  701. this.body = data.slice( byteOffset, byteOffset + chunkLength );
  702. } // Clients must ignore chunks with unknown types.
  703. chunkIndex += chunkLength;
  704. }
  705. if ( this.content === null ) {
  706. throw new Error( 'THREE.GLTFLoader: JSON content not found.' );
  707. }
  708. }
  709. }
  710. /**
  711. * DRACO THREE.Mesh Compression Extension
  712. *
  713. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression
  714. */
  715. class GLTFDracoMeshCompressionExtension {
  716. constructor( json, dracoLoader ) {
  717. if ( ! dracoLoader ) {
  718. throw new Error( 'THREE.GLTFLoader: No DRACOLoader instance provided.' );
  719. }
  720. this.name = EXTENSIONS.KHR_DRACO_MESH_COMPRESSION;
  721. this.json = json;
  722. this.dracoLoader = dracoLoader;
  723. this.dracoLoader.preload();
  724. }
  725. decodePrimitive( primitive, parser ) {
  726. const json = this.json;
  727. const dracoLoader = this.dracoLoader;
  728. const bufferViewIndex = primitive.extensions[ this.name ].bufferView;
  729. const gltfAttributeMap = primitive.extensions[ this.name ].attributes;
  730. const threeAttributeMap = {};
  731. const attributeNormalizedMap = {};
  732. const attributeTypeMap = {};
  733. for ( const attributeName in gltfAttributeMap ) {
  734. const threeAttributeName = ATTRIBUTES[ attributeName ] || attributeName.toLowerCase();
  735. threeAttributeMap[ threeAttributeName ] = gltfAttributeMap[ attributeName ];
  736. }
  737. for ( const attributeName in primitive.attributes ) {
  738. const threeAttributeName = ATTRIBUTES[ attributeName ] || attributeName.toLowerCase();
  739. if ( gltfAttributeMap[ attributeName ] !== undefined ) {
  740. const accessorDef = json.accessors[ primitive.attributes[ attributeName ] ];
  741. const componentType = WEBGL_COMPONENT_TYPES[ accessorDef.componentType ];
  742. attributeTypeMap[ threeAttributeName ] = componentType;
  743. attributeNormalizedMap[ threeAttributeName ] = accessorDef.normalized === true;
  744. }
  745. }
  746. return parser.getDependency( 'bufferView', bufferViewIndex ).then( function ( bufferView ) {
  747. return new Promise( function ( resolve ) {
  748. dracoLoader.decodeDracoFile( bufferView, function ( geometry ) {
  749. for ( const attributeName in geometry.attributes ) {
  750. const attribute = geometry.attributes[ attributeName ];
  751. const normalized = attributeNormalizedMap[ attributeName ];
  752. if ( normalized !== undefined ) attribute.normalized = normalized;
  753. }
  754. resolve( geometry );
  755. }, threeAttributeMap, attributeTypeMap );
  756. } );
  757. } );
  758. }
  759. }
  760. /**
  761. * THREE.Texture Transform Extension
  762. *
  763. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_texture_transform
  764. */
  765. class GLTFTextureTransformExtension {
  766. constructor() {
  767. this.name = EXTENSIONS.KHR_TEXTURE_TRANSFORM;
  768. }
  769. extendTexture( texture, transform ) {
  770. if ( transform.texCoord !== undefined ) {
  771. console.warn( 'THREE.GLTFLoader: Custom UV sets in "' + this.name + '" extension not yet supported.' );
  772. }
  773. if ( transform.offset === undefined && transform.rotation === undefined && transform.scale === undefined ) {
  774. // See https://github.com/mrdoob/three.js/issues/21819.
  775. return texture;
  776. }
  777. texture = texture.clone();
  778. if ( transform.offset !== undefined ) {
  779. texture.offset.fromArray( transform.offset );
  780. }
  781. if ( transform.rotation !== undefined ) {
  782. texture.rotation = transform.rotation;
  783. }
  784. if ( transform.scale !== undefined ) {
  785. texture.repeat.fromArray( transform.scale );
  786. }
  787. texture.needsUpdate = true;
  788. return texture;
  789. }
  790. }
  791. /**
  792. * Specular-Glossiness Extension
  793. *
  794. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness
  795. */
  796. /**
  797. * A sub class of StandardMaterial with some of the functionality
  798. * changed via the `onBeforeCompile` callback
  799. * @pailhead
  800. */
  801. class GLTFMeshStandardSGMaterial extends THREE.MeshStandardMaterial {
  802. constructor( params ) {
  803. super();
  804. this.isGLTFSpecularGlossinessMaterial = true; //various chunks that need replacing
  805. const specularMapParsFragmentChunk = [ '#ifdef USE_SPECULARMAP', ' uniform sampler2D specularMap;', '#endif' ].join( '\n' );
  806. const glossinessMapParsFragmentChunk = [ '#ifdef USE_GLOSSINESSMAP', ' uniform sampler2D glossinessMap;', '#endif' ].join( '\n' );
  807. const specularMapFragmentChunk = [ 'vec3 specularFactor = specular;', '#ifdef USE_SPECULARMAP', ' vec4 texelSpecular = texture2D( specularMap, vUv );', ' texelSpecular = sRGBToLinear( texelSpecular );', ' // reads channel RGB, compatible with a glTF Specular-Glossiness (RGBA) texture', ' specularFactor *= texelSpecular.rgb;', '#endif' ].join( '\n' );
  808. const glossinessMapFragmentChunk = [ 'float glossinessFactor = glossiness;', '#ifdef USE_GLOSSINESSMAP', ' vec4 texelGlossiness = texture2D( glossinessMap, vUv );', ' // reads channel A, compatible with a glTF Specular-Glossiness (RGBA) texture', ' glossinessFactor *= texelGlossiness.a;', '#endif' ].join( '\n' );
  809. const lightPhysicalFragmentChunk = [ 'PhysicalMaterial material;', 'material.diffuseColor = diffuseColor.rgb * ( 1. - max( specularFactor.r, max( specularFactor.g, specularFactor.b ) ) );', 'vec3 dxy = max( abs( dFdx( geometryNormal ) ), abs( dFdy( geometryNormal ) ) );', 'float geometryRoughness = max( max( dxy.x, dxy.y ), dxy.z );', 'material.roughness = max( 1.0 - glossinessFactor, 0.0525 ); // 0.0525 corresponds to the base mip of a 256 cubemap.', 'material.roughness += geometryRoughness;', 'material.roughness = min( material.roughness, 1.0 );', 'material.specularColor = specularFactor;' ].join( '\n' );
  810. const uniforms = {
  811. specular: {
  812. value: new THREE.Color().setHex( 0xffffff )
  813. },
  814. glossiness: {
  815. value: 1
  816. },
  817. specularMap: {
  818. value: null
  819. },
  820. glossinessMap: {
  821. value: null
  822. }
  823. };
  824. this._extraUniforms = uniforms;
  825. this.onBeforeCompile = function ( shader ) {
  826. for ( const uniformName in uniforms ) {
  827. shader.uniforms[ uniformName ] = uniforms[ uniformName ];
  828. }
  829. shader.fragmentShader = shader.fragmentShader.replace( 'uniform float roughness;', 'uniform vec3 specular;' ).replace( 'uniform float metalness;', 'uniform float glossiness;' ).replace( '#include <roughnessmap_pars_fragment>', specularMapParsFragmentChunk ).replace( '#include <metalnessmap_pars_fragment>', glossinessMapParsFragmentChunk ).replace( '#include <roughnessmap_fragment>', specularMapFragmentChunk ).replace( '#include <metalnessmap_fragment>', glossinessMapFragmentChunk ).replace( '#include <lights_physical_fragment>', lightPhysicalFragmentChunk );
  830. };
  831. Object.defineProperties( this, {
  832. specular: {
  833. get: function () {
  834. return uniforms.specular.value;
  835. },
  836. set: function ( v ) {
  837. uniforms.specular.value = v;
  838. }
  839. },
  840. specularMap: {
  841. get: function () {
  842. return uniforms.specularMap.value;
  843. },
  844. set: function ( v ) {
  845. uniforms.specularMap.value = v;
  846. if ( v ) {
  847. this.defines.USE_SPECULARMAP = ''; // USE_UV is set by the renderer for specular maps
  848. } else {
  849. delete this.defines.USE_SPECULARMAP;
  850. }
  851. }
  852. },
  853. glossiness: {
  854. get: function () {
  855. return uniforms.glossiness.value;
  856. },
  857. set: function ( v ) {
  858. uniforms.glossiness.value = v;
  859. }
  860. },
  861. glossinessMap: {
  862. get: function () {
  863. return uniforms.glossinessMap.value;
  864. },
  865. set: function ( v ) {
  866. uniforms.glossinessMap.value = v;
  867. if ( v ) {
  868. this.defines.USE_GLOSSINESSMAP = '';
  869. this.defines.USE_UV = '';
  870. } else {
  871. delete this.defines.USE_GLOSSINESSMAP;
  872. delete this.defines.USE_UV;
  873. }
  874. }
  875. }
  876. } );
  877. delete this.metalness;
  878. delete this.roughness;
  879. delete this.metalnessMap;
  880. delete this.roughnessMap;
  881. this.setValues( params );
  882. }
  883. copy( source ) {
  884. super.copy( source );
  885. this.specularMap = source.specularMap;
  886. this.specular.copy( source.specular );
  887. this.glossinessMap = source.glossinessMap;
  888. this.glossiness = source.glossiness;
  889. delete this.metalness;
  890. delete this.roughness;
  891. delete this.metalnessMap;
  892. delete this.roughnessMap;
  893. return this;
  894. }
  895. }
  896. class GLTFMaterialsPbrSpecularGlossinessExtension {
  897. constructor() {
  898. this.name = EXTENSIONS.KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS;
  899. this.specularGlossinessParams = [ 'color', 'map', 'lightMap', 'lightMapIntensity', 'aoMap', 'aoMapIntensity', 'emissive', 'emissiveIntensity', 'emissiveMap', 'bumpMap', 'bumpScale', 'normalMap', 'normalMapType', 'displacementMap', 'displacementScale', 'displacementBias', 'specularMap', 'specular', 'glossinessMap', 'glossiness', 'alphaMap', 'envMap', 'envMapIntensity', 'refractionRatio' ];
  900. }
  901. getMaterialType() {
  902. return GLTFMeshStandardSGMaterial;
  903. }
  904. extendParams( materialParams, materialDef, parser ) {
  905. const pbrSpecularGlossiness = materialDef.extensions[ this.name ];
  906. materialParams.color = new THREE.Color( 1.0, 1.0, 1.0 );
  907. materialParams.opacity = 1.0;
  908. const pending = [];
  909. if ( Array.isArray( pbrSpecularGlossiness.diffuseFactor ) ) {
  910. const array = pbrSpecularGlossiness.diffuseFactor;
  911. materialParams.color.fromArray( array );
  912. materialParams.opacity = array[ 3 ];
  913. }
  914. if ( pbrSpecularGlossiness.diffuseTexture !== undefined ) {
  915. pending.push( parser.assignTexture( materialParams, 'map', pbrSpecularGlossiness.diffuseTexture ) );
  916. }
  917. materialParams.emissive = new THREE.Color( 0.0, 0.0, 0.0 );
  918. materialParams.glossiness = pbrSpecularGlossiness.glossinessFactor !== undefined ? pbrSpecularGlossiness.glossinessFactor : 1.0;
  919. materialParams.specular = new THREE.Color( 1.0, 1.0, 1.0 );
  920. if ( Array.isArray( pbrSpecularGlossiness.specularFactor ) ) {
  921. materialParams.specular.fromArray( pbrSpecularGlossiness.specularFactor );
  922. }
  923. if ( pbrSpecularGlossiness.specularGlossinessTexture !== undefined ) {
  924. const specGlossMapDef = pbrSpecularGlossiness.specularGlossinessTexture;
  925. pending.push( parser.assignTexture( materialParams, 'glossinessMap', specGlossMapDef ) );
  926. pending.push( parser.assignTexture( materialParams, 'specularMap', specGlossMapDef ) );
  927. }
  928. return Promise.all( pending );
  929. }
  930. createMaterial( materialParams ) {
  931. const material = new GLTFMeshStandardSGMaterial( materialParams );
  932. material.fog = true;
  933. material.color = materialParams.color;
  934. material.map = materialParams.map === undefined ? null : materialParams.map;
  935. material.lightMap = null;
  936. material.lightMapIntensity = 1.0;
  937. material.aoMap = materialParams.aoMap === undefined ? null : materialParams.aoMap;
  938. material.aoMapIntensity = 1.0;
  939. material.emissive = materialParams.emissive;
  940. material.emissiveIntensity = 1.0;
  941. material.emissiveMap = materialParams.emissiveMap === undefined ? null : materialParams.emissiveMap;
  942. material.bumpMap = materialParams.bumpMap === undefined ? null : materialParams.bumpMap;
  943. material.bumpScale = 1;
  944. material.normalMap = materialParams.normalMap === undefined ? null : materialParams.normalMap;
  945. material.normalMapType = THREE.TangentSpaceNormalMap;
  946. if ( materialParams.normalScale ) material.normalScale = materialParams.normalScale;
  947. material.displacementMap = null;
  948. material.displacementScale = 1;
  949. material.displacementBias = 0;
  950. material.specularMap = materialParams.specularMap === undefined ? null : materialParams.specularMap;
  951. material.specular = materialParams.specular;
  952. material.glossinessMap = materialParams.glossinessMap === undefined ? null : materialParams.glossinessMap;
  953. material.glossiness = materialParams.glossiness;
  954. material.alphaMap = null;
  955. material.envMap = materialParams.envMap === undefined ? null : materialParams.envMap;
  956. material.envMapIntensity = 1.0;
  957. material.refractionRatio = 0.98;
  958. return material;
  959. }
  960. }
  961. /**
  962. * THREE.Mesh Quantization Extension
  963. *
  964. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization
  965. */
  966. class GLTFMeshQuantizationExtension {
  967. constructor() {
  968. this.name = EXTENSIONS.KHR_MESH_QUANTIZATION;
  969. }
  970. }
  971. /*********************************/
  972. /********** INTERPOLATION ********/
  973. /*********************************/
  974. // Spline Interpolation
  975. // Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#appendix-c-spline-interpolation
  976. class GLTFCubicSplineInterpolant extends THREE.Interpolant {
  977. constructor( parameterPositions, sampleValues, sampleSize, resultBuffer ) {
  978. super( parameterPositions, sampleValues, sampleSize, resultBuffer );
  979. }
  980. copySampleValue_( index ) {
  981. // Copies a sample value to the result buffer. See description of glTF
  982. // CUBICSPLINE values layout in interpolate_() function below.
  983. const result = this.resultBuffer,
  984. values = this.sampleValues,
  985. valueSize = this.valueSize,
  986. offset = index * valueSize * 3 + valueSize;
  987. for ( let i = 0; i !== valueSize; i ++ ) {
  988. result[ i ] = values[ offset + i ];
  989. }
  990. return result;
  991. }
  992. }
  993. GLTFCubicSplineInterpolant.prototype.beforeStart_ = GLTFCubicSplineInterpolant.prototype.copySampleValue_;
  994. GLTFCubicSplineInterpolant.prototype.afterEnd_ = GLTFCubicSplineInterpolant.prototype.copySampleValue_;
  995. GLTFCubicSplineInterpolant.prototype.interpolate_ = function ( i1, t0, t, t1 ) {
  996. const result = this.resultBuffer;
  997. const values = this.sampleValues;
  998. const stride = this.valueSize;
  999. const stride2 = stride * 2;
  1000. const stride3 = stride * 3;
  1001. const td = t1 - t0;
  1002. const p = ( t - t0 ) / td;
  1003. const pp = p * p;
  1004. const ppp = pp * p;
  1005. const offset1 = i1 * stride3;
  1006. const offset0 = offset1 - stride3;
  1007. const s2 = - 2 * ppp + 3 * pp;
  1008. const s3 = ppp - pp;
  1009. const s0 = 1 - s2;
  1010. const s1 = s3 - pp + p; // Layout of keyframe output values for CUBICSPLINE animations:
  1011. // [ inTangent_1, splineVertex_1, outTangent_1, inTangent_2, splineVertex_2, ... ]
  1012. for ( let i = 0; i !== stride; i ++ ) {
  1013. const p0 = values[ offset0 + i + stride ]; // splineVertex_k
  1014. const m0 = values[ offset0 + i + stride2 ] * td; // outTangent_k * (t_k+1 - t_k)
  1015. const p1 = values[ offset1 + i + stride ]; // splineVertex_k+1
  1016. const m1 = values[ offset1 + i ] * td; // inTangent_k+1 * (t_k+1 - t_k)
  1017. result[ i ] = s0 * p0 + s1 * m0 + s2 * p1 + s3 * m1;
  1018. }
  1019. return result;
  1020. };
  1021. const _q = new THREE.Quaternion();
  1022. class GLTFCubicSplineQuaternionInterpolant extends GLTFCubicSplineInterpolant {
  1023. interpolate_( i1, t0, t, t1 ) {
  1024. const result = super.interpolate_( i1, t0, t, t1 );
  1025. _q.fromArray( result ).normalize().toArray( result );
  1026. return result;
  1027. }
  1028. }
  1029. /*********************************/
  1030. /********** INTERNALS ************/
  1031. /*********************************/
  1032. /* CONSTANTS */
  1033. const WEBGL_CONSTANTS = {
  1034. FLOAT: 5126,
  1035. //FLOAT_MAT2: 35674,
  1036. FLOAT_MAT3: 35675,
  1037. FLOAT_MAT4: 35676,
  1038. FLOAT_VEC2: 35664,
  1039. FLOAT_VEC3: 35665,
  1040. FLOAT_VEC4: 35666,
  1041. LINEAR: 9729,
  1042. REPEAT: 10497,
  1043. SAMPLER_2D: 35678,
  1044. POINTS: 0,
  1045. LINES: 1,
  1046. LINE_LOOP: 2,
  1047. LINE_STRIP: 3,
  1048. TRIANGLES: 4,
  1049. TRIANGLE_STRIP: 5,
  1050. TRIANGLE_FAN: 6,
  1051. UNSIGNED_BYTE: 5121,
  1052. UNSIGNED_SHORT: 5123
  1053. };
  1054. const WEBGL_COMPONENT_TYPES = {
  1055. 5120: Int8Array,
  1056. 5121: Uint8Array,
  1057. 5122: Int16Array,
  1058. 5123: Uint16Array,
  1059. 5125: Uint32Array,
  1060. 5126: Float32Array
  1061. };
  1062. const WEBGL_FILTERS = {
  1063. 9728: THREE.NearestFilter,
  1064. 9729: THREE.LinearFilter,
  1065. 9984: THREE.NearestMipmapNearestFilter,
  1066. 9985: THREE.LinearMipmapNearestFilter,
  1067. 9986: THREE.NearestMipmapLinearFilter,
  1068. 9987: THREE.LinearMipmapLinearFilter
  1069. };
  1070. const WEBGL_WRAPPINGS = {
  1071. 33071: THREE.ClampToEdgeWrapping,
  1072. 33648: THREE.MirroredRepeatWrapping,
  1073. 10497: THREE.RepeatWrapping
  1074. };
  1075. const WEBGL_TYPE_SIZES = {
  1076. 'SCALAR': 1,
  1077. 'VEC2': 2,
  1078. 'VEC3': 3,
  1079. 'VEC4': 4,
  1080. 'MAT2': 4,
  1081. 'MAT3': 9,
  1082. 'MAT4': 16
  1083. };
  1084. const ATTRIBUTES = {
  1085. POSITION: 'position',
  1086. NORMAL: 'normal',
  1087. TANGENT: 'tangent',
  1088. TEXCOORD_0: 'uv',
  1089. TEXCOORD_1: 'uv2',
  1090. COLOR_0: 'color',
  1091. WEIGHTS_0: 'skinWeight',
  1092. JOINTS_0: 'skinIndex'
  1093. };
  1094. const PATH_PROPERTIES = {
  1095. scale: 'scale',
  1096. translation: 'position',
  1097. rotation: 'quaternion',
  1098. weights: 'morphTargetInfluences'
  1099. };
  1100. const INTERPOLATION = {
  1101. CUBICSPLINE: undefined,
  1102. // We use a custom interpolant (GLTFCubicSplineInterpolation) for CUBICSPLINE tracks. Each
  1103. // keyframe track will be initialized with a default interpolation type, then modified.
  1104. LINEAR: THREE.InterpolateLinear,
  1105. STEP: THREE.InterpolateDiscrete
  1106. };
  1107. const ALPHA_MODES = {
  1108. OPAQUE: 'OPAQUE',
  1109. MASK: 'MASK',
  1110. BLEND: 'BLEND'
  1111. };
  1112. /* UTILITY FUNCTIONS */
  1113. function resolveURL( url, path ) {
  1114. // Invalid URL
  1115. if ( typeof url !== 'string' || url === '' ) return ''; // Host Relative URL
  1116. if ( /^https?:\/\//i.test( path ) && /^\//.test( url ) ) {
  1117. path = path.replace( /(^https?:\/\/[^\/]+).*/i, '$1' );
  1118. } // Absolute URL http://,https://,//
  1119. if ( /^(https?:)?\/\//i.test( url ) ) return url; // Data URI
  1120. if ( /^data:.*,.*$/i.test( url ) ) return url; // Blob URL
  1121. if ( /^blob:.*$/i.test( url ) ) return url; // Relative URL
  1122. return path + url;
  1123. }
  1124. /**
  1125. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#default-material
  1126. */
  1127. function createDefaultMaterial( cache ) {
  1128. if ( cache[ 'DefaultMaterial' ] === undefined ) {
  1129. cache[ 'DefaultMaterial' ] = new THREE.MeshStandardMaterial( {
  1130. color: 0xFFFFFF,
  1131. emissive: 0x000000,
  1132. metalness: 1,
  1133. roughness: 1,
  1134. transparent: false,
  1135. depthTest: true,
  1136. side: THREE.FrontSide
  1137. } );
  1138. }
  1139. return cache[ 'DefaultMaterial' ];
  1140. }
  1141. function addUnknownExtensionsToUserData( knownExtensions, object, objectDef ) {
  1142. // Add unknown glTF extensions to an object's userData.
  1143. for ( const name in objectDef.extensions ) {
  1144. if ( knownExtensions[ name ] === undefined ) {
  1145. object.userData.gltfExtensions = object.userData.gltfExtensions || {};
  1146. object.userData.gltfExtensions[ name ] = objectDef.extensions[ name ];
  1147. }
  1148. }
  1149. }
  1150. /**
  1151. * @param {Object3D|Material|BufferGeometry} object
  1152. * @param {GLTF.definition} gltfDef
  1153. */
  1154. function assignExtrasToUserData( object, gltfDef ) {
  1155. if ( gltfDef.extras !== undefined ) {
  1156. if ( typeof gltfDef.extras === 'object' ) {
  1157. Object.assign( object.userData, gltfDef.extras );
  1158. } else {
  1159. console.warn( 'THREE.GLTFLoader: Ignoring primitive type .extras, ' + gltfDef.extras );
  1160. }
  1161. }
  1162. }
  1163. /**
  1164. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#morph-targets
  1165. *
  1166. * @param {BufferGeometry} geometry
  1167. * @param {Array<GLTF.Target>} targets
  1168. * @param {GLTFParser} parser
  1169. * @return {Promise<BufferGeometry>}
  1170. */
  1171. function addMorphTargets( geometry, targets, parser ) {
  1172. let hasMorphPosition = false;
  1173. let hasMorphNormal = false;
  1174. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  1175. const target = targets[ i ];
  1176. if ( target.POSITION !== undefined ) hasMorphPosition = true;
  1177. if ( target.NORMAL !== undefined ) hasMorphNormal = true;
  1178. if ( hasMorphPosition && hasMorphNormal ) break;
  1179. }
  1180. if ( ! hasMorphPosition && ! hasMorphNormal ) return Promise.resolve( geometry );
  1181. const pendingPositionAccessors = [];
  1182. const pendingNormalAccessors = [];
  1183. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  1184. const target = targets[ i ];
  1185. if ( hasMorphPosition ) {
  1186. const pendingAccessor = target.POSITION !== undefined ? parser.getDependency( 'accessor', target.POSITION ) : geometry.attributes.position;
  1187. pendingPositionAccessors.push( pendingAccessor );
  1188. }
  1189. if ( hasMorphNormal ) {
  1190. const pendingAccessor = target.NORMAL !== undefined ? parser.getDependency( 'accessor', target.NORMAL ) : geometry.attributes.normal;
  1191. pendingNormalAccessors.push( pendingAccessor );
  1192. }
  1193. }
  1194. return Promise.all( [ Promise.all( pendingPositionAccessors ), Promise.all( pendingNormalAccessors ) ] ).then( function ( accessors ) {
  1195. const morphPositions = accessors[ 0 ];
  1196. const morphNormals = accessors[ 1 ];
  1197. if ( hasMorphPosition ) geometry.morphAttributes.position = morphPositions;
  1198. if ( hasMorphNormal ) geometry.morphAttributes.normal = morphNormals;
  1199. geometry.morphTargetsRelative = true;
  1200. return geometry;
  1201. } );
  1202. }
  1203. /**
  1204. * @param {Mesh} mesh
  1205. * @param {GLTF.Mesh} meshDef
  1206. */
  1207. function updateMorphTargets( mesh, meshDef ) {
  1208. mesh.updateMorphTargets();
  1209. if ( meshDef.weights !== undefined ) {
  1210. for ( let i = 0, il = meshDef.weights.length; i < il; i ++ ) {
  1211. mesh.morphTargetInfluences[ i ] = meshDef.weights[ i ];
  1212. }
  1213. } // .extras has user-defined data, so check that .extras.targetNames is an array.
  1214. if ( meshDef.extras && Array.isArray( meshDef.extras.targetNames ) ) {
  1215. const targetNames = meshDef.extras.targetNames;
  1216. if ( mesh.morphTargetInfluences.length === targetNames.length ) {
  1217. mesh.morphTargetDictionary = {};
  1218. for ( let i = 0, il = targetNames.length; i < il; i ++ ) {
  1219. mesh.morphTargetDictionary[ targetNames[ i ] ] = i;
  1220. }
  1221. } else {
  1222. console.warn( 'THREE.GLTFLoader: Invalid extras.targetNames length. Ignoring names.' );
  1223. }
  1224. }
  1225. }
  1226. function createPrimitiveKey( primitiveDef ) {
  1227. const dracoExtension = primitiveDef.extensions && primitiveDef.extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ];
  1228. let geometryKey;
  1229. if ( dracoExtension ) {
  1230. geometryKey = 'draco:' + dracoExtension.bufferView + ':' + dracoExtension.indices + ':' + createAttributesKey( dracoExtension.attributes );
  1231. } else {
  1232. geometryKey = primitiveDef.indices + ':' + createAttributesKey( primitiveDef.attributes ) + ':' + primitiveDef.mode;
  1233. }
  1234. return geometryKey;
  1235. }
  1236. function createAttributesKey( attributes ) {
  1237. let attributesKey = '';
  1238. const keys = Object.keys( attributes ).sort();
  1239. for ( let i = 0, il = keys.length; i < il; i ++ ) {
  1240. attributesKey += keys[ i ] + ':' + attributes[ keys[ i ] ] + ';';
  1241. }
  1242. return attributesKey;
  1243. }
  1244. function getNormalizedComponentScale( constructor ) {
  1245. // Reference:
  1246. // https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization#encoding-quantized-data
  1247. switch ( constructor ) {
  1248. case Int8Array:
  1249. return 1 / 127;
  1250. case Uint8Array:
  1251. return 1 / 255;
  1252. case Int16Array:
  1253. return 1 / 32767;
  1254. case Uint16Array:
  1255. return 1 / 65535;
  1256. default:
  1257. throw new Error( 'THREE.GLTFLoader: Unsupported normalized accessor component type.' );
  1258. }
  1259. }
  1260. /* GLTF PARSER */
  1261. class GLTFParser {
  1262. constructor( json = {}, options = {} ) {
  1263. this.json = json;
  1264. this.extensions = {};
  1265. this.plugins = {};
  1266. this.options = options; // loader object cache
  1267. this.cache = new GLTFRegistry(); // associations between Three.js objects and glTF elements
  1268. this.associations = new Map(); // THREE.BufferGeometry caching
  1269. this.primitiveCache = {}; // THREE.Object3D instance caches
  1270. this.meshCache = {
  1271. refs: {},
  1272. uses: {}
  1273. };
  1274. this.cameraCache = {
  1275. refs: {},
  1276. uses: {}
  1277. };
  1278. this.lightCache = {
  1279. refs: {},
  1280. uses: {}
  1281. };
  1282. this.textureCache = {}; // Track node names, to ensure no duplicates
  1283. this.nodeNamesUsed = {}; // Use an THREE.ImageBitmapLoader if imageBitmaps are supported. Moves much of the
  1284. // expensive work of uploading a texture to the GPU off the main thread.
  1285. if ( typeof createImageBitmap !== 'undefined' && /Firefox/.test( navigator.userAgent ) === false ) {
  1286. this.textureLoader = new THREE.ImageBitmapLoader( this.options.manager );
  1287. } else {
  1288. this.textureLoader = new THREE.TextureLoader( this.options.manager );
  1289. }
  1290. this.textureLoader.setCrossOrigin( this.options.crossOrigin );
  1291. this.textureLoader.setRequestHeader( this.options.requestHeader );
  1292. this.fileLoader = new THREE.FileLoader( this.options.manager );
  1293. this.fileLoader.setResponseType( 'arraybuffer' );
  1294. if ( this.options.crossOrigin === 'use-credentials' ) {
  1295. this.fileLoader.setWithCredentials( true );
  1296. }
  1297. }
  1298. setExtensions( extensions ) {
  1299. this.extensions = extensions;
  1300. }
  1301. setPlugins( plugins ) {
  1302. this.plugins = plugins;
  1303. }
  1304. parse( onLoad, onError ) {
  1305. const parser = this;
  1306. const json = this.json;
  1307. const extensions = this.extensions; // Clear the loader cache
  1308. this.cache.removeAll(); // Mark the special nodes/meshes in json for efficient parse
  1309. this._invokeAll( function ( ext ) {
  1310. return ext._markDefs && ext._markDefs();
  1311. } );
  1312. Promise.all( this._invokeAll( function ( ext ) {
  1313. return ext.beforeRoot && ext.beforeRoot();
  1314. } ) ).then( function () {
  1315. return Promise.all( [ parser.getDependencies( 'scene' ), parser.getDependencies( 'animation' ), parser.getDependencies( 'camera' ) ] );
  1316. } ).then( function ( dependencies ) {
  1317. const result = {
  1318. scene: dependencies[ 0 ][ json.scene || 0 ],
  1319. scenes: dependencies[ 0 ],
  1320. animations: dependencies[ 1 ],
  1321. cameras: dependencies[ 2 ],
  1322. asset: json.asset,
  1323. parser: parser,
  1324. userData: {}
  1325. };
  1326. addUnknownExtensionsToUserData( extensions, result, json );
  1327. assignExtrasToUserData( result, json );
  1328. Promise.all( parser._invokeAll( function ( ext ) {
  1329. return ext.afterRoot && ext.afterRoot( result );
  1330. } ) ).then( function () {
  1331. onLoad( result );
  1332. } );
  1333. } ).catch( onError );
  1334. }
  1335. /**
  1336. * Marks the special nodes/meshes in json for efficient parse.
  1337. */
  1338. _markDefs() {
  1339. const nodeDefs = this.json.nodes || [];
  1340. const skinDefs = this.json.skins || [];
  1341. const meshDefs = this.json.meshes || []; // Nothing in the node definition indicates whether it is a THREE.Bone or an
  1342. // THREE.Object3D. Use the skins' joint references to mark bones.
  1343. for ( let skinIndex = 0, skinLength = skinDefs.length; skinIndex < skinLength; skinIndex ++ ) {
  1344. const joints = skinDefs[ skinIndex ].joints;
  1345. for ( let i = 0, il = joints.length; i < il; i ++ ) {
  1346. nodeDefs[ joints[ i ] ].isBone = true;
  1347. }
  1348. } // Iterate over all nodes, marking references to shared resources,
  1349. // as well as skeleton joints.
  1350. for ( let nodeIndex = 0, nodeLength = nodeDefs.length; nodeIndex < nodeLength; nodeIndex ++ ) {
  1351. const nodeDef = nodeDefs[ nodeIndex ];
  1352. if ( nodeDef.mesh !== undefined ) {
  1353. this._addNodeRef( this.meshCache, nodeDef.mesh ); // Nothing in the mesh definition indicates whether it is
  1354. // a THREE.SkinnedMesh or THREE.Mesh. Use the node's mesh reference
  1355. // to mark THREE.SkinnedMesh if node has skin.
  1356. if ( nodeDef.skin !== undefined ) {
  1357. meshDefs[ nodeDef.mesh ].isSkinnedMesh = true;
  1358. }
  1359. }
  1360. if ( nodeDef.camera !== undefined ) {
  1361. this._addNodeRef( this.cameraCache, nodeDef.camera );
  1362. }
  1363. }
  1364. }
  1365. /**
  1366. * Counts references to shared node / THREE.Object3D resources. These resources
  1367. * can be reused, or "instantiated", at multiple nodes in the scene
  1368. * hierarchy. THREE.Mesh, Camera, and Light instances are instantiated and must
  1369. * be marked. Non-scenegraph resources (like Materials, Geometries, and
  1370. * Textures) can be reused directly and are not marked here.
  1371. *
  1372. * Example: CesiumMilkTruck sample model reuses "Wheel" meshes.
  1373. */
  1374. _addNodeRef( cache, index ) {
  1375. if ( index === undefined ) return;
  1376. if ( cache.refs[ index ] === undefined ) {
  1377. cache.refs[ index ] = cache.uses[ index ] = 0;
  1378. }
  1379. cache.refs[ index ] ++;
  1380. }
  1381. /** Returns a reference to a shared resource, cloning it if necessary. */
  1382. _getNodeRef( cache, index, object ) {
  1383. if ( cache.refs[ index ] <= 1 ) return object;
  1384. const ref = object.clone(); // Propagates mappings to the cloned object, prevents mappings on the
  1385. // original object from being lost.
  1386. const updateMappings = ( original, clone ) => {
  1387. const mappings = this.associations.get( original );
  1388. if ( mappings != null ) {
  1389. this.associations.set( clone, mappings );
  1390. }
  1391. for ( const [ i, child ] of original.children.entries() ) {
  1392. updateMappings( child, clone.children[ i ] );
  1393. }
  1394. };
  1395. updateMappings( object, ref );
  1396. ref.name += '_instance_' + cache.uses[ index ] ++;
  1397. return ref;
  1398. }
  1399. _invokeOne( func ) {
  1400. const extensions = Object.values( this.plugins );
  1401. extensions.push( this );
  1402. for ( let i = 0; i < extensions.length; i ++ ) {
  1403. const result = func( extensions[ i ] );
  1404. if ( result ) return result;
  1405. }
  1406. return null;
  1407. }
  1408. _invokeAll( func ) {
  1409. const extensions = Object.values( this.plugins );
  1410. extensions.unshift( this );
  1411. const pending = [];
  1412. for ( let i = 0; i < extensions.length; i ++ ) {
  1413. const result = func( extensions[ i ] );
  1414. if ( result ) pending.push( result );
  1415. }
  1416. return pending;
  1417. }
  1418. /**
  1419. * Requests the specified dependency asynchronously, with caching.
  1420. * @param {string} type
  1421. * @param {number} index
  1422. * @return {Promise<Object3D|Material|THREE.Texture|AnimationClip|ArrayBuffer|Object>}
  1423. */
  1424. getDependency( type, index ) {
  1425. const cacheKey = type + ':' + index;
  1426. let dependency = this.cache.get( cacheKey );
  1427. if ( ! dependency ) {
  1428. switch ( type ) {
  1429. case 'scene':
  1430. dependency = this.loadScene( index );
  1431. break;
  1432. case 'node':
  1433. dependency = this.loadNode( index );
  1434. break;
  1435. case 'mesh':
  1436. dependency = this._invokeOne( function ( ext ) {
  1437. return ext.loadMesh && ext.loadMesh( index );
  1438. } );
  1439. break;
  1440. case 'accessor':
  1441. dependency = this.loadAccessor( index );
  1442. break;
  1443. case 'bufferView':
  1444. dependency = this._invokeOne( function ( ext ) {
  1445. return ext.loadBufferView && ext.loadBufferView( index );
  1446. } );
  1447. break;
  1448. case 'buffer':
  1449. dependency = this.loadBuffer( index );
  1450. break;
  1451. case 'material':
  1452. dependency = this._invokeOne( function ( ext ) {
  1453. return ext.loadMaterial && ext.loadMaterial( index );
  1454. } );
  1455. break;
  1456. case 'texture':
  1457. dependency = this._invokeOne( function ( ext ) {
  1458. return ext.loadTexture && ext.loadTexture( index );
  1459. } );
  1460. break;
  1461. case 'skin':
  1462. dependency = this.loadSkin( index );
  1463. break;
  1464. case 'animation':
  1465. dependency = this.loadAnimation( index );
  1466. break;
  1467. case 'camera':
  1468. dependency = this.loadCamera( index );
  1469. break;
  1470. default:
  1471. throw new Error( 'Unknown type: ' + type );
  1472. }
  1473. this.cache.add( cacheKey, dependency );
  1474. }
  1475. return dependency;
  1476. }
  1477. /**
  1478. * Requests all dependencies of the specified type asynchronously, with caching.
  1479. * @param {string} type
  1480. * @return {Promise<Array<Object>>}
  1481. */
  1482. getDependencies( type ) {
  1483. let dependencies = this.cache.get( type );
  1484. if ( ! dependencies ) {
  1485. const parser = this;
  1486. const defs = this.json[ type + ( type === 'mesh' ? 'es' : 's' ) ] || [];
  1487. dependencies = Promise.all( defs.map( function ( def, index ) {
  1488. return parser.getDependency( type, index );
  1489. } ) );
  1490. this.cache.add( type, dependencies );
  1491. }
  1492. return dependencies;
  1493. }
  1494. /**
  1495. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#buffers-and-buffer-views
  1496. * @param {number} bufferIndex
  1497. * @return {Promise<ArrayBuffer>}
  1498. */
  1499. loadBuffer( bufferIndex ) {
  1500. const bufferDef = this.json.buffers[ bufferIndex ];
  1501. const loader = this.fileLoader;
  1502. if ( bufferDef.type && bufferDef.type !== 'arraybuffer' ) {
  1503. throw new Error( 'THREE.GLTFLoader: ' + bufferDef.type + ' buffer type is not supported.' );
  1504. } // If present, GLB container is required to be the first buffer.
  1505. if ( bufferDef.uri === undefined && bufferIndex === 0 ) {
  1506. return Promise.resolve( this.extensions[ EXTENSIONS.KHR_BINARY_GLTF ].body );
  1507. }
  1508. const options = this.options;
  1509. return new Promise( function ( resolve, reject ) {
  1510. loader.load( resolveURL( bufferDef.uri, options.path ), resolve, undefined, function () {
  1511. reject( new Error( 'THREE.GLTFLoader: Failed to load buffer "' + bufferDef.uri + '".' ) );
  1512. } );
  1513. } );
  1514. }
  1515. /**
  1516. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#buffers-and-buffer-views
  1517. * @param {number} bufferViewIndex
  1518. * @return {Promise<ArrayBuffer>}
  1519. */
  1520. loadBufferView( bufferViewIndex ) {
  1521. const bufferViewDef = this.json.bufferViews[ bufferViewIndex ];
  1522. return this.getDependency( 'buffer', bufferViewDef.buffer ).then( function ( buffer ) {
  1523. const byteLength = bufferViewDef.byteLength || 0;
  1524. const byteOffset = bufferViewDef.byteOffset || 0;
  1525. return buffer.slice( byteOffset, byteOffset + byteLength );
  1526. } );
  1527. }
  1528. /**
  1529. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#accessors
  1530. * @param {number} accessorIndex
  1531. * @return {Promise<BufferAttribute|InterleavedBufferAttribute>}
  1532. */
  1533. loadAccessor( accessorIndex ) {
  1534. const parser = this;
  1535. const json = this.json;
  1536. const accessorDef = this.json.accessors[ accessorIndex ];
  1537. if ( accessorDef.bufferView === undefined && accessorDef.sparse === undefined ) {
  1538. // Ignore empty accessors, which may be used to declare runtime
  1539. // information about attributes coming from another source (e.g. Draco
  1540. // compression extension).
  1541. return Promise.resolve( null );
  1542. }
  1543. const pendingBufferViews = [];
  1544. if ( accessorDef.bufferView !== undefined ) {
  1545. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.bufferView ) );
  1546. } else {
  1547. pendingBufferViews.push( null );
  1548. }
  1549. if ( accessorDef.sparse !== undefined ) {
  1550. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.sparse.indices.bufferView ) );
  1551. pendingBufferViews.push( this.getDependency( 'bufferView', accessorDef.sparse.values.bufferView ) );
  1552. }
  1553. return Promise.all( pendingBufferViews ).then( function ( bufferViews ) {
  1554. const bufferView = bufferViews[ 0 ];
  1555. const itemSize = WEBGL_TYPE_SIZES[ accessorDef.type ];
  1556. const TypedArray = WEBGL_COMPONENT_TYPES[ accessorDef.componentType ]; // For VEC3: itemSize is 3, elementBytes is 4, itemBytes is 12.
  1557. const elementBytes = TypedArray.BYTES_PER_ELEMENT;
  1558. const itemBytes = elementBytes * itemSize;
  1559. const byteOffset = accessorDef.byteOffset || 0;
  1560. const byteStride = accessorDef.bufferView !== undefined ? json.bufferViews[ accessorDef.bufferView ].byteStride : undefined;
  1561. const normalized = accessorDef.normalized === true;
  1562. let array, bufferAttribute; // The buffer is not interleaved if the stride is the item size in bytes.
  1563. if ( byteStride && byteStride !== itemBytes ) {
  1564. // Each "slice" of the buffer, as defined by 'count' elements of 'byteStride' bytes, gets its own THREE.InterleavedBuffer
  1565. // This makes sure that IBA.count reflects accessor.count properly
  1566. const ibSlice = Math.floor( byteOffset / byteStride );
  1567. const ibCacheKey = 'InterleavedBuffer:' + accessorDef.bufferView + ':' + accessorDef.componentType + ':' + ibSlice + ':' + accessorDef.count;
  1568. let ib = parser.cache.get( ibCacheKey );
  1569. if ( ! ib ) {
  1570. array = new TypedArray( bufferView, ibSlice * byteStride, accessorDef.count * byteStride / elementBytes ); // Integer parameters to IB/IBA are in array elements, not bytes.
  1571. ib = new THREE.InterleavedBuffer( array, byteStride / elementBytes );
  1572. parser.cache.add( ibCacheKey, ib );
  1573. }
  1574. bufferAttribute = new THREE.InterleavedBufferAttribute( ib, itemSize, byteOffset % byteStride / elementBytes, normalized );
  1575. } else {
  1576. if ( bufferView === null ) {
  1577. array = new TypedArray( accessorDef.count * itemSize );
  1578. } else {
  1579. array = new TypedArray( bufferView, byteOffset, accessorDef.count * itemSize );
  1580. }
  1581. bufferAttribute = new THREE.BufferAttribute( array, itemSize, normalized );
  1582. } // https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#sparse-accessors
  1583. if ( accessorDef.sparse !== undefined ) {
  1584. const itemSizeIndices = WEBGL_TYPE_SIZES.SCALAR;
  1585. const TypedArrayIndices = WEBGL_COMPONENT_TYPES[ accessorDef.sparse.indices.componentType ];
  1586. const byteOffsetIndices = accessorDef.sparse.indices.byteOffset || 0;
  1587. const byteOffsetValues = accessorDef.sparse.values.byteOffset || 0;
  1588. const sparseIndices = new TypedArrayIndices( bufferViews[ 1 ], byteOffsetIndices, accessorDef.sparse.count * itemSizeIndices );
  1589. const sparseValues = new TypedArray( bufferViews[ 2 ], byteOffsetValues, accessorDef.sparse.count * itemSize );
  1590. if ( bufferView !== null ) {
  1591. // Avoid modifying the original ArrayBuffer, if the bufferView wasn't initialized with zeroes.
  1592. bufferAttribute = new THREE.BufferAttribute( bufferAttribute.array.slice(), bufferAttribute.itemSize, bufferAttribute.normalized );
  1593. }
  1594. for ( let i = 0, il = sparseIndices.length; i < il; i ++ ) {
  1595. const index = sparseIndices[ i ];
  1596. bufferAttribute.setX( index, sparseValues[ i * itemSize ] );
  1597. if ( itemSize >= 2 ) bufferAttribute.setY( index, sparseValues[ i * itemSize + 1 ] );
  1598. if ( itemSize >= 3 ) bufferAttribute.setZ( index, sparseValues[ i * itemSize + 2 ] );
  1599. if ( itemSize >= 4 ) bufferAttribute.setW( index, sparseValues[ i * itemSize + 3 ] );
  1600. if ( itemSize >= 5 ) throw new Error( 'THREE.GLTFLoader: Unsupported itemSize in sparse THREE.BufferAttribute.' );
  1601. }
  1602. }
  1603. return bufferAttribute;
  1604. } );
  1605. }
  1606. /**
  1607. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#textures
  1608. * @param {number} textureIndex
  1609. * @return {Promise<THREE.Texture>}
  1610. */
  1611. loadTexture( textureIndex ) {
  1612. const json = this.json;
  1613. const options = this.options;
  1614. const textureDef = json.textures[ textureIndex ];
  1615. const source = json.images[ textureDef.source ];
  1616. let loader = this.textureLoader;
  1617. if ( source.uri ) {
  1618. const handler = options.manager.getHandler( source.uri );
  1619. if ( handler !== null ) loader = handler;
  1620. }
  1621. return this.loadTextureImage( textureIndex, source, loader );
  1622. }
  1623. loadTextureImage( textureIndex, source, loader ) {
  1624. const parser = this;
  1625. const json = this.json;
  1626. const options = this.options;
  1627. const textureDef = json.textures[ textureIndex ];
  1628. const cacheKey = ( source.uri || source.bufferView ) + ':' + textureDef.sampler;
  1629. if ( this.textureCache[ cacheKey ] ) {
  1630. // See https://github.com/mrdoob/three.js/issues/21559.
  1631. return this.textureCache[ cacheKey ];
  1632. }
  1633. const URL = self.URL || self.webkitURL;
  1634. let sourceURI = source.uri || '';
  1635. let isObjectURL = false;
  1636. if ( source.bufferView !== undefined ) {
  1637. // Load binary image data from bufferView, if provided.
  1638. sourceURI = parser.getDependency( 'bufferView', source.bufferView ).then( function ( bufferView ) {
  1639. isObjectURL = true;
  1640. const blob = new Blob( [ bufferView ], {
  1641. type: source.mimeType
  1642. } );
  1643. sourceURI = URL.createObjectURL( blob );
  1644. return sourceURI;
  1645. } );
  1646. } else if ( source.uri === undefined ) {
  1647. throw new Error( 'THREE.GLTFLoader: Image ' + textureIndex + ' is missing URI and bufferView' );
  1648. }
  1649. const promise = Promise.resolve( sourceURI ).then( function ( sourceURI ) {
  1650. return new Promise( function ( resolve, reject ) {
  1651. let onLoad = resolve;
  1652. if ( loader.isImageBitmapLoader === true ) {
  1653. onLoad = function ( imageBitmap ) {
  1654. const texture = new THREE.Texture( imageBitmap );
  1655. texture.needsUpdate = true;
  1656. resolve( texture );
  1657. };
  1658. }
  1659. loader.load( resolveURL( sourceURI, options.path ), onLoad, undefined, reject );
  1660. } );
  1661. } ).then( function ( texture ) {
  1662. // Clean up resources and configure THREE.Texture.
  1663. if ( isObjectURL === true ) {
  1664. URL.revokeObjectURL( sourceURI );
  1665. }
  1666. texture.flipY = false;
  1667. if ( textureDef.name ) texture.name = textureDef.name;
  1668. const samplers = json.samplers || {};
  1669. const sampler = samplers[ textureDef.sampler ] || {};
  1670. texture.magFilter = WEBGL_FILTERS[ sampler.magFilter ] || THREE.LinearFilter;
  1671. texture.minFilter = WEBGL_FILTERS[ sampler.minFilter ] || THREE.LinearMipmapLinearFilter;
  1672. texture.wrapS = WEBGL_WRAPPINGS[ sampler.wrapS ] || THREE.RepeatWrapping;
  1673. texture.wrapT = WEBGL_WRAPPINGS[ sampler.wrapT ] || THREE.RepeatWrapping;
  1674. parser.associations.set( texture, {
  1675. textures: textureIndex
  1676. } );
  1677. return texture;
  1678. } ).catch( function () {
  1679. console.error( 'THREE.GLTFLoader: Couldn\'t load texture', sourceURI );
  1680. return null;
  1681. } );
  1682. this.textureCache[ cacheKey ] = promise;
  1683. return promise;
  1684. }
  1685. /**
  1686. * Asynchronously assigns a texture to the given material parameters.
  1687. * @param {Object} materialParams
  1688. * @param {string} mapName
  1689. * @param {Object} mapDef
  1690. * @return {Promise<Texture>}
  1691. */
  1692. assignTexture( materialParams, mapName, mapDef ) {
  1693. const parser = this;
  1694. return this.getDependency( 'texture', mapDef.index ).then( function ( texture ) {
  1695. // Materials sample aoMap from UV set 1 and other maps from UV set 0 - this can't be configured
  1696. // However, we will copy UV set 0 to UV set 1 on demand for aoMap
  1697. if ( mapDef.texCoord !== undefined && mapDef.texCoord != 0 && ! ( mapName === 'aoMap' && mapDef.texCoord == 1 ) ) {
  1698. console.warn( 'THREE.GLTFLoader: Custom UV set ' + mapDef.texCoord + ' for texture ' + mapName + ' not yet supported.' );
  1699. }
  1700. if ( parser.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ] ) {
  1701. const transform = mapDef.extensions !== undefined ? mapDef.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ] : undefined;
  1702. if ( transform ) {
  1703. const gltfReference = parser.associations.get( texture );
  1704. texture = parser.extensions[ EXTENSIONS.KHR_TEXTURE_TRANSFORM ].extendTexture( texture, transform );
  1705. parser.associations.set( texture, gltfReference );
  1706. }
  1707. }
  1708. materialParams[ mapName ] = texture;
  1709. return texture;
  1710. } );
  1711. }
  1712. /**
  1713. * Assigns final material to a THREE.Mesh, THREE.Line, or THREE.Points instance. The instance
  1714. * already has a material (generated from the glTF material options alone)
  1715. * but reuse of the same glTF material may require multiple threejs materials
  1716. * to accommodate different primitive types, defines, etc. New materials will
  1717. * be created if necessary, and reused from a cache.
  1718. * @param {Object3D} mesh THREE.Mesh, THREE.Line, or THREE.Points instance.
  1719. */
  1720. assignFinalMaterial( mesh ) {
  1721. const geometry = mesh.geometry;
  1722. let material = mesh.material;
  1723. const useDerivativeTangents = geometry.attributes.tangent === undefined;
  1724. const useVertexColors = geometry.attributes.color !== undefined;
  1725. const useFlatShading = geometry.attributes.normal === undefined;
  1726. if ( mesh.isPoints ) {
  1727. const cacheKey = 'PointsMaterial:' + material.uuid;
  1728. let pointsMaterial = this.cache.get( cacheKey );
  1729. if ( ! pointsMaterial ) {
  1730. pointsMaterial = new THREE.PointsMaterial();
  1731. THREE.Material.prototype.copy.call( pointsMaterial, material );
  1732. pointsMaterial.color.copy( material.color );
  1733. pointsMaterial.map = material.map;
  1734. pointsMaterial.sizeAttenuation = false; // glTF spec says points should be 1px
  1735. this.cache.add( cacheKey, pointsMaterial );
  1736. }
  1737. material = pointsMaterial;
  1738. } else if ( mesh.isLine ) {
  1739. const cacheKey = 'LineBasicMaterial:' + material.uuid;
  1740. let lineMaterial = this.cache.get( cacheKey );
  1741. if ( ! lineMaterial ) {
  1742. lineMaterial = new THREE.LineBasicMaterial();
  1743. THREE.Material.prototype.copy.call( lineMaterial, material );
  1744. lineMaterial.color.copy( material.color );
  1745. this.cache.add( cacheKey, lineMaterial );
  1746. }
  1747. material = lineMaterial;
  1748. } // Clone the material if it will be modified
  1749. if ( useDerivativeTangents || useVertexColors || useFlatShading ) {
  1750. let cacheKey = 'ClonedMaterial:' + material.uuid + ':';
  1751. if ( material.isGLTFSpecularGlossinessMaterial ) cacheKey += 'specular-glossiness:';
  1752. if ( useDerivativeTangents ) cacheKey += 'derivative-tangents:';
  1753. if ( useVertexColors ) cacheKey += 'vertex-colors:';
  1754. if ( useFlatShading ) cacheKey += 'flat-shading:';
  1755. let cachedMaterial = this.cache.get( cacheKey );
  1756. if ( ! cachedMaterial ) {
  1757. cachedMaterial = material.clone();
  1758. if ( useVertexColors ) cachedMaterial.vertexColors = true;
  1759. if ( useFlatShading ) cachedMaterial.flatShading = true;
  1760. if ( useDerivativeTangents ) {
  1761. // https://github.com/mrdoob/three.js/issues/11438#issuecomment-507003995
  1762. if ( cachedMaterial.normalScale ) cachedMaterial.normalScale.y *= - 1;
  1763. if ( cachedMaterial.clearcoatNormalScale ) cachedMaterial.clearcoatNormalScale.y *= - 1;
  1764. }
  1765. this.cache.add( cacheKey, cachedMaterial );
  1766. this.associations.set( cachedMaterial, this.associations.get( material ) );
  1767. }
  1768. material = cachedMaterial;
  1769. } // workarounds for mesh and geometry
  1770. if ( material.aoMap && geometry.attributes.uv2 === undefined && geometry.attributes.uv !== undefined ) {
  1771. geometry.setAttribute( 'uv2', geometry.attributes.uv );
  1772. }
  1773. mesh.material = material;
  1774. }
  1775. getMaterialType() {
  1776. return THREE.MeshStandardMaterial;
  1777. }
  1778. /**
  1779. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#materials
  1780. * @param {number} materialIndex
  1781. * @return {Promise<Material>}
  1782. */
  1783. loadMaterial( materialIndex ) {
  1784. const parser = this;
  1785. const json = this.json;
  1786. const extensions = this.extensions;
  1787. const materialDef = json.materials[ materialIndex ];
  1788. let materialType;
  1789. const materialParams = {};
  1790. const materialExtensions = materialDef.extensions || {};
  1791. const pending = [];
  1792. if ( materialExtensions[ EXTENSIONS.KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS ] ) {
  1793. const sgExtension = extensions[ EXTENSIONS.KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS ];
  1794. materialType = sgExtension.getMaterialType();
  1795. pending.push( sgExtension.extendParams( materialParams, materialDef, parser ) );
  1796. } else if ( materialExtensions[ EXTENSIONS.KHR_MATERIALS_UNLIT ] ) {
  1797. const kmuExtension = extensions[ EXTENSIONS.KHR_MATERIALS_UNLIT ];
  1798. materialType = kmuExtension.getMaterialType();
  1799. pending.push( kmuExtension.extendParams( materialParams, materialDef, parser ) );
  1800. } else {
  1801. // Specification:
  1802. // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#metallic-roughness-material
  1803. const metallicRoughness = materialDef.pbrMetallicRoughness || {};
  1804. materialParams.color = new THREE.Color( 1.0, 1.0, 1.0 );
  1805. materialParams.opacity = 1.0;
  1806. if ( Array.isArray( metallicRoughness.baseColorFactor ) ) {
  1807. const array = metallicRoughness.baseColorFactor;
  1808. materialParams.color.fromArray( array );
  1809. materialParams.opacity = array[ 3 ];
  1810. }
  1811. if ( metallicRoughness.baseColorTexture !== undefined ) {
  1812. pending.push( parser.assignTexture( materialParams, 'map', metallicRoughness.baseColorTexture ) );
  1813. }
  1814. materialParams.metalness = metallicRoughness.metallicFactor !== undefined ? metallicRoughness.metallicFactor : 1.0;
  1815. materialParams.roughness = metallicRoughness.roughnessFactor !== undefined ? metallicRoughness.roughnessFactor : 1.0;
  1816. if ( metallicRoughness.metallicRoughnessTexture !== undefined ) {
  1817. pending.push( parser.assignTexture( materialParams, 'metalnessMap', metallicRoughness.metallicRoughnessTexture ) );
  1818. pending.push( parser.assignTexture( materialParams, 'roughnessMap', metallicRoughness.metallicRoughnessTexture ) );
  1819. }
  1820. materialType = this._invokeOne( function ( ext ) {
  1821. return ext.getMaterialType && ext.getMaterialType( materialIndex );
  1822. } );
  1823. pending.push( Promise.all( this._invokeAll( function ( ext ) {
  1824. return ext.extendMaterialParams && ext.extendMaterialParams( materialIndex, materialParams );
  1825. } ) ) );
  1826. }
  1827. if ( materialDef.doubleSided === true ) {
  1828. materialParams.side = THREE.DoubleSide;
  1829. }
  1830. const alphaMode = materialDef.alphaMode || ALPHA_MODES.OPAQUE;
  1831. if ( alphaMode === ALPHA_MODES.BLEND ) {
  1832. materialParams.transparent = true; // See: https://github.com/mrdoob/three.js/issues/17706
  1833. materialParams.depthWrite = false;
  1834. } else {
  1835. materialParams.format = THREE.RGBFormat;
  1836. materialParams.transparent = false;
  1837. if ( alphaMode === ALPHA_MODES.MASK ) {
  1838. materialParams.alphaTest = materialDef.alphaCutoff !== undefined ? materialDef.alphaCutoff : 0.5;
  1839. }
  1840. }
  1841. if ( materialDef.normalTexture !== undefined && materialType !== THREE.MeshBasicMaterial ) {
  1842. pending.push( parser.assignTexture( materialParams, 'normalMap', materialDef.normalTexture ) );
  1843. materialParams.normalScale = new THREE.Vector2( 1, 1 );
  1844. if ( materialDef.normalTexture.scale !== undefined ) {
  1845. const scale = materialDef.normalTexture.scale;
  1846. materialParams.normalScale.set( scale, scale );
  1847. }
  1848. }
  1849. if ( materialDef.occlusionTexture !== undefined && materialType !== THREE.MeshBasicMaterial ) {
  1850. pending.push( parser.assignTexture( materialParams, 'aoMap', materialDef.occlusionTexture ) );
  1851. if ( materialDef.occlusionTexture.strength !== undefined ) {
  1852. materialParams.aoMapIntensity = materialDef.occlusionTexture.strength;
  1853. }
  1854. }
  1855. if ( materialDef.emissiveFactor !== undefined && materialType !== THREE.MeshBasicMaterial ) {
  1856. materialParams.emissive = new THREE.Color().fromArray( materialDef.emissiveFactor );
  1857. }
  1858. if ( materialDef.emissiveTexture !== undefined && materialType !== THREE.MeshBasicMaterial ) {
  1859. pending.push( parser.assignTexture( materialParams, 'emissiveMap', materialDef.emissiveTexture ) );
  1860. }
  1861. return Promise.all( pending ).then( function () {
  1862. let material;
  1863. if ( materialType === GLTFMeshStandardSGMaterial ) {
  1864. material = extensions[ EXTENSIONS.KHR_MATERIALS_PBR_SPECULAR_GLOSSINESS ].createMaterial( materialParams );
  1865. } else {
  1866. material = new materialType( materialParams );
  1867. }
  1868. if ( materialDef.name ) material.name = materialDef.name; // baseColorTexture, emissiveTexture, and specularGlossinessTexture use sRGB encoding.
  1869. if ( material.map ) material.map.encoding = THREE.sRGBEncoding;
  1870. if ( material.emissiveMap ) material.emissiveMap.encoding = THREE.sRGBEncoding;
  1871. assignExtrasToUserData( material, materialDef );
  1872. parser.associations.set( material, {
  1873. materials: materialIndex
  1874. } );
  1875. if ( materialDef.extensions ) addUnknownExtensionsToUserData( extensions, material, materialDef );
  1876. return material;
  1877. } );
  1878. }
  1879. /** When THREE.Object3D instances are targeted by animation, they need unique names. */
  1880. createUniqueName( originalName ) {
  1881. const sanitizedName = THREE.PropertyBinding.sanitizeNodeName( originalName || '' );
  1882. let name = sanitizedName;
  1883. for ( let i = 1; this.nodeNamesUsed[ name ]; ++ i ) {
  1884. name = sanitizedName + '_' + i;
  1885. }
  1886. this.nodeNamesUsed[ name ] = true;
  1887. return name;
  1888. }
  1889. /**
  1890. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#geometry
  1891. *
  1892. * Creates BufferGeometries from primitives.
  1893. *
  1894. * @param {Array<GLTF.Primitive>} primitives
  1895. * @return {Promise<Array<BufferGeometry>>}
  1896. */
  1897. loadGeometries( primitives ) {
  1898. const parser = this;
  1899. const extensions = this.extensions;
  1900. const cache = this.primitiveCache;
  1901. function createDracoPrimitive( primitive ) {
  1902. return extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ].decodePrimitive( primitive, parser ).then( function ( geometry ) {
  1903. return addPrimitiveAttributes( geometry, primitive, parser );
  1904. } );
  1905. }
  1906. const pending = [];
  1907. for ( let i = 0, il = primitives.length; i < il; i ++ ) {
  1908. const primitive = primitives[ i ];
  1909. const cacheKey = createPrimitiveKey( primitive ); // See if we've already created this geometry
  1910. const cached = cache[ cacheKey ];
  1911. if ( cached ) {
  1912. // Use the cached geometry if it exists
  1913. pending.push( cached.promise );
  1914. } else {
  1915. let geometryPromise;
  1916. if ( primitive.extensions && primitive.extensions[ EXTENSIONS.KHR_DRACO_MESH_COMPRESSION ] ) {
  1917. // Use DRACO geometry if available
  1918. geometryPromise = createDracoPrimitive( primitive );
  1919. } else {
  1920. // Otherwise create a new geometry
  1921. geometryPromise = addPrimitiveAttributes( new THREE.BufferGeometry(), primitive, parser );
  1922. } // Cache this geometry
  1923. cache[ cacheKey ] = {
  1924. primitive: primitive,
  1925. promise: geometryPromise
  1926. };
  1927. pending.push( geometryPromise );
  1928. }
  1929. }
  1930. return Promise.all( pending );
  1931. }
  1932. /**
  1933. * Specification: https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#meshes
  1934. * @param {number} meshIndex
  1935. * @return {Promise<Group|Mesh|SkinnedMesh>}
  1936. */
  1937. loadMesh( meshIndex ) {
  1938. const parser = this;
  1939. const json = this.json;
  1940. const extensions = this.extensions;
  1941. const meshDef = json.meshes[ meshIndex ];
  1942. const primitives = meshDef.primitives;
  1943. const pending = [];
  1944. for ( let i = 0, il = primitives.length; i < il; i ++ ) {
  1945. const material = primitives[ i ].material === undefined ? createDefaultMaterial( this.cache ) : this.getDependency( 'material', primitives[ i ].material );
  1946. pending.push( material );
  1947. }
  1948. pending.push( parser.loadGeometries( primitives ) );
  1949. return Promise.all( pending ).then( function ( results ) {
  1950. const materials = results.slice( 0, results.length - 1 );
  1951. const geometries = results[ results.length - 1 ];
  1952. const meshes = [];
  1953. for ( let i = 0, il = geometries.length; i < il; i ++ ) {
  1954. const geometry = geometries[ i ];
  1955. const primitive = primitives[ i ]; // 1. create THREE.Mesh
  1956. let mesh;
  1957. const material = materials[ i ];
  1958. if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLES || primitive.mode === WEBGL_CONSTANTS.TRIANGLE_STRIP || primitive.mode === WEBGL_CONSTANTS.TRIANGLE_FAN || primitive.mode === undefined ) {
  1959. // .isSkinnedMesh isn't in glTF spec. See ._markDefs()
  1960. mesh = meshDef.isSkinnedMesh === true ? new THREE.SkinnedMesh( geometry, material ) : new THREE.Mesh( geometry, material );
  1961. if ( mesh.isSkinnedMesh === true && ! mesh.geometry.attributes.skinWeight.normalized ) {
  1962. // we normalize floating point skin weight array to fix malformed assets (see #15319)
  1963. // it's important to skip this for non-float32 data since normalizeSkinWeights assumes non-normalized inputs
  1964. mesh.normalizeSkinWeights();
  1965. }
  1966. if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLE_STRIP ) {
  1967. mesh.geometry = toTrianglesDrawMode( mesh.geometry, THREE.TriangleStripDrawMode );
  1968. } else if ( primitive.mode === WEBGL_CONSTANTS.TRIANGLE_FAN ) {
  1969. mesh.geometry = toTrianglesDrawMode( mesh.geometry, THREE.TriangleFanDrawMode );
  1970. }
  1971. } else if ( primitive.mode === WEBGL_CONSTANTS.LINES ) {
  1972. mesh = new THREE.LineSegments( geometry, material );
  1973. } else if ( primitive.mode === WEBGL_CONSTANTS.LINE_STRIP ) {
  1974. mesh = new THREE.Line( geometry, material );
  1975. } else if ( primitive.mode === WEBGL_CONSTANTS.LINE_LOOP ) {
  1976. mesh = new THREE.LineLoop( geometry, material );
  1977. } else if ( primitive.mode === WEBGL_CONSTANTS.POINTS ) {
  1978. mesh = new THREE.Points( geometry, material );
  1979. } else {
  1980. throw new Error( 'THREE.GLTFLoader: Primitive mode unsupported: ' + primitive.mode );
  1981. }
  1982. if ( Object.keys( mesh.geometry.morphAttributes ).length > 0 ) {
  1983. updateMorphTargets( mesh, meshDef );
  1984. }
  1985. mesh.name = parser.createUniqueName( meshDef.name || 'mesh_' + meshIndex );
  1986. assignExtrasToUserData( mesh, meshDef );
  1987. if ( primitive.extensions ) addUnknownExtensionsToUserData( extensions, mesh, primitive );
  1988. parser.assignFinalMaterial( mesh );
  1989. meshes.push( mesh );
  1990. }
  1991. for ( let i = 0, il = meshes.length; i < il; i ++ ) {
  1992. parser.associations.set( meshes[ i ], {
  1993. meshes: meshIndex,
  1994. primitives: i
  1995. } );
  1996. }
  1997. if ( meshes.length === 1 ) {
  1998. return meshes[ 0 ];
  1999. }
  2000. const group = new THREE.Group();
  2001. parser.associations.set( group, {
  2002. meshes: meshIndex
  2003. } );
  2004. for ( let i = 0, il = meshes.length; i < il; i ++ ) {
  2005. group.add( meshes[ i ] );
  2006. }
  2007. return group;
  2008. } );
  2009. }
  2010. /**
  2011. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#cameras
  2012. * @param {number} cameraIndex
  2013. * @return {Promise<THREE.Camera>}
  2014. */
  2015. loadCamera( cameraIndex ) {
  2016. let camera;
  2017. const cameraDef = this.json.cameras[ cameraIndex ];
  2018. const params = cameraDef[ cameraDef.type ];
  2019. if ( ! params ) {
  2020. console.warn( 'THREE.GLTFLoader: Missing camera parameters.' );
  2021. return;
  2022. }
  2023. if ( cameraDef.type === 'perspective' ) {
  2024. camera = new THREE.PerspectiveCamera( THREE.MathUtils.radToDeg( params.yfov ), params.aspectRatio || 1, params.znear || 1, params.zfar || 2e6 );
  2025. } else if ( cameraDef.type === 'orthographic' ) {
  2026. camera = new THREE.OrthographicCamera( - params.xmag, params.xmag, params.ymag, - params.ymag, params.znear, params.zfar );
  2027. }
  2028. if ( cameraDef.name ) camera.name = this.createUniqueName( cameraDef.name );
  2029. assignExtrasToUserData( camera, cameraDef );
  2030. return Promise.resolve( camera );
  2031. }
  2032. /**
  2033. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#skins
  2034. * @param {number} skinIndex
  2035. * @return {Promise<Object>}
  2036. */
  2037. loadSkin( skinIndex ) {
  2038. const skinDef = this.json.skins[ skinIndex ];
  2039. const skinEntry = {
  2040. joints: skinDef.joints
  2041. };
  2042. if ( skinDef.inverseBindMatrices === undefined ) {
  2043. return Promise.resolve( skinEntry );
  2044. }
  2045. return this.getDependency( 'accessor', skinDef.inverseBindMatrices ).then( function ( accessor ) {
  2046. skinEntry.inverseBindMatrices = accessor;
  2047. return skinEntry;
  2048. } );
  2049. }
  2050. /**
  2051. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#animations
  2052. * @param {number} animationIndex
  2053. * @return {Promise<AnimationClip>}
  2054. */
  2055. loadAnimation( animationIndex ) {
  2056. const json = this.json;
  2057. const animationDef = json.animations[ animationIndex ];
  2058. const pendingNodes = [];
  2059. const pendingInputAccessors = [];
  2060. const pendingOutputAccessors = [];
  2061. const pendingSamplers = [];
  2062. const pendingTargets = [];
  2063. for ( let i = 0, il = animationDef.channels.length; i < il; i ++ ) {
  2064. const channel = animationDef.channels[ i ];
  2065. const sampler = animationDef.samplers[ channel.sampler ];
  2066. const target = channel.target;
  2067. const name = target.node !== undefined ? target.node : target.id; // NOTE: target.id is deprecated.
  2068. const input = animationDef.parameters !== undefined ? animationDef.parameters[ sampler.input ] : sampler.input;
  2069. const output = animationDef.parameters !== undefined ? animationDef.parameters[ sampler.output ] : sampler.output;
  2070. pendingNodes.push( this.getDependency( 'node', name ) );
  2071. pendingInputAccessors.push( this.getDependency( 'accessor', input ) );
  2072. pendingOutputAccessors.push( this.getDependency( 'accessor', output ) );
  2073. pendingSamplers.push( sampler );
  2074. pendingTargets.push( target );
  2075. }
  2076. return Promise.all( [ Promise.all( pendingNodes ), Promise.all( pendingInputAccessors ), Promise.all( pendingOutputAccessors ), Promise.all( pendingSamplers ), Promise.all( pendingTargets ) ] ).then( function ( dependencies ) {
  2077. const nodes = dependencies[ 0 ];
  2078. const inputAccessors = dependencies[ 1 ];
  2079. const outputAccessors = dependencies[ 2 ];
  2080. const samplers = dependencies[ 3 ];
  2081. const targets = dependencies[ 4 ];
  2082. const tracks = [];
  2083. for ( let i = 0, il = nodes.length; i < il; i ++ ) {
  2084. const node = nodes[ i ];
  2085. const inputAccessor = inputAccessors[ i ];
  2086. const outputAccessor = outputAccessors[ i ];
  2087. const sampler = samplers[ i ];
  2088. const target = targets[ i ];
  2089. if ( node === undefined ) continue;
  2090. node.updateMatrix();
  2091. node.matrixAutoUpdate = true;
  2092. let TypedKeyframeTrack;
  2093. switch ( PATH_PROPERTIES[ target.path ] ) {
  2094. case PATH_PROPERTIES.weights:
  2095. TypedKeyframeTrack = THREE.NumberKeyframeTrack;
  2096. break;
  2097. case PATH_PROPERTIES.rotation:
  2098. TypedKeyframeTrack = THREE.QuaternionKeyframeTrack;
  2099. break;
  2100. case PATH_PROPERTIES.position:
  2101. case PATH_PROPERTIES.scale:
  2102. default:
  2103. TypedKeyframeTrack = THREE.VectorKeyframeTrack;
  2104. break;
  2105. }
  2106. const targetName = node.name ? node.name : node.uuid;
  2107. const interpolation = sampler.interpolation !== undefined ? INTERPOLATION[ sampler.interpolation ] : THREE.InterpolateLinear;
  2108. const targetNames = [];
  2109. if ( PATH_PROPERTIES[ target.path ] === PATH_PROPERTIES.weights ) {
  2110. // Node may be a THREE.Group (glTF mesh with several primitives) or a THREE.Mesh.
  2111. node.traverse( function ( object ) {
  2112. if ( object.isMesh === true && object.morphTargetInfluences ) {
  2113. targetNames.push( object.name ? object.name : object.uuid );
  2114. }
  2115. } );
  2116. } else {
  2117. targetNames.push( targetName );
  2118. }
  2119. let outputArray = outputAccessor.array;
  2120. if ( outputAccessor.normalized ) {
  2121. const scale = getNormalizedComponentScale( outputArray.constructor );
  2122. const scaled = new Float32Array( outputArray.length );
  2123. for ( let j = 0, jl = outputArray.length; j < jl; j ++ ) {
  2124. scaled[ j ] = outputArray[ j ] * scale;
  2125. }
  2126. outputArray = scaled;
  2127. }
  2128. for ( let j = 0, jl = targetNames.length; j < jl; j ++ ) {
  2129. const track = new TypedKeyframeTrack( targetNames[ j ] + '.' + PATH_PROPERTIES[ target.path ], inputAccessor.array, outputArray, interpolation ); // Override interpolation with custom factory method.
  2130. if ( sampler.interpolation === 'CUBICSPLINE' ) {
  2131. track.createInterpolant = function InterpolantFactoryMethodGLTFCubicSpline( result ) {
  2132. // A CUBICSPLINE keyframe in glTF has three output values for each input value,
  2133. // representing inTangent, splineVertex, and outTangent. As a result, track.getValueSize()
  2134. // must be divided by three to get the interpolant's sampleSize argument.
  2135. const interpolantType = this instanceof THREE.QuaternionKeyframeTrack ? GLTFCubicSplineQuaternionInterpolant : GLTFCubicSplineInterpolant;
  2136. return new interpolantType( this.times, this.values, this.getValueSize() / 3, result );
  2137. }; // Mark as CUBICSPLINE. `track.getInterpolation()` doesn't support custom interpolants.
  2138. track.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline = true;
  2139. }
  2140. tracks.push( track );
  2141. }
  2142. }
  2143. const name = animationDef.name ? animationDef.name : 'animation_' + animationIndex;
  2144. return new THREE.AnimationClip( name, undefined, tracks );
  2145. } );
  2146. }
  2147. createNodeMesh( nodeIndex ) {
  2148. const json = this.json;
  2149. const parser = this;
  2150. const nodeDef = json.nodes[ nodeIndex ];
  2151. if ( nodeDef.mesh === undefined ) return null;
  2152. return parser.getDependency( 'mesh', nodeDef.mesh ).then( function ( mesh ) {
  2153. const node = parser._getNodeRef( parser.meshCache, nodeDef.mesh, mesh ); // if weights are provided on the node, override weights on the mesh.
  2154. if ( nodeDef.weights !== undefined ) {
  2155. node.traverse( function ( o ) {
  2156. if ( ! o.isMesh ) return;
  2157. for ( let i = 0, il = nodeDef.weights.length; i < il; i ++ ) {
  2158. o.morphTargetInfluences[ i ] = nodeDef.weights[ i ];
  2159. }
  2160. } );
  2161. }
  2162. return node;
  2163. } );
  2164. }
  2165. /**
  2166. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#nodes-and-hierarchy
  2167. * @param {number} nodeIndex
  2168. * @return {Promise<Object3D>}
  2169. */
  2170. loadNode( nodeIndex ) {
  2171. const json = this.json;
  2172. const extensions = this.extensions;
  2173. const parser = this;
  2174. const nodeDef = json.nodes[ nodeIndex ]; // reserve node's name before its dependencies, so the root has the intended name.
  2175. const nodeName = nodeDef.name ? parser.createUniqueName( nodeDef.name ) : '';
  2176. return function () {
  2177. const pending = [];
  2178. const meshPromise = parser._invokeOne( function ( ext ) {
  2179. return ext.createNodeMesh && ext.createNodeMesh( nodeIndex );
  2180. } );
  2181. if ( meshPromise ) {
  2182. pending.push( meshPromise );
  2183. }
  2184. if ( nodeDef.camera !== undefined ) {
  2185. pending.push( parser.getDependency( 'camera', nodeDef.camera ).then( function ( camera ) {
  2186. return parser._getNodeRef( parser.cameraCache, nodeDef.camera, camera );
  2187. } ) );
  2188. }
  2189. parser._invokeAll( function ( ext ) {
  2190. return ext.createNodeAttachment && ext.createNodeAttachment( nodeIndex );
  2191. } ).forEach( function ( promise ) {
  2192. pending.push( promise );
  2193. } );
  2194. return Promise.all( pending );
  2195. }().then( function ( objects ) {
  2196. let node; // .isBone isn't in glTF spec. See ._markDefs
  2197. if ( nodeDef.isBone === true ) {
  2198. node = new THREE.Bone();
  2199. } else if ( objects.length > 1 ) {
  2200. node = new THREE.Group();
  2201. } else if ( objects.length === 1 ) {
  2202. node = objects[ 0 ];
  2203. } else {
  2204. node = new THREE.Object3D();
  2205. }
  2206. if ( node !== objects[ 0 ] ) {
  2207. for ( let i = 0, il = objects.length; i < il; i ++ ) {
  2208. node.add( objects[ i ] );
  2209. }
  2210. }
  2211. if ( nodeDef.name ) {
  2212. node.userData.name = nodeDef.name;
  2213. node.name = nodeName;
  2214. }
  2215. assignExtrasToUserData( node, nodeDef );
  2216. if ( nodeDef.extensions ) addUnknownExtensionsToUserData( extensions, node, nodeDef );
  2217. if ( nodeDef.matrix !== undefined ) {
  2218. const matrix = new THREE.Matrix4();
  2219. matrix.fromArray( nodeDef.matrix );
  2220. node.applyMatrix4( matrix );
  2221. } else {
  2222. if ( nodeDef.translation !== undefined ) {
  2223. node.position.fromArray( nodeDef.translation );
  2224. }
  2225. if ( nodeDef.rotation !== undefined ) {
  2226. node.quaternion.fromArray( nodeDef.rotation );
  2227. }
  2228. if ( nodeDef.scale !== undefined ) {
  2229. node.scale.fromArray( nodeDef.scale );
  2230. }
  2231. }
  2232. if ( ! parser.associations.has( node ) ) {
  2233. parser.associations.set( node, {} );
  2234. }
  2235. parser.associations.get( node ).nodes = nodeIndex;
  2236. return node;
  2237. } );
  2238. }
  2239. /**
  2240. * Specification: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#scenes
  2241. * @param {number} sceneIndex
  2242. * @return {Promise<Group>}
  2243. */
  2244. loadScene( sceneIndex ) {
  2245. const json = this.json;
  2246. const extensions = this.extensions;
  2247. const sceneDef = this.json.scenes[ sceneIndex ];
  2248. const parser = this; // THREE.Loader returns THREE.Group, not Scene.
  2249. // See: https://github.com/mrdoob/three.js/issues/18342#issuecomment-578981172
  2250. const scene = new THREE.Group();
  2251. if ( sceneDef.name ) scene.name = parser.createUniqueName( sceneDef.name );
  2252. assignExtrasToUserData( scene, sceneDef );
  2253. if ( sceneDef.extensions ) addUnknownExtensionsToUserData( extensions, scene, sceneDef );
  2254. const nodeIds = sceneDef.nodes || [];
  2255. const pending = [];
  2256. for ( let i = 0, il = nodeIds.length; i < il; i ++ ) {
  2257. pending.push( buildNodeHierarchy( nodeIds[ i ], scene, json, parser ) );
  2258. }
  2259. return Promise.all( pending ).then( function () {
  2260. // Removes dangling associations, associations that reference a node that
  2261. // didn't make it into the scene.
  2262. const reduceAssociations = node => {
  2263. const reducedAssociations = new Map();
  2264. for ( const [ key, value ] of parser.associations ) {
  2265. if ( key instanceof THREE.Material || key instanceof THREE.Texture ) {
  2266. reducedAssociations.set( key, value );
  2267. }
  2268. }
  2269. node.traverse( node => {
  2270. const mappings = parser.associations.get( node );
  2271. if ( mappings != null ) {
  2272. reducedAssociations.set( node, mappings );
  2273. }
  2274. } );
  2275. return reducedAssociations;
  2276. };
  2277. parser.associations = reduceAssociations( scene );
  2278. return scene;
  2279. } );
  2280. }
  2281. }
  2282. function buildNodeHierarchy( nodeId, parentObject, json, parser ) {
  2283. const nodeDef = json.nodes[ nodeId ];
  2284. return parser.getDependency( 'node', nodeId ).then( function ( node ) {
  2285. if ( nodeDef.skin === undefined ) return node; // build skeleton here as well
  2286. let skinEntry;
  2287. return parser.getDependency( 'skin', nodeDef.skin ).then( function ( skin ) {
  2288. skinEntry = skin;
  2289. const pendingJoints = [];
  2290. for ( let i = 0, il = skinEntry.joints.length; i < il; i ++ ) {
  2291. pendingJoints.push( parser.getDependency( 'node', skinEntry.joints[ i ] ) );
  2292. }
  2293. return Promise.all( pendingJoints );
  2294. } ).then( function ( jointNodes ) {
  2295. node.traverse( function ( mesh ) {
  2296. if ( ! mesh.isMesh ) return;
  2297. const bones = [];
  2298. const boneInverses = [];
  2299. for ( let j = 0, jl = jointNodes.length; j < jl; j ++ ) {
  2300. const jointNode = jointNodes[ j ];
  2301. if ( jointNode ) {
  2302. bones.push( jointNode );
  2303. const mat = new THREE.Matrix4();
  2304. if ( skinEntry.inverseBindMatrices !== undefined ) {
  2305. mat.fromArray( skinEntry.inverseBindMatrices.array, j * 16 );
  2306. }
  2307. boneInverses.push( mat );
  2308. } else {
  2309. console.warn( 'THREE.GLTFLoader: Joint "%s" could not be found.', skinEntry.joints[ j ] );
  2310. }
  2311. }
  2312. mesh.bind( new THREE.Skeleton( bones, boneInverses ), mesh.matrixWorld );
  2313. } );
  2314. return node;
  2315. } );
  2316. } ).then( function ( node ) {
  2317. // build node hierachy
  2318. parentObject.add( node );
  2319. const pending = [];
  2320. if ( nodeDef.children ) {
  2321. const children = nodeDef.children;
  2322. for ( let i = 0, il = children.length; i < il; i ++ ) {
  2323. const child = children[ i ];
  2324. pending.push( buildNodeHierarchy( child, node, json, parser ) );
  2325. }
  2326. }
  2327. return Promise.all( pending );
  2328. } );
  2329. }
  2330. /**
  2331. * @param {BufferGeometry} geometry
  2332. * @param {GLTF.Primitive} primitiveDef
  2333. * @param {GLTFParser} parser
  2334. */
  2335. function computeBounds( geometry, primitiveDef, parser ) {
  2336. const attributes = primitiveDef.attributes;
  2337. const box = new THREE.Box3();
  2338. if ( attributes.POSITION !== undefined ) {
  2339. const accessor = parser.json.accessors[ attributes.POSITION ];
  2340. const min = accessor.min;
  2341. const max = accessor.max; // glTF requires 'min' and 'max', but VRM (which extends glTF) currently ignores that requirement.
  2342. if ( min !== undefined && max !== undefined ) {
  2343. box.set( new THREE.Vector3( min[ 0 ], min[ 1 ], min[ 2 ] ), new THREE.Vector3( max[ 0 ], max[ 1 ], max[ 2 ] ) );
  2344. if ( accessor.normalized ) {
  2345. const boxScale = getNormalizedComponentScale( WEBGL_COMPONENT_TYPES[ accessor.componentType ] );
  2346. box.min.multiplyScalar( boxScale );
  2347. box.max.multiplyScalar( boxScale );
  2348. }
  2349. } else {
  2350. console.warn( 'THREE.GLTFLoader: Missing min/max properties for accessor POSITION.' );
  2351. return;
  2352. }
  2353. } else {
  2354. return;
  2355. }
  2356. const targets = primitiveDef.targets;
  2357. if ( targets !== undefined ) {
  2358. const maxDisplacement = new THREE.Vector3();
  2359. const vector = new THREE.Vector3();
  2360. for ( let i = 0, il = targets.length; i < il; i ++ ) {
  2361. const target = targets[ i ];
  2362. if ( target.POSITION !== undefined ) {
  2363. const accessor = parser.json.accessors[ target.POSITION ];
  2364. const min = accessor.min;
  2365. const max = accessor.max; // glTF requires 'min' and 'max', but VRM (which extends glTF) currently ignores that requirement.
  2366. if ( min !== undefined && max !== undefined ) {
  2367. // we need to get max of absolute components because target weight is [-1,1]
  2368. vector.setX( Math.max( Math.abs( min[ 0 ] ), Math.abs( max[ 0 ] ) ) );
  2369. vector.setY( Math.max( Math.abs( min[ 1 ] ), Math.abs( max[ 1 ] ) ) );
  2370. vector.setZ( Math.max( Math.abs( min[ 2 ] ), Math.abs( max[ 2 ] ) ) );
  2371. if ( accessor.normalized ) {
  2372. const boxScale = getNormalizedComponentScale( WEBGL_COMPONENT_TYPES[ accessor.componentType ] );
  2373. vector.multiplyScalar( boxScale );
  2374. } // Note: this assumes that the sum of all weights is at most 1. This isn't quite correct - it's more conservative
  2375. // to assume that each target can have a max weight of 1. However, for some use cases - notably, when morph targets
  2376. // are used to implement key-frame animations and as such only two are active at a time - this results in very large
  2377. // boxes. So for now we make a box that's sometimes a touch too small but is hopefully mostly of reasonable size.
  2378. maxDisplacement.max( vector );
  2379. } else {
  2380. console.warn( 'THREE.GLTFLoader: Missing min/max properties for accessor POSITION.' );
  2381. }
  2382. }
  2383. } // As per comment above this box isn't conservative, but has a reasonable size for a very large number of morph targets.
  2384. box.expandByVector( maxDisplacement );
  2385. }
  2386. geometry.boundingBox = box;
  2387. const sphere = new THREE.Sphere();
  2388. box.getCenter( sphere.center );
  2389. sphere.radius = box.min.distanceTo( box.max ) / 2;
  2390. geometry.boundingSphere = sphere;
  2391. }
  2392. /**
  2393. * @param {BufferGeometry} geometry
  2394. * @param {GLTF.Primitive} primitiveDef
  2395. * @param {GLTFParser} parser
  2396. * @return {Promise<BufferGeometry>}
  2397. */
  2398. function addPrimitiveAttributes( geometry, primitiveDef, parser ) {
  2399. const attributes = primitiveDef.attributes;
  2400. const pending = [];
  2401. function assignAttributeAccessor( accessorIndex, attributeName ) {
  2402. return parser.getDependency( 'accessor', accessorIndex ).then( function ( accessor ) {
  2403. geometry.setAttribute( attributeName, accessor );
  2404. } );
  2405. }
  2406. for ( const gltfAttributeName in attributes ) {
  2407. const threeAttributeName = ATTRIBUTES[ gltfAttributeName ] || gltfAttributeName.toLowerCase(); // Skip attributes already provided by e.g. Draco extension.
  2408. if ( threeAttributeName in geometry.attributes ) continue;
  2409. pending.push( assignAttributeAccessor( attributes[ gltfAttributeName ], threeAttributeName ) );
  2410. }
  2411. if ( primitiveDef.indices !== undefined && ! geometry.index ) {
  2412. const accessor = parser.getDependency( 'accessor', primitiveDef.indices ).then( function ( accessor ) {
  2413. geometry.setIndex( accessor );
  2414. } );
  2415. pending.push( accessor );
  2416. }
  2417. assignExtrasToUserData( geometry, primitiveDef );
  2418. computeBounds( geometry, primitiveDef, parser );
  2419. return Promise.all( pending ).then( function () {
  2420. return primitiveDef.targets !== undefined ? addMorphTargets( geometry, primitiveDef.targets, parser ) : geometry;
  2421. } );
  2422. }
  2423. /**
  2424. * @param {BufferGeometry} geometry
  2425. * @param {Number} drawMode
  2426. * @return {BufferGeometry}
  2427. */
  2428. function toTrianglesDrawMode( geometry, drawMode ) {
  2429. let index = geometry.getIndex(); // generate index if not present
  2430. if ( index === null ) {
  2431. const indices = [];
  2432. const position = geometry.getAttribute( 'position' );
  2433. if ( position !== undefined ) {
  2434. for ( let i = 0; i < position.count; i ++ ) {
  2435. indices.push( i );
  2436. }
  2437. geometry.setIndex( indices );
  2438. index = geometry.getIndex();
  2439. } else {
  2440. console.error( 'THREE.GLTFLoader.toTrianglesDrawMode(): Undefined position attribute. Processing not possible.' );
  2441. return geometry;
  2442. }
  2443. } //
  2444. const numberOfTriangles = index.count - 2;
  2445. const newIndices = [];
  2446. if ( drawMode === THREE.TriangleFanDrawMode ) {
  2447. // gl.TRIANGLE_FAN
  2448. for ( let i = 1; i <= numberOfTriangles; i ++ ) {
  2449. newIndices.push( index.getX( 0 ) );
  2450. newIndices.push( index.getX( i ) );
  2451. newIndices.push( index.getX( i + 1 ) );
  2452. }
  2453. } else {
  2454. // gl.TRIANGLE_STRIP
  2455. for ( let i = 0; i < numberOfTriangles; i ++ ) {
  2456. if ( i % 2 === 0 ) {
  2457. newIndices.push( index.getX( i ) );
  2458. newIndices.push( index.getX( i + 1 ) );
  2459. newIndices.push( index.getX( i + 2 ) );
  2460. } else {
  2461. newIndices.push( index.getX( i + 2 ) );
  2462. newIndices.push( index.getX( i + 1 ) );
  2463. newIndices.push( index.getX( i ) );
  2464. }
  2465. }
  2466. }
  2467. if ( newIndices.length / 3 !== numberOfTriangles ) {
  2468. console.error( 'THREE.GLTFLoader.toTrianglesDrawMode(): Unable to generate correct amount of triangles.' );
  2469. } // build final geometry
  2470. const newGeometry = geometry.clone();
  2471. newGeometry.setIndex( newIndices );
  2472. return newGeometry;
  2473. }
  2474. THREE.GLTFLoader = GLTFLoader;
  2475. } )();