1
0

CCDIKHelper.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>CCDIKHelper - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → </p>
  13. <h1 translate="no">CCDIKHelper</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Helper for visualizing IK bones.</p></div>
  17. </header>
  18. <article>
  19. <h2 class="subsection-title">Import</h2>
  20. <p><span translate="no">CCDIKHelper</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
  21. <pre><code class="language-js">import { CCDIKHelper } from 'three/addons/animation/CCDIKSolver.js';</code></pre>
  22. <div class="container-overview">
  23. <h2>Constructor</h2>
  24. <h3 class="name name-method" id="CCDIKHelper" translate="no">new <a href="#CCDIKHelper">CCDIKHelper</a><span class="signature">( mesh : <span class="param-type"><a href="SkinnedMesh.html">SkinnedMesh</a></span>, iks : <span class="param-type">Array.&lt;<a href="CCDIKSolver.html#~IK">CCDIKSolver~IK</a>></span>, sphereSize : <span class="param-type">number</span> )</span> </h3>
  25. <div class="method">
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name">
  30. <strong>mesh</strong>
  31. </td>
  32. <td class="description last">
  33. <p>The skinned mesh.</p>
  34. </td>
  35. </tr>
  36. <tr>
  37. <td class="name">
  38. <strong>iks</strong>
  39. </td>
  40. <td class="description last">
  41. <p>The IK objects.</p>
  42. <p>Default is <code>[]</code>.</p>
  43. </td>
  44. </tr>
  45. <tr>
  46. <td class="name">
  47. <strong>sphereSize</strong>
  48. </td>
  49. <td class="description last">
  50. <p>The sphere size.</p>
  51. <p>Default is <code>0.25</code>.</p>
  52. </td>
  53. </tr>
  54. </tbody>
  55. </table>
  56. </div>
  57. </div>
  58. <h2 class="subsection-title">Properties</h2>
  59. <div class="member">
  60. <h3 class="name" id="effectorSphereMaterial" translate="no">.<a href="#effectorSphereMaterial">effectorSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
  61. <div class="description">
  62. <p>The material for the effector spheres.</p>
  63. </div>
  64. </div>
  65. <div class="member">
  66. <h3 class="name" id="iks" translate="no">.<a href="#iks">iks</a><span class="type-signature"> : Array.&lt;<a href="CCDIKSolver.html#~IK">CCDIKSolver~IK</a>></span> </h3>
  67. <div class="description">
  68. <p>The IK objects.</p>
  69. </div>
  70. </div>
  71. <div class="member">
  72. <h3 class="name" id="lineMaterial" translate="no">.<a href="#lineMaterial">lineMaterial</a><span class="type-signature"> : <a href="LineBasicMaterial.html">LineBasicMaterial</a></span> </h3>
  73. <div class="description">
  74. <p>A global line material.</p>
  75. </div>
  76. </div>
  77. <div class="member">
  78. <h3 class="name" id="linkSphereMaterial" translate="no">.<a href="#linkSphereMaterial">linkSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
  79. <div class="description">
  80. <p>The material for the link spheres.</p>
  81. </div>
  82. </div>
  83. <div class="member">
  84. <h3 class="name" id="root" translate="no">.<a href="#root">root</a><span class="type-signature"> : <a href="SkinnedMesh.html">SkinnedMesh</a></span> </h3>
  85. <div class="description">
  86. <p>The skinned mesh this helper refers to.</p>
  87. </div>
  88. </div>
  89. <div class="member">
  90. <h3 class="name" id="sphereGeometry" translate="no">.<a href="#sphereGeometry">sphereGeometry</a><span class="type-signature"> : <a href="SkinnedMesh.html">SkinnedMesh</a></span> </h3>
  91. <div class="description">
  92. <p>The helpers sphere geometry.</p>
  93. </div>
  94. </div>
  95. <div class="member">
  96. <h3 class="name" id="targetSphereMaterial" translate="no">.<a href="#targetSphereMaterial">targetSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
  97. <div class="description">
  98. <p>The material for the target spheres.</p>
  99. </div>
  100. </div>
  101. <h2 class="subsection-title">Methods</h2>
  102. <h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
  103. <div class="method">
  104. <div class="description">
  105. <p>Frees the GPU-related resources allocated by this instance.
  106. Call this method whenever this instance is no longer used in your app.</p>
  107. </div>
  108. </div>
  109. <h2 class="subsection-title">Source</h2>
  110. <p>
  111. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/animation/CCDIKSolver.js" translate="no" target="_blank" rel="noopener">examples/jsm/animation/CCDIKSolver.js</a>
  112. </p>
  113. </article>
  114. </section>
  115. <script src="../scripts/linenumber.js"></script>
  116. <script src="../scripts/page.js"></script>
  117. </body>
  118. </html>
粤ICP备19079148号