Chapter 322: CCDIKHelper

Core Idea

Helper for visualizing IK bones.

Key Concepts

• effectorSphereMaterial : MeshBasicMaterial: The material for the effector spheres.
• iks : Array.<CCDIKSolver~IK>: The IK objects.
• lineMaterial : LineBasicMaterial: A global line material.
• linkSphereMaterial : MeshBasicMaterial: The material for the link spheres.
• root : SkinnedMesh: The skinned mesh this helper refers to.
• sphereGeometry : SphereGeometry: The helpers sphere geometry.
• targetSphereMaterial : MeshBasicMaterial: The material for the target spheres.

Code Examples

import { CCDIKHelper } from 'three/addons/animation/CCDIKSolver.js';

• What it demonstrates: Typical usage of CCDIKHelper.

Reference Tables

Constructor

Signature
new CCDIKHelper( mesh : SkinnedMesh, iks : Array.<CCDIKSolver~IK>, sphereSize : number )

Properties

Property	Description
.effectorSphereMaterial : MeshBasicMaterial	The material for the effector spheres.
.iks : Array.<CCDIKSolver~IK>	The IK objects.
.lineMaterial : LineBasicMaterial	A global line material.
.linkSphereMaterial : MeshBasicMaterial	The material for the link spheres.
.root : SkinnedMesh	The skinned mesh this helper refers to.
.sphereGeometry : SphereGeometry	The helpers sphere geometry.
.targetSphereMaterial : MeshBasicMaterial	The material for the target spheres.

Methods

Method	Description
.dispose()	Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Key Takeaways

1. CCDIKHelper extends: EventDispatcher → Object3D
2. Most relevant properties: effectorSphereMaterial, iks, lineMaterial, linkSphereMaterial.
3. Key methods: dispose.

Connects To

• EventDispatcher: parent class
• Object3D: parent class
• Source: examples/jsm/animation/CCDIKSolver.js