GLTFExporter.js 52 KB

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