diff options
Diffstat (limited to 'docs/html/class_bitmap_store.html')
| -rw-r--r-- | docs/html/class_bitmap_store.html | 665 |
1 files changed, 665 insertions, 0 deletions
diff --git a/docs/html/class_bitmap_store.html b/docs/html/class_bitmap_store.html new file mode 100644 index 0000000..6a7bf4a --- /dev/null +++ b/docs/html/class_bitmap_store.html @@ -0,0 +1,665 @@ +<!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: BitmapStore 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-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-methods">Private Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">BitmapStore Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="BitmapStore" --> +<p>Class for accessing images in ALLEGRO_BITMAP format and low level drawing. + <a href="class_bitmap_store.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>></code></p> + +<p><a href="class_bitmap_store-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  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">Image</a> { <br/> +  <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386acdaf29947fecd91b452e554a75fb9e92">PLAYER</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a8a7d9a89e243914ca702660237d4f81d">ENEMY</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386abf3851dc0110fc83020981fcbb5773eb">ROCK</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a780d6b9e20ec37fbaf5a40ca846795d9">CHECKPOINT</a>, +<br/> +  <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386ae662e77b349a8e22c5826ef35b1b5d9a">MAZE_WALL</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a4e2a075dff2c02bf40b134c9090d1f02">MAZE_FLOOR</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a91fec244d29999552e93ecb7578713fb">SMOKE</a>, +<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a8b9eb5b79abe467982784ea2227d67e0">CRASHED_CAR</a>, +<br/> +  <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386a824f0021358b88c7f1172d7dece95948">CLAIMED_CHECKPOINT</a> +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Type used to define which image should be returned. <a href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#abca96ce53be18eb07150745871a3165c">BitmapStore</a> (unsigned int blockWidth)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for creating a <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> with a set image size. <a href="#abca96ce53be18eb07150745871a3165c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a1e34f2fb55475f16ade380fa1e8829f7">~BitmapStore</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for clearing cache. <a href="#a1e34f2fb55475f16ade380fa1e8829f7"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_BITMAP * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#aadd437c869c5856c36d920dfafbc6ee4">getBitmap</a> (<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">Image</a> image)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to get image for drawing to the screen. <a href="#aadd437c869c5856c36d920dfafbc6ee4"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a012f7ace750e7964f20a39cbb5fbe321">BitmapStore</a> (const <a class="el" href="class_bitmap_store.html">BitmapStore</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented copy constructor, prevents copying of <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> objects. <a href="#a012f7ace750e7964f20a39cbb5fbe321"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_bitmap_store.html">BitmapStore</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a3c1092d55aaf1c9c5b7424d7eb2f1576">operator=</a> (const <a class="el" href="class_bitmap_store.html">BitmapStore</a> &rhs)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented assignment operator. <a href="#a3c1092d55aaf1c9c5b7424d7eb2f1576"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#af645b30d96761f401770336a555b6429">drawPlayerCar</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing the player. <a href="#af645b30d96761f401770336a555b6429"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#aff7a6fc2b35ff6cd38ef74730523f5a9">drawEnemyCar</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing an enemy. <a href="#aff7a6fc2b35ff6cd38ef74730523f5a9"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a2132a5ec8dfb43f06f75accf8bb9a50e">drawRock</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing a rock. <a href="#a2132a5ec8dfb43f06f75accf8bb9a50e"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#ae5d12fa60b03a7ea2119c67938650352">drawCheckpoint</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing a checkpoint. <a href="#ae5d12fa60b03a7ea2119c67938650352"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a90680d174c1d77e19ace8c2ba0eef6ac">drawMazeWall</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing a solid part of the maze. <a href="#a90680d174c1d77e19ace8c2ba0eef6ac"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a8a7d5fe7cc38ddb3c651152654226201">drawMazeFloor</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing a non-solid part of the maze. <a href="#a8a7d5fe7cc38ddb3c651152654226201"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a1a346a06675a7257ca8a7879aeb27e48">drawSmoke</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the image representing a smokescreen. <a href="#a1a346a06675a7257ca8a7879aeb27e48"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#abb0a062e5cb3170786a6c202a53c145b">drawCrashedCar</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the popup that appears when a car crashes. <a href="#abb0a062e5cb3170786a6c202a53c145b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a07f505192ccf0717d6aed29761934a5c">drawClaimedCheckpoint</a> (ALLEGRO_BITMAP *canvas)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Draws the popup that appears when a checkpoint is collected. <a href="#a07f505192ccf0717d6aed29761934a5c"></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_drawing_init.html">AllegroDrawingInit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a12f738a24033673278a496c1aa5abcc8">_drawingInstalls</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensures that Allegro is initialized while an object of this class exists. <a href="#a12f738a24033673278a496c1aa5abcc8"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_FONT * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a0c73c3c20f8093c83707cde15c4fed5f">_bitmapFont</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Font used for writing text on bitmaps. <a href="#a0c73c3c20f8093c83707cde15c4fed5f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">map< <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">Image</a>, ALLEGRO_BITMAP * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#ae3d18969f61f97fce6622cb6f7004711">_bitmaps</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">map containing pairs of Images (the enumerated type) and the actual images. <a href="#ae3d18969f61f97fce6622cb6f7004711"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bitmap_store.html#a157ce6e07689037e1081ccf87eaa2fff">_blockWidth</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The width of a square image in the store. <a href="#a157ce6e07689037e1081ccf87eaa2fff"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Class for accessing images in ALLEGRO_BITMAP format and low level drawing. </p> +<p>The store ensures that only one copy of identical images are created. This is done through a map, that caches the images that have already been requested. If an uncached image is requested, it is added to the cache before being returned. The store provides an enumerated type, Image, for other classes to reference which image should represent the object on the screen.</p> +<p>All images are square, to allow easy rotation and placement on the screen.</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="_bitmap_store_8h_source.html#l00030">30</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>.</p> +</div><hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="af3bc66181673def9d0a590cd13c7e386"></a><!-- doxytag: member="BitmapStore::Image" ref="af3bc66181673def9d0a590cd13c7e386" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Type used to define which image should be returned. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386acdaf29947fecd91b452e554a75fb9e92"></a><!-- doxytag: member="PLAYER" ref="af3bc66181673def9d0a590cd13c7e386acdaf29947fecd91b452e554a75fb9e92" args="" -->PLAYER</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a8a7d9a89e243914ca702660237d4f81d"></a><!-- doxytag: member="ENEMY" ref="af3bc66181673def9d0a590cd13c7e386a8a7d9a89e243914ca702660237d4f81d" args="" -->ENEMY</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386abf3851dc0110fc83020981fcbb5773eb"></a><!-- doxytag: member="ROCK" ref="af3bc66181673def9d0a590cd13c7e386abf3851dc0110fc83020981fcbb5773eb" args="" -->ROCK</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a780d6b9e20ec37fbaf5a40ca846795d9"></a><!-- doxytag: member="CHECKPOINT" ref="af3bc66181673def9d0a590cd13c7e386a780d6b9e20ec37fbaf5a40ca846795d9" args="" -->CHECKPOINT</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386ae662e77b349a8e22c5826ef35b1b5d9a"></a><!-- doxytag: member="MAZE_WALL" ref="af3bc66181673def9d0a590cd13c7e386ae662e77b349a8e22c5826ef35b1b5d9a" args="" -->MAZE_WALL</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a4e2a075dff2c02bf40b134c9090d1f02"></a><!-- doxytag: member="MAZE_FLOOR" ref="af3bc66181673def9d0a590cd13c7e386a4e2a075dff2c02bf40b134c9090d1f02" args="" -->MAZE_FLOOR</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a91fec244d29999552e93ecb7578713fb"></a><!-- doxytag: member="SMOKE" ref="af3bc66181673def9d0a590cd13c7e386a91fec244d29999552e93ecb7578713fb" args="" -->SMOKE</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a8b9eb5b79abe467982784ea2227d67e0"></a><!-- doxytag: member="CRASHED_CAR" ref="af3bc66181673def9d0a590cd13c7e386a8b9eb5b79abe467982784ea2227d67e0" args="" -->CRASHED_CAR</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="af3bc66181673def9d0a590cd13c7e386a824f0021358b88c7f1172d7dece95948"></a><!-- doxytag: member="CLAIMED_CHECKPOINT" ref="af3bc66181673def9d0a590cd13c7e386a824f0021358b88c7f1172d7dece95948" args="" -->CLAIMED_CHECKPOINT</em> </td><td> +</td></tr> +</table> +</dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8h_source.html#l00047">47</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>.</p> + +</div> +</div> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="abca96ce53be18eb07150745871a3165c"></a><!-- doxytag: member="BitmapStore::BitmapStore" ref="abca96ce53be18eb07150745871a3165c" args="(unsigned int blockWidth)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BitmapStore::BitmapStore </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>blockWidth</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Constructor for creating a <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> with a set image size. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">blockWidth</td><td>The width (and height) of an image returned by the store in pixels. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00003">3</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a1e34f2fb55475f16ade380fa1e8829f7"></a><!-- doxytag: member="BitmapStore::~BitmapStore" ref="a1e34f2fb55475f16ade380fa1e8829f7" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BitmapStore::~BitmapStore </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destructor for clearing cache. </p> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00014">14</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a012f7ace750e7964f20a39cbb5fbe321"></a><!-- doxytag: member="BitmapStore::BitmapStore" ref="a012f7ace750e7964f20a39cbb5fbe321" args="(const BitmapStore &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BitmapStore::BitmapStore </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_bitmap_store.html">BitmapStore</a> & </td> + <td class="paramname"><em>ref</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unimplemented copy constructor, prevents copying of <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> objects. </p> +<p>Copying a <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> is unneccesary as there should only be a single <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> object. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ae5d12fa60b03a7ea2119c67938650352"></a><!-- doxytag: member="BitmapStore::drawCheckpoint" ref="ae5d12fa60b03a7ea2119c67938650352" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawCheckpoint </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing a checkpoint. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00155">155</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a07f505192ccf0717d6aed29761934a5c"></a><!-- doxytag: member="BitmapStore::drawClaimedCheckpoint" ref="a07f505192ccf0717d6aed29761934a5c" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawClaimedCheckpoint </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the popup that appears when a checkpoint is collected. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00229">229</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="abb0a062e5cb3170786a6c202a53c145b"></a><!-- doxytag: member="BitmapStore::drawCrashedCar" ref="abb0a062e5cb3170786a6c202a53c145b" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawCrashedCar </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the popup that appears when a car crashes. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00208">208</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="aff7a6fc2b35ff6cd38ef74730523f5a9"></a><!-- doxytag: member="BitmapStore::drawEnemyCar" ref="aff7a6fc2b35ff6cd38ef74730523f5a9" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawEnemyCar </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing an enemy. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00105">105</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a8a7d5fe7cc38ddb3c651152654226201"></a><!-- doxytag: member="BitmapStore::drawMazeFloor" ref="a8a7d5fe7cc38ddb3c651152654226201" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawMazeFloor </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing a non-solid part of the maze. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00179">179</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a90680d174c1d77e19ace8c2ba0eef6ac"></a><!-- doxytag: member="BitmapStore::drawMazeWall" ref="a90680d174c1d77e19ace8c2ba0eef6ac" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawMazeWall </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing a solid part of the maze. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00169">169</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="af645b30d96761f401770336a555b6429"></a><!-- doxytag: member="BitmapStore::drawPlayerCar" ref="af645b30d96761f401770336a555b6429" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawPlayerCar </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing the player. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00071">71</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a2132a5ec8dfb43f06f75accf8bb9a50e"></a><!-- doxytag: member="BitmapStore::drawRock" ref="a2132a5ec8dfb43f06f75accf8bb9a50e" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawRock </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing a rock. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00139">139</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a1a346a06675a7257ca8a7879aeb27e48"></a><!-- doxytag: member="BitmapStore::drawSmoke" ref="a1a346a06675a7257ca8a7879aeb27e48" args="(ALLEGRO_BITMAP *canvas)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void BitmapStore::drawSmoke </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>canvas</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Draws the image representing a smokescreen. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">canvas</td><td>ALLEGRO_BITMAP onto which the image is drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00189">189</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="aadd437c869c5856c36d920dfafbc6ee4"></a><!-- doxytag: member="BitmapStore::getBitmap" ref="aadd437c869c5856c36d920dfafbc6ee4" args="(Image image)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_BITMAP * BitmapStore::getBitmap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">Image</a> </td> + <td class="paramname"><em>image</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Function to get image for drawing to the screen. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>Image to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>Requested image in ALLEGRO_BITMAP format. </dd></dl> + +<p>Definition at line <a class="el" href="_bitmap_store_8cpp_source.html#l00025">25</a> of file <a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a3c1092d55aaf1c9c5b7424d7eb2f1576"></a><!-- doxytag: member="BitmapStore::operator=" ref="a3c1092d55aaf1c9c5b7424d7eb2f1576" args="(const BitmapStore &rhs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_bitmap_store.html">BitmapStore</a>& BitmapStore::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_bitmap_store.html">BitmapStore</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Unimplemented assignment operator. </p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_bitmap_store.html#a012f7ace750e7964f20a39cbb5fbe321" title="Unimplemented copy constructor, prevents copying of BitmapStore objects.">BitmapStore(const BitmapStore& ref)</a>; </dd></dl> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a0c73c3c20f8093c83707cde15c4fed5f"></a><!-- doxytag: member="BitmapStore::_bitmapFont" ref="a0c73c3c20f8093c83707cde15c4fed5f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_FONT* <a class="el" href="class_bitmap_store.html#a0c73c3c20f8093c83707cde15c4fed5f">BitmapStore::_bitmapFont</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Font used for writing text on bitmaps. </p> + +<p>Definition at line <a class="el" href="_bitmap_store_8h_source.html#l00128">128</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ae3d18969f61f97fce6622cb6f7004711"></a><!-- doxytag: member="BitmapStore::_bitmaps" ref="ae3d18969f61f97fce6622cb6f7004711" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">map<<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">Image</a>, ALLEGRO_BITMAP*> <a class="el" href="class_bitmap_store.html#ae3d18969f61f97fce6622cb6f7004711">BitmapStore::_bitmaps</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>map containing pairs of Images (the enumerated type) and the actual images. </p> +<p>Creates a cache for images once they have been drawn. </p> + +<p>Definition at line <a class="el" href="_bitmap_store_8h_source.html#l00135">135</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a157ce6e07689037e1081ccf87eaa2fff"></a><!-- doxytag: member="BitmapStore::_blockWidth" ref="a157ce6e07689037e1081ccf87eaa2fff" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int <a class="el" href="class_bitmap_store.html#a157ce6e07689037e1081ccf87eaa2fff">BitmapStore::_blockWidth</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The width of a square image in the store. </p> + +<p>Definition at line <a class="el" href="_bitmap_store_8h_source.html#l00137">137</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a12f738a24033673278a496c1aa5abcc8"></a><!-- doxytag: member="BitmapStore::_drawingInstalls" ref="a12f738a24033673278a496c1aa5abcc8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_allegro_drawing_init.html">AllegroDrawingInit</a> <a class="el" href="class_bitmap_store.html#a12f738a24033673278a496c1aa5abcc8">BitmapStore::_drawingInstalls</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Ensures that Allegro is initialized while an object of this class exists. </p> + +<p>Definition at line <a class="el" href="_bitmap_store_8h_source.html#l00126">126</a> of file <a class="el" href="_bitmap_store_8h_source.html">BitmapStore.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="_bitmap_store_8h_source.html">BitmapStore.h</a></li> +<li>source/presentation/<a class="el" href="_bitmap_store_8cpp_source.html">BitmapStore.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> |