<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Box2D: b2WheelJointDef Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="icon.gif"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Box2D  <span id="projectnumber">2.3.0</span> </div> <div id="projectbrief">A 2D Physics Engine for Games</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="structb2_wheel_joint_def-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">b2WheelJointDef Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="b2_wheel_joint_8h_source.html">b2WheelJoint.h</a>></code></p> <div class="dynheader"> Inheritance diagram for b2WheelJointDef:</div> <div class="dyncontent"> <div class="center"> <img src="structb2_wheel_joint_def.png" usemap="#b2WheelJointDef_map" alt=""/> <map id="b2WheelJointDef_map" name="b2WheelJointDef_map"> <area href="structb2_joint_def.html" title="Joint definitions are used to construct joints. " alt="b2JointDef" shape="rect" coords="0,0,108,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:af26887092d36c3cd03898401a38783e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#af26887092d36c3cd03898401a38783e2">Initialize</a> (<a class="el" href="classb2_body.html">b2Body</a> *<a class="el" href="structb2_joint_def.html#a8cd54c93da396be75a9788f2c6897f05">bodyA</a>, <a class="el" href="classb2_body.html">b2Body</a> *<a class="el" href="structb2_joint_def.html#aa4f4dee2fbcd12187b19506b60e68e3d">bodyB</a>, const <a class="el" href="structb2_vec2.html">b2Vec2</a> &anchor, const <a class="el" href="structb2_vec2.html">b2Vec2</a> &axis)</td></tr> <tr class="separator:af26887092d36c3cd03898401a38783e2"><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> Public Attributes</h2></td></tr> <tr class="memitem:a9429d2273bfdd8bdc0db416e73b89ae4"><td class="memItemLeft" align="right" valign="top"><a id="a9429d2273bfdd8bdc0db416e73b89ae4"></a> <a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#a9429d2273bfdd8bdc0db416e73b89ae4">localAnchorA</a></td></tr> <tr class="memdesc:a9429d2273bfdd8bdc0db416e73b89ae4"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyA's origin. <br /></td></tr> <tr class="separator:a9429d2273bfdd8bdc0db416e73b89ae4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88ba0f7108076b9d7ced68425be95c27"><td class="memItemLeft" align="right" valign="top"><a id="a88ba0f7108076b9d7ced68425be95c27"></a> <a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#a88ba0f7108076b9d7ced68425be95c27">localAnchorB</a></td></tr> <tr class="memdesc:a88ba0f7108076b9d7ced68425be95c27"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyB's origin. <br /></td></tr> <tr class="separator:a88ba0f7108076b9d7ced68425be95c27"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad635ee7b77b50037dc0e021a0f5c93a6"><td class="memItemLeft" align="right" valign="top"><a id="ad635ee7b77b50037dc0e021a0f5c93a6"></a> <a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#ad635ee7b77b50037dc0e021a0f5c93a6">localAxisA</a></td></tr> <tr class="memdesc:ad635ee7b77b50037dc0e021a0f5c93a6"><td class="mdescLeft"> </td><td class="mdescRight">The local translation axis in bodyA. <br /></td></tr> <tr class="separator:ad635ee7b77b50037dc0e021a0f5c93a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e7193d6c34c784ffd71e79d3a70acc6"><td class="memItemLeft" align="right" valign="top"><a id="a8e7193d6c34c784ffd71e79d3a70acc6"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#a8e7193d6c34c784ffd71e79d3a70acc6">enableMotor</a></td></tr> <tr class="memdesc:a8e7193d6c34c784ffd71e79d3a70acc6"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable the joint motor. <br /></td></tr> <tr class="separator:a8e7193d6c34c784ffd71e79d3a70acc6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab658ce0fae40c6de09133659f7ffb829"><td class="memItemLeft" align="right" valign="top"><a id="ab658ce0fae40c6de09133659f7ffb829"></a> float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#ab658ce0fae40c6de09133659f7ffb829">maxMotorTorque</a></td></tr> <tr class="memdesc:ab658ce0fae40c6de09133659f7ffb829"><td class="mdescLeft"> </td><td class="mdescRight">The maximum motor torque, usually in N-m. <br /></td></tr> <tr class="separator:ab658ce0fae40c6de09133659f7ffb829"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7248e25f2ca6b6c2a5f7079ce16e7748"><td class="memItemLeft" align="right" valign="top"><a id="a7248e25f2ca6b6c2a5f7079ce16e7748"></a> float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#a7248e25f2ca6b6c2a5f7079ce16e7748">motorSpeed</a></td></tr> <tr class="memdesc:a7248e25f2ca6b6c2a5f7079ce16e7748"><td class="mdescLeft"> </td><td class="mdescRight">The desired motor speed in radians per second. <br /></td></tr> <tr class="separator:a7248e25f2ca6b6c2a5f7079ce16e7748"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acf3540f46eaf3bc91426386939bd37b1"><td class="memItemLeft" align="right" valign="top"><a id="acf3540f46eaf3bc91426386939bd37b1"></a> float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#acf3540f46eaf3bc91426386939bd37b1">frequencyHz</a></td></tr> <tr class="memdesc:acf3540f46eaf3bc91426386939bd37b1"><td class="mdescLeft"> </td><td class="mdescRight">Suspension frequency, zero indicates no suspension. <br /></td></tr> <tr class="separator:acf3540f46eaf3bc91426386939bd37b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9976584bfee18b46dec355764797ce54"><td class="memItemLeft" align="right" valign="top"><a id="a9976584bfee18b46dec355764797ce54"></a> float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_wheel_joint_def.html#a9976584bfee18b46dec355764797ce54">dampingRatio</a></td></tr> <tr class="memdesc:a9976584bfee18b46dec355764797ce54"><td class="mdescLeft"> </td><td class="mdescRight">Suspension damping ratio, one indicates critical damping. <br /></td></tr> <tr class="separator:a9976584bfee18b46dec355764797ce54"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_attribs_structb2_joint_def"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structb2_joint_def')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structb2_joint_def.html">b2JointDef</a></td></tr> <tr class="memitem:a470f2879b24adb05facbd49f338856fb inherit pub_attribs_structb2_joint_def"><td class="memItemLeft" align="right" valign="top"><a id="a470f2879b24adb05facbd49f338856fb"></a> b2JointType </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_joint_def.html#a470f2879b24adb05facbd49f338856fb">type</a></td></tr> <tr class="memdesc:a470f2879b24adb05facbd49f338856fb inherit pub_attribs_structb2_joint_def"><td class="mdescLeft"> </td><td class="mdescRight">The joint type is set automatically for concrete joint types. <br /></td></tr> <tr class="separator:a470f2879b24adb05facbd49f338856fb inherit pub_attribs_structb2_joint_def"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a07eb150daaaa52fc09c3bcf402b295fe inherit pub_attribs_structb2_joint_def"><td class="memItemLeft" align="right" valign="top"><a id="a07eb150daaaa52fc09c3bcf402b295fe"></a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_joint_def.html#a07eb150daaaa52fc09c3bcf402b295fe">userData</a></td></tr> <tr class="memdesc:a07eb150daaaa52fc09c3bcf402b295fe inherit pub_attribs_structb2_joint_def"><td class="mdescLeft"> </td><td class="mdescRight">Use this to attach application specific data to your joints. <br /></td></tr> <tr class="separator:a07eb150daaaa52fc09c3bcf402b295fe inherit pub_attribs_structb2_joint_def"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8cd54c93da396be75a9788f2c6897f05 inherit pub_attribs_structb2_joint_def"><td class="memItemLeft" align="right" valign="top"><a id="a8cd54c93da396be75a9788f2c6897f05"></a> <a class="el" href="classb2_body.html">b2Body</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_joint_def.html#a8cd54c93da396be75a9788f2c6897f05">bodyA</a></td></tr> <tr class="memdesc:a8cd54c93da396be75a9788f2c6897f05 inherit pub_attribs_structb2_joint_def"><td class="mdescLeft"> </td><td class="mdescRight">The first attached body. <br /></td></tr> <tr class="separator:a8cd54c93da396be75a9788f2c6897f05 inherit pub_attribs_structb2_joint_def"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa4f4dee2fbcd12187b19506b60e68e3d inherit pub_attribs_structb2_joint_def"><td class="memItemLeft" align="right" valign="top"><a id="aa4f4dee2fbcd12187b19506b60e68e3d"></a> <a class="el" href="classb2_body.html">b2Body</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_joint_def.html#aa4f4dee2fbcd12187b19506b60e68e3d">bodyB</a></td></tr> <tr class="memdesc:aa4f4dee2fbcd12187b19506b60e68e3d inherit pub_attribs_structb2_joint_def"><td class="mdescLeft"> </td><td class="mdescRight">The second attached body. <br /></td></tr> <tr class="separator:aa4f4dee2fbcd12187b19506b60e68e3d inherit pub_attribs_structb2_joint_def"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aef099a1f89b64e230173b6016848ea9b inherit pub_attribs_structb2_joint_def"><td class="memItemLeft" align="right" valign="top"><a id="aef099a1f89b64e230173b6016848ea9b"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_joint_def.html#aef099a1f89b64e230173b6016848ea9b">collideConnected</a></td></tr> <tr class="memdesc:aef099a1f89b64e230173b6016848ea9b inherit pub_attribs_structb2_joint_def"><td class="mdescLeft"> </td><td class="mdescRight">Set this flag to true if the attached bodies should collide. <br /></td></tr> <tr class="separator:aef099a1f89b64e230173b6016848ea9b inherit pub_attribs_structb2_joint_def"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Wheel joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="af26887092d36c3cd03898401a38783e2"></a> <h2 class="memtitle"><span class="permalink"><a href="#af26887092d36c3cd03898401a38783e2">◆ </a></span>Initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void b2WheelJointDef::Initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="classb2_body.html">b2Body</a> * </td> <td class="paramname"><em>bodyA</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classb2_body.html">b2Body</a> * </td> <td class="paramname"><em>bodyB</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structb2_vec2.html">b2Vec2</a> & </td> <td class="paramname"><em>anchor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structb2_vec2.html">b2Vec2</a> & </td> <td class="paramname"><em>axis</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis. </p> </div> </div> <hr/>The documentation for this struct was generated from the following files:<ul> <li><a class="el" href="b2_wheel_joint_8h_source.html">b2WheelJoint.h</a></li> <li>b2WheelJoint.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Sep 21 2018 22:35:09 for Box2D by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>