AnimationAction.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>AnimationAction - 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">AnimationAction</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>An instance of <code>AnimationAction</code> schedules the playback of an animation which is
  16. stored in <a href="AnimationClip.html">AnimationClip</a>.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="AnimationAction" translate="no">new <a href="#AnimationAction">AnimationAction</a><span class="signature">( mixer : <span class="param-type"><a href="AnimationMixer.html">AnimationMixer</a></span>, clip : <span class="param-type"><a href="AnimationClip.html">AnimationClip</a></span>, localRoot : <span class="param-type"><a href="Object3D.html">Object3D</a></span>, blendMode : <span class="param-type"><a href="global.html#NormalAnimationBlendMode">NormalAnimationBlendMode</a> | <a href="global.html#AdditiveAnimationBlendMode">AdditiveAnimationBlendMode</a></span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new animation action.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name">
  30. <strong>mixer</strong>
  31. </td>
  32. <td class="description last">
  33. <p>The mixer that is controlled by this action.</p>
  34. </td>
  35. </tr>
  36. <tr>
  37. <td class="name">
  38. <strong>clip</strong>
  39. </td>
  40. <td class="description last">
  41. <p>The animation clip that holds the actual keyframes.</p>
  42. </td>
  43. </tr>
  44. <tr>
  45. <td class="name">
  46. <strong>localRoot</strong>
  47. </td>
  48. <td class="description last">
  49. <p>The root object on which this action is performed.</p>
  50. <p>Default is <code>null</code>.</p>
  51. </td>
  52. </tr>
  53. <tr>
  54. <td class="name">
  55. <strong>blendMode</strong>
  56. </td>
  57. <td class="description last">
  58. <p>The blend mode.</p>
  59. </td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. </div>
  64. </div>
  65. <h2 class="subsection-title">Properties</h2>
  66. <div class="member">
  67. <h3 class="name" id="blendMode" translate="no">.<a href="#blendMode">blendMode</a><span class="type-signature"> : <a href="global.html#NormalAnimationBlendMode">NormalAnimationBlendMode</a> | <a href="global.html#AdditiveAnimationBlendMode">AdditiveAnimationBlendMode</a></span> </h3>
  68. <div class="description">
  69. <p>Defines how the animation is blended/combined when two or more animations
  70. are simultaneously played.</p>
  71. </div>
  72. </div>
  73. <div class="member">
  74. <h3 class="name" id="clampWhenFinished" translate="no">.<a href="#clampWhenFinished">clampWhenFinished</a><span class="type-signature"> : boolean</span> </h3>
  75. <div class="description">
  76. <p>If set to true the animation will automatically be paused on its last frame.</p>
  77. <p>If set to false, <a href="AnimationAction.html#enabled">AnimationAction#enabled</a> will automatically be switched
  78. to <code>false</code> when the last loop of the action has finished, so that this action has
  79. no further impact.</p>
  80. <p>Note: This member has no impact if the action is interrupted (it
  81. has only an effect if its last loop has really finished).</p>
  82. <p>Default is <code>false</code>.</p>
  83. </div>
  84. </div>
  85. <div class="member">
  86. <h3 class="name" id="enabled" translate="no">.<a href="#enabled">enabled</a><span class="type-signature"> : boolean</span> </h3>
  87. <div class="description">
  88. <p>If set to <code>false</code>, the action is disabled so it has no impact.</p>
  89. <p>When the action is re-enabled, the animation continues from its current
  90. time (setting <code>enabled</code> to <code>false</code> doesn't reset the action).</p>
  91. <p>Default is <code>true</code>.</p>
  92. </div>
  93. </div>
  94. <div class="member">
  95. <h3 class="name" id="loop" translate="no">.<a href="#loop">loop</a><span class="type-signature"> : <a href="global.html#LoopRepeat">LoopRepeat</a> | <a href="global.html#LoopOnce">LoopOnce</a> | <a href="global.html#LoopPingPong">LoopPingPong</a></span> </h3>
  96. <div class="description">
  97. <p>The loop mode, set via <a href="AnimationAction.html#setLoop">AnimationAction#setLoop</a>.</p>
  98. <p>Default is <code>LoopRepeat</code>.</p>
  99. </div>
  100. </div>
  101. <div class="member">
  102. <h3 class="name" id="paused" translate="no">.<a href="#paused">paused</a><span class="type-signature"> : boolean</span> </h3>
  103. <div class="description">
  104. <p>If set to <code>true</code>, the playback of the action is paused.</p>
  105. <p>Default is <code>false</code>.</p>
  106. </div>
  107. </div>
  108. <div class="member">
  109. <h3 class="name" id="repetitions" translate="no">.<a href="#repetitions">repetitions</a><span class="type-signature"> : number</span> </h3>
  110. <div class="description">
  111. <p>The number of repetitions of the performed clip over the course of this action.
  112. Can be set via <a href="AnimationAction.html#setLoop">AnimationAction#setLoop</a>.</p>
  113. <p>Setting this number has no effect if <a href="AnimationAction.html#loop">AnimationAction#loop</a> is set to
  114. <code>THREE:LoopOnce</code>.</p>
  115. <p>Default is <code>Infinity</code>.</p>
  116. </div>
  117. </div>
  118. <div class="member">
  119. <h3 class="name" id="time" translate="no">.<a href="#time">time</a><span class="type-signature"> : number</span> </h3>
  120. <div class="description">
  121. <p>The local time of this action (in seconds, starting with <code>0</code>).</p>
  122. <p>The value gets clamped or wrapped to <code>[0,clip.duration]</code> (according to the
  123. loop state).</p>
  124. <p>Default is <code>Infinity</code>.</p>
  125. </div>
  126. </div>
  127. <div class="member">
  128. <h3 class="name" id="timeScale" translate="no">.<a href="#timeScale">timeScale</a><span class="type-signature"> : number</span> </h3>
  129. <div class="description">
  130. <p>Scaling factor for the <a href="AnimationAction.html#time">AnimationAction#time</a>. A value of <code>0</code> causes the
  131. animation to pause. Negative values cause the animation to play backwards.</p>
  132. <p>Default is <code>1</code>.</p>
  133. </div>
  134. </div>
  135. <div class="member">
  136. <h3 class="name" id="weight" translate="no">.<a href="#weight">weight</a><span class="type-signature"> : number</span> </h3>
  137. <div class="description">
  138. <p>The degree of influence of this action (in the interval <code>[0, 1]</code>). Values
  139. between <code>0</code> (no impact) and <code>1</code> (full impact) can be used to blend between
  140. several actions.</p>
  141. <p>Default is <code>1</code>.</p>
  142. </div>
  143. </div>
  144. <div class="member">
  145. <h3 class="name" id="zeroSlopeAtEnd" translate="no">.<a href="#zeroSlopeAtEnd">zeroSlopeAtEnd</a><span class="type-signature"> : boolean</span> </h3>
  146. <div class="description">
  147. <p>Enables smooth interpolation without separate clips for start, loop and end.</p>
  148. <p>Default is <code>true</code>.</p>
  149. </div>
  150. </div>
  151. <div class="member">
  152. <h3 class="name" id="zeroSlopeAtStart" translate="no">.<a href="#zeroSlopeAtStart">zeroSlopeAtStart</a><span class="type-signature"> : boolean</span> </h3>
  153. <div class="description">
  154. <p>Enables smooth interpolation without separate clips for start, loop and end.</p>
  155. <p>Default is <code>true</code>.</p>
  156. </div>
  157. </div>
  158. <h2 class="subsection-title">Methods</h2>
  159. <h3 class="name name-method" id="crossFadeFrom" translate="no">.<a href="#crossFadeFrom">crossFadeFrom</a><span class="signature">( fadeOutAction : <span class="param-type"><a href="AnimationAction.html">AnimationAction</a></span>, duration : <span class="param-type">number</span>, warp : <span class="param-type">boolean</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  160. <div class="method">
  161. <div class="description">
  162. <p>Causes this action to fade in and the given action to fade out,
  163. within the passed time interval.</p>
  164. </div>
  165. <table class="params">
  166. <tbody>
  167. <tr>
  168. <td class="name">
  169. <strong>fadeOutAction</strong>
  170. </td>
  171. <td class="description last">
  172. <p>The animation action to fade out.</p>
  173. </td>
  174. </tr>
  175. <tr>
  176. <td class="name">
  177. <strong>duration</strong>
  178. </td>
  179. <td class="description last">
  180. <p>The duration of the fade.</p>
  181. </td>
  182. </tr>
  183. <tr>
  184. <td class="name">
  185. <strong>warp</strong>
  186. </td>
  187. <td class="description last">
  188. <p>Whether warping should be used or not.</p>
  189. <p>Default is <code>false</code>.</p>
  190. </td>
  191. </tr>
  192. </tbody>
  193. </table>
  194. <dl class="details">
  195. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  196. </dl>
  197. </div>
  198. <h3 class="name name-method" id="crossFadeTo" translate="no">.<a href="#crossFadeTo">crossFadeTo</a><span class="signature">( fadeInAction : <span class="param-type"><a href="AnimationAction.html">AnimationAction</a></span>, duration : <span class="param-type">number</span>, warp : <span class="param-type">boolean</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  199. <div class="method">
  200. <div class="description">
  201. <p>Causes this action to fade out and the given action to fade in,
  202. within the passed time interval.</p>
  203. </div>
  204. <table class="params">
  205. <tbody>
  206. <tr>
  207. <td class="name">
  208. <strong>fadeInAction</strong>
  209. </td>
  210. <td class="description last">
  211. <p>The animation action to fade in.</p>
  212. </td>
  213. </tr>
  214. <tr>
  215. <td class="name">
  216. <strong>duration</strong>
  217. </td>
  218. <td class="description last">
  219. <p>The duration of the fade.</p>
  220. </td>
  221. </tr>
  222. <tr>
  223. <td class="name">
  224. <strong>warp</strong>
  225. </td>
  226. <td class="description last">
  227. <p>Whether warping should be used or not.</p>
  228. <p>Default is <code>false</code>.</p>
  229. </td>
  230. </tr>
  231. </tbody>
  232. </table>
  233. <dl class="details">
  234. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  235. </dl>
  236. </div>
  237. <h3 class="name name-method" id="fadeIn" translate="no">.<a href="#fadeIn">fadeIn</a><span class="signature">( duration : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  238. <div class="method">
  239. <div class="description">
  240. <p>Fades the animation in by increasing its weight gradually from <code>0</code> to <code>1</code>,
  241. within the passed time interval.</p>
  242. </div>
  243. <table class="params">
  244. <tbody>
  245. <tr>
  246. <td class="name">
  247. <strong>duration</strong>
  248. </td>
  249. <td class="description last">
  250. <p>The duration of the fade.</p>
  251. </td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  257. </dl>
  258. </div>
  259. <h3 class="name name-method" id="fadeOut" translate="no">.<a href="#fadeOut">fadeOut</a><span class="signature">( duration : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  260. <div class="method">
  261. <div class="description">
  262. <p>Fades the animation out by decreasing its weight gradually from <code>1</code> to <code>0</code>,
  263. within the passed time interval.</p>
  264. </div>
  265. <table class="params">
  266. <tbody>
  267. <tr>
  268. <td class="name">
  269. <strong>duration</strong>
  270. </td>
  271. <td class="description last">
  272. <p>The duration of the fade.</p>
  273. </td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <dl class="details">
  278. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  279. </dl>
  280. </div>
  281. <h3 class="name name-method" id="getClip" translate="no">.<a href="#getClip">getClip</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationClip.html">AnimationClip</a></span> </h3>
  282. <div class="method">
  283. <div class="description">
  284. <p>Returns the animation clip of this animation action.</p>
  285. </div>
  286. <dl class="details">
  287. <dt class="tag-returns"><strong>Returns:</strong> The animation clip.</dt>
  288. </dl>
  289. </div>
  290. <h3 class="name name-method" id="getEffectiveTimeScale" translate="no">.<a href="#getEffectiveTimeScale">getEffectiveTimeScale</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
  291. <div class="method">
  292. <div class="description">
  293. <p>Returns the effective time scale of this action.</p>
  294. </div>
  295. <dl class="details">
  296. <dt class="tag-returns"><strong>Returns:</strong> The effective time scale.</dt>
  297. </dl>
  298. </div>
  299. <h3 class="name name-method" id="getEffectiveWeight" translate="no">.<a href="#getEffectiveWeight">getEffectiveWeight</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
  300. <div class="method">
  301. <div class="description">
  302. <p>Returns the effective weight of this action.</p>
  303. </div>
  304. <dl class="details">
  305. <dt class="tag-returns"><strong>Returns:</strong> The effective weight.</dt>
  306. </dl>
  307. </div>
  308. <h3 class="name name-method" id="getMixer" translate="no">.<a href="#getMixer">getMixer</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationMixer.html">AnimationMixer</a></span> </h3>
  309. <div class="method">
  310. <div class="description">
  311. <p>Returns the animation mixer of this animation action.</p>
  312. </div>
  313. <dl class="details">
  314. <dt class="tag-returns"><strong>Returns:</strong> The animation mixer.</dt>
  315. </dl>
  316. </div>
  317. <h3 class="name name-method" id="getRoot" translate="no">.<a href="#getRoot">getRoot</a><span class="signature">()</span><span class="type-signature"> : <a href="Object3D.html">Object3D</a></span> </h3>
  318. <div class="method">
  319. <div class="description">
  320. <p>Returns the root object of this animation action.</p>
  321. </div>
  322. <dl class="details">
  323. <dt class="tag-returns"><strong>Returns:</strong> The root object.</dt>
  324. </dl>
  325. </div>
  326. <h3 class="name name-method" id="halt" translate="no">.<a href="#halt">halt</a><span class="signature">( duration : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  327. <div class="method">
  328. <div class="description">
  329. <p>Decelerates this animation's speed to <code>0</code> within the passed time interval.</p>
  330. </div>
  331. <table class="params">
  332. <tbody>
  333. <tr>
  334. <td class="name">
  335. <strong>duration</strong>
  336. </td>
  337. <td class="description last">
  338. <p>The duration.</p>
  339. </td>
  340. </tr>
  341. </tbody>
  342. </table>
  343. <dl class="details">
  344. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  345. </dl>
  346. </div>
  347. <h3 class="name name-method" id="isRunning" translate="no">.<a href="#isRunning">isRunning</a><span class="signature">()</span><span class="type-signature"> : boolean</span> </h3>
  348. <div class="method">
  349. <div class="description">
  350. <p>Returns <code>true</code> if the animation is running.</p>
  351. </div>
  352. <dl class="details">
  353. <dt class="tag-returns"><strong>Returns:</strong> Whether the animation is running or not.</dt>
  354. </dl>
  355. </div>
  356. <h3 class="name name-method" id="isScheduled" translate="no">.<a href="#isScheduled">isScheduled</a><span class="signature">()</span><span class="type-signature"> : boolean</span> </h3>
  357. <div class="method">
  358. <div class="description">
  359. <p>Returns <code>true</code> when <a href="AnimationAction.html#play">AnimationAction#play</a> has been called.</p>
  360. </div>
  361. <dl class="details">
  362. <dt class="tag-returns"><strong>Returns:</strong> Whether the animation is scheduled or not.</dt>
  363. </dl>
  364. </div>
  365. <h3 class="name name-method" id="play" translate="no">.<a href="#play">play</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  366. <div class="method">
  367. <div class="description">
  368. <p>Starts the playback of the animation.</p>
  369. </div>
  370. <dl class="details">
  371. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  372. </dl>
  373. </div>
  374. <h3 class="name name-method" id="reset" translate="no">.<a href="#reset">reset</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  375. <div class="method">
  376. <div class="description">
  377. <p>Resets the playback of the animation.</p>
  378. </div>
  379. <dl class="details">
  380. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  381. </dl>
  382. </div>
  383. <h3 class="name name-method" id="setDuration" translate="no">.<a href="#setDuration">setDuration</a><span class="signature">( duration : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  384. <div class="method">
  385. <div class="description">
  386. <p>Sets the duration for a single loop of this action.</p>
  387. </div>
  388. <table class="params">
  389. <tbody>
  390. <tr>
  391. <td class="name">
  392. <strong>duration</strong>
  393. </td>
  394. <td class="description last">
  395. <p>The duration to set.</p>
  396. </td>
  397. </tr>
  398. </tbody>
  399. </table>
  400. <dl class="details">
  401. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  402. </dl>
  403. </div>
  404. <h3 class="name name-method" id="setEffectiveTimeScale" translate="no">.<a href="#setEffectiveTimeScale">setEffectiveTimeScale</a><span class="signature">( timeScale : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  405. <div class="method">
  406. <div class="description">
  407. <p>Sets the effective time scale of this action.</p>
  408. <p>An action has no effect and thus an effective time scale of zero when the
  409. action is paused.</p>
  410. </div>
  411. <table class="params">
  412. <tbody>
  413. <tr>
  414. <td class="name">
  415. <strong>timeScale</strong>
  416. </td>
  417. <td class="description last">
  418. <p>The time scale to set.</p>
  419. </td>
  420. </tr>
  421. </tbody>
  422. </table>
  423. <dl class="details">
  424. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  425. </dl>
  426. </div>
  427. <h3 class="name name-method" id="setEffectiveWeight" translate="no">.<a href="#setEffectiveWeight">setEffectiveWeight</a><span class="signature">( weight : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  428. <div class="method">
  429. <div class="description">
  430. <p>Sets the effective weight of this action.</p>
  431. <p>An action has no effect and thus an effective weight of zero when the
  432. action is disabled.</p>
  433. </div>
  434. <table class="params">
  435. <tbody>
  436. <tr>
  437. <td class="name">
  438. <strong>weight</strong>
  439. </td>
  440. <td class="description last">
  441. <p>The weight to set.</p>
  442. </td>
  443. </tr>
  444. </tbody>
  445. </table>
  446. <dl class="details">
  447. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  448. </dl>
  449. </div>
  450. <h3 class="name name-method" id="setLoop" translate="no">.<a href="#setLoop">setLoop</a><span class="signature">( mode : <span class="param-type"><a href="global.html#LoopRepeat">LoopRepeat</a> | <a href="global.html#LoopOnce">LoopOnce</a> | <a href="global.html#LoopPingPong">LoopPingPong</a></span>, repetitions : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  451. <div class="method">
  452. <div class="description">
  453. <p>Configures the loop settings for this action.</p>
  454. </div>
  455. <table class="params">
  456. <tbody>
  457. <tr>
  458. <td class="name">
  459. <strong>mode</strong>
  460. </td>
  461. <td class="description last">
  462. <p>The loop mode.</p>
  463. </td>
  464. </tr>
  465. <tr>
  466. <td class="name">
  467. <strong>repetitions</strong>
  468. </td>
  469. <td class="description last">
  470. <p>The number of repetitions.</p>
  471. </td>
  472. </tr>
  473. </tbody>
  474. </table>
  475. <dl class="details">
  476. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  477. </dl>
  478. </div>
  479. <h3 class="name name-method" id="startAt" translate="no">.<a href="#startAt">startAt</a><span class="signature">( time : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  480. <div class="method">
  481. <div class="description">
  482. <p>Defines the time when the animation should start.</p>
  483. </div>
  484. <table class="params">
  485. <tbody>
  486. <tr>
  487. <td class="name">
  488. <strong>time</strong>
  489. </td>
  490. <td class="description last">
  491. <p>The start time in seconds.</p>
  492. </td>
  493. </tr>
  494. </tbody>
  495. </table>
  496. <dl class="details">
  497. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  498. </dl>
  499. </div>
  500. <h3 class="name name-method" id="stop" translate="no">.<a href="#stop">stop</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  501. <div class="method">
  502. <div class="description">
  503. <p>Stops the playback of the animation.</p>
  504. </div>
  505. <dl class="details">
  506. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  507. </dl>
  508. </div>
  509. <h3 class="name name-method" id="stopFading" translate="no">.<a href="#stopFading">stopFading</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  510. <div class="method">
  511. <div class="description">
  512. <p>Stops any fading which is applied to this action.</p>
  513. </div>
  514. <dl class="details">
  515. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  516. </dl>
  517. </div>
  518. <h3 class="name name-method" id="stopWarping" translate="no">.<a href="#stopWarping">stopWarping</a><span class="signature">()</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  519. <div class="method">
  520. <div class="description">
  521. <p>Stops any scheduled warping which is applied to this action.</p>
  522. </div>
  523. <dl class="details">
  524. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  525. </dl>
  526. </div>
  527. <h3 class="name name-method" id="syncWith" translate="no">.<a href="#syncWith">syncWith</a><span class="signature">( action : <span class="param-type"><a href="AnimationAction.html">AnimationAction</a></span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  528. <div class="method">
  529. <div class="description">
  530. <p>Synchronizes this action with the passed other action.</p>
  531. </div>
  532. <table class="params">
  533. <tbody>
  534. <tr>
  535. <td class="name">
  536. <strong>action</strong>
  537. </td>
  538. <td class="description last">
  539. <p>The action to sync with.</p>
  540. </td>
  541. </tr>
  542. </tbody>
  543. </table>
  544. <dl class="details">
  545. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  546. </dl>
  547. </div>
  548. <h3 class="name name-method" id="warp" translate="no">.<a href="#warp">warp</a><span class="signature">( startTimeScale : <span class="param-type">number</span>, endTimeScale : <span class="param-type">number</span>, duration : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationAction.html">AnimationAction</a></span> </h3>
  549. <div class="method">
  550. <div class="description">
  551. <p>Changes the playback speed, within the passed time interval, by modifying
  552. <a href="AnimationAction.html#timeScale">AnimationAction#timeScale</a> gradually from <code>startTimeScale</code> to
  553. <code>endTimeScale</code>.</p>
  554. </div>
  555. <table class="params">
  556. <tbody>
  557. <tr>
  558. <td class="name">
  559. <strong>startTimeScale</strong>
  560. </td>
  561. <td class="description last">
  562. <p>The start time scale.</p>
  563. </td>
  564. </tr>
  565. <tr>
  566. <td class="name">
  567. <strong>endTimeScale</strong>
  568. </td>
  569. <td class="description last">
  570. <p>The end time scale.</p>
  571. </td>
  572. </tr>
  573. <tr>
  574. <td class="name">
  575. <strong>duration</strong>
  576. </td>
  577. <td class="description last">
  578. <p>The duration.</p>
  579. </td>
  580. </tr>
  581. </tbody>
  582. </table>
  583. <dl class="details">
  584. <dt class="tag-returns"><strong>Returns:</strong> A reference to this animation action.</dt>
  585. </dl>
  586. </div>
  587. <h2 class="subsection-title">Source</h2>
  588. <p>
  589. <a href="https://github.com/mrdoob/three.js/blob/master/src/animation/AnimationAction.js" translate="no" target="_blank" rel="noopener">src/animation/AnimationAction.js</a>
  590. </p>
  591. </article>
  592. </section>
  593. <script src="../scripts/linenumber.js"></script>
  594. <script src="../scripts/page.js"></script>
  595. </body>
  596. </html>
粤ICP备19079148号