3DMLoader.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  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>3DM加载器([name])</h1>
  12. <p class="desc">
  13. 用于加载 Rhinoceros 3d 模型文件。<br /><br />
  14. Rhinoceros 是一个 3D 建模器,用于创建、编辑、分析、记录、渲染、动画和转换 NURBS 曲线、曲面、breps、挤压、点云以及多边形网格和 SubD 对象。
  15. [link:https://github.com/mcneel/rhino3dm rhino3dm.js] 从开源几何库 [link:https://github.com/mcneel/opennurbs openNURBS]
  16. 编译为 WebAssembly 。加载器当前使用 [link:https://www.npmjs.com/package/rhino3dm/v/8.0.1 rhino3dm.js 8.0.1.]。
  17. </p>
  18. <h2>导入</h2>
  19. <p>
  20. [name] 是一个附加组件,必须显式导入。请参阅 [link:#manual/introduction/Installation Installation / Addons]。
  21. </p>
  22. <code>
  23. import { Rhino3dmLoader } from 'three/addons/loaders/3DMLoader.js';
  24. </code>
  25. <h2>支持的转换</h2>
  26. <p>
  27. [name] 将 Rhino 对象转换为以下 three.js 类型:
  28. </p>
  29. <table>
  30. <tr>
  31. <th>3dm type</th>
  32. <th>three.js type</th>
  33. </tr>
  34. <tr>
  35. <td>Point</td>
  36. <td>[page:Points Points]</td>
  37. </tr>
  38. <tr>
  39. <td>PointSet / PointCloud</td>
  40. <td>[page:Points Points]</td>
  41. </tr>
  42. <tr>
  43. <td>TextDot</td>
  44. <td>[page:Sprite Sprite]</td>
  45. </tr>
  46. <tr>
  47. <td>Curve</td>
  48. <td>[page:Line Line] <sup> 1</sup></td>
  49. </tr>
  50. <tr>
  51. <td>Mesh</td>
  52. <td>[page:Mesh Mesh]</td>
  53. </tr>
  54. <tr>
  55. <td>Extrusion</td>
  56. <td>[page:Mesh Mesh]<sup> 2</sup></td>
  57. </tr>
  58. <tr>
  59. <td>BREP</td>
  60. <td>[page:Mesh Mesh]<sup> 2</sup></td>
  61. </tr>
  62. <tr>
  63. <td>SubD</td>
  64. <td>[page:Mesh Mesh]<sup> 3</sup></td>
  65. </tr>
  66. <tr>
  67. <td>InstanceReferences</td>
  68. <td>[page:Object3D Object3D]</td>
  69. </tr>
  70. <tr>
  71. <td>DirectionalLight</td>
  72. <td>[page:DirectionalLight DirectionalLight]</td>
  73. </tr>
  74. <tr>
  75. <td>PointLight</td>
  76. <td>[page:PointLight PointLight]</td>
  77. </tr>
  78. <tr>
  79. <td>RectangularLight</td>
  80. <td>[page:RectAreaLight RectAreaLight]</td>
  81. </tr>
  82. <tr>
  83. <td>SpotLight</td>
  84. <td>[page:SpotLight SpotLight]</td>
  85. </tr>
  86. <tr>
  87. <td>File3dm</td>
  88. <td>[page:Object3D Object3D]<sup> 4</sup></td>
  89. </tr>
  90. <tr>
  91. <td>Material / Physically Based Material</td>
  92. <td>[page:MeshPhysicalMaterial MeshPhysicalMaterial]</td>
  93. </tr>
  94. </table>
  95. <h3>注意:</h3>
  96. <p><i>
  97. <sup>1</sup> NURBS 曲线被离散化为硬编码分辨率。
  98. </i></p>
  99. <p><i>
  100. <sup>2</sup> 基于 BREP 和 NURBS 曲面的类型用其“渲染网格”表示。如果渲染网格未在 Rhino 中以适当的显示模式显示(即“着色”、“渲染”等),或者以编程方式创建(例如通过 Grasshopper
  101. 或直接使用 rhino3dm),则渲染网格可能不会与这些对象关联图书馆。从 rhino3dm.js@8.0.0-beta2 开始,BrepFace 和 Extrusions 可以分配网格表示,但这些必须由用户生成。
  102. </i></p>
  103. <p><i>
  104. <sup>3</sup> SubD 对象通过细分其控制网来表示。
  105. </i></p>
  106. <p><i>
  107. <sup>4</sup> 无论 Rhino 文件(File3dm)被加载还是解析,返回的对象都是一个 [page:Object3D
  108. Object3D] ,所有 Rhino 对象(File3dmObject)都是子对象。File3dm 图层和其他文件级属性将添加到生成对象的 userData 中。
  109. </i></p>
  110. <p><i>
  111. <sup>5</sup> 所有生成的 Three.js 对象都具有来自填充在其 userData 对象中的 Rhino 对象的有用属性(即图层索引、名称等)。
  112. </i></p>
  113. <p><i>
  114. <sup>6</sup> Rhino 和 Three.js 有不同的坐标系。导入后,您应该将生成的 [page:Object3D Object3D] 在 x 方向上旋转 -90° 或在应用程序开始时设置
  115. THREE.Object3D.DEFAULT_UP:
  116. <code>THREE.Object3D.DEFAULT_UP.set( 0, 0, 1 );</code>
  117. 请记住,这将影响应用程序中所有 Object3D 的方向。
  118. </i></p>
  119. <h2>例子</h2>
  120. <p>
  121. [example:webgl_loader_3dm]
  122. </p>
  123. <h2>构造函数</h2>
  124. <h3>Rhino3dmLoader( [param:LoadingManager manager] )</h3>
  125. <p>
  126. [page:LoadingManager manager] — 加载器使用的 [page:LoadingManager loadingManager]。默认值为 [page:LoadingManager
  127. THREE.DefaultLoadingManager]。
  128. </p>
  129. <p>
  130. 创建一个新的 Rhino3dmLoader。
  131. </p>
  132. <h2>属性</h2>
  133. <p>有关常用属性,请参阅 [page:Loader] 基类。</p>
  134. <h2>方法</h2>
  135. <p>有关常用方法,请参阅 [page:Loader] 基类。</p>
  136. <h3>[method:Object3D load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function
  137. onError] )</h3>
  138. <p>
  139. [page:String url] — 包含 `.3dm` 文件路径/URL的字符串<br />
  140. [page:Function onLoad] — 加载成功完成后调用的函数<br />
  141. [page:Function onProgress] — (可选)加载过程中调用的函数。参数将是 XMLHttpRequest 实例,其中包含 .[page:Integer total] 和 .[page:Integer
  142. loaded] 字节。如果服务器没有设置 Content-Length,.[page:Integer total] 将为 0。<br />
  143. [page:Function onError] — (可选)加载期间发生错误时调用的函数。该函数接收错误作为参数。<br />
  144. </p>
  145. <p>
  146. 开始从 url 加载并在解析得到 Object3d 后调用 `onLoad` 。
  147. </p>
  148. <code>
  149. // Instantiate a loader
  150. const loader = new Rhino3dmLoader();
  151. // Specify path to a folder containing WASM/JS libraries or a CDN.
  152. // For example, /jsm/libs/rhino3dm/ is the location of the library inside the three.js repository
  153. // loader.setLibraryPath( '/path_to_library/rhino3dm/' );
  154. loader.setLibraryPath( 'https://cdn.jsdelivr.net/npm/rhino3dm@8.0.1/' );
  155. // Load a 3DM file
  156. loader.load(
  157. // resource URL
  158. 'model.3dm',
  159. // called when the resource is loaded
  160. function ( object ) {
  161. scene.add( object );
  162. },
  163. // called as loading progresses
  164. function ( xhr ) {
  165. console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
  166. },
  167. // called when loading has errors
  168. function ( error ) {
  169. console.log( 'An error happened' );
  170. }
  171. );
  172. </code>
  173. <h3>[method:Object3D parse]( [param:ArrayBuffer buffer], [param:Function onLoad], [param:Function onProgress],
  174. [param:Function onError] )</h3>
  175. <p>
  176. [page:ArrayBuffer buffer] — 代表 Rhino `File3dm` 文档的 ArrayBuffer<br />
  177. [page:Function onLoad] — 加载成功完成后调用的函数。<br />
  178. [page:Function onError] — (可选)加载期间发生错误时调用的函数。该函数接收错误作为参数。<br />
  179. </p>
  180. <p>
  181. 解析 File3dm ArrayBuffer 并在得到 Object3d 后调用 `onLoad`。
  182. 请参阅 [link:https://github.com/mcneel/rhino-developer-samples/tree/7/rhino3dm/js/SampleParse3dmObjects this example]
  183. 以获取更多参考。
  184. </p>
  185. <code>
  186. import rhino3dm from 'https://cdn.jsdelivr.net/npm/rhino3dm@8.0.1'
  187. // Instantiate a loader
  188. const loader = new Rhino3dmLoader();
  189. // Specify path to a folder containing WASM/JS libraries or a CDN.
  190. loader.setLibraryPath( 'https://cdn.jsdelivr.net/npm/rhino3dm@8.0.1' );
  191. const rhino = await rhino3dm();
  192. console.log('Loaded rhino3dm.');
  193. // create Rhino Document and add a point to it
  194. const doc = new rhino.File3dm();
  195. const ptA = [0, 0, 0];
  196. const point = new rhino.Point( ptA );
  197. doc.objects().add( point, null );
  198. // create a copy of the doc.toByteArray data to get an ArrayBuffer
  199. const buffer = new Uint8Array( doc.toByteArray() ).buffer;
  200. loader.parse( buffer, function ( object ) {
  201. scene.add( object );
  202. } );
  203. </code>
  204. <h3>[method:this setLibraryPath]( [param:String value] )</h3>
  205. <p>
  206. [page:String value] — 包含 JS 和 WASM 库的文件夹的路径。
  207. </p>
  208. <code>
  209. // Instantiate a loader
  210. const loader = new Rhino3dmLoader();
  211. // Specify path to a folder containing the WASM/JS library:
  212. loader.setLibraryPath( '/path_to_library/rhino3dm/' );
  213. // or from a CDN:
  214. loader.setLibraryPath( 'https://cdn.jsdelivr.net/npm/rhino3dm@8.0.1' );
  215. </code>
  216. <h3>[method:this setWorkerLimit]( [param:Number workerLimit] )</h3>
  217. <p>
  218. [page:Number workerLimit] - 要分配的最大 worker 数量。默认值为 4。<br />
  219. </p>
  220. <p>
  221. 设置解码期间要使用的 [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers
  222. Web Workers] 的最大数量。如果 worker 还负责应用程序中的其他任务,则较低的限制可能更好。
  223. </p>
  224. <h3>[method:this dispose]()</h3>
  225. <p>
  226. 处理加载程序资源并释放内存。
  227. </p>
  228. <h2>源代码</h2>
  229. <p>
  230. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/3DMLoader.js examples/jsm/loaders/3DMLoader.js]
  231. </p>
  232. </body>
  233. </html>