summaryrefslogtreecommitdiff
path: root/docs/html/class_maze.html
blob: 873efacfe51e922a86bd3000e89264e4afb9bd48 (plain)
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<!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: Maze 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&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Maze Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Maze" -->
<p>A rectangular 2D boolean array, representing where cars can drive and where they cannot.  
 <a href="class_maze.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_maze_8h_source.html">Maze.h</a>&gt;</code></p>

<p><a href="class_maze-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Direction</a> { <a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28fad2e008a4b04be5e2d3559c70193920e7">UP</a>, 
<a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28fa89ab143d020541957ab5e0e9cfdd3e23">DOWN</a>, 
<a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28faab1a1fe0274cd139b3c0116d8caf458c">LEFT</a>, 
<a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28fa699ae3e1d989e9b12bd200aa86e29e9d">RIGHT</a>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the directions in which movement can happen in the maze.  <a href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a7ecf1da4b9685f97bf3110a8479e724b">Maze</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an empty <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> with width and height of zero.  <a href="#a7ecf1da4b9685f97bf3110a8479e724b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#ae238f9a5dbae9418f78f158ced6decf8">generateMaze</a> (const vector&lt; pair&lt; int, int &gt; &gt; &amp;walls, int maxObjectX=0, int maxObjectY=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a new <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> from the vector of wall coordinates.  <a href="#ae238f9a5dbae9418f78f158ced6decf8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a1bbdfece82c4ba90ffcf2fea52e5fef1">getSolid</a> (const int &amp;x, const int &amp;y) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a given position contains a wall or not.  <a href="#a1bbdfece82c4ba90ffcf2fea52e5fef1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a6963ffbb8e10f5ca72ddc749b3f29419">width</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the width of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> object.  <a href="#a6963ffbb8e10f5ca72ddc749b3f29419"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a53de30abea69713225ab77703e753d81">height</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the height of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> object.  <a href="#a53de30abea69713225ab77703e753d81"></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">static <a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Direction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a79cf362b55c21634a93ef6b7d192b77c">backwards</a> (<a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Direction</a> forwards)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverts a given direction, to give the value to face in the opposite direction.  <a href="#a79cf362b55c21634a93ef6b7d192b77c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef vector&lt; vector&lt; bool &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#aea392ab34f271f56b1746b30aed9588a">BoolGrid</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides an easier to read pseudonym for a 2 dimensional boolean vector.  <a href="#aea392ab34f271f56b1746b30aed9588a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_maze.html#aea392ab34f271f56b1746b30aed9588a">BoolGrid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a3f0247841ddb8a6b5b8b5eeff86b754a">_wallLocations</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The 2 dimensional vector that stores the locations of walls.  <a href="#a3f0247841ddb8a6b5b8b5eeff86b754a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a981c764d7ad04ca06bd8dee472578ce4">_width</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of blocks in each row.  <a href="#a981c764d7ad04ca06bd8dee472578ce4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maze.html#a02f1ff55e76161495bbe11bc4c0e5f54">_height</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of blocks in each column.  <a href="#a02f1ff55e76161495bbe11bc4c0e5f54"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A rectangular 2D boolean array, representing where cars can drive and where they cannot. </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="_maze_8h_source.html#l00014">14</a> of file <a class="el" href="_maze_8h_source.html">Maze.h</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="aea392ab34f271f56b1746b30aed9588a"></a><!-- doxytag: member="Maze::BoolGrid" ref="aea392ab34f271f56b1746b30aed9588a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef vector&lt;vector&lt;bool&gt; &gt; <a class="el" href="class_maze.html#aea392ab34f271f56b1746b30aed9588a">Maze::BoolGrid</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides an easier to read pseudonym for a 2 dimensional boolean vector. </p>

<p>Definition at line <a class="el" href="_maze_8h_source.html#l00085">85</a> of file <a class="el" href="_maze_8h_source.html">Maze.h</a>.</p>

</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ad12c28d50f4d7457160a70a94acfe28f"></a><!-- doxytag: member="Maze::Direction" ref="ad12c28d50f4d7457160a70a94acfe28f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Maze::Direction</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Defines the directions in which movement can happen in the maze. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ad12c28d50f4d7457160a70a94acfe28fad2e008a4b04be5e2d3559c70193920e7"></a><!-- doxytag: member="UP" ref="ad12c28d50f4d7457160a70a94acfe28fad2e008a4b04be5e2d3559c70193920e7" args="" -->UP</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad12c28d50f4d7457160a70a94acfe28fa89ab143d020541957ab5e0e9cfdd3e23"></a><!-- doxytag: member="DOWN" ref="ad12c28d50f4d7457160a70a94acfe28fa89ab143d020541957ab5e0e9cfdd3e23" args="" -->DOWN</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad12c28d50f4d7457160a70a94acfe28faab1a1fe0274cd139b3c0116d8caf458c"></a><!-- doxytag: member="LEFT" ref="ad12c28d50f4d7457160a70a94acfe28faab1a1fe0274cd139b3c0116d8caf458c" args="" -->LEFT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad12c28d50f4d7457160a70a94acfe28fa699ae3e1d989e9b12bd200aa86e29e9d"></a><!-- doxytag: member="RIGHT" ref="ad12c28d50f4d7457160a70a94acfe28fa699ae3e1d989e9b12bd200aa86e29e9d" args="" -->RIGHT</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="_maze_8h_source.html#l00020">20</a> of file <a class="el" href="_maze_8h_source.html">Maze.h</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7ecf1da4b9685f97bf3110a8479e724b"></a><!-- doxytag: member="Maze::Maze" ref="a7ecf1da4b9685f97bf3110a8479e724b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Maze::Maze </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates an empty <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> with width and height of zero. </p>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00003">3</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a79cf362b55c21634a93ef6b7d192b77c"></a><!-- doxytag: member="Maze::backwards" ref="a79cf362b55c21634a93ef6b7d192b77c" args="(Direction forwards)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Maze::Direction</a> Maze::backwards </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f">Direction</a>&#160;</td>
          <td class="paramname"><em>forwards</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Inverts a given direction, to give the value to face in the opposite direction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">forwards</td><td>The direction to be inverted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The inverse of the given direction. </dd></dl>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00057">57</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ae238f9a5dbae9418f78f158ced6decf8"></a><!-- doxytag: member="Maze::generateMaze" ref="ae238f9a5dbae9418f78f158ced6decf8" args="(const vector&lt; pair&lt; int, int &gt; &gt; &amp;walls, int maxObjectX=0, int maxObjectY=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Maze::generateMaze </td>
          <td>(</td>
          <td class="paramtype">const vector&lt; pair&lt; int, int &gt; &gt; &amp;&#160;</td>
          <td class="paramname"><em>walls</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>maxObjectX</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>maxObjectY</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Generates a new <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> from the vector of wall coordinates. </p>
<p>The size of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> is chosen to just fit all of the walls. If objects exist outside of the walls, the x of the rightmost object and the y of the bottommost object can be passed in to make the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> at least reach those coordinates.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">walls</td><td>A vector of x,y coordinate pairs representing the locations of each wall block. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">maxObjectX</td><td>The minimum x value that the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> must be able to index. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">maxObjectY</td><td>The minimum y value that the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> must be able to index. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00009">9</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a1bbdfece82c4ba90ffcf2fea52e5fef1"></a><!-- doxytag: member="Maze::getSolid" ref="a1bbdfece82c4ba90ffcf2fea52e5fef1" args="(const int &amp;x, const int &amp;y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Maze::getSolid </td>
          <td>(</td>
          <td class="paramtype">const int &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int &amp;&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checks if a given position contains a wall or not. </p>
<p>This function is one of the most called as it is called for each block drawing the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> on the <a class="el" href="class_screen.html" title="Class for creating a window on the screen.">Screen</a>, by any <a class="el" href="class_car.html" title="GameObject that moves through the maze and changes direction.">Car</a> checking if it can move, and by the <a class="el" href="class_enemy_car.html" title="GameObject that chases the player around the maze.">EnemyCar</a> to choose a viable direction to face. As such, it has been optimised by passing the parameters by constant reference, even though they are primitives. Further, the vector class's bounds checking is bypassed, with bounds checking performed manually with the assumption that the 2D vector is rectangular, to increase performance. Neither of these changes impare readability.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The x coordinate being queried. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The y coordinate being queried.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the location contains a wall. Also returns true if the coordinate is outside of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a>. </dd></dl>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00040">40</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a53de30abea69713225ab77703e753d81"></a><!-- doxytag: member="Maze::height" ref="a53de30abea69713225ab77703e753d81" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Maze::height </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the height of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amount of blocks in each column of the maze. </dd></dl>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00052">52</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6963ffbb8e10f5ca72ddc749b3f29419"></a><!-- doxytag: member="Maze::width" ref="a6963ffbb8e10f5ca72ddc749b3f29419" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Maze::width </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the width of the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amount of blocks in each row of the maze. </dd></dl>

<p>Definition at line <a class="el" href="_maze_8cpp_source.html#l00048">48</a> of file <a class="el" href="_maze_8cpp_source.html">Maze.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a02f1ff55e76161495bbe11bc4c0e5f54"></a><!-- doxytag: member="Maze::_height" ref="a02f1ff55e76161495bbe11bc4c0e5f54" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_maze.html#a02f1ff55e76161495bbe11bc4c0e5f54">Maze::_height</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The number of blocks in each column. </p>

<p>Definition at line <a class="el" href="_maze_8h_source.html#l00097">97</a> of file <a class="el" href="_maze_8h_source.html">Maze.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3f0247841ddb8a6b5b8b5eeff86b754a"></a><!-- doxytag: member="Maze::_wallLocations" ref="a3f0247841ddb8a6b5b8b5eeff86b754a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_maze.html#aea392ab34f271f56b1746b30aed9588a">BoolGrid</a> <a class="el" href="class_maze.html#a3f0247841ddb8a6b5b8b5eeff86b754a">Maze::_wallLocations</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The 2 dimensional vector that stores the locations of walls. </p>
<p>The outer vector is columns, indexed with the x coordinate, and the inner vectors are the vertical positions in the column, indexed with the y coordinate. This results in a vector that is acced with _wallLocations.at(x).at(y). </p>

<p>Definition at line <a class="el" href="_maze_8h_source.html#l00094">94</a> of file <a class="el" href="_maze_8h_source.html">Maze.h</a>.</p>

</div>
</div>
<a class="anchor" id="a981c764d7ad04ca06bd8dee472578ce4"></a><!-- doxytag: member="Maze::_width" ref="a981c764d7ad04ca06bd8dee472578ce4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_maze.html#a981c764d7ad04ca06bd8dee472578ce4">Maze::_width</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The number of blocks in each row. </p>

<p>Definition at line <a class="el" href="_maze_8h_source.html#l00096">96</a> of file <a class="el" href="_maze_8h_source.html">Maze.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="_maze_8h_source.html">Maze.h</a></li>
<li>source/logic/<a class="el" href="_maze_8cpp_source.html">Maze.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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 &#160;<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>