GLTFExporter.js 51 KB

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