LoadingManager.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. 其功能时处理并跟踪已加载和待处理的数据。如果未手动设置加强管理器,则会为加载器创建和使用默认全局实例加载器管理器
  14. - 请参阅 [page:DefaultLoadingManager].<br /><br />
  15. 一般来说,默认的加载管理器已足够使用了,但有时候也需要设置单独的加载器 - 例如,如果你想为对象和纹理显示单独的加载条。
  16. </p>
  17. <h2>例子</h2>
  18. <p>
  19. [example:webgl_loader_fbx WebGL / loader / fbx]<br />
  20. [example:webgl_loader_obj WebGL / loader / obj]<br />
  21. [example:webgl_materials_reflectivity WebGL / materials / reflectivity]<br />
  22. [example:webgl_postprocessing_outline WebGL / postprocesing / outline]
  23. </p>
  24. <p>
  25. 下面的例子将介绍,如何使用加载管理器来跟踪 [page:OBJLoader] 的加载进度流程。
  26. </p>
  27. <code>
  28. var manager = new THREE.LoadingManager();
  29. manager.onStart = function ( url, itemsLoaded, itemsTotal ) {
  30. console.log( 'Started loading file: ' + url + '.\nLoaded ' + itemsLoaded + ' of ' + itemsTotal + ' files.' );
  31. };
  32. manager.onLoad = function ( ) {
  33. console.log( 'Loading complete!');
  34. };
  35. manager.onProgress = function ( url, itemsLoaded, itemsTotal ) {
  36. console.log( 'Loading file: ' + url + '.\nLoaded ' + itemsLoaded + ' of ' + itemsTotal + ' files.' );
  37. };
  38. manager.onError = function ( url ) {
  39. console.log( 'There was an error loading ' + url );
  40. };
  41. var loader = new THREE.OBJLoader( manager );
  42. loader.load( 'file.obj', function ( object ) {
  43. //
  44. } );
  45. </code>
  46. <p>
  47. 除了观察进度流程之外,还可以使用LoadingManager在加载期间覆写资源URL。当某资源来自拖拽事件、
  48. WebSockets、WebRTC或其他API时,此方法可以有所帮助。下面显示了如何使用Blob URL加载内存模型的示例。
  49. </p>
  50. <code>
  51. // 将文件拖入网页时创建的Blob或File对象。
  52. var blobs = {'fish.gltf': blob1, 'diffuse.png': blob2, 'normal.png': blob3};
  53. var manager = new THREE.LoadingManager();
  54. // 使用URL回调初始化加载管理器。
  55. var objectURLs = [];
  56. manager.setURLModifier( ( url ) => {
  57. url = URL.createObjectURL( blobs[ url ] );
  58. objectURLs.push( url );
  59. return url;
  60. } );
  61. // 像通常一样加载,然后撤消blob URL
  62. var loader = new THREE.GLTFLoader( manager );
  63. loader.load( 'fish.gltf', (gltf) => {
  64. scene.add( gltf.scene );
  65. objectURLs.forEach( ( url ) => URL.revokeObjectURL( url ) );
  66. });
  67. </code>
  68. <h2>构造方法</h2>
  69. <h3>[name]( [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  70. <p>
  71. [page:Function onLoad] — (可选) 所有加载器加载完成后,将调用此函数。<br />
  72. [page:Function onProgress] — (可选) 当每个项目完成后,将调用此函数。<br />
  73. [page:Function onError] — (可选) 当一个加载器遇到错误时,将调用此函数。 <br />
  74. 创建一个新的 [name].
  75. </p>
  76. <h2>属性</h2>
  77. <h3>[property:Function onStart]</h3>
  78. <p>
  79. 此换上咋加载开始时,被调用.
  80. 有如下参数:<br />
  81. [page:String url] — 被加载的项的url。<br />
  82. [page:Integer itemsLoaded] — 目前已加载项的个数。<br />
  83. [page:Iteger itemsTotal] — 总共所需要加载项的个数。<br /><br />
  84. 此方法默认时未定义。
  85. </p>
  86. <h3>[property:Function onLoad]</h3>
  87. <p>
  88. 所有的项加载完成后将调用此函数。默认情况下,此方法时未定义的,除非在构造函数中进行传递。
  89. </p>
  90. <h3>[property:Function onProgress]</h3>
  91. <p>
  92. 此方法加载每一个项,加载完成时进行调用。
  93. 有如下参数:<br />
  94. [page:String url] — 被加载的项的url。<br />
  95. [page:Integer itemsLoaded] — 目前已加载项的个数。<br />
  96. [page:Iteger itemsTotal] — 总共所需要加载项的个数。<br /><br />
  97. 默认情况下,此方法时未定义的,除非在构造函数中进行传递。
  98. </p>
  99. <h3>[property:Function onError]</h3>
  100. <p>
  101. 此方法将在任意项加载错误时,进行调用。
  102. 有如下参数:<br />
  103. [page:String url] — 所加载出错误的项的url<br /><br />
  104. 默认情况下,此方法时未定义的,除非在构造函数中进行传递。
  105. </p>
  106. <h2>方法</h2>
  107. <h3>[method:LoadingManager addHandler]( [param:Object regex], [param:Loader loader] )</h3>
  108. <p>
  109. [page:Object regex] — A regular expression.<br />
  110. [page:Loader loader] — The loader.
  111. <p>
  112. Registers a loader with the given regular expression. Can be used to define what loader should be used in
  113. order to load specific files. A typical use case is to overwrite the default loader for textures.
  114. </p>
  115. <code>
  116. // add handler for TGA textures
  117. manager.addHandler( /\.tga$/i, new TGALoader() );
  118. </code>
  119. <h3>[method:null getHandler]( [param:String file] )</h3>
  120. <p>
  121. [page:String file] — The file path.
  122. <p>
  123. Can be used to retrieve the registered loader for the given file path.
  124. </p>
  125. <h3>[method:LoadingManager removeHandler]( [param:Object regex] )</h3>
  126. <p>
  127. [page:Object regex] — A regular expression.
  128. <p>
  129. Removes the loader for the given regular expression.
  130. </p>
  131. <h3>[method:String resolveURL]( [param:String url] )</h3>
  132. <p>
  133. [page:String url] — 所要加载的url<br /><br />
  134. 给定URL,使用URL修饰符回调(如果有)并返回已解析的URL。如果未设置URL修饰符,则返回原始URL。
  135. </p>
  136. <h3>[method:null setURLModifier]( [param:Function callback] )</h3>
  137. <p>
  138. [page:Function callback] — 设置URL修饰符成功时回调。使用url参数进行回调,并且必须返回 [page:String resolvedURL] 。<br /><br />
  139. 如果设置了回调,则在发送请求之前将向每个资源URL传递回调。回调可以返回最初的URL,也可以返回新URL以覆盖加载行为。
  140. 此行为可用于从.ZIP、拖拽API和数据URI中加载资源文件。
  141. </p>
  142. <br /><br />
  143. <p>
  144. <em>Note: The following methods are designed to be called internally by loaders. You shouldn't call
  145. them directly.</em>
  146. </p>
  147. <h3>[method:null itemStart]( [param:String url] )</h3>
  148. <p>
  149. [page:String url] — 所要加载的url<br /><br />
  150. 任何使用管理器的加载器都会调用此方法, 当加载器需要开始加载URL时。
  151. </p>
  152. <h3>[method:null itemEnd]( [param:String url] )</h3>
  153. <p>
  154. [page:String url] — 所要加载的url<br /><br />
  155. 任何使用管理器的加载器都会调用此方法, 当加载器需要加载URL结束时。
  156. </p>
  157. <h3>[method:null itemError]( [param:String url] )</h3>
  158. <p>
  159. [page:String url] — 所要加载的url<br /><br />
  160. 任何使用管理器的加载器都会调用此方法, 当加载器出现加载错误时。
  161. </p>
  162. <h2>源</h2>
  163. [link:https://github.com/mrdoob/three.js/blob/master/src/loaders/LoadingManager.js src/loaders/LoadingManager.js]
  164. </body>
  165. </html>