diff options
Diffstat (limited to 'docs/html/class_checkpoint.html')
| -rw-r--r-- | docs/html/class_checkpoint.html | 301 |
1 files changed, 301 insertions, 0 deletions
diff --git a/docs/html/class_checkpoint.html b/docs/html/class_checkpoint.html new file mode 100644 index 0000000..0e3b2dc --- /dev/null +++ b/docs/html/class_checkpoint.html @@ -0,0 +1,301 @@ +<!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: Checkpoint 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="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pri-static-attribs">Static Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">Checkpoint Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="Checkpoint" --><!-- doxytag: inherits="GameObject" --> +<p><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that the player needs to pick up by driving over. + <a href="class_checkpoint.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_checkpoint_8h_source.html">Checkpoint.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for Checkpoint:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_checkpoint.png" usemap="#Checkpoint_map" alt=""/> + <map id="Checkpoint_map" name="Checkpoint_map"> +<area href="class_game_object.html" title="Parent class for objects that are placed in the maze." alt="GameObject" shape="rect" coords="0,0,81,24"/> +</map> + </div></div> + +<p><a href="class_checkpoint-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_checkpoint.html#a20c371a9e21ac0092b652a7d63f46f85">Checkpoint</a> (double x, double y)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a checkpoint at the given coordinates. <a href="#a20c371a9e21ac0092b652a7d63f46f85"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_checkpoint.html#ac94e0d92110fc4105bf5bf82ef4a5818">Checkpoint</a> (const <a class="el" href="class_checkpoint.html">Checkpoint</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constuctor, overwritten to include in the counting of Checkpoints. <a href="#ac94e0d92110fc4105bf5bf82ef4a5818"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_checkpoint.html#a7fff1a4a6a71c2150a969fbe40d01c34">~Checkpoint</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor, decreases the number of Checkpoints in existence. <a href="#a7fff1a4a6a71c2150a969fbe40d01c34"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_checkpoint.html#ad8f4b9da968e6b1f07080dc6f61282f7">collect</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to be called when a <a class="el" href="class_player_car.html" title="A GameObject that is controlled by the player.">PlayerCar</a> collects the <a class="el" href="class_checkpoint.html" title="GameObject that the player needs to pick up by driving over.">Checkpoint</a>. <a href="#ad8f4b9da968e6b1f07080dc6f61282f7"></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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_checkpoint.html#a872d8574b6f0a7960854fb1175e05f13">checkpointCount</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Function for accessing the number of checkpoints that currently exist. <a href="#a872d8574b6f0a7960854fb1175e05f13"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-static-attribs"></a> +Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_checkpoint.html#acb3ffc612d2a496b6b95752878818ff6">_checkpointCount</a> = 0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Count of the number of Checkpoints currently in existence. <a href="#acb3ffc612d2a496b6b95752878818ff6"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that the player needs to pick up by driving over. </p> +<p>The level is complete when all checkpoints have been collected.</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="_checkpoint_8h_source.html#l00015">15</a> of file <a class="el" href="_checkpoint_8h_source.html">Checkpoint.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a20c371a9e21ac0092b652a7d63f46f85"></a><!-- doxytag: member="Checkpoint::Checkpoint" ref="a20c371a9e21ac0092b652a7d63f46f85" args="(double x, double y)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Checkpoint::Checkpoint </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>x</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>y</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Creates a checkpoint at the given coordinates. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>x coordinate of Checkpoint's position. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>y coordinate of Checkpoint's position. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_checkpoint_8cpp_source.html#l00005">5</a> of file <a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ac94e0d92110fc4105bf5bf82ef4a5818"></a><!-- doxytag: member="Checkpoint::Checkpoint" ref="ac94e0d92110fc4105bf5bf82ef4a5818" args="(const Checkpoint &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Checkpoint::Checkpoint </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_checkpoint.html">Checkpoint</a> & </td> + <td class="paramname"><em>ref</em></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Copy constuctor, overwritten to include in the counting of Checkpoints. </p> + +<p>Definition at line <a class="el" href="_checkpoint_8cpp_source.html#l00011">11</a> of file <a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a7fff1a4a6a71c2150a969fbe40d01c34"></a><!-- doxytag: member="Checkpoint::~Checkpoint" ref="a7fff1a4a6a71c2150a969fbe40d01c34" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Checkpoint::~Checkpoint </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destructor, decreases the number of Checkpoints in existence. </p> + +<p>Definition at line <a class="el" href="_checkpoint_8cpp_source.html#l00017">17</a> of file <a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a872d8574b6f0a7960854fb1175e05f13"></a><!-- doxytag: member="Checkpoint::checkpointCount" ref="a872d8574b6f0a7960854fb1175e05f13" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Checkpoint::checkpointCount </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Function for accessing the number of checkpoints that currently exist. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>The number of checkpoints that currently exist. </dd></dl> + +<p>Definition at line <a class="el" href="_checkpoint_8cpp_source.html#l00022">22</a> of file <a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ad8f4b9da968e6b1f07080dc6f61282f7"></a><!-- doxytag: member="Checkpoint::collect" ref="ad8f4b9da968e6b1f07080dc6f61282f7" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Checkpoint::collect </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Function to be called when a <a class="el" href="class_player_car.html" title="A GameObject that is controlled by the player.">PlayerCar</a> collects the <a class="el" href="class_checkpoint.html" title="GameObject that the player needs to pick up by driving over.">Checkpoint</a>. </p> + +<p>Definition at line <a class="el" href="_checkpoint_8cpp_source.html#l00027">27</a> of file <a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.cpp</a>.</p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="acb3ffc612d2a496b6b95752878818ff6"></a><!-- doxytag: member="Checkpoint::_checkpointCount" ref="acb3ffc612d2a496b6b95752878818ff6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_checkpoint.html#acb3ffc612d2a496b6b95752878818ff6">Checkpoint::_checkpointCount</a> = 0<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Count of the number of Checkpoints currently in existence. </p> + +<p>Definition at line <a class="el" href="_checkpoint_8h_source.html#l00050">50</a> of file <a class="el" href="_checkpoint_8h_source.html">Checkpoint.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="_checkpoint_8h_source.html">Checkpoint.h</a></li> +<li>source/logic/<a class="el" href="_checkpoint_8cpp_source.html">Checkpoint.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> |