Loader.html 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <!DOCTYPE html>
  2. <html lang="en">
  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">Base class for implementing loaders.</p>
  12. <h2>Constructor</h2>
  13. <h3>[name]( [param:LoadingManager manager] )</h3>
  14. <p>
  15. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
  16. </p>
  17. <p>
  18. Creates a new [name].
  19. </p>
  20. <h2>Properties</h2>
  21. <h3>[property:String crossOrigin]</h3>
  22. <p>
  23. The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  24. Default is *anonymous*.
  25. </p>
  26. <h3>[property:Boolean withCredentials]</h3>
  27. <p>
  28. Whether the XMLHttpRequest uses credentials. See [page:.setWithCredentials].
  29. Default is *false*.
  30. </p>
  31. <h3>[property:LoadingManager manager]</h3>
  32. <p>
  33. The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
  34. </p>
  35. <h3>[property:String path]</h3>
  36. <p>
  37. The base path from which the asset will be loaded.
  38. Default is the empty string.
  39. </p>
  40. <h3>[property:String resourcePath]</h3>
  41. <p>
  42. The base path from which additional resources like textures will be loaded.
  43. Default is the empty string.
  44. </p>
  45. <h3>[property:Object requestHeader]</h3>
  46. <p>
  47. The [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request. See [page:.setRequestHeader]. Default is empty object.
  48. </p>
  49. <h2>Methods</h2>
  50. <h3>[method:void load]()</h3>
  51. <p>
  52. This method needs to be implement by all concrete loaders. It holds the logic for loading the asset from the backend.
  53. </p>
  54. <h3>[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )</h3>
  55. <p>
  56. [page:String url] — A string containing the path/URL of the file to be loaded.<br />
  57. [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 />
  58. </p>
  59. <p>
  60. 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].
  61. </p>
  62. <p>
  63. [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].
  64. </p>
  65. <h3>[method:void parse]()</h3>
  66. <p>
  67. This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.
  68. </p>
  69. <h3>[method:Loader setCrossOrigin]( [param:String crossOrigin] )</h3>
  70. <p>
  71. [page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  72. </p>
  73. <h3>[method:Loader setWithCredentials]( [param:Boolean value] )</h3>
  74. <p>
  75. Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or
  76. TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].<br />
  77. Note that this has no effect if you are loading files locally or from the same domain.
  78. </p>
  79. <h3>[method:Loader setPath]( [param:String path] )</h3>
  80. <p>
  81. [page:String path] — Set the base path for the asset.
  82. </p>
  83. <h3>[method:Loader setResourcePath]( [param:String resourcePath] )</h3>
  84. <p>
  85. [page:String resourcePath] — Set the base path for dependent resources like textures.
  86. </p>
  87. <h3>[method:Loader setRequestHeader]( [param:Object requestHeader] )</h3>
  88. <p>
  89. [page:Object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.<br /><br />
  90. Set the [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request.
  91. </p>
  92. <h2>Source</h2>
  93. <p>
  94. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  95. </p>
  96. </body>
  97. </html>