source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1StringInterface.html @ 657

Revision 657, 30.4 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::StringInterface class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::StringInterface Class Reference</h1>Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::StringInterface:
16<p><center><img src="classOgre_1_1StringInterface.png" usemap="#Ogre::StringInterface_map" border="0" alt=""></center>
17<map name="Ogre::StringInterface_map">
18<area href="classOgre_1_1ExternalTextureSource.html" alt="Ogre::ExternalTextureSource" shape="rect" coords="0,56,195,80">
19<area href="classOgre_1_1OverlayElement.html" alt="Ogre::OverlayElement" shape="rect" coords="205,56,400,80">
20<area href="classOgre_1_1ParticleAffector.html" alt="Ogre::ParticleAffector" shape="rect" coords="615,56,810,80">
21<area href="classOgre_1_1ParticleEmitter.html" alt="Ogre::ParticleEmitter" shape="rect" coords="1025,56,1220,80">
22<area href="classOgre_1_1ParticleSystem.html" alt="Ogre::ParticleSystem" shape="rect" coords="1230,56,1425,80">
23<area href="classOgre_1_1ParticleSystemRenderer.html" alt="Ogre::ParticleSystemRenderer" shape="rect" coords="1435,56,1630,80">
24<area href="classOgre_1_1Resource.html" alt="Ogre::Resource" shape="rect" coords="1640,56,1835,80">
25<area href="classOgre_1_1OverlayContainer.html" alt="Ogre::OverlayContainer" shape="rect" coords="410,112,605,136">
26<area href="classOgre_1_1TextAreaOverlayElement.html" alt="Ogre::TextAreaOverlayElement" shape="rect" coords="410,168,605,192">
27<area href="classOgre_1_1ColourFaderAffector.html" alt="Ogre::ColourFaderAffector" shape="rect" coords="820,112,1015,136">
28<area href="classOgre_1_1ColourFaderAffector2.html" alt="Ogre::ColourFaderAffector2" shape="rect" coords="820,168,1015,192">
29<area href="classOgre_1_1ColourImageAffector.html" alt="Ogre::ColourImageAffector" shape="rect" coords="820,224,1015,248">
30<area href="classOgre_1_1ColourInterpolatorAffector.html" alt="Ogre::ColourInterpolatorAffector" shape="rect" coords="820,280,1015,304">
31<area href="classOgre_1_1LinearForceAffector.html" alt="Ogre::LinearForceAffector" shape="rect" coords="820,336,1015,360">
32<area href="classOgre_1_1RotationAffector.html" alt="Ogre::RotationAffector" shape="rect" coords="820,392,1015,416">
33<area href="classOgre_1_1ScaleAffector.html" alt="Ogre::ScaleAffector" shape="rect" coords="820,448,1015,472">
34<area href="classOgre_1_1AreaEmitter.html" alt="Ogre::AreaEmitter" shape="rect" coords="1230,112,1425,136">
35<area href="classOgre_1_1PointEmitter.html" alt="Ogre::PointEmitter" shape="rect" coords="1230,168,1425,192">
36<area href="classOgre_1_1BillboardParticleRenderer.html" alt="Ogre::BillboardParticleRenderer" shape="rect" coords="1435,112,1630,136">
37<area href="classOgre_1_1BspLevel.html" alt="Ogre::BspLevel" shape="rect" coords="1845,112,2040,136">
38<area href="classOgre_1_1Font.html" alt="Ogre::Font" shape="rect" coords="1845,168,2040,192">
39<area href="classOgre_1_1GpuProgram.html" alt="Ogre::GpuProgram" shape="rect" coords="1845,224,2040,248">
40<area href="classOgre_1_1Material.html" alt="Ogre::Material" shape="rect" coords="1845,280,2040,304">
41<area href="classOgre_1_1Mesh.html" alt="Ogre::Mesh" shape="rect" coords="1845,336,2040,360">
42<area href="classOgre_1_1Skeleton.html" alt="Ogre::Skeleton" shape="rect" coords="1845,392,2040,416">
43<area href="classOgre_1_1Texture.html" alt="Ogre::Texture" shape="rect" coords="1845,448,2040,472">
44</map>
45<a href="classOgre_1_1StringInterface-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
46<tr><td></td></tr>
47<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1StringInterfacea0">~StringInterface</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual desctructor, see Effective C++.  <a href="#Ogre_1_1StringInterfacea0"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea44">getParamDictionary</a> (void)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea44"></a><br><br></td></tr>
54<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea45">getParamDictionary</a> (void) const </td></tr>
55
56<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a518">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">getParameters</a> (void) const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea46"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">setParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;value)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;paramList)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea49">getParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name) const </td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
71<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
72<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturee0">cleanupDictionary</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.  <a href="#Ogre_1_1Texturee0"></a><br><br></td></tr>
75<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
76<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Textureb6">createParamDictionary</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;className)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for creating a parameter dictionary for the class, if it does not already exist.  <a href="#Ogre_1_1Textureb6"></a><br><br></td></tr>
79<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class name for this instance to be used as a lookup (must be initialised by subclasses).  <a href="#Ogre_1_1Texturep26"></a><br><br></td></tr>
83<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
87</table>
88<hr><a name="_details"></a><h2>Detailed Description</h2>
89Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
90<p>
91<dl compact><dt><b>Remarks:</b></dt><dd>This class also holds a static map of class name to parameter dictionaries for each subclass to use. See <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> for details. <p>
92In order to use this class, each subclass must call createParamDictionary in their constructors which will create a parameter dictionary for the class if it does not exist yet. </dd></dl>
93
94<p>
95
96<p>
97Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00152">152</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
98<a class="anchor" name="Ogre_1_1StringInterfacea0" doxytag="Ogre::StringInterface::~StringInterface" ></a><p>
99<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
100  <tr>
101    <td class="mdRow">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="md" nowrap valign="top"> virtual Ogre::StringInterface::~<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> </td>
105          <td class="md" valign="top">(&nbsp;</td>
106          <td class="mdname1" valign="top" nowrap>          </td>
107          <td class="md" valign="top">&nbsp;)&nbsp;</td>
108          <td class="md" nowrap><code> [virtual]</code></td>
109        </tr>
110
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Virtual desctructor, see Effective C++.
124<p>
125
126<p>
127Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00187">187</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
128  </tr>
129</table>
130<hr><h2>Member Function Documentation</h2>
131<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::StringInterface::cleanupDictionary" ></a><p>
132<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
133  <tr>
134    <td class="mdRow">
135      <table cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
138          <td class="md" valign="top">(&nbsp;</td>
139          <td class="mdname1" valign="top" nowrap>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap><code> [static]</code></td>
142        </tr>
143
144      </table>
145    </td>
146  </tr>
147</table>
148<table cellspacing=5 cellpadding=0 border=0>
149  <tr>
150    <td>
151      &nbsp;
152    </td>
153    <td>
154
155<p>
156Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.
157<p>
158<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
159  </tr>
160</table>
161<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::StringInterface::copyParametersTo" ></a><p>
162<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
168          <td class="md" valign="top">(&nbsp;</td>
169          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
170          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
171          <td class="md" valign="top">&nbsp;)&nbsp;</td>
172          <td class="md" nowrap> const<code> [virtual]</code></td>
173        </tr>
174
175      </table>
176    </td>
177  </tr>
178</table>
179<table cellspacing=5 cellpadding=0 border=0>
180  <tr>
181    <td>
182      &nbsp;
183    </td>
184    <td>
185
186<p>
187Method for copying this object's parameters to another object.
188<p>
189<dl compact><dt><b>Remarks:</b></dt><dd>This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. </dd></dl>
190<dl compact><dt><b></b></dt><dd>Any unrecognised parameters will be ignored as with setParameter method. </dd></dl>
191<dl compact><dt><b>Parameters:</b></dt><dd>
192  <table border="0" cellspacing="2" cellpadding="0">
193    <tr><td valign=top><em>dest</em>&nbsp;</td><td>Pointer to object to have it's parameters set the same as this object. </td></tr>
194  </table>
195</dl>
196
197<p>
198Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00296">296</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
199<p>
200References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">setParameter()</a>.    </td>
201  </tr>
202</table>
203<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::StringInterface::createParamDictionary" ></a><p>
204<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
205  <tr>
206    <td class="mdRow">
207      <table cellpadding="0" cellspacing="0" border="0">
208        <tr>
209          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
210          <td class="md" valign="top">(&nbsp;</td>
211          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
212          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
213          <td class="md" valign="top">&nbsp;)&nbsp;</td>
214          <td class="md" nowrap><code> [protected]</code></td>
215        </tr>
216
217      </table>
218    </td>
219  </tr>
220</table>
221<table cellspacing=5 cellpadding=0 border=0>
222  <tr>
223    <td>
224      &nbsp;
225    </td>
226    <td>
227
228<p>
229Internal method for creating a parameter dictionary for the class, if it does not already exist.
230<p>
231<dl compact><dt><b>Remarks:</b></dt><dd>This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance). </dd></dl>
232<dl compact><dt><b>Parameters:</b></dt><dd>
233  <table border="0" cellspacing="2" cellpadding="0">
234    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
235  </table>
236</dl>
237<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
238
239<p>
240Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00172">172</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
241<p>
242References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
243  </tr>
244</table>
245<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::StringInterface::getParamDictionary" ></a><p>
246<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
247  <tr>
248    <td class="mdRow">
249      <table cellpadding="0" cellspacing="0" border="0">
250        <tr>
251          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
252          <td class="md" valign="top">(&nbsp;</td>
253          <td class="md" nowrap valign="top">void&nbsp;</td>
254          <td class="mdname1" valign="top" nowrap>          </td>
255          <td class="md" valign="top">&nbsp;)&nbsp;</td>
256          <td class="md" nowrap> const</td>
257        </tr>
258
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>
271
272<p>
273Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00209">209</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
274  </tr>
275</table>
276<a class="anchor" name="Ogre_1_1Texturea44" doxytag="Ogre::StringInterface::getParamDictionary" ></a><p>
277<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
278  <tr>
279    <td class="mdRow">
280      <table cellpadding="0" cellspacing="0" border="0">
281        <tr>
282          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
283          <td class="md" valign="top">(&nbsp;</td>
284          <td class="md" nowrap valign="top">void&nbsp;</td>
285          <td class="mdname1" valign="top" nowrap>          </td>
286          <td class="md" valign="top">&nbsp;)&nbsp;</td>
287          <td class="md" nowrap></td>
288        </tr>
289
290      </table>
291    </td>
292  </tr>
293</table>
294<table cellspacing=5 cellpadding=0 border=0>
295  <tr>
296    <td>
297      &nbsp;
298    </td>
299    <td>
300
301<p>
302Retrieves the parameter dictionary for this class.
303<p>
304<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
305<dl compact><dt><b>Returns:</b></dt><dd>Pointer to <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> shared by all instances of this class which you can add parameters to, retrieve parameters etc. </dd></dl>
306
307<p>
308Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00196">196</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
309  </tr>
310</table>
311<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::StringInterface::getParameter" ></a><p>
312<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
313  <tr>
314    <td class="mdRow">
315      <table cellpadding="0" cellspacing="0" border="0">
316        <tr>
317          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::StringInterface::getParameter </td>
318          <td class="md" valign="top">(&nbsp;</td>
319          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
320          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
321          <td class="md" valign="top">&nbsp;)&nbsp;</td>
322          <td class="md" nowrap> const<code> [virtual]</code></td>
323        </tr>
324
325      </table>
326    </td>
327  </tr>
328</table>
329<table cellspacing=5 cellpadding=0 border=0>
330  <tr>
331    <td>
332      &nbsp;
333    </td>
334    <td>
335
336<p>
337Generic parameter retrieval method.
338<p>
339<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> to convert this string back into a native type. </dd></dl>
340<dl compact><dt><b>Parameters:</b></dt><dd>
341  <table border="0" cellspacing="2" cellpadding="0">
342    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
343  </table>
344</dl>
345<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
346
347<p>
348Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00265">265</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
349<p>
350References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet()</a>, <a class="el" href="OgreStringInterface_8h-source.html#l00090">Ogre::ParamDictionary::getParamCommand()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
351  </tr>
352</table>
353<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::StringInterface::getParameters" ></a><p>
354<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
355  <tr>
356    <td class="mdRow">
357      <table cellpadding="0" cellspacing="0" border="0">
358        <tr>
359          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a518">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
360          <td class="md" valign="top">(&nbsp;</td>
361          <td class="md" nowrap valign="top">void&nbsp;</td>
362          <td class="mdname1" valign="top" nowrap>          </td>
363          <td class="md" valign="top">&nbsp;)&nbsp;</td>
364          <td class="md" nowrap> const</td>
365        </tr>
366
367      </table>
368    </td>
369  </tr>
370</table>
371<table cellspacing=5 cellpadding=0 border=0>
372  <tr>
373    <td>
374      &nbsp;
375    </td>
376    <td>
377
378<p>
379Retrieves a list of parameters valid for this object.
380<p>
381<dl compact><dt><b>Returns:</b></dt><dd>A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dd></dl>
382    </td>
383  </tr>
384</table>
385<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::StringInterface::setParameter" ></a><p>
386<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
394          <td class="mdname" nowrap> <em>name</em>, </td>
395        </tr>
396        <tr>
397          <td class="md" nowrap align="right"></td>
398          <td></td>
399          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
400          <td class="mdname" nowrap> <em>value</em></td>
401        </tr>
402        <tr>
403          <td></td>
404          <td class="md">)&nbsp;</td>
405          <td class="md" colspan="2"><code> [virtual]</code></td>
406        </tr>
407
408      </table>
409    </td>
410  </tr>
411</table>
412<table cellspacing=5 cellpadding=0 border=0>
413  <tr>
414    <td>
415      &nbsp;
416    </td>
417    <td>
418
419<p>
420Generic parameter setting method.
421<p>
422<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
423<dl compact><dt><b>Parameters:</b></dt><dd>
424  <table border="0" cellspacing="2" cellpadding="0">
425    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
426    <tr><td valign=top><em>value</em>&nbsp;</td><td>String value. Must be in the right format for the type specified in the parameter definition. See the <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> class for more information. </td></tr>
427  </table>
428</dl>
429<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
430
431<p>
432Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">copyParametersTo()</a>.    </td>
433  </tr>
434</table>
435<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::StringInterface::setParameterList" ></a><p>
436<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
437  <tr>
438    <td class="mdRow">
439      <table cellpadding="0" cellspacing="0" border="0">
440        <tr>
441          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
442          <td class="md" valign="top">(&nbsp;</td>
443          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;&nbsp;</td>
444          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
445          <td class="md" valign="top">&nbsp;)&nbsp;</td>
446          <td class="md" nowrap><code> [virtual]</code></td>
447        </tr>
448
449      </table>
450    </td>
451  </tr>
452</table>
453<table cellspacing=5 cellpadding=0 border=0>
454  <tr>
455    <td>
456      &nbsp;
457    </td>
458    <td>
459
460<p>
461Generic multiple parameter setting method.
462<p>
463<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
464<dl compact><dt><b>Parameters:</b></dt><dd>
465  <table border="0" cellspacing="2" cellpadding="0">
466    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
467  </table>
468</dl>
469    </td>
470  </tr>
471</table>
472<hr><h2>Member Data Documentation</h2>
473<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::StringInterface::mParamDictName" ></a><p>
474<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
475  <tr>
476    <td class="mdRow">
477      <table cellpadding="0" cellspacing="0" border="0">
478        <tr>
479          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected]</code>
480      </table>
481    </td>
482  </tr>
483</table>
484<table cellspacing=5 cellpadding=0 border=0>
485  <tr>
486    <td>
487      &nbsp;
488    </td>
489    <td>
490
491<p>
492Class name for this instance to be used as a lookup (must be initialised by subclasses).
493<p>
494
495<p>
496Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00160">160</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
497  </tr>
498</table>
499<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::StringInterface::msDictionary" ></a><p>
500<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
501  <tr>
502    <td class="mdRow">
503      <table cellpadding="0" cellspacing="0" border="0">
504        <tr>
505          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected]</code>
506      </table>
507    </td>
508  </tr>
509</table>
510<table cellspacing=5 cellpadding=0 border=0>
511  <tr>
512    <td>
513      &nbsp;
514    </td>
515    <td>
516
517<p>
518Dictionary of parameters.
519<p>
520
521<p>
522Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00157">157</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
523  </tr>
524</table>
525<hr>The documentation for this class was generated from the following file:<ul>
526<li><a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a></ul>
527<hr>
528<p>
529Copyright &copy; 2000-2005 by The OGRE Team<br />
530<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
531This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
532                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
533                <Work rdf:about="">
534                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
535        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
536                </Work>
537                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
538
539Last modified Sun Feb 12 13:04:10 2006
540</p>
541</body>
542</html>
Note: See TracBrowser for help on using the repository browser.