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
|
<!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: ChipmunkConstraint 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="#properties">Properties</a> </div>
<div class="headertitle">
<h1>ChipmunkConstraint Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ChipmunkConstraint" --><!-- doxytag: inherits="ChipmunkBaseObject-p" -->
<p>Constraints connect two <a class="el" href="interface_chipmunk_body.html" title="Rigid bodies are the basic unit of simulation in Chipmunk.">ChipmunkBody</a> objects together.
<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="protocol_chipmunk_base_object-p.html">ChipmunkBaseObject-p</a>.</p>
<p>Inherited by <a class="el" href="interface_chipmunk_damped_rotary_spring.html">ChipmunkDampedRotarySpring</a>, <a class="el" href="interface_chipmunk_damped_spring.html">ChipmunkDampedSpring</a>, <a class="el" href="interface_chipmunk_gear_joint.html">ChipmunkGearJoint</a>, <a class="el" href="interface_chipmunk_groove_joint.html">ChipmunkGrooveJoint</a>, <a class="el" href="interface_chipmunk_pin_joint.html">ChipmunkPinJoint</a>, <a class="el" href="interface_chipmunk_pivot_joint.html">ChipmunkPivotJoint</a>, <a class="el" href="interface_chipmunk_ratchet_joint.html">ChipmunkRatchetJoint</a>, <a class="el" href="interface_chipmunk_rotary_limit_joint.html">ChipmunkRotaryLimitJoint</a>, <a class="el" href="interface_chipmunk_simple_motor.html">ChipmunkSimpleMotor</a>, and <a class="el" href="interface_chipmunk_slide_joint.html">ChipmunkSlideJoint</a>.</p>
<p><a href="class_chipmunk_constraint-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a78ffbfb6a51f7742b9c084abca8778f0"></a><!-- doxytag: member="ChipmunkConstraint::constraint" ref="a78ffbfb6a51f7742b9c084abca8778f0" args="" -->
cpConstraint * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#a78ffbfb6a51f7742b9c084abca8778f0">constraint</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying cpConstraint C struct. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae60654a9744d40d272c77d41a781203"></a><!-- doxytag: member="ChipmunkConstraint::bodyA" ref="aae60654a9744d40d272c77d41a781203" args="" -->
<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#aae60654a9744d40d272c77d41a781203">bodyA</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The first <a class="el" href="interface_chipmunk_body.html" title="Rigid bodies are the basic unit of simulation in Chipmunk.">ChipmunkBody</a> the constraint controls. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3b008f612c712a3dce2e48c1a32f0c5"></a><!-- doxytag: member="ChipmunkConstraint::bodyB" ref="ab3b008f612c712a3dce2e48c1a32f0c5" args="" -->
<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#ab3b008f612c712a3dce2e48c1a32f0c5">bodyB</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The second <a class="el" href="interface_chipmunk_body.html" title="Rigid bodies are the basic unit of simulation in Chipmunk.">ChipmunkBody</a> the constraint controls. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#ad6294d2fd2c320f9a1912c48464860f0">maxForce</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum force this constraint is allowed to use (defalts to infinity). <a href="#ad6294d2fd2c320f9a1912c48464860f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#a8e639de970eba3b86c58bbe9fabe9016">biasCoef</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Amount of constraint error to correct each step (defaults to 10%). <a href="#a8e639de970eba3b86c58bbe9fabe9016"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#a45acd3f4ab2c7633167a55280ab60042">maxBias</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum rate (speed) that a joint can be corrected at (defaults to infinity). <a href="#a45acd3f4ab2c7633167a55280ab60042"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">id </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_constraint.html#a0dc9b49b787eab446b58e2dc94680f2a">data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An object that this constraint is associated with. <a href="#a0dc9b49b787eab446b58e2dc94680f2a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Constraints connect two <a class="el" href="interface_chipmunk_body.html" title="Rigid bodies are the basic unit of simulation in Chipmunk.">ChipmunkBody</a> objects together. </p>
<p>Most often constraints are simple joints, but can also be things like motors, friction generators or servos.</p>
<object width="425" height="344">
<param name="movie" value="http://www.youtube.com/v/ZgJJZTS0aMM?fs=1&hl=en_US&rel=0"></param>
<param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param>
<embed src="http://www.youtube.com/v/ZgJJZTS0aMM?fs=1&hl=en_US&rel=0" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="425" height="344"></embed>
</object>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a8e639de970eba3b86c58bbe9fabe9016"></a><!-- doxytag: member="ChipmunkConstraint::biasCoef" ref="a8e639de970eba3b86c58bbe9fabe9016" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (cpFloat) biasCoef<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Amount of constraint error to correct each step (defaults to 10%). </p>
<p>This can be used to fine tune constraint parameters. </p>
</div>
</div>
<a class="anchor" id="a0dc9b49b787eab446b58e2dc94680f2a"></a><!-- doxytag: member="ChipmunkConstraint::data" ref="a0dc9b49b787eab446b58e2dc94680f2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) data<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object that this constraint is associated with. </p>
<p>You can use this get a reference to your game object or controller object from within callbacks. </p>
<dl class="attention"><dt><b>Attention:</b></dt><dd>Like most <code>delegate</code> properties this is a weak reference and does not call <code>retain</code>. This prevents reference cycles from occuring. </dd></dl>
<p>Reimplemented from <a class="el" href="protocol_chipmunk_base_object-p.html"><ChipmunkBaseObject></a>.</p>
</div>
</div>
<a class="anchor" id="a45acd3f4ab2c7633167a55280ab60042"></a><!-- doxytag: member="ChipmunkConstraint::maxBias" ref="a45acd3f4ab2c7633167a55280ab60042" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (cpFloat) maxBias<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum rate (speed) that a joint can be corrected at (defaults to infinity). </p>
<p>Setting this value to a finite value allows you to control a joint like a </p>
</div>
</div>
<a class="anchor" id="ad6294d2fd2c320f9a1912c48464860f0"></a><!-- doxytag: member="ChipmunkConstraint::maxForce" ref="ad6294d2fd2c320f9a1912c48464860f0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (cpFloat) maxForce<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum force this constraint is allowed to use (defalts to infinity). </p>
<p>This allows joints to be pulled apart if too much force is applied to them. It also allows you to use constraints as force or friction generators for controlling bodies. </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>
|
