summaryrefslogtreecommitdiff
path: root/docs/html/class_limited_time_object.html
blob: 7c34b4b2e882372f891b0b8ab92b0dda6988a7ed (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
<!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: LimitedTimeObject 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="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">LimitedTimeObject Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="LimitedTimeObject" --><!-- doxytag: inherits="GameObject" -->
<p>Parent class for GameObjects that are created, exist for a given time, and are then destroyed.  
 <a href="class_limited_time_object.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_limited_time_object_8h_source.html">LimitedTimeObject.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for LimitedTimeObject:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_limited_time_object.png" usemap="#LimitedTimeObject_map" alt=""/>
  <map id="LimitedTimeObject_map" name="LimitedTimeObject_map">
<area href="class_game_object.html" title="Parent class for objects that are placed in the maze." alt="GameObject" shape="rect" coords="76,0,219,24"/>
<area href="class_destroyed_object_popup.html" title="Object that appears on the screen for a short time when another object has been destroyed." alt="DestroyedObjectPopup" shape="rect" coords="0,112,143,136"/>
<area href="class_smokescreen.html" title="GameObject that causes the EnemyCar to be delayed if they crash into it." alt="Smokescreen" shape="rect" coords="153,112,296,136"/>
</map>
 </div></div>

<p><a href="class_limited_time_object-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_limited_time_object.html#a0993f1696ed62abc3ef7856e4da7ae0e">LimitedTimeObject</a> (double x, double y, <a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a> image, int time)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="class_limited_time_object.html" title="Parent class for GameObjects that are created, exist for a given time, and are then destroyed...">LimitedTimeObject</a> with the given parameters.  <a href="#a0993f1696ed62abc3ef7856e4da7ae0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_limited_time_object.html#ad81a1c9aba4e21dfa40b9e6d881aba4e">update</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that should be run on every iteration of the gameloop.  <a href="#ad81a1c9aba4e21dfa40b9e6d881aba4e"></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">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_limited_time_object.html#a0b6a4bb0c76b637fba1db498ce084d3a">_remainingTime</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of times that update still needs to be run before the object is marked for destruction.  <a href="#a0b6a4bb0c76b637fba1db498ce084d3a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Parent class for GameObjects that are created, exist for a given time, and are then destroyed. </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="_limited_time_object_8h_source.html#l00014">14</a> of file <a class="el" href="_limited_time_object_8h_source.html">LimitedTimeObject.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0993f1696ed62abc3ef7856e4da7ae0e"></a><!-- doxytag: member="LimitedTimeObject::LimitedTimeObject" ref="a0993f1696ed62abc3ef7856e4da7ae0e" args="(double x, double y, BitmapStore::Image image, int time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">LimitedTimeObject::LimitedTimeObject </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_bitmap_store.html#af3bc66181673def9d0a590cd13c7e386">BitmapStore::Image</a>&#160;</td>
          <td class="paramname"><em>image</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>time</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_limited_time_object.html" title="Parent class for GameObjects that are created, exist for a given time, and are then destroyed...">LimitedTimeObject</a> with the given parameters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The x coordinate of the new object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The y coordinate of the new object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The image that is drawn to represent the object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The number of times that the update function is run before the object is destroyed. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_limited_time_object_8cpp_source.html#l00003">3</a> of file <a class="el" href="_limited_time_object_8cpp_source.html">LimitedTimeObject.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad81a1c9aba4e21dfa40b9e6d881aba4e"></a><!-- doxytag: member="LimitedTimeObject::update" ref="ad81a1c9aba4e21dfa40b9e6d881aba4e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LimitedTimeObject::update </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that should be run on every iteration of the gameloop. </p>
<p>The time remaining is decremented, and the object is marked for destruction when it reaches zero. </p>

<p>Definition at line <a class="el" href="_limited_time_object_8cpp_source.html#l00009">9</a> of file <a class="el" href="_limited_time_object_8cpp_source.html">LimitedTimeObject.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0b6a4bb0c76b637fba1db498ce084d3a"></a><!-- doxytag: member="LimitedTimeObject::_remainingTime" ref="a0b6a4bb0c76b637fba1db498ce084d3a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_limited_time_object.html#a0b6a4bb0c76b637fba1db498ce084d3a">LimitedTimeObject::_remainingTime</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The number of times that update still needs to be run before the object is marked for destruction. </p>
<p>For example, if the remaining time is 1, then the object is marked on the next update. </p>

<p>Definition at line <a class="el" href="_limited_time_object_8h_source.html#l00042">42</a> of file <a class="el" href="_limited_time_object_8h_source.html">LimitedTimeObject.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="_limited_time_object_8h_source.html">LimitedTimeObject.h</a></li>
<li>source/logic/<a class="el" href="_limited_time_object_8cpp_source.html">LimitedTimeObject.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>