PLYLoader.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html>
  2. <html lang="zh">
  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. [page:Loader] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. PLY(Polygon File Format)多边形文件格式,也称为斯坦福(Stanford)三角形格式的加载器。[name] 支持 ASCII 和二进制文件,包含以下 PLY 属性:
  14. <ul>
  15. <li>x, y, z (vertex positions)</li>
  16. <li>nx, ny, nz (vertex normals)</li>
  17. <li>s, t / u, v (texture coordinates)</li>
  18. <li>red, green, blue (vertex colors)</li>
  19. <li>vertex_indices (face indices)</li>
  20. <li>通过属性名称映射自定义属性</li>
  21. </ul>
  22. </p>
  23. <h2>导入</h2>
  24. <p>
  25. [name] 是一个附加组件,必须显式导入。请参阅 [link:#manual/introduction/Installation Installation / Addons]。
  26. </p>
  27. <code>
  28. import { PLYLoader } from 'three/addons/loaders/PLYLoader.js';
  29. </code>
  30. <h2>代码示例</h2>
  31. <code>
  32. // instantiate a loader
  33. const loader = new PLYLoader();
  34. // load a resource
  35. loader.load(
  36. // resource URL
  37. 'models/ply/ascii/dolphins.ply',
  38. // called when the resource is loaded
  39. function ( geometry ) {
  40. // compute vertex normals if not present in the file
  41. geometry.computeVertexNormals();
  42. const material = new THREE.MeshStandardMaterial( { color: 0x0055ff } );
  43. const mesh = new THREE.Mesh( geometry, material );
  44. scene.add( mesh );
  45. },
  46. // called when loading is in progress
  47. function ( xhr ) {
  48. console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
  49. },
  50. // called when loading has errors
  51. function ( error ) {
  52. console.log( 'An error happened' );
  53. }
  54. );
  55. </code>
  56. <h2>例子</h2>
  57. <p>
  58. [example:webgl_loader_ply]
  59. </p>
  60. <h2>构造函数</h2>
  61. <h3>[name]( [param:LoadingManager manager] )</h3>
  62. <p>
  63. [page:LoadingManager manager] — 加载器使用的 [page:LoadingManager loadingManager] 。默认值为 [page:LoadingManager THREE.DefaultLoadingManager]。
  64. </p>
  65. <p>
  66. 创建一个 [name] 实例。
  67. </p>
  68. <h2>属性</h2>
  69. <p>有关公共属性,请参阅 [page:Loader] 基类。</p>
  70. <h3>[page:Object propertyNameMapping]</h3>
  71. <p>
  72. 将默认属性名称映射到自定义属性名称的对象。用于处理非标准 PLY 属性名称。
  73. </p>
  74. <h3>[page:Object customPropertyMapping]</h3>
  75. <p>
  76. 定义标准位置、法线、uv 和颜色属性未涵盖的属性的自定义属性映射的对象。
  77. </p>
  78. <h2>方法</h2>
  79. <p>有关常用方法,请参阅 [page:Loader] 基类。</p>
  80. <h3>[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  81. <p>
  82. [page:String url] — 包含 `.ply` 文件路径/URL 的字符串。<br />
  83. [page:Function onLoad] — (可选)加载成功完成后调用的函数。该函数接收具有以下属性的对象 [page:BufferGeometry]。<br />
  84. [page:Function onProgress] — (可选)加载过程中调用的函数。参数将是 XMLHttpRequest 实例,其中包含 .[page:Integer total] 和 .[page:Integer
  85. loaded] 字节。如果服务器没有设置 Content-Length,.[page:Integer total] 将为 0。<br />
  86. [page:Function onError] — (可选)加载期间发生错误时调用的函数。该函数接收错误作为参数。<br />
  87. </p>
  88. <p>
  89. 开始从 url 加载并使用解析后的响应内容调用 onLoad。
  90. </p>
  91. <h3>[method:BufferGeometry parse]( [param:ArrayBuffer data] )</h3>
  92. <p>
  93. [page:ArrayBuffer data] — 要解析的二进制或文本结构
  94. </p>
  95. <p>
  96. 解析 PLY 二进制或 ASCII 结构并返回 [page:BufferGeometry]。<br />
  97. 几何图形(geometry) 包含顶点位置,并且可能包括顶点法线、纹理坐标、顶点颜色和面索引,具体取决于 PLY 文件内容。
  98. </p>
  99. <h3>[method:undefined setPropertyNameMapping]( [param:Object mapping] )</h3>
  100. <p>
  101. [page:Object mapping] — 将默认属性名称映射到自定义属性名称的对象。
  102. </p>
  103. <p>
  104. 设置属性名称映射,将默认属性名称映射到自定义属性名称。例如,以下内容将文件中的属性 "diffuse_(red|green|blue)" 映射到标准颜色名称:
  105. </p>
  106. <code>
  107. loader.setPropertyNameMapping( {
  108. diffuse_red: 'red',
  109. diffuse_green: 'green',
  110. diffuse_blue: 'blue'
  111. } );
  112. </code>
  113. <h3>[method:undefined setCustomPropertyNameMapping]( [param:Object mapping] )</h3>
  114. <p>
  115. [page:Object mapping] — 定义自定义属性映射的对象。
  116. </p>
  117. <p>
  118. 可以使用此方法添加除位置、UV、法线和颜色属性的默认属性之外的自定义属性。例如,以下内容将元素属性 "custom_property_a" 和 "custom_property_b" 映射到项目大小为 2 的属性 "customAttribute":
  119. </p>
  120. <code>
  121. loader.setCustomPropertyNameMapping( {
  122. customAttribute: ['custom_property_a', 'custom_property_b']
  123. } );
  124. </code>
  125. <h2>源码</h2>
  126. <p>
  127. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/PLYLoader.js examples/jsm/loaders/PLYLoader.js]
  128. </p>
  129. </body>
  130. </html>
粤ICP备19079148号