ColladaLoader.html 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <script src="../../list.js"></script>
  6. <script src="../../page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="../../page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <div class="desc">A loader for <em>Collada</em> files.</div>
  12. <h2>Constructor</h2>
  13. <h3>[name]()</h3>
  14. <div>
  15. Creates a new [name].
  16. </div>
  17. <h2>Properties</h2>
  18. <h3>[property:Array options]</h3>
  19. <div>
  20. &nbsp;.[page:Boolean centerGeometry] — Force [page:Geometry] to always be centered at the local origin of the containing [page: Mesh].<br />
  21. &nbsp;.[page:Boolean convertUpAxis] — Axis conversion is done for geometries, animations, and controllers.<br />
  22. &nbsp;.[page:Boolean subdivideFaces] — Force subdivision into multiple [page: Face3].<br />
  23. &nbsp;.[page:String upAxis] — X, Y or Z<br />
  24. &nbsp;.[page:Boolean defaultEnvMap] — Cubemap to use for reflective or refractive materials.<br />
  25. </div>
  26. <h3>[property:Object geometries]</h3>
  27. <div>
  28. Parsed <em>.dae</em> geometries.
  29. </div>
  30. <h2>Methods</h2>
  31. <h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress] )</h3>
  32. <div>
  33. [page:String url] — required<br />
  34. [page:function onLoad] — Will be called when load completes. The argument will be an [page:Object object] containing loaded resources.<br />
  35. [page:function onProgress] — Will be called while load progresses. The argument will be an object containing .[page:Integer total] and .[page:Integer loaded] bytes.<br />
  36. </div>
  37. <div>
  38. Begin loading from url and call onLoad with the parsed response content.
  39. </div>
  40. <h3>[method:Object parse]( [page:Document doc], [page:Function callBack], [page:String url] )</h3>
  41. <div>
  42. [page:Document doc] — The <em>XML</em> document to parse.<br />
  43. [page:Function callBack] — Will be called when parse completes.<br />
  44. [page:String url] — The base url from which to find subsequent resources.<br />
  45. </div>
  46. <div>
  47. Parse an <em>XML Document</em> and return an [page:Object object] that contain loaded parts: .[page:Scene scene], .[page:Array morphs], .[page:Array skins], .[page:Array animations], .[page:Object dae]
  48. </div>
  49. <h3>[method:null setPreferredShading]( [page:Integer shading] )</h3>
  50. <div>
  51. [page:Integer shading] — required
  52. </div>
  53. <div>
  54. Set the .[page:Integer shading] property on the resource's materials.<br />
  55. Options are [page:Materials THREE.SmoothShading], [page:Materials THREE.FlatShading], [page:Materials THREE.NoShading].
  56. </div>
  57. <h3>[method:null applySkin]( [page:Geometry geometry], [page:Object instanceCtrl], [page:Integer frame] )</h3>
  58. <div>
  59. [page:Geometry geometry] — required<br />
  60. [page:Object instanceCtrl] — required. A collada <em>skinController</em><br />
  61. [page:Integer frame] — optionnal. Default is 40<br />
  62. </div>
  63. <div>
  64. Apply a skin (vertices, animation, bones) from a <em>collada skin controller</em>, on the given [page:Geometry].
  65. </div>
  66. <h2>Example</h2>
  67. <code>
  68. // instantiate a loader
  69. var loader = new THREE.ColladaLoader();
  70. loader.load(
  71. // resource URL
  72. 'models/collada/monster/monster.dae',
  73. // Function when resource is loaded
  74. function ( collada ) {
  75. scene.add( collada.scene );
  76. },
  77. // Function called when download progresses
  78. function ( xhr ) {
  79. console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  80. }
  81. );
  82. </code>
  83. [example:webgl_loader_collada]<br />
  84. [example:webgl_loader_collada_keyframe]<br />
  85. [example:webgl_loader_collada_skinning]<br />
  86. [example:webgl_loader_collada_kinematics]
  87. <h2>Source</h2>
  88. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/ColladaLoader.js examples/js/loaders/ColladaLoader.js]
  89. </body>
  90. </html>