# MMD动画辅助对象([name])

`MMD` 资源的动画辅助对象。
[name] 处理由 [page:MMDLoader] 加载的 MMD 资源的动画，具有 IK、Grant 和Physics 等 MMD 特殊功能。它内部使用 [page:CCDIKSolver] 和 [page:MMDPhysics]。

## 引入

[name] 是一个附加组件，必须显式导入。请参阅 [link:#manual/introduction/Installation Installation / Addons]。

`import { MMDAnimationHelper } from 'three/addons/animation/MMDAnimationHelper.js';`

## 代码示例

`// Instantiate a helper const helper = new MMDAnimationHelper(); // Load MMD resources and add to helper new MMDLoader().loadWithAnimation( 'models/mmd/miku.pmd', 'models/mmd/dance.vmd', function ( mmd ) { helper.add( mmd.mesh, { animation: mmd.animation, physics: true } ); scene.add( mmd.mesh ); new THREE.AudioLoader().load( 'audios/mmd/song.mp3', function ( buffer ) { const listener = new THREE.AudioListener(); const audio = new THREE.Audio( listener ).setBuffer( buffer ); listener.position.z = 1; scene.add( audio ); scene.add( listener ); } ); } ); function render() { helper.update( clock.getDelta() ); renderer.render( scene, camera ); }`

## 例子

[example:webgl_loader_mmd]
[example:webgl_loader_mmd_pose]
[example:webgl_loader_mmd_audio]

## 构造函数

### [name]( [param:Object params] )

[page:Object params] — （可选）

- [page:Boolean sync] - 添加对象的动画持续时间是否同步。默认为 true
- [page:Number afterglow] - 默认值为 0.0。
- [page:Boolean resetPhysicsOnLoop] - 默认值为 true
- [page:Boolean pmxAnimation] - 如果设置为 true，则帮助程序遵循复杂且昂贵的 PMX 动画系统。仅当您的 PMX 模型动画效果不佳时才尝试此选项。默认为 false。

创建一个新的 [name]。

## 属性

### [property:Audio audio]

添加的 [page:Audio] 音频

### [property:Camera camera]

添加的 [page:Camera] 相机

### [property:Array meshes]

添加的 [page:SkinnedMesh] 数组

### [property:WeakMap objects]

一个 [page:WeakMap] ，它保存添加到 helper 的对象的 helper 中使用的动画内容。例如，您可以使用“helper.objects.get(mesh).mixer”访问添加的 [page:AnimationMixer] 的 [page:SkinnedMesh]。

### [property:Function onBeforePhysics]

在 [page:SkinnedMesh] 的物理计算之前立即执行的可选回调。该函数通过 [page:SkinnedMesh] 调用。

## 方法

### [method:MMDAnimationHelper add]( [param:Object3D object], [param:Object params] )

[page:Object3D object] — [page:SkinnedMesh], [page:Camera] 或 [page:Audio]
[page:Object params] — （可选）

- [page:AnimationClip animation] - 一个 [page:AnimationClip] 或设置为对象的 [page:AnimationClip] 数组。仅适用于 [page:SkinnedMesh] 和 [page:Camera]。默认值 undefined。
- [page:Boolean physics] - 仅适用于 [page:SkinnedMesh]。是否开启物理标志。默认为 true。
- [page:Integer warmup] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 60。
- [page:Number unitStep] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 1 / 65。
- [page:Integer maxStepNum] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 3。
- [page:Vector3 gravity] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 ( 0, - 9.8 * 10, 0 )。
- [page:Number delayTime] - 仅适用于 [page:Audio]。默认值为 0.0。

添加 [page:SkinnedMesh]、[page:Camera] 或 [page:Audio] 到辅助对象并设置动画。 添加的对象的动画持续时间是同步的。如果已经添加了摄像头/音频，它将被替换为新的。

### [method:MMDAnimationHelper enable]( [param:String key], [param:Boolean enabled] )

[page:String key] — 允许的字符串为 'animation'、'ik'、'grant'、'physicals' 和 'cameraAnimation'。
[page:Boolean enabled] — true 表示启用，false 表示禁用。

启用/禁用动画功能

### [method:MMDAnimationHelper pose]( [param:SkinnedMesh mesh], [param:Object vpd], [param:Object params] )

[page:SkinnedMesh mesh] — [page:SkinnedMesh] 改变姿势。不需要将其添加到 helper 中。
[page:Object vpd] — 获取由 [page:MMDLoader].loadVPD 加载的 VPD 内容
[page:Object params] — （可选）

- [page:Boolean resetPose] - 默认为 true
- [page:Boolean ik] - 默认为 true
- [page:Boolean grant] - 默认为 true

根据 VPD 内容指定 更改 [page:SkinnedMesh] 的姿势。

### [method:MMDAnimationHelper remove]( [param:Object3D object] )

[page:Object3D object] — [page:SkinnedMesh]、[page:Camera] 或 [page:Audio]

从助手中删除 [page:SkinnedMesh]、[page:Camera] 或 [page:Audio]。

### [method:MMDAnimationHelper update]( [param:Number delta] )

[page:Number delta] — 秒数

提前混合器时间并更新添加到助手的对象的动画。

## 源代码

[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/animation/MMDAnimationHelper.js examples/jsm/animation/MMDAnimationHelper.js]