AnimationAction.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. <!DOCTYPE html>
  2. <html lang="fr">
  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>[name]</h1>
  11. <p class="desc">
  12. Les AnimationActions programment la performance des animations qui sont stockées dans
  13. [page:AnimationClip AnimationClips].<br /><br />
  14. Note: La plupart des méthodes d'AnimationAction peuvent être chainées.<br /><br />
  15. Pour avoir un aperçu des différents éléments du système d'animation de three.js, consultez
  16. l'article "Système d'Animation" dans la section "Étapes Suivantes" du manuel.
  17. </p>
  18. <h2>Constructeur</h2>
  19. <h3>[name]( [param:AnimationMixer mixer], [param:AnimationClip clip], [param:Object3D localRoot] )</h3>
  20. <p>
  21. [page:AnimationMixer mixer] - l'`AnimationMixer` contrôlé par cette action.<br />
  22. [page:AnimationClip clip] - l`AnimationClip` qui contient les données d'animation pour cette action.<br />
  23. [page:Object3D localRoot] - l'objet racine sur lequel est appliqué l'action.<br /><br />
  24. Note: Au lieu d'appeler ce constructeur directement, vous devriez instantier un AnimationAction avec
  25. [page:AnimationMixer.clipAction] étant donné que cette méthode applique une mise en cache pour obtenir de meilleures performances.
  26. </p>
  27. <h2>Propriétés</h2>
  28. <h3>[property:Boolean clampWhenFinished]</h3>
  29. <p>
  30. Si `clampWhenFinished` est mis à true l'animation sera automatiquement [page:.paused mise en pause]
  31. à son dernier frame.<br /><br />
  32. Si `clampWhenFinished` est mis à false, [page:.enabled enabled] sera automatiquement reglé sur
  33. false quand la dernière boucle de l'action sera terminée, afin que cette action n'ai pas plus
  34. d'impact.<br /><br />
  35. La valeur par défaut est false.<br /><br />
  36. Note: `clampWhenFinished` n'a pas d'impact si l'action est interrompue (il n'a d'impact que si
  37. la dernière boucle de l'action s'est réellement terminée).
  38. </p>
  39. <h3>[property:Boolean enabled]</h3>
  40. <p>
  41. Régler `enabled` sur `false` désactive cette action, afin qu'elle n'ai aucun impact. La valeur par défaut est `true`.<br /><br />
  42. Quand l'action est réactivée, l'animation continue depuis son [page:.time time] actuel
  43. (Régler `enabled` sur `false` ne relance pas l'action).<br /><br />
  44. Note: Régler `enabled` sur `true` ne redémarre pas automatiquement l'action. Régler `enabled`
  45. sur `true` ne redémarrera l'action immédiatement que si les conditions suivantes sont remplies:
  46. [page:.paused paused] est à `false`, l'action n'a pas été désactivée (en
  47. exécutant un [page:.stop stop] ou un [page:.reset reset]), et ni [page:.weight weight]
  48. ni [page:.timeScale timeScale] ne sont à `0`.
  49. </p>
  50. <h3>[property:Number loop]</h3>
  51. <p>
  52. Le mode répeter (peut-être changé avec [page:.setLoop setLoop]). Sa valeur par défaut est
  53. [page:Animation THREE.LoopRepeat] (avec un nombre infini de répétitions [page:.repetitions repetitions])<br /><br />
  54. Doit être une de ces constantes:<br /><br />
  55. [page:Animation THREE.LoopOnce] - joue le clip une fois,<br />
  56. [page:Animation THREE.LoopRepeat] - joue le clip le nombre choisi de `répetitions`,
  57. en sautant à chaque fois de la fin du clip à son début,<br />
  58. [page:Animation THREE.LoopPingPong] - joue le clip le nombre choisi de `répetitions`,
  59. alternant entre lecture du début vers la fin et lecture de la fin vers le début.
  60. </p>
  61. <h3>[property:Boolean paused]</h3>
  62. <p>
  63. Régler `paused` sur `true` met l'exécution de l'action en pause en mettant l'échelle temporelle effective
  64. à `0`. La valeur par défaut est `false`.<br /><br />
  65. </p>
  66. <h3>[property:Number repetitions]</h3>
  67. <p>
  68. Le nombre de répétitions de l'[page:AnimationClip] actuel réalisées durant cette action.
  69. Peut-être paramétré depuis [page:.setLoop setLoop]. La valeur par défaut est `Infinity`.<br /><br />
  70. Changer ce nombre n'a aucun effet, si le [page:.loop loop mode] est réglé sur
  71. [page:Animation THREE.LoopOnce].
  72. </p>
  73. <h3>[property:Number time]</h3>
  74. <p>
  75. Le temps local de cette action (en secondes, en commençant par `0`).<br /><br />
  76. La valeur peut-être restreinte à `0...clip.duration` (selon l'état de la boucle). Il peut être
  77. mis à l'échelle relativement à celui du mixer global en changeant [page:.timeScale timeScale] (en utilisant
  78. [page:.setEffectiveTimeScale setEffectiveTimeScale] ou [page:.setDuration setDuration]).<br />
  79. </p>
  80. <h3>[property:Number timeScale]</h3>
  81. <p>
  82. Facteur de mise à l'échelle pour le [page:.time time]. Une valeur de `0` cause la mise en pause de l'animation. Une valeur
  83. négative fera jouer l'animation à l'envers . La valeur par défaut est `1`.<br /><br />
  84. Les propriétés/méthodes concernant `timeScale` (respectivement `time`) sont:
  85. [page:.getEffectiveTimeScale getEffectiveTimeScale],
  86. [page:.halt halt],
  87. [page:.paused paused],
  88. [page:.setDuration setDuration],
  89. [page:.setEffectiveTimeScale setEffectiveTimeScale],
  90. [page:.stopWarping stopWarping],
  91. [page:.syncWith syncWith],
  92. [page:.warp warp].
  93. </p>
  94. <h3>[property:Number weight]</h3>
  95. <p>
  96. Le degré d'importance d'une action (compris dans l'intervalle `[0, 1]`). Les valeurs entre `0` (aucun impact)
  97. et 1 (impact total) peuvent être utilisées pour mélanger plusieurs actions. La valeur par défaut est `1`. <br /><br />
  98. Les propriétés/méthodes concernant `weight` sont:
  99. [page:.crossFadeFrom crossFadeFrom],
  100. [page:.crossFadeTo crossFadeTo],
  101. [page:.enabled enabled],
  102. [page:.fadeIn fadeIn],
  103. [page:.fadeOut fadeOut],
  104. [page:.getEffectiveWeight getEffectiveWeight],
  105. [page:.setEffectiveWeight setEffectiveWeight],
  106. [page:.stopFading stopFading].
  107. </p>
  108. <h3>[property:Boolean zeroSlopeAtEnd]</h3>
  109. <p>
  110. Permet une interpolation fluide sans avoir de clips séparés pour le début, les répétitions et la fin. La valeur par défaut est `true`.
  111. </p>
  112. <h3>[property:Boolean zeroSlopeAtStart]</h3>
  113. <p>
  114. Permet une interpolation fluide sans avoir de clips séparés pour le début, les répétitions et la fin. La valeur par défaut est `true`.
  115. </p>
  116. <h2>Méthodes</h2>
  117. <h3>[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
  118. <p>
  119. Provoque l'[page:.fadeIn apparition] de cette action, en faisant disparaître une autre action simultanément, durant
  120. l'intervalle de temps passée en paramètre. Cette méthode peut être chaînée.<br /><br />
  121. Si warpBoolean est à true, un [page:.warp warping] additionnel (changement graduel de l'échelle temporelle)
  122. sera appliqué.<br /><br />
  123. Note: Comme avec `fadeIn`/`fadeOut`, le fading commence/termine avec un weight à 1.
  124. </p>
  125. <h3>[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
  126. <p>
  127. Provoque la [page:.fadeIn disparition] de cette action, en faisant apparaître une autre action simultanément, durant
  128. l'intervalle de temps passée en paramètre. Cette méthode peut être chaînée.<br /><br />
  129. Si warpBoolean est à true, un [page:.warp warping] additionnel (changement graduel de l'échelle temporelle)
  130. sera appliqué.<br /><br />
  131. Note: Comme avec `fadeIn`/`fadeOut`, le fading commence/termine avec un weight à 1.
  132. </p>
  133. <h3>[method:this fadeIn]( [param:Number durationInSeconds] )</h3>
  134. <p>
  135. Augmente graduellement le [page:.weight weight] de cette action de `0` à `1`, durant
  136. l'intervalle de temps passée en paramètre. Cette méthode peut être chaînée.
  137. </p>
  138. <h3>[method:this fadeOut]( [param:Number durationInSeconds] )</h3>
  139. <p>
  140. Diminue graduellement le [page:.weight weight] de cette de `1` à `0`, durant
  141. l'intervalle de temps passée en paramètre. Cette méthode peut être chaînée.
  142. </p>
  143. <h3>[method:Number getEffectiveTimeScale]()</h3>
  144. <p>
  145. Renvoie l'échelle temporelle effective (en prenant en compte l'état actuel du warping et de
  146. [page:.paused paused]).
  147. </p>
  148. <h3>[method:Number getEffectiveWeight]()</h3>
  149. <p>
  150. Renvoie le weight effectif (en prenant en compte l'état actuel du fondu et de
  151. [page:.enabled enabled]).
  152. </p>
  153. <h3>[method:AnimationClip getClip]()</h3>
  154. <p>
  155. Renvoie le clip qui contient les données d'animation pour cette action.
  156. </p>
  157. <h3>[method:AnimationMixer getMixer]()</h3>
  158. <p>
  159. Renvoie le mixer qui est responsable de jouer cette action.
  160. </p>
  161. <h3>[method:Object3D getRoot]()</h3>
  162. <p>
  163. Renvoie l'objet racine sur lequel l'action est appliquée.
  164. </p>
  165. <h3>[method:this halt]( [param:Number durationInSeconds] )</h3>
  166. <p>
  167. Diminue la vitesse de l'animation jusqu'à `0` en diminuant le [page:.timeScale timeScale] graduellement
  168. (en commençant depuis sa valeur actuelle), durant l'intervalle de temps passée en paramètre. Cette méthode peut être chaînée.
  169. </p>
  170. <h3>[method:Boolean isRunning]()</h3>
  171. <p>
  172. Renvoie true si le [page:.time time] de l'action est en cours.<br /><br />
  173. En plus d'être activé dans le mixer (see [page:.isScheduled isScheduled]) les conditions suivantes doivent être remplies:
  174. [page:.paused paused] est à faux, [page:.enabled enabled] est à true,
  175. [page:.timeScale timeScale] est différent de `0`, et un départ différé n'est pas programmé
  176. ([page:.startAt startAt]).<br /><br />
  177. Note: le fait que `isRunning` soit à true n'indique pas nécessairement que l'action est visible.
  178. C'est seulement le cas si le [page:.weight weight] est reglé sur une valeur non-nulle.
  179. </p>
  180. <h3>[method:Boolean isScheduled]()</h3>
  181. <p>
  182. Renvoie true, si cette action est activée dans le mixer.<br /><br />
  183. Note: Cela n'indique pas nécessairement que l'action est en cours d'éxécution (voir les conditions additionnelles
  184. pour [page:.isRunning isRunning]).
  185. </p>
  186. <h3>[method:this play]()</h3>
  187. <p>
  188. Indique au mixer d'activer cette action. Cette méthode peut être chaînée.<br /><br />
  189. Note: Activer cette action ne signifie pas nécessairement que l'animation démarrera directement:
  190. Si l'action s'était déjà terminée avant (en atteignant la fin de sa dernière boucle), ou si une durée
  191. pour un départ différé a été renseignée (via [page:.startAt startAt]), un [page:.reset reset] doit être
  192. éxécuté avant. Quelques autres paramètres ([page:.paused paused]=true, [page:.enabled enabled]=false,
  193. [page:.weight weight]=0, [page:.timeScale timeScale]=0) peuvent empêcher cette animation d'être jouée,
  194. également.
  195. </p>
  196. <h3>[method:this reset]()</h3>
  197. <p>
  198. Réinitialise l'action. Cette méthode peut être chaînée.<br /><br />
  199. Cette méthode passe [page:.paused paused] à false, [page:.enabled enabled] à true,
  200. [page:.time time] à `0`, annule tous les fondus et warping programmés, retire le compteur
  201. de boucles interne et les départs différés programmés.<br /><br />
  202. Note: .`reset` est toujours appelé par [page:.stop stop], mais .`reset` n'appelle pas .`stop` de lui-même.
  203. Cela signifie que: Si vous voulez à la fois, réinitialiser et stopper, n'appellez pas .`reset`; mais .`stop`.
  204. </p>
  205. <h3>[method:this setDuration]( [param:Number durationInSeconds] )</h3>
  206. <p>
  207. Renseigne la durée pour une seule boucle de cette action (en modifiant [page:.timeScale timeScale]
  208. et en stoppant tous les warpings programmés). Cette méthode peut être chaînée.
  209. </p>
  210. <h3>[method:this setEffectiveTimeScale]( [param:Number timeScale] )</h3>
  211. <p>
  212. Renseigne le [page:.timeScale timeScale] et stoppe tous les warpings programmés. Cette méthode peut être chaînée.<br /><br />
  213. Si [page:.paused paused] est à false, l'échelle temporelle effective (propriété interne) sera également
  214. mise à cette valeur; par ailleurs l'échelle temporelle effective (affectant directement l'animation à
  215. cet instant) sera mis à `0`.<br /><br />
  216. Note: .`paused` ne sera pas automatiquement mis à `true`, si le .`timeScale` est mis à `0` par
  217. cette méthode.
  218. </p>
  219. <h3>[method:this setEffectiveWeight]( [param:Number weight] )</h3>
  220. <p>
  221. Renseigne le [page:.weight weight] et stop tous les fondus programmés. Cette méthode peut être chaînée.<br /><br />
  222. Si [page:.enabled enabled] est à true, le weight effectif (propriété interne) sera également mis
  223. à cette valeur; Par ailleurs le weight effectif (affectant directement l'action à cet instant)
  224. sera mis à `0`.<br /><br />
  225. Note: .`enabled` ne sera pas automatiquement mis à `false`, si le .`weight` est mis à `0` par
  226. cette méthode.
  227. </p>
  228. <h3>[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )</h3>
  229. <p>
  230. Renseigne le [page:.loop loop mode] et le nombre de [page:.repetitions répétitions]. Cette méthode
  231. peut être chaînée.
  232. </p>
  233. <h3>[method:this startAt]( [param:Number startTimeInSeconds] )</h3>
  234. <p>
  235. Définis le temps pour un départ différé (généralement [page:AnimationMixer.time] +
  236. deltaTimeInSeconds). Cette méthode peut être chaînée.<br /><br />
  237. Note: Cette action ne commencera qu'à un temps donné, si .`startAt` est chaîné avec
  238. [page:.play play], ou si l'action a déjà été activée dans le mixer (par un appel précédent
  239. de .`play`, sans l'avoir stoppée ou réinitialisée entre temps).
  240. </p>
  241. <h3>[method:this stop]()</h3>
  242. <p>
  243. Indique au mixer de désactiver cette action. Cette méthode peut être chaînée.<br /><br />
  244. L'action sera immédiatement stoppée et complètement [page:.reset reset].<br /><br />
  245. Note: Vous pouvez stopper simultanément toutes les actions actives d'un même mixer via
  246. [page:AnimationMixer.stopAllAction mixer.stopAllAction].
  247. </p>
  248. <h3>[method:this stopFading]()</h3>
  249. <p>
  250. Stoppe tous les [page:.fadeIn fondus] programmés qui sont appliqués à cette action. Cette méthode peut être
  251. chaînée.
  252. </p>
  253. <h3>[method:this stopWarping]()</h3>
  254. <p>
  255. Stoppe tous les [page:.warp warping] programmés qui sont appliqués à cette action. Cette méthode peut être
  256. chaînée.
  257. </p>
  258. <h3>[method:this syncWith]( [param:AnimationAction otherAction] )</h3>
  259. <p>
  260. Synchronise cette action avec l'action passée en paramètre. Cette méthode peut être chaînée.<br /><br />
  261. La synchronisation est faite en dupliquant les valeurs du [page:.time time] et du [page:.timeScale timeScale] de l'autre action
  262. (stoppant tous les warpings programmés).<br /><br />
  263. Note: Les changements futurs du `time` et du `timeScale` de l'autre action ne seront pas détéctés.
  264. </p>
  265. <h3>[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )</h3>
  266. <p>
  267. Change la vitesse de lecture, durant l'intervalle temporelle passée en paramètre, en modifiant le
  268. [page:.timeScale timeScale] graduellement depuis `startTimeScale` jusqu'à `endTimeScale`. Cette méthode
  269. peut être chaînée.
  270. </p>
  271. <h2>Évènements</h2>
  272. <p class="desc">
  273. Il y a deux évènements indiquant quand une boucle de l'animation ou l'animation elle-même s'est terminée. Vous pouvez y réagir avec:
  274. </p>
  275. <code>
  276. mixer.addEventListener( 'loop', function( e ) { …} ); // properties of e: type, action and loopDelta
  277. mixer.addEventListener( 'finished', function( e ) { …} ); // properties of e: type, action and direction
  278. </code>
  279. <h2>Source</h2>
  280. <p>
  281. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  282. </p>
  283. </body>
  284. </html>