source: GTP/trunk/Lib/Illum/IllumModule/doc/html/class_ogre_caustic_cube_map_rendering_run.html @ 894

Revision 894, 18.5 KB checked in by szirmay, 18 years ago (diff)
Line 
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: OgreCausticCubeMapRenderingRun 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&nbsp;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&nbsp;List</span></a></li>
17    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19  </ul></div>
20<h1>OgreCausticCubeMapRenderingRun Class Reference</h1><!-- doxytag: class="OgreCausticCubeMapRenderingRun" --><!-- doxytag: inherits="OgreRenderingRun,CausticCubeMapRenderingRun" --><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 OgreCausticCubeMapRenderingRun:
24<p><center><img src="class_ogre_caustic_cube_map_rendering_run.png" usemap="#OgreCausticCubeMapRenderingRun_map" border="0" alt=""></center>
25<map name="OgreCausticCubeMapRenderingRun_map">
26<area href="class_ogre_rendering_run.html" alt="OgreRenderingRun" shape="rect" coords="0,56,218,80">
27<area href="class_caustic_cube_map_rendering_run.html" alt="CausticCubeMapRenderingRun" shape="rect" coords="228,56,446,80">
28<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,218,24">
29<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="228,0,446,24">
30</map>
31<a href="class_ogre_caustic_cube_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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#8a0f74d0cbb4653435032a1890b874c4">OgreCausticCubeMapRenderingRun</a> (<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *<a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#84f148f5925772bf158958a074f6c5ee">sharedRuns</a>, String <a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#49047ddb603142e4078e6aaf580982cf">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_caustic_cube_map_rendering_run.html#24652b7f9f253e79a2d7361021ae7a5d">resolution</a>, String <a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#0002de4a1e4853f2a13c21f54877dfdb">materialName</a>, unsigned char <a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#b752cc9e5e89dd3916d0240152ad9138">photonMapTexId</a>, bool <a class="el" href="class_caustic_cube_map_rendering_run.html#1e07ccec65f3d7ec480aca0c0065316a">updateAllFace</a>)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#8a0f74d0cbb4653435032a1890b874c4"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54c82d2df5a161fae11c1ab616224036"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::getCausticCubeMapTextureName" ref="54c82d2df5a161fae11c1ab616224036" args="()" -->
38String &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#54c82d2df5a161fae11c1ab616224036">getCausticCubeMapTextureName</a> ()</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the name of the resulting caustic cubemap texture <br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#e6dfda3ace6f42e1804a960e88f518e7">photonMapChanged</a> (<a class="el" href="class_rendering_run.html">RenderingRun</a> *run)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called if the changed run is a <a class="el" href="class_photon_map_rendering_run.html">PhotonMapRenderingRun</a>.  <a href="#e6dfda3ace6f42e1804a960e88f518e7"></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"><a class="anchor" name="2d88070be561771b55a69bb89819d94c"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::createCausticCubeMap" ref="2d88070be561771b55a69bb89819d94c" args="()" -->
46void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#2d88070be561771b55a69bb89819d94c">createCausticCubeMap</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a cubemap texture used for the caustic-cubemap. <br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#e84bced29136a12e3f32ac3c3157217d">updateCubeFace</a> (int facenum)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates one face of the cubemap.  <a href="#e84bced29136a12e3f32ac3c3157217d"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#3af399eb995301b2646a3756880ee1fb">faceNeedsUpdate</a> (int facenum)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if a cubemap face needs to be updated.  <a href="#3af399eb995301b2646a3756880ee1fb"></a><br></td></tr>
55<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b752cc9e5e89dd3916d0240152ad9138"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::photonMapTexId" ref="b752cc9e5e89dd3916d0240152ad9138" args="" -->
57unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#b752cc9e5e89dd3916d0240152ad9138">photonMapTexId</a></td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the texture unit state id of the caustic map generation material where the photonhit map should be bound to <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84f148f5925772bf158958a074f6c5ee"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::sharedRuns" ref="84f148f5925772bf158958a074f6c5ee" args="" -->
61<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#84f148f5925772bf158958a074f6c5ee">sharedRuns</a></td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</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>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49047ddb603142e4078e6aaf580982cf"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::name" ref="49047ddb603142e4078e6aaf580982cf" args="" -->
65String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#49047ddb603142e4078e6aaf580982cf">name</a></td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the name of the cubemap texture that was created by this run <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f3dba91179f265575be69196a49d35d7"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::causticCubemapTexture" ref="f3dba91179f265575be69196a49d35d7" args="" -->
69Texture *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#f3dba91179f265575be69196a49d35d7">causticCubemapTexture</a></td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">a pointer to the cubemap texture that was created by this run <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0002de4a1e4853f2a13c21f54877dfdb"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::materialName" ref="0002de4a1e4853f2a13c21f54877dfdb" args="" -->
73String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_caustic_cube_map_rendering_run.html#0002de4a1e4853f2a13c21f54877dfdb">materialName</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the name of the material that should be used when rendering the caustic cubemap <br></td></tr>
76</table>
77<hr><a name="_details"></a><h2>Detailed Description</h2>
78<a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment.
79<p>
80<hr><h2>Constructor &amp; Destructor Documentation</h2>
81<a class="anchor" name="8a0f74d0cbb4653435032a1890b874c4"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::OgreCausticCubeMapRenderingRun" ref="8a0f74d0cbb4653435032a1890b874c4" args="(OgreSharedRuns *sharedRuns, String name, unsigned long startFrame, unsigned long updateInterval, unsigned int resolution, String materialName, unsigned char photonMapTexId, bool updateAllFace)" --><p>
82<table class="mdTable" cellpadding="2" cellspacing="0">
83  <tr>
84    <td class="mdRow">
85      <table cellpadding="0" cellspacing="0" border="0">
86        <tr>
87          <td class="md" nowrap valign="top">OgreCausticCubeMapRenderingRun::OgreCausticCubeMapRenderingRun           </td>
88          <td class="md" valign="top">(&nbsp;</td>
89          <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *&nbsp;</td>
90          <td class="mdname" nowrap> <em>sharedRuns</em>, </td>
91        </tr>
92        <tr>
93          <td class="md" nowrap align="right"></td>
94          <td class="md"></td>
95          <td class="md" nowrap>String&nbsp;</td>
96          <td class="mdname" nowrap> <em>name</em>, </td>
97        </tr>
98        <tr>
99          <td class="md" nowrap align="right"></td>
100          <td class="md"></td>
101          <td class="md" nowrap>unsigned long&nbsp;</td>
102          <td class="mdname" nowrap> <em>startFrame</em>, </td>
103        </tr>
104        <tr>
105          <td class="md" nowrap align="right"></td>
106          <td class="md"></td>
107          <td class="md" nowrap>unsigned long&nbsp;</td>
108          <td class="mdname" nowrap> <em>updateInterval</em>, </td>
109        </tr>
110        <tr>
111          <td class="md" nowrap align="right"></td>
112          <td class="md"></td>
113          <td class="md" nowrap>unsigned int&nbsp;</td>
114          <td class="mdname" nowrap> <em>resolution</em>, </td>
115        </tr>
116        <tr>
117          <td class="md" nowrap align="right"></td>
118          <td class="md"></td>
119          <td class="md" nowrap>String&nbsp;</td>
120          <td class="mdname" nowrap> <em>materialName</em>, </td>
121        </tr>
122        <tr>
123          <td class="md" nowrap align="right"></td>
124          <td class="md"></td>
125          <td class="md" nowrap>unsigned char&nbsp;</td>
126          <td class="mdname" nowrap> <em>photonMapTexId</em>, </td>
127        </tr>
128        <tr>
129          <td class="md" nowrap align="right"></td>
130          <td class="md"></td>
131          <td class="md" nowrap>bool&nbsp;</td>
132          <td class="mdname" nowrap> <em>updateAllFace</em></td>
133        </tr>
134        <tr>
135          <td class="md"></td>
136          <td class="md">)&nbsp;</td>
137          <td class="md" colspan="2"></td>
138        </tr>
139      </table>
140    </td>
141  </tr>
142</table>
143<table cellspacing="5" cellpadding="0" border="0">
144  <tr>
145    <td>
146      &nbsp;
147    </td>
148    <td>
149
150<p>
151Constructor.
152<p>
153<dl compact><dt><b>Parameters:</b></dt><dd>
154  <table border="0" cellspacing="2" cellpadding="0">
155    <tr><td valign="top"></td><td valign="top"><em>sharedRuns</em>&nbsp;</td><td>a pointer to the <a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> this run belongs to </td></tr>
156    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>the name of the cubemap texture to be created </td></tr>
157    <tr><td valign="top"></td><td valign="top"><em>startFrame</em>&nbsp;</td><td>adds an offset to the current frame number to help evenly distribute updates between frames </td></tr>
158    <tr><td valign="top"></td><td valign="top"><em>updateInterval</em>&nbsp;</td><td>update frequency </td></tr>
159    <tr><td valign="top"></td><td valign="top"><em>resolution</em>&nbsp;</td><td>cubemap resolution </td></tr>
160    <tr><td valign="top"></td><td valign="top"><em>materialName</em>&nbsp;</td><td>the name of the material that should be used when rendering the caustic cubemap </td></tr>
161    <tr><td valign="top"></td><td valign="top"><em>photonMapTexId</em>&nbsp;</td><td>the texture unit state id of the caustic map generation material where the photonhit map should be bound to </td></tr>
162    <tr><td valign="top"></td><td valign="top"><em>updateAllFace</em>&nbsp;</td><td>defines if all cubemap faces should be updated in a frame or only one face per frame </td></tr>
163  </table>
164</dl>
165    </td>
166  </tr>
167</table>
168<hr><h2>Member Function Documentation</h2>
169<a class="anchor" name="3af399eb995301b2646a3756880ee1fb"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::faceNeedsUpdate" ref="3af399eb995301b2646a3756880ee1fb" args="(int facenum)" --><p>
170<table class="mdTable" cellpadding="2" cellspacing="0">
171  <tr>
172    <td class="mdRow">
173      <table cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td class="md" nowrap valign="top">bool OgreCausticCubeMapRenderingRun::faceNeedsUpdate           </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="md" nowrap valign="top">int&nbsp;</td>
178          <td class="mdname1" valign="top" nowrap> <em>facenum</em>          </td>
179          <td class="md" valign="top">&nbsp;)&nbsp;</td>
180          <td class="md" nowrap><code> [protected, virtual]</code></td>
181        </tr>
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing="5" cellpadding="0" border="0">
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Checks if a cubemap face needs to be updated.
195<p>
196If the object we are updating the cubemap for is far from the camera, or too small, or the given cubemapface does not have significant effect on the rendering the face can be skipped.<p>
197<dl compact><dt><b>Parameters:</b></dt><dd>
198  <table border="0" cellspacing="2" cellpadding="0">
199    <tr><td valign="top"></td><td valign="top"><em>facenum</em>&nbsp;</td><td>the number of the face to be checked </td></tr>
200  </table>
201</dl>
202
203<p>
204Implements <a class="el" href="class_caustic_cube_map_rendering_run.html#64958b6a3860e9185202c61a11976ce3">CausticCubeMapRenderingRun</a>.    </td>
205  </tr>
206</table>
207<a class="anchor" name="e6dfda3ace6f42e1804a960e88f518e7"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::photonMapChanged" ref="e6dfda3ace6f42e1804a960e88f518e7" args="(RenderingRun *run)" --><p>
208<table class="mdTable" cellpadding="2" cellspacing="0">
209  <tr>
210    <td class="mdRow">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top">void OgreCausticCubeMapRenderingRun::photonMapChanged           </td>
214          <td class="md" valign="top">(&nbsp;</td>
215          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
216          <td class="mdname1" valign="top" nowrap> <em>run</em>          </td>
217          <td class="md" valign="top">&nbsp;)&nbsp;</td>
218          <td class="md" nowrap><code> [virtual]</code></td>
219        </tr>
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing="5" cellpadding="0" border="0">
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232Called if the changed run is a <a class="el" href="class_photon_map_rendering_run.html">PhotonMapRenderingRun</a>.
233<p>
234<dl compact><dt><b>Parameters:</b></dt><dd>
235  <table border="0" cellspacing="2" cellpadding="0">
236    <tr><td valign="top"></td><td valign="top"><em>run</em>&nbsp;</td><td>pointer to the changed <a class="el" href="class_photon_map_rendering_run.html">PhotonMapRenderingRun</a> </td></tr>
237  </table>
238</dl>
239
240<p>
241Implements <a class="el" href="class_caustic_cube_map_rendering_run.html#2c39d2b16e356d040d51151bcb119be1">CausticCubeMapRenderingRun</a>.    </td>
242  </tr>
243</table>
244<a class="anchor" name="e84bced29136a12e3f32ac3c3157217d"></a><!-- doxytag: member="OgreCausticCubeMapRenderingRun::updateCubeFace" ref="e84bced29136a12e3f32ac3c3157217d" args="(int facenum)" --><p>
245<table class="mdTable" cellpadding="2" cellspacing="0">
246  <tr>
247    <td class="mdRow">
248      <table cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td class="md" nowrap valign="top">void OgreCausticCubeMapRenderingRun::updateCubeFace           </td>
251          <td class="md" valign="top">(&nbsp;</td>
252          <td class="md" nowrap valign="top">int&nbsp;</td>
253          <td class="mdname1" valign="top" nowrap> <em>facenum</em>          </td>
254          <td class="md" valign="top">&nbsp;)&nbsp;</td>
255          <td class="md" nowrap><code> [inline, protected, virtual]</code></td>
256        </tr>
257      </table>
258    </td>
259  </tr>
260</table>
261<table cellspacing="5" cellpadding="0" border="0">
262  <tr>
263    <td>
264      &nbsp;
265    </td>
266    <td>
267
268<p>
269Updates one face of the cubemap.
270<p>
271<dl compact><dt><b>Parameters:</b></dt><dd>
272  <table border="0" cellspacing="2" cellpadding="0">
273    <tr><td valign="top"></td><td valign="top"><em>facenum</em>&nbsp;</td><td>the number of the face to be updated </td></tr>
274  </table>
275</dl>
276
277<p>
278Implements <a class="el" href="class_caustic_cube_map_rendering_run.html#8243ea1e4988a378cfa338a3a10d218a">CausticCubeMapRenderingRun</a>.    </td>
279  </tr>
280</table>
281<hr>The documentation for this class was generated from the following files:<ul>
282<li>OgreCausticCubeMapRenderingRun.h<li>OgreCausticCubeMapRenderingRun.cpp</ul>
283<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:39 2006 for GameTools Illumination Module by&nbsp;
284<a href="http://www.doxygen.org/index.html">
285<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
286</body>
287</html>
Note: See TracBrowser for help on using the repository browser.