SkeletonHelper.html 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. <!DOCTYPE html>
  2. <html lang="en">
  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:Object3D] &rarr; [page:Line] &rarr; [page:LineSegments] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. A helper object to assist with visualizing a [page:Skeleton Skeleton]. The
  14. helper is rendered using a [page:LineBasicMaterial LineBasicMaterial].
  15. </p>
  16. <h2>Code Example</h2>
  17. <code>
  18. const helper = new THREE.SkeletonHelper( skinnedMesh );
  19. scene.add( helper );
  20. </code>
  21. <h2>Examples</h2>
  22. <p>
  23. [example:webgl_animation_skinning_blending WebGL / animation / skinning / blending]<br />
  24. [example:webgl_animation_skinning_morph WebGL / animation / skinning / morph]<br />
  25. [example:webgl_loader_bvh WebGL / loader / bvh ]
  26. </p>
  27. <h2>Constructor</h2>
  28. <h3>[name]( [param:Object3D object] )</h3>
  29. <p>
  30. object -- Usually an instance of [page:SkinnedMesh]. However, any instance
  31. of [page:Object3D] can be used if it represents a hierarchy of [page:Bone Bone]s (via [page:Object3D.children]).
  32. </p>
  33. <h2>Properties</h2>
  34. <h3>[property:Array bones]</h3>
  35. <p>The list of bones that the helper renders as [page:Line Lines].</p>
  36. <h3>[property:Boolean isSkeletonHelper]</h3>
  37. <p>Read-only flag to check if a given object is of type [name].</p>
  38. <h3>[property:Object3D root]</h3>
  39. <p>The object passed in the constructor.</p>
  40. <h2>Methods</h2>
  41. <p>See the base [page:LineSegments] class for common methods.</p>
  42. <h3>[method:undefined dispose]()</h3>
  43. <p>
  44. Frees the GPU-related resources allocated by this instance. Call this
  45. method whenever this instance is no longer used in your app.
  46. </p>
  47. <h2>Source</h2>
  48. <p>
  49. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  50. </p>
  51. </body>
  52. </html>