classAmbientForceController.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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. <title>AmbientForceController Class Reference</title>
  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
  7. </head>
  8. <body>
  9. <table width="100%" class="header">
  10. <tr>
  11. </tr>
  12. <tr><td class="headermenu">
  13. <center>
  14. <a class="qindex" href="index.html">Main</a> &nbsp;
  15. <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
  16. </center>
  17. </td></tr>
  18. </table>
  19. <br>
  20. <!-- END HEADER -->
  21. <!-- Generated by Doxygen 1.8.3.1 -->
  22. </div><!-- top -->
  23. <div class="header">
  24. <div class="summary">
  25. <a href="#pub-methods">Methods</a> &#124;
  26. <a href="#pub-attribs">Fields</a> &#124;
  27. <a href="classAmbientForceController-members.html">List of all members</a> </div>
  28. <div class="headertitle">
  29. <div class="title">AmbientForceController Class Reference</div> </div>
  30. </div><!--header-->
  31. <div class="contents">
  32. <p>Inherits <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>, and <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>.</p>
  33. <table class="memberdecls">
  34. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  35. Methods</h2></td></tr>
  36. <tr class="memitem:a97be11b2402763ab5c0153690bc268cd"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a97be11b2402763ab5c0153690bc268cd">getForce</a> ()</td></tr>
  37. <tr class="separator:a97be11b2402763ab5c0153690bc268cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  38. <tr class="memitem:a97be11b2402763ab5c0153690bc268cd"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a97be11b2402763ab5c0153690bc268cd">getForce</a> ()</td></tr>
  39. <tr class="separator:a97be11b2402763ab5c0153690bc268cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  40. <tr class="memitem:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1d7e09a7fb9f4644eaa58c94a977cb86">setForce</a> (float x, float y)</td></tr>
  41. <tr class="separator:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  42. <tr class="memitem:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1d7e09a7fb9f4644eaa58c94a977cb86">setForce</a> (float x, float y)</td></tr>
  43. <tr class="separator:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  44. </table><table class="memberdecls">
  45. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  46. Fields</h2></td></tr>
  47. <tr class="memitem:a1bf1d197b24ebf96dc97556cdf88e5a2"><td class="memItemLeft" align="right" valign="top">Vector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1bf1d197b24ebf96dc97556cdf88e5a2">Force</a></td></tr>
  48. <tr class="separator:a1bf1d197b24ebf96dc97556cdf88e5a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  49. <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
  50. <tr class="memitem:a094b3153ea492c8ab7f1b472283c2d28"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a094b3153ea492c8ab7f1b472283c2d28">canSaveDynamicFields</a></td></tr>
  51. <tr class="separator:a094b3153ea492c8ab7f1b472283c2d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:a838c93015cf480b28071eb8484b79717"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a838c93015cf480b28071eb8484b79717">internalName</a></td></tr>
  53. <tr class="separator:a838c93015cf480b28071eb8484b79717"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:a6346b4e4f6c9ca58dfc90e875c389441"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a6346b4e4f6c9ca58dfc90e875c389441">parentGroup</a></td></tr>
  55. <tr class="separator:a6346b4e4f6c9ca58dfc90e875c389441"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
  57. <tr class="memitem:a2b948f74cf91dc25aa8cfad17cc1af03"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a2b948f74cf91dc25aa8cfad17cc1af03">superclass</a></td></tr>
  58. <tr class="separator:a2b948f74cf91dc25aa8cfad17cc1af03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:aacad5bf2af1bd29da9373742d9060c92"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#aacad5bf2af1bd29da9373742d9060c92">class</a></td></tr>
  60. <tr class="separator:aacad5bf2af1bd29da9373742d9060c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="inherit_header pub_attribs_classGroupedSceneController"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classGroupedSceneController')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a></td></tr>
  62. <tr class="memitem:ae880d2a4e974373996e332ad6d62c277 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#ae880d2a4e974373996e332ad6d62c277">canSaveDynamicFields</a></td></tr>
  63. <tr class="separator:ae880d2a4e974373996e332ad6d62c277 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a8c1efbde231d2907fae859591f80abb3 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a8c1efbde231d2907fae859591f80abb3">internalName</a></td></tr>
  65. <tr class="separator:a8c1efbde231d2907fae859591f80abb3 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a13467f9db1c85e4e0facaa39d91041fc inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a13467f9db1c85e4e0facaa39d91041fc">parentGroup</a></td></tr>
  67. <tr class="separator:a13467f9db1c85e4e0facaa39d91041fc inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a9fbe026c3fe24b3d4977f00301951eda inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a9fbe026c3fe24b3d4977f00301951eda">superclass</a></td></tr>
  69. <tr class="separator:a9fbe026c3fe24b3d4977f00301951eda inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a67eed791a187d218ece43af1bd948a13 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a67eed791a187d218ece43af1bd948a13">class</a></td></tr>
  71. <tr class="separator:a67eed791a187d218ece43af1bd948a13 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="inherit_header pub_attribs_classSceneObjectSet"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSceneObjectSet')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a></td></tr>
  73. <tr class="memitem:a53e301552ce268958765ae60db955aa1 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a53e301552ce268958765ae60db955aa1">canSaveDynamicFields</a></td></tr>
  74. <tr class="separator:a53e301552ce268958765ae60db955aa1 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:aa12f696f4d553882bf9f86d4aee19f4d inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#aa12f696f4d553882bf9f86d4aee19f4d">internalName</a></td></tr>
  76. <tr class="separator:aa12f696f4d553882bf9f86d4aee19f4d inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ae71d572ddce28762e139857f7316d015 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ae71d572ddce28762e139857f7316d015">parentGroup</a></td></tr>
  78. <tr class="separator:ae71d572ddce28762e139857f7316d015 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ad8c38e686e2c931e843377416b65ecbe inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ad8c38e686e2c931e843377416b65ecbe">superclass</a></td></tr>
  80. <tr class="separator:ad8c38e686e2c931e843377416b65ecbe inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ad4b47101b91967a7b104ee1c68943430 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ad4b47101b91967a7b104ee1c68943430">class</a></td></tr>
  82. <tr class="separator:ad4b47101b91967a7b104ee1c68943430 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  84. <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
  85. <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
  87. <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
  89. <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
  91. <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
  93. <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table>
  95. <h2 class="groupheader">Methods</h2>
  96. <a class="anchor" id="a97be11b2402763ab5c0153690bc268cd"></a>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">string AmbientForceController::getForce </td>
  102. <td>(</td>
  103. <td class="paramname"></td><td>)</td>
  104. <td></td>
  105. </tr>
  106. </table>
  107. </div><div class="memdoc">
  108. <p>Gets the ambient force being used. </p>
  109. <dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
  110. </div>
  111. </div>
  112. <a class="anchor" id="a97be11b2402763ab5c0153690bc268cd"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">string AmbientForceController::getForce </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. <p>Gets the ambient force being used. </p>
  125. <dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
  126. </div>
  127. </div>
  128. <a class="anchor" id="a1d7e09a7fb9f4644eaa58c94a977cb86"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">void AmbientForceController::setForce </td>
  134. <td>(</td>
  135. <td class="paramtype">float&#160;</td>
  136. <td class="paramname"><em>x</em>, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">float&#160;</td>
  142. <td class="paramname"><em>y</em>&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <ul>
  152. <li>Sets the ambient force to use. <dl class="params"><dt>Parameters</dt><dd>
  153. <table class="params">
  154. <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
  155. <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
  156. </table>
  157. </dd>
  158. </dl>
  159. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  160. </li>
  161. </ul>
  162. </div>
  163. </div>
  164. <a class="anchor" id="a1d7e09a7fb9f4644eaa58c94a977cb86"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">void AmbientForceController::setForce </td>
  170. <td>(</td>
  171. <td class="paramtype">float&#160;</td>
  172. <td class="paramname"><em>x</em>, </td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey"></td>
  176. <td></td>
  177. <td class="paramtype">float&#160;</td>
  178. <td class="paramname"><em>y</em>&#160;</td>
  179. </tr>
  180. <tr>
  181. <td></td>
  182. <td>)</td>
  183. <td></td><td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <ul>
  188. <li>Sets the ambient force to use. <dl class="params"><dt>Parameters</dt><dd>
  189. <table class="params">
  190. <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
  191. <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
  192. </table>
  193. </dd>
  194. </dl>
  195. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  196. </li>
  197. </ul>
  198. </div>
  199. </div>
  200. <h2 class="groupheader">Member Data Documentation</h2>
  201. <a class="anchor" id="a094b3153ea492c8ab7f1b472283c2d28"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">bool AmbientForceController::canSaveDynamicFields</td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <a class="anchor" id="aacad5bf2af1bd29da9373742d9060c92"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">string AmbientForceController::class</td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Script SuperClass of object. </p>
  222. </div>
  223. </div>
  224. <a class="anchor" id="a1bf1d197b24ebf96dc97556cdf88e5a2"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">Vector2 AmbientForceController::Force</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>The constant force to apply. </p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a838c93015cf480b28071eb8484b79717"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">string AmbientForceController::internalName</td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. </div>
  246. </div>
  247. <a class="anchor" id="a6346b4e4f6c9ca58dfc90e875c389441"></a>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">SimObjectPtr AmbientForceController::parentGroup</td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Group hierarchy parent of the object. </p>
  257. </div>
  258. </div>
  259. <a class="anchor" id="a2b948f74cf91dc25aa8cfad17cc1af03"></a>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">string AmbientForceController::superclass</td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Script Class of object. </p>
  269. </div>
  270. </div>
  271. </div><!-- contents -->
  272. <!-- START FOOTER -->
  273. <br>
  274. <br>
  275. <center>
  276. <div style="color: #777777;">
  277. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  278. </div>
  279. </center>
  280. </body>
  281. </html>