GLTFLoader.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  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. [page:Loader] &rarr;
  12. <h1>GLTF加载器([name])</h1>
  13. <p class="desc">用于载入<em>glTF 2.0</em>资源的加载器。<br /><br />
  14. [link:https://www.khronos.org/gltf glTF](gl传输格式)是一种开放格式的规范
  15. ([link:https://github.com/KhronosGroup/glTF/tree/master/specification/2.0 open format specification]),
  16. 用于更高效地传输、加载3D内容。该类文件以JSON(.glft)格式或二进制(.glb)格式提供,
  17. 外部文件存储贴图(.jpg、.png)和额外的二进制数据(.bin)。一个glTF组件可传输一个或多个场景,
  18. 包括网格、材质、贴图、蒙皮、骨架、变形目标、动画、灯光以及摄像机。
  19. </p>
  20. <h2>扩展</h2>
  21. <p>
  22. GLTFLoader支持下列glTF 2.0扩展([link:https://github.com/KhronosGroup/glTF/tree/master/extensions/ glTF 2.0 extensions]):
  23. </p>
  24. <ul>
  25. <li>KHR_draco_mesh_compression</li>
  26. <li>KHR_materials_pbrSpecularGlossiness</li>
  27. <li>KHR_materials_unlit</li>
  28. <li>KHR_mesh_quantization</li>
  29. <li>KHR_lights_punctual<sup>1</sup></li>
  30. <li>KHR_texture_transform<sup>2</sup></li>
  31. <li>MSFT_texture_dds</li>
  32. </ul>
  33. <p><i>
  34. <sup>1</sup>需要[link:https://threejs.org/docs/#api/en/renderers/WebGLRenderer.physicallyCorrectLights physicallyCorrectLights]被启用。
  35. </i></p>
  36. <p><i>
  37. <sup>2</sup>支持UV变换,但存在一些重要的限制。
  38. Transforms applied to
  39. a texture using the first UV slot (all textures except aoMap and lightMap) must share the same
  40. transform, or no transfor at all.
  41. aoMap 和 lightMap 纹理不能被变换。每个材质最多只能使用一次变换。
  42. 每次对使用具有唯一变换的纹理都会导致一次额外的GPU纹理上传。
  43. 请参阅#[link:https://github.com/mrdoob/three.js/pull/13831 13831] 和
  44. #[link:https://github.com/mrdoob/three.js/issues/12788 12788]。
  45. </i></p>
  46. <h2>示例</h2>
  47. <code>
  48. // Instantiate a loader
  49. var loader = new THREE.GLTFLoader();
  50. // Optional: Provide a DRACOLoader instance to decode compressed mesh data
  51. var dracoLoader = new THREE.DRACOLoader();
  52. dracoLoader.setDecoderPath( '/examples/js/libs/draco/' );
  53. loader.setDRACOLoader( dracoLoader );
  54. // Load a glTF resource
  55. loader.load(
  56. // resource URL
  57. 'models/gltf/duck/duck.gltf',
  58. // called when the resource is loaded
  59. function ( gltf ) {
  60. scene.add( gltf.scene );
  61. gltf.animations; // Array&lt;THREE.AnimationClip&gt;
  62. gltf.scene; // THREE.Scene
  63. gltf.scenes; // Array&lt;THREE.Scene&gt;
  64. gltf.cameras; // Array&lt;THREE.Camera&gt;
  65. gltf.asset; // Object
  66. },
  67. // called while loading is progressing
  68. function ( xhr ) {
  69. console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
  70. },
  71. // called when loading has errors
  72. function ( error ) {
  73. console.log( 'An error happened' );
  74. }
  75. );
  76. </code>
  77. [example:webgl_loader_gltf]
  78. <h2>浏览器兼容性</h2>
  79. <p>GLTFLoader 依赖 ES6 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promises],
  80. 这一特性不支持IE11。若要在IE11中使用该加载器,你必须引入polyfill([link:https://github.com/stefanpenner/es6-promise include a polyfill])
  81. 来提供一个Promise的替代方案。</p>
  82. <h2>纹理</h2>
  83. <p>纹理中包含的颜色信息(.map, .emissiveMap, 和 .specularMap)在glTF中总是使用sRGB颜色空间,而顶点颜色和材质属性(.color, .emissive, .specular)
  84. 则使用线性颜色空间。在典型的渲染工作流程中,纹理会被渲染器转换为线性颜色空间,进行光照计算,然后最终输出会被转换回 sRGB
  85. 颜色空间并显示在屏幕上。除非你需要使用线性颜色空间进行后期处理,否则请在使用glTF的时候将[page:WebGLRenderer]进行如下配置:</p>
  86. <code>
  87. renderer.outputEncoding = THREE.sRGBEncoding;
  88. </code>
  89. <p>假设渲染器的配置如上所示,则GLTFLoader将可以正确地自动配置从.gltf或.glb文件中引用的纹理。
  90. 当从外部加载纹理(例如,使用[page:TextureLoader])并将纹理应用到glTF模型,则必须给定对应的颜色空间与朝向:</p>
  91. <code>
  92. // If texture is used for color information, set colorspace.
  93. texture.encoding = THREE.sRGBEncoding;
  94. // UVs use the convention that (0, 0) corresponds to the upper left corner of a texture.
  95. texture.flipY = false;
  96. </code>
  97. <h2>自定义扩展</h2>
  98. <p>
  99. 来自未知扩展的元数据会被保存到Object3D、Scene和Material实例中上的“.userData.gltfExtensions”,
  100. 或被附加到 response “gltf”对象。示例:
  101. </p>
  102. <code>
  103. loader.load('foo.gltf', function ( gltf ) {
  104. var scene = gltf.scene;
  105. var mesh = scene.children[ 3 ];
  106. var fooExtension = mesh.userData.gltfExtensions.EXT_foo;
  107. gltf.parser.getDependency( 'bufferView', fooExtension.bufferView )
  108. .then( function ( fooBuffer ) { ... } );
  109. } );
  110. </code>
  111. <br>
  112. <hr>
  113. <h2>构造函数</h2>
  114. <h3>[name]( [param:LoadingManager manager] )</h3>
  115. <p>
  116. [page:LoadingManager manager] — 该加载器将要使用的 [page:LoadingManager loadingManager] 。默认为 [page:LoadingManager THREE.DefaultLoadingManager]。
  117. </p>
  118. <p>
  119. 创建一个新的[name]。
  120. </p>
  121. <h2>属性</h2>
  122. <p>共有属性请参见其基类[page:Loader]。</p>
  123. <h2>方法</h2>
  124. <p>共有方法请参见其基类[page:Loader]。</p>
  125. <h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  126. <p>
  127. [page:String url] — 包含有<em>.gltf</em>/<em>.glb</em>文件路径/URL的字符串。<br />
  128. [page:Function onLoad] — 加载成功完成后将会被调用的函数。该函数接收[page:Function parse]所返回的已加载的JSON响应。<br />
  129. [page:Function onProgress] — (可选)加载正在进行过程中会被调用的函数。其参数将会是XMLHttpRequest实例,包含有总字节数.[page:Integer total]与已加载的字节数.[page:Integer loaded]。<br />
  130. [page:Function onError] — (可选)若在加载过程发生错误,将被调用的函数。该函数接收error来作为参数。<br />
  131. </p>
  132. <p>
  133. 开始从url加载,并使用解析过的响应内容调用回调函数。
  134. </p>
  135. <h3>[method:null setDRACOLoader]( [param:DRACOLoader dracoLoader] )</h3>
  136. <p>
  137. [page:DRACOLoader dracoLoader] — THREE.DRACOLoader的实例,用于解码使用KHR_draco_mesh_compression扩展压缩过的文件。
  138. </p>
  139. <p>
  140. 请参阅[link:https://github.com/mrdoob/three.js/tree/dev/examples/js/libs/draco#readme readme]来了解Draco及其解码器的详细信息。
  141. </p>
  142. <h3>[method:null setDDSLoader]( [param:DDSLoader ddsLoader] )</h3>
  143. <p>
  144. [page:DDSLoader ddsLoader] — THREE.DDSLoader的实例,用于加载使用MSFT_TEXTURE_DDS扩展压缩过的纹理。
  145. </p>
  146. <h3>[method:null parse]( [param:ArrayBuffer data], [param:String path], [param:Function onLoad], [param:Function onError] )</h3>
  147. <p>
  148. [page:ArrayBuffer data] — 需要解析的glTF文件,值为一个ArrayBuffer或<em>JSON</em>字符串。<br />
  149. [page:String path] — 用于找到后续glTF资源(如纹理和.bin数据文件)的基础路径。<br />
  150. [page:Function onLoad] — 解析成功完成后将会被调用的函数。<br />
  151. [page:Function onError] — (可选)若在解析过程发生错误,将被调用的函数。该函数接收error来作为参数。<br />
  152. </p>
  153. <p>
  154. 解析基于glTF的ArrayBuffer或<em>JSON</em>字符串,并在完成后触发[page:Function onLoad]回调。[page:Function onLoad]的参数将是一个包含有已加载部分的[page:object]:.[page:Scene scene]、 .[page:Array scenes]、 .[page:Array cameras]、 .[page:Array animations] 和 .[page:Object asset]。
  155. </p>
  156. <h2>源代码</h2>
  157. <p>
  158. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/GLTFLoader.js examples/js/loaders/GLTFLoader.js]
  159. </p>
  160. </body>
  161. </html>