GLTFExporter.js 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599
  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. RGBFormat,
  19. RepeatWrapping,
  20. Scene,
  21. Vector3
  22. } from '../../../build/three.module.js';
  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. /**
  465. * Process a buffer to append to the default one.
  466. * @param {ArrayBuffer} buffer
  467. * @return {Integer}
  468. */
  469. processBuffer( buffer ) {
  470. const json = this.json;
  471. const buffers = this.buffers;
  472. if ( ! json.buffers ) json.buffers = [ { byteLength: 0 } ];
  473. // All buffers are merged before export.
  474. buffers.push( buffer );
  475. return 0;
  476. }
  477. /**
  478. * Process and generate a BufferView
  479. * @param {BufferAttribute} attribute
  480. * @param {number} componentType
  481. * @param {number} start
  482. * @param {number} count
  483. * @param {number} target (Optional) Target usage of the BufferView
  484. * @return {Object}
  485. */
  486. processBufferView( attribute, componentType, start, count, target ) {
  487. const json = this.json;
  488. if ( ! json.bufferViews ) json.bufferViews = [];
  489. // Create a new dataview and dump the attribute's array into it
  490. let componentSize;
  491. if ( componentType === WEBGL_CONSTANTS.UNSIGNED_BYTE ) {
  492. componentSize = 1;
  493. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_SHORT ) {
  494. componentSize = 2;
  495. } else {
  496. componentSize = 4;
  497. }
  498. const byteLength = getPaddedBufferSize( count * attribute.itemSize * componentSize );
  499. const dataView = new DataView( new ArrayBuffer( byteLength ) );
  500. let offset = 0;
  501. for ( let i = start; i < start + count; i ++ ) {
  502. for ( let a = 0; a < attribute.itemSize; a ++ ) {
  503. let value;
  504. if ( attribute.itemSize > 4 ) {
  505. // no support for interleaved data for itemSize > 4
  506. value = attribute.array[ i * attribute.itemSize + a ];
  507. } else {
  508. if ( a === 0 ) value = attribute.getX( i );
  509. else if ( a === 1 ) value = attribute.getY( i );
  510. else if ( a === 2 ) value = attribute.getZ( i );
  511. else if ( a === 3 ) value = attribute.getW( i );
  512. }
  513. if ( componentType === WEBGL_CONSTANTS.FLOAT ) {
  514. dataView.setFloat32( offset, value, true );
  515. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_INT ) {
  516. dataView.setUint32( offset, value, true );
  517. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_SHORT ) {
  518. dataView.setUint16( offset, value, true );
  519. } else if ( componentType === WEBGL_CONSTANTS.UNSIGNED_BYTE ) {
  520. dataView.setUint8( offset, value );
  521. }
  522. offset += componentSize;
  523. }
  524. }
  525. const bufferViewDef = {
  526. buffer: this.processBuffer( dataView.buffer ),
  527. byteOffset: this.byteOffset,
  528. byteLength: byteLength
  529. };
  530. if ( target !== undefined ) bufferViewDef.target = target;
  531. if ( target === WEBGL_CONSTANTS.ARRAY_BUFFER ) {
  532. // Only define byteStride for vertex attributes.
  533. bufferViewDef.byteStride = attribute.itemSize * componentSize;
  534. }
  535. this.byteOffset += byteLength;
  536. json.bufferViews.push( bufferViewDef );
  537. // @TODO Merge bufferViews where possible.
  538. const output = {
  539. id: json.bufferViews.length - 1,
  540. byteLength: 0
  541. };
  542. return output;
  543. }
  544. /**
  545. * Process and generate a BufferView from an image Blob.
  546. * @param {Blob} blob
  547. * @return {Promise<Integer>}
  548. */
  549. processBufferViewImage( blob ) {
  550. const writer = this;
  551. const json = writer.json;
  552. if ( ! json.bufferViews ) json.bufferViews = [];
  553. return new Promise( function ( resolve ) {
  554. const reader = new window.FileReader();
  555. reader.readAsArrayBuffer( blob );
  556. reader.onloadend = function () {
  557. const buffer = getPaddedArrayBuffer( reader.result );
  558. const bufferViewDef = {
  559. buffer: writer.processBuffer( buffer ),
  560. byteOffset: writer.byteOffset,
  561. byteLength: buffer.byteLength
  562. };
  563. writer.byteOffset += buffer.byteLength;
  564. resolve( json.bufferViews.push( bufferViewDef ) - 1 );
  565. };
  566. } );
  567. }
  568. /**
  569. * Process attribute to generate an accessor
  570. * @param {BufferAttribute} attribute Attribute to process
  571. * @param {THREE.BufferGeometry} geometry (Optional) Geometry used for truncated draw range
  572. * @param {Integer} start (Optional)
  573. * @param {Integer} count (Optional)
  574. * @return {Integer|null} Index of the processed accessor on the "accessors" array
  575. */
  576. processAccessor( attribute, geometry, start, count ) {
  577. const options = this.options;
  578. const json = this.json;
  579. const types = {
  580. 1: 'SCALAR',
  581. 2: 'VEC2',
  582. 3: 'VEC3',
  583. 4: 'VEC4',
  584. 16: 'MAT4'
  585. };
  586. let componentType;
  587. // Detect the component type of the attribute array (float, uint or ushort)
  588. if ( attribute.array.constructor === Float32Array ) {
  589. componentType = WEBGL_CONSTANTS.FLOAT;
  590. } else if ( attribute.array.constructor === Uint32Array ) {
  591. componentType = WEBGL_CONSTANTS.UNSIGNED_INT;
  592. } else if ( attribute.array.constructor === Uint16Array ) {
  593. componentType = WEBGL_CONSTANTS.UNSIGNED_SHORT;
  594. } else if ( attribute.array.constructor === Uint8Array ) {
  595. componentType = WEBGL_CONSTANTS.UNSIGNED_BYTE;
  596. } else {
  597. throw new Error( 'THREE.GLTFExporter: Unsupported bufferAttribute component type.' );
  598. }
  599. if ( start === undefined ) start = 0;
  600. if ( count === undefined ) count = attribute.count;
  601. // @TODO Indexed buffer geometry with drawRange not supported yet
  602. if ( options.truncateDrawRange && geometry !== undefined && geometry.index === null ) {
  603. const end = start + count;
  604. const end2 = geometry.drawRange.count === Infinity
  605. ? attribute.count
  606. : geometry.drawRange.start + geometry.drawRange.count;
  607. start = Math.max( start, geometry.drawRange.start );
  608. count = Math.min( end, end2 ) - start;
  609. if ( count < 0 ) count = 0;
  610. }
  611. // Skip creating an accessor if the attribute doesn't have data to export
  612. if ( count === 0 ) return null;
  613. const minMax = getMinMax( attribute, start, count );
  614. let bufferViewTarget;
  615. // If geometry isn't provided, don't infer the target usage of the bufferView. For
  616. // animation samplers, target must not be set.
  617. if ( geometry !== undefined ) {
  618. bufferViewTarget = attribute === geometry.index ? WEBGL_CONSTANTS.ELEMENT_ARRAY_BUFFER : WEBGL_CONSTANTS.ARRAY_BUFFER;
  619. }
  620. const bufferView = this.processBufferView( attribute, componentType, start, count, bufferViewTarget );
  621. const accessorDef = {
  622. bufferView: bufferView.id,
  623. byteOffset: bufferView.byteOffset,
  624. componentType: componentType,
  625. count: count,
  626. max: minMax.max,
  627. min: minMax.min,
  628. type: types[ attribute.itemSize ]
  629. };
  630. if ( attribute.normalized === true ) accessorDef.normalized = true;
  631. if ( ! json.accessors ) json.accessors = [];
  632. return json.accessors.push( accessorDef ) - 1;
  633. }
  634. /**
  635. * Process image
  636. * @param {Image} image to process
  637. * @param {Integer} format of the image (e.g. RGBFormat, RGBAFormat etc)
  638. * @param {Boolean} flipY before writing out the image
  639. * @return {Integer} Index of the processed texture in the "images" array
  640. */
  641. processImage( image, format, flipY ) {
  642. const writer = this;
  643. const cache = writer.cache;
  644. const json = writer.json;
  645. const options = writer.options;
  646. const pending = writer.pending;
  647. if ( ! cache.images.has( image ) ) cache.images.set( image, {} );
  648. const cachedImages = cache.images.get( image );
  649. const mimeType = format === RGBAFormat ? 'image/png' : 'image/jpeg';
  650. const key = mimeType + ':flipY/' + flipY.toString();
  651. if ( cachedImages[ key ] !== undefined ) return cachedImages[ key ];
  652. if ( ! json.images ) json.images = [];
  653. const imageDef = { mimeType: mimeType };
  654. if ( options.embedImages ) {
  655. const canvas = cachedCanvas = cachedCanvas || document.createElement( 'canvas' );
  656. canvas.width = Math.min( image.width, options.maxTextureSize );
  657. canvas.height = Math.min( image.height, options.maxTextureSize );
  658. const ctx = canvas.getContext( '2d' );
  659. if ( flipY === true ) {
  660. ctx.translate( 0, canvas.height );
  661. ctx.scale( 1, - 1 );
  662. }
  663. if ( ( typeof HTMLImageElement !== 'undefined' && image instanceof HTMLImageElement ) ||
  664. ( typeof HTMLCanvasElement !== 'undefined' && image instanceof HTMLCanvasElement ) ||
  665. ( typeof OffscreenCanvas !== 'undefined' && image instanceof OffscreenCanvas ) ||
  666. ( typeof ImageBitmap !== 'undefined' && image instanceof ImageBitmap ) ) {
  667. ctx.drawImage( image, 0, 0, canvas.width, canvas.height );
  668. } else {
  669. if ( format !== RGBAFormat && format !== RGBFormat ) {
  670. console.error( 'GLTFExporter: Only RGB and RGBA formats are supported.' );
  671. }
  672. if ( image.width > options.maxTextureSize || image.height > options.maxTextureSize ) {
  673. console.warn( 'GLTFExporter: Image size is bigger than maxTextureSize', image );
  674. }
  675. const data = new Uint8ClampedArray( image.height * image.width * 4 );
  676. if ( format === RGBAFormat ) {
  677. for ( let i = 0; i < data.length; i += 4 ) {
  678. data[ i + 0 ] = image.data[ i + 0 ];
  679. data[ i + 1 ] = image.data[ i + 1 ];
  680. data[ i + 2 ] = image.data[ i + 2 ];
  681. data[ i + 3 ] = image.data[ i + 3 ];
  682. }
  683. } else {
  684. for ( let i = 0, j = 0; i < data.length; i += 4, j += 3 ) {
  685. data[ i + 0 ] = image.data[ j + 0 ];
  686. data[ i + 1 ] = image.data[ j + 1 ];
  687. data[ i + 2 ] = image.data[ j + 2 ];
  688. data[ i + 3 ] = 255;
  689. }
  690. }
  691. ctx.putImageData( new ImageData( data, image.width, image.height ), 0, 0 );
  692. }
  693. if ( options.binary === true ) {
  694. pending.push( new Promise( function ( resolve ) {
  695. canvas.toBlob( function ( blob ) {
  696. writer.processBufferViewImage( blob ).then( function ( bufferViewIndex ) {
  697. imageDef.bufferView = bufferViewIndex;
  698. resolve();
  699. } );
  700. }, mimeType );
  701. } ) );
  702. } else {
  703. imageDef.uri = canvas.toDataURL( mimeType );
  704. }
  705. } else {
  706. imageDef.uri = image.src;
  707. }
  708. const index = json.images.push( imageDef ) - 1;
  709. cachedImages[ key ] = index;
  710. return index;
  711. }
  712. /**
  713. * Process sampler
  714. * @param {Texture} map Texture to process
  715. * @return {Integer} Index of the processed texture in the "samplers" array
  716. */
  717. processSampler( map ) {
  718. const json = this.json;
  719. if ( ! json.samplers ) json.samplers = [];
  720. const samplerDef = {
  721. magFilter: THREE_TO_WEBGL[ map.magFilter ],
  722. minFilter: THREE_TO_WEBGL[ map.minFilter ],
  723. wrapS: THREE_TO_WEBGL[ map.wrapS ],
  724. wrapT: THREE_TO_WEBGL[ map.wrapT ]
  725. };
  726. return json.samplers.push( samplerDef ) - 1;
  727. }
  728. /**
  729. * Process texture
  730. * @param {Texture} map Map to process
  731. * @return {Integer} Index of the processed texture in the "textures" array
  732. */
  733. processTexture( map ) {
  734. const cache = this.cache;
  735. const json = this.json;
  736. if ( cache.textures.has( map ) ) return cache.textures.get( map );
  737. if ( ! json.textures ) json.textures = [];
  738. const textureDef = {
  739. sampler: this.processSampler( map ),
  740. source: this.processImage( map.image, map.format, map.flipY )
  741. };
  742. if ( map.name ) textureDef.name = map.name;
  743. this._invokeAll( function ( ext ) {
  744. ext.writeTexture && ext.writeTexture( map, textureDef );
  745. } );
  746. const index = json.textures.push( textureDef ) - 1;
  747. cache.textures.set( map, index );
  748. return index;
  749. }
  750. /**
  751. * Process material
  752. * @param {THREE.Material} material Material to process
  753. * @return {Integer|null} Index of the processed material in the "materials" array
  754. */
  755. processMaterial( material ) {
  756. const cache = this.cache;
  757. const json = this.json;
  758. if ( cache.materials.has( material ) ) return cache.materials.get( material );
  759. if ( material.isShaderMaterial ) {
  760. console.warn( 'GLTFExporter: THREE.ShaderMaterial not supported.' );
  761. return null;
  762. }
  763. if ( ! json.materials ) json.materials = [];
  764. // @QUESTION Should we avoid including any attribute that has the default value?
  765. const materialDef = { pbrMetallicRoughness: {} };
  766. if ( material.isMeshStandardMaterial !== true && material.isMeshBasicMaterial !== true ) {
  767. console.warn( 'GLTFExporter: Use MeshStandardMaterial or MeshBasicMaterial for best results.' );
  768. }
  769. // pbrMetallicRoughness.baseColorFactor
  770. const color = material.color.toArray().concat( [ material.opacity ] );
  771. if ( ! equalArray( color, [ 1, 1, 1, 1 ] ) ) {
  772. materialDef.pbrMetallicRoughness.baseColorFactor = color;
  773. }
  774. if ( material.isMeshStandardMaterial ) {
  775. materialDef.pbrMetallicRoughness.metallicFactor = material.metalness;
  776. materialDef.pbrMetallicRoughness.roughnessFactor = material.roughness;
  777. } else {
  778. materialDef.pbrMetallicRoughness.metallicFactor = 0.5;
  779. materialDef.pbrMetallicRoughness.roughnessFactor = 0.5;
  780. }
  781. // pbrMetallicRoughness.metallicRoughnessTexture
  782. if ( material.metalnessMap || material.roughnessMap ) {
  783. if ( material.metalnessMap === material.roughnessMap ) {
  784. const metalRoughMapDef = { index: this.processTexture( material.metalnessMap ) };
  785. this.applyTextureTransform( metalRoughMapDef, material.metalnessMap );
  786. materialDef.pbrMetallicRoughness.metallicRoughnessTexture = metalRoughMapDef;
  787. } else {
  788. console.warn( 'THREE.GLTFExporter: Ignoring metalnessMap and roughnessMap because they are not the same Texture.' );
  789. }
  790. }
  791. // pbrMetallicRoughness.baseColorTexture or pbrSpecularGlossiness diffuseTexture
  792. if ( material.map ) {
  793. const baseColorMapDef = { index: this.processTexture( material.map ) };
  794. this.applyTextureTransform( baseColorMapDef, material.map );
  795. materialDef.pbrMetallicRoughness.baseColorTexture = baseColorMapDef;
  796. }
  797. if ( material.emissive ) {
  798. // note: emissive components are limited to stay within the 0 - 1 range to accommodate glTF spec. see #21849 and #22000.
  799. const emissive = material.emissive.clone().multiplyScalar( material.emissiveIntensity );
  800. const maxEmissiveComponent = Math.max( emissive.r, emissive.g, emissive.b );
  801. if ( maxEmissiveComponent > 1 ) {
  802. emissive.multiplyScalar( 1 / maxEmissiveComponent );
  803. console.warn( 'THREE.GLTFExporter: Some emissive components exceed 1; emissive has been limited' );
  804. }
  805. if ( maxEmissiveComponent > 0 ) {
  806. materialDef.emissiveFactor = emissive.toArray();
  807. }
  808. // emissiveTexture
  809. if ( material.emissiveMap ) {
  810. const emissiveMapDef = { index: this.processTexture( material.emissiveMap ) };
  811. this.applyTextureTransform( emissiveMapDef, material.emissiveMap );
  812. materialDef.emissiveTexture = emissiveMapDef;
  813. }
  814. }
  815. // normalTexture
  816. if ( material.normalMap ) {
  817. const normalMapDef = { index: this.processTexture( material.normalMap ) };
  818. if ( material.normalScale && material.normalScale.x !== 1 ) {
  819. // glTF normal scale is univariate. Ignore `y`, which may be flipped.
  820. // Context: https://github.com/mrdoob/three.js/issues/11438#issuecomment-507003995
  821. normalMapDef.scale = material.normalScale.x;
  822. }
  823. this.applyTextureTransform( normalMapDef, material.normalMap );
  824. materialDef.normalTexture = normalMapDef;
  825. }
  826. // occlusionTexture
  827. if ( material.aoMap ) {
  828. const occlusionMapDef = {
  829. index: this.processTexture( material.aoMap ),
  830. texCoord: 1
  831. };
  832. if ( material.aoMapIntensity !== 1.0 ) {
  833. occlusionMapDef.strength = material.aoMapIntensity;
  834. }
  835. this.applyTextureTransform( occlusionMapDef, material.aoMap );
  836. materialDef.occlusionTexture = occlusionMapDef;
  837. }
  838. // alphaMode
  839. if ( material.transparent ) {
  840. materialDef.alphaMode = 'BLEND';
  841. } else {
  842. if ( material.alphaTest > 0.0 ) {
  843. materialDef.alphaMode = 'MASK';
  844. materialDef.alphaCutoff = material.alphaTest;
  845. }
  846. }
  847. // doubleSided
  848. if ( material.side === DoubleSide ) materialDef.doubleSided = true;
  849. if ( material.name !== '' ) materialDef.name = material.name;
  850. this.serializeUserData( material, materialDef );
  851. this._invokeAll( function ( ext ) {
  852. ext.writeMaterial && ext.writeMaterial( material, materialDef );
  853. } );
  854. const index = json.materials.push( materialDef ) - 1;
  855. cache.materials.set( material, index );
  856. return index;
  857. }
  858. /**
  859. * Process mesh
  860. * @param {THREE.Mesh} mesh Mesh to process
  861. * @return {Integer|null} Index of the processed mesh in the "meshes" array
  862. */
  863. processMesh( mesh ) {
  864. const cache = this.cache;
  865. const json = this.json;
  866. const meshCacheKeyParts = [ mesh.geometry.uuid ];
  867. if ( Array.isArray( mesh.material ) ) {
  868. for ( let i = 0, l = mesh.material.length; i < l; i ++ ) {
  869. meshCacheKeyParts.push( mesh.material[ i ].uuid );
  870. }
  871. } else {
  872. meshCacheKeyParts.push( mesh.material.uuid );
  873. }
  874. const meshCacheKey = meshCacheKeyParts.join( ':' );
  875. if ( cache.meshes.has( meshCacheKey ) ) return cache.meshes.get( meshCacheKey );
  876. const geometry = mesh.geometry;
  877. let mode;
  878. // Use the correct mode
  879. if ( mesh.isLineSegments ) {
  880. mode = WEBGL_CONSTANTS.LINES;
  881. } else if ( mesh.isLineLoop ) {
  882. mode = WEBGL_CONSTANTS.LINE_LOOP;
  883. } else if ( mesh.isLine ) {
  884. mode = WEBGL_CONSTANTS.LINE_STRIP;
  885. } else if ( mesh.isPoints ) {
  886. mode = WEBGL_CONSTANTS.POINTS;
  887. } else {
  888. mode = mesh.material.wireframe ? WEBGL_CONSTANTS.LINES : WEBGL_CONSTANTS.TRIANGLES;
  889. }
  890. if ( geometry.isBufferGeometry !== true ) {
  891. throw new Error( 'THREE.GLTFExporter: Geometry is not of type THREE.BufferGeometry.' );
  892. }
  893. const meshDef = {};
  894. const attributes = {};
  895. const primitives = [];
  896. const targets = [];
  897. // Conversion between attributes names in threejs and gltf spec
  898. const nameConversion = {
  899. uv: 'TEXCOORD_0',
  900. uv2: 'TEXCOORD_1',
  901. color: 'COLOR_0',
  902. skinWeight: 'WEIGHTS_0',
  903. skinIndex: 'JOINTS_0'
  904. };
  905. const originalNormal = geometry.getAttribute( 'normal' );
  906. if ( originalNormal !== undefined && ! this.isNormalizedNormalAttribute( originalNormal ) ) {
  907. console.warn( 'THREE.GLTFExporter: Creating normalized normal attribute from the non-normalized one.' );
  908. geometry.setAttribute( 'normal', this.createNormalizedNormalAttribute( originalNormal ) );
  909. }
  910. // @QUESTION Detect if .vertexColors = true?
  911. // For every attribute create an accessor
  912. let modifiedAttribute = null;
  913. for ( let attributeName in geometry.attributes ) {
  914. // Ignore morph target attributes, which are exported later.
  915. if ( attributeName.substr( 0, 5 ) === 'morph' ) continue;
  916. const attribute = geometry.attributes[ attributeName ];
  917. attributeName = nameConversion[ attributeName ] || attributeName.toUpperCase();
  918. // Prefix all geometry attributes except the ones specifically
  919. // listed in the spec; non-spec attributes are considered custom.
  920. const validVertexAttributes =
  921. /^(POSITION|NORMAL|TANGENT|TEXCOORD_\d+|COLOR_\d+|JOINTS_\d+|WEIGHTS_\d+)$/;
  922. if ( ! validVertexAttributes.test( attributeName ) ) attributeName = '_' + attributeName;
  923. if ( cache.attributes.has( this.getUID( attribute ) ) ) {
  924. attributes[ attributeName ] = cache.attributes.get( this.getUID( attribute ) );
  925. continue;
  926. }
  927. // JOINTS_0 must be UNSIGNED_BYTE or UNSIGNED_SHORT.
  928. modifiedAttribute = null;
  929. const array = attribute.array;
  930. if ( attributeName === 'JOINTS_0' &&
  931. ! ( array instanceof Uint16Array ) &&
  932. ! ( array instanceof Uint8Array ) ) {
  933. console.warn( 'GLTFExporter: Attribute "skinIndex" converted to type UNSIGNED_SHORT.' );
  934. modifiedAttribute = new BufferAttribute( new Uint16Array( array ), attribute.itemSize, attribute.normalized );
  935. }
  936. const accessor = this.processAccessor( modifiedAttribute || attribute, geometry );
  937. if ( accessor !== null ) {
  938. attributes[ attributeName ] = accessor;
  939. cache.attributes.set( this.getUID( attribute ), accessor );
  940. }
  941. }
  942. if ( originalNormal !== undefined ) geometry.setAttribute( 'normal', originalNormal );
  943. // Skip if no exportable attributes found
  944. if ( Object.keys( attributes ).length === 0 ) return null;
  945. // Morph targets
  946. if ( mesh.morphTargetInfluences !== undefined && mesh.morphTargetInfluences.length > 0 ) {
  947. const weights = [];
  948. const targetNames = [];
  949. const reverseDictionary = {};
  950. if ( mesh.morphTargetDictionary !== undefined ) {
  951. for ( const key in mesh.morphTargetDictionary ) {
  952. reverseDictionary[ mesh.morphTargetDictionary[ key ] ] = key;
  953. }
  954. }
  955. for ( let i = 0; i < mesh.morphTargetInfluences.length; ++ i ) {
  956. const target = {};
  957. let warned = false;
  958. for ( const attributeName in geometry.morphAttributes ) {
  959. // glTF 2.0 morph supports only POSITION/NORMAL/TANGENT.
  960. // Three.js doesn't support TANGENT yet.
  961. if ( attributeName !== 'position' && attributeName !== 'normal' ) {
  962. if ( ! warned ) {
  963. console.warn( 'GLTFExporter: Only POSITION and NORMAL morph are supported.' );
  964. warned = true;
  965. }
  966. continue;
  967. }
  968. const attribute = geometry.morphAttributes[ attributeName ][ i ];
  969. const gltfAttributeName = attributeName.toUpperCase();
  970. // Three.js morph attribute has absolute values while the one of glTF has relative values.
  971. //
  972. // glTF 2.0 Specification:
  973. // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#morph-targets
  974. const baseAttribute = geometry.attributes[ attributeName ];
  975. if ( cache.attributes.has( this.getUID( attribute ) ) ) {
  976. target[ gltfAttributeName ] = cache.attributes.get( this.getUID( attribute ) );
  977. continue;
  978. }
  979. // Clones attribute not to override
  980. const relativeAttribute = attribute.clone();
  981. if ( ! geometry.morphTargetsRelative ) {
  982. for ( let j = 0, jl = attribute.count; j < jl; j ++ ) {
  983. relativeAttribute.setXYZ(
  984. j,
  985. attribute.getX( j ) - baseAttribute.getX( j ),
  986. attribute.getY( j ) - baseAttribute.getY( j ),
  987. attribute.getZ( j ) - baseAttribute.getZ( j )
  988. );
  989. }
  990. }
  991. target[ gltfAttributeName ] = this.processAccessor( relativeAttribute, geometry );
  992. cache.attributes.set( this.getUID( baseAttribute ), target[ gltfAttributeName ] );
  993. }
  994. targets.push( target );
  995. weights.push( mesh.morphTargetInfluences[ i ] );
  996. if ( mesh.morphTargetDictionary !== undefined ) targetNames.push( reverseDictionary[ i ] );
  997. }
  998. meshDef.weights = weights;
  999. if ( targetNames.length > 0 ) {
  1000. meshDef.extras = {};
  1001. meshDef.extras.targetNames = targetNames;
  1002. }
  1003. }
  1004. const isMultiMaterial = Array.isArray( mesh.material );
  1005. if ( isMultiMaterial && geometry.groups.length === 0 ) return null;
  1006. const materials = isMultiMaterial ? mesh.material : [ mesh.material ];
  1007. const groups = isMultiMaterial ? geometry.groups : [ { materialIndex: 0, start: undefined, count: undefined } ];
  1008. for ( let i = 0, il = groups.length; i < il; i ++ ) {
  1009. const primitive = {
  1010. mode: mode,
  1011. attributes: attributes,
  1012. };
  1013. this.serializeUserData( geometry, primitive );
  1014. if ( targets.length > 0 ) primitive.targets = targets;
  1015. if ( geometry.index !== null ) {
  1016. let cacheKey = this.getUID( geometry.index );
  1017. if ( groups[ i ].start !== undefined || groups[ i ].count !== undefined ) {
  1018. cacheKey += ':' + groups[ i ].start + ':' + groups[ i ].count;
  1019. }
  1020. if ( cache.attributes.has( cacheKey ) ) {
  1021. primitive.indices = cache.attributes.get( cacheKey );
  1022. } else {
  1023. primitive.indices = this.processAccessor( geometry.index, geometry, groups[ i ].start, groups[ i ].count );
  1024. cache.attributes.set( cacheKey, primitive.indices );
  1025. }
  1026. if ( primitive.indices === null ) delete primitive.indices;
  1027. }
  1028. const material = this.processMaterial( materials[ groups[ i ].materialIndex ] );
  1029. if ( material !== null ) primitive.material = material;
  1030. primitives.push( primitive );
  1031. }
  1032. meshDef.primitives = primitives;
  1033. if ( ! json.meshes ) json.meshes = [];
  1034. this._invokeAll( function ( ext ) {
  1035. ext.writeMesh && ext.writeMesh( mesh, meshDef );
  1036. } );
  1037. const index = json.meshes.push( meshDef ) - 1;
  1038. cache.meshes.set( meshCacheKey, index );
  1039. return index;
  1040. }
  1041. /**
  1042. * Process camera
  1043. * @param {THREE.Camera} camera Camera to process
  1044. * @return {Integer} Index of the processed mesh in the "camera" array
  1045. */
  1046. processCamera( camera ) {
  1047. const json = this.json;
  1048. if ( ! json.cameras ) json.cameras = [];
  1049. const isOrtho = camera.isOrthographicCamera;
  1050. const cameraDef = {
  1051. type: isOrtho ? 'orthographic' : 'perspective'
  1052. };
  1053. if ( isOrtho ) {
  1054. cameraDef.orthographic = {
  1055. xmag: camera.right * 2,
  1056. ymag: camera.top * 2,
  1057. zfar: camera.far <= 0 ? 0.001 : camera.far,
  1058. znear: camera.near < 0 ? 0 : camera.near
  1059. };
  1060. } else {
  1061. cameraDef.perspective = {
  1062. aspectRatio: camera.aspect,
  1063. yfov: MathUtils.degToRad( camera.fov ),
  1064. zfar: camera.far <= 0 ? 0.001 : camera.far,
  1065. znear: camera.near < 0 ? 0 : camera.near
  1066. };
  1067. }
  1068. // Question: Is saving "type" as name intentional?
  1069. if ( camera.name !== '' ) cameraDef.name = camera.type;
  1070. return json.cameras.push( cameraDef ) - 1;
  1071. }
  1072. /**
  1073. * Creates glTF animation entry from AnimationClip object.
  1074. *
  1075. * Status:
  1076. * - Only properties listed in PATH_PROPERTIES may be animated.
  1077. *
  1078. * @param {THREE.AnimationClip} clip
  1079. * @param {THREE.Object3D} root
  1080. * @return {number|null}
  1081. */
  1082. processAnimation( clip, root ) {
  1083. const json = this.json;
  1084. const nodeMap = this.nodeMap;
  1085. if ( ! json.animations ) json.animations = [];
  1086. clip = GLTFExporter.Utils.mergeMorphTargetTracks( clip.clone(), root );
  1087. const tracks = clip.tracks;
  1088. const channels = [];
  1089. const samplers = [];
  1090. for ( let i = 0; i < tracks.length; ++ i ) {
  1091. const track = tracks[ i ];
  1092. const trackBinding = PropertyBinding.parseTrackName( track.name );
  1093. let trackNode = PropertyBinding.findNode( root, trackBinding.nodeName );
  1094. const trackProperty = PATH_PROPERTIES[ trackBinding.propertyName ];
  1095. if ( trackBinding.objectName === 'bones' ) {
  1096. if ( trackNode.isSkinnedMesh === true ) {
  1097. trackNode = trackNode.skeleton.getBoneByName( trackBinding.objectIndex );
  1098. } else {
  1099. trackNode = undefined;
  1100. }
  1101. }
  1102. if ( ! trackNode || ! trackProperty ) {
  1103. console.warn( 'THREE.GLTFExporter: Could not export animation track "%s".', track.name );
  1104. return null;
  1105. }
  1106. const inputItemSize = 1;
  1107. let outputItemSize = track.values.length / track.times.length;
  1108. if ( trackProperty === PATH_PROPERTIES.morphTargetInfluences ) {
  1109. outputItemSize /= trackNode.morphTargetInfluences.length;
  1110. }
  1111. let interpolation;
  1112. // @TODO export CubicInterpolant(InterpolateSmooth) as CUBICSPLINE
  1113. // Detecting glTF cubic spline interpolant by checking factory method's special property
  1114. // GLTFCubicSplineInterpolant is a custom interpolant and track doesn't return
  1115. // valid value from .getInterpolation().
  1116. if ( track.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline === true ) {
  1117. interpolation = 'CUBICSPLINE';
  1118. // itemSize of CUBICSPLINE keyframe is 9
  1119. // (VEC3 * 3: inTangent, splineVertex, and outTangent)
  1120. // but needs to be stored as VEC3 so dividing by 3 here.
  1121. outputItemSize /= 3;
  1122. } else if ( track.getInterpolation() === InterpolateDiscrete ) {
  1123. interpolation = 'STEP';
  1124. } else {
  1125. interpolation = 'LINEAR';
  1126. }
  1127. samplers.push( {
  1128. input: this.processAccessor( new BufferAttribute( track.times, inputItemSize ) ),
  1129. output: this.processAccessor( new BufferAttribute( track.values, outputItemSize ) ),
  1130. interpolation: interpolation
  1131. } );
  1132. channels.push( {
  1133. sampler: samplers.length - 1,
  1134. target: {
  1135. node: nodeMap.get( trackNode ),
  1136. path: trackProperty
  1137. }
  1138. } );
  1139. }
  1140. json.animations.push( {
  1141. name: clip.name || 'clip_' + json.animations.length,
  1142. samplers: samplers,
  1143. channels: channels
  1144. } );
  1145. return json.animations.length - 1;
  1146. }
  1147. /**
  1148. * @param {THREE.Object3D} object
  1149. * @return {number|null}
  1150. */
  1151. processSkin( object ) {
  1152. const json = this.json;
  1153. const nodeMap = this.nodeMap;
  1154. const node = json.nodes[ nodeMap.get( object ) ];
  1155. const skeleton = object.skeleton;
  1156. if ( skeleton === undefined ) return null;
  1157. const rootJoint = object.skeleton.bones[ 0 ];
  1158. if ( rootJoint === undefined ) return null;
  1159. const joints = [];
  1160. const inverseBindMatrices = new Float32Array( skeleton.bones.length * 16 );
  1161. const temporaryBoneInverse = new Matrix4();
  1162. for ( let i = 0; i < skeleton.bones.length; ++ i ) {
  1163. joints.push( nodeMap.get( skeleton.bones[ i ] ) );
  1164. temporaryBoneInverse.copy( skeleton.boneInverses[ i ] );
  1165. temporaryBoneInverse.multiply( object.bindMatrix ).toArray( inverseBindMatrices, i * 16 );
  1166. }
  1167. if ( json.skins === undefined ) json.skins = [];
  1168. json.skins.push( {
  1169. inverseBindMatrices: this.processAccessor( new BufferAttribute( inverseBindMatrices, 16 ) ),
  1170. joints: joints,
  1171. skeleton: nodeMap.get( rootJoint )
  1172. } );
  1173. const skinIndex = node.skin = json.skins.length - 1;
  1174. return skinIndex;
  1175. }
  1176. /**
  1177. * Process Object3D node
  1178. * @param {THREE.Object3D} node Object3D to processNode
  1179. * @return {Integer} Index of the node in the nodes list
  1180. */
  1181. processNode( object ) {
  1182. const json = this.json;
  1183. const options = this.options;
  1184. const nodeMap = this.nodeMap;
  1185. if ( ! json.nodes ) json.nodes = [];
  1186. const nodeDef = {};
  1187. if ( options.trs ) {
  1188. const rotation = object.quaternion.toArray();
  1189. const position = object.position.toArray();
  1190. const scale = object.scale.toArray();
  1191. if ( ! equalArray( rotation, [ 0, 0, 0, 1 ] ) ) {
  1192. nodeDef.rotation = rotation;
  1193. }
  1194. if ( ! equalArray( position, [ 0, 0, 0 ] ) ) {
  1195. nodeDef.translation = position;
  1196. }
  1197. if ( ! equalArray( scale, [ 1, 1, 1 ] ) ) {
  1198. nodeDef.scale = scale;
  1199. }
  1200. } else {
  1201. if ( object.matrixAutoUpdate ) {
  1202. object.updateMatrix();
  1203. }
  1204. if ( isIdentityMatrix( object.matrix ) === false ) {
  1205. nodeDef.matrix = object.matrix.elements;
  1206. }
  1207. }
  1208. // We don't export empty strings name because it represents no-name in Three.js.
  1209. if ( object.name !== '' ) nodeDef.name = String( object.name );
  1210. this.serializeUserData( object, nodeDef );
  1211. if ( object.isMesh || object.isLine || object.isPoints ) {
  1212. const meshIndex = this.processMesh( object );
  1213. if ( meshIndex !== null ) nodeDef.mesh = meshIndex;
  1214. } else if ( object.isCamera ) {
  1215. nodeDef.camera = this.processCamera( object );
  1216. }
  1217. if ( object.isSkinnedMesh ) this.skins.push( object );
  1218. if ( object.children.length > 0 ) {
  1219. const children = [];
  1220. for ( let i = 0, l = object.children.length; i < l; i ++ ) {
  1221. const child = object.children[ i ];
  1222. if ( child.visible || options.onlyVisible === false ) {
  1223. const nodeIndex = this.processNode( child );
  1224. if ( nodeIndex !== null ) children.push( nodeIndex );
  1225. }
  1226. }
  1227. if ( children.length > 0 ) nodeDef.children = children;
  1228. }
  1229. this._invokeAll( function ( ext ) {
  1230. ext.writeNode && ext.writeNode( object, nodeDef );
  1231. } );
  1232. const nodeIndex = json.nodes.push( nodeDef ) - 1;
  1233. nodeMap.set( object, nodeIndex );
  1234. return nodeIndex;
  1235. }
  1236. /**
  1237. * Process Scene
  1238. * @param {Scene} node Scene to process
  1239. */
  1240. processScene( scene ) {
  1241. const json = this.json;
  1242. const options = this.options;
  1243. if ( ! json.scenes ) {
  1244. json.scenes = [];
  1245. json.scene = 0;
  1246. }
  1247. const sceneDef = {};
  1248. if ( scene.name !== '' ) sceneDef.name = scene.name;
  1249. json.scenes.push( sceneDef );
  1250. const nodes = [];
  1251. for ( let i = 0, l = scene.children.length; i < l; i ++ ) {
  1252. const child = scene.children[ i ];
  1253. if ( child.visible || options.onlyVisible === false ) {
  1254. const nodeIndex = this.processNode( child );
  1255. if ( nodeIndex !== null ) nodes.push( nodeIndex );
  1256. }
  1257. }
  1258. if ( nodes.length > 0 ) sceneDef.nodes = nodes;
  1259. this.serializeUserData( scene, sceneDef );
  1260. }
  1261. /**
  1262. * Creates a Scene to hold a list of objects and parse it
  1263. * @param {Array} objects List of objects to process
  1264. */
  1265. processObjects( objects ) {
  1266. const scene = new Scene();
  1267. scene.name = 'AuxScene';
  1268. for ( let i = 0; i < objects.length; i ++ ) {
  1269. // We push directly to children instead of calling `add` to prevent
  1270. // modify the .parent and break its original scene and hierarchy
  1271. scene.children.push( objects[ i ] );
  1272. }
  1273. this.processScene( scene );
  1274. }
  1275. /**
  1276. * @param {THREE.Object3D|Array<THREE.Object3D>} input
  1277. */
  1278. processInput( input ) {
  1279. const options = this.options;
  1280. input = input instanceof Array ? input : [ input ];
  1281. this._invokeAll( function ( ext ) {
  1282. ext.beforeParse && ext.beforeParse( input );
  1283. } );
  1284. const objectsWithoutScene = [];
  1285. for ( let i = 0; i < input.length; i ++ ) {
  1286. if ( input[ i ] instanceof Scene ) {
  1287. this.processScene( input[ i ] );
  1288. } else {
  1289. objectsWithoutScene.push( input[ i ] );
  1290. }
  1291. }
  1292. if ( objectsWithoutScene.length > 0 ) this.processObjects( objectsWithoutScene );
  1293. for ( let i = 0; i < this.skins.length; ++ i ) {
  1294. this.processSkin( this.skins[ i ] );
  1295. }
  1296. for ( let i = 0; i < options.animations.length; ++ i ) {
  1297. this.processAnimation( options.animations[ i ], input[ 0 ] );
  1298. }
  1299. this._invokeAll( function ( ext ) {
  1300. ext.afterParse && ext.afterParse( input );
  1301. } );
  1302. }
  1303. _invokeAll( func ) {
  1304. for ( let i = 0, il = this.plugins.length; i < il; i ++ ) {
  1305. func( this.plugins[ i ] );
  1306. }
  1307. }
  1308. }
  1309. /**
  1310. * Punctual Lights Extension
  1311. *
  1312. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_lights_punctual
  1313. */
  1314. class GLTFLightExtension {
  1315. constructor( writer ) {
  1316. this.writer = writer;
  1317. this.name = 'KHR_lights_punctual';
  1318. }
  1319. writeNode( light, nodeDef ) {
  1320. if ( ! light.isLight ) return;
  1321. if ( ! light.isDirectionalLight && ! light.isPointLight && ! light.isSpotLight ) {
  1322. console.warn( 'THREE.GLTFExporter: Only directional, point, and spot lights are supported.', light );
  1323. return;
  1324. }
  1325. const writer = this.writer;
  1326. const json = writer.json;
  1327. const extensionsUsed = writer.extensionsUsed;
  1328. const lightDef = {};
  1329. if ( light.name ) lightDef.name = light.name;
  1330. lightDef.color = light.color.toArray();
  1331. lightDef.intensity = light.intensity;
  1332. if ( light.isDirectionalLight ) {
  1333. lightDef.type = 'directional';
  1334. } else if ( light.isPointLight ) {
  1335. lightDef.type = 'point';
  1336. if ( light.distance > 0 ) lightDef.range = light.distance;
  1337. } else if ( light.isSpotLight ) {
  1338. lightDef.type = 'spot';
  1339. if ( light.distance > 0 ) lightDef.range = light.distance;
  1340. lightDef.spot = {};
  1341. lightDef.spot.innerConeAngle = ( light.penumbra - 1.0 ) * light.angle * - 1.0;
  1342. lightDef.spot.outerConeAngle = light.angle;
  1343. }
  1344. if ( light.decay !== undefined && light.decay !== 2 ) {
  1345. console.warn( 'THREE.GLTFExporter: Light decay may be lost. glTF is physically-based, '
  1346. + 'and expects light.decay=2.' );
  1347. }
  1348. if ( light.target
  1349. && ( light.target.parent !== light
  1350. || light.target.position.x !== 0
  1351. || light.target.position.y !== 0
  1352. || light.target.position.z !== - 1 ) ) {
  1353. console.warn( 'THREE.GLTFExporter: Light direction may be lost. For best results, '
  1354. + 'make light.target a child of the light with position 0,0,-1.' );
  1355. }
  1356. if ( ! extensionsUsed[ this.name ] ) {
  1357. json.extensions = json.extensions || {};
  1358. json.extensions[ this.name ] = { lights: [] };
  1359. extensionsUsed[ this.name ] = true;
  1360. }
  1361. const lights = json.extensions[ this.name ].lights;
  1362. lights.push( lightDef );
  1363. nodeDef.extensions = nodeDef.extensions || {};
  1364. nodeDef.extensions[ this.name ] = { light: lights.length - 1 };
  1365. }
  1366. }
  1367. /**
  1368. * Unlit Materials Extension
  1369. *
  1370. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit
  1371. */
  1372. class GLTFMaterialsUnlitExtension {
  1373. constructor( writer ) {
  1374. this.writer = writer;
  1375. this.name = 'KHR_materials_unlit';
  1376. }
  1377. writeMaterial( material, materialDef ) {
  1378. if ( ! material.isMeshBasicMaterial ) return;
  1379. const writer = this.writer;
  1380. const extensionsUsed = writer.extensionsUsed;
  1381. materialDef.extensions = materialDef.extensions || {};
  1382. materialDef.extensions[ this.name ] = {};
  1383. extensionsUsed[ this.name ] = true;
  1384. materialDef.pbrMetallicRoughness.metallicFactor = 0.0;
  1385. materialDef.pbrMetallicRoughness.roughnessFactor = 0.9;
  1386. }
  1387. }
  1388. /**
  1389. * Specular-Glossiness Extension
  1390. *
  1391. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness
  1392. */
  1393. class GLTFMaterialsPBRSpecularGlossiness {
  1394. constructor( writer ) {
  1395. this.writer = writer;
  1396. this.name = 'KHR_materials_pbrSpecularGlossiness';
  1397. }
  1398. writeMaterial( material, materialDef ) {
  1399. if ( ! material.isGLTFSpecularGlossinessMaterial ) return;
  1400. const writer = this.writer;
  1401. const extensionsUsed = writer.extensionsUsed;
  1402. const extensionDef = {};
  1403. if ( materialDef.pbrMetallicRoughness.baseColorFactor ) {
  1404. extensionDef.diffuseFactor = materialDef.pbrMetallicRoughness.baseColorFactor;
  1405. }
  1406. const specularFactor = [ 1, 1, 1 ];
  1407. material.specular.toArray( specularFactor, 0 );
  1408. extensionDef.specularFactor = specularFactor;
  1409. extensionDef.glossinessFactor = material.glossiness;
  1410. if ( materialDef.pbrMetallicRoughness.baseColorTexture ) {
  1411. extensionDef.diffuseTexture = materialDef.pbrMetallicRoughness.baseColorTexture;
  1412. }
  1413. if ( material.specularMap ) {
  1414. const specularMapDef = { index: writer.processTexture( material.specularMap ) };
  1415. writer.applyTextureTransform( specularMapDef, material.specularMap );
  1416. extensionDef.specularGlossinessTexture = specularMapDef;
  1417. }
  1418. materialDef.extensions = materialDef.extensions || {};
  1419. materialDef.extensions[ this.name ] = extensionDef;
  1420. extensionsUsed[ this.name ] = true;
  1421. }
  1422. }
  1423. /**
  1424. * Clearcoat Materials Extension
  1425. *
  1426. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_clearcoat
  1427. */
  1428. class GLTFMaterialsClearcoatExtension {
  1429. constructor( writer ) {
  1430. this.writer = writer;
  1431. this.name = 'KHR_materials_clearcoat';
  1432. }
  1433. writeMaterial( material, materialDef ) {
  1434. if ( ! material.isMeshPhysicalMaterial ) return;
  1435. const writer = this.writer;
  1436. const extensionsUsed = writer.extensionsUsed;
  1437. const extensionDef = {};
  1438. extensionDef.clearcoatFactor = material.clearcoat;
  1439. if ( material.clearcoatMap ) {
  1440. const clearcoatMapDef = { index: writer.processTexture( material.clearcoatMap ) };
  1441. writer.applyTextureTransform( clearcoatMapDef, material.clearcoatMap );
  1442. extensionDef.clearcoatTexture = clearcoatMapDef;
  1443. }
  1444. extensionDef.clearcoatRoughnessFactor = material.clearcoatRoughness;
  1445. if ( material.clearcoatRoughnessMap ) {
  1446. const clearcoatRoughnessMapDef = { index: writer.processTexture( material.clearcoatRoughnessMap ) };
  1447. writer.applyTextureTransform( clearcoatRoughnessMapDef, material.clearcoatRoughnessMap );
  1448. extensionDef.clearcoatRoughnessTexture = clearcoatRoughnessMapDef;
  1449. }
  1450. if ( material.clearcoatNormalMap ) {
  1451. const clearcoatNormalMapDef = { index: writer.processTexture( material.clearcoatNormalMap ) };
  1452. writer.applyTextureTransform( clearcoatNormalMapDef, material.clearcoatNormalMap );
  1453. extensionDef.clearcoatNormalTexture = clearcoatNormalMapDef;
  1454. }
  1455. materialDef.extensions = materialDef.extensions || {};
  1456. materialDef.extensions[ this.name ] = extensionDef;
  1457. extensionsUsed[ this.name ] = true;
  1458. }
  1459. }
  1460. /**
  1461. * Transmission Materials Extension
  1462. *
  1463. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_transmission
  1464. */
  1465. class GLTFMaterialsTransmissionExtension {
  1466. constructor( writer ) {
  1467. this.writer = writer;
  1468. this.name = 'KHR_materials_transmission';
  1469. }
  1470. writeMaterial( material, materialDef ) {
  1471. if ( ! material.isMeshPhysicalMaterial || material.transmission === 0 ) return;
  1472. const writer = this.writer;
  1473. const extensionsUsed = writer.extensionsUsed;
  1474. const extensionDef = {};
  1475. extensionDef.transmissionFactor = material.transmission;
  1476. if ( material.transmissionMap ) {
  1477. const transmissionMapDef = { index: writer.processTexture( material.transmissionMap ) };
  1478. writer.applyTextureTransform( transmissionMapDef, material.transmissionMap );
  1479. extensionDef.transmissionTexture = transmissionMapDef;
  1480. }
  1481. materialDef.extensions = materialDef.extensions || {};
  1482. materialDef.extensions[ this.name ] = extensionDef;
  1483. extensionsUsed[ this.name ] = true;
  1484. }
  1485. }
  1486. /**
  1487. * Materials Volume Extension
  1488. *
  1489. * Specification: https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_volume
  1490. */
  1491. class GLTFMaterialsVolumeExtension {
  1492. constructor( writer ) {
  1493. this.writer = writer;
  1494. this.name = 'KHR_materials_volume';
  1495. }
  1496. writeMaterial( material, materialDef ) {
  1497. if ( ! material.isMeshPhysicalMaterial || material.transmission === 0 ) return;
  1498. const writer = this.writer;
  1499. const extensionsUsed = writer.extensionsUsed;
  1500. const extensionDef = {};
  1501. extensionDef.thicknessFactor = material.thickness;
  1502. if ( material.thicknessMap ) {
  1503. const thicknessMapDef = { index: writer.processTexture( material.thicknessMap ) };
  1504. writer.applyTextureTransform( thicknessMapDef, material.thicknessMap );
  1505. extensionDef.thicknessTexture = thicknessMapDef;
  1506. }
  1507. extensionDef.attenuationDistance = material.attenuationDistance;
  1508. extensionDef.attenuationColor = material.attenuationColor.toArray();
  1509. materialDef.extensions = materialDef.extensions || {};
  1510. materialDef.extensions[ this.name ] = extensionDef;
  1511. extensionsUsed[ this.name ] = true;
  1512. }
  1513. }
  1514. /**
  1515. * Static utility functions
  1516. */
  1517. GLTFExporter.Utils = {
  1518. insertKeyframe: function ( track, time ) {
  1519. const tolerance = 0.001; // 1ms
  1520. const valueSize = track.getValueSize();
  1521. const times = new track.TimeBufferType( track.times.length + 1 );
  1522. const values = new track.ValueBufferType( track.values.length + valueSize );
  1523. const interpolant = track.createInterpolant( new track.ValueBufferType( valueSize ) );
  1524. let index;
  1525. if ( track.times.length === 0 ) {
  1526. times[ 0 ] = time;
  1527. for ( let i = 0; i < valueSize; i ++ ) {
  1528. values[ i ] = 0;
  1529. }
  1530. index = 0;
  1531. } else if ( time < track.times[ 0 ] ) {
  1532. if ( Math.abs( track.times[ 0 ] - time ) < tolerance ) return 0;
  1533. times[ 0 ] = time;
  1534. times.set( track.times, 1 );
  1535. values.set( interpolant.evaluate( time ), 0 );
  1536. values.set( track.values, valueSize );
  1537. index = 0;
  1538. } else if ( time > track.times[ track.times.length - 1 ] ) {
  1539. if ( Math.abs( track.times[ track.times.length - 1 ] - time ) < tolerance ) {
  1540. return track.times.length - 1;
  1541. }
  1542. times[ times.length - 1 ] = time;
  1543. times.set( track.times, 0 );
  1544. values.set( track.values, 0 );
  1545. values.set( interpolant.evaluate( time ), track.values.length );
  1546. index = times.length - 1;
  1547. } else {
  1548. for ( let i = 0; i < track.times.length; i ++ ) {
  1549. if ( Math.abs( track.times[ i ] - time ) < tolerance ) return i;
  1550. if ( track.times[ i ] < time && track.times[ i + 1 ] > time ) {
  1551. times.set( track.times.slice( 0, i + 1 ), 0 );
  1552. times[ i + 1 ] = time;
  1553. times.set( track.times.slice( i + 1 ), i + 2 );
  1554. values.set( track.values.slice( 0, ( i + 1 ) * valueSize ), 0 );
  1555. values.set( interpolant.evaluate( time ), ( i + 1 ) * valueSize );
  1556. values.set( track.values.slice( ( i + 1 ) * valueSize ), ( i + 2 ) * valueSize );
  1557. index = i + 1;
  1558. break;
  1559. }
  1560. }
  1561. }
  1562. track.times = times;
  1563. track.values = values;
  1564. return index;
  1565. },
  1566. mergeMorphTargetTracks: function ( clip, root ) {
  1567. const tracks = [];
  1568. const mergedTracks = {};
  1569. const sourceTracks = clip.tracks;
  1570. for ( let i = 0; i < sourceTracks.length; ++ i ) {
  1571. let sourceTrack = sourceTracks[ i ];
  1572. const sourceTrackBinding = PropertyBinding.parseTrackName( sourceTrack.name );
  1573. const sourceTrackNode = PropertyBinding.findNode( root, sourceTrackBinding.nodeName );
  1574. if ( sourceTrackBinding.propertyName !== 'morphTargetInfluences' || sourceTrackBinding.propertyIndex === undefined ) {
  1575. // Tracks that don't affect morph targets, or that affect all morph targets together, can be left as-is.
  1576. tracks.push( sourceTrack );
  1577. continue;
  1578. }
  1579. if ( sourceTrack.createInterpolant !== sourceTrack.InterpolantFactoryMethodDiscrete
  1580. && sourceTrack.createInterpolant !== sourceTrack.InterpolantFactoryMethodLinear ) {
  1581. if ( sourceTrack.createInterpolant.isInterpolantFactoryMethodGLTFCubicSpline ) {
  1582. // This should never happen, because glTF morph target animations
  1583. // affect all targets already.
  1584. throw new Error( 'THREE.GLTFExporter: Cannot merge tracks with glTF CUBICSPLINE interpolation.' );
  1585. }
  1586. console.warn( 'THREE.GLTFExporter: Morph target interpolation mode not yet supported. Using LINEAR instead.' );
  1587. sourceTrack = sourceTrack.clone();
  1588. sourceTrack.setInterpolation( InterpolateLinear );
  1589. }
  1590. const targetCount = sourceTrackNode.morphTargetInfluences.length;
  1591. const targetIndex = sourceTrackNode.morphTargetDictionary[ sourceTrackBinding.propertyIndex ];
  1592. if ( targetIndex === undefined ) {
  1593. throw new Error( 'THREE.GLTFExporter: Morph target name not found: ' + sourceTrackBinding.propertyIndex );
  1594. }
  1595. let mergedTrack;
  1596. // If this is the first time we've seen this object, create a new
  1597. // track to store merged keyframe data for each morph target.
  1598. if ( mergedTracks[ sourceTrackNode.uuid ] === undefined ) {
  1599. mergedTrack = sourceTrack.clone();
  1600. const values = new mergedTrack.ValueBufferType( targetCount * mergedTrack.times.length );
  1601. for ( let j = 0; j < mergedTrack.times.length; j ++ ) {
  1602. values[ j * targetCount + targetIndex ] = mergedTrack.values[ j ];
  1603. }
  1604. // We need to take into consideration the intended target node
  1605. // of our original un-merged morphTarget animation.
  1606. mergedTrack.name = ( sourceTrackBinding.nodeName || '' ) + '.morphTargetInfluences';
  1607. mergedTrack.values = values;
  1608. mergedTracks[ sourceTrackNode.uuid ] = mergedTrack;
  1609. tracks.push( mergedTrack );
  1610. continue;
  1611. }
  1612. const sourceInterpolant = sourceTrack.createInterpolant( new sourceTrack.ValueBufferType( 1 ) );
  1613. mergedTrack = mergedTracks[ sourceTrackNode.uuid ];
  1614. // For every existing keyframe of the merged track, write a (possibly
  1615. // interpolated) value from the source track.
  1616. for ( let j = 0; j < mergedTrack.times.length; j ++ ) {
  1617. mergedTrack.values[ j * targetCount + targetIndex ] = sourceInterpolant.evaluate( mergedTrack.times[ j ] );
  1618. }
  1619. // For every existing keyframe of the source track, write a (possibly
  1620. // new) keyframe to the merged track. Values from the previous loop may
  1621. // be written again, but keyframes are de-duplicated.
  1622. for ( let j = 0; j < sourceTrack.times.length; j ++ ) {
  1623. const keyframeIndex = this.insertKeyframe( mergedTrack, sourceTrack.times[ j ] );
  1624. mergedTrack.values[ keyframeIndex * targetCount + targetIndex ] = sourceTrack.values[ j ];
  1625. }
  1626. }
  1627. clip.tracks = tracks;
  1628. return clip;
  1629. }
  1630. };
  1631. export { GLTFExporter };