| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <title>AmbientForceController Class Reference</title>
- <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <table width="100%" class="header">
- <tr>
- </tr>
- <tr><td class="headermenu">
- <center>
- <a class="qindex" href="index.html">Main</a>
- <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
- </center>
- </td></tr>
- </table>
- <br>
- <!-- END HEADER -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Methods</a> |
- <a href="#pub-attribs">Fields</a> |
- <a href="classAmbientForceController-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">AmbientForceController Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>, and <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Methods</h2></td></tr>
- <tr class="memitem:a97be11b2402763ab5c0153690bc268cd"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a97be11b2402763ab5c0153690bc268cd">getForce</a> ()</td></tr>
- <tr class="separator:a97be11b2402763ab5c0153690bc268cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97be11b2402763ab5c0153690bc268cd"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a97be11b2402763ab5c0153690bc268cd">getForce</a> ()</td></tr>
- <tr class="separator:a97be11b2402763ab5c0153690bc268cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1d7e09a7fb9f4644eaa58c94a977cb86">setForce</a> (float x, float y)</td></tr>
- <tr class="separator:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1d7e09a7fb9f4644eaa58c94a977cb86">setForce</a> (float x, float y)</td></tr>
- <tr class="separator:a1d7e09a7fb9f4644eaa58c94a977cb86"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Fields</h2></td></tr>
- <tr class="memitem:a1bf1d197b24ebf96dc97556cdf88e5a2"><td class="memItemLeft" align="right" valign="top">Vector2 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a1bf1d197b24ebf96dc97556cdf88e5a2">Force</a></td></tr>
- <tr class="separator:a1bf1d197b24ebf96dc97556cdf88e5a2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
- <tr class="memitem:a094b3153ea492c8ab7f1b472283c2d28"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a094b3153ea492c8ab7f1b472283c2d28">canSaveDynamicFields</a></td></tr>
- <tr class="separator:a094b3153ea492c8ab7f1b472283c2d28"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a838c93015cf480b28071eb8484b79717"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a838c93015cf480b28071eb8484b79717">internalName</a></td></tr>
- <tr class="separator:a838c93015cf480b28071eb8484b79717"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6346b4e4f6c9ca58dfc90e875c389441"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a6346b4e4f6c9ca58dfc90e875c389441">parentGroup</a></td></tr>
- <tr class="separator:a6346b4e4f6c9ca58dfc90e875c389441"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
- <tr class="memitem:a2b948f74cf91dc25aa8cfad17cc1af03"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#a2b948f74cf91dc25aa8cfad17cc1af03">superclass</a></td></tr>
- <tr class="separator:a2b948f74cf91dc25aa8cfad17cc1af03"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aacad5bf2af1bd29da9373742d9060c92"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbientForceController.html#aacad5bf2af1bd29da9373742d9060c92">class</a></td></tr>
- <tr class="separator:aacad5bf2af1bd29da9373742d9060c92"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classGroupedSceneController"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classGroupedSceneController')"><img src="closed.png" alt="-"/> Fields inherited from <a class="el" href="classGroupedSceneController.html">GroupedSceneController</a></td></tr>
- <tr class="memitem:ae880d2a4e974373996e332ad6d62c277 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#ae880d2a4e974373996e332ad6d62c277">canSaveDynamicFields</a></td></tr>
- <tr class="separator:ae880d2a4e974373996e332ad6d62c277 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8c1efbde231d2907fae859591f80abb3 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a8c1efbde231d2907fae859591f80abb3">internalName</a></td></tr>
- <tr class="separator:a8c1efbde231d2907fae859591f80abb3 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13467f9db1c85e4e0facaa39d91041fc inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a13467f9db1c85e4e0facaa39d91041fc">parentGroup</a></td></tr>
- <tr class="separator:a13467f9db1c85e4e0facaa39d91041fc inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9fbe026c3fe24b3d4977f00301951eda inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a9fbe026c3fe24b3d4977f00301951eda">superclass</a></td></tr>
- <tr class="separator:a9fbe026c3fe24b3d4977f00301951eda inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a67eed791a187d218ece43af1bd948a13 inherit pub_attribs_classGroupedSceneController"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGroupedSceneController.html#a67eed791a187d218ece43af1bd948a13">class</a></td></tr>
- <tr class="separator:a67eed791a187d218ece43af1bd948a13 inherit pub_attribs_classGroupedSceneController"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSceneObjectSet"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSceneObjectSet')"><img src="closed.png" alt="-"/> Fields inherited from <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a></td></tr>
- <tr class="memitem:a53e301552ce268958765ae60db955aa1 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a53e301552ce268958765ae60db955aa1">canSaveDynamicFields</a></td></tr>
- <tr class="separator:a53e301552ce268958765ae60db955aa1 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa12f696f4d553882bf9f86d4aee19f4d inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#aa12f696f4d553882bf9f86d4aee19f4d">internalName</a></td></tr>
- <tr class="separator:aa12f696f4d553882bf9f86d4aee19f4d inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae71d572ddce28762e139857f7316d015 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ae71d572ddce28762e139857f7316d015">parentGroup</a></td></tr>
- <tr class="separator:ae71d572ddce28762e139857f7316d015 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad8c38e686e2c931e843377416b65ecbe inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ad8c38e686e2c931e843377416b65ecbe">superclass</a></td></tr>
- <tr class="separator:ad8c38e686e2c931e843377416b65ecbe inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4b47101b91967a7b104ee1c68943430 inherit pub_attribs_classSceneObjectSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ad4b47101b91967a7b104ee1c68943430">class</a></td></tr>
- <tr class="separator:ad4b47101b91967a7b104ee1c68943430 inherit pub_attribs_classSceneObjectSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/> Fields inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
- <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
- <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
- <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
- <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
- <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Methods</h2>
- <a class="anchor" id="a97be11b2402763ab5c0153690bc268cd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string AmbientForceController::getForce </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the ambient force being used. </p>
- <dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a97be11b2402763ab5c0153690bc268cd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string AmbientForceController::getForce </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the ambient force being used. </p>
- <dl class="section return"><dt>Returns</dt><dd>The ambient force being used. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a1d7e09a7fb9f4644eaa58c94a977cb86"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void AmbientForceController::setForce </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>y</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Sets the ambient force to use. <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
- <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="a1d7e09a7fb9f4644eaa58c94a977cb86"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void AmbientForceController::setForce </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>y</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Sets the ambient force to use. <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">x</td><td>The component of the ambient force along the horizontal (world) axis. </td></tr>
- <tr><td class="paramname">y</td><td>The component of the ambient force along the vertical (world) axis. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </li>
- </ul>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a class="anchor" id="a094b3153ea492c8ab7f1b472283c2d28"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool AmbientForceController::canSaveDynamicFields</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="aacad5bf2af1bd29da9373742d9060c92"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string AmbientForceController::class</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script SuperClass of object. </p>
- </div>
- </div>
- <a class="anchor" id="a1bf1d197b24ebf96dc97556cdf88e5a2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Vector2 AmbientForceController::Force</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The constant force to apply. </p>
- </div>
- </div>
- <a class="anchor" id="a838c93015cf480b28071eb8484b79717"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string AmbientForceController::internalName</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a6346b4e4f6c9ca58dfc90e875c389441"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">SimObjectPtr AmbientForceController::parentGroup</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Group hierarchy parent of the object. </p>
- </div>
- </div>
- <a class="anchor" id="a2b948f74cf91dc25aa8cfad17cc1af03"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string AmbientForceController::superclass</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script Class of object. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|