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

Revision 894, 11.1 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: RenderTechniqueFactory 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>RenderTechniqueFactory Class Reference</h1><!-- doxytag: class="RenderTechniqueFactory" -->Base abstract class for creating <a class="el" href="class_render_technique.html">RenderTechnique</a> instances. 
21<a href="#_details">More...</a>
22<p>
23<a href="class_render_technique_factory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
24<tr><td></td></tr>
25<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#456caae5bb8ed8033612d0819b73068c">isType</a> (String type)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns if this factory can create a <a class="el" href="class_render_technique.html">RenderTechnique</a> of the given type.  <a href="#456caae5bb8ed8033612d0819b73068c"></a><br></td></tr>
29<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_ogre_render_technique.html">OgreRenderTechnique</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#957cfcc225fee1db5341e9585eabc5a3">createInstance</a> (IllumTechniqueParams *params, Pass *pass, <a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *parentRenderable, <a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *parentTechniqueGroup)=0</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a <a class="el" href="class_render_technique.html">RenderTechnique</a> of the factory type.  <a href="#957cfcc225fee1db5341e9585eabc5a3"></a><br></td></tr>
32<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#114cbcd56280b343e3daf53d52ccec04">ILLUM_ATTRIBUTE_PARSER</a> )(String &amp;params, <a class="el" href="class_render_technique_factory.html">RenderTechniqueFactory</a> *factory)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function for parsing <a class="el" href="class_render_technique.html">RenderTechnique</a> attributes  <a href="#114cbcd56280b343e3daf53d52ccec04"></a><br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b069aae5b2942e72ed56326b3bf20c0"></a><!-- doxytag: member="RenderTechniqueFactory::AttribParserList" ref="7b069aae5b2942e72ed56326b3bf20c0" args="" -->
37typedef std::map&lt; String,<br>
38 <a class="el" href="class_render_technique_factory.html#114cbcd56280b343e3daf53d52ccec04">ILLUM_ATTRIBUTE_PARSER</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#7b069aae5b2942e72ed56326b3bf20c0">AttribParserList</a></td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Keyword-mapped attribute parsers. <br></td></tr>
41<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d95c56553235c5e92232a9ceda819a41"></a><!-- doxytag: member="RenderTechniqueFactory::attributeParsers" ref="d95c56553235c5e92232a9ceda819a41" args="" -->
43<a class="el" href="class_render_technique_factory.html#7b069aae5b2942e72ed56326b3bf20c0">AttribParserList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#d95c56553235c5e92232a9ceda819a41">attributeParsers</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">map of parser functions <br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="210470e472928933eff647ab4d2ebce0"></a><!-- doxytag: member="RenderTechniqueFactory::typeName" ref="210470e472928933eff647ab4d2ebce0" args="" -->
47String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_render_technique_factory.html#210470e472928933eff647ab4d2ebce0">typeName</a></td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">factoryname <br></td></tr>
50</table>
51<hr><a name="_details"></a><h2>Detailed Description</h2>
52Base abstract class for creating <a class="el" href="class_render_technique.html">RenderTechnique</a> instances.
53<p>
54<hr><h2>Member Typedef Documentation</h2>
55<a class="anchor" name="114cbcd56280b343e3daf53d52ccec04"></a><!-- doxytag: member="RenderTechniqueFactory::ILLUM_ATTRIBUTE_PARSER" ref="114cbcd56280b343e3daf53d52ccec04" args=")(String &amp;params, RenderTechniqueFactory *factory)" --><p>
56<table class="mdTable" cellpadding="2" cellspacing="0">
57  <tr>
58    <td class="mdRow">
59      <table cellpadding="0" cellspacing="0" border="0">
60        <tr>
61          <td class="md" nowrap valign="top">typedef void(* <a class="el" href="class_render_technique_factory.html#114cbcd56280b343e3daf53d52ccec04">RenderTechniqueFactory::ILLUM_ATTRIBUTE_PARSER</a>)(String &amp;params, <a class="el" href="class_render_technique_factory.html">RenderTechniqueFactory</a> *factory)<code> [protected]</code>          </td>
62        </tr>
63      </table>
64    </td>
65  </tr>
66</table>
67<table cellspacing="5" cellpadding="0" border="0">
68  <tr>
69    <td>
70      &nbsp;
71    </td>
72    <td>
73
74<p>
75function for parsing <a class="el" href="class_render_technique.html">RenderTechnique</a> attributes
76<p>
77<dl compact><dt><b>Parameters:</b></dt><dd>
78  <table border="0" cellspacing="2" cellpadding="0">
79    <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>attribute value stored in a String </td></tr>
80  </table>
81</dl>
82    </td>
83  </tr>
84</table>
85<hr><h2>Member Function Documentation</h2>
86<a class="anchor" name="957cfcc225fee1db5341e9585eabc5a3"></a><!-- doxytag: member="RenderTechniqueFactory::createInstance" ref="957cfcc225fee1db5341e9585eabc5a3" args="(IllumTechniqueParams *params, Pass *pass, OgreRenderable *parentRenderable, OgreTechniqueGroup *parentTechniqueGroup)=0" --><p>
87<table class="mdTable" cellpadding="2" cellspacing="0">
88  <tr>
89    <td class="mdRow">
90      <table cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <td class="md" nowrap valign="top">virtual <a class="el" href="class_ogre_render_technique.html">OgreRenderTechnique</a>* RenderTechniqueFactory::createInstance           </td>
93          <td class="md" valign="top">(&nbsp;</td>
94          <td class="md" nowrap valign="top">IllumTechniqueParams *&nbsp;</td>
95          <td class="mdname" nowrap> <em>params</em>, </td>
96        </tr>
97        <tr>
98          <td class="md" nowrap align="right"></td>
99          <td class="md"></td>
100          <td class="md" nowrap>Pass *&nbsp;</td>
101          <td class="mdname" nowrap> <em>pass</em>, </td>
102        </tr>
103        <tr>
104          <td class="md" nowrap align="right"></td>
105          <td class="md"></td>
106          <td class="md" nowrap><a class="el" href="class_ogre_renderable.html">OgreRenderable</a> *&nbsp;</td>
107          <td class="mdname" nowrap> <em>parentRenderable</em>, </td>
108        </tr>
109        <tr>
110          <td class="md" nowrap align="right"></td>
111          <td class="md"></td>
112          <td class="md" nowrap><a class="el" href="class_ogre_technique_group.html">OgreTechniqueGroup</a> *&nbsp;</td>
113          <td class="mdname" nowrap> <em>parentTechniqueGroup</em></td>
114        </tr>
115        <tr>
116          <td class="md"></td>
117          <td class="md">)&nbsp;</td>
118          <td class="md" colspan="2"><code> [pure virtual]</code></td>
119        </tr>
120      </table>
121    </td>
122  </tr>
123</table>
124<table cellspacing="5" cellpadding="0" border="0">
125  <tr>
126    <td>
127      &nbsp;
128    </td>
129    <td>
130
131<p>
132Creates a <a class="el" href="class_render_technique.html">RenderTechnique</a> of the factory type.
133<p>
134<dl compact><dt><b>Parameters:</b></dt><dd>
135  <table border="0" cellspacing="2" cellpadding="0">
136    <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>containes constructor parameters as NameValuePairList </td></tr>
137    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the Pass to use in <a class="el" href="class_render_technique.html">RenderTechnique</a> constructor </td></tr>
138    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the parentRenderable to pass to <a class="el" href="class_render_technique.html">RenderTechnique</a> constructor </td></tr>
139    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the parentTechniqueGroup to pass to <a class="el" href="class_render_technique.html">RenderTechnique</a> constructor </td></tr>
140  </table>
141</dl>
142    </td>
143  </tr>
144</table>
145<a class="anchor" name="456caae5bb8ed8033612d0819b73068c"></a><!-- doxytag: member="RenderTechniqueFactory::isType" ref="456caae5bb8ed8033612d0819b73068c" args="(String type)" --><p>
146<table class="mdTable" cellpadding="2" cellspacing="0">
147  <tr>
148    <td class="mdRow">
149      <table cellpadding="0" cellspacing="0" border="0">
150        <tr>
151          <td class="md" nowrap valign="top">bool RenderTechniqueFactory::isType           </td>
152          <td class="md" valign="top">(&nbsp;</td>
153          <td class="md" nowrap valign="top">String&nbsp;</td>
154          <td class="mdname1" valign="top" nowrap> <em>type</em>          </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>
170Returns if this factory can create a <a class="el" href="class_render_technique.html">RenderTechnique</a> of the given type.
171<p>
172<dl compact><dt><b>Parameters:</b></dt><dd>
173  <table border="0" cellspacing="2" cellpadding="0">
174    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td><a class="el" href="class_render_technique.html">RenderTechnique</a> type </td></tr>
175  </table>
176</dl>
177    </td>
178  </tr>
179</table>
180<hr>The documentation for this class was generated from the following files:<ul>
181<li>OgreRenderTechnique.h<li>OgreRenderTechnique.cpp</ul>
182<hr size="1"><address style="align: right;"><small>Generated on Thu Apr 27 17:29:43 2006 for GameTools Illumination Module by&nbsp;
183<a href="http://www.doxygen.org/index.html">
184<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
185</body>
186</html>
Note: See TracBrowser for help on using the repository browser.