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
200
201
202
203
204
|
<!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: ChipmunkShape 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="#properties">Properties</a> </div>
<div class="headertitle">
<h1>ChipmunkShape Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ChipmunkShape" --><!-- doxytag: inherits="ChipmunkBaseObject-p" -->
<p>Abstract base class for collsion shape types.
<a href="#_details">More...</a></p>
<p><code>#import <<a class="el" href="_chipmunk_shape_8h_source.html">ChipmunkShape.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_circle_shape.html">ChipmunkCircleShape</a>, <a class="el" href="interface_chipmunk_poly_shape.html">ChipmunkPolyShape</a>, and <a class="el" href="interface_chipmunk_segment_shape.html">ChipmunkSegmentShape</a>.</p>
<p><a href="class_chipmunk_shape-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"><a class="anchor" id="a8904b565d74a2bd419b33cba98fdc9e2"></a><!-- doxytag: member="ChipmunkShape::cacheBB" ref="a8904b565d74a2bd419b33cba98fdc9e2" args="()" -->
(cpBB) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_shape.html#a8904b565d74a2bd419b33cba98fdc9e2">cacheBB</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update and cache the axis-aligned bounding box for this shape. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfc5d5df4f881d591c6bb67af67323d5"></a><!-- doxytag: member="ChipmunkShape::pointQuery:" ref="abfc5d5df4f881d591c6bb67af67323d5" args="(cpVect point)" -->
(bool) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_shape.html#abfc5d5df4f881d591c6bb67af67323d5">pointQuery:</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a point in absolute coordinates lies within the shape. <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="adcc8138bf6513071dd956adcd45c1a2f"></a><!-- doxytag: member="ChipmunkShape::shape" ref="adcc8138bf6513071dd956adcd45c1a2f" args="" -->
cpShape * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#adcc8138bf6513071dd956adcd45c1a2f">shape</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying cpShape C struct. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ca84366c13237a0e387d28e15865192"></a><!-- doxytag: member="ChipmunkShape::body" ref="a0ca84366c13237a0e387d28e15865192" args="" -->
<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#a0ca84366c13237a0e387d28e15865192">body</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="interface_chipmunk_body.html" title="Rigid bodies are the basic unit of simulation in Chipmunk.">ChipmunkBody</a> that this shape is attached to. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af76755f32475329226932c1d6dacff41"></a><!-- doxytag: member="ChipmunkShape::bb" ref="af76755f32475329226932c1d6dacff41" args="" -->
cpBB </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#af76755f32475329226932c1d6dacff41">bb</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The axis-aligned bounding box for this shape. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2916f8e94f1e148e506781bbbe9e31f"></a><!-- doxytag: member="ChipmunkShape::sensor" ref="af2916f8e94f1e148e506781bbbe9e31f" args="" -->
BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#af2916f8e94f1e148e506781bbbe9e31f">sensor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sensor shapes send collision callback messages, but don't create a collision response. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa25644777b090207dc5be78da2922f85"></a><!-- doxytag: member="ChipmunkShape::elasticity" ref="aa25644777b090207dc5be78da2922f85" args="" -->
cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#aa25644777b090207dc5be78da2922f85">elasticity</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How bouncy this shape is. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac161b9d079be6c15166a7e94232eb296"></a><!-- doxytag: member="ChipmunkShape::friction" ref="ac161b9d079be6c15166a7e94232eb296" args="" -->
cpFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#ac161b9d079be6c15166a7e94232eb296">friction</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How much friction this shape has. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">cpVect </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#a9bdd914e4b665ca108e5aebb09caf228">surfaceVel</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The velocity of the shape's surface. <a href="#a9bdd914e4b665ca108e5aebb09caf228"></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_shape.html#a8dc205ce246e673d60cc40d2bbd8a693">collisionType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An object reference used as a collision type identifier. <a href="#a8dc205ce246e673d60cc40d2bbd8a693"></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_shape.html#a5720f10418920f7645c12eb5d57c51e5">group</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An object reference used as a collision group identifier. <a href="#a5720f10418920f7645c12eb5d57c51e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41a959241f56e4fee8a6610d86f93937"></a><!-- doxytag: member="ChipmunkShape::layers" ref="a41a959241f56e4fee8a6610d86f93937" args="" -->
cpLayers </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#a41a959241f56e4fee8a6610d86f93937">layers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A layer bitmask that defines which objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">id </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_shape.html#a00de9897a0f58f140054a6dbb0b9e389">data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An object that this shape is associated with. <a href="#a00de9897a0f58f140054a6dbb0b9e389"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract base class for collsion shape types. </p>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a8dc205ce246e673d60cc40d2bbd8a693"></a><!-- doxytag: member="ChipmunkShape::collisionType" ref="a8dc205ce246e673d60cc40d2bbd8a693" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) collisionType<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object reference used as a collision type identifier. </p>
<p>This is used when defining collision handlers. </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>. </dd></dl>
</div>
</div>
<a class="anchor" id="a00de9897a0f58f140054a6dbb0b9e389"></a><!-- doxytag: member="ChipmunkShape::data" ref="a00de9897a0f58f140054a6dbb0b9e389" 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 shape 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="a5720f10418920f7645c12eb5d57c51e5"></a><!-- doxytag: member="ChipmunkShape::group" ref="a5720f10418920f7645c12eb5d57c51e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) group<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object reference used as a collision group identifier. </p>
<p>Shapes with the same group do not collide. </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>. </dd></dl>
</div>
</div>
<a class="anchor" id="a9bdd914e4b665ca108e5aebb09caf228"></a><!-- doxytag: member="ChipmunkShape::surfaceVel" ref="a9bdd914e4b665ca108e5aebb09caf228" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (cpVect) surfaceVel<code> [read, write, assign]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The velocity of the shape's surface. </p>
<p>This velocity is used in the collision response when calculating the friction only. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_chipmunk_shape_8h_source.html">ChipmunkShape.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>
|
