Loader.html 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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">Base class for implementing loaders.</p>
  13. <h2>Constructor</h2>
  14. <h3>[name]( [param:LoadingManager manager] )</h3>
  15. <p>
  16. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
  17. </p>
  18. <p>
  19. Creates a new [name].
  20. </p>
  21. <h2>Properties</h2>
  22. <h3>[property:string crossOrigin]</h3>
  23. <p>
  24. The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  25. Default is *anonymous*.
  26. </p>
  27. <h3>[property:LoadingManager manager]</h3>
  28. <p>
  29. The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
  30. </p>
  31. <h3>[property:String path]</h3>
  32. <p>
  33. The base path from which the asset will be loaded.
  34. Default is the empty string.
  35. </p>
  36. <h3>[property:String resourcePath]</h3>
  37. <p>
  38. The base path from which additional resources like textures will be loaded.
  39. Default is the empty string.
  40. </p>
  41. <h2>Methods</h2>
  42. <h3>[method:void load]()</h3>
  43. <p>
  44. This method needs to be implement by all concrete loaders. It holds the logic for loading the asset from the backend.
  45. </p>
  46. <h3>[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )</h3>
  47. <p>
  48. [page:String url] — A string containing the path/URL of the file to be loaded.<br />
  49. [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
  50. </p>
  51. <p>
  52. This method is equivalent to [page:.load], but returns a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise].
  53. </p>
  54. <p>
  55. [page:Function onLoad] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve Promise.resolve] and [page:Function onError] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject Promise.reject].
  56. </p>
  57. <h3>[method:void parse]()</h3>
  58. <p>
  59. This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.
  60. </p>
  61. <h3>[method:Loader setCrossOrigin]( [param:String crossOrigin] )</h3>
  62. <p>
  63. [page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  64. </p>
  65. <h3>[method:Loader setPath]( [param:String path] )</h3>
  66. <p>
  67. [page:String path] — Set the base path for the asset.
  68. </p>
  69. <h3>[method:Loader setResourcePath]( [param:String resourcePath] )</h3>
  70. <p>
  71. [page:String resourcePath] — Set the base path for dependent resources like textures.
  72. </p>
  73. <h2>Source</h2>
  74. <p>
  75. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  76. </p>
  77. </body>
  78. </html>