LoaderSupport.js 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100
  1. /**
  2. * @author Kai Salmen / https://kaisalmen.de
  3. * Development repository: https://github.com/kaisalmen/WWOBJLoader
  4. */
  5. 'use strict';
  6. if ( THREE.LoaderSupport === undefined ) { THREE.LoaderSupport = {} }
  7. /**
  8. * Validation functions
  9. * @class
  10. */
  11. THREE.LoaderSupport.Validator = {
  12. /**
  13. * If given input is null or undefined, false is returned otherwise true.
  14. *
  15. * @param input Anything
  16. * @returns {boolean}
  17. */
  18. isValid: function( input ) {
  19. return ( input !== null && input !== undefined );
  20. },
  21. /**
  22. * If given input is null or undefined, the defaultValue is returned otherwise the given input.
  23. *
  24. * @param input Anything
  25. * @param defaultValue Anything
  26. * @returns {*}
  27. */
  28. verifyInput: function( input, defaultValue ) {
  29. return ( input === null || input === undefined ) ? defaultValue : input;
  30. }
  31. };
  32. /**
  33. * Callbacks utilized by functions working with WWLoader implementations
  34. * @class
  35. */
  36. THREE.LoaderSupport.Callbacks = (function () {
  37. var Validator = THREE.LoaderSupport.Validator;
  38. function Callbacks() {
  39. this.onProgress = null;
  40. this.onMeshAlter = null;
  41. this.onLoad = null;
  42. }
  43. /**
  44. * Register callback function that is invoked by internal function "announceProgress" to print feedback.
  45. * @memberOf THREE.LoaderSupport.Callbacks
  46. *
  47. * @param {callback} callbackOnProgress Callback function for described functionality
  48. */
  49. Callbacks.prototype.setCallbackOnProgress = function ( callbackOnProgress ) {
  50. this.onProgress = Validator.verifyInput( callbackOnProgress, this.onProgress );
  51. };
  52. /**
  53. * Register callback function that is called every time a mesh was loaded.
  54. * Use {@link THREE.LoaderSupport.LoadedMeshUserOverride} for alteration instructions (geometry, material or disregard mesh).
  55. * @memberOf THREE.LoaderSupport.Callbacks
  56. *
  57. * @param {callback} callbackOnMeshAlter Callback function for described functionality
  58. */
  59. Callbacks.prototype.setCallbackOnMeshAlter = function ( callbackOnMeshAlter ) {
  60. this.onMeshAlter = Validator.verifyInput( callbackOnMeshAlter, this.onMeshAlter );
  61. };
  62. /**
  63. * Register callback function that is called once loading of the complete model is completed.
  64. * @memberOf THREE.LoaderSupport.Callbacks
  65. *
  66. * @param {callback} callbackOnLoad Callback function for described functionality
  67. */
  68. Callbacks.prototype.setCallbackOnLoad = function ( callbackOnLoad ) {
  69. this.onLoad = Validator.verifyInput( callbackOnLoad, this.onLoad );
  70. };
  71. return Callbacks;
  72. })();
  73. /**
  74. * Global callback definition
  75. * @class
  76. */
  77. THREE.LoaderSupport.Builder = (function () {
  78. var Validator = THREE.LoaderSupport.Validator;
  79. function Builder() {
  80. this.callbacks = new THREE.LoaderSupport.Callbacks();
  81. this.materials = [];
  82. this.materialNames = [];
  83. this._createDefaultMaterials();
  84. }
  85. Builder.prototype._createDefaultMaterials = function () {
  86. var defaultMaterial = new THREE.MeshStandardMaterial( { color: 0xDCF1FF } );
  87. defaultMaterial.name = 'defaultMaterial';
  88. if ( ! Validator.isValid( this.materials[ defaultMaterial ] ) ) {
  89. this.materials[ defaultMaterial.name ] = defaultMaterial;
  90. }
  91. this.materialNames.push( defaultMaterial.name );
  92. var vertexColorMaterial = new THREE.MeshStandardMaterial( { color: 0xDCF1FF } );
  93. vertexColorMaterial.name = 'vertexColorMaterial';
  94. vertexColorMaterial.vertexColors = THREE.VertexColors;
  95. if ( ! Validator.isValid( this.materials[ vertexColorMaterial.name ] ) ) {
  96. this.materials[ vertexColorMaterial.name ] = vertexColorMaterial;
  97. }
  98. this.materialNames.push( vertexColorMaterial.name );
  99. };
  100. /**
  101. * Set materials loaded by any supplier of an Array of {@link THREE.Material}.
  102. * @memberOf THREE.LoaderSupport.Builder
  103. *
  104. * @param {THREE.Material[]} materials Array of {@link THREE.Material}
  105. */
  106. Builder.prototype.setMaterials = function ( materials ) {
  107. if ( Validator.isValid( materials ) && Object.keys( materials ).length > 0 ) {
  108. var materialName;
  109. for ( materialName in materials ) {
  110. if ( materials.hasOwnProperty( materialName ) && ! this.materials.hasOwnProperty( materialName) ) {
  111. this.materials[ materialName ] = materials[ materialName ];
  112. }
  113. }
  114. // always reset list of names as they are an array
  115. this.materialNames = [];
  116. for ( materialName in materials ) this.materialNames.push( materialName );
  117. }
  118. };
  119. Builder.prototype._setCallbacks = function ( callbackOnProgress, callbackOnMeshAlter, callbackOnLoad ) {
  120. this.callbacks.setCallbackOnProgress( callbackOnProgress );
  121. this.callbacks.setCallbackOnMeshAlter( callbackOnMeshAlter );
  122. this.callbacks.setCallbackOnLoad( callbackOnLoad );
  123. };
  124. /**
  125. * Builds one or multiple meshes from the data described in the payload (buffers, params, material info,
  126. *
  127. * @param {Object} payload buffers, params, materials
  128. * @returns {THREE.Mesh[]} mesh Array of {@link THREE.Mesh}
  129. */
  130. Builder.prototype.buildMeshes = function ( payload ) {
  131. var meshName = payload.params.meshName;
  132. var bufferGeometry = new THREE.BufferGeometry();
  133. bufferGeometry.addAttribute( 'position', new THREE.BufferAttribute( new Float32Array( payload.buffers.vertices ), 3 ) );
  134. if ( Validator.isValid( payload.buffers.indices ) ) {
  135. bufferGeometry.setIndex( new THREE.BufferAttribute( new Uint32Array( payload.buffers.indices ), 1 ));
  136. }
  137. var haveVertexColors = Validator.isValid( payload.buffers.colors );
  138. if ( haveVertexColors ) {
  139. bufferGeometry.addAttribute( 'color', new THREE.BufferAttribute( new Float32Array( payload.buffers.colors ), 3 ) );
  140. }
  141. if ( Validator.isValid( payload.buffers.normals ) ) {
  142. bufferGeometry.addAttribute( 'normal', new THREE.BufferAttribute( new Float32Array( payload.buffers.normals ), 3 ) );
  143. } else {
  144. bufferGeometry.computeVertexNormals();
  145. }
  146. if ( Validator.isValid( payload.buffers.uvs ) ) {
  147. bufferGeometry.addAttribute( 'uv', new THREE.BufferAttribute( new Float32Array( payload.buffers.uvs ), 2 ) );
  148. }
  149. var materialDescriptions = payload.materials.materialDescriptions;
  150. var materialDescription;
  151. var material;
  152. var materialName;
  153. var createMultiMaterial = payload.materials.multiMaterial;
  154. var multiMaterials = [];
  155. var key;
  156. for ( key in materialDescriptions ) {
  157. materialDescription = materialDescriptions[ key ];
  158. material = this.materials[ materialDescription.name ];
  159. material = Validator.verifyInput( material, this.materials[ 'defaultMaterial' ] );
  160. if ( haveVertexColors ) {
  161. if ( material.hasOwnProperty( 'vertexColors' ) ) {
  162. materialName = material.name + '_vertexColor';
  163. var materialClone = this.materials[ materialName ];
  164. if ( ! Validator.isValid( materialClone ) ) {
  165. materialClone = material.clone();
  166. materialClone.name = materialName;
  167. materialClone.vertexColors = THREE.VertexColors;
  168. this.materials[ materialName ] = materialClone;
  169. }
  170. material = materialClone;
  171. } else {
  172. material = this.materials[ 'vertexColorMaterial' ];
  173. }
  174. }
  175. if ( materialDescription.flat ) {
  176. materialName = material.name + '_flat';
  177. var materialClone = this.materials[ materialName ];
  178. if ( ! Validator.isValid( materialClone ) ) {
  179. materialClone = material.clone();
  180. materialClone.name = materialName;
  181. materialClone.flatShading = true;
  182. this.materials[ materialName ] = materialClone;
  183. }
  184. material = materialClone;
  185. }
  186. if ( createMultiMaterial ) multiMaterials.push( material );
  187. }
  188. if ( createMultiMaterial ) {
  189. material = multiMaterials;
  190. var materialGroups = payload.materials.materialGroups;
  191. var materialGroup;
  192. for ( key in materialGroups ) {
  193. materialGroup = materialGroups[ key ];
  194. bufferGeometry.addGroup( materialGroup.start, materialGroup.count, materialGroup.index );
  195. }
  196. }
  197. var meshes = [];
  198. var mesh;
  199. var callbackOnMeshAlter = this.callbacks.onMeshAlter;
  200. var callbackOnMeshAlterResult;
  201. var useOrgMesh = true;
  202. if ( Validator.isValid( callbackOnMeshAlter ) ) {
  203. callbackOnMeshAlterResult = callbackOnMeshAlter( meshName, bufferGeometry, material );
  204. if ( Validator.isValid( callbackOnMeshAlterResult ) ) {
  205. if ( ! callbackOnMeshAlterResult.isDisregardMesh() && callbackOnMeshAlterResult.providesAlteredMeshes() ) {
  206. for ( var i in callbackOnMeshAlterResult.meshes ) {
  207. meshes.push( callbackOnMeshAlterResult.meshes[ i ] );
  208. }
  209. }
  210. useOrgMesh = false;
  211. }
  212. }
  213. if ( useOrgMesh ) {
  214. mesh = new THREE.Mesh( bufferGeometry, material );
  215. mesh.name = meshName;
  216. meshes.push( mesh );
  217. }
  218. var progressMessage;
  219. if ( Validator.isValid( meshes ) && meshes.length > 0 ) {
  220. var meshNames = [];
  221. for ( var i in meshes ) {
  222. mesh = meshes[ i ];
  223. meshNames[ i ] = mesh.name;
  224. }
  225. progressMessage = 'Adding mesh(es) (' + meshNames.length + ': ' + meshNames + ') from input mesh: ' + meshName;
  226. } else {
  227. progressMessage = 'Not adding mesh: ' + meshName;
  228. }
  229. var callbackOnProgress = this.callbacks.onProgress;
  230. if ( Validator.isValid( callbackOnProgress ) ) callbackOnProgress( progressMessage );
  231. return meshes;
  232. };
  233. return Builder;
  234. })();
  235. /**
  236. * Global callback definition
  237. * @class
  238. */
  239. THREE.LoaderSupport.Commons = (function () {
  240. var Validator = THREE.LoaderSupport.Validator;
  241. function Commons( manager ) {
  242. this.manager = Validator.verifyInput( manager, THREE.DefaultLoadingManager );
  243. this.modelName = '';
  244. this.instanceNo = 0;
  245. this.path = '';
  246. this.debug = false;
  247. this.loaderRootNode = new THREE.Group();
  248. this.builder = new THREE.LoaderSupport.Builder();
  249. this.callbacks = new THREE.LoaderSupport.Callbacks();
  250. };
  251. Commons.prototype._applyPrepData = function ( prepData ) {
  252. if ( Validator.isValid( prepData ) ) {
  253. this.setModelName( prepData.modelName );
  254. this.setStreamMeshesTo( prepData.streamMeshesTo );
  255. this.builder.setMaterials( prepData.materials );
  256. this._setCallbacks( prepData.getCallbacks().onProgress, prepData.getCallbacks().onMeshAlter, prepData.getCallbacks().onLoad );
  257. }
  258. };
  259. Commons.prototype._setCallbacks = function ( callbackOnProgress, callbackOnMeshAlter, callbackOnLoad ) {
  260. this.callbacks.setCallbackOnProgress( callbackOnProgress );
  261. this.callbacks.setCallbackOnMeshAlter( callbackOnMeshAlter );
  262. this.callbacks.setCallbackOnLoad( callbackOnLoad );
  263. this.builder._setCallbacks( callbackOnProgress, callbackOnMeshAlter, callbackOnLoad );
  264. };
  265. Commons.prototype.setModelName = function ( modelName ) {
  266. this.modelName = Validator.verifyInput( modelName, this.modelName );
  267. };
  268. /**
  269. * The URL of the base path
  270. * @param {string} path
  271. */
  272. Commons.prototype.setPath = function ( path ) {
  273. this.path = Validator.verifyInput( path, this.path );
  274. };
  275. /**
  276. * Allows to set debug mode.
  277. * @memberOf THREE.LoaderSupport.Commons
  278. *
  279. * @param {boolean} enabled
  280. */
  281. Commons.prototype.setDebug = function ( enabled ) {
  282. this.debug = enabled;
  283. };
  284. /**
  285. * Set the node where the loaded objects will be attached directly.
  286. * @memberOf THREE.LoaderSupport.Commons
  287. *
  288. * @param {THREE.Object3D} streamMeshesTo Attached scenegraph object where meshes will be attached live
  289. */
  290. Commons.prototype.setStreamMeshesTo = function ( streamMeshesTo ) {
  291. this.loaderRootNode = Validator.verifyInput( streamMeshesTo, this.loaderRootNode );
  292. };
  293. /**
  294. * Set materials loaded by MTLLoader or any other supplier of an Array of {@link THREE.Material}.
  295. * @memberOf THREE.LoaderSupport.Commons
  296. *
  297. * @param {THREE.Material[]} materials Array of {@link THREE.Material}
  298. */
  299. Commons.prototype.setMaterials = function ( materials ) {
  300. this.builder.setMaterials( materials );
  301. };
  302. /**
  303. * Announce feedback which is give to the registered callbacks and logged if debug is enabled
  304. * @memberOf THREE.LoaderSupport.Commons
  305. *
  306. * @param baseText
  307. * @param text
  308. */
  309. Commons.prototype.onProgress = function ( baseText, text ) {
  310. var content = Validator.isValid( baseText ) ? baseText: '';
  311. content = Validator.isValid( text ) ? content + ' ' + text : content;
  312. if ( Validator.isValid( this.callbacks.onProgress ) ) this.callbacks.onProgress( content, this.modelName, this.instanceNo );
  313. if ( this.debug ) console.log( content );
  314. };
  315. return Commons;
  316. })();
  317. /**
  318. * Object to return by {@link THREE.LoaderSupport.Commons}.callbacks.meshLoaded.
  319. * Used to disregard a certain mesh or to return one to many created meshes.
  320. * @class
  321. *
  322. * @param {boolean} disregardMesh=false Tell implementation to completely disregard this mesh
  323. */
  324. THREE.LoaderSupport.LoadedMeshUserOverride = (function () {
  325. function LoadedMeshUserOverride( disregardMesh, alteredMesh ) {
  326. this.disregardMesh = disregardMesh === true;
  327. this.alteredMesh = alteredMesh === true;
  328. this.meshes = [];
  329. }
  330. /**
  331. * Add a mesh created within callback.
  332. *
  333. * @memberOf THREE.OBJLoader2.LoadedMeshUserOverride
  334. *
  335. * @param {THREE.Mesh} mesh
  336. */
  337. LoadedMeshUserOverride.prototype.addMesh = function ( mesh ) {
  338. this.meshes.push( mesh );
  339. };
  340. /**
  341. * Answers if mesh shall be disregarded completely.
  342. *
  343. * @returns {boolean}
  344. */
  345. LoadedMeshUserOverride.prototype.isDisregardMesh = function () {
  346. return this.disregardMesh;
  347. };
  348. /**
  349. * Answers if new mesh(es) were created.
  350. *
  351. * @returns {boolean}
  352. */
  353. LoadedMeshUserOverride.prototype.providesAlteredMeshes = function () {
  354. return this.alteredMesh;
  355. };
  356. return LoadedMeshUserOverride;
  357. })();
  358. /**
  359. * A resource description used by {@link THREE.LoaderSupport.PrepData} and others.
  360. * @class
  361. *
  362. * @param {string} url URL to the file
  363. * @param {string} extension The file extension (type)
  364. */
  365. THREE.LoaderSupport.ResourceDescriptor = (function () {
  366. var Validator = THREE.LoaderSupport.Validator;
  367. function ResourceDescriptor( url, extension ) {
  368. var urlParts = url.split( '/' );
  369. if ( urlParts.length < 2 ) {
  370. this.path = null;
  371. this.name = this.name = url;
  372. this.url = url;
  373. } else {
  374. this.path = Validator.verifyInput( urlParts.slice( 0, urlParts.length - 1).join( '/' ) + '/', null );
  375. this.name = Validator.verifyInput( urlParts[ urlParts.length - 1 ], null );
  376. this.url = url;
  377. }
  378. this.extension = Validator.verifyInput( extension, "default" );
  379. this.extension = this.extension.trim();
  380. this.content = null;
  381. }
  382. /**
  383. * Set the content of this resource (String)
  384. * @memberOf THREE.LoaderSupport.ResourceDescriptor
  385. *
  386. * @param {Object} content The file content as arraybuffer or text
  387. */
  388. ResourceDescriptor.prototype.setContent = function ( content ) {
  389. this.content = Validator.verifyInput( content, null );
  390. };
  391. return ResourceDescriptor;
  392. })();
  393. /**
  394. * Base class for configuration of prepareRun when using {@link THREE.LoaderSupport.WorkerSupport}.
  395. * @class
  396. */
  397. THREE.LoaderSupport.PrepData = (function () {
  398. var Validator = THREE.LoaderSupport.Validator;
  399. function PrepData( modelName ) {
  400. this.modelName = Validator.verifyInput( modelName, '' );
  401. this.resources = [];
  402. this.streamMeshesTo = null;
  403. this.materialPerSmoothingGroup = false;
  404. this.callbacks = new THREE.LoaderSupport.Callbacks();
  405. this.crossOrigin;
  406. this.useAsync = false;
  407. }
  408. /**
  409. * {@link THREE.Object3D} where meshes will be attached.
  410. * @memberOf THREE.LoaderSupport.PrepData
  411. *
  412. * @param {THREE.Object3D} streamMeshesTo Scene graph object
  413. */
  414. PrepData.prototype.setStreamMeshesTo = function ( streamMeshesTo ) {
  415. this.streamMeshesTo = Validator.verifyInput( streamMeshesTo, null );
  416. };
  417. /**
  418. * Tells whether a material shall be created per smoothing group
  419. * @memberOf THREE.LoaderSupport.PrepData
  420. *
  421. * @param {boolean} materialPerSmoothingGroup=false Default is false
  422. */
  423. PrepData.prototype.setMaterialPerSmoothingGroup = function ( materialPerSmoothingGroup ) {
  424. this.materialPerSmoothingGroup = materialPerSmoothingGroup;
  425. };
  426. /**
  427. * Returns all callbacks as {@link THREE.LoaderSupport.Callbacks}
  428. * @memberOf THREE.LoaderSupport.PrepData
  429. *
  430. * @returns {THREE.LoaderSupport.Callbacks}
  431. */
  432. PrepData.prototype.getCallbacks = function () {
  433. return this.callbacks;
  434. };
  435. /**
  436. * Sets the CORS string to be used.
  437. * @memberOf THREE.LoaderSupport.PrepData
  438. *
  439. * @param {string} crossOrigin CORS value
  440. */
  441. PrepData.prototype.setCrossOrigin = function ( crossOrigin ) {
  442. this.crossOrigin = crossOrigin;
  443. };
  444. /**
  445. * Add a resource description
  446. * @memberOf THREE.LoaderSupport.PrepData
  447. *
  448. * @param {THREE.LoaderSupport.ResourceDescriptor} The resource description
  449. */
  450. PrepData.prototype.addResource = function ( resource ) {
  451. this.resources.push( resource );
  452. };
  453. /**
  454. *
  455. * @param {boolean} useAsync
  456. */
  457. PrepData.prototype.setUseAsync = function ( useAsync ) {
  458. this.useAsync = useAsync === true;
  459. };
  460. /**
  461. * Clones this object and returns it afterwards.
  462. *
  463. * @returns {@link THREE.LoaderSupport.PrepData}
  464. */
  465. PrepData.prototype.clone = function () {
  466. var clone = new THREE.LoaderSupport.PrepData( this.modelName );
  467. clone.resources = this.resources;
  468. clone.streamMeshesTo = this.streamMeshesTo;
  469. clone.materialPerSmoothingGroup = this.materialPerSmoothingGroup;
  470. clone.callbacks = this.callbacks;
  471. clone.crossOrigin = this.crossOrigin;
  472. clone.useAsync = this.useAsync;
  473. return clone;
  474. };
  475. return PrepData;
  476. })();
  477. THREE.LoaderSupport.WorkerRunnerRefImpl = (function () {
  478. function WorkerRunnerRefImpl() {
  479. var scope = this;
  480. var scopedRunner = function( event ) {
  481. scope.run( event.data );
  482. };
  483. self.addEventListener( 'message', scopedRunner, false );
  484. }
  485. WorkerRunnerRefImpl.prototype.applyProperties = function ( parser, params ) {
  486. var property, funcName, values;
  487. for ( property in params ) {
  488. funcName = 'set' + property.substring( 0, 1 ).toLocaleUpperCase() + property.substring( 1 );
  489. values = params[ property ];
  490. if ( parser.hasOwnProperty( property ) ) {
  491. if ( typeof parser[ funcName ] === 'function' ) {
  492. parser[ funcName ]( values );
  493. } else {
  494. parser[ property ] = values;
  495. }
  496. }
  497. }
  498. };
  499. WorkerRunnerRefImpl.prototype.run = function ( payload ) {
  500. if ( payload.cmd === 'run' ) {
  501. console.log( 'WorkerRunner: Starting Run...' );
  502. var callbacks = {
  503. callbackBuilder: function ( payload ) {
  504. self.postMessage( payload );
  505. },
  506. callbackProgress: function ( message ) {
  507. console.log( 'WorkerRunner: progress: ' + message );
  508. }
  509. };
  510. // Parser is expected to be named as such
  511. var parser = new Parser();
  512. this.applyProperties( parser, payload.params );
  513. this.applyProperties( parser, payload.materials );
  514. this.applyProperties( parser, callbacks );
  515. parser.parse( payload.buffers.input );
  516. console.log( 'WorkerRunner: Run complete!' );
  517. callbacks.callbackBuilder( {
  518. cmd: 'complete',
  519. msg: 'WorkerRunner completed run.'
  520. } );
  521. } else {
  522. console.error( 'WorkerRunner: Received unknown command: ' + payload.cmd );
  523. }
  524. };
  525. return WorkerRunnerRefImpl;
  526. })();
  527. THREE.LoaderSupport.WorkerSupport = (function () {
  528. var WORKER_SUPPORT_VERSION = '1.0.0-dev';
  529. var Validator = THREE.LoaderSupport.Validator;
  530. function WorkerSupport() {
  531. console.log( "Using THREE.LoaderSupport.WorkerSupport version: " + WORKER_SUPPORT_VERSION );
  532. // check worker support first
  533. if ( window.Worker === undefined ) throw "This browser does not support web workers!";
  534. if ( window.Blob === undefined ) throw "This browser does not support Blob!";
  535. if ( typeof window.URL.createObjectURL !== 'function' ) throw "This browser does not support Object creation from URL!";
  536. this.worker = null;
  537. this.workerCode = null;
  538. this.running = false;
  539. this.terminateRequested = false;
  540. this.callbacks = {
  541. builder: null,
  542. onLoad: null
  543. };
  544. }
  545. WorkerSupport.prototype.validate = function ( functionCodeBuilder, forceWorkerReload, runnerImpl ) {
  546. this.running = false;
  547. if ( forceWorkerReload ) {
  548. this.worker = null;
  549. this.workerCode = null;
  550. this.callbacks.builder = null;
  551. this.callbacks.onLoad = null;
  552. }
  553. if ( ! Validator.isValid( this.worker ) ) {
  554. console.log( 'WorkerSupport: Building worker code...' );
  555. console.time( 'buildWebWorkerCode' );
  556. var workerRunner;
  557. if ( Validator.isValid( runnerImpl ) ) {
  558. console.log( 'WorkerSupport: Using "' + runnerImpl.name + '" as Runncer class for worker.');
  559. workerRunner = runnerImpl;
  560. } else {
  561. console.log( 'WorkerSupport: Using DEFAULT "THREE.LoaderSupport.WorkerRunnerRefImpl" as Runncer class for worker.');
  562. workerRunner = THREE.LoaderSupport.WorkerRunnerRefImpl;
  563. }
  564. this.workerCode = functionCodeBuilder( buildObject, buildSingelton );
  565. this.workerCode += buildSingelton( workerRunner.name, workerRunner.name, workerRunner );
  566. this.workerCode += 'new ' + workerRunner.name + '();\n\n';
  567. var blob = new Blob( [ this.workerCode ], { type: 'text/plain' } );
  568. this.worker = new Worker( window.URL.createObjectURL( blob ) );
  569. console.timeEnd( 'buildWebWorkerCode' );
  570. var scope = this;
  571. var receiveWorkerMessage = function ( e ) {
  572. var payload = e.data;
  573. switch ( payload.cmd ) {
  574. case 'meshData':
  575. scope.callbacks.builder( payload );
  576. break;
  577. case 'complete':
  578. scope.callbacks.onLoad( payload.msg );
  579. scope.running = false;
  580. if ( scope.terminateRequested ) {
  581. console.log( 'WorkerSupport: Run is complete. Terminating application on request!' );
  582. if ( Validator.isValid( scope.worker ) ) {
  583. scope.worker.terminate();
  584. }
  585. scope.worker = null;
  586. scope.workerCode = null;
  587. }
  588. break;
  589. default:
  590. console.error( 'WorkerSupport: Received unknown command: ' + payload.cmd );
  591. break;
  592. }
  593. };
  594. this.worker.addEventListener( 'message', receiveWorkerMessage, false );
  595. }
  596. };
  597. WorkerSupport.prototype.setCallbacks = function ( builder, onLoad ) {
  598. this.callbacks = {
  599. builder: builder,
  600. onLoad: onLoad
  601. };
  602. };
  603. var buildObject = function ( fullName, object ) {
  604. var objectString = fullName + ' = {\n';
  605. var part;
  606. for ( var name in object ) {
  607. part = object[ name ];
  608. if ( typeof( part ) === 'string' || part instanceof String ) {
  609. part = part.replace( '\n', '\\n' );
  610. part = part.replace( '\r', '\\r' );
  611. objectString += '\t' + name + ': "' + part + '",\n';
  612. } else if ( part instanceof Array ) {
  613. objectString += '\t' + name + ': [' + part + '],\n';
  614. } else if ( Number.isInteger( part ) ) {
  615. objectString += '\t' + name + ': ' + part + ',\n';
  616. } else if ( typeof part === 'function' ) {
  617. objectString += '\t' + name + ': ' + part + ',\n';
  618. }
  619. }
  620. objectString += '}\n\n';
  621. return objectString;
  622. };
  623. var buildSingelton = function ( fullName, internalName, object ) {
  624. var objectString = fullName + ' = (function () {\n\n';
  625. objectString += '\t' + object.prototype.constructor.toString() + '\n\n';
  626. var funcString;
  627. var objectPart;
  628. for ( var name in object.prototype ) {
  629. objectPart = object.prototype[ name ];
  630. if ( typeof objectPart === 'function' ) {
  631. funcString = objectPart.toString();
  632. objectString += '\t' + internalName + '.prototype.' + name + ' = ' + funcString + ';\n\n';
  633. }
  634. }
  635. objectString += '\treturn ' + internalName + ';\n';
  636. objectString += '})();\n\n';
  637. return objectString;
  638. };
  639. WorkerSupport.prototype.setTerminateRequested = function ( terminateRequested ) {
  640. this.terminateRequested = terminateRequested === true;
  641. };
  642. WorkerSupport.prototype.run = function ( messageObject ) {
  643. if ( ! Validator.isValid( this.callbacks.builder ) ) throw 'Unable to run as no "builder" callback is set.';
  644. if ( ! Validator.isValid( this.callbacks.onLoad ) ) throw 'Unable to run as no "onLoad" callback is set.';
  645. if ( Validator.isValid( this.worker ) ) {
  646. this.running = true;
  647. this.worker.postMessage( messageObject );
  648. }
  649. };
  650. return WorkerSupport;
  651. })();
  652. /**
  653. * Orchestrate loading of multiple OBJ files/data from an instruction queue with a configurable amount of workers (1-16).
  654. * Workflow:
  655. * prepareWorkers
  656. * enqueueForRun
  657. * processQueue
  658. * deregister
  659. *
  660. * @class
  661. */
  662. THREE.LoaderSupport.WorkerDirector = (function () {
  663. var LOADER_WORKER_DIRECTOR_VERSION = '1.0.0-dev';
  664. var Validator = THREE.LoaderSupport.Validator;
  665. var MAX_WEB_WORKER = 16;
  666. var MAX_QUEUE_SIZE = 8192;
  667. function WorkerDirector( classDef ) {
  668. console.log( "Using THREE.LoaderSupport.WorkerDirector version: " + LOADER_WORKER_DIRECTOR_VERSION );
  669. this.maxQueueSize = MAX_QUEUE_SIZE ;
  670. this.maxWebWorkers = MAX_WEB_WORKER;
  671. this.crossOrigin = null;
  672. if ( ! Validator.isValid( classDef ) ) throw 'Provided invalid classDef: ' + classDef;
  673. this.workerDescription = {
  674. classDef: classDef,
  675. globalCallbacks: {},
  676. workerSupports: []
  677. };
  678. this.objectsCompleted = 0;
  679. this.instructionQueue = [];
  680. }
  681. /**
  682. * Returns the maximum length of the instruction queue.
  683. * @memberOf THREE.LoaderSupport.WorkerDirector
  684. *
  685. * @returns {number}
  686. */
  687. WorkerDirector.prototype.getMaxQueueSize = function () {
  688. return this.maxQueueSize;
  689. };
  690. /**
  691. * Returns the maximum number of workers.
  692. * @memberOf THREE.LoaderSupport.WorkerDirector
  693. *
  694. * @returns {number}
  695. */
  696. WorkerDirector.prototype.getMaxWebWorkers = function () {
  697. return this.maxWebWorkers;
  698. };
  699. /**
  700. * Sets the CORS string to be used.
  701. * @memberOf THREE.LoaderSupport.WorkerDirector
  702. *
  703. * @param {string} crossOrigin CORS value
  704. */
  705. WorkerDirector.prototype.setCrossOrigin = function ( crossOrigin ) {
  706. this.crossOrigin = crossOrigin;
  707. };
  708. /**
  709. * Create or destroy workers according limits. Set the name and register callbacks for dynamically created web workers.
  710. * @memberOf THREE.LoaderSupport.WorkerDirector
  711. *
  712. * @param {THREE.OBJLoader2.WWOBJLoader2.PrepDataCallbacks} globalCallbacks Register global callbacks used by all web workers
  713. * @param {number} maxQueueSize Set the maximum size of the instruction queue (1-1024)
  714. * @param {number} maxWebWorkers Set the maximum amount of workers (1-16)
  715. */
  716. WorkerDirector.prototype.prepareWorkers = function ( globalCallbacks, maxQueueSize, maxWebWorkers ) {
  717. if ( Validator.isValid( globalCallbacks ) ) this.workerDescription.globalCallbacks = globalCallbacks;
  718. this.maxQueueSize = Math.min( maxQueueSize, MAX_QUEUE_SIZE );
  719. this.maxWebWorkers = Math.min( maxWebWorkers, MAX_WEB_WORKER );
  720. this.objectsCompleted = 0;
  721. this.instructionQueue = [];
  722. var start = this.workerDescription.workerSupports.length;
  723. var i;
  724. if ( start < this.maxWebWorkers ) {
  725. for ( i = start; i < this.maxWebWorkers; i++ ) {
  726. this.workerDescription.workerSupports[ i ] = {
  727. workerSupport: new THREE.LoaderSupport.WorkerSupport(),
  728. loader: null
  729. };
  730. }
  731. } else {
  732. for ( i = start - 1; i >= this.maxWebWorkers; i-- ) {
  733. this.workerDescription.workerSupports[ i ].workerSupport.setRequestTerminate( true );
  734. this.workerDescription.workerSupports.pop();
  735. }
  736. }
  737. };
  738. /**
  739. * Store run instructions in internal instructionQueue.
  740. * @memberOf THREE.LoaderSupport.WorkerDirector
  741. *
  742. * @param {Object} prepData Either {@link THREE.LoaderSupport.PrepData}
  743. */
  744. WorkerDirector.prototype.enqueueForRun = function ( prepData ) {
  745. if ( this.instructionQueue.length < this.maxQueueSize ) {
  746. this.instructionQueue.push( prepData );
  747. }
  748. };
  749. /**
  750. * Process the instructionQueue until it is depleted.
  751. * @memberOf THREE.LoaderSupport.WorkerDirector
  752. */
  753. WorkerDirector.prototype.processQueue = function () {
  754. if ( this.instructionQueue.length === 0 ) return;
  755. var length = Math.min( this.maxWebWorkers, this.instructionQueue.length );
  756. for ( var i = 0; i < length; i++ ) {
  757. this._kickWorkerRun( this.instructionQueue[ 0 ], i );
  758. this.instructionQueue.shift();
  759. }
  760. };
  761. WorkerDirector.prototype._kickWorkerRun = function( prepData, workerInstanceNo ) {
  762. var scope = this;
  763. var directorOnLoad = function ( sceneGraphBaseNode, modelName, instanceNo ) {
  764. scope.objectsCompleted++;
  765. var nextPrepData = scope.instructionQueue[ 0 ];
  766. if ( Validator.isValid( nextPrepData ) ) {
  767. scope.instructionQueue.shift();
  768. console.log( '\nAssigning next item from queue to worker (queue length: ' + scope.instructionQueue.length + ')\n\n' );
  769. scope._kickWorkerRun( nextPrepData, instanceNo );
  770. } else if ( scope.instructionQueue.length === 0 ) {
  771. scope.deregister();
  772. }
  773. };
  774. var prepDataCallbacks = prepData.getCallbacks();
  775. var globalCallbacks = this.workerDescription.globalCallbacks;
  776. var wrapperOnLoad = function ( sceneGraphBaseNode, modelName, instanceNo ) {
  777. if ( Validator.isValid( globalCallbacks.onLoad ) ) {
  778. globalCallbacks.onLoad( sceneGraphBaseNode, modelName, instanceNo );
  779. }
  780. if ( Validator.isValid( prepDataCallbacks.onLoad ) ) {
  781. prepDataCallbacks.onLoad( sceneGraphBaseNode, modelName, instanceNo );
  782. }
  783. directorOnLoad( sceneGraphBaseNode, modelName, instanceNo );
  784. };
  785. var wrapperOnProgress = function ( content, modelName, instanceNo ) {
  786. if ( Validator.isValid( globalCallbacks.onProgress ) ) {
  787. globalCallbacks.onProgress( content, modelName, instanceNo );
  788. }
  789. if ( Validator.isValid( prepDataCallbacks.onProgress ) ) {
  790. prepDataCallbacks.onProgress( content, modelName, instanceNo );
  791. }
  792. };
  793. var wrapperOnMeshAlter = function ( meshName, bufferGeometry, material ) {
  794. if ( Validator.isValid( globalCallbacks.onMeshAlter ) ) {
  795. globalCallbacks.onMeshAlter( meshName, bufferGeometry, material );
  796. }
  797. if ( Validator.isValid( prepDataCallbacks.onMeshAlter ) ) {
  798. prepDataCallbacks.onMeshAlter( meshName, bufferGeometry, material );
  799. }
  800. };
  801. var supportTuple = this.workerDescription.workerSupports[ workerInstanceNo ];
  802. supportTuple.loader = this._buildLoader( workerInstanceNo );
  803. var updatedCallbacks = new THREE.LoaderSupport.Callbacks();
  804. updatedCallbacks.setCallbackOnLoad( wrapperOnLoad );
  805. updatedCallbacks.setCallbackOnProgress( wrapperOnProgress );
  806. updatedCallbacks.setCallbackOnMeshAlter( wrapperOnMeshAlter );
  807. prepData.callbacks = updatedCallbacks;
  808. supportTuple.loader.run( prepData, supportTuple.workerSupport );
  809. };
  810. WorkerDirector.prototype._buildLoader = function ( instanceNo ) {
  811. var classDef = this.workerDescription.classDef;
  812. var loader = Object.create( classDef.prototype );
  813. this.workerDescription.classDef.call( loader );
  814. // verify that all required functions are implemented
  815. if ( ! loader.hasOwnProperty( 'instanceNo' ) ) throw classDef.name + ' has no property "instanceNo".';
  816. loader.instanceNo = instanceNo;
  817. if ( ! loader.hasOwnProperty( 'workerSupport' ) ) {
  818. throw classDef.name + ' has no property "workerSupport".';
  819. } else if ( ! classDef.workerSupport instanceof THREE.LoaderSupport.WorkerSupport ) {
  820. throw classDef.name + '.workerSupport is not of type "THREE.LoaderSupport.WorkerSupport".';
  821. }
  822. if ( typeof loader.run !== 'function' ) throw classDef.name + ' has no function "run".';
  823. return loader;
  824. };
  825. /**
  826. * Terminate all workers.
  827. * @memberOf THREE.LoaderSupport.WorkerDirector
  828. */
  829. WorkerDirector.prototype.deregister = function () {
  830. console.log( 'WorkerDirector received the deregister call. Terminating all workers!' );
  831. for ( var i = 0, length = this.workerDescription.workerSupports.length; i < length; i++ ) {
  832. var supportTuple = this.workerDescription.workerSupports[ i ];
  833. supportTuple.workerSupport.setTerminateRequested( true );
  834. console.log( 'Requested termination of worker.' );
  835. var loaderCallbacks = supportTuple.loader.callbacks;
  836. if ( Validator.isValid( loaderCallbacks.onProgress ) ) loaderCallbacks.onProgress( '' );
  837. }
  838. this.workerDescription.workerSupports = [];
  839. this.instructionQueue = [];
  840. };
  841. return WorkerDirector;
  842. })();