summaryrefslogtreecommitdiff
path: root/docs/html/class_screen_panel.html
blob: cc72a9fb908895d8a1dcf72691e7d30d2e2855ed (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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
<!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: ScreenPanel 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-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ScreenPanel Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ScreenPanel" -->
<p>Parent class for panels that are drawn on the screen.  
 <a href="class_screen_panel.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ScreenPanel:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_screen_panel.png" usemap="#ScreenPanel_map" alt=""/>
  <map id="ScreenPanel_map" name="ScreenPanel_map">
<area href="class_game_panel.html" title="ScreenPanel to be drawn on the screen to draw the area where the game takes place." alt="GamePanel" shape="rect" coords="0,56,85,80"/>
<area href="class_info_panel.html" title="ScreenPanel to be drawn on the screen to give the player information." alt="InfoPanel" shape="rect" coords="95,56,180,80"/>
</map>
 </div></div>

<p><a href="class_screen_panel-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a8c13559489444ea8131066fa5b884645">ScreenPanel</a> (ALLEGRO_BITMAP *back, ALLEGRO_BITMAP *front, int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> from the given back and front buffers.  <a href="#a8c13559489444ea8131066fa5b884645"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a843296c130c75beb41ada9ba3eddd457">~ScreenPanel</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor to ensure that sub-bitmap memory is deallocated.  <a href="#a843296c130c75beb41ada9ba3eddd457"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#ab4299f065cdf3e344c3b32b484136ada">draw</a> (const <a class="el" href="class_maze.html">Maze</a> &amp;maze, const list&lt; <a class="el" href="class_player_car.html">PlayerCar</a> &gt; &amp;players, const list&lt; <a class="el" href="class_enemy_car.html">EnemyCar</a> &gt; &amp;enemies, const list&lt; <a class="el" href="class_checkpoint.html">Checkpoint</a> &gt; &amp;checkpoints, const list&lt; <a class="el" href="class_rock.html">Rock</a> &gt; &amp;rocks, const list&lt; <a class="el" href="class_smokescreen.html">Smokescreen</a> &gt; &amp;smokescreens, const list&lt; <a class="el" href="class_destroyed_object_popup.html">DestroyedObjectPopup</a> &gt; &amp;popups)=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pure virtual method for drawing a collection of objects onto the panel.  <a href="#ab4299f065cdf3e344c3b32b484136ada"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#ab701d3888b13463d200be112f0eb4d82">flip</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps the front and back buffers.  <a href="#ab701d3888b13463d200be112f0eb4d82"></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">ALLEGRO_BITMAP *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a1a3ec8e60be5d5cede210171bda33468">_back</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The back buffer. Only the back buffer can be drawn to.  <a href="#a1a3ec8e60be5d5cede210171bda33468"></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_screen_panel.html#afbbcad2a101b95869dcdef9bf0898f65">_width</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the sub-bitmaps being drawn to in pixels.  <a href="#afbbcad2a101b95869dcdef9bf0898f65"></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_screen_panel.html#a4f6dd5c7ca10d51bface7b1ddedc236c">_height</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the sub-bitmaps being drawn to in pixels.  <a href="#a4f6dd5c7ca10d51bface7b1ddedc236c"></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 ALLEGRO_COLOR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a1cc6ea44035f47d77d24b4cee9dc9d85">BLANK</a> = al_map_rgb(0,0,0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Colour used to clear the screen at the beginning of drawing operations.  <a href="#a1cc6ea44035f47d77d24b4cee9dc9d85"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private 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_screen_panel.html#a60c670cbb4930adcb77dc3002fdeb4df">ScreenPanel</a> (const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &amp;ref)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor not implemented, ScreenPanels should not be copied.  <a href="#a60c670cbb4930adcb77dc3002fdeb4df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_screen_panel.html">ScreenPanel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a896035d9c68aecd6ca802e2223d26ec5">operator=</a> (const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &amp;rhs)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator not implemented, ScreenPanels should not be copied.  <a href="#a896035d9c68aecd6ca802e2223d26ec5"></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_allegro_init.html">AllegroInit</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a3877f04c03866e35588f0b753ee7c485">_allegro</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles dependencies on Allegro being initialised.  <a href="#a3877f04c03866e35588f0b753ee7c485"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_BITMAP *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a0a3232c41ca107b2cceee73aa0e0d7fe">_front</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The front buffer, that is currently being shown on the screen.  <a href="#a0a3232c41ca107b2cceee73aa0e0d7fe"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Parent class for panels that are drawn on the screen. </p>
<p>Panels are given a sub-bitmap of the <a class="el" href="class_screen.html" title="Class for creating a window on the screen.">Screen</a> bitmap, which they draw their panel specific outputs on. The <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> class is subclassed to give specific drawing functions, like 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> and GameObjects on the screen.</p>
<p>When the object is created, the back bitmap and front bitmap should correspond to the back and front buffers of the display respectively. This should be kept in sync by calling flip every time the display is flipped.</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="_screen_panel_8h_source.html#l00029">29</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8c13559489444ea8131066fa5b884645"></a><!-- doxytag: member="ScreenPanel::ScreenPanel" ref="a8c13559489444ea8131066fa5b884645" args="(ALLEGRO_BITMAP *back, ALLEGRO_BITMAP *front, int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ScreenPanel::ScreenPanel </td>
          <td>(</td>
          <td class="paramtype">ALLEGRO_BITMAP *&#160;</td>
          <td class="paramname"><em>back</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALLEGRO_BITMAP *&#160;</td>
          <td class="paramname"><em>front</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>height</em>&#160;</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_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> from the given back and front buffers. </p>
<p>The sub-bitmaps that <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> uses are created from a rectangular region on back and front that has its top left corner at the coordinate x,y, is width long in the x direction, and height long in the y direction.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">back</td><td>The current back buffer of the display being sub-bitmapped. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">front</td><td>The current front buffer (image currently being displayed) of the display being sub-bitmapped. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The x coordinate of the left side of the sub-bitmap in pixels. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The x coordinate of the top of the sub-bitmap in pixels. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The length in the x direction of the new sub-bitmap in pixels. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The length in the y direction of the new sub-bitmap in pixels. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00005">5</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a843296c130c75beb41ada9ba3eddd457"></a><!-- doxytag: member="ScreenPanel::~ScreenPanel" ref="a843296c130c75beb41ada9ba3eddd457" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ScreenPanel::~ScreenPanel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor to ensure that sub-bitmap memory is deallocated. </p>

<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00013">13</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a60c670cbb4930adcb77dc3002fdeb4df"></a><!-- doxytag: member="ScreenPanel::ScreenPanel" ref="a60c670cbb4930adcb77dc3002fdeb4df" args="(const ScreenPanel &amp;ref)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ScreenPanel::ScreenPanel </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &amp;&#160;</td>
          <td class="paramname"><em>ref</em></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Copy constructor not implemented, ScreenPanels should not be copied. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab4299f065cdf3e344c3b32b484136ada"></a><!-- doxytag: member="ScreenPanel::draw" ref="ab4299f065cdf3e344c3b32b484136ada" args="(const Maze &amp;maze, const list&lt; PlayerCar &gt; &amp;players, const list&lt; EnemyCar &gt; &amp;enemies, const list&lt; Checkpoint &gt; &amp;checkpoints, const list&lt; Rock &gt; &amp;rocks, const list&lt; Smokescreen &gt; &amp;smokescreens, const list&lt; DestroyedObjectPopup &gt; &amp;popups)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ScreenPanel::draw </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_maze.html">Maze</a> &amp;&#160;</td>
          <td class="paramname"><em>maze</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_player_car.html">PlayerCar</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>players</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_enemy_car.html">EnemyCar</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>enemies</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_checkpoint.html">Checkpoint</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>checkpoints</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_rock.html">Rock</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>rocks</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_smokescreen.html">Smokescreen</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>smokescreens</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const list&lt; <a class="el" href="class_destroyed_object_popup.html">DestroyedObjectPopup</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>popups</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Pure virtual method for drawing a collection of objects onto the panel. </p>
<p>Implementations do not need to draw all of the objects if it is not neccesary for the type of panel, but the interface accepts all of them to be general.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">maze</td><td>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> that all of the objects are in. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">players</td><td>The list of PlayerCars to be drawn. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">enemies</td><td>The list of EnemyCars to be drawn. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">checkpoints</td><td>The list of Checkpoints to be drawn. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">rocks</td><td>The list of Rocks to be drawn. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">smokescreens</td><td>The list of Smokescreens to be drawn. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">popups</td><td>The list of DestroyedObjectPopups to be drawn. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="class_info_panel.html#aa9628c14e08ac6573e0191d9d4afa227">InfoPanel</a>, and <a class="el" href="class_game_panel.html#ab093fb770fa8b46ee863947259c72abd">GamePanel</a>.</p>

</div>
</div>
<a class="anchor" id="ab701d3888b13463d200be112f0eb4d82"></a><!-- doxytag: member="ScreenPanel::flip" ref="ab701d3888b13463d200be112f0eb4d82" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ScreenPanel::flip </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Swaps the front and back buffers. </p>
<p>This function should be called every time the display is flipped. </p>

<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00019">19</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a896035d9c68aecd6ca802e2223d26ec5"></a><!-- doxytag: member="ScreenPanel::operator=" ref="a896035d9c68aecd6ca802e2223d26ec5" args="(const ScreenPanel &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_screen_panel.html">ScreenPanel</a>&amp; ScreenPanel::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Assignment operator not implemented, ScreenPanels should not be copied. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3877f04c03866e35588f0b753ee7c485"></a><!-- doxytag: member="ScreenPanel::_allegro" ref="a3877f04c03866e35588f0b753ee7c485" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_allegro_init.html">AllegroInit</a> <a class="el" href="class_screen_panel.html#a3877f04c03866e35588f0b753ee7c485">ScreenPanel::_allegro</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Handles dependencies on Allegro being initialised. </p>

<p>Reimplemented in <a class="el" href="class_game_panel.html#a18c100c8d9ae2601a97083485d937418">GamePanel</a>.</p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00093">93</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1a3ec8e60be5d5cede210171bda33468"></a><!-- doxytag: member="ScreenPanel::_back" ref="a1a3ec8e60be5d5cede210171bda33468" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ALLEGRO_BITMAP* <a class="el" href="class_screen_panel.html#a1a3ec8e60be5d5cede210171bda33468">ScreenPanel::_back</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The back buffer. Only the back buffer can be drawn to. </p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00079">79</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0a3232c41ca107b2cceee73aa0e0d7fe"></a><!-- doxytag: member="ScreenPanel::_front" ref="a0a3232c41ca107b2cceee73aa0e0d7fe" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ALLEGRO_BITMAP* <a class="el" href="class_screen_panel.html#a0a3232c41ca107b2cceee73aa0e0d7fe">ScreenPanel::_front</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The front buffer, that is currently being shown on the screen. </p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00095">95</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4f6dd5c7ca10d51bface7b1ddedc236c"></a><!-- doxytag: member="ScreenPanel::_height" ref="a4f6dd5c7ca10d51bface7b1ddedc236c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_screen_panel.html#a4f6dd5c7ca10d51bface7b1ddedc236c">ScreenPanel::_height</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The height of the sub-bitmaps being drawn to in pixels. </p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00082">82</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

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

<p>The width of the sub-bitmaps being drawn to in pixels. </p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00081">81</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1cc6ea44035f47d77d24b4cee9dc9d85"></a><!-- doxytag: member="ScreenPanel::BLANK" ref="a1cc6ea44035f47d77d24b4cee9dc9d85" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const ALLEGRO_COLOR <a class="el" href="class_screen_panel.html#a1cc6ea44035f47d77d24b4cee9dc9d85">ScreenPanel::BLANK</a> = al_map_rgb(0,0,0)<code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Colour used to clear the screen at the beginning of drawing operations. </p>

<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00077">77</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>source/presentation/<a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a></li>
<li>source/presentation/<a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.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>