PropertyMixer.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>PropertyMixer - 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. <h1 translate="no">PropertyMixer</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>Buffered scene graph property that allows weighted accumulation; used internally.</p></div>
  16. </header>
  17. <article>
  18. <div class="container-overview">
  19. <h2>Constructor</h2>
  20. <h3 class="name name-method" id="PropertyMixer" translate="no">new <a href="#PropertyMixer">PropertyMixer</a><span class="signature">( binding : <span class="param-type"><a href="PropertyBinding.html">PropertyBinding</a></span>, typeName : <span class="param-type">string</span>, valueSize : <span class="param-type">number</span> )</span> </h3>
  21. <div class="method">
  22. <div class="description">
  23. <p>Constructs a new property mixer.</p>
  24. </div>
  25. <table class="params">
  26. <tbody>
  27. <tr>
  28. <td class="name">
  29. <strong>binding</strong>
  30. </td>
  31. <td class="description last">
  32. <p>The property binding.</p>
  33. </td>
  34. </tr>
  35. <tr>
  36. <td class="name">
  37. <strong>typeName</strong>
  38. </td>
  39. <td class="description last">
  40. <p>The keyframe track type name.</p>
  41. </td>
  42. </tr>
  43. <tr>
  44. <td class="name">
  45. <strong>valueSize</strong>
  46. </td>
  47. <td class="description last">
  48. <p>The keyframe track value size.</p>
  49. </td>
  50. </tr>
  51. </tbody>
  52. </table>
  53. </div>
  54. </div>
  55. <h2 class="subsection-title">Properties</h2>
  56. <div class="member">
  57. <h3 class="name" id="binding" translate="no">.<a href="#binding">binding</a><span class="type-signature"> : <a href="PropertyBinding.html">PropertyBinding</a></span> </h3>
  58. <div class="description">
  59. <p>The property binding.</p>
  60. </div>
  61. </div>
  62. <div class="member">
  63. <h3 class="name" id="cumulativeWeight" translate="no">.<a href="#cumulativeWeight">cumulativeWeight</a><span class="type-signature"> : number</span> </h3>
  64. <div class="description">
  65. <p>TODO</p>
  66. <p>Default is <code>0</code>.</p>
  67. </div>
  68. </div>
  69. <div class="member">
  70. <h3 class="name" id="cumulativeWeightAdditive" translate="no">.<a href="#cumulativeWeightAdditive">cumulativeWeightAdditive</a><span class="type-signature"> : number</span> </h3>
  71. <div class="description">
  72. <p>TODO</p>
  73. <p>Default is <code>0</code>.</p>
  74. </div>
  75. </div>
  76. <div class="member">
  77. <h3 class="name" id="referenceCount" translate="no">.<a href="#referenceCount">referenceCount</a><span class="type-signature"> : number</span> </h3>
  78. <div class="description">
  79. <p>TODO</p>
  80. <p>Default is <code>0</code>.</p>
  81. </div>
  82. </div>
  83. <div class="member">
  84. <h3 class="name" id="useCount" translate="no">.<a href="#useCount">useCount</a><span class="type-signature"> : number</span> </h3>
  85. <div class="description">
  86. <p>TODO</p>
  87. <p>Default is <code>0</code>.</p>
  88. </div>
  89. </div>
  90. <div class="member">
  91. <h3 class="name" id="valueSize" translate="no">.<a href="#valueSize">valueSize</a><span class="type-signature"> : number</span> </h3>
  92. <div class="description">
  93. <p>The keyframe track value size.</p>
  94. </div>
  95. </div>
  96. <h2 class="subsection-title">Methods</h2>
  97. <h3 class="name name-method" id="accumulate" translate="no">.<a href="#accumulate">accumulate</a><span class="signature">( accuIndex : <span class="param-type">number</span>, weight : <span class="param-type">number</span> )</span> </h3>
  98. <div class="method">
  99. <div class="description">
  100. <p>Accumulates data in the <code>incoming</code> region into <code>accu&lt;i&gt;</code>.</p>
  101. </div>
  102. <table class="params">
  103. <tbody>
  104. <tr>
  105. <td class="name">
  106. <strong>accuIndex</strong>
  107. </td>
  108. <td class="description last">
  109. <p>The accumulation index.</p>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td class="name">
  114. <strong>weight</strong>
  115. </td>
  116. <td class="description last">
  117. <p>The weight.</p>
  118. </td>
  119. </tr>
  120. </tbody>
  121. </table>
  122. </div>
  123. <h3 class="name name-method" id="accumulateAdditive" translate="no">.<a href="#accumulateAdditive">accumulateAdditive</a><span class="signature">( weight : <span class="param-type">number</span> )</span> </h3>
  124. <div class="method">
  125. <div class="description">
  126. <p>Accumulates data in the <code>incoming</code> region into <code>add</code>.</p>
  127. </div>
  128. <table class="params">
  129. <tbody>
  130. <tr>
  131. <td class="name">
  132. <strong>weight</strong>
  133. </td>
  134. <td class="description last">
  135. <p>The weight.</p>
  136. </td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. </div>
  141. <h3 class="name name-method" id="apply" translate="no">.<a href="#apply">apply</a><span class="signature">( accuIndex : <span class="param-type">number</span> )</span> </h3>
  142. <div class="method">
  143. <div class="description">
  144. <p>Applies the state of <code>accu&lt;i&gt;</code> to the binding when accus differ.</p>
  145. </div>
  146. <table class="params">
  147. <tbody>
  148. <tr>
  149. <td class="name">
  150. <strong>accuIndex</strong>
  151. </td>
  152. <td class="description last">
  153. <p>The accumulation index.</p>
  154. </td>
  155. </tr>
  156. </tbody>
  157. </table>
  158. </div>
  159. <h3 class="name name-method" id="restoreOriginalState" translate="no">.<a href="#restoreOriginalState">restoreOriginalState</a><span class="signature">()</span> </h3>
  160. <div class="method">
  161. <div class="description">
  162. <p>Applies the state previously taken via <a href="PropertyMixer.html#saveOriginalState">PropertyMixer#saveOriginalState</a> to the binding.</p>
  163. </div>
  164. </div>
  165. <h3 class="name name-method" id="saveOriginalState" translate="no">.<a href="#saveOriginalState">saveOriginalState</a><span class="signature">()</span> </h3>
  166. <div class="method">
  167. <div class="description">
  168. <p>Remembers the state of the bound property and copy it to both accus.</p>
  169. </div>
  170. </div>
  171. <h2 class="subsection-title">Source</h2>
  172. <p>
  173. <a href="https://github.com/mrdoob/three.js/blob/master/src/animation/PropertyMixer.js" translate="no" target="_blank" rel="noopener">src/animation/PropertyMixer.js</a>
  174. </p>
  175. </article>
  176. </section>
  177. <script src="../scripts/linenumber.js"></script>
  178. <script src="../scripts/page.js"></script>
  179. </body>
  180. </html>
粤ICP备19079148号