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

Revision 894, 20.0 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: OgreDistanceCubeMapRenderTechnique 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>OgreDistanceCubeMapRenderTechnique Class Reference</h1><!-- doxytag: class="OgreDistanceCubeMapRenderTechnique" --><!-- doxytag: inherits="DistanceCubeMapRenderTechnique,OgreRenderTechnique" --><a class="el" href="class_distance_cube_map_render_technique.html">DistanceCubeMapRenderTechnique</a> used in an Ogre environment. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for OgreDistanceCubeMapRenderTechnique:
24<p><center><img src="class_ogre_distance_cube_map_render_technique.png" usemap="#OgreDistanceCubeMapRenderTechnique_map" border="0" alt=""></center>
25<map name="OgreDistanceCubeMapRenderTechnique_map">
26<area href="class_distance_cube_map_render_technique.html" alt="DistanceCubeMapRenderTechnique" shape="rect" coords="0,56,244,80">
27<area href="class_ogre_render_technique.html" alt="OgreRenderTechnique" shape="rect" coords="254,56,498,80">
28<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="0,0,244,24">
29<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="254,0,498,24">
30</map>
31<a href="class_ogre_distance_cube_map_render_technique-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_distance_cube_map_render_technique.html#83e5043edea2ee89c05ef24c0f958d3d">OgreDistanceCubeMapRenderTechnique</a> (unsigned long <a class="el" href="class_distance_cube_map_render_technique.html#876bc314690e57ae900198ff45a547fd">startFrame</a>, unsigned long <a class="el" href="class_distance_cube_map_render_technique.html#151794555cd05164b81cf6ee46ce1243">cubeMapUpdateInterval</a>, unsigned int <a class="el" href="class_distance_cube_map_render_technique.html#a29ca438eec28a942fb60bc8cc79daa4">cubeMapResolution</a>, unsigned char <a class="el" href="class_ogre_distance_cube_map_render_technique.html#2879a63aeebb5e00efe21cf146695035">texID</a>, bool <a class="el" href="class_distance_cube_map_render_technique.html#2566dc3bbb88815a8a2f6e336e512979">useDistCalc</a>, bool <a class="el" href="class_distance_cube_map_render_technique.html#937d780206004df4bd454331b34ca0ab">useFaceAngleCalc</a>, float <a class="el" href="class_distance_cube_map_render_technique.html#b55090c2446594a78a36f1122beb9c33">distTolerance</a>, float <a class="el" href="class_distance_cube_map_render_technique.html#4b9ebb9ec5cf246fb93fc0e1cf42f3c2">angleTolerance</a>, bool <a class="el" href="class_distance_cube_map_render_technique.html#7c9b2f1e77107ac88a4e1e1abc2472dc">updateAllFace</a>, Pass *<a class="el" href="class_ogre_render_technique.html#d52ee875206d5c373bbec1315131b96f">pass</a>, <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *<a class="el" href="class_render_technique.html#888980e685779fa6801cda413e8c3637">parentRenderable</a>, <a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *<a class="el" href="class_render_technique.html#f1246cf759d7b81eb25195834a7ad349">parentTechniqueGroup</a>)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#83e5043edea2ee89c05ef24c0f958d3d"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3975597bef81f7c40d812e0e710133f3"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::~OgreDistanceCubeMapRenderTechnique" ref="3975597bef81f7c40d812e0e710133f3" args="()" -->
38&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_render_technique.html#3975597bef81f7c40d812e0e710133f3">~OgreDistanceCubeMapRenderTechnique</a> ()</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <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_distance_cube_map_render_technique.html#2dac178431b973cf7420c7bd7e87666a">update</a> (unsigned long frameNum)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the resources in the given frame.  <a href="#2dac178431b973cf7420c7bd7e87666a"></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_render_technique.html#b555e5164ea394455fd5add3a087f7e7">distanceCubeMapRunChanged</a> (<a class="el" href="class_rendering_run.html">RenderingRun</a> *run)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called if the changed run is a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.  <a href="#b555e5164ea394455fd5add3a087f7e7"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_render_technique.html#27372dfb3385f71e97ff34263142613d">createDistanceCubeMapRun</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.  <a href="#27372dfb3385f71e97ff34263142613d"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_render_technique.html#1af356a0aa335a591d79cf5c6e290fef">distanceCubeMapRunUpdated</a> (<a class="el" href="class_rendering_run.html">RenderingRun</a> *run)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called if the changed run is a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.  <a href="#1af356a0aa335a591d79cf5c6e290fef"></a><br></td></tr>
54<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2879a63aeebb5e00efe21cf146695035"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::texID" ref="2879a63aeebb5e00efe21cf146695035" args="" -->
56unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_render_technique.html#2879a63aeebb5e00efe21cf146695035">texID</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the id of the texture unit state the resulting cubemap should be bound to <br></td></tr>
59</table>
60<hr><a name="_details"></a><h2>Detailed Description</h2>
61<a class="el" href="class_distance_cube_map_render_technique.html">DistanceCubeMapRenderTechnique</a> used in an Ogre environment.
62<p>
63<hr><h2>Constructor &amp; Destructor Documentation</h2>
64<a class="anchor" name="83e5043edea2ee89c05ef24c0f958d3d"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::OgreDistanceCubeMapRenderTechnique" ref="83e5043edea2ee89c05ef24c0f958d3d" args="(unsigned long startFrame, unsigned long cubeMapUpdateInterval, unsigned int cubeMapResolution, unsigned char texID, bool useDistCalc, bool useFaceAngleCalc, float distTolerance, float angleTolerance, bool updateAllFace, Pass *pass, OgreRenderable *parentRenderable, OgreTechniqueGroup *parentTechniqueGroup)" --><p>
65<table class="mdTable" cellpadding="2" cellspacing="0">
66  <tr>
67    <td class="mdRow">
68      <table cellpadding="0" cellspacing="0" border="0">
69        <tr>
70          <td class="md" nowrap valign="top">OgreDistanceCubeMapRenderTechnique::OgreDistanceCubeMapRenderTechnique           </td>
71          <td class="md" valign="top">(&nbsp;</td>
72          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
73          <td class="mdname" nowrap> <em>startFrame</em>, </td>
74        </tr>
75        <tr>
76          <td class="md" nowrap align="right"></td>
77          <td class="md"></td>
78          <td class="md" nowrap>unsigned long&nbsp;</td>
79          <td class="mdname" nowrap> <em>cubeMapUpdateInterval</em>, </td>
80        </tr>
81        <tr>
82          <td class="md" nowrap align="right"></td>
83          <td class="md"></td>
84          <td class="md" nowrap>unsigned int&nbsp;</td>
85          <td class="mdname" nowrap> <em>cubeMapResolution</em>, </td>
86        </tr>
87        <tr>
88          <td class="md" nowrap align="right"></td>
89          <td class="md"></td>
90          <td class="md" nowrap>unsigned char&nbsp;</td>
91          <td class="mdname" nowrap> <em>texID</em>, </td>
92        </tr>
93        <tr>
94          <td class="md" nowrap align="right"></td>
95          <td class="md"></td>
96          <td class="md" nowrap>bool&nbsp;</td>
97          <td class="mdname" nowrap> <em>useDistCalc</em>, </td>
98        </tr>
99        <tr>
100          <td class="md" nowrap align="right"></td>
101          <td class="md"></td>
102          <td class="md" nowrap>bool&nbsp;</td>
103          <td class="mdname" nowrap> <em>useFaceAngleCalc</em>, </td>
104        </tr>
105        <tr>
106          <td class="md" nowrap align="right"></td>
107          <td class="md"></td>
108          <td class="md" nowrap>float&nbsp;</td>
109          <td class="mdname" nowrap> <em>distTolerance</em>, </td>
110        </tr>
111        <tr>
112          <td class="md" nowrap align="right"></td>
113          <td class="md"></td>
114          <td class="md" nowrap>float&nbsp;</td>
115          <td class="mdname" nowrap> <em>angleTolerance</em>, </td>
116        </tr>
117        <tr>
118          <td class="md" nowrap align="right"></td>
119          <td class="md"></td>
120          <td class="md" nowrap>bool&nbsp;</td>
121          <td class="mdname" nowrap> <em>updateAllFace</em>, </td>
122        </tr>
123        <tr>
124          <td class="md" nowrap align="right"></td>
125          <td class="md"></td>
126          <td class="md" nowrap>Pass *&nbsp;</td>
127          <td class="mdname" nowrap> <em>pass</em>, </td>
128        </tr>
129        <tr>
130          <td class="md" nowrap align="right"></td>
131          <td class="md"></td>
132          <td class="md" nowrap><a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *&nbsp;</td>
133          <td class="mdname" nowrap> <em>parentRenderable</em>, </td>
134        </tr>
135        <tr>
136          <td class="md" nowrap align="right"></td>
137          <td class="md"></td>
138          <td class="md" nowrap><a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *&nbsp;</td>
139          <td class="mdname" nowrap> <em>parentTechniqueGroup</em></td>
140        </tr>
141        <tr>
142          <td class="md"></td>
143          <td class="md">)&nbsp;</td>
144          <td class="md" colspan="2"></td>
145        </tr>
146      </table>
147    </td>
148  </tr>
149</table>
150<table cellspacing="5" cellpadding="0" border="0">
151  <tr>
152    <td>
153      &nbsp;
154    </td>
155    <td>
156
157<p>
158Constructor.
159<p>
160<dl compact><dt><b>Parameters:</b></dt><dd>
161  <table border="0" cellspacing="2" cellpadding="0">
162    <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>
163    <tr><td valign="top"></td><td valign="top"><em>cubeMapUpdateInterval</em>&nbsp;</td><td>update frequency </td></tr>
164    <tr><td valign="top"></td><td valign="top"><em>cubeMapResolution</em>&nbsp;</td><td>distance cubemap resolution </td></tr>
165    <tr><td valign="top"></td><td valign="top"><em>texID</em>&nbsp;</td><td>the id of the texture unit state the resulting cubemap should be bound to </td></tr>
166    <tr><td valign="top"></td><td valign="top"><em>useDistCalc</em>&nbsp;</td><td>flag to skip cube face update if object is far away </td></tr>
167    <tr><td valign="top"></td><td valign="top"><em>useFaceAngleCalc</em>&nbsp;</td><td>flag to skip cube face update if face is neglible </td></tr>
168    <tr><td valign="top"></td><td valign="top"><em>distTolerance</em>&nbsp;</td><td>distance tolerance used in face skip </td></tr>
169    <tr><td valign="top"></td><td valign="top"><em>angleTolerance</em>&nbsp;</td><td>angle tolerance used in face skip </td></tr>
170    <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>
171    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the pass to operate on </td></tr>
172    <tr><td valign="top"></td><td valign="top"><em>parentRenderable</em>&nbsp;</td><td>the object to operate on </td></tr>
173    <tr><td valign="top"></td><td valign="top"><em>parentTechniqueGroup</em>&nbsp;</td><td>the <a class="el" href="class_technique_group.html">TechniqueGroup</a> this RenderedTechnique is attached to </td></tr>
174  </table>
175</dl>
176    </td>
177  </tr>
178</table>
179<hr><h2>Member Function Documentation</h2>
180<a class="anchor" name="27372dfb3385f71e97ff34263142613d"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::createDistanceCubeMapRun" ref="27372dfb3385f71e97ff34263142613d" args="()" --><p>
181<table class="mdTable" cellpadding="2" cellspacing="0">
182  <tr>
183    <td class="mdRow">
184      <table cellpadding="0" cellspacing="0" border="0">
185        <tr>
186          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> * OgreDistanceCubeMapRenderTechnique::createDistanceCubeMapRun           </td>
187          <td class="md" valign="top">(&nbsp;</td>
188          <td class="mdname1" valign="top" nowrap>          </td>
189          <td class="md" valign="top">&nbsp;)&nbsp;</td>
190          <td class="md" nowrap><code> [protected, virtual]</code></td>
191        </tr>
192      </table>
193    </td>
194  </tr>
195</table>
196<table cellspacing="5" cellpadding="0" border="0">
197  <tr>
198    <td>
199      &nbsp;
200    </td>
201    <td>
202
203<p>
204Creates a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.
205<p>
206<dl compact><dt><b>Returns:</b></dt><dd>the new <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> instance. </dd></dl>
207
208<p>
209Implements <a class="el" href="class_distance_cube_map_render_technique.html#b6e465de84149d0f3ec5d3e2ca0df7d6">DistanceCubeMapRenderTechnique</a>.    </td>
210  </tr>
211</table>
212<a class="anchor" name="b555e5164ea394455fd5add3a087f7e7"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::distanceCubeMapRunChanged" ref="b555e5164ea394455fd5add3a087f7e7" args="(RenderingRun *run)" --><p>
213<table class="mdTable" cellpadding="2" cellspacing="0">
214  <tr>
215    <td class="mdRow">
216      <table cellpadding="0" cellspacing="0" border="0">
217        <tr>
218          <td class="md" nowrap valign="top">void OgreDistanceCubeMapRenderTechnique::distanceCubeMapRunChanged           </td>
219          <td class="md" valign="top">(&nbsp;</td>
220          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
221          <td class="mdname1" valign="top" nowrap> <em>run</em>          </td>
222          <td class="md" valign="top">&nbsp;)&nbsp;</td>
223          <td class="md" nowrap><code> [protected, virtual]</code></td>
224        </tr>
225      </table>
226    </td>
227  </tr>
228</table>
229<table cellspacing="5" cellpadding="0" border="0">
230  <tr>
231    <td>
232      &nbsp;
233    </td>
234    <td>
235
236<p>
237Called if the changed run is a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.
238<p>
239<dl compact><dt><b>Parameters:</b></dt><dd>
240  <table border="0" cellspacing="2" cellpadding="0">
241    <tr><td valign="top"></td><td valign="top"><em>run</em>&nbsp;</td><td>pointer to the changed <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> </td></tr>
242  </table>
243</dl>
244
245<p>
246Implements <a class="el" href="class_distance_cube_map_render_technique.html#6c21fd486f7bea8baf44640e8e400592">DistanceCubeMapRenderTechnique</a>.    </td>
247  </tr>
248</table>
249<a class="anchor" name="1af356a0aa335a591d79cf5c6e290fef"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::distanceCubeMapRunUpdated" ref="1af356a0aa335a591d79cf5c6e290fef" args="(RenderingRun *run)" --><p>
250<table class="mdTable" cellpadding="2" cellspacing="0">
251  <tr>
252    <td class="mdRow">
253      <table cellpadding="0" cellspacing="0" border="0">
254        <tr>
255          <td class="md" nowrap valign="top">void OgreDistanceCubeMapRenderTechnique::distanceCubeMapRunUpdated           </td>
256          <td class="md" valign="top">(&nbsp;</td>
257          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
258          <td class="mdname1" valign="top" nowrap> <em>run</em>          </td>
259          <td class="md" valign="top">&nbsp;)&nbsp;</td>
260          <td class="md" nowrap><code> [protected, virtual]</code></td>
261        </tr>
262      </table>
263    </td>
264  </tr>
265</table>
266<table cellspacing="5" cellpadding="0" border="0">
267  <tr>
268    <td>
269      &nbsp;
270    </td>
271    <td>
272
273<p>
274Called if the changed run is a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.
275<p>
276<dl compact><dt><b>Parameters:</b></dt><dd>
277  <table border="0" cellspacing="2" cellpadding="0">
278    <tr><td valign="top"></td><td valign="top"><em>run</em>&nbsp;</td><td>pointer to the changed <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> </td></tr>
279  </table>
280</dl>
281
282<p>
283Implements <a class="el" href="class_distance_cube_map_render_technique.html#5bcbd6c44375a91a20f9a9e00af2bd3c">DistanceCubeMapRenderTechnique</a>.    </td>
284  </tr>
285</table>
286<a class="anchor" name="2dac178431b973cf7420c7bd7e87666a"></a><!-- doxytag: member="OgreDistanceCubeMapRenderTechnique::update" ref="2dac178431b973cf7420c7bd7e87666a" args="(unsigned long frameNum)" --><p>
287<table class="mdTable" cellpadding="2" cellspacing="0">
288  <tr>
289    <td class="mdRow">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top">void OgreDistanceCubeMapRenderTechnique::update           </td>
293          <td class="md" valign="top">(&nbsp;</td>
294          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap><code> [virtual]</code></td>
298        </tr>
299      </table>
300    </td>
301  </tr>
302</table>
303<table cellspacing="5" cellpadding="0" border="0">
304  <tr>
305    <td>
306      &nbsp;
307    </td>
308    <td>
309
310<p>
311Updates the resources in the given frame.
312<p>
313<dl compact><dt><b>Parameters:</b></dt><dd>
314  <table border="0" cellspacing="2" cellpadding="0">
315    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>the actual framenumber </td></tr>
316  </table>
317</dl>
318
319<p>
320Reimplemented from <a class="el" href="class_distance_cube_map_render_technique.html#cd3ee50d23e6fa29f12aa07f7b54a6ed">DistanceCubeMapRenderTechnique</a>.    </td>
321  </tr>
322</table>
323<hr>The documentation for this class was generated from the following files:<ul>
324<li>OgreDistanceCubeMapRenderTechnique.h<li>OgreDistanceCubeMapRenderTechnique.cpp</ul>
325<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:40 2006 for GameTools Illumination Module by&nbsp;
326<a href="http://www.doxygen.org/index.html">
327<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
328</body>
329</html>
Note: See TracBrowser for help on using the repository browser.