1
0

MMDAnimationHelper.html 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. <!DOCTYPE html>
  2. <html lang="zh">
  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. <h1>MMD动画辅助对象([name])</h1>
  11. <p class="desc"> <a href="https://sites.google.com/view/evpvp/">`MMD`</a> 资源的动画辅助对象。<br /><br />
  12. [name] 处理由 [page:MMDLoader] 加载的 MMD 资源的动画,具有 IK、Grant 和Physics 等 MMD 特殊功能。它内部使用 [page:CCDIKSolver] 和
  13. [page:MMDPhysics]。
  14. </p>
  15. <h2>导入</h2>
  16. <p>
  17. [name] 是一个附加组件,必须显式导入。请参阅 [link:#manual/introduction/Installation Installation / Addons]。
  18. </p>
  19. <code>
  20. import { MMDAnimationHelper } from 'three/addons/animation/MMDAnimationHelper.js';
  21. </code>
  22. <h2>代码示例</h2>
  23. <code>
  24. // Instantiate a helper
  25. const helper = new MMDAnimationHelper();
  26. // Load MMD resources and add to helper
  27. new MMDLoader().loadWithAnimation(
  28. 'models/mmd/miku.pmd',
  29. 'models/mmd/dance.vmd',
  30. function ( mmd ) {
  31. helper.add( mmd.mesh, {
  32. animation: mmd.animation,
  33. physics: true
  34. } );
  35. scene.add( mmd.mesh );
  36. new THREE.AudioLoader().load(
  37. 'audios/mmd/song.mp3',
  38. function ( buffer ) {
  39. const listener = new THREE.AudioListener();
  40. const audio = new THREE.Audio( listener ).setBuffer( buffer );
  41. listener.position.z = 1;
  42. scene.add( audio );
  43. scene.add( listener );
  44. }
  45. );
  46. }
  47. );
  48. function render() {
  49. helper.update( clock.getDelta() );
  50. renderer.render( scene, camera );
  51. }
  52. </code>
  53. <h2>例子</h2>
  54. <p>
  55. [example:webgl_loader_mmd]<br />
  56. [example:webgl_loader_mmd_pose]<br />
  57. [example:webgl_loader_mmd_audio]
  58. </p>
  59. <h2>构造函数</h2>
  60. <h3>[name]( [param:Object params] )</h3>
  61. <p>
  62. [page:Object params] — (可选)<br />
  63. </p>
  64. <ul>
  65. <li> [page:Boolean sync] - 添加对象的动画持续时间是否同步。默认为 true</li>
  66. <li> [page:Number afterglow] - 默认值为 0.0。</li>
  67. <li> [page:Boolean resetPhysicsOnLoop] - 默认值为 true</li>
  68. <li> [page:Boolean pmxAnimation] - 如果设置为 true,则帮助程序遵循复杂且昂贵的 PMX 动画系统。仅当您的 PMX 模型动画效果不佳时才尝试此选项。默认为 false。</li>
  69. </ul>
  70. <p>
  71. 创建一个新的 [name]。
  72. </p>
  73. <h2>属性</h2>
  74. <h3>[property:Audio audio]</h3>
  75. <p>添加的 [page:Audio] 音频</p>
  76. <h3>[property:Camera camera]</h3>
  77. <p>添加的 [page:Camera] 相机</p>
  78. <h3>[property:Array meshes]</h3>
  79. <p>添加的 [page:SkinnedMesh] 数组</p>
  80. <h3>[property:WeakMap objects]</h3>
  81. <p>一个 [page:WeakMap] ,它保存添加到 helper 的对象的 helper 中使用的动画内容。例如,您可以使用“helper.objects.get(mesh).mixer”访问添加的
  82. [page:AnimationMixer] 的 [page:SkinnedMesh]。</p>
  83. <h3>[property:Function onBeforePhysics]</h3>
  84. <p> 在 [page:SkinnedMesh] 的物理计算之前立即执行的可选回调。该函数通过 [page:SkinnedMesh] 调用。</p>
  85. <h2>方法</h2>
  86. <h3>[method:MMDAnimationHelper add]( [param:Object3D object], [param:Object params] )</h3>
  87. <p>
  88. [page:Object3D object] — [page:SkinnedMesh], [page:Camera] 或 [page:Audio]<br />
  89. [page:Object params] — (可选)<br />
  90. </p>
  91. <ul>
  92. <li>[page:AnimationClip animation] - 一个 [page:AnimationClip] 或设置为对象的 [page:AnimationClip] 数组。仅适用于 [page:SkinnedMesh]
  93. 和 [page:Camera]。默认值 undefined。</li>
  94. <li>[page:Boolean physics] - 仅适用于 [page:SkinnedMesh]。是否开启物理标志。默认为 true。</li>
  95. <li>[page:Integer warmup] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 60。</li>
  96. <li>[page:Number unitStep] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 1 / 65。</li>
  97. <li>[page:Integer maxStepNum] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 3。</li>
  98. <li>[page:Vector3 gravity] - 仅适用于 [page:SkinnedMesh] 并且 physics 为 true。物理参数。默认值为 ( 0, - 9.8 * 10, 0 )。</li>
  99. <li>[page:Number delayTime] - 仅适用于 [page:Audio]。默认值为 0.0。</li>
  100. </ul>
  101. <p>
  102. 添加 [page:SkinnedMesh]、[page:Camera] 或 [page:Audio] 到辅助对象并设置动画。 添加的对象的动画持续时间是同步的。如果已经添加了摄像头/音频,它将被替换为新的。
  103. </p>
  104. <h3>[method:MMDAnimationHelper enable]( [param:String key], [param:Boolean enabled] )</h3>
  105. <p>
  106. [page:String key] — 允许的字符串为 'animation'、'ik'、'grant'、'physicals' 和 'cameraAnimation'。<br />
  107. [page:Boolean enabled] — true 表示启用,false 表示禁用。<br />
  108. </p>
  109. <p>
  110. 启用/禁用动画功能
  111. </p>
  112. <h3>[method:MMDAnimationHelper pose]( [param:SkinnedMesh mesh], [param:Object vpd], [param:Object params] )</h3>
  113. <p>
  114. [page:SkinnedMesh mesh] — [page:SkinnedMesh] 改变姿势。不需要将其添加到 helper 中。<br />
  115. [page:Object vpd] — 获取由 [page:MMDLoader].loadVPD 加载的 VPD 内容<br />
  116. [page:Object params] — (可选)<br />
  117. </p>
  118. <ul>
  119. <li>[page:Boolean resetPose] - 默认为 true</li>
  120. <li>[page:Boolean ik] - 默认为 true</li>
  121. <li>[page:Boolean grant] - 默认为 true</li>
  122. </ul>
  123. <p>
  124. 根据 VPD 内容指定 更改 [page:SkinnedMesh] 的姿势。
  125. </p>
  126. <h3>[method:MMDAnimationHelper remove]( [param:Object3D object] )</h3>
  127. <p>
  128. [page:Object3D object] — [page:SkinnedMesh]、[page:Camera] 或 [page:Audio]<br />
  129. </p>
  130. <p>
  131. 从助手中删除 [page:SkinnedMesh]、[page:Camera] 或 [page:Audio]。
  132. </p>
  133. <h3>[method:MMDAnimationHelper update]( [param:Number delta] )</h3>
  134. <p>
  135. [page:Number delta] — 秒数<br />
  136. </p>
  137. <p>
  138. 提前混合器时间并更新添加到助手的对象的动画。
  139. </p>
  140. <h2>源代码</h2>
  141. <p>
  142. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/animation/MMDAnimationHelper.js examples/jsm/animation/MMDAnimationHelper.js]
  143. </p>
  144. </body>
  145. </html>