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

Revision 894, 16.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: OgreDistanceCubeMapRenderingRun 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>OgreDistanceCubeMapRenderingRun Class Reference</h1><!-- doxytag: class="OgreDistanceCubeMapRenderingRun" --><!-- doxytag: inherits="OgreRenderingRun,DistanceCubeMapRenderingRun" --><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 OgreDistanceCubeMapRenderingRun:
24<p><center><img src="class_ogre_distance_cube_map_rendering_run.png" usemap="#OgreDistanceCubeMapRenderingRun_map" border="0" alt=""></center>
25<map name="OgreDistanceCubeMapRenderingRun_map">
26<area href="class_ogre_rendering_run.html" alt="OgreRenderingRun" shape="rect" coords="0,56,225,80">
27<area href="class_distance_cube_map_rendering_run.html" alt="DistanceCubeMapRenderingRun" shape="rect" coords="235,56,460,80">
28<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="0,0,225,24">
29<area href="class_rendering_run.html" alt="RenderingRun" shape="rect" coords="235,0,460,24">
30</map>
31<a href="class_ogre_distance_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_distance_cube_map_rendering_run.html#4e90b6745ae060823afa03cd6fc24967">OgreDistanceCubeMapRenderingRun</a> (<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *<a class="el" href="class_ogre_distance_cube_map_rendering_run.html#d5d0ed61894ca949987dfa3b863c8965">sharedRuns</a>, String <a class="el" href="class_ogre_distance_cube_map_rendering_run.html#be12d094ee80cddf518c5ad1d8281d03">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_distance_cube_map_rendering_run.html#92d9f48b10e829ad00b7db48455bf051">resolution</a>, bool <a class="el" href="class_distance_cube_map_rendering_run.html#2bf0cdaf8446f625f5a928759d3390a7">useDistCalc</a>=false, bool <a class="el" href="class_distance_cube_map_rendering_run.html#af1266ea5fc9f11b99f126c85db51496">useFaceAngleCalc</a>=false, float <a class="el" href="class_distance_cube_map_rendering_run.html#ab35b6785b590515549f9a1bbdca9a5c">distTolerance</a>=15, float <a class="el" href="class_distance_cube_map_rendering_run.html#20ddd9025e0992be956ecb62126d9d10">angleTolerance</a>=10, bool <a class="el" href="class_distance_cube_map_rendering_run.html#94ad114c110d60b45c49ef2a2b2f2425">updateAllFace</a>=false)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#4e90b6745ae060823afa03cd6fc24967"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb4611322d76efde0bc0c68caa056643"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::getDistanceCubeMapTextureName" ref="cb4611322d76efde0bc0c68caa056643" args="()" -->
38String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#cb4611322d76efde0bc0c68caa056643">getDistanceCubeMapTextureName</a> ()</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns the name of the resulting distance cubemap texture <br></td></tr>
41<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="519ecc8de5d92c412f18958fa0ee3bcc"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::createDistanceCubeMap" ref="519ecc8de5d92c412f18958fa0ee3bcc" args="()" -->
43void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#519ecc8de5d92c412f18958fa0ee3bcc">createDistanceCubeMap</a> ()</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a cubemap texture used for the color-cubemap. <br></td></tr>
46<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_rendering_run.html#a44d3caa2b7cdcd010c294990a751d14">updateCubeFace</a> (int facenum)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates one face of the cubemap.  <a href="#a44d3caa2b7cdcd010c294990a751d14"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#fffaf3a5bb506314baa02f3d25fa980a">faceNeedsUpdate</a> (int facenum)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if a cubemap face needs to be updated.  <a href="#fffaf3a5bb506314baa02f3d25fa980a"></a><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="d5d0ed61894ca949987dfa3b863c8965"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::sharedRuns" ref="d5d0ed61894ca949987dfa3b863c8965" args="" -->
54<a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#d5d0ed61894ca949987dfa3b863c8965">sharedRuns</a></td></tr>
55
56<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>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be12d094ee80cddf518c5ad1d8281d03"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::name" ref="be12d094ee80cddf518c5ad1d8281d03" args="" -->
58String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#be12d094ee80cddf518c5ad1d8281d03">name</a></td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the name of the cubemap texture that was created by this run <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b66fd0617754ecf81034bff2558e2e3"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::distanceCubemapTexture" ref="7b66fd0617754ecf81034bff2558e2e3" args="" -->
62Texture *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_distance_cube_map_rendering_run.html#7b66fd0617754ecf81034bff2558e2e3">distanceCubemapTexture</a></td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">a pointer to the cubemap texture that was created by this run <br></td></tr>
65</table>
66<hr><a name="_details"></a><h2>Detailed Description</h2>
67<a class="el" href="class_color_cube_map_rendering_run.html">ColorCubeMapRenderingRun</a> used in an OGRE environment.
68<p>
69<hr><h2>Constructor &amp; Destructor Documentation</h2>
70<a class="anchor" name="4e90b6745ae060823afa03cd6fc24967"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::OgreDistanceCubeMapRenderingRun" ref="4e90b6745ae060823afa03cd6fc24967" args="(OgreSharedRuns *sharedRuns, String name, unsigned long startFrame, unsigned long updateInterval, unsigned int resolution, bool useDistCalc=false, bool useFaceAngleCalc=false, float distTolerance=15, float angleTolerance=10, bool updateAllFace=false)" --><p>
71<table class="mdTable" cellpadding="2" cellspacing="0">
72  <tr>
73    <td class="mdRow">
74      <table cellpadding="0" cellspacing="0" border="0">
75        <tr>
76          <td class="md" nowrap valign="top">OgreDistanceCubeMapRenderingRun::OgreDistanceCubeMapRenderingRun           </td>
77          <td class="md" valign="top">(&nbsp;</td>
78          <td class="md" nowrap valign="top"><a class="el" href="class_ogre_shared_runs.html">OgreSharedRuns</a> *&nbsp;</td>
79          <td class="mdname" nowrap> <em>sharedRuns</em>, </td>
80        </tr>
81        <tr>
82          <td class="md" nowrap align="right"></td>
83          <td class="md"></td>
84          <td class="md" nowrap>String&nbsp;</td>
85          <td class="mdname" nowrap> <em>name</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 long&nbsp;</td>
91          <td class="mdname" nowrap> <em>startFrame</em>, </td>
92        </tr>
93        <tr>
94          <td class="md" nowrap align="right"></td>
95          <td class="md"></td>
96          <td class="md" nowrap>unsigned long&nbsp;</td>
97          <td class="mdname" nowrap> <em>updateInterval</em>, </td>
98        </tr>
99        <tr>
100          <td class="md" nowrap align="right"></td>
101          <td class="md"></td>
102          <td class="md" nowrap>unsigned int&nbsp;</td>
103          <td class="mdname" nowrap> <em>resolution</em>, </td>
104        </tr>
105        <tr>
106          <td class="md" nowrap align="right"></td>
107          <td class="md"></td>
108          <td class="md" nowrap>bool&nbsp;</td>
109          <td class="mdname" nowrap> <em>useDistCalc</em> = <code>false</code>, </td>
110        </tr>
111        <tr>
112          <td class="md" nowrap align="right"></td>
113          <td class="md"></td>
114          <td class="md" nowrap>bool&nbsp;</td>
115          <td class="mdname" nowrap> <em>useFaceAngleCalc</em> = <code>false</code>, </td>
116        </tr>
117        <tr>
118          <td class="md" nowrap align="right"></td>
119          <td class="md"></td>
120          <td class="md" nowrap>float&nbsp;</td>
121          <td class="mdname" nowrap> <em>distTolerance</em> = <code>15</code>, </td>
122        </tr>
123        <tr>
124          <td class="md" nowrap align="right"></td>
125          <td class="md"></td>
126          <td class="md" nowrap>float&nbsp;</td>
127          <td class="mdname" nowrap> <em>angleTolerance</em> = <code>10</code>, </td>
128        </tr>
129        <tr>
130          <td class="md" nowrap align="right"></td>
131          <td class="md"></td>
132          <td class="md" nowrap>bool&nbsp;</td>
133          <td class="mdname" nowrap> <em>updateAllFace</em> = <code>false</code></td>
134        </tr>
135        <tr>
136          <td class="md"></td>
137          <td class="md">)&nbsp;</td>
138          <td class="md" colspan="2"></td>
139        </tr>
140      </table>
141    </td>
142  </tr>
143</table>
144<table cellspacing="5" cellpadding="0" border="0">
145  <tr>
146    <td>
147      &nbsp;
148    </td>
149    <td>
150
151<p>
152Constructor.
153<p>
154<dl compact><dt><b>Parameters:</b></dt><dd>
155  <table border="0" cellspacing="2" cellpadding="0">
156    <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>
157    <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>
158    <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>
159    <tr><td valign="top"></td><td valign="top"><em>updateInterval</em>&nbsp;</td><td>update frequency </td></tr>
160    <tr><td valign="top"></td><td valign="top"><em>resolution</em>&nbsp;</td><td>cubemap resolution </td></tr>
161    <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>
162    <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>
163    <tr><td valign="top"></td><td valign="top"><em>distTolerance</em>&nbsp;</td><td>distance tolerance used in face skip </td></tr>
164    <tr><td valign="top"></td><td valign="top"><em>angleTolerance</em>&nbsp;</td><td>angle tolerance used in face skip </td></tr>
165    <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>
166  </table>
167</dl>
168    </td>
169  </tr>
170</table>
171<hr><h2>Member Function Documentation</h2>
172<a class="anchor" name="fffaf3a5bb506314baa02f3d25fa980a"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::faceNeedsUpdate" ref="fffaf3a5bb506314baa02f3d25fa980a" args="(int facenum)" --><p>
173<table class="mdTable" cellpadding="2" cellspacing="0">
174  <tr>
175    <td class="mdRow">
176      <table cellpadding="0" cellspacing="0" border="0">
177        <tr>
178          <td class="md" nowrap valign="top">bool OgreDistanceCubeMapRenderingRun::faceNeedsUpdate           </td>
179          <td class="md" valign="top">(&nbsp;</td>
180          <td class="md" nowrap valign="top">int&nbsp;</td>
181          <td class="mdname1" valign="top" nowrap> <em>facenum</em>          </td>
182          <td class="md" valign="top">&nbsp;)&nbsp;</td>
183          <td class="md" nowrap><code> [protected, virtual]</code></td>
184        </tr>
185      </table>
186    </td>
187  </tr>
188</table>
189<table cellspacing="5" cellpadding="0" border="0">
190  <tr>
191    <td>
192      &nbsp;
193    </td>
194    <td>
195
196<p>
197Checks if a cubemap face needs to be updated.
198<p>
199If 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>
200<dl compact><dt><b>Parameters:</b></dt><dd>
201  <table border="0" cellspacing="2" cellpadding="0">
202    <tr><td valign="top"></td><td valign="top"><em>facenum</em>&nbsp;</td><td>the number of the face to be checked </td></tr>
203  </table>
204</dl>
205
206<p>
207Implements <a class="el" href="class_distance_cube_map_rendering_run.html#a1bef95adcf43940459ec62b252dfc99">DistanceCubeMapRenderingRun</a>.    </td>
208  </tr>
209</table>
210<a class="anchor" name="a44d3caa2b7cdcd010c294990a751d14"></a><!-- doxytag: member="OgreDistanceCubeMapRenderingRun::updateCubeFace" ref="a44d3caa2b7cdcd010c294990a751d14" args="(int facenum)" --><p>
211<table class="mdTable" cellpadding="2" cellspacing="0">
212  <tr>
213    <td class="mdRow">
214      <table cellpadding="0" cellspacing="0" border="0">
215        <tr>
216          <td class="md" nowrap valign="top">void OgreDistanceCubeMapRenderingRun::updateCubeFace           </td>
217          <td class="md" valign="top">(&nbsp;</td>
218          <td class="md" nowrap valign="top">int&nbsp;</td>
219          <td class="mdname1" valign="top" nowrap> <em>facenum</em>          </td>
220          <td class="md" valign="top">&nbsp;)&nbsp;</td>
221          <td class="md" nowrap><code> [inline, protected, virtual]</code></td>
222        </tr>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing="5" cellpadding="0" border="0">
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Updates one face of the cubemap.
236<p>
237<dl compact><dt><b>Parameters:</b></dt><dd>
238  <table border="0" cellspacing="2" cellpadding="0">
239    <tr><td valign="top"></td><td valign="top"><em>facenum</em>&nbsp;</td><td>the number of the face to be updated </td></tr>
240  </table>
241</dl>
242
243<p>
244Implements <a class="el" href="class_distance_cube_map_rendering_run.html#a7ca131491f221078618f5544974f2ae">DistanceCubeMapRenderingRun</a>.    </td>
245  </tr>
246</table>
247<hr>The documentation for this class was generated from the following files:<ul>
248<li>OgreDistanceCubeMapRenderingRun.h<li>OgreDistanceCubeMapRenderingRun.cpp</ul>
249<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:40 2006 for GameTools Illumination Module by&nbsp;
250<a href="http://www.doxygen.org/index.html">
251<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
252</body>
253</html>
Note: See TracBrowser for help on using the repository browser.