GLTFLoader.js 101 KB

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