[2221] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
---|
| 3 | <title>gametools-rain: RainFrameListener Class Reference</title> |
---|
| 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
| 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
| 6 | </head><body> |
---|
| 7 | <!-- Generated by Doxygen 1.4.6 --> |
---|
| 8 | <div class="tabs"> |
---|
| 9 | <ul> |
---|
| 10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
| 11 | <li id="current"><a href="annotated.html"><span>Classes</span></a></li> |
---|
| 12 | <li><a href="files.html"><span>Files</span></a></li> |
---|
| 13 | </ul></div> |
---|
| 14 | <div class="tabs"> |
---|
| 15 | <ul> |
---|
| 16 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
| 17 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 18 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 19 | </ul></div> |
---|
| 20 | <h1>RainFrameListener Class Reference</h1><!-- doxytag: class="RainFrameListener" --><code>#include <<a class="el" href="RainFrameListener_8h-source.html">RainFrameListener.h</a>></code> |
---|
| 21 | <p> |
---|
| 22 | <a href="classRainFrameListener-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 23 | <a class="el" href="classRainFrameListener.html">RainFrameListener</a> class processes keyboard and mouse events, and performs all computations needed for each frame |
---|
| 24 | <p> |
---|
| 25 | <table border="0" cellpadding="0" cellspacing="0"> |
---|
| 26 | <tr><td></td></tr> |
---|
| 27 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 28 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRainFrameListener.html#7ffa91734beebaa997cb27e814f572fe">RainFrameListener</a> (RenderWindow *win, Camera *cam, SceneNode *ViewNode, SceneNode *CameraNode, <a class="el" href="classCloseDropsParticles.html">CloseDropsParticles</a> *syst)</td></tr> |
---|
| 29 | |
---|
| 30 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRainFrameListener.html#11baf48c2d3f2880dfc1a6451df01545">frameStarted</a> (const FrameEvent &evt)</td></tr> |
---|
| 31 | |
---|
| 32 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRainFrameListener.html#2b35f43facecdc5efd19060f234289c1">frameEnded</a> (const FrameEvent &evt)</td></tr> |
---|
| 33 | |
---|
| 34 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRainFrameListener.html#fb74925a5b7856838701cdeed0523924">updateStats</a> (void)</td></tr> |
---|
| 36 | |
---|
| 37 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRainFrameListener.html#ea5fb5d71d65f6aed207feb5a3db7b09">displayMessage</a> (String text)</td></tr> |
---|
| 38 | |
---|
| 39 | </table> |
---|
| 40 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 41 | <a class="anchor" name="7ffa91734beebaa997cb27e814f572fe"></a><!-- doxytag: member="RainFrameListener::RainFrameListener" ref="7ffa91734beebaa997cb27e814f572fe" args="(RenderWindow *win, Camera *cam, SceneNode *ViewNode, SceneNode *CameraNode, CloseDropsParticles *syst)" --><p> |
---|
| 42 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 43 | <tr> |
---|
| 44 | <td class="mdRow"> |
---|
| 45 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 46 | <tr> |
---|
| 47 | <td class="md" nowrap valign="top">RainFrameListener::RainFrameListener </td> |
---|
| 48 | <td class="md" valign="top">( </td> |
---|
| 49 | <td class="md" nowrap valign="top">RenderWindow * </td> |
---|
| 50 | <td class="mdname" nowrap> <em>win</em>, </td> |
---|
| 51 | </tr> |
---|
| 52 | <tr> |
---|
| 53 | <td class="md" nowrap align="right"></td> |
---|
| 54 | <td class="md"></td> |
---|
| 55 | <td class="md" nowrap>Camera * </td> |
---|
| 56 | <td class="mdname" nowrap> <em>cam</em>, </td> |
---|
| 57 | </tr> |
---|
| 58 | <tr> |
---|
| 59 | <td class="md" nowrap align="right"></td> |
---|
| 60 | <td class="md"></td> |
---|
| 61 | <td class="md" nowrap>SceneNode * </td> |
---|
| 62 | <td class="mdname" nowrap> <em>ViewNode</em>, </td> |
---|
| 63 | </tr> |
---|
| 64 | <tr> |
---|
| 65 | <td class="md" nowrap align="right"></td> |
---|
| 66 | <td class="md"></td> |
---|
| 67 | <td class="md" nowrap>SceneNode * </td> |
---|
| 68 | <td class="mdname" nowrap> <em>CameraNode</em>, </td> |
---|
| 69 | </tr> |
---|
| 70 | <tr> |
---|
| 71 | <td class="md" nowrap align="right"></td> |
---|
| 72 | <td class="md"></td> |
---|
| 73 | <td class="md" nowrap><a class="el" href="classCloseDropsParticles.html">CloseDropsParticles</a> * </td> |
---|
| 74 | <td class="mdname" nowrap> <em>syst</em></td> |
---|
| 75 | </tr> |
---|
| 76 | <tr> |
---|
| 77 | <td class="md"></td> |
---|
| 78 | <td class="md">) </td> |
---|
| 79 | <td class="md" colspan="2"></td> |
---|
| 80 | </tr> |
---|
| 81 | </table> |
---|
| 82 | </td> |
---|
| 83 | </tr> |
---|
| 84 | </table> |
---|
| 85 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 86 | <tr> |
---|
| 87 | <td> |
---|
| 88 | |
---|
| 89 | </td> |
---|
| 90 | <td> |
---|
| 91 | |
---|
| 92 | <p> |
---|
| 93 | standard constructor<ul> |
---|
| 94 | <li>the renderWindow and camera are needed for reglar initialization of the frame listener</li><li>view node will only be translated (position of the observer and particle system)</li><li>cameranode, which must be attached to viewNode, will be rotated to look in any direction</li><li>syst is the particle system itself, which will need to be updated with user input, time since last frame... </li></ul> |
---|
| 95 | </td> |
---|
| 96 | </tr> |
---|
| 97 | </table> |
---|
| 98 | <hr><h2>Member Function Documentation</h2> |
---|
| 99 | <a class="anchor" name="ea5fb5d71d65f6aed207feb5a3db7b09"></a><!-- doxytag: member="RainFrameListener::displayMessage" ref="ea5fb5d71d65f6aed207feb5a3db7b09" args="(String text)" --><p> |
---|
| 100 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 101 | <tr> |
---|
| 102 | <td class="mdRow"> |
---|
| 103 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 104 | <tr> |
---|
| 105 | <td class="md" nowrap valign="top">void RainFrameListener::displayMessage </td> |
---|
| 106 | <td class="md" valign="top">( </td> |
---|
| 107 | <td class="md" nowrap valign="top">String </td> |
---|
| 108 | <td class="mdname1" valign="top" nowrap> <em>text</em> </td> |
---|
| 109 | <td class="md" valign="top"> ) </td> |
---|
| 110 | <td class="md" nowrap><code> [protected]</code></td> |
---|
| 111 | </tr> |
---|
| 112 | </table> |
---|
| 113 | </td> |
---|
| 114 | </tr> |
---|
| 115 | </table> |
---|
| 116 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 117 | <tr> |
---|
| 118 | <td> |
---|
| 119 | |
---|
| 120 | </td> |
---|
| 121 | <td> |
---|
| 122 | |
---|
| 123 | <p> |
---|
| 124 | function to set a specific text on the stats overlay </td> |
---|
| 125 | </tr> |
---|
| 126 | </table> |
---|
| 127 | <a class="anchor" name="2b35f43facecdc5efd19060f234289c1"></a><!-- doxytag: member="RainFrameListener::frameEnded" ref="2b35f43facecdc5efd19060f234289c1" args="(const FrameEvent &evt)" --><p> |
---|
| 128 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 129 | <tr> |
---|
| 130 | <td class="mdRow"> |
---|
| 131 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 132 | <tr> |
---|
| 133 | <td class="md" nowrap valign="top">bool RainFrameListener::frameEnded </td> |
---|
| 134 | <td class="md" valign="top">( </td> |
---|
| 135 | <td class="md" nowrap valign="top">const FrameEvent & </td> |
---|
| 136 | <td class="mdname1" valign="top" nowrap> <em>evt</em> </td> |
---|
| 137 | <td class="md" valign="top"> ) </td> |
---|
| 138 | <td class="md" nowrap></td> |
---|
| 139 | </tr> |
---|
| 140 | </table> |
---|
| 141 | </td> |
---|
| 142 | </tr> |
---|
| 143 | </table> |
---|
| 144 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 145 | <tr> |
---|
| 146 | <td> |
---|
| 147 | |
---|
| 148 | </td> |
---|
| 149 | <td> |
---|
| 150 | |
---|
| 151 | <p> |
---|
| 152 | this function is called just after a frame gets rendered </td> |
---|
| 153 | </tr> |
---|
| 154 | </table> |
---|
| 155 | <a class="anchor" name="11baf48c2d3f2880dfc1a6451df01545"></a><!-- doxytag: member="RainFrameListener::frameStarted" ref="11baf48c2d3f2880dfc1a6451df01545" args="(const FrameEvent &evt)" --><p> |
---|
| 156 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 157 | <tr> |
---|
| 158 | <td class="mdRow"> |
---|
| 159 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 160 | <tr> |
---|
| 161 | <td class="md" nowrap valign="top">bool RainFrameListener::frameStarted </td> |
---|
| 162 | <td class="md" valign="top">( </td> |
---|
| 163 | <td class="md" nowrap valign="top">const FrameEvent & </td> |
---|
| 164 | <td class="mdname1" valign="top" nowrap> <em>evt</em> </td> |
---|
| 165 | <td class="md" valign="top"> ) </td> |
---|
| 166 | <td class="md" nowrap></td> |
---|
| 167 | </tr> |
---|
| 168 | </table> |
---|
| 169 | </td> |
---|
| 170 | </tr> |
---|
| 171 | </table> |
---|
| 172 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 173 | <tr> |
---|
| 174 | <td> |
---|
| 175 | |
---|
| 176 | </td> |
---|
| 177 | <td> |
---|
| 178 | |
---|
| 179 | <p> |
---|
| 180 | this function is called just before a frame gets rendered Contains reactions to user input (keyboard, mouse), and calls for particle system update </td> |
---|
| 181 | </tr> |
---|
| 182 | </table> |
---|
| 183 | <a class="anchor" name="fb74925a5b7856838701cdeed0523924"></a><!-- doxytag: member="RainFrameListener::updateStats" ref="fb74925a5b7856838701cdeed0523924" args="(void)" --><p> |
---|
| 184 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 185 | <tr> |
---|
| 186 | <td class="mdRow"> |
---|
| 187 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 188 | <tr> |
---|
| 189 | <td class="md" nowrap valign="top">void RainFrameListener::updateStats </td> |
---|
| 190 | <td class="md" valign="top">( </td> |
---|
| 191 | <td class="md" nowrap valign="top">void </td> |
---|
| 192 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 193 | <td class="md" valign="top"> ) </td> |
---|
| 194 | <td class="md" nowrap><code> [protected]</code></td> |
---|
| 195 | </tr> |
---|
| 196 | </table> |
---|
| 197 | </td> |
---|
| 198 | </tr> |
---|
| 199 | </table> |
---|
| 200 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 201 | <tr> |
---|
| 202 | <td> |
---|
| 203 | |
---|
| 204 | </td> |
---|
| 205 | <td> |
---|
| 206 | |
---|
| 207 | <p> |
---|
| 208 | function to update the text of the overlay with fps stats </td> |
---|
| 209 | </tr> |
---|
| 210 | </table> |
---|
| 211 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
| 212 | <li><a class="el" href="RainFrameListener_8h-source.html">RainFrameListener.h</a><li>RainFrameListener.cpp</ul> |
---|
| 213 | <hr size="1"><address style="align: right;"><small>Generated on Wed May 17 16:55:30 2006 for gametools-rain by |
---|
| 214 | <a href="http://www.doxygen.org/index.html"> |
---|
| 215 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
---|
| 216 | </body> |
---|
| 217 | </html> |
---|