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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
<!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>Rally X: Car Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="car.PNG"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Rally X
</div>
<div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
<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 id="navrow2" 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="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Car Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Car" --><!-- doxytag: inherits="GameObject" -->
<p><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that moves through the maze and changes direction.
<a href="class_car.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_car_8h_source.html">Car.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Car:</div>
<div class="dyncontent">
<div class="center">
<img src="class_car.png" usemap="#Car_map" alt=""/>
<map id="Car_map" name="Car_map">
<area href="class_game_object.html" title="Parent class for objects that are placed in the maze." alt="GameObject" shape="rect" coords="45,0,126,24"/>
<area href="class_enemy_car.html" title="GameObject that chases the player around the maze." alt="EnemyCar" shape="rect" coords="0,112,81,136"/>
<area href="class_player_car.html" title="A GameObject that is controlled by the player." alt="PlayerCar" shape="rect" coords="91,112,172,136"/>
</map>
</div></div>
<p><a href="class_car-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_car.html#a3bd1dc6b75af9dc5bbe4354e0b3161d0">Car</a> (double x, double y, <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a> image, <a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Maze::Direction</a> facing)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> at the given position, with the given image, facing in the given direction. <a href="#a3bd1dc6b75af9dc5bbe4354e0b3161d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_car.html#a68b59187e1520a5d016b0894b4c116b9">speed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to access the current speed of the car. <a href="#a68b59187e1520a5d016b0894b4c116b9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_car.html#a85e8699362bb5206e4142dbd5d20dcb9">move</a> (const <a class="el" href="class_maze.html">Maze</a> &maze)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Moves the car by its current speed in the direction of its facing. <a href="#a85e8699362bb5206e4142dbd5d20dcb9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_car.html#a84b3d05e98d66f358942193ff54dee51">_speed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The current speed that the <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> is moving at. <a href="#a84b3d05e98d66f358942193ff54dee51"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_car.html#a7b942584de02f8af6f571a60a1cf32ba">_baseSpeed</a> = 0.1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The speed that a <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> moves at in normal conditions. <a href="#a7b942584de02f8af6f571a60a1cf32ba"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that moves through the maze and changes direction. </p>
<p>Should not be instantiated directly, but rather instantiated through one of the subclasses, <a class="el" href="class_player_car.html" title="A GameObject that is controlled by the player.">PlayerCar</a> or <a class="el" href="class_enemy_car.html" title="GameObject that chases the player around the maze.">EnemyCar</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Justin Wernick </dd>
<dd>
David Schneider </dd></dl>
<p>Definition at line <a class="el" href="_car_8h_source.html#l00020">20</a> of file <a class="el" href="_car_8h_source.html">Car.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3bd1dc6b75af9dc5bbe4354e0b3161d0"></a><!-- doxytag: member="Car::Car" ref="a3bd1dc6b75af9dc5bbe4354e0b3161d0" args="(double x, double y, BitmapStore::Image image, Maze::Direction facing)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Car::Car </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a> </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Maze::Direction</a> </td>
<td class="paramname"><em>facing</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> at the given position, with the given image, facing in the given direction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>x coordinate of initial position. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>y coordinate of initial position. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>Bitmap to be drawn on the screen to represent the car. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">facing</td><td>Direction in which the <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> is initially facing. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_car_8cpp_source.html#l00003">3</a> of file <a class="el" href="_car_8cpp_source.html">Car.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a85e8699362bb5206e4142dbd5d20dcb9"></a><!-- doxytag: member="Car::move" ref="a85e8699362bb5206e4142dbd5d20dcb9" args="(const Maze &maze)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Car::move </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_maze.html">Maze</a> & </td>
<td class="paramname"><em>maze</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Moves the car by its current speed in the direction of its facing. </p>
<p>Only moves along the x or y axis, and snaps to the grid in the other direction. Does not allow movement through solid parts of the maze.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">maze</td><td>The maze in which the <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> is moving, confining its movements. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_car_8cpp_source.html#l00014">14</a> of file <a class="el" href="_car_8cpp_source.html">Car.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a68b59187e1520a5d016b0894b4c116b9"></a><!-- doxytag: member="Car::speed" ref="a68b59187e1520a5d016b0894b4c116b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Car::speed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function to access the current speed of the car. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current speed of the car, in pixels per update. </dd></dl>
<p>Definition at line <a class="el" href="_car_8cpp_source.html#l00009">9</a> of file <a class="el" href="_car_8cpp_source.html">Car.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a7b942584de02f8af6f571a60a1cf32ba"></a><!-- doxytag: member="Car::_baseSpeed" ref="a7b942584de02f8af6f571a60a1cf32ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const double <a class="el" href="class_car.html#a7b942584de02f8af6f571a60a1cf32ba">Car::_baseSpeed</a> = 0.1<code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The speed that a <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> moves at in normal conditions. </p>
<p>Definition at line <a class="el" href="_car_8h_source.html#l00054">54</a> of file <a class="el" href="_car_8h_source.html">Car.h</a>.</p>
</div>
</div>
<a class="anchor" id="a84b3d05e98d66f358942193ff54dee51"></a><!-- doxytag: member="Car::_speed" ref="a84b3d05e98d66f358942193ff54dee51" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="class_car.html#a84b3d05e98d66f358942193ff54dee51">Car::_speed</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current speed that the <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> is moving at. </p>
<p>Definition at line <a class="el" href="_car_8h_source.html#l00053">53</a> of file <a class="el" href="_car_8h_source.html">Car.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>source/logic/<a class="el" href="_car_8h_source.html">Car.h</a></li>
<li>source/logic/<a class="el" href="_car_8cpp_source.html">Car.cpp</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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></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>
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 5 2011 20:08:31 for Rally X by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>
</body>
</html>
|
