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

Revision 894, 16.4 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: TechniqueGroup 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>TechniqueGroup Class Reference</h1><!-- doxytag: class="TechniqueGroup" -->Base abstract class for a collection techniques. 
21<a href="#_details">More...</a>
22<p>
23<p>Inheritance diagram for TechniqueGroup:
24<p><center><img src="class_technique_group.png" usemap="#TechniqueGroup_map" border="0" alt=""></center>
25<map name="TechniqueGroup_map">
26<area href="class_ogre_technique_group.html" alt="OgreTechniqueGroup" shape="rect" coords="0,56,134,80">
27</map>
28<a href="class_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"><a class="anchor" name="78a953fbdc089bd16780738f1b9e2d68"></a><!-- doxytag: member="TechniqueGroup::TechniqueGroup" ref="78a953fbdc089bd16780738f1b9e2d68" args="(void)" -->
32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#78a953fbdc089bd16780738f1b9e2d68">TechniqueGroup</a> (void)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#ad80497fa5aab64053d6317fa103f8d6">addSharedRun</a> (<a class="el" href="class_shared_runs.html">SharedRuns</a> *sharedRuns)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds an empty <a class="el" href="class_shared_runs.html">SharedRuns</a> parent.  <a href="#ad80497fa5aab64053d6317fa103f8d6"></a><br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#90c28dd1d4d0c3ee1f75c885ab83679e">getSharedRuns</a> ()</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the shared runs.  <a href="#90c28dd1d4d0c3ee1f75c885ab83679e"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#6f15f8e4631e19a3a54dc0b37b9e8d86">addRenderTechnique</a> (<a class="el" href="class_render_technique.html">RenderTechnique</a> *technique)=0</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a rendertechnique to the group.  <a href="#6f15f8e4631e19a3a54dc0b37b9e8d86"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#ad1175c21c8a650433054e9b83bd7bef">update</a> (unsigned long frameNum)=0</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates all rendertechniques.  <a href="#ad1175c21c8a650433054e9b83bd7bef"></a><br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#08c56a767f3bd47e694770199ee53577">runChanged</a> (RenderingRunType runType, <a class="el" href="class_rendering_run.html">RenderingRun</a> *run)=0</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after one of he shared runs changes.  <a href="#08c56a767f3bd47e694770199ee53577"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#990f2d8acbd75a1c011b057bfd2f14d3">runUpdated</a> (RenderingRunType runType, <a class="el" href="class_rendering_run.html">RenderingRun</a> *run)=0</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after one of he shared runs updates.  <a href="#990f2d8acbd75a1c011b057bfd2f14d3"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="abeee1f706938feb51682591ef465dff"></a><!-- doxytag: member="TechniqueGroup::updateBounds" ref="abeee1f706938feb51682591ef465dff" args="()" -->
54virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#abeee1f706938feb51682591ef465dff">updateBounds</a> ()</td></tr>
55
56<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>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a1de216a2235f77ebe999e4f9f7f9dd"></a><!-- doxytag: member="TechniqueGroup::validateSharedRuns" ref="5a1de216a2235f77ebe999e4f9f7f9dd" args="()" -->
58virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#5a1de216a2235f77ebe999e4f9f7f9dd">validateSharedRuns</a> ()</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Validates the connected <a class="el" href="class_shared_runs.html">SharedRuns</a> instance. <br></td></tr>
61<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95897182f3831e4a20ce42e3a0777576"></a><!-- doxytag: member="TechniqueGroup::parentSharedRuns" ref="95897182f3831e4a20ce42e3a0777576" args="" -->
63<a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_technique_group.html#95897182f3831e4a20ce42e3a0777576">parentSharedRuns</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the connected <a class="el" href="class_shared_runs.html">SharedRuns</a> instance each technique uses. <br></td></tr>
66</table>
67<hr><a name="_details"></a><h2>Detailed Description</h2>
68Base abstract class for a collection techniques.
69<p>
70This is a helper class, to collect <a class="el" href="class_render_technique.html">RenderTechnique</a> instances bound to a single renderable. It's main task is to recieve and forward messages to each <a class="el" href="class_render_technique.html">RenderTechnique</a>.
71<p>
72<hr><h2>Member Function Documentation</h2>
73<a class="anchor" name="6f15f8e4631e19a3a54dc0b37b9e8d86"></a><!-- doxytag: member="TechniqueGroup::addRenderTechnique" ref="6f15f8e4631e19a3a54dc0b37b9e8d86" args="(RenderTechnique *technique)=0" --><p>
74<table class="mdTable" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top">virtual void TechniqueGroup::addRenderTechnique           </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="md" nowrap valign="top"><a class="el" href="class_render_technique.html">RenderTechnique</a> *&nbsp;</td>
82          <td class="mdname1" valign="top" nowrap> <em>technique</em>          </td>
83          <td class="md" valign="top">&nbsp;)&nbsp;</td>
84          <td class="md" nowrap><code> [pure virtual]</code></td>
85        </tr>
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing="5" cellpadding="0" border="0">
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98Adds a rendertechnique to the group.
99<p>
100<dl compact><dt><b>Parameters:</b></dt><dd>
101  <table border="0" cellspacing="2" cellpadding="0">
102    <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>
103  </table>
104</dl>
105
106<p>
107Implemented in <a class="el" href="class_ogre_technique_group.html#2c4140ede5876460df41b108fb0b741d">OgreTechniqueGroup</a>.    </td>
108  </tr>
109</table>
110<a class="anchor" name="ad80497fa5aab64053d6317fa103f8d6"></a><!-- doxytag: member="TechniqueGroup::addSharedRun" ref="ad80497fa5aab64053d6317fa103f8d6" args="(SharedRuns *sharedRuns)" --><p>
111<table class="mdTable" cellpadding="2" cellspacing="0">
112  <tr>
113    <td class="mdRow">
114      <table cellpadding="0" cellspacing="0" border="0">
115        <tr>
116          <td class="md" nowrap valign="top">void TechniqueGroup::addSharedRun           </td>
117          <td class="md" valign="top">(&nbsp;</td>
118          <td class="md" nowrap valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a> *&nbsp;</td>
119          <td class="mdname1" valign="top" nowrap> <em>sharedRuns</em>          </td>
120          <td class="md" valign="top">&nbsp;)&nbsp;</td>
121          <td class="md" nowrap><code> [inline]</code></td>
122        </tr>
123      </table>
124    </td>
125  </tr>
126</table>
127<table cellspacing="5" cellpadding="0" border="0">
128  <tr>
129    <td>
130      &nbsp;
131    </td>
132    <td>
133
134<p>
135Adds an empty <a class="el" href="class_shared_runs.html">SharedRuns</a> parent.
136<p>
137Used after creating a new <a class="el" href="class_technique_group.html">TechniqueGroup</a>.<p>
138<dl compact><dt><b>Parameters:</b></dt><dd>
139  <table border="0" cellspacing="2" cellpadding="0">
140    <tr><td valign="top"></td><td valign="top"><em>sharedRuns</em>&nbsp;</td><td>the SharedRun instance the RenderTechniques will use. </td></tr>
141  </table>
142</dl>
143    </td>
144  </tr>
145</table>
146<a class="anchor" name="90c28dd1d4d0c3ee1f75c885ab83679e"></a><!-- doxytag: member="TechniqueGroup::getSharedRuns" ref="90c28dd1d4d0c3ee1f75c885ab83679e" args="()" --><p>
147<table class="mdTable" cellpadding="2" cellspacing="0">
148  <tr>
149    <td class="mdRow">
150      <table cellpadding="0" cellspacing="0" border="0">
151        <tr>
152          <td class="md" nowrap valign="top"><a class="el" href="class_shared_runs.html">SharedRuns</a>* TechniqueGroup::getSharedRuns           </td>
153          <td class="md" valign="top">(&nbsp;</td>
154          <td class="mdname1" valign="top" nowrap>          </td>
155          <td class="md" valign="top">&nbsp;)&nbsp;</td>
156          <td class="md" nowrap><code> [inline]</code></td>
157        </tr>
158      </table>
159    </td>
160  </tr>
161</table>
162<table cellspacing="5" cellpadding="0" border="0">
163  <tr>
164    <td>
165      &nbsp;
166    </td>
167    <td>
168
169<p>
170Retrieves the shared runs.
171<p>
172<dl compact><dt><b>Returns:</b></dt><dd>the SharedRun instance the RenderTechniques use. </dd></dl>
173    </td>
174  </tr>
175</table>
176<a class="anchor" name="08c56a767f3bd47e694770199ee53577"></a><!-- doxytag: member="TechniqueGroup::runChanged" ref="08c56a767f3bd47e694770199ee53577" args="(RenderingRunType runType, RenderingRun *run)=0" --><p>
177<table class="mdTable" cellpadding="2" cellspacing="0">
178  <tr>
179    <td class="mdRow">
180      <table cellpadding="0" cellspacing="0" border="0">
181        <tr>
182          <td class="md" nowrap valign="top">virtual void TechniqueGroup::runChanged           </td>
183          <td class="md" valign="top">(&nbsp;</td>
184          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
185          <td class="mdname" nowrap> <em>runType</em>, </td>
186        </tr>
187        <tr>
188          <td class="md" nowrap align="right"></td>
189          <td class="md"></td>
190          <td class="md" nowrap><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
191          <td class="mdname" nowrap> <em>run</em></td>
192        </tr>
193        <tr>
194          <td class="md"></td>
195          <td class="md">)&nbsp;</td>
196          <td class="md" colspan="2"><code> [pure virtual]</code></td>
197        </tr>
198      </table>
199    </td>
200  </tr>
201</table>
202<table cellspacing="5" cellpadding="0" border="0">
203  <tr>
204    <td>
205      &nbsp;
206    </td>
207    <td>
208
209<p>
210Called after one of he shared runs changes.
211<p>
212This message will be forwarded to each RenderTechique.<p>
213<dl compact><dt><b>Parameters:</b></dt><dd>
214  <table border="0" cellspacing="2" cellpadding="0">
215    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>enum describing the type of the changed run </td></tr>
216    <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>
217  </table>
218</dl>
219
220<p>
221Implemented in <a class="el" href="class_ogre_technique_group.html#8a082b0ff103272a7d02bd90fb749375">OgreTechniqueGroup</a>.    </td>
222  </tr>
223</table>
224<a class="anchor" name="990f2d8acbd75a1c011b057bfd2f14d3"></a><!-- doxytag: member="TechniqueGroup::runUpdated" ref="990f2d8acbd75a1c011b057bfd2f14d3" args="(RenderingRunType runType, RenderingRun *run)=0" --><p>
225<table class="mdTable" cellpadding="2" cellspacing="0">
226  <tr>
227    <td class="mdRow">
228      <table cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td class="md" nowrap valign="top">virtual void TechniqueGroup::runUpdated           </td>
231          <td class="md" valign="top">(&nbsp;</td>
232          <td class="md" nowrap valign="top">RenderingRunType&nbsp;</td>
233          <td class="mdname" nowrap> <em>runType</em>, </td>
234        </tr>
235        <tr>
236          <td class="md" nowrap align="right"></td>
237          <td class="md"></td>
238          <td class="md" nowrap><a class="el" href="class_rendering_run.html">RenderingRun</a> *&nbsp;</td>
239          <td class="mdname" nowrap> <em>run</em></td>
240        </tr>
241        <tr>
242          <td class="md"></td>
243          <td class="md">)&nbsp;</td>
244          <td class="md" colspan="2"><code> [pure virtual]</code></td>
245        </tr>
246      </table>
247    </td>
248  </tr>
249</table>
250<table cellspacing="5" cellpadding="0" border="0">
251  <tr>
252    <td>
253      &nbsp;
254    </td>
255    <td>
256
257<p>
258Called after one of he shared runs updates.
259<p>
260This message will be forwarded to each RenderTechique.<p>
261<dl compact><dt><b>Parameters:</b></dt><dd>
262  <table border="0" cellspacing="2" cellpadding="0">
263    <tr><td valign="top"></td><td valign="top"><em>runType</em>&nbsp;</td><td>enum describing the type of the updated run </td></tr>
264    <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>
265  </table>
266</dl>
267
268<p>
269Implemented in <a class="el" href="class_ogre_technique_group.html#8b5acd490af14da7e88eebde691e1f7f">OgreTechniqueGroup</a>.    </td>
270  </tr>
271</table>
272<a class="anchor" name="ad1175c21c8a650433054e9b83bd7bef"></a><!-- doxytag: member="TechniqueGroup::update" ref="ad1175c21c8a650433054e9b83bd7bef" args="(unsigned long frameNum)=0" --><p>
273<table class="mdTable" cellpadding="2" cellspacing="0">
274  <tr>
275    <td class="mdRow">
276      <table cellpadding="0" cellspacing="0" border="0">
277        <tr>
278          <td class="md" nowrap valign="top">virtual void TechniqueGroup::update           </td>
279          <td class="md" valign="top">(&nbsp;</td>
280          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
281          <td class="mdname1" valign="top" nowrap> <em>frameNum</em>          </td>
282          <td class="md" valign="top">&nbsp;)&nbsp;</td>
283          <td class="md" nowrap><code> [pure virtual]</code></td>
284        </tr>
285      </table>
286    </td>
287  </tr>
288</table>
289<table cellspacing="5" cellpadding="0" border="0">
290  <tr>
291    <td>
292      &nbsp;
293    </td>
294    <td>
295
296<p>
297Updates all rendertechniques.
298<p>
299<dl compact><dt><b>Parameters:</b></dt><dd>
300  <table border="0" cellspacing="2" cellpadding="0">
301    <tr><td valign="top"></td><td valign="top"><em>framenum</em>&nbsp;</td><td>current framenumber </td></tr>
302  </table>
303</dl>
304
305<p>
306Implemented in <a class="el" href="class_ogre_technique_group.html#94e7551f2d53b1cc54c5e8e1d1142b08">OgreTechniqueGroup</a>.    </td>
307  </tr>
308</table>
309<hr>The documentation for this class was generated from the following files:<ul>
310<li>TechniqueGroup.h<li>TechniqueGroup.cpp</ul>
311<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:43 2006 for GameTools Illumination Module by&nbsp;
312<a href="http://www.doxygen.org/index.html">
313<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
314</body>
315</html>
Note: See TracBrowser for help on using the repository browser.