samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>CCDIKHelper - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → </p>
	<h1 translate="no">CCDIKHelper</h1>
		<section>
			<header>
				<div class="class-description"><p>Helper for visualizing IK bones.</p></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<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">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { CCDIKHelper } from 'three/addons/animation/CCDIKSolver.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="CCDIKHelper" translate="no">new <a href="#CCDIKHelper">CCDIKHelper</a><span class="signature">( mesh : <span class="param-type">SkinnedMesh</span>, iks : <span class="param-type">Array.&lt;CCDIKSolver~IK></span>, sphereSize : <span class="param-type">number</span> )</span> </h3>
					<div class="method">
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>mesh</code></td>
									<td class="description last"><p>The skinned mesh.</p></td>
								</tr>
								<tr>
									<td class="name"><code>iks</code></td>
									<td class="description last"><p>The IK objects.<br/>Default is <code>[]</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>sphereSize</code></td>
									<td class="description last"><p>The sphere size.<br/>Default is <code>0.25</code>.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="effectorSphereMaterial" translate="no">.<a href="#effectorSphereMaterial">effectorSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
					<div class="description">
						<p>The material for the effector spheres.</p>
					</div>
				</div>
				<div class="member">
					<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>
					<div class="description">
						<p>The IK objects.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="lineMaterial" translate="no">.<a href="#lineMaterial">lineMaterial</a><span class="type-signature"> : <a href="LineBasicMaterial.html">LineBasicMaterial</a></span> </h3>
					<div class="description">
						<p>A global line material.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="linkSphereMaterial" translate="no">.<a href="#linkSphereMaterial">linkSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
					<div class="description">
						<p>The material for the link spheres.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="root" translate="no">.<a href="#root">root</a><span class="type-signature"> : <a href="SkinnedMesh.html">SkinnedMesh</a></span> </h3>
					<div class="description">
						<p>The skinned mesh this helper refers to.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="sphereGeometry" translate="no">.<a href="#sphereGeometry">sphereGeometry</a><span class="type-signature"> : <a href="SkinnedMesh.html">SkinnedMesh</a></span> </h3>
					<div class="description">
						<p>The helpers sphere geometry.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="targetSphereMaterial" translate="no">.<a href="#targetSphereMaterial">targetSphereMaterial</a><span class="type-signature"> : <a href="MeshBasicMaterial.html">MeshBasicMaterial</a></span> </h3>
					<div class="description">
						<p>The material for the target spheres.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Frees the GPU-related resources allocated by this instance.
Call this method whenever this instance is no longer used in your app.</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/animation/CCDIKSolver.js" target="_blank" rel="noopener" translate="no">examples/jsm/animation/CCDIKSolver.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>