Loader.html 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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">用于实现加载器的基类。</p>
  13. <h2>构造函数</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>属性</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>方法</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:void parse]()</h3>
  47. <p>
  48. This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.
  49. </p>
  50. <h3>[method:Loader setCrossOrigin]( [param:String crossOrigin] )</h3>
  51. <p>
  52. [page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
  53. </p>
  54. <h3>[method:Loader setPath]( [param:String path] )</h3>
  55. <p>
  56. [page:String path] — Set the base path for the asset.
  57. </p>
  58. <h3>[method:Loader setResourcePath]( [param:String resourcePath] )</h3>
  59. <p>
  60. [page:String resourcePath] — Set the base path for dependent resources like textures.
  61. </p>
  62. <h2>Handlers</h2>
  63. <p>
  64. *[name].Handlers* is a special object normally used by other loaders like [page:GLTFLoader] or [page:MTLLoader]. It provides an
  65. API that allows the definition of special mappings: What loaders should be used in order to load specific files. A typical use case
  66. is to overwrite the default loader for textures.<br /><br />
  67. Note: It's only possible to use *[name].Handlers* if the respective loader support the usage.
  68. </p>
  69. <h3>[method:null add]( [param:Object regex], [param:Loader loader] )</h3>
  70. <p>
  71. [page:Object regex] — A regular expression.<br />
  72. [page:Loader loader] — The loader.
  73. <p>
  74. Registers a loader with the given regular expression.
  75. </p>
  76. <h3>[method:null get]( [param:String file] )</h3>
  77. <p>
  78. [page:String file] — The file path.
  79. <p>
  80. Can be used to retrieve the registered loader for the given file path.
  81. </p>
  82. <h2>Source</h2>
  83. <p>
  84. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  85. </p>
  86. </body>
  87. </html>