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

Revision 894, 17.3 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: OgreCubeMapRenderTechnique 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>OgreCubeMapRenderTechnique Class Reference</h1><!-- doxytag: class="OgreCubeMapRenderTechnique" --><!-- doxytag: inherits="CubeMapRenderTechnique,OgreRenderTechnique" --><a class="el" href="class_cube_map_render_technique.html">CubeMapRenderTechnique</a> used in an Ogre environment. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for OgreCubeMapRenderTechnique:
24<p><center><img src="class_ogre_cube_map_render_technique.png" usemap="#OgreCubeMapRenderTechnique_map" border="0" alt=""></center>
25<map name="OgreCubeMapRenderTechnique_map">
26<area href="class_cube_map_render_technique.html" alt="CubeMapRenderTechnique" shape="rect" coords="0,56,195,80">
27<area href="class_ogre_render_technique.html" alt="OgreRenderTechnique" shape="rect" coords="205,56,400,80">
28<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="0,0,195,24">
29<area href="class_render_technique.html" alt="RenderTechnique" shape="rect" coords="205,0,400,24">
30</map>
31<a href="class_ogre_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_cube_map_render_technique.html#630b4dd9473da43a083640fa5a0d7bdf">OgreCubeMapRenderTechnique</a> (unsigned long <a class="el" href="class_cube_map_render_technique.html#8524bab7cad2126392bc059ca8a64d1a">startFrame</a>, unsigned long <a class="el" href="class_cube_map_render_technique.html#8ff0524e57bdc66edca5b7be59122692">cubeMapUpdateInterval</a>, unsigned int <a class="el" href="class_cube_map_render_technique.html#c81cd26ea04593304401347a02efd46e">cubeMapResolution</a>, unsigned char <a class="el" href="class_ogre_cube_map_render_technique.html#b197ae8609596ae7ac983f7dccef6368">texID</a>, bool <a class="el" href="class_cube_map_render_technique.html#620f22ebf50fcdb249f728161b02ca65">useDistCalc</a>, bool <a class="el" href="class_cube_map_render_technique.html#39286d307d69ed0e2796df2264eb8f73">useFaceAngleCalc</a>, float <a class="el" href="class_cube_map_render_technique.html#3d652245799ffab777999deb9a6323d0">distTolerance</a>, float <a class="el" href="class_cube_map_render_technique.html#27c8c625b5c62fc0774a8189cdf3819d">angleTolerance</a>, bool <a class="el" href="class_cube_map_render_technique.html#2e6ef90b4fc5fda0792ec951f11765b4">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="#630b4dd9473da43a083640fa5a0d7bdf"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc2751352ed04bdec0823dfb9dd135cc"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::~OgreCubeMapRenderTechnique" ref="fc2751352ed04bdec0823dfb9dd135cc" args="()" -->
38&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_cube_map_render_technique.html#fc2751352ed04bdec0823dfb9dd135cc">~OgreCubeMapRenderTechnique</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_cube_map_render_technique.html#bd08cab54fecb8d7382ace0d234946e7">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="#bd08cab54fecb8d7382ace0d234946e7"></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_cube_map_render_technique.html#8ad205ab1e076522a6822805a5236956">colorCubeMapRunChanged</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="#8ad205ab1e076522a6822805a5236956"></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_cube_map_render_technique.html#07c4a7ff4c518ce6ae27d88960878e63">createColorCubeMapRun</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="#07c4a7ff4c518ce6ae27d88960878e63"></a><br></td></tr>
51<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b197ae8609596ae7ac983f7dccef6368"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::texID" ref="b197ae8609596ae7ac983f7dccef6368" args="" -->
53unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_cube_map_render_technique.html#b197ae8609596ae7ac983f7dccef6368">texID</a></td></tr>
54
55<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>
56</table>
57<hr><a name="_details"></a><h2>Detailed Description</h2>
58<a class="el" href="class_cube_map_render_technique.html">CubeMapRenderTechnique</a> used in an Ogre environment.
59<p>
60<hr><h2>Constructor &amp; Destructor Documentation</h2>
61<a class="anchor" name="630b4dd9473da43a083640fa5a0d7bdf"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::OgreCubeMapRenderTechnique" ref="630b4dd9473da43a083640fa5a0d7bdf" 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>
62<table class="mdTable" cellpadding="2" cellspacing="0">
63  <tr>
64    <td class="mdRow">
65      <table cellpadding="0" cellspacing="0" border="0">
66        <tr>
67          <td class="md" nowrap valign="top">OgreCubeMapRenderTechnique::OgreCubeMapRenderTechnique           </td>
68          <td class="md" valign="top">(&nbsp;</td>
69          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
70          <td class="mdname" nowrap> <em>startFrame</em>, </td>
71        </tr>
72        <tr>
73          <td class="md" nowrap align="right"></td>
74          <td class="md"></td>
75          <td class="md" nowrap>unsigned long&nbsp;</td>
76          <td class="mdname" nowrap> <em>cubeMapUpdateInterval</em>, </td>
77        </tr>
78        <tr>
79          <td class="md" nowrap align="right"></td>
80          <td class="md"></td>
81          <td class="md" nowrap>unsigned int&nbsp;</td>
82          <td class="mdname" nowrap> <em>cubeMapResolution</em>, </td>
83        </tr>
84        <tr>
85          <td class="md" nowrap align="right"></td>
86          <td class="md"></td>
87          <td class="md" nowrap>unsigned char&nbsp;</td>
88          <td class="mdname" nowrap> <em>texID</em>, </td>
89        </tr>
90        <tr>
91          <td class="md" nowrap align="right"></td>
92          <td class="md"></td>
93          <td class="md" nowrap>bool&nbsp;</td>
94          <td class="mdname" nowrap> <em>useDistCalc</em>, </td>
95        </tr>
96        <tr>
97          <td class="md" nowrap align="right"></td>
98          <td class="md"></td>
99          <td class="md" nowrap>bool&nbsp;</td>
100          <td class="mdname" nowrap> <em>useFaceAngleCalc</em>, </td>
101        </tr>
102        <tr>
103          <td class="md" nowrap align="right"></td>
104          <td class="md"></td>
105          <td class="md" nowrap>float&nbsp;</td>
106          <td class="mdname" nowrap> <em>distTolerance</em>, </td>
107        </tr>
108        <tr>
109          <td class="md" nowrap align="right"></td>
110          <td class="md"></td>
111          <td class="md" nowrap>float&nbsp;</td>
112          <td class="mdname" nowrap> <em>angleTolerance</em>, </td>
113        </tr>
114        <tr>
115          <td class="md" nowrap align="right"></td>
116          <td class="md"></td>
117          <td class="md" nowrap>bool&nbsp;</td>
118          <td class="mdname" nowrap> <em>updateAllFace</em>, </td>
119        </tr>
120        <tr>
121          <td class="md" nowrap align="right"></td>
122          <td class="md"></td>
123          <td class="md" nowrap>Pass *&nbsp;</td>
124          <td class="mdname" nowrap> <em>pass</em>, </td>
125        </tr>
126        <tr>
127          <td class="md" nowrap align="right"></td>
128          <td class="md"></td>
129          <td class="md" nowrap><a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *&nbsp;</td>
130          <td class="mdname" nowrap> <em>parentRenderable</em>, </td>
131        </tr>
132        <tr>
133          <td class="md" nowrap align="right"></td>
134          <td class="md"></td>
135          <td class="md" nowrap><a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *&nbsp;</td>
136          <td class="mdname" nowrap> <em>parentTechniqueGroup</em></td>
137        </tr>
138        <tr>
139          <td class="md"></td>
140          <td class="md">)&nbsp;</td>
141          <td class="md" colspan="2"></td>
142        </tr>
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing="5" cellpadding="0" border="0">
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155Constructor.
156<p>
157<dl compact><dt><b>Parameters:</b></dt><dd>
158  <table border="0" cellspacing="2" cellpadding="0">
159    <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>
160    <tr><td valign="top"></td><td valign="top"><em>cubeMapUpdateInterval</em>&nbsp;</td><td>update frequency </td></tr>
161    <tr><td valign="top"></td><td valign="top"><em>cubeMapResolution</em>&nbsp;</td><td>color cubemap resolution </td></tr>
162    <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>
163    <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>
164    <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>
165    <tr><td valign="top"></td><td valign="top"><em>distTolerance</em>&nbsp;</td><td>distance tolerance used in face skip </td></tr>
166    <tr><td valign="top"></td><td valign="top"><em>angleTolerance</em>&nbsp;</td><td>angle tolerance used in face skip </td></tr>
167    <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>
168    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the pass to operate on </td></tr>
169    <tr><td valign="top"></td><td valign="top"><em>parentRenderable</em>&nbsp;</td><td>the object to operate on </td></tr>
170    <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>
171  </table>
172</dl>
173    </td>
174  </tr>
175</table>
176<hr><h2>Member Function Documentation</h2>
177<a class="anchor" name="8ad205ab1e076522a6822805a5236956"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::colorCubeMapRunChanged" ref="8ad205ab1e076522a6822805a5236956" args="(RenderingRun *run)" --><p>
178<table class="mdTable" cellpadding="2" cellspacing="0">
179  <tr>
180    <td class="mdRow">
181      <table cellpadding="0" cellspacing="0" border="0">
182        <tr>
183          <td class="md" nowrap valign="top">void OgreCubeMapRenderTechnique::colorCubeMapRunChanged           </td>
184          <td class="md" valign="top">(&nbsp;</td>
185          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
186          <td class="mdname1" valign="top" nowrap> <em>run</em>          </td>
187          <td class="md" valign="top">&nbsp;)&nbsp;</td>
188          <td class="md" nowrap><code> [protected, virtual]</code></td>
189        </tr>
190      </table>
191    </td>
192  </tr>
193</table>
194<table cellspacing="5" cellpadding="0" border="0">
195  <tr>
196    <td>
197      &nbsp;
198    </td>
199    <td>
200
201<p>
202Called if the changed run is a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.
203<p>
204<dl compact><dt><b>Parameters:</b></dt><dd>
205  <table border="0" cellspacing="2" cellpadding="0">
206    <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>
207  </table>
208</dl>
209
210<p>
211Implements <a class="el" href="class_cube_map_render_technique.html#4d8a24b9c21360ba3e5672c3bf0bda76">CubeMapRenderTechnique</a>.    </td>
212  </tr>
213</table>
214<a class="anchor" name="07c4a7ff4c518ce6ae27d88960878e63"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::createColorCubeMapRun" ref="07c4a7ff4c518ce6ae27d88960878e63" args="()" --><p>
215<table class="mdTable" cellpadding="2" cellspacing="0">
216  <tr>
217    <td class="mdRow">
218      <table cellpadding="0" cellspacing="0" border="0">
219        <tr>
220          <td class="md" nowrap valign="top"><a class="el" href="class_rendering_run.html">RenderingRun</a> * OgreCubeMapRenderTechnique::createColorCubeMapRun           </td>
221          <td class="md" valign="top">(&nbsp;</td>
222          <td class="mdname1" valign="top" nowrap>          </td>
223          <td class="md" valign="top">&nbsp;)&nbsp;</td>
224          <td class="md" nowrap><code> [protected, virtual]</code></td>
225        </tr>
226      </table>
227    </td>
228  </tr>
229</table>
230<table cellspacing="5" cellpadding="0" border="0">
231  <tr>
232    <td>
233      &nbsp;
234    </td>
235    <td>
236
237<p>
238Creates a <a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a>.
239<p>
240<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>
241
242<p>
243Implements <a class="el" href="class_cube_map_render_technique.html#b21be2025735a9d8d55c465c3be5842b">CubeMapRenderTechnique</a>.    </td>
244  </tr>
245</table>
246<a class="anchor" name="bd08cab54fecb8d7382ace0d234946e7"></a><!-- doxytag: member="OgreCubeMapRenderTechnique::update" ref="bd08cab54fecb8d7382ace0d234946e7" args="(unsigned long frameNum)" --><p>
247<table class="mdTable" cellpadding="2" cellspacing="0">
248  <tr>
249    <td class="mdRow">
250      <table cellpadding="0" cellspacing="0" border="0">
251        <tr>
252          <td class="md" nowrap valign="top">void OgreCubeMapRenderTechnique::update           </td>
253          <td class="md" valign="top">(&nbsp;</td>
254          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
255          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
256          <td class="md" valign="top">&nbsp;)&nbsp;</td>
257          <td class="md" nowrap><code> [virtual]</code></td>
258        </tr>
259      </table>
260    </td>
261  </tr>
262</table>
263<table cellspacing="5" cellpadding="0" border="0">
264  <tr>
265    <td>
266      &nbsp;
267    </td>
268    <td>
269
270<p>
271Updates the resources in the given frame.
272<p>
273<dl compact><dt><b>Parameters:</b></dt><dd>
274  <table border="0" cellspacing="2" cellpadding="0">
275    <tr><td valign="top"></td><td valign="top"><em>frameNum</em>&nbsp;</td><td>the actual framenumber </td></tr>
276  </table>
277</dl>
278
279<p>
280Reimplemented from <a class="el" href="class_cube_map_render_technique.html#6094646a1da963728058422dedf56781">CubeMapRenderTechnique</a>.    </td>
281  </tr>
282</table>
283<hr>The documentation for this class was generated from the following files:<ul>
284<li>OgreCubeMapRenderTechnique.h<li>OgreCubeMapRenderTechnique.cpp</ul>
285<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:40 2006 for GameTools Illumination Module by&nbsp;
286<a href="http://www.doxygen.org/index.html">
287<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
288</body>
289</html>
Note: See TracBrowser for help on using the repository browser.