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 Illumination Module: OgrePhotonMapRenderingRun 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-NO --> |
---|
8 | <div class="tabs"> |
---|
9 | <ul> |
---|
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
11 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
---|
12 | <li id="current"><a href="annotated.html"><span>Classes</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>OgrePhotonMapRenderingRun Class Reference</h1><!-- doxytag: class="OgrePhotonMapRenderingRun" --><!-- doxytag: inherits="OgreRenderingRun,PhotonMapRenderingRun" --><a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment. |
---|
21 | <a href="#_details">More...</a> |
---|
22 | <p> |
---|
23 | <p>Inheritance diagram for OgrePhotonMapRenderingRun: |
---|
24 | <p><center><img src="class_ogre_photon_map_rendering_run.png" usemap="#OgrePhotonMapRenderingRun_map" border="0" alt=""></center> |
---|
25 | <map name="OgrePhotonMapRenderingRun_map"> |
---|
26 | <area href="class_ogre_rendering_run.html" alt="OgreRenderingRun" shape="rect" coords="0,56,185,80"> |
---|
27 | <area href="class_photon_map_rendering_run.html" alt="PhotonMapRenderingRun" shape="rect" coords="195,56,380,80"> |
---|
28 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,185,24"> |
---|
29 | <area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="195,0,380,24"> |
---|
30 | </map> |
---|
31 | <a href="class_ogre_photon_map_rendering_run-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
32 | <tr><td></td></tr> |
---|
33 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#2802880178c6e55a2272a81f6d75a23e">OgrePhotonMapRenderingRun</a> (<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *<a class="el" href="class_ogre_photon_map_rendering_run.html#9ee61eae1f8dfe9c716e74efbe15b871">sharedRuns</a>, String <a class="el" href="class_ogre_photon_map_rendering_run.html#579bc84237973a296e2277fa097bb3c8">name</a>, unsigned long <a class="el" href="class_rendering_run.html#cb0a9e0eec1217206a14f7d387487443">startFrame</a>, unsigned long <a class="el" href="class_rendering_run.html#7196160c7f2effe7235b710a12f1b262">updateInterval</a>, unsigned int <a class="el" href="class_ogre_photon_map_rendering_run.html#d7e3a3248b1d55bbfc05a84dbd90d767">resolution</a>, String <a class="el" href="class_ogre_photon_map_rendering_run.html#2eed541f9c4bcc2a56dcac4d12c61a71">materialName</a>, bool <a class="el" href="class_ogre_photon_map_rendering_run.html#2143e134e633ab21ad6c6da0f0a72af7">useDistance</a>)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#2802880178c6e55a2272a81f6d75a23e"></a><br></td></tr> |
---|
37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ac21cab29621cb5e2bc86d550dd0aa4"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::getPhotonMapTextureName" ref="3ac21cab29621cb5e2bc86d550dd0aa4" args="()" --> |
---|
38 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#3ac21cab29621cb5e2bc86d550dd0aa4">getPhotonMapTextureName</a> ()</td></tr> |
---|
39 | |
---|
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns the name of the resulting photon hit map <br></td></tr> |
---|
41 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#732fe4c86f8d881af9d63b3b37f88ed8">refreshLight</a> ()</td></tr> |
---|
42 | |
---|
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Refreshes light camera matrices, called in each update. <a href="#732fe4c86f8d881af9d63b3b37f88ed8"></a><br></td></tr> |
---|
44 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
45 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#963a3e60a34ce8cec8a542d2f22db10a">updateFrame</a> (unsigned long frameNum)</td></tr> |
---|
46 | |
---|
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This function does the actual update in a frame. <a href="#963a3e60a34ce8cec8a542d2f22db10a"></a><br></td></tr> |
---|
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa4c08223730cca44881c2ac12241711"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::createPhotonMap" ref="aa4c08223730cca44881c2ac12241711" args="()" --> |
---|
49 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#aa4c08223730cca44881c2ac12241711">createPhotonMap</a> ()</td></tr> |
---|
50 | |
---|
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a photon hit map. <br></td></tr> |
---|
52 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
53 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2eed541f9c4bcc2a56dcac4d12c61a71"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::materialName" ref="2eed541f9c4bcc2a56dcac4d12c61a71" args="" --> |
---|
54 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#2eed541f9c4bcc2a56dcac4d12c61a71">materialName</a></td></tr> |
---|
55 | |
---|
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the material should be used when rendering the choton hit map <br></td></tr> |
---|
57 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="991dece107edda232e011051e110cde0"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::light" ref="991dece107edda232e011051e110cde0" args="" --> |
---|
58 | Light * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#991dece107edda232e011051e110cde0">light</a></td></tr> |
---|
59 | |
---|
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the nearest light source from the caster object <br></td></tr> |
---|
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35905e520b388a678f58693f51b8c373"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::photonMapCamera" ref="35905e520b388a678f58693f51b8c373" args="" --> |
---|
62 | Camera * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#35905e520b388a678f58693f51b8c373">photonMapCamera</a></td></tr> |
---|
63 | |
---|
64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the created photon hit map texture <br></td></tr> |
---|
65 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2143e134e633ab21ad6c6da0f0a72af7"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::useDistance" ref="2143e134e633ab21ad6c6da0f0a72af7" args="" --> |
---|
66 | bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#2143e134e633ab21ad6c6da0f0a72af7">useDistance</a></td></tr> |
---|
67 | |
---|
68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">tells if a distance cubemap impostor should be used in photon hit calculation (recommended) <br></td></tr> |
---|
69 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ee61eae1f8dfe9c716e74efbe15b871"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::sharedRuns" ref="9ee61eae1f8dfe9c716e74efbe15b871" args="" --> |
---|
70 | <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#9ee61eae1f8dfe9c716e74efbe15b871">sharedRuns</a></td></tr> |
---|
71 | |
---|
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">a pointer to the <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> this run belongs to <br></td></tr> |
---|
73 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="579bc84237973a296e2277fa097bb3c8"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::name" ref="579bc84237973a296e2277fa097bb3c8" args="" --> |
---|
74 | String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#579bc84237973a296e2277fa097bb3c8">name</a></td></tr> |
---|
75 | |
---|
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the photonmap texture that was created by this run <br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c1fc9ddfca392fd54b95291fdf9c995"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::photonMapTexture" ref="9c1fc9ddfca392fd54b95291fdf9c995" args="" --> |
---|
78 | Texture * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#9c1fc9ddfca392fd54b95291fdf9c995">photonMapTexture</a></td></tr> |
---|
79 | |
---|
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">a pointer to the photonmap texture that was created by this run <br></td></tr> |
---|
81 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7e3a3248b1d55bbfc05a84dbd90d767"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::resolution" ref="d7e3a3248b1d55bbfc05a84dbd90d767" args="" --> |
---|
82 | unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_photon_map_rendering_run.html#d7e3a3248b1d55bbfc05a84dbd90d767">resolution</a></td></tr> |
---|
83 | |
---|
84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">the resolution of the photonmap texture that was created by this run <br></td></tr> |
---|
85 | </table> |
---|
86 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
87 | <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment. |
---|
88 | <p> |
---|
89 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
90 | <a class="anchor" name="2802880178c6e55a2272a81f6d75a23e"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::OgrePhotonMapRenderingRun" ref="2802880178c6e55a2272a81f6d75a23e" args="(OgreSharedRuns *sharedRuns, String name, unsigned long startFrame, unsigned long updateInterval, unsigned int resolution, String materialName, bool useDistance)" --><p> |
---|
91 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
92 | <tr> |
---|
93 | <td class="mdRow"> |
---|
94 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
95 | <tr> |
---|
96 | <td class="md" nowrap valign="top">OgrePhotonMapRenderingRun::OgrePhotonMapRenderingRun </td> |
---|
97 | <td class="md" valign="top">( </td> |
---|
98 | <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> * </td> |
---|
99 | <td class="mdname" nowrap> <em>sharedRuns</em>, </td> |
---|
100 | </tr> |
---|
101 | <tr> |
---|
102 | <td class="md" nowrap align="right"></td> |
---|
103 | <td class="md"></td> |
---|
104 | <td class="md" nowrap>String </td> |
---|
105 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
106 | </tr> |
---|
107 | <tr> |
---|
108 | <td class="md" nowrap align="right"></td> |
---|
109 | <td class="md"></td> |
---|
110 | <td class="md" nowrap>unsigned long </td> |
---|
111 | <td class="mdname" nowrap> <em>startFrame</em>, </td> |
---|
112 | </tr> |
---|
113 | <tr> |
---|
114 | <td class="md" nowrap align="right"></td> |
---|
115 | <td class="md"></td> |
---|
116 | <td class="md" nowrap>unsigned long </td> |
---|
117 | <td class="mdname" nowrap> <em>updateInterval</em>, </td> |
---|
118 | </tr> |
---|
119 | <tr> |
---|
120 | <td class="md" nowrap align="right"></td> |
---|
121 | <td class="md"></td> |
---|
122 | <td class="md" nowrap>unsigned int </td> |
---|
123 | <td class="mdname" nowrap> <em>resolution</em>, </td> |
---|
124 | </tr> |
---|
125 | <tr> |
---|
126 | <td class="md" nowrap align="right"></td> |
---|
127 | <td class="md"></td> |
---|
128 | <td class="md" nowrap>String </td> |
---|
129 | <td class="mdname" nowrap> <em>materialName</em>, </td> |
---|
130 | </tr> |
---|
131 | <tr> |
---|
132 | <td class="md" nowrap align="right"></td> |
---|
133 | <td class="md"></td> |
---|
134 | <td class="md" nowrap>bool </td> |
---|
135 | <td class="mdname" nowrap> <em>useDistance</em></td> |
---|
136 | </tr> |
---|
137 | <tr> |
---|
138 | <td class="md"></td> |
---|
139 | <td class="md">) </td> |
---|
140 | <td class="md" colspan="2"></td> |
---|
141 | </tr> |
---|
142 | </table> |
---|
143 | </td> |
---|
144 | </tr> |
---|
145 | </table> |
---|
146 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
147 | <tr> |
---|
148 | <td> |
---|
149 | |
---|
150 | </td> |
---|
151 | <td> |
---|
152 | |
---|
153 | <p> |
---|
154 | Constructor. |
---|
155 | <p> |
---|
156 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
157 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
158 | <tr><td valign="top"></td><td valign="top"><em>sharedRuns</em> </td><td>a pointer to the <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> this run belongs to </td></tr> |
---|
159 | <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the texture to be created </td></tr> |
---|
160 | <tr><td valign="top"></td><td valign="top"><em>startFrame</em> </td><td>adds an offset to the current frame number to help evenly distribute updates between frames </td></tr> |
---|
161 | <tr><td valign="top"></td><td valign="top"><em>updateInterval</em> </td><td>update frequency </td></tr> |
---|
162 | <tr><td valign="top"></td><td valign="top"><em>resolution</em> </td><td>color cubemap resolution </td></tr> |
---|
163 | <tr><td valign="top"></td><td valign="top"><em>materialName</em> </td><td>the name of the material should be used when rendering the choton hit map </td></tr> |
---|
164 | <tr><td valign="top"></td><td valign="top"><em>useDistance</em> </td><td>tells if a distance cubemap impostor should be used in photon hit calculation (recommended) </td></tr> |
---|
165 | </table> |
---|
166 | </dl> |
---|
167 | </td> |
---|
168 | </tr> |
---|
169 | </table> |
---|
170 | <hr><h2>Member Function Documentation</h2> |
---|
171 | <a class="anchor" name="732fe4c86f8d881af9d63b3b37f88ed8"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::refreshLight" ref="732fe4c86f8d881af9d63b3b37f88ed8" args="()" --><p> |
---|
172 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
173 | <tr> |
---|
174 | <td class="mdRow"> |
---|
175 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
176 | <tr> |
---|
177 | <td class="md" nowrap valign="top">void OgrePhotonMapRenderingRun::refreshLight </td> |
---|
178 | <td class="md" valign="top">( </td> |
---|
179 | <td class="mdname1" valign="top" nowrap> </td> |
---|
180 | <td class="md" valign="top"> ) </td> |
---|
181 | <td class="md" nowrap></td> |
---|
182 | </tr> |
---|
183 | </table> |
---|
184 | </td> |
---|
185 | </tr> |
---|
186 | </table> |
---|
187 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
188 | <tr> |
---|
189 | <td> |
---|
190 | |
---|
191 | </td> |
---|
192 | <td> |
---|
193 | |
---|
194 | <p> |
---|
195 | Refreshes light camera matrices, called in each update. |
---|
196 | <p> |
---|
197 | TODO: search nearest light, set light params </td> |
---|
198 | </tr> |
---|
199 | </table> |
---|
200 | <a class="anchor" name="963a3e60a34ce8cec8a542d2f22db10a"></a><!-- doxytag: member="OgrePhotonMapRenderingRun::updateFrame" ref="963a3e60a34ce8cec8a542d2f22db10a" args="(unsigned long frameNum)" --><p> |
---|
201 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
202 | <tr> |
---|
203 | <td class="mdRow"> |
---|
204 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
205 | <tr> |
---|
206 | <td class="md" nowrap valign="top">void OgrePhotonMapRenderingRun::updateFrame </td> |
---|
207 | <td class="md" valign="top">( </td> |
---|
208 | <td class="md" nowrap valign="top">unsigned long </td> |
---|
209 | <td class="mdname1" valign="top" nowrap> <em>frameNum</em> </td> |
---|
210 | <td class="md" valign="top"> ) </td> |
---|
211 | <td class="md" nowrap><code> [protected, virtual]</code></td> |
---|
212 | </tr> |
---|
213 | </table> |
---|
214 | </td> |
---|
215 | </tr> |
---|
216 | </table> |
---|
217 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
218 | <tr> |
---|
219 | <td> |
---|
220 | |
---|
221 | </td> |
---|
222 | <td> |
---|
223 | |
---|
224 | <p> |
---|
225 | This function does the actual update in a frame. |
---|
226 | <p> |
---|
227 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
228 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
229 | <tr><td valign="top"></td><td valign="top"><em>frameNum</em> </td><td>current frame number </td></tr> |
---|
230 | </table> |
---|
231 | </dl> |
---|
232 | |
---|
233 | <p> |
---|
234 | Implements <a class="el" href="class_photon_map_rendering_run.html#bf26e2ba9976a6260ba64f0f8b957afb">PhotonMapRenderingRun</a>. </td> |
---|
235 | </tr> |
---|
236 | </table> |
---|
237 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
238 | <li>OgrePhotonMapRenderingRun.h<li>OgrePhotonMapRenderingRun.cpp</ul> |
---|
239 | <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:41 2006 for GameTools Illumination Module by |
---|
240 | <a href="http://www.doxygen.org/index.html"> |
---|
241 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
242 | </body> |
---|
243 | </html> |
---|