1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
<!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>Objective Chipmunk: ChipmunkPinJoint Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<h1>ChipmunkPinJoint Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ChipmunkPinJoint" --><!-- doxytag: inherits="ChipmunkConstraint" -->
<p>Pin joints hold a set distance between points on two bodies.
<a href="#_details">More...</a></p>
<p><code>#import <<a class="el" href="_chipmunk_constraint_8h_source.html">ChipmunkConstraint.h</a>></code></p>
<p>Inherits <a class="el" href="interface_chipmunk_constraint.html">ChipmunkConstraint</a>.</p>
<p><a href="class_chipmunk_pin_joint-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_pin_joint.html#ab5222f3acd02f249f9d39c53faf418e5">initWithBodyA:bodyB:anchr1:anchr2:</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a pin joint between the two bodies with the given anchor points. <a href="#ab5222f3acd02f249f9d39c53faf418e5"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_chipmunk_pin_joint.html">ChipmunkPinJoint</a> *) </td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_chipmunk_pin_joint.html#a04b5382751eb450408fd4c3d138a9e08">pinJointWithBodyA:bodyB:anchr1:anchr2:</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an autoreleased pin joint between the two bodies with the given anchor points. <a href="#a04b5382751eb450408fd4c3d138a9e08"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e6594e24767a962e788e444246d4283"></a><!-- doxytag: member="ChipmunkPinJoint::anchr1" ref="a2e6594e24767a962e788e444246d4283" args="" -->
cpVect </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_pin_joint.html#a2e6594e24767a962e788e444246d4283">anchr1</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The anchor point on the first body. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cbc5754c2cc0f96427e9b25a1658d4c"></a><!-- doxytag: member="ChipmunkPinJoint::anchr2" ref="a9cbc5754c2cc0f96427e9b25a1658d4c" args="" -->
cpVect </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_pin_joint.html#a9cbc5754c2cc0f96427e9b25a1658d4c">anchr2</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The anchor point on the second body. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12da676f585eaaf52f587a535d548e0b"></a><!-- doxytag: member="ChipmunkPinJoint::dist" ref="a12da676f585eaaf52f587a535d548e0b" args="" -->
cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_pin_joint.html#a12da676f585eaaf52f587a535d548e0b">dist</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The distance between the two anchor points that the joint keeps. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Pin joints hold a set distance between points on two bodies. </p>
<p>Think of them as connecting a solid pin or rod between the two anchor points. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab5222f3acd02f249f9d39c53faf418e5"></a><!-- doxytag: member="ChipmunkPinJoint::initWithBodyA:bodyB:anchr1:anchr2:" ref="ab5222f3acd02f249f9d39c53faf418e5" args="(ChipmunkBody *a,[bodyB] ChipmunkBody *b,[anchr1] cpVect anchr1,[anchr2] cpVect anchr2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) initWithBodyA: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> *) </td>
<td class="paramname"> <em>a</em></td>
</tr>
<tr>
<td class="paramkey">bodyB:</td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> *) </td>
<td class="paramname"> <em>b</em></td>
</tr>
<tr>
<td class="paramkey">anchr1:</td>
<td></td>
<td class="paramtype">(cpVect) </td>
<td class="paramname"> <em>anchr1</em></td>
</tr>
<tr>
<td class="paramkey">anchr2:</td>
<td></td>
<td class="paramtype">(cpVect) </td>
<td class="paramname"> <em>anchr2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize a pin joint between the two bodies with the given anchor points. </p>
<p>The distance is calculated when the joint is initialized. It can be set explicitly using the property. </p>
</div>
</div>
<a class="anchor" id="a04b5382751eb450408fd4c3d138a9e08"></a><!-- doxytag: member="ChipmunkPinJoint::pinJointWithBodyA:bodyB:anchr1:anchr2:" ref="a04b5382751eb450408fd4c3d138a9e08" args="(ChipmunkBody *a,[bodyB] ChipmunkBody *b,[anchr1] cpVect anchr1,[anchr2] cpVect anchr2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="interface_chipmunk_pin_joint.html">ChipmunkPinJoint</a> *) pinJointWithBodyA: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> *) </td>
<td class="paramname"> <em>a</em></td>
</tr>
<tr>
<td class="paramkey">bodyB:</td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> *) </td>
<td class="paramname"> <em>b</em></td>
</tr>
<tr>
<td class="paramkey">anchr1:</td>
<td></td>
<td class="paramtype">(cpVect) </td>
<td class="paramname"> <em>anchr1</em></td>
</tr>
<tr>
<td class="paramkey">anchr2:</td>
<td></td>
<td class="paramtype">(cpVect) </td>
<td class="paramname"> <em>anchr2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an autoreleased pin joint between the two bodies with the given anchor points. </p>
<p>The distance is calculated when the joint is initialized. It can be set explicitly using the property. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_chipmunk_constraint_8h_source.html">ChipmunkConstraint.h</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Dec 13 2010 18:43:39 for Objective Chipmunk by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
|