GLTFExporter.js 53 KB

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