classgameplay_1_1_animation_clip.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>AnimationClip Class Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#nested-classes">Classes</a> &#124;
  87. <a href="#pub-methods">Public Member Functions</a> &#124;
  88. <a href="#pub-static-attribs">Static Public Attributes</a> </div>
  89. <div class="headertitle">
  90. <div class="title">gameplay::AnimationClip Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <!-- doxytag: class="gameplay::AnimationClip" --><!-- doxytag: inherits="gameplay::Ref,gameplay::ScriptTarget" -->
  94. <p><code>#include &lt;AnimationClip.h&gt;</code></p>
  95. <div class="dynheader">
  96. Inheritance diagram for gameplay::AnimationClip:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="classgameplay_1_1_animation_clip.png" usemap="#gameplay::AnimationClip_map" alt=""/>
  100. <map id="gameplay::AnimationClip_map" name="gameplay::AnimationClip_map">
  101. <area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,149,24"/>
  102. <area href="classgameplay_1_1_script_target.html" alt="gameplay::ScriptTarget" shape="rect" coords="159,0,308,24"/>
  103. </map>
  104. </div></div>
  105. <p><a href="classgameplay_1_1_animation_clip-members.html">List of all members.</a></p>
  106. <table class="memberdecls">
  107. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  108. Classes</h2></td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">Listener</a></td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>ListenerEvent</b></td></tr>
  111. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  112. Public Member Functions</h2></td></tr>
  113. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a94ba56bb5e835db6bc9d6e310bd0b8e5">getTypeName</a> () const </td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a964b19aa8de84b2fa40ac07df7ffddff">getId</a> () const </td></tr>
  115. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_animation.html">Animation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a12c347102fdd8fdbe8e30804b1833742">getAnimation</a> () const </td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a66b9cad3b41aba5a1695917489b6f92d">getStartTime</a> () const </td></tr>
  117. <tr><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ae0898f2d6b4d3d886d1f2bba8ef0dbd5">getEndTime</a> () const </td></tr>
  118. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a931d14990e9524ea5e78ecb64e2bb198">getElapsedTime</a> () const </td></tr>
  119. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ab29326cd02dd538d28900b127896ab01">setRepeatCount</a> (float repeatCount)</td></tr>
  120. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a006f61a1f72e9428b5d9717530de04c1">getRepeatCount</a> () const </td></tr>
  121. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ac177842ec1730ce35cd02c47b03f8155">setActiveDuration</a> (unsigned long duration)</td></tr>
  122. <tr><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ac336294bfed721fecbe9520d103e993f">getActiveDuration</a> () const </td></tr>
  123. <tr><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a438b928a919fd2b0184c17c520bb2879">getDuration</a> () const </td></tr>
  124. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a0881be549f9b6d833fc055bdd1af57d2">setSpeed</a> (float speed)</td></tr>
  125. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a53442765a6241c12aedce275f7cf2248">getSpeed</a> () const </td></tr>
  126. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a128747035d2e8797a7364494a597c77f">setBlendWeight</a> (float blendWeight)</td></tr>
  127. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a87e1eb6ea8944308b8c3c6326565323f">getBlendWeight</a> () const </td></tr>
  128. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a48fab9d3a958cb9ab1fee3e3d290d89d">setLoopBlendTime</a> (float loopBlendTime)</td></tr>
  129. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ad6245c2a651db2a779c10478b2c6271f">getLoopBlendTime</a> () const </td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a5c94a21f0850ea1c91b5612571510027">isPlaying</a> () const </td></tr>
  131. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ae3f523b557ddfdb3ef8b05bee79d090c">play</a> ()</td></tr>
  132. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a60b8be3ef809c7001a870daf460267ba">stop</a> ()</td></tr>
  133. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ac74a4379207b09ec2f949b4bc64e88e9">pause</a> ()</td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a1a804917d2545152cb1885463fb53a0d">crossFade</a> (<a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> *clip, unsigned long duration)</td></tr>
  135. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#abf7d596e7960b8dfa7c79ace78aeaf71">addBeginListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener)</td></tr>
  136. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#af4d28a5db1cdb321c83b0f23a9b241c1">removeBeginListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener)</td></tr>
  137. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#af1e38797873c3fa5a8921e6b43e40719">addEndListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener)</td></tr>
  138. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#aec799b6c4b13d01eae0d6a0f1a84b68a">removeEndListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener)</td></tr>
  139. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#ac1ffa1b5991a31c5810902f72c445e64">addListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener, unsigned long eventTime)</td></tr>
  140. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a140f43660effeae41c302286d3b1849a">removeListener</a> (<a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *listener, unsigned long eventTime)</td></tr>
  141. <tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
  142. Static Public Attributes</h2></td></tr>
  143. <tr><td class="memItemLeft" align="right" valign="top">static const unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_clip.html#a32c79759c1e6a69d0d10db44579853b6">REPEAT_INDEFINITE</a> = 0</td></tr>
  144. </table>
  145. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  146. <div class="textblock"><p>Defines the runtime session of an <a class="el" href="classgameplay_1_1_animation.html">Animation</a> to be played. </p>
  147. </div><hr/><h2>Member Function Documentation</h2>
  148. <a class="anchor" id="abf7d596e7960b8dfa7c79ace78aeaf71"></a><!-- doxytag: member="gameplay::AnimationClip::addBeginListener" ref="abf7d596e7960b8dfa7c79ace78aeaf71" args="(AnimationClip::Listener *listener)" -->
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#abf7d596e7960b8dfa7c79ace78aeaf71">gameplay::AnimationClip::addBeginListener</a> </td>
  154. <td>(</td>
  155. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  156. <td class="paramname"><em>listener</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div>
  161. <div class="memdoc">
  162. <p>Adds an animation begin listener.</p>
  163. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  164. <table class="params">
  165. <tr><td class="paramname">listener</td><td>The listener to be called when an <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> begins. </td></tr>
  166. </table>
  167. </dd>
  168. </dl>
  169. </div>
  170. </div>
  171. <a class="anchor" id="af1e38797873c3fa5a8921e6b43e40719"></a><!-- doxytag: member="gameplay::AnimationClip::addEndListener" ref="af1e38797873c3fa5a8921e6b43e40719" args="(AnimationClip::Listener *listener)" -->
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#af1e38797873c3fa5a8921e6b43e40719">gameplay::AnimationClip::addEndListener</a> </td>
  177. <td>(</td>
  178. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  179. <td class="paramname"><em>listener</em></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </div>
  184. <div class="memdoc">
  185. <p>Adds an animation end listener.</p>
  186. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  187. <table class="params">
  188. <tr><td class="paramname">listener</td><td>The listener to be called when an <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> ends. </td></tr>
  189. </table>
  190. </dd>
  191. </dl>
  192. </div>
  193. </div>
  194. <a class="anchor" id="ac1ffa1b5991a31c5810902f72c445e64"></a><!-- doxytag: member="gameplay::AnimationClip::addListener" ref="ac1ffa1b5991a31c5810902f72c445e64" args="(AnimationClip::Listener *listener, unsigned long eventTime)" -->
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#ac1ffa1b5991a31c5810902f72c445e64">gameplay::AnimationClip::addListener</a> </td>
  200. <td>(</td>
  201. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  202. <td class="paramname"><em>listener</em>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">unsigned long&#160;</td>
  208. <td class="paramname"><em>eventTime</em>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td>)</td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </div>
  217. <div class="memdoc">
  218. <p>Adds an animation listener to be called back at the specified eventTime during the playback of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>.</p>
  219. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  220. <table class="params">
  221. <tr><td class="paramname">listener</td><td>The listener to be called when the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> reaches the specified time in its playback. </td></tr>
  222. <tr><td class="paramname">eventTime</td><td>The time the listener will be called during the playback of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. Must be between 0 and the duration of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </td></tr>
  223. </table>
  224. </dd>
  225. </dl>
  226. </div>
  227. </div>
  228. <a class="anchor" id="a1a804917d2545152cb1885463fb53a0d"></a><!-- doxytag: member="gameplay::AnimationClip::crossFade" ref="a1a804917d2545152cb1885463fb53a0d" args="(AnimationClip *clip, unsigned long duration)" -->
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a1a804917d2545152cb1885463fb53a0d">gameplay::AnimationClip::crossFade</a> </td>
  234. <td>(</td>
  235. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> *&#160;</td>
  236. <td class="paramname"><em>clip</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">unsigned long&#160;</td>
  242. <td class="paramname"><em>duration</em>&#160;</td>
  243. </tr>
  244. <tr>
  245. <td></td>
  246. <td>)</td>
  247. <td></td><td></td>
  248. </tr>
  249. </table>
  250. </div>
  251. <div class="memdoc">
  252. <p>Fades this clip out, and the specified clip in over the given duration.</p>
  253. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  254. <table class="params">
  255. <tr><td class="paramname">clip</td><td>The clip to fade into. </td></tr>
  256. <tr><td class="paramname">duration</td><td>The duration of the fade. </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. </div>
  261. </div>
  262. <a class="anchor" id="ac336294bfed721fecbe9520d103e993f"></a><!-- doxytag: member="gameplay::AnimationClip::getActiveDuration" ref="ac336294bfed721fecbe9520d103e993f" args="() const " -->
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">unsigned long <a class="el" href="classgameplay_1_1_animation_clip.html#ac336294bfed721fecbe9520d103e993f">gameplay::AnimationClip::getActiveDuration</a> </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td> const</td>
  271. </tr>
  272. </table>
  273. </div>
  274. <div class="memdoc">
  275. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s active duration.</p>
  276. <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s active duration. </dd></dl>
  277. </div>
  278. </div>
  279. <a class="anchor" id="a12c347102fdd8fdbe8e30804b1833742"></a><!-- doxytag: member="gameplay::AnimationClip::getAnimation" ref="a12c347102fdd8fdbe8e30804b1833742" args="() const " -->
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_clip.html#a12c347102fdd8fdbe8e30804b1833742">gameplay::AnimationClip::getAnimation</a> </td>
  285. <td>(</td>
  286. <td class="paramname"></td><td>)</td>
  287. <td> const</td>
  288. </tr>
  289. </table>
  290. </div>
  291. <div class="memdoc">
  292. <p>Gets the <a class="el" href="classgameplay_1_1_animation.html">Animation</a> that this <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> was created from.</p>
  293. <dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classgameplay_1_1_animation.html">Animation</a> that this clip was created from. </dd></dl>
  294. </div>
  295. </div>
  296. <a class="anchor" id="a87e1eb6ea8944308b8c3c6326565323f"></a><!-- doxytag: member="gameplay::AnimationClip::getBlendWeight" ref="a87e1eb6ea8944308b8c3c6326565323f" args="() const " -->
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">float <a class="el" href="classgameplay_1_1_animation_clip.html#a87e1eb6ea8944308b8c3c6326565323f">gameplay::AnimationClip::getBlendWeight</a> </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td> const</td>
  305. </tr>
  306. </table>
  307. </div>
  308. <div class="memdoc">
  309. <p>Gets the blend weight of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>.</p>
  310. <dl class="return"><dt><b>Returns:</b></dt><dd>The blendweight of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </dd></dl>
  311. </div>
  312. </div>
  313. <a class="anchor" id="a438b928a919fd2b0184c17c520bb2879"></a><!-- doxytag: member="gameplay::AnimationClip::getDuration" ref="a438b928a919fd2b0184c17c520bb2879" args="() const " -->
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="memname">
  317. <tr>
  318. <td class="memname">unsigned long <a class="el" href="classgameplay_1_1_animation_clip.html#a438b928a919fd2b0184c17c520bb2879">gameplay::AnimationClip::getDuration</a> </td>
  319. <td>(</td>
  320. <td class="paramname"></td><td>)</td>
  321. <td> const</td>
  322. </tr>
  323. </table>
  324. </div>
  325. <div class="memdoc">
  326. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s duration.</p>
  327. <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s duration, in milliseconds. </dd></dl>
  328. </div>
  329. </div>
  330. <a class="anchor" id="a931d14990e9524ea5e78ecb64e2bb198"></a><!-- doxytag: member="gameplay::AnimationClip::getElapsedTime" ref="a931d14990e9524ea5e78ecb64e2bb198" args="() const " -->
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">float <a class="el" href="classgameplay_1_1_animation_clip.html#a931d14990e9524ea5e78ecb64e2bb198">gameplay::AnimationClip::getElapsedTime</a> </td>
  336. <td>(</td>
  337. <td class="paramname"></td><td>)</td>
  338. <td> const</td>
  339. </tr>
  340. </table>
  341. </div>
  342. <div class="memdoc">
  343. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s elapsed time.</p>
  344. <dl class="return"><dt><b>Returns:</b></dt><dd>The elapsed time of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> (in milliseconds). </dd></dl>
  345. </div>
  346. </div>
  347. <a class="anchor" id="ae0898f2d6b4d3d886d1f2bba8ef0dbd5"></a><!-- doxytag: member="gameplay::AnimationClip::getEndTime" ref="ae0898f2d6b4d3d886d1f2bba8ef0dbd5" args="() const " -->
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">unsigned long <a class="el" href="classgameplay_1_1_animation_clip.html#ae0898f2d6b4d3d886d1f2bba8ef0dbd5">gameplay::AnimationClip::getEndTime</a> </td>
  353. <td>(</td>
  354. <td class="paramname"></td><td>)</td>
  355. <td> const</td>
  356. </tr>
  357. </table>
  358. </div>
  359. <div class="memdoc">
  360. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s end time.</p>
  361. <dl class="return"><dt><b>Returns:</b></dt><dd>The time (in milliseconds) that the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> will end. </dd></dl>
  362. </div>
  363. </div>
  364. <a class="anchor" id="a964b19aa8de84b2fa40ac07df7ffddff"></a><!-- doxytag: member="gameplay::AnimationClip::getId" ref="a964b19aa8de84b2fa40ac07df7ffddff" args="() const " -->
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">const char* <a class="el" href="classgameplay_1_1_animation_clip.html#a964b19aa8de84b2fa40ac07df7ffddff">gameplay::AnimationClip::getId</a> </td>
  370. <td>(</td>
  371. <td class="paramname"></td><td>)</td>
  372. <td> const</td>
  373. </tr>
  374. </table>
  375. </div>
  376. <div class="memdoc">
  377. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s ID.</p>
  378. <dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s ID. </dd></dl>
  379. </div>
  380. </div>
  381. <a class="anchor" id="ad6245c2a651db2a779c10478b2c6271f"></a><!-- doxytag: member="gameplay::AnimationClip::getLoopBlendTime" ref="ad6245c2a651db2a779c10478b2c6271f" args="() const " -->
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname">float <a class="el" href="classgameplay_1_1_animation_clip.html#ad6245c2a651db2a779c10478b2c6271f">gameplay::AnimationClip::getLoopBlendTime</a> </td>
  387. <td>(</td>
  388. <td class="paramname"></td><td>)</td>
  389. <td> const</td>
  390. </tr>
  391. </table>
  392. </div>
  393. <div class="memdoc">
  394. <p>Returns the amount of time (in milliseconds) spent blending the clip's end points when looping.</p>
  395. <dl class="return"><dt><b>Returns:</b></dt><dd>Time spent blending end points of the clip when looping. </dd></dl>
  396. </div>
  397. </div>
  398. <a class="anchor" id="a006f61a1f72e9428b5d9717530de04c1"></a><!-- doxytag: member="gameplay::AnimationClip::getRepeatCount" ref="a006f61a1f72e9428b5d9717530de04c1" args="() const " -->
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">float <a class="el" href="classgameplay_1_1_animation_clip.html#a006f61a1f72e9428b5d9717530de04c1">gameplay::AnimationClip::getRepeatCount</a> </td>
  404. <td>(</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td> const</td>
  407. </tr>
  408. </table>
  409. </div>
  410. <div class="memdoc">
  411. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s repeat count.</p>
  412. <dl class="return"><dt><b>Returns:</b></dt><dd>The repeat count that is set on the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="a53442765a6241c12aedce275f7cf2248"></a><!-- doxytag: member="gameplay::AnimationClip::getSpeed" ref="a53442765a6241c12aedce275f7cf2248" args="() const " -->
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">float <a class="el" href="classgameplay_1_1_animation_clip.html#a53442765a6241c12aedce275f7cf2248">gameplay::AnimationClip::getSpeed</a> </td>
  421. <td>(</td>
  422. <td class="paramname"></td><td>)</td>
  423. <td> const</td>
  424. </tr>
  425. </table>
  426. </div>
  427. <div class="memdoc">
  428. <p>Gets the AninimationClip's running speed.</p>
  429. <dl class="return"><dt><b>Returns:</b></dt><dd>The AninimationClip's running speed. </dd></dl>
  430. </div>
  431. </div>
  432. <a class="anchor" id="a66b9cad3b41aba5a1695917489b6f92d"></a><!-- doxytag: member="gameplay::AnimationClip::getStartTime" ref="a66b9cad3b41aba5a1695917489b6f92d" args="() const " -->
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname">unsigned long <a class="el" href="classgameplay_1_1_animation_clip.html#a66b9cad3b41aba5a1695917489b6f92d">gameplay::AnimationClip::getStartTime</a> </td>
  438. <td>(</td>
  439. <td class="paramname"></td><td>)</td>
  440. <td> const</td>
  441. </tr>
  442. </table>
  443. </div>
  444. <div class="memdoc">
  445. <p>Gets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s start time.</p>
  446. <dl class="return"><dt><b>Returns:</b></dt><dd>The time (in milliseconds) that the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> starts playing from. </dd></dl>
  447. </div>
  448. </div>
  449. <a class="anchor" id="a94ba56bb5e835db6bc9d6e310bd0b8e5"></a><!-- doxytag: member="gameplay::AnimationClip::getTypeName" ref="a94ba56bb5e835db6bc9d6e310bd0b8e5" args="() const " -->
  450. <div class="memitem">
  451. <div class="memproto">
  452. <table class="memname">
  453. <tr>
  454. <td class="memname">const char* <a class="el" href="classgameplay_1_1_animation_clip.html#a94ba56bb5e835db6bc9d6e310bd0b8e5">gameplay::AnimationClip::getTypeName</a> </td>
  455. <td>(</td>
  456. <td class="paramname"></td><td>)</td>
  457. <td> const<code> [virtual]</code></td>
  458. </tr>
  459. </table>
  460. </div>
  461. <div class="memdoc">
  462. <p>Extends <a class="el" href="classgameplay_1_1_script_target.html#ac419e98f0eac8a52a6095da0e3853df3">ScriptTarget::getTypeName()</a> to return the type name of this class.</p>
  463. <dl class="return"><dt><b>Returns:</b></dt><dd>The type name of this class: "AnimationClip" </dd></dl>
  464. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_script_target.html#ac419e98f0eac8a52a6095da0e3853df3">ScriptTarget::getTypeName()</a> </dd></dl>
  465. <p>Implements <a class="el" href="classgameplay_1_1_script_target.html#ac419e98f0eac8a52a6095da0e3853df3">gameplay::ScriptTarget</a>.</p>
  466. </div>
  467. </div>
  468. <a class="anchor" id="a5c94a21f0850ea1c91b5612571510027"></a><!-- doxytag: member="gameplay::AnimationClip::isPlaying" ref="a5c94a21f0850ea1c91b5612571510027" args="() const " -->
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="memname">
  472. <tr>
  473. <td class="memname">bool <a class="el" href="classgameplay_1_1_animation_clip.html#a5c94a21f0850ea1c91b5612571510027">gameplay::AnimationClip::isPlaying</a> </td>
  474. <td>(</td>
  475. <td class="paramname"></td><td>)</td>
  476. <td> const</td>
  477. </tr>
  478. </table>
  479. </div>
  480. <div class="memdoc">
  481. <p>Checks if the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> is playing.</p>
  482. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> is playing; false if the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> is not playing. </dd></dl>
  483. </div>
  484. </div>
  485. <a class="anchor" id="ac74a4379207b09ec2f949b4bc64e88e9"></a><!-- doxytag: member="gameplay::AnimationClip::pause" ref="ac74a4379207b09ec2f949b4bc64e88e9" args="()" -->
  486. <div class="memitem">
  487. <div class="memproto">
  488. <table class="memname">
  489. <tr>
  490. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#ac74a4379207b09ec2f949b4bc64e88e9">gameplay::AnimationClip::pause</a> </td>
  491. <td>(</td>
  492. <td class="paramname"></td><td>)</td>
  493. <td></td>
  494. </tr>
  495. </table>
  496. </div>
  497. <div class="memdoc">
  498. <p>Pauses the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </p>
  499. </div>
  500. </div>
  501. <a class="anchor" id="ae3f523b557ddfdb3ef8b05bee79d090c"></a><!-- doxytag: member="gameplay::AnimationClip::play" ref="ae3f523b557ddfdb3ef8b05bee79d090c" args="()" -->
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#ae3f523b557ddfdb3ef8b05bee79d090c">gameplay::AnimationClip::play</a> </td>
  507. <td>(</td>
  508. <td class="paramname"></td><td>)</td>
  509. <td></td>
  510. </tr>
  511. </table>
  512. </div>
  513. <div class="memdoc">
  514. <p>Plays the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </p>
  515. </div>
  516. </div>
  517. <a class="anchor" id="af4d28a5db1cdb321c83b0f23a9b241c1"></a><!-- doxytag: member="gameplay::AnimationClip::removeBeginListener" ref="af4d28a5db1cdb321c83b0f23a9b241c1" args="(AnimationClip::Listener *listener)" -->
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#af4d28a5db1cdb321c83b0f23a9b241c1">gameplay::AnimationClip::removeBeginListener</a> </td>
  523. <td>(</td>
  524. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  525. <td class="paramname"><em>listener</em></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </div>
  530. <div class="memdoc">
  531. <p>Removes an animation begin listener.</p>
  532. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  533. <table class="params">
  534. <tr><td class="paramname">listener</td><td>The listener to be removed. </td></tr>
  535. </table>
  536. </dd>
  537. </dl>
  538. </div>
  539. </div>
  540. <a class="anchor" id="aec799b6c4b13d01eae0d6a0f1a84b68a"></a><!-- doxytag: member="gameplay::AnimationClip::removeEndListener" ref="aec799b6c4b13d01eae0d6a0f1a84b68a" args="(AnimationClip::Listener *listener)" -->
  541. <div class="memitem">
  542. <div class="memproto">
  543. <table class="memname">
  544. <tr>
  545. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#aec799b6c4b13d01eae0d6a0f1a84b68a">gameplay::AnimationClip::removeEndListener</a> </td>
  546. <td>(</td>
  547. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  548. <td class="paramname"><em>listener</em></td><td>)</td>
  549. <td></td>
  550. </tr>
  551. </table>
  552. </div>
  553. <div class="memdoc">
  554. <p>Removes an animation end listener.</p>
  555. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  556. <table class="params">
  557. <tr><td class="paramname">listener</td><td>The listener to be removed. </td></tr>
  558. </table>
  559. </dd>
  560. </dl>
  561. </div>
  562. </div>
  563. <a class="anchor" id="a140f43660effeae41c302286d3b1849a"></a><!-- doxytag: member="gameplay::AnimationClip::removeListener" ref="a140f43660effeae41c302286d3b1849a" args="(AnimationClip::Listener *listener, unsigned long eventTime)" -->
  564. <div class="memitem">
  565. <div class="memproto">
  566. <table class="memname">
  567. <tr>
  568. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a140f43660effeae41c302286d3b1849a">gameplay::AnimationClip::removeListener</a> </td>
  569. <td>(</td>
  570. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_clip_1_1_listener.html">AnimationClip::Listener</a> *&#160;</td>
  571. <td class="paramname"><em>listener</em>, </td>
  572. </tr>
  573. <tr>
  574. <td class="paramkey"></td>
  575. <td></td>
  576. <td class="paramtype">unsigned long&#160;</td>
  577. <td class="paramname"><em>eventTime</em>&#160;</td>
  578. </tr>
  579. <tr>
  580. <td></td>
  581. <td>)</td>
  582. <td></td><td></td>
  583. </tr>
  584. </table>
  585. </div>
  586. <div class="memdoc">
  587. <p>Removes an animation listener assigned to the specified eventTime.</p>
  588. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  589. <table class="params">
  590. <tr><td class="paramname">listener</td><td>The listener to be removed with the specified time. </td></tr>
  591. <tr><td class="paramname">eventTime</td><td>The time of the listener to be removed. </td></tr>
  592. </table>
  593. </dd>
  594. </dl>
  595. </div>
  596. </div>
  597. <a class="anchor" id="ac177842ec1730ce35cd02c47b03f8155"></a><!-- doxytag: member="gameplay::AnimationClip::setActiveDuration" ref="ac177842ec1730ce35cd02c47b03f8155" args="(unsigned long duration)" -->
  598. <div class="memitem">
  599. <div class="memproto">
  600. <table class="memname">
  601. <tr>
  602. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#ac177842ec1730ce35cd02c47b03f8155">gameplay::AnimationClip::setActiveDuration</a> </td>
  603. <td>(</td>
  604. <td class="paramtype">unsigned long&#160;</td>
  605. <td class="paramname"><em>duration</em></td><td>)</td>
  606. <td></td>
  607. </tr>
  608. </table>
  609. </div>
  610. <div class="memdoc">
  611. <p>Sets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s active duration. Overrides repeat count.</p>
  612. <p>Use REPEAT_INDEFINITE to play the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> indefinitely.</p>
  613. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  614. <table class="params">
  615. <tr><td class="paramname">duration</td><td>The active duration that is set on the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>, in milliseconds. </td></tr>
  616. </table>
  617. </dd>
  618. </dl>
  619. </div>
  620. </div>
  621. <a class="anchor" id="a128747035d2e8797a7364494a597c77f"></a><!-- doxytag: member="gameplay::AnimationClip::setBlendWeight" ref="a128747035d2e8797a7364494a597c77f" args="(float blendWeight)" -->
  622. <div class="memitem">
  623. <div class="memproto">
  624. <table class="memname">
  625. <tr>
  626. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a128747035d2e8797a7364494a597c77f">gameplay::AnimationClip::setBlendWeight</a> </td>
  627. <td>(</td>
  628. <td class="paramtype">float&#160;</td>
  629. <td class="paramname"><em>blendWeight</em></td><td>)</td>
  630. <td></td>
  631. </tr>
  632. </table>
  633. </div>
  634. <div class="memdoc">
  635. <p>Sets the blend weight of the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>.</p>
  636. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  637. <table class="params">
  638. <tr><td class="paramname">blendWeight</td><td>The blend weight to apply to the clip. </td></tr>
  639. </table>
  640. </dd>
  641. </dl>
  642. </div>
  643. </div>
  644. <a class="anchor" id="a48fab9d3a958cb9ab1fee3e3d290d89d"></a><!-- doxytag: member="gameplay::AnimationClip::setLoopBlendTime" ref="a48fab9d3a958cb9ab1fee3e3d290d89d" args="(float loopBlendTime)" -->
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a48fab9d3a958cb9ab1fee3e3d290d89d">gameplay::AnimationClip::setLoopBlendTime</a> </td>
  650. <td>(</td>
  651. <td class="paramtype">float&#160;</td>
  652. <td class="paramname"><em>loopBlendTime</em></td><td>)</td>
  653. <td></td>
  654. </tr>
  655. </table>
  656. </div>
  657. <div class="memdoc">
  658. <p>Sets the time (in milliseconds) to append to the clip's active duration to use for blending the end points of the clip when looping.</p>
  659. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  660. <table class="params">
  661. <tr><td class="paramname">loopBlendTime</td><td>Time spent blending end points of clip when looping. </td></tr>
  662. </table>
  663. </dd>
  664. </dl>
  665. </div>
  666. </div>
  667. <a class="anchor" id="ab29326cd02dd538d28900b127896ab01"></a><!-- doxytag: member="gameplay::AnimationClip::setRepeatCount" ref="ab29326cd02dd538d28900b127896ab01" args="(float repeatCount)" -->
  668. <div class="memitem">
  669. <div class="memproto">
  670. <table class="memname">
  671. <tr>
  672. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#ab29326cd02dd538d28900b127896ab01">gameplay::AnimationClip::setRepeatCount</a> </td>
  673. <td>(</td>
  674. <td class="paramtype">float&#160;</td>
  675. <td class="paramname"><em>repeatCount</em></td><td>)</td>
  676. <td></td>
  677. </tr>
  678. </table>
  679. </div>
  680. <div class="memdoc">
  681. <p>Sets the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s repeat count. Overrides repeat duration.</p>
  682. <p>Use REPEAT_INDEFINITE to play the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a> indefinitely.</p>
  683. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  684. <table class="params">
  685. <tr><td class="paramname">repeatCount</td><td>The repeat count to set on the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </td></tr>
  686. </table>
  687. </dd>
  688. </dl>
  689. </div>
  690. </div>
  691. <a class="anchor" id="a0881be549f9b6d833fc055bdd1af57d2"></a><!-- doxytag: member="gameplay::AnimationClip::setSpeed" ref="a0881be549f9b6d833fc055bdd1af57d2" args="(float speed)" -->
  692. <div class="memitem">
  693. <div class="memproto">
  694. <table class="memname">
  695. <tr>
  696. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a0881be549f9b6d833fc055bdd1af57d2">gameplay::AnimationClip::setSpeed</a> </td>
  697. <td>(</td>
  698. <td class="paramtype">float&#160;</td>
  699. <td class="paramname"><em>speed</em></td><td>)</td>
  700. <td></td>
  701. </tr>
  702. </table>
  703. </div>
  704. <div class="memdoc">
  705. <p>Set the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>'s running speed.</p>
  706. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  707. <table class="params">
  708. <tr><td class="paramname">speed</td><td>The clips running speed. </td></tr>
  709. </table>
  710. </dd>
  711. </dl>
  712. </div>
  713. </div>
  714. <a class="anchor" id="a60b8be3ef809c7001a870daf460267ba"></a><!-- doxytag: member="gameplay::AnimationClip::stop" ref="a60b8be3ef809c7001a870daf460267ba" args="()" -->
  715. <div class="memitem">
  716. <div class="memproto">
  717. <table class="memname">
  718. <tr>
  719. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_clip.html#a60b8be3ef809c7001a870daf460267ba">gameplay::AnimationClip::stop</a> </td>
  720. <td>(</td>
  721. <td class="paramname"></td><td>)</td>
  722. <td></td>
  723. </tr>
  724. </table>
  725. </div>
  726. <div class="memdoc">
  727. <p>Stops the <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </p>
  728. </div>
  729. </div>
  730. <hr/><h2>Member Data Documentation</h2>
  731. <a class="anchor" id="a32c79759c1e6a69d0d10db44579853b6"></a><!-- doxytag: member="gameplay::AnimationClip::REPEAT_INDEFINITE" ref="a32c79759c1e6a69d0d10db44579853b6" args="" -->
  732. <div class="memitem">
  733. <div class="memproto">
  734. <table class="memname">
  735. <tr>
  736. <td class="memname">const unsigned int <a class="el" href="classgameplay_1_1_animation_clip.html#a32c79759c1e6a69d0d10db44579853b6">gameplay::AnimationClip::REPEAT_INDEFINITE</a> = 0<code> [static]</code></td>
  737. </tr>
  738. </table>
  739. </div>
  740. <div class="memdoc">
  741. <p>Defines a constant for indefinitely repeating an <a class="el" href="classgameplay_1_1_animation_clip.html">AnimationClip</a>. </p>
  742. </div>
  743. </div>
  744. </div><!-- contents -->
  745. <!-- window showing the filter options -->
  746. <div id="MSearchSelectWindow"
  747. onmouseover="return searchBox.OnSearchSelectShow()"
  748. onmouseout="return searchBox.OnSearchSelectHide()"
  749. onkeydown="return searchBox.OnSearchSelectKey(event)">
  750. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  751. <!-- iframe showing the search results (closed by default) -->
  752. <div id="MSearchResultsWindow">
  753. <iframe src="javascript:void(0)" frameborder="0"
  754. name="MSearchResults" id="MSearchResults">
  755. </iframe>
  756. </div>
  757. <hr class="footer"/><address class="footer"><small>
  758. Generated on Sat Jan 24 2015 15:29:41 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  759. <img class="footer" src="doxygen.png" alt="doxygen"/>
  760. </a> 1.7.6.1
  761. </small></address>
  762. </body>
  763. </html>