summaryrefslogtreecommitdiff
path: root/docs/html/annotated.html
blob: 0f5f45f2a4c1a09e6a7efab20dcd96a44ae90e88 (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
<!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: Class List</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 class="current"><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="headertitle">
<div class="title">Class List</div>  </div>
</div>
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><table>
  <tr><td class="indexkey"><a class="el" href="class_allegro_drawing_init.html">AllegroDrawingInit</a></td><td class="indexvalue">Class ensures that Allegro's primitive and text drawing is installed and uninstalled when appropriate </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_allegro_init.html">AllegroInit</a></td><td class="indexvalue">Class ensures that Allegro is initialized and uninstalled when appropriate </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_allegro_keyboard_init.html">AllegroKeyboardInit</a></td><td class="indexvalue">Class ensures that Allegro's keyboard is installed and uninstalled when appropriate </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_bad_resolution.html">BadResolution</a></td><td class="indexvalue">Exception that is thrown if the <a class="el" href="class_config.html" title="Object for handling user settings loaded from a file.">Config</a> file requests a resolution that can not work </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_bitmap_store.html">BitmapStore</a></td><td class="indexvalue">Class for accessing images in ALLEGRO_BITMAP format and low level drawing </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_car.html">Car</a></td><td class="indexvalue"><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that moves through the maze and changes direction </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_checkpoint.html">Checkpoint</a></td><td class="indexvalue"><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 </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_collision_detector.html">CollisionDetector</a></td><td class="indexvalue">Object for handling collisions between GameObjects </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_colour_store.html">ColourStore</a></td><td class="indexvalue">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 </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_config.html">Config</a></td><td class="indexvalue">Object for handling user settings loaded from a file </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_destroyed_object_popup.html">DestroyedObjectPopup</a></td><td class="indexvalue">Object that appears on the screen for a short time when another object has been destroyed </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_enemy_car.html">EnemyCar</a></td><td class="indexvalue"><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that chases the player around the maze </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_file_open_error.html">FileOpenError</a></td><td class="indexvalue">An exception that is thrown if the file selected for opening does not exist </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_game.html">Game</a></td><td class="indexvalue">The object that controls the flow of the game, and the launch point of the game </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_game_object.html">GameObject</a></td><td class="indexvalue">Parent class for objects that are placed in the maze </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_game_panel.html">GamePanel</a></td><td class="indexvalue"><a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> to be drawn on the screen to draw the area where the game takes place </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_info_panel.html">InfoPanel</a></td><td class="indexvalue"><a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> to be drawn on the screen to give the player information </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_install_failure.html">InstallFailure</a></td><td class="indexvalue">Exception to be thrown if any component of Allegro fails to install at runtime </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_keyboard_handler.html">KeyboardHandler</a></td><td class="indexvalue">Class for handling keyboard related game inputs from the player </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_level_reader.html">LevelReader</a></td><td class="indexvalue">Reads the game objects from a text file and calls relevant constructors </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_limited_time_object.html">LimitedTimeObject</a></td><td class="indexvalue">Parent class for GameObjects that are created, exist for a given time, and are then destroyed </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_maze.html">Maze</a></td><td class="indexvalue">A rectangular 2D boolean array, representing where cars can drive and where they cannot </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_maze_math.html">MazeMath</a></td><td class="indexvalue">Class of static methods for common math functions that occur in the 2D maze setting </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_player_car.html">PlayerCar</a></td><td class="indexvalue">A <a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that is controlled by the player </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_rock.html">Rock</a></td><td class="indexvalue">A game object that acts as an obstacle to the player </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_screen.html">Screen</a></td><td class="indexvalue">Class for creating a window on the screen </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_screen_panel.html">ScreenPanel</a></td><td class="indexvalue">Parent class for panels that are drawn on the screen </td></tr>
  <tr><td class="indexkey"><a class="el" href="class_smokescreen.html">Smokescreen</a></td><td class="indexvalue"><a class="el" href="class_game_object.html" title="Parent class for objects that are placed in the maze.">GameObject</a> that causes the <a class="el" href="class_enemy_car.html" title="GameObject that chases the player around the maze.">EnemyCar</a> to be delayed if they crash into it </td></tr>
</table>
</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>