LoadingManager.html 6.9 KB

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