classgameplay_1_1_animation_target.html 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900
  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>AnimationTarget 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_target.html">AnimationTarget</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-methods">Public Member Functions</a> &#124;
  87. <a href="#pro-types">Protected Types</a> &#124;
  88. <a href="#pro-methods">Protected Member Functions</a> &#124;
  89. <a href="#pro-attribs">Protected Attributes</a> </div>
  90. <div class="headertitle">
  91. <div class="title">gameplay::AnimationTarget Class Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <!-- doxytag: class="gameplay::AnimationTarget" -->
  95. <p><code>#include &lt;AnimationTarget.h&gt;</code></p>
  96. <div class="dynheader">
  97. Inheritance diagram for gameplay::AnimationTarget:</div>
  98. <div class="dyncontent">
  99. <div class="center">
  100. <img src="classgameplay_1_1_animation_target.png" usemap="#gameplay::AnimationTarget_map" alt=""/>
  101. <map id="gameplay::AnimationTarget_map" name="gameplay::AnimationTarget_map">
  102. <area href="classgameplay_1_1_control.html" alt="gameplay::Control" shape="rect" coords="279,56,455,80"/>
  103. <area href="classgameplay_1_1_material_parameter.html" alt="gameplay::MaterialParameter" shape="rect" coords="465,56,641,80"/>
  104. <area href="classgameplay_1_1_sprite.html" alt="gameplay::Sprite" shape="rect" coords="651,56,827,80"/>
  105. <area href="classgameplay_1_1_text.html" alt="gameplay::Text" shape="rect" coords="837,56,1013,80"/>
  106. <area href="classgameplay_1_1_transform.html" alt="gameplay::Transform" shape="rect" coords="1023,56,1199,80"/>
  107. <area href="classgameplay_1_1_container.html" alt="gameplay::Container" shape="rect" coords="0,112,176,136"/>
  108. <area href="classgameplay_1_1_image_control.html" alt="gameplay::ImageControl" shape="rect" coords="186,112,362,136"/>
  109. <area href="classgameplay_1_1_joystick_control.html" alt="gameplay::JoystickControl" shape="rect" coords="372,112,548,136"/>
  110. <area href="classgameplay_1_1_label.html" alt="gameplay::Label" shape="rect" coords="558,112,734,136"/>
  111. <area href="classgameplay_1_1_node.html" alt="gameplay::Node" shape="rect" coords="1023,112,1199,136"/>
  112. <area href="classgameplay_1_1_form.html" alt="gameplay::Form" shape="rect" coords="0,168,176,192"/>
  113. <area href="classgameplay_1_1_button.html" alt="gameplay::Button" shape="rect" coords="372,168,548,192"/>
  114. <area href="classgameplay_1_1_slider.html" alt="gameplay::Slider" shape="rect" coords="558,168,734,192"/>
  115. <area href="classgameplay_1_1_text_box.html" alt="gameplay::TextBox" shape="rect" coords="744,168,920,192"/>
  116. <area href="classgameplay_1_1_joint.html" alt="gameplay::Joint" shape="rect" coords="1023,168,1199,192"/>
  117. <area href="classgameplay_1_1_check_box.html" alt="gameplay::CheckBox" shape="rect" coords="279,224,455,248"/>
  118. <area href="classgameplay_1_1_radio_button.html" alt="gameplay::RadioButton" shape="rect" coords="465,224,641,248"/>
  119. </map>
  120. </div></div>
  121. <p><a href="classgameplay_1_1_animation_target-members.html">List of all members.</a></p>
  122. <table class="memberdecls">
  123. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  124. Public Member Functions</h2></td></tr>
  125. <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_target.html#adece90a6580ca606de174aaf266c610c">createAnimation</a> (const char *id, int propertyId, unsigned int keyCount, unsigned int *keyTimes, float *keyValues, <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a> type)</td></tr>
  126. <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_target.html#a6bd8537d47ad3de32bb0f72ef8748ed6">createAnimation</a> (const char *id, int propertyId, unsigned int keyCount, unsigned int *keyTimes, float *keyValues, float *keyInValue, float *keyOutValue, <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a> type)</td></tr>
  127. <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_target.html#acf1d4b96c618f474826ddfe0a125e216">createAnimation</a> (const char *id, const char *url)</td></tr>
  128. <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_target.html#ae9eac514a95b4dbab8db8d69e3f2f33c">createAnimation</a> (const char *id, <a class="el" href="classgameplay_1_1_properties.html">Properties</a> *animationProperties)</td></tr>
  129. <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_target.html#a7a1e29d9e344cd43edbcbfcace02d7b1">createAnimationFromTo</a> (const char *id, int propertyId, float *from, float *to, <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a> type, unsigned long duration)</td></tr>
  130. <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_target.html#a00be990fd84631e10ce40e9ca0b84f60">createAnimationFromBy</a> (const char *id, int propertyId, float *from, float *by, <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a> type, unsigned long duration)</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_target.html#a7bc288605c05e88521448cae2f21e2bc">destroyAnimation</a> (const char *id=NULL)</td></tr>
  132. <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a963d6a3f8e77c59cfb9ac2284d961c31">getAnimationPropertyComponentCount</a> (int propertyId) const =0</td></tr>
  133. <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a9e29517739e99d940e119dc2ee5a4aae">getAnimationPropertyValue</a> (int propertyId, <a class="el" href="classgameplay_1_1_animation_value.html">AnimationValue</a> *value)=0</td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a84a39aaabebfe0f05387778c3e7cefb0">setAnimationPropertyValue</a> (int propertyId, <a class="el" href="classgameplay_1_1_animation_value.html">AnimationValue</a> *value, float blendWeight=1.0f)=0</td></tr>
  135. <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_target.html#a8b08d7ad0b0fa52d9139dc931053a26f">getAnimation</a> (const char *id=NULL) const </td></tr>
  136. <tr><td colspan="2"><h2><a name="pro-types"></a>
  137. Protected Types</h2></td></tr>
  138. <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">TargetType</a> { <b>SCALAR</b>,
  139. <b>TRANSFORM</b>
  140. }</td></tr>
  141. <tr><td colspan="2"><h2><a name="pro-methods"></a>
  142. Protected Member Functions</h2></td></tr>
  143. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a03d383afb9045efee09ec661bceedf80">AnimationTarget</a> ()</td></tr>
  144. <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#ab8cedab6501d1908450814e6071f2155">~AnimationTarget</a> ()</td></tr>
  145. <tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a36d1eb07dcd07da53b7b1b142d36c344">getPropertyId</a> (<a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">TargetType</a> type, const char *propertyIdStr)</td></tr>
  146. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a67ef6f7b9d1761e1e9dc97ebdd2a79e1">addChannel</a> (Animation::Channel *channel)</td></tr>
  147. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#ad731be35a3536bd7769fda268fbd6c1a">removeChannel</a> (Animation::Channel *channel)</td></tr>
  148. <tr><td class="memItemLeft" align="right" valign="top">Animation::Channel *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a462900fcd93cf03982b63efca7afcbf6">getChannel</a> (const char *id) const </td></tr>
  149. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a24e4e3876f62ea8ed584bc01b934434e">cloneInto</a> (<a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a> *target, <a class="el" href="classgameplay_1_1_node_clone_context.html">NodeCloneContext</a> &amp;context) const </td></tr>
  150. <tr><td colspan="2"><h2><a name="pro-attribs"></a>
  151. Protected Attributes</h2></td></tr>
  152. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">TargetType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_animation_target.html#a3427f0e388bbfed7b5ee9fdda24b60a8">_targetType</a></td></tr>
  153. </table>
  154. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  155. <div class="textblock"><p>Defines an interface allowing animation to target an object for changing its animation properties. </p>
  156. </div><hr/><h2>Member Enumeration Documentation</h2>
  157. <a class="anchor" id="ac351f3b809938474d6688224a45aebcc"></a><!-- doxytag: member="gameplay::AnimationTarget::TargetType" ref="ac351f3b809938474d6688224a45aebcc" args="" -->
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">enum <a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">gameplay::AnimationTarget::TargetType</a><code> [protected]</code></td>
  163. </tr>
  164. </table>
  165. </div>
  166. <div class="memdoc">
  167. <p>The type of animation target. </p>
  168. </div>
  169. </div>
  170. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  171. <a class="anchor" id="a03d383afb9045efee09ec661bceedf80"></a><!-- doxytag: member="gameplay::AnimationTarget::AnimationTarget" ref="a03d383afb9045efee09ec661bceedf80" args="()" -->
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname"><a class="el" href="classgameplay_1_1_animation_target.html#a03d383afb9045efee09ec661bceedf80">gameplay::AnimationTarget::AnimationTarget</a> </td>
  177. <td>(</td>
  178. <td class="paramname"></td><td>)</td>
  179. <td><code> [protected]</code></td>
  180. </tr>
  181. </table>
  182. </div>
  183. <div class="memdoc">
  184. <p>Constructor. </p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="ab8cedab6501d1908450814e6071f2155"></a><!-- doxytag: member="gameplay::AnimationTarget::~AnimationTarget" ref="ab8cedab6501d1908450814e6071f2155" args="()" -->
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">virtual <a class="el" href="classgameplay_1_1_animation_target.html#ab8cedab6501d1908450814e6071f2155">gameplay::AnimationTarget::~AnimationTarget</a> </td>
  193. <td>(</td>
  194. <td class="paramname"></td><td>)</td>
  195. <td><code> [protected, virtual]</code></td>
  196. </tr>
  197. </table>
  198. </div>
  199. <div class="memdoc">
  200. <p>Destructor. </p>
  201. </div>
  202. </div>
  203. <hr/><h2>Member Function Documentation</h2>
  204. <a class="anchor" id="a67ef6f7b9d1761e1e9dc97ebdd2a79e1"></a><!-- doxytag: member="gameplay::AnimationTarget::addChannel" ref="a67ef6f7b9d1761e1e9dc97ebdd2a79e1" args="(Animation::Channel *channel)" -->
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_target.html#a67ef6f7b9d1761e1e9dc97ebdd2a79e1">gameplay::AnimationTarget::addChannel</a> </td>
  210. <td>(</td>
  211. <td class="paramtype">Animation::Channel *&#160;</td>
  212. <td class="paramname"><em>channel</em></td><td>)</td>
  213. <td><code> [protected]</code></td>
  214. </tr>
  215. </table>
  216. </div>
  217. <div class="memdoc">
  218. <p>Adds the given animation channel to this animation target.</p>
  219. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  220. <table class="params">
  221. <tr><td class="paramname">channel</td><td>The animation channel to add. </td></tr>
  222. </table>
  223. </dd>
  224. </dl>
  225. </div>
  226. </div>
  227. <a class="anchor" id="a24e4e3876f62ea8ed584bc01b934434e"></a><!-- doxytag: member="gameplay::AnimationTarget::cloneInto" ref="a24e4e3876f62ea8ed584bc01b934434e" args="(AnimationTarget *target, NodeCloneContext &amp;context) const " -->
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_target.html#a24e4e3876f62ea8ed584bc01b934434e">gameplay::AnimationTarget::cloneInto</a> </td>
  233. <td>(</td>
  234. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a> *&#160;</td>
  235. <td class="paramname"><em>target</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype"><a class="el" href="classgameplay_1_1_node_clone_context.html">NodeCloneContext</a> &amp;&#160;</td>
  241. <td class="paramname"><em>context</em>&#160;</td>
  242. </tr>
  243. <tr>
  244. <td></td>
  245. <td>)</td>
  246. <td></td><td> const<code> [protected]</code></td>
  247. </tr>
  248. </table>
  249. </div>
  250. <div class="memdoc">
  251. <p>Copies data from this animation target into the given target for the purpose of cloning.</p>
  252. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  253. <table class="params">
  254. <tr><td class="paramname">target</td><td>The target to copy into. </td></tr>
  255. <tr><td class="paramname">context</td><td>The clone context. </td></tr>
  256. </table>
  257. </dd>
  258. </dl>
  259. </div>
  260. </div>
  261. <a class="anchor" id="adece90a6580ca606de174aaf266c610c"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimation" ref="adece90a6580ca606de174aaf266c610c" args="(const char *id, int propertyId, unsigned int keyCount, unsigned int *keyTimes, float *keyValues, Curve::InterpolationType type)" -->
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#adece90a6580ca606de174aaf266c610c">gameplay::AnimationTarget::createAnimation</a> </td>
  267. <td>(</td>
  268. <td class="paramtype">const char *&#160;</td>
  269. <td class="paramname"><em>id</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">int&#160;</td>
  275. <td class="paramname"><em>propertyId</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">unsigned int&#160;</td>
  281. <td class="paramname"><em>keyCount</em>, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype">unsigned int *&#160;</td>
  287. <td class="paramname"><em>keyTimes</em>, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">float *&#160;</td>
  293. <td class="paramname"><em>keyValues</em>, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype"><a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a>&#160;</td>
  299. <td class="paramname"><em>type</em>&#160;</td>
  300. </tr>
  301. <tr>
  302. <td></td>
  303. <td>)</td>
  304. <td></td><td></td>
  305. </tr>
  306. </table>
  307. </div>
  308. <div class="memdoc">
  309. <p>Creates an animation on this target from a set of key value and key time pairs. Cannot use <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1ae5849e3d75739ad09dacee0d92fd8c29">Curve::BEZIER</a> or CURVE::HERMITE as the interpolation type since they require tangents/control points.</p>
  310. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  311. <table class="params">
  312. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  313. <tr><td class="paramname">propertyId</td><td>The property on this target to animate. </td></tr>
  314. <tr><td class="paramname">keyCount</td><td>The number of keyframes in the animation. Must be greater than one. </td></tr>
  315. <tr><td class="paramname">keyTimes</td><td>The list of key times for the animation (in milliseconds). </td></tr>
  316. <tr><td class="paramname">keyValues</td><td>The list of key values for the animation. </td></tr>
  317. <tr><td class="paramname">type</td><td>The curve interpolation type.</td></tr>
  318. </table>
  319. </dd>
  320. </dl>
  321. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  322. </div>
  323. </div>
  324. <a class="anchor" id="a6bd8537d47ad3de32bb0f72ef8748ed6"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimation" ref="a6bd8537d47ad3de32bb0f72ef8748ed6" args="(const char *id, int propertyId, unsigned int keyCount, unsigned int *keyTimes, float *keyValues, float *keyInValue, float *keyOutValue, Curve::InterpolationType type)" -->
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#adece90a6580ca606de174aaf266c610c">gameplay::AnimationTarget::createAnimation</a> </td>
  330. <td>(</td>
  331. <td class="paramtype">const char *&#160;</td>
  332. <td class="paramname"><em>id</em>, </td>
  333. </tr>
  334. <tr>
  335. <td class="paramkey"></td>
  336. <td></td>
  337. <td class="paramtype">int&#160;</td>
  338. <td class="paramname"><em>propertyId</em>, </td>
  339. </tr>
  340. <tr>
  341. <td class="paramkey"></td>
  342. <td></td>
  343. <td class="paramtype">unsigned int&#160;</td>
  344. <td class="paramname"><em>keyCount</em>, </td>
  345. </tr>
  346. <tr>
  347. <td class="paramkey"></td>
  348. <td></td>
  349. <td class="paramtype">unsigned int *&#160;</td>
  350. <td class="paramname"><em>keyTimes</em>, </td>
  351. </tr>
  352. <tr>
  353. <td class="paramkey"></td>
  354. <td></td>
  355. <td class="paramtype">float *&#160;</td>
  356. <td class="paramname"><em>keyValues</em>, </td>
  357. </tr>
  358. <tr>
  359. <td class="paramkey"></td>
  360. <td></td>
  361. <td class="paramtype">float *&#160;</td>
  362. <td class="paramname"><em>keyInValue</em>, </td>
  363. </tr>
  364. <tr>
  365. <td class="paramkey"></td>
  366. <td></td>
  367. <td class="paramtype">float *&#160;</td>
  368. <td class="paramname"><em>keyOutValue</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype"><a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a>&#160;</td>
  374. <td class="paramname"><em>type</em>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </div>
  383. <div class="memdoc">
  384. <p>Creates an animation on this target from a set of key value and key time pairs.</p>
  385. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  386. <table class="params">
  387. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  388. <tr><td class="paramname">propertyId</td><td>The property on this target to animate. </td></tr>
  389. <tr><td class="paramname">keyCount</td><td>The number of keyframes in the animation. Must be greater than one. </td></tr>
  390. <tr><td class="paramname">keyTimes</td><td>The list of key times for the animation (in milliseconds). </td></tr>
  391. <tr><td class="paramname">keyValues</td><td>The list of key values for the animation. </td></tr>
  392. <tr><td class="paramname">keyInValue</td><td>The list of key in values for the animation. </td></tr>
  393. <tr><td class="paramname">keyOutValue</td><td>The list of key out values for the animation. </td></tr>
  394. <tr><td class="paramname">type</td><td>The curve interpolation type.</td></tr>
  395. </table>
  396. </dd>
  397. </dl>
  398. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  399. </div>
  400. </div>
  401. <a class="anchor" id="acf1d4b96c618f474826ddfe0a125e216"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimation" ref="acf1d4b96c618f474826ddfe0a125e216" args="(const char *id, const char *url)" -->
  402. <div class="memitem">
  403. <div class="memproto">
  404. <table class="memname">
  405. <tr>
  406. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#adece90a6580ca606de174aaf266c610c">gameplay::AnimationTarget::createAnimation</a> </td>
  407. <td>(</td>
  408. <td class="paramtype">const char *&#160;</td>
  409. <td class="paramname"><em>id</em>, </td>
  410. </tr>
  411. <tr>
  412. <td class="paramkey"></td>
  413. <td></td>
  414. <td class="paramtype">const char *&#160;</td>
  415. <td class="paramname"><em>url</em>&#160;</td>
  416. </tr>
  417. <tr>
  418. <td></td>
  419. <td>)</td>
  420. <td></td><td></td>
  421. </tr>
  422. </table>
  423. </div>
  424. <div class="memdoc">
  425. <p>Creates an animation on this target using the data from the <a class="el" href="classgameplay_1_1_properties.html">Properties</a> object defined at the specified URL, where the URL is of the format "&lt;file-path&gt;.&lt;extension&gt;#&lt;namespace-id&gt;/&lt;namespace-id&gt;/.../&lt;namespace-id&gt;" (and "#&lt;namespace-id&gt;/&lt;namespace-id&gt;/.../&lt;namespace-id&gt;" is optional).</p>
  426. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  427. <table class="params">
  428. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  429. <tr><td class="paramname">url</td><td>The URL pointing to the <a class="el" href="classgameplay_1_1_properties.html">Properties</a> object defining the animation data.</td></tr>
  430. </table>
  431. </dd>
  432. </dl>
  433. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  434. </div>
  435. </div>
  436. <a class="anchor" id="ae9eac514a95b4dbab8db8d69e3f2f33c"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimation" ref="ae9eac514a95b4dbab8db8d69e3f2f33c" args="(const char *id, Properties *animationProperties)" -->
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#adece90a6580ca606de174aaf266c610c">gameplay::AnimationTarget::createAnimation</a> </td>
  442. <td>(</td>
  443. <td class="paramtype">const char *&#160;</td>
  444. <td class="paramname"><em>id</em>, </td>
  445. </tr>
  446. <tr>
  447. <td class="paramkey"></td>
  448. <td></td>
  449. <td class="paramtype"><a class="el" href="classgameplay_1_1_properties.html">Properties</a> *&#160;</td>
  450. <td class="paramname"><em>animationProperties</em>&#160;</td>
  451. </tr>
  452. <tr>
  453. <td></td>
  454. <td>)</td>
  455. <td></td><td></td>
  456. </tr>
  457. </table>
  458. </div>
  459. <div class="memdoc">
  460. <p>Creates an animation on this target using the data from the given properties object.</p>
  461. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  462. <table class="params">
  463. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  464. <tr><td class="paramname">animationProperties</td><td>The properties object defining the animation data.</td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  469. </div>
  470. </div>
  471. <a class="anchor" id="a00be990fd84631e10ce40e9ca0b84f60"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimationFromBy" ref="a00be990fd84631e10ce40e9ca0b84f60" args="(const char *id, int propertyId, float *from, float *by, Curve::InterpolationType type, unsigned long duration)" -->
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#a00be990fd84631e10ce40e9ca0b84f60">gameplay::AnimationTarget::createAnimationFromBy</a> </td>
  477. <td>(</td>
  478. <td class="paramtype">const char *&#160;</td>
  479. <td class="paramname"><em>id</em>, </td>
  480. </tr>
  481. <tr>
  482. <td class="paramkey"></td>
  483. <td></td>
  484. <td class="paramtype">int&#160;</td>
  485. <td class="paramname"><em>propertyId</em>, </td>
  486. </tr>
  487. <tr>
  488. <td class="paramkey"></td>
  489. <td></td>
  490. <td class="paramtype">float *&#160;</td>
  491. <td class="paramname"><em>from</em>, </td>
  492. </tr>
  493. <tr>
  494. <td class="paramkey"></td>
  495. <td></td>
  496. <td class="paramtype">float *&#160;</td>
  497. <td class="paramname"><em>by</em>, </td>
  498. </tr>
  499. <tr>
  500. <td class="paramkey"></td>
  501. <td></td>
  502. <td class="paramtype"><a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a>&#160;</td>
  503. <td class="paramname"><em>type</em>, </td>
  504. </tr>
  505. <tr>
  506. <td class="paramkey"></td>
  507. <td></td>
  508. <td class="paramtype">unsigned long&#160;</td>
  509. <td class="paramname"><em>duration</em>&#160;</td>
  510. </tr>
  511. <tr>
  512. <td></td>
  513. <td>)</td>
  514. <td></td><td></td>
  515. </tr>
  516. </table>
  517. </div>
  518. <div class="memdoc">
  519. <p>Creates a simple two keyframe from-by animation. Cannot use <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1ae5849e3d75739ad09dacee0d92fd8c29">Curve::BEZIER</a> or CURVE::HERMITE as the interpolation type since they require tangents/control points.</p>
  520. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  521. <table class="params">
  522. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  523. <tr><td class="paramname">propertyId</td><td>The property on this target to animate. </td></tr>
  524. <tr><td class="paramname">from</td><td>The values to animate from. </td></tr>
  525. <tr><td class="paramname">by</td><td>The values to animate by. </td></tr>
  526. <tr><td class="paramname">type</td><td>The curve interpolation type. </td></tr>
  527. <tr><td class="paramname">duration</td><td>The duration of the animation (in milliseconds).</td></tr>
  528. </table>
  529. </dd>
  530. </dl>
  531. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  532. </div>
  533. </div>
  534. <a class="anchor" id="a7a1e29d9e344cd43edbcbfcace02d7b1"></a><!-- doxytag: member="gameplay::AnimationTarget::createAnimationFromTo" ref="a7a1e29d9e344cd43edbcbfcace02d7b1" args="(const char *id, int propertyId, float *from, float *to, Curve::InterpolationType type, unsigned long duration)" -->
  535. <div class="memitem">
  536. <div class="memproto">
  537. <table class="memname">
  538. <tr>
  539. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#a7a1e29d9e344cd43edbcbfcace02d7b1">gameplay::AnimationTarget::createAnimationFromTo</a> </td>
  540. <td>(</td>
  541. <td class="paramtype">const char *&#160;</td>
  542. <td class="paramname"><em>id</em>, </td>
  543. </tr>
  544. <tr>
  545. <td class="paramkey"></td>
  546. <td></td>
  547. <td class="paramtype">int&#160;</td>
  548. <td class="paramname"><em>propertyId</em>, </td>
  549. </tr>
  550. <tr>
  551. <td class="paramkey"></td>
  552. <td></td>
  553. <td class="paramtype">float *&#160;</td>
  554. <td class="paramname"><em>from</em>, </td>
  555. </tr>
  556. <tr>
  557. <td class="paramkey"></td>
  558. <td></td>
  559. <td class="paramtype">float *&#160;</td>
  560. <td class="paramname"><em>to</em>, </td>
  561. </tr>
  562. <tr>
  563. <td class="paramkey"></td>
  564. <td></td>
  565. <td class="paramtype"><a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1">Curve::InterpolationType</a>&#160;</td>
  566. <td class="paramname"><em>type</em>, </td>
  567. </tr>
  568. <tr>
  569. <td class="paramkey"></td>
  570. <td></td>
  571. <td class="paramtype">unsigned long&#160;</td>
  572. <td class="paramname"><em>duration</em>&#160;</td>
  573. </tr>
  574. <tr>
  575. <td></td>
  576. <td>)</td>
  577. <td></td><td></td>
  578. </tr>
  579. </table>
  580. </div>
  581. <div class="memdoc">
  582. <p>Creates a simple two keyframe from-to animation. Cannot use <a class="el" href="classgameplay_1_1_curve.html#ae692a9c9671b9f4734aea55bfb3050e1ae5849e3d75739ad09dacee0d92fd8c29">Curve::BEZIER</a> or CURVE::HERMITE as the interpolation type since they require tangents/control points.</p>
  583. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  584. <table class="params">
  585. <tr><td class="paramname">id</td><td>The ID of the animation. </td></tr>
  586. <tr><td class="paramname">propertyId</td><td>The property on this target to animate. </td></tr>
  587. <tr><td class="paramname">from</td><td>The values to animate from. </td></tr>
  588. <tr><td class="paramname">to</td><td>The values to animate to. </td></tr>
  589. <tr><td class="paramname">type</td><td>The curve interpolation type. </td></tr>
  590. <tr><td class="paramname">duration</td><td>The duration of the animation (in milliseconds).</td></tr>
  591. </table>
  592. </dd>
  593. </dl>
  594. <dl class="return"><dt><b>Returns:</b></dt><dd>The newly created animation. </dd></dl>
  595. </div>
  596. </div>
  597. <a class="anchor" id="a7bc288605c05e88521448cae2f21e2bc"></a><!-- doxytag: member="gameplay::AnimationTarget::destroyAnimation" ref="a7bc288605c05e88521448cae2f21e2bc" args="(const char *id=NULL)" -->
  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_target.html#a7bc288605c05e88521448cae2f21e2bc">gameplay::AnimationTarget::destroyAnimation</a> </td>
  603. <td>(</td>
  604. <td class="paramtype">const char *&#160;</td>
  605. <td class="paramname"><em>id</em> = <code>NULL</code></td><td>)</td>
  606. <td></td>
  607. </tr>
  608. </table>
  609. </div>
  610. <div class="memdoc">
  611. <p>Destroys the animation with the specified ID. Destroys the first animation if ID is NULL.</p>
  612. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  613. <table class="params">
  614. <tr><td class="paramname">id</td><td>The ID of the animation to destroy. </td></tr>
  615. </table>
  616. </dd>
  617. </dl>
  618. </div>
  619. </div>
  620. <a class="anchor" id="a8b08d7ad0b0fa52d9139dc931053a26f"></a><!-- doxytag: member="gameplay::AnimationTarget::getAnimation" ref="a8b08d7ad0b0fa52d9139dc931053a26f" args="(const char *id=NULL) const " -->
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_animation_target.html#a8b08d7ad0b0fa52d9139dc931053a26f">gameplay::AnimationTarget::getAnimation</a> </td>
  626. <td>(</td>
  627. <td class="paramtype">const char *&#160;</td>
  628. <td class="paramname"><em>id</em> = <code>NULL</code></td><td>)</td>
  629. <td> const</td>
  630. </tr>
  631. </table>
  632. </div>
  633. <div class="memdoc">
  634. <p>Gets the animation with the specified ID. If the ID is NULL, this function will return the first animation it finds.</p>
  635. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  636. <table class="params">
  637. <tr><td class="paramname">id</td><td>The name of the animation to get. </td></tr>
  638. </table>
  639. </dd>
  640. </dl>
  641. <p>Reimplemented in <a class="el" href="classgameplay_1_1_node.html#a18ccc842b846acee10da31419e29545d">gameplay::Node</a>, and <a class="el" href="classgameplay_1_1_container.html#a1f88ffbc4b0fcf37d5e0be9cf76cac22">gameplay::Container</a>.</p>
  642. </div>
  643. </div>
  644. <a class="anchor" id="a963d6a3f8e77c59cfb9ac2284d961c31"></a><!-- doxytag: member="gameplay::AnimationTarget::getAnimationPropertyComponentCount" ref="a963d6a3f8e77c59cfb9ac2284d961c31" args="(int propertyId) const =0" -->
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname">virtual unsigned int <a class="el" href="classgameplay_1_1_animation_target.html#a963d6a3f8e77c59cfb9ac2284d961c31">gameplay::AnimationTarget::getAnimationPropertyComponentCount</a> </td>
  650. <td>(</td>
  651. <td class="paramtype">int&#160;</td>
  652. <td class="paramname"><em>propertyId</em></td><td>)</td>
  653. <td> const<code> [pure virtual]</code></td>
  654. </tr>
  655. </table>
  656. </div>
  657. <div class="memdoc">
  658. <p>Abstract method to return the property component count of the given property ID on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a>.</p>
  659. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  660. <table class="params">
  661. <tr><td class="paramname">propertyId</td><td>The ID of the property on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a> to obtain the component count for.</td></tr>
  662. </table>
  663. </dd>
  664. </dl>
  665. <dl class="return"><dt><b>Returns:</b></dt><dd>The property component count of the given property. </dd></dl>
  666. <p>Implemented in <a class="el" href="classgameplay_1_1_control.html#a6d18739bdbd45718c043afb33245093b">gameplay::Control</a>, <a class="el" href="classgameplay_1_1_transform.html#a842ce88c27aaedb5b43e0ac675ba7b1f">gameplay::Transform</a>, <a class="el" href="classgameplay_1_1_sprite.html#a120699968725ddff056e3481d9948864">gameplay::Sprite</a>, <a class="el" href="classgameplay_1_1_material_parameter.html#a6f898406a1e9390d7a26dba04e3b71e0">gameplay::MaterialParameter</a>, <a class="el" href="classgameplay_1_1_container.html#a540ba8ee5dd80383d64f07342ddda2e7">gameplay::Container</a>, and <a class="el" href="classgameplay_1_1_text.html#a0bf4a55d568bc0a4b33caae2139205d6">gameplay::Text</a>.</p>
  667. </div>
  668. </div>
  669. <a class="anchor" id="a9e29517739e99d940e119dc2ee5a4aae"></a><!-- doxytag: member="gameplay::AnimationTarget::getAnimationPropertyValue" ref="a9e29517739e99d940e119dc2ee5a4aae" args="(int propertyId, AnimationValue *value)=0" -->
  670. <div class="memitem">
  671. <div class="memproto">
  672. <table class="memname">
  673. <tr>
  674. <td class="memname">virtual void <a class="el" href="classgameplay_1_1_animation_target.html#a9e29517739e99d940e119dc2ee5a4aae">gameplay::AnimationTarget::getAnimationPropertyValue</a> </td>
  675. <td>(</td>
  676. <td class="paramtype">int&#160;</td>
  677. <td class="paramname"><em>propertyId</em>, </td>
  678. </tr>
  679. <tr>
  680. <td class="paramkey"></td>
  681. <td></td>
  682. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_value.html">AnimationValue</a> *&#160;</td>
  683. <td class="paramname"><em>value</em>&#160;</td>
  684. </tr>
  685. <tr>
  686. <td></td>
  687. <td>)</td>
  688. <td></td><td><code> [pure virtual]</code></td>
  689. </tr>
  690. </table>
  691. </div>
  692. <div class="memdoc">
  693. <p>Abstract method for getting the animation property value for the given property ID on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a>.</p>
  694. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  695. <table class="params">
  696. <tr><td class="paramname">propertyId</td><td>The ID of the property on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a> to get the animation property value for. </td></tr>
  697. <tr><td class="paramname">value</td><td>The container to get the animation property value in. </td></tr>
  698. </table>
  699. </dd>
  700. </dl>
  701. <p>Implemented in <a class="el" href="classgameplay_1_1_control.html#a3d0ea04fcf78d25124017c40c2846979">gameplay::Control</a>, <a class="el" href="classgameplay_1_1_transform.html#aa511e1efa7282723e0bfbe38742ec410">gameplay::Transform</a>, <a class="el" href="classgameplay_1_1_sprite.html#a08e47866c6498e6bab7e0fba02fbf117">gameplay::Sprite</a>, <a class="el" href="classgameplay_1_1_material_parameter.html#a4128baa81318a61cd6791b0cff9a5ea3">gameplay::MaterialParameter</a>, <a class="el" href="classgameplay_1_1_container.html#a2ede2188d0b9de8eb0b82eb013ebf991">gameplay::Container</a>, and <a class="el" href="classgameplay_1_1_text.html#a2abb93f79d07d9f4ceb4712c5d0742b7">gameplay::Text</a>.</p>
  702. </div>
  703. </div>
  704. <a class="anchor" id="a462900fcd93cf03982b63efca7afcbf6"></a><!-- doxytag: member="gameplay::AnimationTarget::getChannel" ref="a462900fcd93cf03982b63efca7afcbf6" args="(const char *id) const " -->
  705. <div class="memitem">
  706. <div class="memproto">
  707. <table class="memname">
  708. <tr>
  709. <td class="memname">Animation::Channel* <a class="el" href="classgameplay_1_1_animation_target.html#a462900fcd93cf03982b63efca7afcbf6">gameplay::AnimationTarget::getChannel</a> </td>
  710. <td>(</td>
  711. <td class="paramtype">const char *&#160;</td>
  712. <td class="paramname"><em>id</em></td><td>)</td>
  713. <td> const<code> [protected]</code></td>
  714. </tr>
  715. </table>
  716. </div>
  717. <div class="memdoc">
  718. <p>Gets the Animation::Channel that belongs to the <a class="el" href="classgameplay_1_1_animation.html">Animation</a> with the specified ID.</p>
  719. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  720. <table class="params">
  721. <tr><td class="paramname">id</td><td>The ID of the <a class="el" href="classgameplay_1_1_animation.html">Animation</a> the Channel belongs to. </td></tr>
  722. </table>
  723. </dd>
  724. </dl>
  725. </div>
  726. </div>
  727. <a class="anchor" id="a36d1eb07dcd07da53b7b1b142d36c344"></a><!-- doxytag: member="gameplay::AnimationTarget::getPropertyId" ref="a36d1eb07dcd07da53b7b1b142d36c344" args="(TargetType type, const char *propertyIdStr)" -->
  728. <div class="memitem">
  729. <div class="memproto">
  730. <table class="memname">
  731. <tr>
  732. <td class="memname">virtual int <a class="el" href="classgameplay_1_1_animation_target.html#a36d1eb07dcd07da53b7b1b142d36c344">gameplay::AnimationTarget::getPropertyId</a> </td>
  733. <td>(</td>
  734. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">TargetType</a>&#160;</td>
  735. <td class="paramname"><em>type</em>, </td>
  736. </tr>
  737. <tr>
  738. <td class="paramkey"></td>
  739. <td></td>
  740. <td class="paramtype">const char *&#160;</td>
  741. <td class="paramname"><em>propertyIdStr</em>&#160;</td>
  742. </tr>
  743. <tr>
  744. <td></td>
  745. <td>)</td>
  746. <td></td><td><code> [protected, virtual]</code></td>
  747. </tr>
  748. </table>
  749. </div>
  750. <div class="memdoc">
  751. <p>Gets the TargetType's property ID value for the specified property ID string.</p>
  752. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  753. <table class="params">
  754. <tr><td class="paramname">type</td><td>The TargetType of the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a>. </td></tr>
  755. <tr><td class="paramname">propertyIdStr</td><td>The property ID string. </td></tr>
  756. </table>
  757. </dd>
  758. </dl>
  759. <dl class="return"><dt><b>Returns:</b></dt><dd>The property ID value for the property ID string; -1 if the propertyIdStr does not exist for the TargetType. </dd></dl>
  760. <p>Reimplemented in <a class="el" href="classgameplay_1_1_sprite.html#a5c5e4511b819da20c2d0db6beaeed838">gameplay::Sprite</a>, and <a class="el" href="classgameplay_1_1_text.html#aaacd16022c44b781bf66a52195646a08">gameplay::Text</a>.</p>
  761. </div>
  762. </div>
  763. <a class="anchor" id="ad731be35a3536bd7769fda268fbd6c1a"></a><!-- doxytag: member="gameplay::AnimationTarget::removeChannel" ref="ad731be35a3536bd7769fda268fbd6c1a" args="(Animation::Channel *channel)" -->
  764. <div class="memitem">
  765. <div class="memproto">
  766. <table class="memname">
  767. <tr>
  768. <td class="memname">void <a class="el" href="classgameplay_1_1_animation_target.html#ad731be35a3536bd7769fda268fbd6c1a">gameplay::AnimationTarget::removeChannel</a> </td>
  769. <td>(</td>
  770. <td class="paramtype">Animation::Channel *&#160;</td>
  771. <td class="paramname"><em>channel</em></td><td>)</td>
  772. <td><code> [protected]</code></td>
  773. </tr>
  774. </table>
  775. </div>
  776. <div class="memdoc">
  777. <p>Removes the given animation channel from this animation target.</p>
  778. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  779. <table class="params">
  780. <tr><td class="paramname">channel</td><td>The animation channel to delete. </td></tr>
  781. </table>
  782. </dd>
  783. </dl>
  784. </div>
  785. </div>
  786. <a class="anchor" id="a84a39aaabebfe0f05387778c3e7cefb0"></a><!-- doxytag: member="gameplay::AnimationTarget::setAnimationPropertyValue" ref="a84a39aaabebfe0f05387778c3e7cefb0" args="(int propertyId, AnimationValue *value, float blendWeight=1.0f)=0" -->
  787. <div class="memitem">
  788. <div class="memproto">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname">virtual void <a class="el" href="classgameplay_1_1_animation_target.html#a84a39aaabebfe0f05387778c3e7cefb0">gameplay::AnimationTarget::setAnimationPropertyValue</a> </td>
  792. <td>(</td>
  793. <td class="paramtype">int&#160;</td>
  794. <td class="paramname"><em>propertyId</em>, </td>
  795. </tr>
  796. <tr>
  797. <td class="paramkey"></td>
  798. <td></td>
  799. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation_value.html">AnimationValue</a> *&#160;</td>
  800. <td class="paramname"><em>value</em>, </td>
  801. </tr>
  802. <tr>
  803. <td class="paramkey"></td>
  804. <td></td>
  805. <td class="paramtype">float&#160;</td>
  806. <td class="paramname"><em>blendWeight</em> = <code>1.0f</code>&#160;</td>
  807. </tr>
  808. <tr>
  809. <td></td>
  810. <td>)</td>
  811. <td></td><td><code> [pure virtual]</code></td>
  812. </tr>
  813. </table>
  814. </div>
  815. <div class="memdoc">
  816. <p>Abstract method for setting the animation property value for the given property ID on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a>.</p>
  817. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  818. <table class="params">
  819. <tr><td class="paramname">propertyId</td><td>The ID of the property on the <a class="el" href="classgameplay_1_1_animation_target.html">AnimationTarget</a> to set the animation property value on. </td></tr>
  820. <tr><td class="paramname">value</td><td>The container to set the animation property value in. </td></tr>
  821. <tr><td class="paramname">blendWeight</td><td>The blend weight. </td></tr>
  822. </table>
  823. </dd>
  824. </dl>
  825. <p>Implemented in <a class="el" href="classgameplay_1_1_control.html#a62a89ccb93888f7258287b767cfae107">gameplay::Control</a>, <a class="el" href="classgameplay_1_1_transform.html#a444e7a96105255379d13ac2b0523d5e3">gameplay::Transform</a>, <a class="el" href="classgameplay_1_1_sprite.html#ab438db5b61ab8fc96ef6605e88faccc5">gameplay::Sprite</a>, <a class="el" href="classgameplay_1_1_material_parameter.html#aaf03d11eb0ad260816f213fdccfac4b4">gameplay::MaterialParameter</a>, <a class="el" href="classgameplay_1_1_container.html#a395c95a45eabb5e4c39eef105526b482">gameplay::Container</a>, and <a class="el" href="classgameplay_1_1_text.html#af3a4147a1ef612d0500d8fd9f0311ebc">gameplay::Text</a>.</p>
  826. </div>
  827. </div>
  828. <hr/><h2>Member Data Documentation</h2>
  829. <a class="anchor" id="a3427f0e388bbfed7b5ee9fdda24b60a8"></a><!-- doxytag: member="gameplay::AnimationTarget::_targetType" ref="a3427f0e388bbfed7b5ee9fdda24b60a8" args="" -->
  830. <div class="memitem">
  831. <div class="memproto">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname"><a class="el" href="classgameplay_1_1_animation_target.html#ac351f3b809938474d6688224a45aebcc">TargetType</a> <a class="el" href="classgameplay_1_1_animation_target.html#a3427f0e388bbfed7b5ee9fdda24b60a8">gameplay::AnimationTarget::_targetType</a><code> [protected]</code></td>
  835. </tr>
  836. </table>
  837. </div>
  838. <div class="memdoc">
  839. <p>The target's type.</p>
  840. <dl class="see"><dt><b>See also:</b></dt><dd>TargetType::SCALAR </dd>
  841. <dd>
  842. TargetType::TRANSFORM </dd></dl>
  843. </div>
  844. </div>
  845. </div><!-- contents -->
  846. <!-- window showing the filter options -->
  847. <div id="MSearchSelectWindow"
  848. onmouseover="return searchBox.OnSearchSelectShow()"
  849. onmouseout="return searchBox.OnSearchSelectHide()"
  850. onkeydown="return searchBox.OnSearchSelectKey(event)">
  851. <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>
  852. <!-- iframe showing the search results (closed by default) -->
  853. <div id="MSearchResultsWindow">
  854. <iframe src="javascript:void(0)" frameborder="0"
  855. name="MSearchResults" id="MSearchResults">
  856. </iframe>
  857. </div>
  858. <hr class="footer"/><address class="footer"><small>
  859. Generated on Sat Jan 24 2015 15:29:42 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  860. <img class="footer" src="doxygen.png" alt="doxygen"/>
  861. </a> 1.7.6.1
  862. </small></address>
  863. </body>
  864. </html>