GLTFExporter.js 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647
  1. import {
  2. BufferAttribute,
  3. ClampToEdgeWrapping,
  4. DoubleSide,
  5. InterpolateDiscrete,
  6. InterpolateLinear,
  7. LinearFilter,
  8. LinearMipmapLinearFilter,
  9. LinearMipmapNearestFilter,
  10. MathUtils,
  11. Matrix4,
  12. MirroredRepeatWrapping,
  13. NearestFilter,
  14. NearestMipmapLinearFilter,
  15. NearestMipmapNearestFilter,
  16. PropertyBinding,
  17. RGBAFormat,
  18. RepeatWrapping,
  19. Scene,
  20. Source,
  21. Vector3
  22. } from 'three';
  23. class GLTFExporter {
  24. constructor() {
  25. this.pluginCallbacks = [];
  26. this.register( function ( writer ) {
  27. return new GLTFLightExtension( writer );
  28. } );
  29. this.register( function ( writer ) {
  30. return new GLTFMaterialsUnlitExtension( writer );
  31. } );
  32. this.register( function ( writer ) {
  33. return new GLTFMaterialsPBRSpecularGlossiness( writer );
  34. } );
  35. this.register( function ( writer ) {
  36. return new GLTFMaterialsTransmissionExtension( writer );
  37. } );
  38. this.register( function ( writer ) {
  39. return new GLTFMaterialsVolumeExtension( writer );
  40. } );
  41. this.register( function ( writer ) {
  42. return new GLTFMaterialsClearcoatExtension( writer );
  43. } );
  44. }
  45. register( callback ) {
  46. if ( this.pluginCallbacks.indexOf( callback ) === - 1 ) {
  47. this.pluginCallbacks.push( callback );
  48. }
  49. return this;
  50. }
  51. unregister( callback ) {
  52. if ( this.pluginCallbacks.indexOf( callback ) !== - 1 ) {
  53. this.pluginCallbacks.splice( this.pluginCallbacks.indexOf( callback ), 1 );
  54. }
  55. return this;
  56. }
  57. /**
  58. * Parse scenes and generate GLTF output
  59. * @param {Scene or [THREE.Scenes]} input Scene or Array of THREE.Scenes
  60. * @param {Function} onDone Callback on completed
  61. * @param {Function} onError Callback on errors
  62. * @param {Object} options options
  63. */
  64. parse( input, onDone, onError, options ) {
  65. if ( typeof onError === 'object' ) {
  66. console.warn( 'THREE.GLTFExporter: parse() expects options as the fourth argument now.' );
  67. options = onError;
  68. }
  69. const writer = new GLTFWriter();
  70. const plugins = [];
  71. for ( let i = 0, il = this.pluginCallbacks.length; i < il; i ++ ) {
  72. plugins.push( this.pluginCallbacks[ i ]( writer ) );
  73. }
  74. writer.setPlugins( plugins );
  75. writer.write( input, onDone, options ).catch( onError );
  76. }
  77. parseAsync( input, options ) {
  78. const scope = this;
  79. return new Promise( function ( resolve, reject ) {
  80. scope.parse( input, resolve, reject, options );
  81. } );
  82. }
  83. }
  84. //------------------------------------------------------------------------------
  85. // Constants
  86. //------------------------------------------------------------------------------
  87. const WEBGL_CONSTANTS = {
  88. POINTS: 0x0000,
  89. LINES: 0x0001,
  90. LINE_LOOP: 0x0002,
  91. LINE_STRIP: 0x0003,
  92. TRIANGLES: 0x0004,
  93. TRIANGLE_STRIP: 0x0005,
  94. TRIANGLE_FAN: 0x0006,
  95. UNSIGNED_BYTE: 0x1401,
  96. UNSIGNED_SHORT: 0x1403,
  97. FLOAT: 0x1406,
  98. UNSIGNED_INT: 0x1405,
  99. ARRAY_BUFFER: 0x8892,
  100. ELEMENT_ARRAY_BUFFER: 0x8893,
  101. NEAREST: 0x2600,
  102. LINEAR: 0x2601,
  103. NEAREST_MIPMAP_NEAREST: 0x2700,
  104. LINEAR_MIPMAP_NEAREST: 0x2701,
  105. NEAREST_MIPMAP_LINEAR: 0x2702,
  106. LINEAR_MIPMAP_LINEAR: 0x2703,
  107. CLAMP_TO_EDGE: 33071,
  108. MIRRORED_REPEAT: 33648,
  109. REPEAT: 10497
  110. };
  111. const THREE_TO_WEBGL = {};
  112. THREE_TO_WEBGL[ NearestFilter ] = WEBGL_CONSTANTS.NEAREST;
  113. THREE_TO_WEBGL[ NearestMipmapNearestFilter ] = WEBGL_CONSTANTS.NEAREST_MIPMAP_NEAREST;
  114. THREE_TO_WEBGL[ NearestMipmapLinearFilter ] = WEBGL_CONSTANTS.NEAREST_MIPMAP_LINEAR;
  115. THREE_TO_WEBGL[ LinearFilter ] = WEBGL_CONSTANTS.LINEAR;
  116. THREE_TO_WEBGL[ LinearMipmapNearestFilter ] = WEBGL_CONSTANTS.LINEAR_MIPMAP_NEAREST;
  117. THREE_TO_WEBGL[ LinearMipmapLinearFilter ] = WEBGL_CONSTANTS.LINEAR_MIPMAP_LINEAR;
  118. THREE_TO_WEBGL[ ClampToEdgeWrapping ] = WEBGL_CONSTANTS.CLAMP_TO_EDGE;
  119. THREE_TO_WEBGL[ RepeatWrapping ] = WEBGL_CONSTANTS.REPEAT;
  120. THREE_TO_WEBGL[ MirroredRepeatWrapping ] = WEBGL_CONSTANTS.MIRRORED_REPEAT;
  121. const PATH_PROPERTIES = {
  122. scale: 'scale',
  123. position: 'translation',
  124. quaternion: 'rotation',
  125. morphTargetInfluences: 'weights'
  126. };
  127. // GLB constants
  128. // https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#glb-file-format-specification
  129. const GLB_HEADER_BYTES = 12;
  130. const GLB_HEADER_MAGIC = 0x46546C67;
  131. const GLB_VERSION = 2;
  132. const GLB_CHUNK_PREFIX_BYTES = 8;
  133. const GLB_CHUNK_TYPE_JSON = 0x4E4F534A;
  134. const GLB_CHUNK_TYPE_BIN = 0x004E4942;
  135. //------------------------------------------------------------------------------
  136. // Utility functions
  137. //------------------------------------------------------------------------------
  138. /**
  139. * Compare two arrays
  140. * @param {Array} array1 Array 1 to compare
  141. * @param {Array} array2 Array 2 to compare
  142. * @return {Boolean} Returns true if both arrays are equal
  143. */
  144. function equalArray( array1, array2 ) {
  145. return ( array1.length === array2.length ) && array1.every( function ( element, index ) {
  146. return element === array2[ index ];
  147. } );
  148. }
  149. /**
  150. * Converts a string to an ArrayBuffer.
  151. * @param {string} text
  152. * @return {ArrayBuffer}
  153. */
  154. function stringToArrayBuffer( text ) {
  155. if ( window.TextEncoder !== undefined ) {
  156. return new TextEncoder().encode( text ).buffer;
  157. }
  158. const array = new Uint8Array( new ArrayBuffer( text.length ) );
  159. for ( let i = 0, il = text.length; i < il; i ++ ) {
  160. const value = text.charCodeAt( i );
  161. // Replacing multi-byte character with space(0x20).
  162. array[ i ] = value > 0xFF ? 0x20 : value;
  163. }
  164. return array.buffer;
  165. }
  166. /**
  167. * Is identity matrix
  168. *
  169. * @param {Matrix4} matrix
  170. * @returns {Boolean} Returns true, if parameter is identity matrix
  171. */
  172. function isIdentityMatrix( matrix ) {
  173. return equalArray( matrix.elements, [ 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 ] );
  174. }
  175. /**
  176. * Get the min and max vectors from the given attribute
  177. * @param {BufferAttribute} attribute Attribute to find the min/max in range from start to start + count
  178. * @param {Integer} start
  179. * @param {Integer} count
  180. * @return {Object} Object containing the `min` and `max` values (As an array of attribute.itemSize components)
  181. */
  182. function getMinMax( attribute, start, count ) {
  183. const output = {
  184. min: new Array( attribute.itemSize ).fill( Number.POSITIVE_INFINITY ),
  185. max: new Array( attribute.itemSize ).fill( Number.NEGATIVE_INFINITY )
  186. };
  187. for ( let i = start; i < start + count; i ++ ) {
  188. for ( let a = 0; a < attribute.itemSize; a ++ ) {
  189. let value;
  190. if ( attribute.itemSize > 4 ) {
  191. // no support for interleaved data for itemSize > 4
  192. value = attribute.array[ i * attribute.itemSize + a ];
  193. } else {
  194. if ( a === 0 ) value = attribute.getX( i );
  195. else if ( a === 1 ) value = attribute.getY( i );
  196. else if ( a === 2 ) value = attribute.getZ( i );
  197. else if ( a === 3 ) value = attribute.getW( i );
  198. }
  199. output.min[ a ] = Math.min( output.min[ a ], value );
  200. output.max[ a ] = Math.max( output.max[ a ], value );
  201. }
  202. }
  203. return output;
  204. }
  205. /**
  206. * Get the required size + padding for a buffer, rounded to the next 4-byte boundary.
  207. * https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#data-alignment
  208. *
  209. * @param {Integer} bufferSize The size the original buffer.
  210. * @returns {Integer} new buffer size with required padding.
  211. *
  212. */
  213. function getPaddedBufferSize( bufferSize ) {
  214. return Math.ceil( bufferSize / 4 ) * 4;
  215. }
  216. /**
  217. * Returns a buffer aligned to 4-byte boundary.
  218. *
  219. * @param {ArrayBuffer} arrayBuffer Buffer to pad
  220. * @param {Integer} paddingByte (Optional)
  221. * @returns {ArrayBuffer} The same buffer if it's already aligned to 4-byte boundary or a new buffer
  222. */
  223. function getPaddedArrayBuffer( arrayBuffer, paddingByte = 0 ) {
  224. const paddedLength = getPaddedBufferSize( arrayBuffer.byteLength );
  225. if ( paddedLength !== arrayBuffer.byteLength ) {
  226. const array = new Uint8Array( paddedLength );
  227. array.set( new Uint8Array( arrayBuffer ) );
  228. if ( paddingByte !== 0 ) {
  229. for ( let i = arrayBuffer.byteLength; i < paddedLength; i ++ ) {
  230. array[ i ] = paddingByte;
  231. }
  232. }
  233. return array.buffer;
  234. }
  235. return arrayBuffer;
  236. }
  237. let cachedCanvas = null;
  238. /**
  239. * Writer
  240. */
  241. class GLTFWriter {
  242. constructor() {
  243. this.plugins = [];
  244. this.options = {};
  245. this.pending = [];
  246. this.buffers = [];
  247. this.byteOffset = 0;
  248. this.buffers = [];
  249. this.nodeMap = new Map();
  250. this.skins = [];
  251. this.extensionsUsed = {};
  252. this.uids = new Map();
  253. this.uid = 0;
  254. this.json = {
  255. asset: {
  256. version: '2.0',
  257. generator: 'THREE.GLTFExporter'
  258. }
  259. };
  260. this.cache = {
  261. meshes: new Map(),
  262. attributes: new Map(),
  263. attributesNormalized: new Map(),
  264. materials: new Map(),
  265. textures: new Map(),
  266. images: new Map()
  267. };
  268. }
  269. setPlugins( plugins ) {
  270. this.plugins = plugins;
  271. }
  272. /**
  273. * Parse scenes and generate GLTF output
  274. * @param {Scene or [THREE.Scenes]} input Scene or Array of THREE.Scenes
  275. * @param {Function} onDone Callback on completed
  276. * @param {Object} options options
  277. */
  278. async write( input, onDone, options ) {
  279. this.options = Object.assign( {}, {
  280. // default options
  281. binary: false,
  282. trs: false,
  283. onlyVisible: true,
  284. truncateDrawRange: true,
  285. embedImages: true,
  286. maxTextureSize: Infinity,
  287. animations: [],
  288. includeCustomExtensions: false
  289. }, options );
  290. if ( this.options.animations.length > 0 ) {
  291. // Only TRS properties, and not matrices, may be targeted by animation.
  292. this.options.trs = true;
  293. }
  294. this.processInput( input );
  295. await Promise.all( this.pending );
  296. const writer = this;
  297. const buffers = writer.buffers;
  298. const json = writer.json;
  299. options = writer.options;
  300. const extensionsUsed = writer.extensionsUsed;
  301. // Merge buffers.
  302. const blob = new Blob( buffers, { type: 'application/octet-stream' } );
  303. // Declare extensions.
  304. const extensionsUsedList = Object.keys( extensionsUsed );
  305. if ( extensionsUsedList.length > 0 ) json.extensionsUsed = extensionsUsedList;
  306. // Update bytelength of the single buffer.
  307. if ( json.buffers && json.buffers.length > 0 ) json.buffers[ 0 ].byteLength = blob.size;
  308. if ( options.binary === true ) {
  309. // https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md#glb-file-format-specification
  310. const reader = new window.FileReader();
  311. reader.readAsArrayBuffer( blob );
  312. reader.onloadend = function () {
  313. // Binary chunk.
  314. const binaryChunk = getPaddedArrayBuffer( reader.result );
  315. const binaryChunkPrefix = new DataView( new ArrayBuffer( GLB_CHUNK_PREFIX_BYTES ) );
  316. binaryChunkPrefix.setUint32( 0, binaryChunk.byteLength, true );
  317. binaryChunkPrefix.setUint32( 4, GLB_CHUNK_TYPE_BIN, true );
  318. // JSON chunk.
  319. const jsonChunk = getPaddedArrayBuffer( stringToArrayBuffer( JSON.stringify( json ) ), 0x20 );
  320. const jsonChunkPrefix = new DataView( new ArrayBuffer( GLB_CHUNK_PREFIX_BYTES ) );
  321. jsonChunkPrefix.setUint32( 0, jsonChunk.byteLength, true );
  322. jsonChunkPrefix.setUint32( 4, GLB_CHUNK_TYPE_JSON, true );
  323. // GLB header.
  324. const header = new ArrayBuffer( GLB_HEADER_BYTES );
  325. const headerView = new DataView( header );
  326. headerView.setUint32( 0, GLB_HEADER_MAGIC, true );
  327. headerView.setUint32( 4, GLB_VERSION, true );
  328. const totalByteLength = GLB_HEADER_BYTES
  329. + jsonChunkPrefix.byteLength + jsonChunk.byteLength
  330. + binaryChunkPrefix.byteLength + binaryChunk.byteLength;
  331. headerView.setUint32( 8, totalByteLength, true );
  332. const glbBlob = new Blob( [
  333. header,
  334. jsonChunkPrefix,
  335. jsonChunk,
  336. binaryChunkPrefix,
  337. binaryChunk
  338. ], { type: 'application/octet-stream' } );
  339. const glbReader = new window.FileReader();
  340. glbReader.readAsArrayBuffer( glbBlob );
  341. glbReader.onloadend = function () {
  342. onDone( glbReader.result );
  343. };
  344. };
  345. } else {
  346. if ( json.buffers && json.buffers.length > 0 ) {
  347. const reader = new window.FileReader();
  348. reader.readAsDataURL( blob );
  349. reader.onloadend = function () {
  350. const base64data = reader.result;
  351. json.buffers[ 0 ].uri = base64data;
  352. onDone( json );
  353. };
  354. } else {
  355. onDone( json );
  356. }
  357. }
  358. }
  359. /**
  360. * Serializes a userData.
  361. *
  362. * @param {THREE.Object3D|THREE.Material} object
  363. * @param {Object} objectDef
  364. */
  365. serializeUserData( object, objectDef ) {
  366. if ( Object.keys( object.userData ).length === 0 ) return;
  367. const options = this.options;
  368. const extensionsUsed = this.extensionsUsed;
  369. try {
  370. const json = JSON.parse( JSON.stringify( object.userData ) );
  371. if ( options.includeCustomExtensions && json.gltfExtensions ) {
  372. if ( objectDef.extensions === undefined ) objectDef.extensions = {};
  373. for ( const extensionName in json.gltfExtensions ) {
  374. objectDef.extensions[ extensionName ] = json.gltfExtensions[ extensionName ];
  375. extensionsUsed[ extensionName ] = true;
  376. }
  377. delete json.gltfExtensions;
  378. }
  379. if ( Object.keys( json ).length > 0 ) objectDef.extras = json;
  380. } catch ( error ) {
  381. console.warn( 'THREE.GLTFExporter: userData of \'' + object.name + '\' ' +
  382. 'won\'t be serialized because of JSON.stringify error - ' + error.message );
  383. }
  384. }
  385. /**
  386. * Assign and return a temporal unique id for an object
  387. * especially which doesn't have .uuid
  388. * @param {Object} object
  389. * @return {Integer}
  390. */
  391. getUID( object ) {
  392. if ( ! this.uids.has( object ) ) this.uids.set( object, this.uid ++ );
  393. return this.uids.get( object );
  394. }
  395. /**
  396. * Checks if normal attribute values are normalized.
  397. *
  398. * @param {BufferAttribute} normal
  399. * @returns {Boolean}
  400. */
  401. isNormalizedNormalAttribute( normal ) {
  402. const cache = this.cache;
  403. if ( cache.attributesNormalized.has( normal ) ) return false;
  404. const v = new Vector3();
  405. for ( let i = 0, il = normal.count; i < il; i ++ ) {
  406. // 0.0005 is from glTF-validator
  407. if ( Math.abs( v.fromBufferAttribute( normal, i ).length() - 1.0 ) > 0.0005 ) return false;
  408. }
  409. return true;
  410. }
  411. /**
  412. * Creates normalized normal buffer attribute.
  413. *
  414. * @param {BufferAttribute} normal
  415. * @returns {BufferAttribute}
  416. *
  417. */
  418. createNormalizedNormalAttribute( normal ) {
  419. const cache = this.cache;
  420. if ( cache.attributesNormalized.has( normal ) ) return cache.attributesNormalized.get( normal );
  421. const attribute = normal.clone();
  422. const v = new Vector3();
  423. for ( let i = 0, il = attribute.count; i < il; i ++ ) {
  424. v.fromBufferAttribute( attribute, i );
  425. if ( v.x === 0 && v.y === 0 && v.z === 0 ) {
  426. // if values can't be normalized set (1, 0, 0)
  427. v.setX( 1.0 );
  428. } else {
  429. v.normalize();
  430. }
  431. attribute.setXYZ( i, v.x, v.y, v.z );
  432. }
  433. cache.attributesNormalized.set( normal, attribute );
  434. return attribute;
  435. }
  436. /**
  437. * Applies a texture transform, if present, to the map definition. Requires
  438. * the KHR_texture_transform extension.
  439. *
  440. * @param {Object} mapDef
  441. * @param {THREE.Texture} texture
  442. */
  443. applyTextureTransform( mapDef, texture ) {
  444. let didTransform = false;
  445. const transformDef = {};
  446. if ( texture.offset.x !== 0 || texture.offset.y !== 0 ) {
  447. transformDef.offset = texture.offset.toArray();
  448. didTransform = true;
  449. }
  450. if ( texture.rotation !== 0 ) {
  451. transformDef.rotation = texture.rotation;
  452. didTransform = true;
  453. }
  454. if ( texture.repeat.x !== 1 || texture.repeat.y !== 1 ) {
  455. transformDef.scale = texture.repeat.toArray();
  456. didTransform = true;
  457. }
  458. if ( didTransform ) {
  459. mapDef.extensions = mapDef.extensions || {};
  460. mapDef.extensions[ 'KHR_texture_transform' ] = transformDef;
  461. this.extensionsUsed[ 'KHR_texture_transform' ] = true;
  462. }
  463. }
  464. buildMetalRoughTexture( metalnessMap, roughnessMap ) {
  465. if ( metalnessMap === roughnessMap ) return metalnessMap;
  466. console.warn( 'THREE.GLTFExporter: Merged metalnessMap and roughnessMap textures.' );
  467. const metalness = metalnessMap?.image;
  468. const roughness = roughnessMap?.image;
  469. const width = Math.max( metalness?.width || 0, roughness?.width || 0 );
  470. const height = Math.max( metalness?.height || 0, roughness?.height || 0 );
  471. const canvas = document.createElement( 'canvas' );
  472. canvas.width = width;
  473. canvas.height = height;
  474. const context = canvas.getContext( '2d' );
  475. context.fillStyle = '#00ffff';
  476. context.fillRect( 0, 0, width, height );
  477. const composite = context.getImageData( 0, 0, width, height );
  478. if ( metalness ) {
  479. context.drawImage( metalness, 0, 0, width, height );
  480. const data = context.getImageData( 0, 0, width, height ).data;
  481. for ( let i = 2; i < data.length; i += 4 ) {
  482. composite.data[ i ] = data[ i ];
  483. }
  484. }
  485. if ( roughness ) {
  486. context.drawImage( roughness, 0, 0, width, height );
  487. const data = context.getImageData( 0, 0, width, height ).data;
  488. for ( let i = 1; i < data.length; i += 4 ) {
  489. composite.data[ i ] = data[ i ];
  490. }
  491. }
  492. context.putImageData( composite, 0, 0 );
  493. //
  494. const reference = metalnessMap || roughnessMap;
  495. const texture = reference.clone();
  496. texture.source = new Source( canvas );
  497. return texture;
  498. }
  499. /**
  500. * Process a buffer to append to the default one.
  501. * @param {ArrayBuffer} buffer
  502. * @return {Integer}
  503. */
  504. processBuffer( buffer ) {
  505. const json = this.json;
  506. const buffers = this.buffers;
  507. if ( ! json.buffers ) json.buffers = [ { byteLength: 0 } ];
  508. // All buffers are merged before export.
  509. buffers.push( buffer );
  510. return 0;
  511. }
  512. /**
  513. * Process and generate a BufferView
  514. * @param {BufferAttribute} attribute
  515. * @param {number} componentType
  516. * @param {number} start
  517. * @param {number} count
  518. * @param {number} target (Optional) Target usage of the BufferView
  519. * @return {Object}
  520. */
  521. processBufferView( attribute, componentType, start, count, target ) {
  522. const json = this.json;
  523. if ( ! json.bufferViews ) json.bufferViews = [];
  524. // Create a new dataview and dump the attribute's array into it
  525. let componentSize;
  526. if ( componentType === WEBGL_CONSTANTS.UNSIGNED_BYTE ) {
  527. componentSize = 1;
  528. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_SHORT ) {
  529. componentSize = 2;
  530. } else {
  531. componentSize = 4;
  532. }
  533. const byteLength = getPaddedBufferSize( count * attribute.itemSize * componentSize );
  534. const dataView = new DataView( new ArrayBuffer( byteLength ) );
  535. let offset = 0;
  536. for ( let i = start; i < start + count; i ++ ) {
  537. for ( let a = 0; a < attribute.itemSize; a ++ ) {
  538. let value;
  539. if ( attribute.itemSize > 4 ) {
  540. // no support for interleaved data for itemSize > 4
  541. value = attribute.array[ i * attribute.itemSize + a ];
  542. } else {
  543. if ( a === 0 ) value = attribute.getX( i );
  544. else if ( a === 1 ) value = attribute.getY( i );
  545. else if ( a === 2 ) value = attribute.getZ( i );
  546. else if ( a === 3 ) value = attribute.getW( i );
  547. }
  548. if ( componentType === WEBGL_CONSTANTS.FLOAT ) {
  549. dataView.setFloat32( offset, value, true );
  550. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_INT ) {
  551. dataView.setUint32( offset, value, true );
  552. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_SHORT ) {
  553. dataView.setUint16( offset, value, true );
  554. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_BYTE ) {
  555. dataView.setUint8( offset, value );
  556. }
  557. offset += componentSize;
  558. }
  559. }
  560. const bufferViewDef = {
  561. buffer: this.processBuffer( dataView.buffer ),
  562. byteOffset: this.byteOffset,
  563. byteLength: byteLength
  564. };
  565. if ( target !== undefined ) bufferViewDef.target = target;
  566. if ( target === WEBGL_CONSTANTS.ARRAY_BUFFER ) {
  567. // Only define byteStride for vertex attributes.
  568. bufferViewDef.byteStride = attribute.itemSize * componentSize;
  569. }
  570. this.byteOffset += byteLength;
  571. json.bufferViews.push( bufferViewDef );
  572. // @TODO Merge bufferViews where possible.
  573. const output = {
  574. id: json.bufferViews.length - 1,
  575. byteLength: 0
  576. };
  577. return output;
  578. }
  579. /**
  580. * Process and generate a BufferView from an image Blob.
  581. * @param {Blob} blob
  582. * @return {Promise<Integer>}
  583. */
  584. processBufferViewImage( blob ) {
  585. const writer = this;
  586. const json = writer.json;
  587. if ( ! json.bufferViews ) json.bufferViews = [];
  588. return new Promise( function ( resolve ) {
  589. const reader = new window.FileReader();
  590. reader.readAsArrayBuffer( blob );
  591. reader.onloadend = function () {
  592. const buffer = getPaddedArrayBuffer( reader.result );
  593. const bufferViewDef = {
  594. buffer: writer.processBuffer( buffer ),
  595. byteOffset: writer.byteOffset,
  596. byteLength: buffer.byteLength
  597. };
  598. writer.byteOffset += buffer.byteLength;
  599. resolve( json.bufferViews.push( bufferViewDef ) - 1 );
  600. };
  601. } );
  602. }
  603. /**
  604. * Process attribute to generate an accessor
  605. * @param {BufferAttribute} attribute Attribute to process
  606. * @param {THREE.BufferGeometry} geometry (Optional) Geometry used for truncated draw range
  607. * @param {Integer} start (Optional)
  608. * @param {Integer} count (Optional)
  609. * @return {Integer|null} Index of the processed accessor on the "accessors" array
  610. */
  611. processAccessor( attribute, geometry, start, count ) {
  612. const options = this.options;
  613. const json = this.json;
  614. const types = {
  615. 1: 'SCALAR',
  616. 2: 'VEC2',
  617. 3: 'VEC3',
  618. 4: 'VEC4',
  619. 16: 'MAT4'
  620. };
  621. let componentType;
  622. // Detect the component type of the attribute array (float, uint or ushort)
  623. if ( attribute.array.constructor === Float32Array ) {
  624. componentType = WEBGL_CONSTANTS.FLOAT;
  625. } else if ( attribute.array.constructor === Uint32Array ) {
  626. componentType = WEBGL_CONSTANTS.UNSIGNED_INT;
  627. } else if ( attribute.array.constructor === Uint16Array ) {
  628. componentType = WEBGL_CONSTANTS.UNSIGNED_SHORT;
  629. } else if ( attribute.array.constructor === Uint8Array ) {
  630. componentType = WEBGL_CONSTANTS.UNSIGNED_BYTE;
  631. } else {
  632. throw new Error( 'THREE.GLTFExporter: Unsupported bufferAttribute component type.' );
  633. }
  634. if ( start === undefined ) start = 0;
  635. if ( count === undefined ) count = attribute.count;
  636. // @TODO Indexed buffer geometry with drawRange not supported yet
  637. if ( options.truncateDrawRange && geometry !== undefined && geometry.index === null ) {
  638. const end = start + count;
  639. const end2 = geometry.drawRange.count === Infinity
  640. ? attribute.count
  641. : geometry.drawRange.start + geometry.drawRange.count;
  642. start = Math.max( start, geometry.drawRange.start );
  643. count = Math.min( end, end2 ) - start;
  644. if ( count < 0 ) count = 0;
  645. }
  646. // Skip creating an accessor if the attribute doesn't have data to export
  647. if ( count === 0 ) return null;
  648. const minMax = getMinMax( attribute, start, count );
  649. let bufferViewTarget;
  650. // If geometry isn't provided, don't infer the target usage of the bufferView. For
  651. // animation samplers, target must not be set.
  652. if ( geometry !== undefined ) {
  653. bufferViewTarget = attribute === geometry.index ? WEBGL_CONSTANTS.ELEMENT_ARRAY_BUFFER : WEBGL_CONSTANTS.ARRAY_BUFFER;
  654. }
  655. const bufferView = this.processBufferView( attribute, componentType, start, count, bufferViewTarget );
  656. const accessorDef = {
  657. bufferView: bufferView.id,
  658. byteOffset: bufferView.byteOffset,
  659. componentType: componentType,
  660. count: count,
  661. max: minMax.max,
  662. min: minMax.min,
  663. type: types[ attribute.itemSize ]
  664. };
  665. if ( attribute.normalized === true ) accessorDef.normalized = true;
  666. if ( ! json.accessors ) json.accessors = [];
  667. return json.accessors.push( accessorDef ) - 1;
  668. }
  669. /**
  670. * Process image
  671. * @param {Image} image to process
  672. * @param {Integer} format of the image (RGBAFormat)
  673. * @param {Boolean} flipY before writing out the image
  674. * @param {String} mimeType export format
  675. * @return {Integer} Index of the processed texture in the "images" array
  676. */
  677. processImage( image, format, flipY, mimeType = 'image/png' ) {
  678. const writer = this;
  679. const cache = writer.cache;
  680. const json = writer.json;
  681. const options = writer.options;
  682. const pending = writer.pending;
  683. if ( ! cache.images.has( image ) ) cache.images.set( image, {} );
  684. const cachedImages = cache.images.get( image );
  685. const key = mimeType + ':flipY/' + flipY.toString();
  686. if ( cachedImages[ key ] !== undefined ) return cachedImages[ key ];
  687. if ( ! json.images ) json.images = [];
  688. const imageDef = { mimeType: mimeType };
  689. if ( options.embedImages ) {
  690. const canvas = cachedCanvas = cachedCanvas || document.createElement( 'canvas' );
  691. canvas.width = Math.min( image.width, options.maxTextureSize );
  692. canvas.height = Math.min( image.height, options.maxTextureSize );
  693. const ctx = canvas.getContext( '2d' );
  694. if ( flipY === true ) {
  695. ctx.translate( 0, canvas.height );
  696. ctx.scale( 1, - 1 );
  697. }
  698. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  699. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  700. ( typeof OffscreenCanvas !== 'undefined' && image instanceof OffscreenCanvas ) ||
  701. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  702. ctx.drawImage( image, 0, 0, canvas.width, canvas.height );
  703. } else {
  704. if ( format !== RGBAFormat ) {
  705. console.error( 'GLTFExporter: Only RGBAFormat is supported.' );
  706. }
  707. if ( image.width > options.maxTextureSize || image.height > options.maxTextureSize ) {
  708. console.warn( 'GLTFExporter: Image size is bigger than maxTextureSize', image );
  709. }
  710. const data = new Uint8ClampedArray( image.height * image.width * 4 );
  711. for ( let i = 0; i < data.length; i += 4 ) {
  712. data[ i + 0 ] = image.data[ i + 0 ];
  713. data[ i + 1 ] = image.data[ i + 1 ];
  714. data[ i + 2 ] = image.data[ i + 2 ];
  715. data[ i + 3 ] = image.data[ i + 3 ];
  716. }
  717. ctx.putImageData( new ImageData( data, image.width, image.height ), 0, 0 );
  718. }
  719. if ( options.binary === true ) {
  720. pending.push( new Promise( function ( resolve ) {
  721. canvas.toBlob( function ( blob ) {
  722. writer.processBufferViewImage( blob ).then( function ( bufferViewIndex ) {
  723. imageDef.bufferView = bufferViewIndex;
  724. resolve();
  725. } );
  726. }, mimeType );
  727. } ) );
  728. } else {
  729. imageDef.uri = canvas.toDataURL( mimeType );
  730. }
  731. } else {
  732. imageDef.uri = image.src;
  733. }
  734. const index = json.images.push( imageDef ) - 1;
  735. cachedImages[ key ] = index;
  736. return index;
  737. }
  738. /**
  739. * Process sampler
  740. * @param {Texture} map Texture to process
  741. * @return {Integer} Index of the processed texture in the "samplers" array
  742. */
  743. processSampler( map ) {
  744. const json = this.json;
  745. if ( ! json.samplers ) json.samplers = [];
  746. const samplerDef = {
  747. magFilter: THREE_TO_WEBGL[ map.magFilter ],
  748. minFilter: THREE_TO_WEBGL[ map.minFilter ],
  749. wrapS: THREE_TO_WEBGL[ map.wrapS ],
  750. wrapT: THREE_TO_WEBGL[ map.wrapT ]
  751. };
  752. return json.samplers.push( samplerDef ) - 1;
  753. }
  754. /**
  755. * Process texture
  756. * @param {Texture} map Map to process
  757. * @return {Integer} Index of the processed texture in the "textures" array
  758. */
  759. processTexture( map ) {
  760. const cache = this.cache;
  761. const json = this.json;
  762. if ( cache.textures.has( map ) ) return cache.textures.get( map );
  763. if ( ! json.textures ) json.textures = [];
  764. let mimeType = map.userData.mimeType;
  765. if ( mimeType === 'image/webp' ) mimeType = 'image/png';
  766. const textureDef = {
  767. sampler: this.processSampler( map ),
  768. source: this.processImage( map.image, map.format, map.flipY, mimeType )
  769. };
  770. if ( map.name ) textureDef.name = map.name;
  771. this._invokeAll( function ( ext ) {
  772. ext.writeTexture && ext.writeTexture( map, textureDef );
  773. } );
  774. const index = json.textures.push( textureDef ) - 1;
  775. cache.textures.set( map, index );
  776. return index;
  777. }
  778. /**
  779. * Process material
  780. * @param {THREE.Material} material Material to process
  781. * @return {Integer|null} Index of the processed material in the "materials" array
  782. */
  783. processMaterial( material ) {
  784. const cache = this.cache;
  785. const json = this.json;
  786. if ( cache.materials.has( material ) ) return cache.materials.get( material );
  787. if ( material.isShaderMaterial ) {
  788. console.warn( 'GLTFExporter: THREE.ShaderMaterial not supported.' );
  789. return null;
  790. }
  791. if ( ! json.materials ) json.materials = [];
  792. // @QUESTION Should we avoid including any attribute that has the default value?
  793. const materialDef = { pbrMetallicRoughness: {} };
  794. if ( material.isMeshStandardMaterial !== true && material.isMeshBasicMaterial !== true ) {
  795. console.warn( 'GLTFExporter: Use MeshStandardMaterial or MeshBasicMaterial for best results.' );
  796. }
  797. // pbrMetallicRoughness.baseColorFactor
  798. const color = material.color.toArray().concat( [ material.opacity ] );
  799. if ( ! equalArray( color, [ 1, 1, 1, 1 ] ) ) {
  800. materialDef.pbrMetallicRoughness.baseColorFactor = color;
  801. }
  802. if ( material.isMeshStandardMaterial ) {
  803. materialDef.pbrMetallicRoughness.metallicFactor = material.metalness;
  804. materialDef.pbrMetallicRoughness.roughnessFactor = material.roughness;
  805. } else {
  806. materialDef.pbrMetallicRoughness.metallicFactor = 0.5;
  807. materialDef.pbrMetallicRoughness.roughnessFactor = 0.5;
  808. }
  809. // pbrMetallicRoughness.metallicRoughnessTexture
  810. if ( material.metalnessMap || material.roughnessMap ) {
  811. const metalRoughTexture = this.buildMetalRoughTexture( material.metalnessMap, material.roughnessMap );
  812. const metalRoughMapDef = { index: this.processTexture( metalRoughTexture ) };
  813. this.applyTextureTransform( metalRoughMapDef, metalRoughTexture );
  814. materialDef.pbrMetallicRoughness.metallicRoughnessTexture = metalRoughMapDef;
  815. }
  816. // pbrMetallicRoughness.baseColorTexture or pbrSpecularGlossiness diffuseTexture
  817. if ( material.map ) {
  818. const baseColorMapDef = { index: this.processTexture( material.map ) };
  819. this.applyTextureTransform( baseColorMapDef, material.map );
  820. materialDef.pbrMetallicRoughness.baseColorTexture = baseColorMapDef;
  821. }
  822. if ( material.emissive ) {
  823. // note: emissive components are limited to stay within the 0 - 1 range to accommodate glTF spec. see #21849 and #22000.
  824. const emissive = material.emissive.clone().multiplyScalar( material.emissiveIntensity );
  825. const maxEmissiveComponent = Math.max( emissive.r, emissive.g, emissive.b );
  826. if ( maxEmissiveComponent > 1 ) {
  827. emissive.multiplyScalar( 1 / maxEmissiveComponent );
  828. console.warn( 'THREE.GLTFExporter: Some emissive components exceed 1; emissive has been limited' );
  829. }
  830. if ( maxEmissiveComponent > 0 ) {
  831. materialDef.emissiveFactor = emissive.toArray();
  832. }
  833. // emissiveTexture
  834. if ( material.emissiveMap ) {
  835. const emissiveMapDef = { index: this.processTexture( material.emissiveMap ) };
  836. this.applyTextureTransform( emissiveMapDef, material.emissiveMap );
  837. materialDef.emissiveTexture = emissiveMapDef;
  838. }
  839. }
  840. // normalTexture
  841. if ( material.normalMap ) {
  842. const normalMapDef = { index: this.processTexture( material.normalMap ) };
  843. if ( material.normalScale && material.normalScale.x !== 1 ) {
  844. // glTF normal scale is univariate. Ignore `y`, which may be flipped.
  845. // Context: https://github.com/mrdoob/three.js/issues/11438#issuecomment-507003995
  846. normalMapDef.scale = material.normalScale.x;
  847. }
  848. this.applyTextureTransform( normalMapDef, material.normalMap );
  849. materialDef.normalTexture = normalMapDef;
  850. }
  851. // occlusionTexture
  852. if ( material.aoMap ) {
  853. const occlusionMapDef = {
  854. index: this.processTexture( material.aoMap ),
  855. texCoord: 1
  856. };
  857. if ( material.aoMapIntensity !== 1.0 ) {
  858. occlusionMapDef.strength = material.aoMapIntensity;
  859. }
  860. this.applyTextureTransform( occlusionMapDef, material.aoMap );
  861. materialDef.occlusionTexture = occlusionMapDef;
  862. }
  863. // alphaMode
  864. if ( material.transparent ) {
  865. materialDef.alphaMode = 'BLEND';
  866. } else {
  867. if ( material.alphaTest > 0.0 ) {
  868. materialDef.alphaMode = 'MASK';
  869. materialDef.alphaCutoff = material.alphaTest;
  870. }
  871. }
  872. // doubleSided
  873. if ( material.side === DoubleSide ) materialDef.doubleSided = true;
  874. if ( material.name !== '' ) materialDef.name = material.name;
  875. this.serializeUserData( material, materialDef );
  876. this._invokeAll( function ( ext ) {
  877. ext.writeMaterial && ext.writeMaterial( material, materialDef );
  878. } );
  879. const index = json.materials.push( materialDef ) - 1;
  880. cache.materials.set( material, index );
  881. return index;
  882. }
  883. /**
  884. * Process mesh
  885. * @param {THREE.Mesh} mesh Mesh to process
  886. * @return {Integer|null} Index of the processed mesh in the "meshes" array
  887. */
  888. processMesh( mesh ) {
  889. const cache = this.cache;
  890. const json = this.json;
  891. const meshCacheKeyParts = [ mesh.geometry.uuid ];
  892. if ( Array.isArray( mesh.material ) ) {
  893. for ( let i = 0, l = mesh.material.length; i < l; i ++ ) {
  894. meshCacheKeyParts.push( mesh.material[ i ].uuid );
  895. }
  896. } else {
  897. meshCacheKeyParts.push( mesh.material.uuid );
  898. }
  899. const meshCacheKey = meshCacheKeyParts.join( ':' );
  900. if ( cache.meshes.has( meshCacheKey ) ) return cache.meshes.get( meshCacheKey );
  901. const geometry = mesh.geometry;
  902. let mode;
  903. // Use the correct mode
  904. if ( mesh.isLineSegments ) {
  905. mode = WEBGL_CONSTANTS.LINES;
  906. } else if ( mesh.isLineLoop ) {
  907. mode = WEBGL_CONSTANTS.LINE_LOOP;
  908. } else if ( mesh.isLine ) {
  909. mode = WEBGL_CONSTANTS.LINE_STRIP;
  910. } else if ( mesh.isPoints ) {
  911. mode = WEBGL_CONSTANTS.POINTS;
  912. } else {
  913. mode = mesh.material.wireframe ? WEBGL_CONSTANTS.LINES : WEBGL_CONSTANTS.TRIANGLES;
  914. }
  915. if ( geometry.isBufferGeometry !== true ) {
  916. throw new Error( 'THREE.GLTFExporter: Geometry is not of type THREE.BufferGeometry.' );
  917. }
  918. const meshDef = {};
  919. const attributes = {};
  920. const primitives = [];
  921. const targets = [];
  922. // Conversion between attributes names in threejs and gltf spec
  923. const nameConversion = {
  924. uv: 'TEXCOORD_0',
  925. uv2: 'TEXCOORD_1',
  926. color: 'COLOR_0',
  927. skinWeight: 'WEIGHTS_0',
  928. skinIndex: 'JOINTS_0'
  929. };
  930. const originalNormal = geometry.getAttribute( 'normal' );
  931. if ( originalNormal !== undefined && ! this.isNormalizedNormalAttribute( originalNormal ) ) {
  932. console.warn( 'THREE.GLTFExporter: Creating normalized normal attribute from the non-normalized one.' );
  933. geometry.setAttribute( 'normal', this.createNormalizedNormalAttribute( originalNormal ) );
  934. }
  935. // @QUESTION Detect if .vertexColors = true?
  936. // For every attribute create an accessor
  937. let modifiedAttribute = null;
  938. for ( let attributeName in geometry.attributes ) {
  939. // Ignore morph target attributes, which are exported later.
  940. if ( attributeName.slice( 0, 5 ) === 'morph' ) continue;
  941. const attribute = geometry.attributes[ attributeName ];
  942. attributeName = nameConversion[ attributeName ] || attributeName.toUpperCase();
  943. // Prefix all geometry attributes except the ones specifically
  944. // listed in the spec; non-spec attributes are considered custom.
  945. const validVertexAttributes =
  946. /^(POSITION|NORMAL|TANGENT|TEXCOORD_\d+|COLOR_\d+|JOINTS_\d+|WEIGHTS_\d+)$/;
  947. if ( ! validVertexAttributes.test( attributeName ) ) attributeName = '_' + attributeName;
  948. if ( cache.attributes.has( this.getUID( attribute ) ) ) {
  949. attributes[ attributeName ] = cache.attributes.get( this.getUID( attribute ) );
  950. continue;
  951. }
  952. // JOINTS_0 must be UNSIGNED_BYTE or UNSIGNED_SHORT.
  953. modifiedAttribute = null;
  954. const array = attribute.array;
  955. if ( attributeName === 'JOINTS_0' &&
  956. ! ( array instanceof Uint16Array ) &&
  957. ! ( array instanceof Uint8Array ) ) {
  958. console.warn( 'GLTFExporter: Attribute "skinIndex" converted to type UNSIGNED_SHORT.' );
  959. modifiedAttribute = new BufferAttribute( new Uint16Array( array ), attribute.itemSize, attribute.normalized );
  960. }
  961. const accessor = this.processAccessor( modifiedAttribute || attribute, geometry );
  962. if ( accessor !== null ) {
  963. attributes[ attributeName ] = accessor;
  964. cache.attributes.set( this.getUID( attribute ), accessor );
  965. }
  966. }
  967. if ( originalNormal !== undefined ) geometry.setAttribute( 'normal', originalNormal );
  968. // Skip if no exportable attributes found
  969. if ( Object.keys( attributes ).length === 0 ) return null;
  970. // Morph targets
  971. if ( mesh.morphTargetInfluences !== undefined && mesh.morphTargetInfluences.length > 0 ) {
  972. const weights = [];
  973. const targetNames = [];
  974. const reverseDictionary = {};
  975. if ( mesh.morphTargetDictionary !== undefined ) {
  976. for ( const key in mesh.morphTargetDictionary ) {
  977. reverseDictionary[ mesh.morphTargetDictionary[ key ] ] = key;
  978. }
  979. }
  980. for ( let i = 0; i < mesh.morphTargetInfluences.length; ++ i ) {
  981. const target = {};
  982. let warned = false;
  983. for ( const attributeName in geometry.morphAttributes ) {
  984. // glTF 2.0 morph supports only POSITION/NORMAL/TANGENT.
  985. // Three.js doesn't support TANGENT yet.
  986. if ( attributeName !== 'position' && attributeName !== 'normal' ) {
  987. if ( ! warned ) {
  988. console.warn( 'GLTFExporter: Only POSITION and NORMAL morph are supported.' );
  989. warned = true;
  990. }
  991. continue;
  992. }
  993. const attribute = geometry.morphAttributes[ attributeName ][ i ];
  994. const gltfAttributeName = attributeName.toUpperCase();
  995. // Three.js morph attribute has absolute values while the one of glTF has relative values.
  996. //
  997. // glTF 2.0 Specification:
  998. // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#morph-targets
  999. const baseAttribute = geometry.attributes[ attributeName ];
  1000. if ( cache.attributes.has( this.getUID( attribute ) ) ) {
  1001. target[ gltfAttributeName ] = cache.attributes.get( this.getUID( attribute ) );
  1002. continue;
  1003. }
  1004. // Clones attribute not to override
  1005. const relativeAttribute = attribute.clone();
  1006. if ( ! geometry.morphTargetsRelative ) {
  1007. for ( let j = 0, jl = attribute.count; j < jl; j ++ ) {
  1008. relativeAttribute.setXYZ(
  1009. j,
  1010. attribute.getX( j ) - baseAttribute.getX( j ),
  1011. attribute.getY( j ) - baseAttribute.getY( j ),
  1012. attribute.getZ( j ) - baseAttribute.getZ( j )
  1013. );
  1014. }
  1015. }
  1016. target[ gltfAttributeName ] = this.processAccessor( relativeAttribute, geometry );
  1017. cache.attributes.set( this.getUID( baseAttribute ), target[ gltfAttributeName ] );
  1018. }
  1019. targets.push( target );
  1020. weights.push( mesh.morphTargetInfluences[ i ] );
  1021. if ( mesh.morphTargetDictionary !== undefined ) targetNames.push( reverseDictionary[ i ] );
  1022. }
  1023. meshDef.weights = weights;
  1024. if ( targetNames.length > 0 ) {
  1025. meshDef.extras = {};
  1026. meshDef.extras.targetNames = targetNames;
  1027. }
  1028. }
  1029. const isMultiMaterial = Array.isArray( mesh.material );
  1030. if ( isMultiMaterial && geometry.groups.length === 0 ) return null;
  1031. const materials = isMultiMaterial ? mesh.material : [ mesh.material ];
  1032. const groups = isMultiMaterial ? geometry.groups : [ { materialIndex: 0, start: undefined, count: undefined } ];
  1033. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  1034. const primitive = {
  1035. mode: mode,
  1036. attributes: attributes,
  1037. };
  1038. this.serializeUserData( geometry, primitive );
  1039. if ( targets.length > 0 ) primitive.targets = targets;
  1040. if ( geometry.index !== null ) {
  1041. let cacheKey = this.getUID( geometry.index );
  1042. if ( groups[ i ].start !== undefined || groups[ i ].count !== undefined ) {
  1043. cacheKey += ':' + groups[ i ].start + ':' + groups[ i ].count;
  1044. }
  1045. if ( cache.attributes.has( cacheKey ) ) {
  1046. primitive.indices = cache.attributes.get( cacheKey );
  1047. } else {
  1048. primitive.indices = this.processAccessor( geometry.index, geometry, groups[ i ].start, groups[ i ].count );
  1049. cache.attributes.set( cacheKey, primitive.indices );
  1050. }
  1051. if ( primitive.indices === null ) delete primitive.indices;
  1052. }
  1053. const material = this.processMaterial( materials[ groups[ i ].materialIndex ] );
  1054. if ( material !== null ) primitive.material = material;
  1055. primitives.push( primitive );
  1056. }
  1057. meshDef.primitives = primitives;
  1058. if ( ! json.meshes ) json.meshes = [];
  1059. this._invokeAll( function ( ext ) {
  1060. ext.writeMesh && ext.writeMesh( mesh, meshDef );
  1061. } );
  1062. const index = json.meshes.push( meshDef ) - 1;
  1063. cache.meshes.set( meshCacheKey, index );
  1064. return index;
  1065. }
  1066. /**
  1067. * Process camera
  1068. * @param {THREE.Camera} camera Camera to process
  1069. * @return {Integer} Index of the processed mesh in the "camera" array
  1070. */
  1071. processCamera( camera ) {
  1072. const json = this.json;
  1073. if ( ! json.cameras ) json.cameras = [];
  1074. const isOrtho = camera.isOrthographicCamera;
  1075. const cameraDef = {
  1076. type: isOrtho ? 'orthographic' : 'perspective'
  1077. };
  1078. if ( isOrtho ) {
  1079. cameraDef.orthographic = {
  1080. xmag: camera.right * 2,
  1081. ymag: camera.top * 2,
  1082. zfar: camera.far <= 0 ? 0.001 : camera.far,
  1083. znear: camera.near < 0 ? 0 : camera.near
  1084. };
  1085. } else {
  1086. cameraDef.perspective = {
  1087. aspectRatio: camera.aspect,
  1088. yfov: MathUtils.degToRad( camera.fov ),
  1089. zfar: camera.far <= 0 ? 0.001 : camera.far,
  1090. znear: camera.near < 0 ? 0 : camera.near
  1091. };
  1092. }
  1093. // Question: Is saving "type" as name intentional?
  1094. if ( camera.name !== '' ) cameraDef.name = camera.type;
  1095. return json.cameras.push( cameraDef ) - 1;
  1096. }
  1097. /**
  1098. * Creates glTF animation entry from AnimationClip object.
  1099. *
  1100. * Status:
  1101. * - Only properties listed in PATH_PROPERTIES may be animated.
  1102. *
  1103. * @param {THREE.AnimationClip} clip
  1104. * @param {THREE.Object3D} root
  1105. * @return {number|null}
  1106. */
  1107. processAnimation( clip, root ) {
  1108. const json = this.json;
  1109. const nodeMap = this.nodeMap;
  1110. if ( ! json.animations ) json.animations = [];
  1111. clip = GLTFExporter.Utils.mergeMorphTargetTracks( clip.clone(), root );
  1112. const tracks = clip.tracks;
  1113. const channels = [];
  1114. const samplers = [];
  1115. for ( let i = 0; i < tracks.length; ++ i ) {
  1116. const track = tracks[ i ];
  1117. const trackBinding = PropertyBinding.parseTrackName( track.name );
  1118. let trackNode = PropertyBinding.findNode( root, trackBinding.nodeName );
  1119. const trackProperty = PATH_PROPERTIES[ trackBinding.propertyName ];
  1120. if ( trackBinding.objectName === 'bones' ) {
  1121. if ( trackNode.isSkinnedMesh === true ) {
  1122. trackNode = trackNode.skeleton.getBoneByName( trackBinding.objectIndex );
  1123. } else {
  1124. trackNode = undefined;
  1125. }
  1126. }
  1127. if ( ! trackNode || ! trackProperty ) {
  1128. console.warn( 'THREE.GLTFExporter: Could not export animation track "%s".', track.name );
  1129. return null;
  1130. }
  1131. const inputItemSize = 1;
  1132. let outputItemSize = track.values.length / track.times.length;
  1133. if ( trackProperty === PATH_PROPERTIES.morphTargetInfluences ) {
  1134. outputItemSize /= trackNode.morphTargetInfluences.length;
  1135. }
  1136. let interpolation;
  1137. // @TODO export CubicInterpolant(InterpolateSmooth) as CUBICSPLINE
  1138. // Detecting glTF cubic spline interpolant by checking factory method's special property
  1139. // GLTFCubicSplineInterpolant is a custom interpolant and track doesn't return
  1140. // valid value from .getInterpolation().
  1141. if ( track.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline === true ) {
  1142. interpolation = 'CUBICSPLINE';
  1143. // itemSize of CUBICSPLINE keyframe is 9
  1144. // (VEC3 * 3: inTangent, splineVertex, and outTangent)
  1145. // but needs to be stored as VEC3 so dividing by 3 here.
  1146. outputItemSize /= 3;
  1147. } else if ( track.getInterpolation() === InterpolateDiscrete ) {
  1148. interpolation = 'STEP';
  1149. } else {
  1150. interpolation = 'LINEAR';
  1151. }
  1152. samplers.push( {
  1153. input: this.processAccessor( new BufferAttribute( track.times, inputItemSize ) ),
  1154. output: this.processAccessor( new BufferAttribute( track.values, outputItemSize ) ),
  1155. interpolation: interpolation
  1156. } );
  1157. channels.push( {
  1158. sampler: samplers.length - 1,
  1159. target: {
  1160. node: nodeMap.get( trackNode ),
  1161. path: trackProperty
  1162. }
  1163. } );
  1164. }
  1165. json.animations.push( {
  1166. name: clip.name || 'clip_' + json.animations.length,
  1167. samplers: samplers,
  1168. channels: channels
  1169. } );
  1170. return json.animations.length - 1;
  1171. }
  1172. /**
  1173. * @param {THREE.Object3D} object
  1174. * @return {number|null}
  1175. */
  1176. processSkin( object ) {
  1177. const json = this.json;
  1178. const nodeMap = this.nodeMap;
  1179. const node = json.nodes[ nodeMap.get( object ) ];
  1180. const skeleton = object.skeleton;
  1181. if ( skeleton === undefined ) return null;
  1182. const rootJoint = object.skeleton.bones[ 0 ];
  1183. if ( rootJoint === undefined ) return null;
  1184. const joints = [];
  1185. const inverseBindMatrices = new Float32Array( skeleton.bones.length * 16 );
  1186. const temporaryBoneInverse = new Matrix4();
  1187. for ( let i = 0; i < skeleton.bones.length; ++ i ) {
  1188. joints.push( nodeMap.get( skeleton.bones[ i ] ) );
  1189. temporaryBoneInverse.copy( skeleton.boneInverses[ i ] );
  1190. temporaryBoneInverse.multiply( object.bindMatrix ).toArray( inverseBindMatrices, i * 16 );
  1191. }
  1192. if ( json.skins === undefined ) json.skins = [];
  1193. json.skins.push( {
  1194. inverseBindMatrices: this.processAccessor( new BufferAttribute( inverseBindMatrices, 16 ) ),
  1195. joints: joints,
  1196. skeleton: nodeMap.get( rootJoint )
  1197. } );
  1198. const skinIndex = node.skin = json.skins.length - 1;
  1199. return skinIndex;
  1200. }
  1201. /**
  1202. * Process Object3D node
  1203. * @param {THREE.Object3D} node Object3D to processNode
  1204. * @return {Integer} Index of the node in the nodes list
  1205. */
  1206. processNode( object ) {
  1207. const json = this.json;
  1208. const options = this.options;
  1209. const nodeMap = this.nodeMap;
  1210. if ( ! json.nodes ) json.nodes = [];
  1211. const nodeDef = {};
  1212. if ( options.trs ) {
  1213. const rotation = object.quaternion.toArray();
  1214. const position = object.position.toArray();
  1215. const scale = object.scale.toArray();
  1216. if ( ! equalArray( rotation, [ 0, 0, 0, 1 ] ) ) {
  1217. nodeDef.rotation = rotation;
  1218. }
  1219. if ( ! equalArray( position, [ 0, 0, 0 ] ) ) {
  1220. nodeDef.translation = position;
  1221. }
  1222. if ( ! equalArray( scale, [ 1, 1, 1 ] ) ) {
  1223. nodeDef.scale = scale;
  1224. }
  1225. } else {
  1226. if ( object.matrixAutoUpdate ) {
  1227. object.updateMatrix();
  1228. }
  1229. if ( isIdentityMatrix( object.matrix ) === false ) {
  1230. nodeDef.matrix = object.matrix.elements;
  1231. }
  1232. }
  1233. // We don't export empty strings name because it represents no-name in Three.js.
  1234. if ( object.name !== '' ) nodeDef.name = String( object.name );
  1235. this.serializeUserData( object, nodeDef );
  1236. if ( object.isMesh || object.isLine || object.isPoints ) {
  1237. const meshIndex = this.processMesh( object );
  1238. if ( meshIndex !== null ) nodeDef.mesh = meshIndex;
  1239. } else if ( object.isCamera ) {
  1240. nodeDef.camera = this.processCamera( object );
  1241. }
  1242. if ( object.isSkinnedMesh ) this.skins.push( object );
  1243. if ( object.children.length > 0 ) {
  1244. const children = [];
  1245. for ( let i = 0, l = object.children.length; i < l; i ++ ) {
  1246. const child = object.children[ i ];
  1247. if ( child.visible || options.onlyVisible === false ) {
  1248. const nodeIndex = this.processNode( child );
  1249. if ( nodeIndex !== null ) children.push( nodeIndex );
  1250. }
  1251. }
  1252. if ( children.length > 0 ) nodeDef.children = children;
  1253. }
  1254. this._invokeAll( function ( ext ) {
  1255. ext.writeNode && ext.writeNode( object, nodeDef );
  1256. } );
  1257. const nodeIndex = json.nodes.push( nodeDef ) - 1;
  1258. nodeMap.set( object, nodeIndex );
  1259. return nodeIndex;
  1260. }
  1261. /**
  1262. * Process Scene
  1263. * @param {Scene} node Scene to process
  1264. */
  1265. processScene( scene ) {
  1266. const json = this.json;
  1267. const options = this.options;
  1268. if ( ! json.scenes ) {
  1269. json.scenes = [];
  1270. json.scene = 0;
  1271. }
  1272. const sceneDef = {};
  1273. if ( scene.name !== '' ) sceneDef.name = scene.name;
  1274. json.scenes.push( sceneDef );
  1275. const nodes = [];
  1276. for ( let i = 0, l = scene.children.length; i < l; i ++ ) {
  1277. const child = scene.children[ i ];
  1278. if ( child.visible || options.onlyVisible === false ) {
  1279. const nodeIndex = this.processNode( child );
  1280. if ( nodeIndex !== null ) nodes.push( nodeIndex );
  1281. }
  1282. }
  1283. if ( nodes.length > 0 ) sceneDef.nodes = nodes;
  1284. this.serializeUserData( scene, sceneDef );
  1285. }
  1286. /**
  1287. * Creates a Scene to hold a list of objects and parse it
  1288. * @param {Array} objects List of objects to process
  1289. */
  1290. processObjects( objects ) {
  1291. const scene = new Scene();
  1292. scene.name = 'AuxScene';
  1293. for ( let i = 0; i < objects.length; i ++ ) {
  1294. // We push directly to children instead of calling `add` to prevent
  1295. // modify the .parent and break its original scene and hierarchy
  1296. scene.children.push( objects[ i ] );
  1297. }
  1298. this.processScene( scene );
  1299. }
  1300. /**
  1301. * @param {THREE.Object3D|Array<THREE.Object3D>} input
  1302. */
  1303. processInput( input ) {
  1304. const options = this.options;
  1305. input = input instanceof Array ? input : [ input ];
  1306. this._invokeAll( function ( ext ) {
  1307. ext.beforeParse && ext.beforeParse( input );
  1308. } );
  1309. const objectsWithoutScene = [];
  1310. for ( let i = 0; i < input.length; i ++ ) {
  1311. if ( input[ i ] instanceof Scene ) {
  1312. this.processScene( input[ i ] );
  1313. } else {
  1314. objectsWithoutScene.push( input[ i ] );
  1315. }
  1316. }
  1317. if ( objectsWithoutScene.length > 0 ) this.processObjects( objectsWithoutScene );
  1318. for ( let i = 0; i < this.skins.length; ++ i ) {
  1319. this.processSkin( this.skins[ i ] );
  1320. }
  1321. for ( let i = 0; i < options.animations.length; ++ i ) {
  1322. this.processAnimation( options.animations[ i ], input[ 0 ] );
  1323. }
  1324. this._invokeAll( function ( ext ) {
  1325. ext.afterParse && ext.afterParse( input );
  1326. } );
  1327. }
  1328. _invokeAll( func ) {
  1329. for ( let i = 0, il = this.plugins.length; i < il; i ++ ) {
  1330. func( this.plugins[ i ] );
  1331. }
  1332. }
  1333. }
  1334. /**
  1335. * Punctual Lights Extension
  1336. *
  1337. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
  1338. */
  1339. class GLTFLightExtension {
  1340. constructor( writer ) {
  1341. this.writer = writer;
  1342. this.name = 'KHR_lights_punctual';
  1343. }
  1344. writeNode( light, nodeDef ) {
  1345. if ( ! light.isLight ) return;
  1346. if ( ! light.isDirectionalLight && ! light.isPointLight && ! light.isSpotLight ) {
  1347. console.warn( 'THREE.GLTFExporter: Only directional, point, and spot lights are supported.', light );
  1348. return;
  1349. }
  1350. const writer = this.writer;
  1351. const json = writer.json;
  1352. const extensionsUsed = writer.extensionsUsed;
  1353. const lightDef = {};
  1354. if ( light.name ) lightDef.name = light.name;
  1355. lightDef.color = light.color.toArray();
  1356. lightDef.intensity = light.intensity;
  1357. if ( light.isDirectionalLight ) {
  1358. lightDef.type = 'directional';
  1359. } else if ( light.isPointLight ) {
  1360. lightDef.type = 'point';
  1361. if ( light.distance > 0 ) lightDef.range = light.distance;
  1362. } else if ( light.isSpotLight ) {
  1363. lightDef.type = 'spot';
  1364. if ( light.distance > 0 ) lightDef.range = light.distance;
  1365. lightDef.spot = {};
  1366. lightDef.spot.innerConeAngle = ( light.penumbra - 1.0 ) * light.angle * - 1.0;
  1367. lightDef.spot.outerConeAngle = light.angle;
  1368. }
  1369. if ( light.decay !== undefined && light.decay !== 2 ) {
  1370. console.warn( 'THREE.GLTFExporter: Light decay may be lost. glTF is physically-based, '
  1371. + 'and expects light.decay=2.' );
  1372. }
  1373. if ( light.target
  1374. && ( light.target.parent !== light
  1375. || light.target.position.x !== 0
  1376. || light.target.position.y !== 0
  1377. || light.target.position.z !== - 1 ) ) {
  1378. console.warn( 'THREE.GLTFExporter: Light direction may be lost. For best results, '
  1379. + 'make light.target a child of the light with position 0,0,-1.' );
  1380. }
  1381. if ( ! extensionsUsed[ this.name ] ) {
  1382. json.extensions = json.extensions || {};
  1383. json.extensions[ this.name ] = { lights: [] };
  1384. extensionsUsed[ this.name ] = true;
  1385. }
  1386. const lights = json.extensions[ this.name ].lights;
  1387. lights.push( lightDef );
  1388. nodeDef.extensions = nodeDef.extensions || {};
  1389. nodeDef.extensions[ this.name ] = { light: lights.length - 1 };
  1390. }
  1391. }
  1392. /**
  1393. * Unlit Materials Extension
  1394. *
  1395. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit
  1396. */
  1397. class GLTFMaterialsUnlitExtension {
  1398. constructor( writer ) {
  1399. this.writer = writer;
  1400. this.name = 'KHR_materials_unlit';
  1401. }
  1402. writeMaterial( material, materialDef ) {
  1403. if ( ! material.isMeshBasicMaterial ) return;
  1404. const writer = this.writer;
  1405. const extensionsUsed = writer.extensionsUsed;
  1406. materialDef.extensions = materialDef.extensions || {};
  1407. materialDef.extensions[ this.name ] = {};
  1408. extensionsUsed[ this.name ] = true;
  1409. materialDef.pbrMetallicRoughness.metallicFactor = 0.0;
  1410. materialDef.pbrMetallicRoughness.roughnessFactor = 0.9;
  1411. }
  1412. }
  1413. /**
  1414. * Specular-Glossiness Extension
  1415. *
  1416. * Specification: https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness
  1417. */
  1418. class GLTFMaterialsPBRSpecularGlossiness {
  1419. constructor( writer ) {
  1420. this.writer = writer;
  1421. this.name = 'KHR_materials_pbrSpecularGlossiness';
  1422. }
  1423. writeMaterial( material, materialDef ) {
  1424. if ( ! material.isGLTFSpecularGlossinessMaterial ) return;
  1425. const writer = this.writer;
  1426. const extensionsUsed = writer.extensionsUsed;
  1427. const extensionDef = {};
  1428. if ( materialDef.pbrMetallicRoughness.baseColorFactor ) {
  1429. extensionDef.diffuseFactor = materialDef.pbrMetallicRoughness.baseColorFactor;
  1430. }
  1431. const specularFactor = [ 1, 1, 1 ];
  1432. material.specular.toArray( specularFactor, 0 );
  1433. extensionDef.specularFactor = specularFactor;
  1434. extensionDef.glossinessFactor = material.glossiness;
  1435. if ( materialDef.pbrMetallicRoughness.baseColorTexture ) {
  1436. extensionDef.diffuseTexture = materialDef.pbrMetallicRoughness.baseColorTexture;
  1437. }
  1438. if ( material.specularMap ) {
  1439. const specularMapDef = { index: writer.processTexture( material.specularMap ) };
  1440. writer.applyTextureTransform( specularMapDef, material.specularMap );
  1441. extensionDef.specularGlossinessTexture = specularMapDef;
  1442. }
  1443. materialDef.extensions = materialDef.extensions || {};
  1444. materialDef.extensions[ this.name ] = extensionDef;
  1445. extensionsUsed[ this.name ] = true;
  1446. }
  1447. }
  1448. /**
  1449. * Clearcoat Materials Extension
  1450. *
  1451. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_clearcoat
  1452. */
  1453. class GLTFMaterialsClearcoatExtension {
  1454. constructor( writer ) {
  1455. this.writer = writer;
  1456. this.name = 'KHR_materials_clearcoat';
  1457. }
  1458. writeMaterial( material, materialDef ) {
  1459. if ( ! material.isMeshPhysicalMaterial ) return;
  1460. const writer = this.writer;
  1461. const extensionsUsed = writer.extensionsUsed;
  1462. const extensionDef = {};
  1463. extensionDef.clearcoatFactor = material.clearcoat;
  1464. if ( material.clearcoatMap ) {
  1465. const clearcoatMapDef = { index: writer.processTexture( material.clearcoatMap ) };
  1466. writer.applyTextureTransform( clearcoatMapDef, material.clearcoatMap );
  1467. extensionDef.clearcoatTexture = clearcoatMapDef;
  1468. }
  1469. extensionDef.clearcoatRoughnessFactor = material.clearcoatRoughness;
  1470. if ( material.clearcoatRoughnessMap ) {
  1471. const clearcoatRoughnessMapDef = { index: writer.processTexture( material.clearcoatRoughnessMap ) };
  1472. writer.applyTextureTransform( clearcoatRoughnessMapDef, material.clearcoatRoughnessMap );
  1473. extensionDef.clearcoatRoughnessTexture = clearcoatRoughnessMapDef;
  1474. }
  1475. if ( material.clearcoatNormalMap ) {
  1476. const clearcoatNormalMapDef = { index: writer.processTexture( material.clearcoatNormalMap ) };
  1477. writer.applyTextureTransform( clearcoatNormalMapDef, material.clearcoatNormalMap );
  1478. extensionDef.clearcoatNormalTexture = clearcoatNormalMapDef;
  1479. }
  1480. materialDef.extensions = materialDef.extensions || {};
  1481. materialDef.extensions[ this.name ] = extensionDef;
  1482. extensionsUsed[ this.name ] = true;
  1483. }
  1484. }
  1485. /**
  1486. * Transmission Materials Extension
  1487. *
  1488. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_transmission
  1489. */
  1490. class GLTFMaterialsTransmissionExtension {
  1491. constructor( writer ) {
  1492. this.writer = writer;
  1493. this.name = 'KHR_materials_transmission';
  1494. }
  1495. writeMaterial( material, materialDef ) {
  1496. if ( ! material.isMeshPhysicalMaterial || material.transmission === 0 ) return;
  1497. const writer = this.writer;
  1498. const extensionsUsed = writer.extensionsUsed;
  1499. const extensionDef = {};
  1500. extensionDef.transmissionFactor = material.transmission;
  1501. if ( material.transmissionMap ) {
  1502. const transmissionMapDef = { index: writer.processTexture( material.transmissionMap ) };
  1503. writer.applyTextureTransform( transmissionMapDef, material.transmissionMap );
  1504. extensionDef.transmissionTexture = transmissionMapDef;
  1505. }
  1506. materialDef.extensions = materialDef.extensions || {};
  1507. materialDef.extensions[ this.name ] = extensionDef;
  1508. extensionsUsed[ this.name ] = true;
  1509. }
  1510. }
  1511. /**
  1512. * Materials Volume Extension
  1513. *
  1514. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_volume
  1515. */
  1516. class GLTFMaterialsVolumeExtension {
  1517. constructor( writer ) {
  1518. this.writer = writer;
  1519. this.name = 'KHR_materials_volume';
  1520. }
  1521. writeMaterial( material, materialDef ) {
  1522. if ( ! material.isMeshPhysicalMaterial || material.transmission === 0 ) return;
  1523. const writer = this.writer;
  1524. const extensionsUsed = writer.extensionsUsed;
  1525. const extensionDef = {};
  1526. extensionDef.thicknessFactor = material.thickness;
  1527. if ( material.thicknessMap ) {
  1528. const thicknessMapDef = { index: writer.processTexture( material.thicknessMap ) };
  1529. writer.applyTextureTransform( thicknessMapDef, material.thicknessMap );
  1530. extensionDef.thicknessTexture = thicknessMapDef;
  1531. }
  1532. extensionDef.attenuationDistance = material.attenuationDistance;
  1533. extensionDef.attenuationColor = material.attenuationColor.toArray();
  1534. materialDef.extensions = materialDef.extensions || {};
  1535. materialDef.extensions[ this.name ] = extensionDef;
  1536. extensionsUsed[ this.name ] = true;
  1537. }
  1538. }
  1539. /**
  1540. * Static utility functions
  1541. */
  1542. GLTFExporter.Utils = {
  1543. insertKeyframe: function ( track, time ) {
  1544. const tolerance = 0.001; // 1ms
  1545. const valueSize = track.getValueSize();
  1546. const times = new track.TimeBufferType( track.times.length + 1 );
  1547. const values = new track.ValueBufferType( track.values.length + valueSize );
  1548. const interpolant = track.createInterpolant( new track.ValueBufferType( valueSize ) );
  1549. let index;
  1550. if ( track.times.length === 0 ) {
  1551. times[ 0 ] = time;
  1552. for ( let i = 0; i < valueSize; i ++ ) {
  1553. values[ i ] = 0;
  1554. }
  1555. index = 0;
  1556. } else if ( time < track.times[ 0 ] ) {
  1557. if ( Math.abs( track.times[ 0 ] - time ) < tolerance ) return 0;
  1558. times[ 0 ] = time;
  1559. times.set( track.times, 1 );
  1560. values.set( interpolant.evaluate( time ), 0 );
  1561. values.set( track.values, valueSize );
  1562. index = 0;
  1563. } else if ( time > track.times[ track.times.length - 1 ] ) {
  1564. if ( Math.abs( track.times[ track.times.length - 1 ] - time ) < tolerance ) {
  1565. return track.times.length - 1;
  1566. }
  1567. times[ times.length - 1 ] = time;
  1568. times.set( track.times, 0 );
  1569. values.set( track.values, 0 );
  1570. values.set( interpolant.evaluate( time ), track.values.length );
  1571. index = times.length - 1;
  1572. } else {
  1573. for ( let i = 0; i < track.times.length; i ++ ) {
  1574. if ( Math.abs( track.times[ i ] - time ) < tolerance ) return i;
  1575. if ( track.times[ i ] < time && track.times[ i + 1 ] > time ) {
  1576. times.set( track.times.slice( 0, i + 1 ), 0 );
  1577. times[ i + 1 ] = time;
  1578. times.set( track.times.slice( i + 1 ), i + 2 );
  1579. values.set( track.values.slice( 0, ( i + 1 ) * valueSize ), 0 );
  1580. values.set( interpolant.evaluate( time ), ( i + 1 ) * valueSize );
  1581. values.set( track.values.slice( ( i + 1 ) * valueSize ), ( i + 2 ) * valueSize );
  1582. index = i + 1;
  1583. break;
  1584. }
  1585. }
  1586. }
  1587. track.times = times;
  1588. track.values = values;
  1589. return index;
  1590. },
  1591. mergeMorphTargetTracks: function ( clip, root ) {
  1592. const tracks = [];
  1593. const mergedTracks = {};
  1594. const sourceTracks = clip.tracks;
  1595. for ( let i = 0; i < sourceTracks.length; ++ i ) {
  1596. let sourceTrack = sourceTracks[ i ];
  1597. const sourceTrackBinding = PropertyBinding.parseTrackName( sourceTrack.name );
  1598. const sourceTrackNode = PropertyBinding.findNode( root, sourceTrackBinding.nodeName );
  1599. if ( sourceTrackBinding.propertyName !== 'morphTargetInfluences' || sourceTrackBinding.propertyIndex === undefined ) {
  1600. // Tracks that don't affect morph targets, or that affect all morph targets together, can be left as-is.
  1601. tracks.push( sourceTrack );
  1602. continue;
  1603. }
  1604. if ( sourceTrack.createInterpolant !== sourceTrack.InterpolantFactoryMethodDiscrete
  1605. && sourceTrack.createInterpolant !== sourceTrack.InterpolantFactoryMethodLinear ) {
  1606. if ( sourceTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  1607. // This should never happen, because glTF morph target animations
  1608. // affect all targets already.
  1609. throw new Error( 'THREE.GLTFExporter: Cannot merge tracks with glTF CUBICSPLINE interpolation.' );
  1610. }
  1611. console.warn( 'THREE.GLTFExporter: Morph target interpolation mode not yet supported. Using LINEAR instead.' );
  1612. sourceTrack = sourceTrack.clone();
  1613. sourceTrack.setInterpolation( InterpolateLinear );
  1614. }
  1615. const targetCount = sourceTrackNode.morphTargetInfluences.length;
  1616. const targetIndex = sourceTrackNode.morphTargetDictionary[ sourceTrackBinding.propertyIndex ];
  1617. if ( targetIndex === undefined ) {
  1618. throw new Error( 'THREE.GLTFExporter: Morph target name not found: ' + sourceTrackBinding.propertyIndex );
  1619. }
  1620. let mergedTrack;
  1621. // If this is the first time we've seen this object, create a new
  1622. // track to store merged keyframe data for each morph target.
  1623. if ( mergedTracks[ sourceTrackNode.uuid ] === undefined ) {
  1624. mergedTrack = sourceTrack.clone();
  1625. const values = new mergedTrack.ValueBufferType( targetCount * mergedTrack.times.length );
  1626. for ( let j = 0; j < mergedTrack.times.length; j ++ ) {
  1627. values[ j * targetCount + targetIndex ] = mergedTrack.values[ j ];
  1628. }
  1629. // We need to take into consideration the intended target node
  1630. // of our original un-merged morphTarget animation.
  1631. mergedTrack.name = ( sourceTrackBinding.nodeName || '' ) + '.morphTargetInfluences';
  1632. mergedTrack.values = values;
  1633. mergedTracks[ sourceTrackNode.uuid ] = mergedTrack;
  1634. tracks.push( mergedTrack );
  1635. continue;
  1636. }
  1637. const sourceInterpolant = sourceTrack.createInterpolant( new sourceTrack.ValueBufferType( 1 ) );
  1638. mergedTrack = mergedTracks[ sourceTrackNode.uuid ];
  1639. // For every existing keyframe of the merged track, write a (possibly
  1640. // interpolated) value from the source track.
  1641. for ( let j = 0; j < mergedTrack.times.length; j ++ ) {
  1642. mergedTrack.values[ j * targetCount + targetIndex ] = sourceInterpolant.evaluate( mergedTrack.times[ j ] );
  1643. }
  1644. // For every existing keyframe of the source track, write a (possibly
  1645. // new) keyframe to the merged track. Values from the previous loop may
  1646. // be written again, but keyframes are de-duplicated.
  1647. for ( let j = 0; j < sourceTrack.times.length; j ++ ) {
  1648. const keyframeIndex = this.insertKeyframe( mergedTrack, sourceTrack.times[ j ] );
  1649. mergedTrack.values[ keyframeIndex * targetCount + targetIndex ] = sourceTrack.values[ j ];
  1650. }
  1651. }
  1652. clip.tracks = tracks;
  1653. return clip;
  1654. }
  1655. };
  1656. export { GLTFExporter };