CubeTextureLoader.html 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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. Class for loading a [page:CubeTexture CubeTexture].
  14. This uses the [page:ImageLoader] internally for loading files.
  15. </p>
  16. <h2>Example</h2>
  17. <p>
  18. [example:webgl_materials_cubemap materials / cubemap]<br />
  19. [example:webgl_materials_cubemap_balls_reflection materials / cubemap / balls / reflection]<br />
  20. [example:webgl_materials_cubemap_balls_refraction materials / cubemap / balls / refraction]<br />
  21. [example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
  22. [example:webgl_materials_cubemap_dynamic2 materials / cubemap / dynamic2]<br />
  23. [example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
  24. </p>
  25. <code>
  26. var scene = new THREE.Scene();
  27. scene.background = new THREE.CubeTextureLoader()
  28. .setPath( 'textures/cubeMaps/' )
  29. .load( [
  30. 'px.png',
  31. 'nx.png',
  32. 'py.png',
  33. 'ny.png',
  34. 'pz.png',
  35. 'nz.png'
  36. ] );
  37. </code>
  38. <h2>Constructor</h2>
  39. <h3>[name]( [param:LoadingManager manager] )</h3>
  40. <p>
  41. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].<br /><br />
  42. Creates a new [name].
  43. </p>
  44. <h2>Properties</h2>
  45. <h3>[property:String crossOrigin]</h3>
  46. <p>
  47. If set, assigns the [link:https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes crossOrigin]
  48. attribute of the image to the value of *crossOrigin*,
  49. prior to starting the load. Default is *"anonymous"*.
  50. </p>
  51. <h3>[property:LoadingManager manager]</h3>
  52. <p>
  53. The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
  54. </p>
  55. <h3>[property:String path]</h3>
  56. <p>The base path from which files will be loaded. See [page:.setPath]. Default is *undefined*.</p>
  57. <h2>Methods</h2>
  58. <h3>[method:null load]( [param:String urls], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  59. <p>
  60. [page:String urls] — array of 6 urls to images, one for each side of the CubeTexture.
  61. The urls should be specified in the following order: pos-x, neg-x, pos-y, neg-y, pos-z, neg-z.
  62. They can also be [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URIs].<br />
  63. Note that, by convention, cube maps are specified in a coordinate system in which positive-x is to the right
  64. when looking up the positive-z axis -- in other words, using a left-handed coordinate system.
  65. Since three.js uses a right-handed coordinate system, environment maps used in three.js will have pos-x and neg-x swapped.<br />
  66. [page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
  67. [page:Function onProgress] — Will be called while load progresses. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
  68. [page:Function onError] — Will be called when load errors.<br />
  69. </p>
  70. <p>
  71. Begin loading from url and pass the loaded [page:Texture texture] to onLoad.
  72. </p>
  73. <h3>[method:null setCrossOrigin]( [param:String value] )</h3>
  74. <p> Set the [page:.crossOrigin] attribute.</p>
  75. <h3>[method:FileLoader setPath]( [param:String path] )</h3>
  76. <p>
  77. Set the base path or URL from which to load files. This can be useful if
  78. you are loading many textures from the same directory.
  79. </p>
  80. <h2>Source</h2>
  81. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  82. </body>
  83. </html>