source: Documentation/D5.3 Stand-alone computation package for illumination algorithms/appendix/IlluminationModule/html/class_ogre_technique_group.html @ 2910

Revision 2910, 12.6 KB checked in by hbeneit, 16 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: OgreTechniqueGroup 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>OgreTechniqueGroup Class Reference</h1><!-- doxytag: class="OgreTechniqueGroup" --><!-- doxytag: inherits="TechniqueGroup" -->Base class of a <a class="el" href="class_shared_runs.html">SharedRuns</a> in an OGRE environment. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for OgreTechniqueGroup:
24<p><center><img src="class_ogre_technique_group.png" usemap="#OgreTechniqueGroup_map" border="0" alt=""></center>
25<map name="OgreTechniqueGroup_map">
26<area href="class_technique_group.html" alt="TechniqueGroup" shape="rect" coords="0,0,134,24">
27</map>
28<a href="class_ogre_technique_group-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
29<tr><td></td></tr>
30<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#2c4140ede5876460df41b108fb0b741d">addRenderTechnique</a> (<a class="el" href="class_render_technique.html">RenderTechnique</a> *technique)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a rendertechnique to the group.  <a href="#2c4140ede5876460df41b108fb0b741d"></a><br></td></tr>
34<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#94e7551f2d53b1cc54c5e8e1d1142b08">update</a> (unsigned long frameNum)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates all rendertechniques.  <a href="#94e7551f2d53b1cc54c5e8e1d1142b08"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#8a082b0ff103272a7d02bd90fb749375">runChanged</a> (RenderingRunType runType, <a class="el" href="class_rendering_run.html">RenderingRun</a> *run)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after one of he shared runs changes.  <a href="#8a082b0ff103272a7d02bd90fb749375"></a><br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#8b5acd490af14da7e88eebde691e1f7f">runUpdated</a> (RenderingRunType runType, <a class="el" href="class_rendering_run.html">RenderingRun</a> *run)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after one of he shared runs updates.  <a href="#8b5acd490af14da7e88eebde691e1f7f"></a><br></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2410c52a0a6304375bd95615a7e293b3"></a><!-- doxytag: member="OgreTechniqueGroup::updateBounds" ref="2410c52a0a6304375bd95615a7e293b3" args="()" -->
44void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#2410c52a0a6304375bd95615a7e293b3">updateBounds</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the connected <a class="el" href="class_shared_runs.html">SharedRuns</a> boundary. <br></td></tr>
47<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; <a class="el" href="class_ogre_render_technique.html">OgreRenderTechnique</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_technique_group.html#59a51c2dadacc5bdc4ee3bea2c556050">renderTechniques</a></td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Collection of OgreRenderTechniques.  <a href="#59a51c2dadacc5bdc4ee3bea2c556050"></a><br></td></tr>
51</table>
52<hr><a name="_details"></a><h2>Detailed Description</h2>
53Base class of a <a class="el" href="class_shared_runs.html">SharedRuns</a> in an OGRE environment.
54<p>
55<hr><h2>Member Function Documentation</h2>
56<a class="anchor" name="2c4140ede5876460df41b108fb0b741d"></a><!-- doxytag: member="OgreTechniqueGroup::addRenderTechnique" ref="2c4140ede5876460df41b108fb0b741d" args="(RenderTechnique *technique)" --><p>
57<table class="mdTable" cellpadding="2" cellspacing="0">
58  <tr>
59    <td class="mdRow">
60      <table cellpadding="0" cellspacing="0" border="0">
61        <tr>
62          <td class="md" nowrap valign="top">void OgreTechniqueGroup::addRenderTechnique           </td>
63          <td class="md" valign="top">(&nbsp;</td>
64          <td class="md" nowrap valign="top"><a class="el" href="class_render_technique.html">RenderTechnique</a> *&nbsp;</td>
65          <td class="mdname1" valign="top" nowrap> <em>technique</em>          </td>
66          <td class="md" valign="top">&nbsp;)&nbsp;</td>
67          <td class="md" nowrap><code> [virtual]</code></td>
68        </tr>
69      </table>
70    </td>
71  </tr>
72</table>
73<table cellspacing="5" cellpadding="0" border="0">
74  <tr>
75    <td>
76      &nbsp;
77    </td>
78    <td>
79
80<p>
81Adds a rendertechnique to the group.
82<p>
83<dl compact><dt><b>Parameters:</b></dt><dd>
84  <table border="0" cellspacing="2" cellpadding="0">
85    <tr><td valign="top"></td><td valign="top"><em>technique</em>&nbsp;</td><td>the <a class="el" href="class_render_technique.html">RenderTechnique</a> instance to add. </td></tr>
86  </table>
87</dl>
88
89<p>
90Implements <a class="el" href="class_technique_group.html#6f15f8e4631e19a3a54dc0b37b9e8d86">TechniqueGroup</a>.    </td>
91  </tr>
92</table>
93<a class="anchor" name="8a082b0ff103272a7d02bd90fb749375"></a><!-- doxytag: member="OgreTechniqueGroup::runChanged" ref="8a082b0ff103272a7d02bd90fb749375" args="(RenderingRunType runType, RenderingRun *run)" --><p>
94<table class="mdTable" cellpadding="2" cellspacing="0">
95  <tr>
96    <td class="mdRow">
97      <table cellpadding="0" cellspacing="0" border="0">
98        <tr>
99          <td class="md" nowrap valign="top">void OgreTechniqueGroup::runChanged           </td>
100          <td class="md" valign="top">(&nbsp;</td>
101          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
102          <td class="mdname" nowrap> <em>runType</em>, </td>
103        </tr>
104        <tr>
105          <td class="md" nowrap align="right"></td>
106          <td class="md"></td>
107          <td class="md" nowrap><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
108          <td class="mdname" nowrap> <em>run</em></td>
109        </tr>
110        <tr>
111          <td class="md"></td>
112          <td class="md">)&nbsp;</td>
113          <td class="md" colspan="2"><code> [virtual]</code></td>
114        </tr>
115      </table>
116    </td>
117  </tr>
118</table>
119<table cellspacing="5" cellpadding="0" border="0">
120  <tr>
121    <td>
122      &nbsp;
123    </td>
124    <td>
125
126<p>
127Called after one of he shared runs changes.
128<p>
129This message will be forwarded to each RenderTechique.<p>
130<dl compact><dt><b>Parameters:</b></dt><dd>
131  <table border="0" cellspacing="2" cellpadding="0">
132    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>enum describing the type of the changed run </td></tr>
133    <tr><td valign="top"></td><td valign="top"><em>run</em>&nbsp;</td><td>pointer to the changed <a class="el" href="class_rendering_run.html">RenderingRun</a> </td></tr>
134  </table>
135</dl>
136
137<p>
138Implements <a class="el" href="class_technique_group.html#08c56a767f3bd47e694770199ee53577">TechniqueGroup</a>.    </td>
139  </tr>
140</table>
141<a class="anchor" name="8b5acd490af14da7e88eebde691e1f7f"></a><!-- doxytag: member="OgreTechniqueGroup::runUpdated" ref="8b5acd490af14da7e88eebde691e1f7f" args="(RenderingRunType runType, RenderingRun *run)" --><p>
142<table class="mdTable" cellpadding="2" cellspacing="0">
143  <tr>
144    <td class="mdRow">
145      <table cellpadding="0" cellspacing="0" border="0">
146        <tr>
147          <td class="md" nowrap valign="top">void OgreTechniqueGroup::runUpdated           </td>
148          <td class="md" valign="top">(&nbsp;</td>
149          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
150          <td class="mdname" nowrap> <em>runType</em>, </td>
151        </tr>
152        <tr>
153          <td class="md" nowrap align="right"></td>
154          <td class="md"></td>
155          <td class="md" nowrap><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
156          <td class="mdname" nowrap> <em>run</em></td>
157        </tr>
158        <tr>
159          <td class="md"></td>
160          <td class="md">)&nbsp;</td>
161          <td class="md" colspan="2"><code> [virtual]</code></td>
162        </tr>
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing="5" cellpadding="0" border="0">
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175Called after one of he shared runs updates.
176<p>
177This message will be forwarded to each RenderTechique.<p>
178<dl compact><dt><b>Parameters:</b></dt><dd>
179  <table border="0" cellspacing="2" cellpadding="0">
180    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>enum describing the type of the updated run </td></tr>
181    <tr><td valign="top"></td><td valign="top"><em>run</em>&nbsp;</td><td>pointer to the updated <a class="el" href="class_rendering_run.html">RenderingRun</a> </td></tr>
182  </table>
183</dl>
184
185<p>
186Implements <a class="el" href="class_technique_group.html#990f2d8acbd75a1c011b057bfd2f14d3">TechniqueGroup</a>.    </td>
187  </tr>
188</table>
189<a class="anchor" name="94e7551f2d53b1cc54c5e8e1d1142b08"></a><!-- doxytag: member="OgreTechniqueGroup::update" ref="94e7551f2d53b1cc54c5e8e1d1142b08" args="(unsigned long frameNum)" --><p>
190<table class="mdTable" cellpadding="2" cellspacing="0">
191  <tr>
192    <td class="mdRow">
193      <table cellpadding="0" cellspacing="0" border="0">
194        <tr>
195          <td class="md" nowrap valign="top">void OgreTechniqueGroup::update           </td>
196          <td class="md" valign="top">(&nbsp;</td>
197          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
198          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
199          <td class="md" valign="top">&nbsp;)&nbsp;</td>
200          <td class="md" nowrap><code> [virtual]</code></td>
201        </tr>
202      </table>
203    </td>
204  </tr>
205</table>
206<table cellspacing="5" cellpadding="0" border="0">
207  <tr>
208    <td>
209      &nbsp;
210    </td>
211    <td>
212
213<p>
214Updates all rendertechniques.
215<p>
216<dl compact><dt><b>Parameters:</b></dt><dd>
217  <table border="0" cellspacing="2" cellpadding="0">
218    <tr><td valign="top"></td><td valign="top"><em>framenum</em>&nbsp;</td><td>current framenumber </td></tr>
219  </table>
220</dl>
221
222<p>
223Implements <a class="el" href="class_technique_group.html#ad1175c21c8a650433054e9b83bd7bef">TechniqueGroup</a>.    </td>
224  </tr>
225</table>
226<hr><h2>Member Data Documentation</h2>
227<a class="anchor" name="59a51c2dadacc5bdc4ee3bea2c556050"></a><!-- doxytag: member="OgreTechniqueGroup::renderTechniques" ref="59a51c2dadacc5bdc4ee3bea2c556050" args="" --><p>
228<table class="mdTable" cellpadding="2" cellspacing="0">
229  <tr>
230    <td class="mdRow">
231      <table cellpadding="0" cellspacing="0" border="0">
232        <tr>
233          <td class="md" nowrap valign="top">std::vector&lt;<a class="el" href="class_ogre_render_technique.html">OgreRenderTechnique</a>*&gt; <a class="el" href="class_ogre_technique_group.html#59a51c2dadacc5bdc4ee3bea2c556050">OgreTechniqueGroup::renderTechniques</a><code> [protected]</code>          </td>
234        </tr>
235      </table>
236    </td>
237  </tr>
238</table>
239<table cellspacing="5" cellpadding="0" border="0">
240  <tr>
241    <td>
242      &nbsp;
243    </td>
244    <td>
245
246<p>
247Collection of OgreRenderTechniques.
248<p>
249All messages will be forwarded to each element of this vector.     </td>
250  </tr>
251</table>
252<hr>The documentation for this class was generated from the following files:<ul>
253<li>OgreTechniqueGroup.h<li>OgreTechniqueGroup.cpp</ul>
254<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:42 2006 for GameTools Illumination Module by&nbsp;
255<a href="http://www.doxygen.org/index.html">
256<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
257</body>
258</html>
Note: See TracBrowser for help on using the repository browser.