diff options
Diffstat (limited to 'docs/html/class_colour_store.html')
-rw-r--r-- | docs/html/class_colour_store.html | 297 |
1 files changed, 297 insertions, 0 deletions
diff --git a/docs/html/class_colour_store.html b/docs/html/class_colour_store.html new file mode 100644 index 0000000..d7af6da --- /dev/null +++ b/docs/html/class_colour_store.html @@ -0,0 +1,297 @@ +<!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: ColourStore Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> + +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Rally X + + </div> + <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-methods">Private Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">ColourStore Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="ColourStore" --> +<p>Class for mapping <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> images to colours for use in the minimap. + <a href="class_colour_store.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_colour_store_8h_source.html">ColourStore.h</a>></code></p> + +<p><a href="class_colour_store-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#a667f2e3c6d5b6eb553f58724e58bbed0">ColourStore</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the <a class="el" href="class_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> object and initialises all of the colours. <a href="#a667f2e3c6d5b6eb553f58724e58bbed0"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_COLOR </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#ac8474c4e9b335215f03ec2c749847ad2">getColour</a> (<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a> image)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the colour associated with a given image. <a href="#ac8474c4e9b335215f03ec2c749847ad2"></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_colour_store.html#a3063a6fce81040a8b840a303b1e08829">ColourStore</a> (const <a class="el" href="class_colour_store.html">ColourStore</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented copy constructor, prevents copying of <a class="el" href="class_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> objects. <a href="#a3063a6fce81040a8b840a303b1e08829"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_colour_store.html">ColourStore</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#a2d3688dbcdf5f9f9b82ef50709c2f286">operator=</a> (const <a class="el" href="class_colour_store.html">ColourStore</a> &rhs)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unimplemented assignment operator. <a href="#a2d3688dbcdf5f9f9b82ef50709c2f286"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#ad3f729c8e9f6a94bacd85e6db47e2e82">populateColours</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises all of the relevant colours. <a href="#ad3f729c8e9f6a94bacd85e6db47e2e82"></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">map< <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a>, <br class="typebreak"/> +ALLEGRO_COLOR > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#acb64b1ffc465fa752a2f282da4c9afba">_colours</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_COLOR </td><td class="memItemRight" valign="bottom"><a class="el" href="class_colour_store.html#acadd8e6ed32fe6535252c94124df04ca">_transparent</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialised to have an alpha of 0, and returned when the colour of an unlisted image is requested. <a href="#acadd8e6ed32fe6535252c94124df04ca"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Class for mapping <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> images to colours for use in the minimap. </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="_colour_store_8h_source.html#l00014">14</a> of file <a class="el" href="_colour_store_8h_source.html">ColourStore.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a667f2e3c6d5b6eb553f58724e58bbed0"></a><!-- doxytag: member="ColourStore::ColourStore" ref="a667f2e3c6d5b6eb553f58724e58bbed0" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ColourStore::ColourStore </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Creates the <a class="el" href="class_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> object and initialises all of the colours. </p> + +<p>Definition at line <a class="el" href="_colour_store_8cpp_source.html#l00003">3</a> of file <a class="el" href="_colour_store_8cpp_source.html">ColourStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a3063a6fce81040a8b840a303b1e08829"></a><!-- doxytag: member="ColourStore::ColourStore" ref="a3063a6fce81040a8b840a303b1e08829" args="(const ColourStore &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ColourStore::ColourStore </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_colour_store.html">ColourStore</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_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> objects. </p> +<p>Copying a <a class="el" href="class_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> is unneccesary as there should only be a single <a class="el" href="class_colour_store.html" title="Class for mapping BitmapStore images to colours for use in the minimap.">ColourStore</a> object. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ac8474c4e9b335215f03ec2c749847ad2"></a><!-- doxytag: member="ColourStore::getColour" ref="ac8474c4e9b335215f03ec2c749847ad2" args="(BitmapStore::Image image)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_COLOR ColourStore::getColour </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a> </td> + <td class="paramname"><em>image</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the colour associated with a given image. </p> +<p>If no colour makes sense for the image, then when it is requested a colour with an alpha of 0 (completely transparent) is returned.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The <a class="el" href="class_bitmap_store.html" title="Class for accessing images in ALLEGRO_BITMAP format and low level drawing.">BitmapStore</a> image to be associated with a colour.</td></tr> + </table> + </dd> +</dl> +<dl class="return"><dt><b>Returns:</b></dt><dd>The requested colour. </dd></dl> + +<p>Definition at line <a class="el" href="_colour_store_8cpp_source.html#l00018">18</a> of file <a class="el" href="_colour_store_8cpp_source.html">ColourStore.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a2d3688dbcdf5f9f9b82ef50709c2f286"></a><!-- doxytag: member="ColourStore::operator=" ref="a2d3688dbcdf5f9f9b82ef50709c2f286" args="(const ColourStore &rhs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_colour_store.html">ColourStore</a>& ColourStore::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_colour_store.html">ColourStore</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_colour_store.html#a3063a6fce81040a8b840a303b1e08829" title="Unimplemented copy constructor, prevents copying of ColourStore objects.">ColourStore(const ColourStore& ref)</a>; </dd></dl> + +</div> +</div> +<a class="anchor" id="ad3f729c8e9f6a94bacd85e6db47e2e82"></a><!-- doxytag: member="ColourStore::populateColours" ref="ad3f729c8e9f6a94bacd85e6db47e2e82" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ColourStore::populateColours </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Initialises all of the relevant colours. </p> + +<p>Definition at line <a class="el" href="_colour_store_8cpp_source.html#l00008">8</a> of file <a class="el" href="_colour_store_8cpp_source.html">ColourStore.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="acb64b1ffc465fa752a2f282da4c9afba"></a><!-- doxytag: member="ColourStore::_colours" ref="acb64b1ffc465fa752a2f282da4c9afba" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">map<<a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a>, ALLEGRO_COLOR> <a class="el" href="class_colour_store.html#acb64b1ffc465fa752a2f282da4c9afba">ColourStore::_colours</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="_colour_store_8h_source.html#l00047">47</a> of file <a class="el" href="_colour_store_8h_source.html">ColourStore.h</a>.</p> + +</div> +</div> +<a class="anchor" id="acadd8e6ed32fe6535252c94124df04ca"></a><!-- doxytag: member="ColourStore::_transparent" ref="acadd8e6ed32fe6535252c94124df04ca" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_COLOR <a class="el" href="class_colour_store.html#acadd8e6ed32fe6535252c94124df04ca">ColourStore::_transparent</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Initialised to have an alpha of 0, and returned when the colour of an unlisted image is requested. </p> + +<p>Definition at line <a class="el" href="_colour_store_8h_source.html#l00052">52</a> of file <a class="el" href="_colour_store_8h_source.html">ColourStore.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="_colour_store_8h_source.html">ColourStore.h</a></li> +<li>source/presentation/<a class="el" href="_colour_store_8cpp_source.html">ColourStore.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> |