<!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: b2RevoluteJointDef 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_revolute_joint_def-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">b2RevoluteJointDef Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="b2_revolute_joint_8h_source.html">b2RevoluteJoint.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for b2RevoluteJointDef:</div>
<div class="dyncontent">
<div class="center">
<img src="structb2_revolute_joint_def.png" usemap="#b2RevoluteJointDef_map" alt=""/>
<map id="b2RevoluteJointDef_map" name="b2RevoluteJointDef_map">
<area href="structb2_joint_def.html" title="Joint definitions are used to construct joints. " alt="b2JointDef" shape="rect" coords="0,0,122,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:a6401b2a663533415d032a525e4fa2806"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a6401b2a663533415d032a525e4fa2806">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)</td></tr>
<tr class="separator:a6401b2a663533415d032a525e4fa2806"><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:a76337d07aa63232a7b20d50decc862ae"><td class="memItemLeft" align="right" valign="top"><a id="a76337d07aa63232a7b20d50decc862ae"></a>
<a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a76337d07aa63232a7b20d50decc862ae">localAnchorA</a></td></tr>
<tr class="memdesc:a76337d07aa63232a7b20d50decc862ae"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyA's origin. <br /></td></tr>
<tr class="separator:a76337d07aa63232a7b20d50decc862ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f33bc1d9f6c22043a5ff2f1d89f04e0"><td class="memItemLeft" align="right" valign="top"><a id="a3f33bc1d9f6c22043a5ff2f1d89f04e0"></a>
<a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a3f33bc1d9f6c22043a5ff2f1d89f04e0">localAnchorB</a></td></tr>
<tr class="memdesc:a3f33bc1d9f6c22043a5ff2f1d89f04e0"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyB's origin. <br /></td></tr>
<tr class="separator:a3f33bc1d9f6c22043a5ff2f1d89f04e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1858d897d5fea04c5e606a1ff73f64f8"><td class="memItemLeft" align="right" valign="top"><a id="a1858d897d5fea04c5e606a1ff73f64f8"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a1858d897d5fea04c5e606a1ff73f64f8">referenceAngle</a></td></tr>
<tr class="memdesc:a1858d897d5fea04c5e606a1ff73f64f8"><td class="mdescLeft"> </td><td class="mdescRight">The bodyB angle minus bodyA angle in the reference state (radians). <br /></td></tr>
<tr class="separator:a1858d897d5fea04c5e606a1ff73f64f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2eaefc5fc5caf879cfd59ebcd852b756"><td class="memItemLeft" align="right" valign="top"><a id="a2eaefc5fc5caf879cfd59ebcd852b756"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a2eaefc5fc5caf879cfd59ebcd852b756">enableLimit</a></td></tr>
<tr class="memdesc:a2eaefc5fc5caf879cfd59ebcd852b756"><td class="mdescLeft"> </td><td class="mdescRight">A flag to enable joint limits. <br /></td></tr>
<tr class="separator:a2eaefc5fc5caf879cfd59ebcd852b756"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24d0b2638a01405c77bd1c0de3e53de8"><td class="memItemLeft" align="right" valign="top"><a id="a24d0b2638a01405c77bd1c0de3e53de8"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a24d0b2638a01405c77bd1c0de3e53de8">lowerAngle</a></td></tr>
<tr class="memdesc:a24d0b2638a01405c77bd1c0de3e53de8"><td class="mdescLeft"> </td><td class="mdescRight">The lower angle for the joint limit (radians). <br /></td></tr>
<tr class="separator:a24d0b2638a01405c77bd1c0de3e53de8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a692cfe333ad12afd5753a6ec54e39a66"><td class="memItemLeft" align="right" valign="top"><a id="a692cfe333ad12afd5753a6ec54e39a66"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a692cfe333ad12afd5753a6ec54e39a66">upperAngle</a></td></tr>
<tr class="memdesc:a692cfe333ad12afd5753a6ec54e39a66"><td class="mdescLeft"> </td><td class="mdescRight">The upper angle for the joint limit (radians). <br /></td></tr>
<tr class="separator:a692cfe333ad12afd5753a6ec54e39a66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa94d9e66be9f03818d0cfbd9c70b2996"><td class="memItemLeft" align="right" valign="top"><a id="aa94d9e66be9f03818d0cfbd9c70b2996"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#aa94d9e66be9f03818d0cfbd9c70b2996">enableMotor</a></td></tr>
<tr class="memdesc:aa94d9e66be9f03818d0cfbd9c70b2996"><td class="mdescLeft"> </td><td class="mdescRight">A flag to enable the joint motor. <br /></td></tr>
<tr class="separator:aa94d9e66be9f03818d0cfbd9c70b2996"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aced7cf768f4dcc3561576a39c7b92ec4"><td class="memItemLeft" align="right" valign="top"><a id="aced7cf768f4dcc3561576a39c7b92ec4"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#aced7cf768f4dcc3561576a39c7b92ec4">motorSpeed</a></td></tr>
<tr class="memdesc:aced7cf768f4dcc3561576a39c7b92ec4"><td class="mdescLeft"> </td><td class="mdescRight">The desired motor speed. Usually in radians per second. <br /></td></tr>
<tr class="separator:aced7cf768f4dcc3561576a39c7b92ec4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fc1b67fe6d1bc31f88cc2cfd681fe30"><td class="memItemLeft" align="right" valign="top">float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_revolute_joint_def.html#a9fc1b67fe6d1bc31f88cc2cfd681fe30">maxMotorTorque</a></td></tr>
<tr class="separator:a9fc1b67fe6d1bc31f88cc2cfd681fe30"><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>Revolute joint definition. This requires defining an anchor point where the bodies are joined. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. You also need to specify the initial relative angle for joint limits. This helps when saving and loading a game. The local anchor points are measured from the body's origin rather than the center of mass because:</p><ol type="1">
<li>you might not know where the center of mass will be.</li>
<li>if you add/remove shapes from a body and recompute the mass, the joints will be broken. </li>
</ol>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6401b2a663533415d032a525e4fa2806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6401b2a663533415d032a525e4fa2806">◆ </a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void b2RevoluteJointDef::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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the bodies, anchors, and reference angle using a world anchor point. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9fc1b67fe6d1bc31f88cc2cfd681fe30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fc1b67fe6d1bc31f88cc2cfd681fe30">◆ </a></span>maxMotorTorque</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float32 b2RevoluteJointDef::maxMotorTorque</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum motor torque used to achieve the desired motor speed. Usually in N-m. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="b2_revolute_joint_8h_source.html">b2RevoluteJoint.h</a></li>
<li>b2RevoluteJoint.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 21 2018 22:35:08 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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
deebb45492ddfb87b1d0b33e0be8a2b3
>
files
>
549
