<!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: b2DistanceJointDef 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_distance_joint_def-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">b2DistanceJointDef Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="b2_distance_joint_8h_source.html">b2DistanceJoint.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for b2DistanceJointDef:</div>
<div class="dyncontent">
<div class="center">
<img src="structb2_distance_joint_def.png" usemap="#b2DistanceJointDef_map" alt=""/>
<map id="b2DistanceJointDef_map" name="b2DistanceJointDef_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:a99788a534638cc28cd1e44e0036503f0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#a99788a534638cc28cd1e44e0036503f0">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> &anchorA, const <a class="el" href="structb2_vec2.html">b2Vec2</a> &anchorB)</td></tr>
<tr class="separator:a99788a534638cc28cd1e44e0036503f0"><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:a15c7a75fa277e2056bf1b44198658518"><td class="memItemLeft" align="right" valign="top"><a id="a15c7a75fa277e2056bf1b44198658518"></a>
<a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#a15c7a75fa277e2056bf1b44198658518">localAnchorA</a></td></tr>
<tr class="memdesc:a15c7a75fa277e2056bf1b44198658518"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyA's origin. <br /></td></tr>
<tr class="separator:a15c7a75fa277e2056bf1b44198658518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c8995be726238eee084af750442255c"><td class="memItemLeft" align="right" valign="top"><a id="a3c8995be726238eee084af750442255c"></a>
<a class="el" href="structb2_vec2.html">b2Vec2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#a3c8995be726238eee084af750442255c">localAnchorB</a></td></tr>
<tr class="memdesc:a3c8995be726238eee084af750442255c"><td class="mdescLeft"> </td><td class="mdescRight">The local anchor point relative to bodyB's origin. <br /></td></tr>
<tr class="separator:a3c8995be726238eee084af750442255c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2c48ad52de91c804c386c12c5bf3714"><td class="memItemLeft" align="right" valign="top"><a id="ac2c48ad52de91c804c386c12c5bf3714"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#ac2c48ad52de91c804c386c12c5bf3714">length</a></td></tr>
<tr class="memdesc:ac2c48ad52de91c804c386c12c5bf3714"><td class="mdescLeft"> </td><td class="mdescRight">The natural length between the anchor points. <br /></td></tr>
<tr class="separator:ac2c48ad52de91c804c386c12c5bf3714"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35e2362bcb6c58734f95d0ac045863ea"><td class="memItemLeft" align="right" valign="top">float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#a35e2362bcb6c58734f95d0ac045863ea">frequencyHz</a></td></tr>
<tr class="separator:a35e2362bcb6c58734f95d0ac045863ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad009b24ff211158eb4e1db4815a63b94"><td class="memItemLeft" align="right" valign="top"><a id="ad009b24ff211158eb4e1db4815a63b94"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structb2_distance_joint_def.html#ad009b24ff211158eb4e1db4815a63b94">dampingRatio</a></td></tr>
<tr class="memdesc:ad009b24ff211158eb4e1db4815a63b94"><td class="mdescLeft"> </td><td class="mdescRight">The damping ratio. 0 = no damping, 1 = critical damping. <br /></td></tr>
<tr class="separator:ad009b24ff211158eb4e1db4815a63b94"><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>Distance joint definition. This requires defining an anchor point on both bodies and the non-zero length of the distance joint. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. This helps when saving and loading a game. </p><dl class="section warning"><dt>Warning</dt><dd>Do not use a zero or short length. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a99788a534638cc28cd1e44e0036503f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99788a534638cc28cd1e44e0036503f0">◆ </a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void b2DistanceJointDef::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>anchorA</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>anchorB</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the bodies, anchors, and length using the world anchors. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a35e2362bcb6c58734f95d0ac045863ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35e2362bcb6c58734f95d0ac045863ea">◆ </a></span>frequencyHz</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float32 b2DistanceJointDef::frequencyHz</td>
</tr>
</table>
</div><div class="memdoc">
<p>The mass-spring-damper frequency in Hertz. A value of 0 disables softness. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="b2_distance_joint_8h_source.html">b2DistanceJoint.h</a></li>
<li>b2DistanceJoint.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 21 2018 22:35:07 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
>
483
