classAmbientForceController.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: AmbientForceController Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classAmbientForceController-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">AmbientForceController Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a0434fc9330abb8405750f7c8196fc5a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a0434fc9330abb8405750f7c8196fc5a3">getForce</a> ()</td></tr>
  60. <tr class="separator:a0434fc9330abb8405750f7c8196fc5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a3ad349a0c6886e6008b0bf72f87b8184"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a3ad349a0c6886e6008b0bf72f87b8184">setForce</a> (float x, float y)</td></tr>
  62. <tr class="separator:a3ad349a0c6886e6008b0bf72f87b8184"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. </table>
  64. <h2 class="groupheader">Member Function Documentation</h2>
  65. <a class="anchor" id="a0434fc9330abb8405750f7c8196fc5a3"></a>
  66. <div class="memitem">
  67. <div class="memproto">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getForce </td>
  71. <td>(</td>
  72. <td class="paramname"></td><td>)</td>
  73. <td></td>
  74. </tr>
  75. </table>
  76. </div><div class="memdoc">
  77. <p>Gets the ambient force being used. </p>
  78. <dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
  79. </div>
  80. </div>
  81. <a class="anchor" id="a3ad349a0c6886e6008b0bf72f87b8184"></a>
  82. <div class="memitem">
  83. <div class="memproto">
  84. <table class="memname">
  85. <tr>
  86. <td class="memname">void setForce </td>
  87. <td>(</td>
  88. <td class="paramtype">float&#160;</td>
  89. <td class="paramname"><em>x</em>, </td>
  90. </tr>
  91. <tr>
  92. <td class="paramkey"></td>
  93. <td></td>
  94. <td class="paramtype">float&#160;</td>
  95. <td class="paramname"><em>y</em>&#160;</td>
  96. </tr>
  97. <tr>
  98. <td></td>
  99. <td>)</td>
  100. <td></td><td></td>
  101. </tr>
  102. </table>
  103. </div><div class="memdoc">
  104. <p>Sets the ambient force to use. </p>
  105. <dl class="params"><dt>Parameters</dt><dd>
  106. <table class="params">
  107. <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
  108. <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
  109. </table>
  110. </dd>
  111. </dl>
  112. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  113. </div>
  114. </div>
  115. </div><!-- contents -->
  116. <!-- start footer part -->
  117. <hr class="footer"/><address class="footer"><small>
  118. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  119. <img class="footer" src="doxygen.png" alt="doxygen"/>
  120. </a> 1.8.3.1
  121. </small></address>
  122. </body>
  123. </html>