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

Revision 692, 30.8 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
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,210,80">
19<area href="classOgre_1_1OverlayElement.html" alt="Ogre::OverlayElement" shape="rect" coords="220,56,430,80">
20<area href="classOgre_1_1ParticleAffector.html" alt="Ogre::ParticleAffector" shape="rect" coords="660,56,870,80">
21<area href="classOgre_1_1ParticleEmitter.html" alt="Ogre::ParticleEmitter" shape="rect" coords="1100,56,1310,80">
22<area href="classOgre_1_1ParticleSystem.html" alt="Ogre::ParticleSystem" shape="rect" coords="1320,56,1530,80">
23<area href="classOgre_1_1ParticleSystemRenderer.html" alt="Ogre::ParticleSystemRenderer" shape="rect" coords="1540,56,1750,80">
24<area href="classOgre_1_1Resource.html" alt="Ogre::Resource" shape="rect" coords="1760,56,1970,80">
25<area href="classOgre_1_1OverlayContainer.html" alt="Ogre::OverlayContainer" shape="rect" coords="440,112,650,136">
26<area href="classOgre_1_1TextAreaOverlayElement.html" alt="Ogre::TextAreaOverlayElement" shape="rect" coords="440,168,650,192">
27<area href="classOgre_1_1ColourFaderAffector.html" alt="Ogre::ColourFaderAffector" shape="rect" coords="880,112,1090,136">
28<area href="classOgre_1_1ColourFaderAffector2.html" alt="Ogre::ColourFaderAffector2" shape="rect" coords="880,168,1090,192">
29<area href="classOgre_1_1ColourImageAffector.html" alt="Ogre::ColourImageAffector" shape="rect" coords="880,224,1090,248">
30<area href="classOgre_1_1ColourInterpolatorAffector.html" alt="Ogre::ColourInterpolatorAffector" shape="rect" coords="880,280,1090,304">
31<area href="classOgre_1_1DeflectorPlaneAffector.html" alt="Ogre::DeflectorPlaneAffector" shape="rect" coords="880,336,1090,360">
32<area href="classOgre_1_1DirectionRandomiserAffector.html" alt="Ogre::DirectionRandomiserAffector" shape="rect" coords="880,392,1090,416">
33<area href="classOgre_1_1LinearForceAffector.html" alt="Ogre::LinearForceAffector" shape="rect" coords="880,448,1090,472">
34<area href="classOgre_1_1RotationAffector.html" alt="Ogre::RotationAffector" shape="rect" coords="880,504,1090,528">
35<area href="classOgre_1_1ScaleAffector.html" alt="Ogre::ScaleAffector" shape="rect" coords="880,560,1090,584">
36<area href="classOgre_1_1AreaEmitter.html" alt="Ogre::AreaEmitter" shape="rect" coords="1320,112,1530,136">
37<area href="classOgre_1_1PointEmitter.html" alt="Ogre::PointEmitter" shape="rect" coords="1320,168,1530,192">
38<area href="classOgre_1_1BillboardParticleRenderer.html" alt="Ogre::BillboardParticleRenderer" shape="rect" coords="1540,112,1750,136">
39<area href="classOgre_1_1BspLevel.html" alt="Ogre::BspLevel" shape="rect" coords="1980,112,2190,136">
40<area href="classOgre_1_1Compositor.html" alt="Ogre::Compositor" shape="rect" coords="1980,168,2190,192">
41<area href="classOgre_1_1Font.html" alt="Ogre::Font" shape="rect" coords="1980,224,2190,248">
42<area href="classOgre_1_1GpuProgram.html" alt="Ogre::GpuProgram" shape="rect" coords="1980,280,2190,304">
43<area href="classOgre_1_1Material.html" alt="Ogre::Material" shape="rect" coords="1980,336,2190,360">
44<area href="classOgre_1_1Mesh.html" alt="Ogre::Mesh" shape="rect" coords="1980,392,2190,416">
45<area href="classOgre_1_1Skeleton.html" alt="Ogre::Skeleton" shape="rect" coords="1980,448,2190,472">
46<area href="classOgre_1_1Texture.html" alt="Ogre::Texture" shape="rect" coords="1980,504,2190,528">
47</map>
48<a href="classOgre_1_1StringInterface-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
49<tr><td></td></tr>
50<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
51<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>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual desctructor, see Effective C++.  <a href="#Ogre_1_1StringInterfacea0"></a><br><br></td></tr>
54<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_1Texturea45">getParamDictionary</a> (void)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea45"></a><br><br></td></tr>
57<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_1Texturea46">getParamDictionary</a> (void) const </td></tr>
58
59<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a563">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">getParameters</a> (void) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
62<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_1Texturea48">setParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;value)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
65<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_1Texturea49">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;paramList)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">getParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name) const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
71<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_1Texturea51">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea51"></a><br><br></td></tr>
74<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
75<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>
76
77<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>
78<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
79<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#a471">String</a> &amp;className)</td></tr>
80
81<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>
82<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
84
85<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>
86<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
90</table>
91<hr><a name="_details"></a><h2>Detailed Description</h2>
92Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
93<p>
94<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>
95In 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>
96
97<p>
98
99<p>
100Definition 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>
101<a class="anchor" name="Ogre_1_1StringInterfacea0" doxytag="Ogre::StringInterface::~StringInterface" ></a><p>
102<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
103  <tr>
104    <td class="mdRow">
105      <table cellpadding="0" cellspacing="0" border="0">
106        <tr>
107          <td class="md" nowrap valign="top"> virtual Ogre::StringInterface::~<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> </td>
108          <td class="md" valign="top">(&nbsp;</td>
109          <td class="mdname1" valign="top" nowrap>          </td>
110          <td class="md" valign="top">&nbsp;)&nbsp;</td>
111          <td class="md" nowrap><code> [virtual]</code></td>
112        </tr>
113
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing=5 cellpadding=0 border=0>
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126Virtual desctructor, see Effective C++.
127<p>
128
129<p>
130Definition 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>
131  </tr>
132</table>
133<hr><h2>Member Function Documentation</h2>
134<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::StringInterface::cleanupDictionary" ></a><p>
135<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136  <tr>
137    <td class="mdRow">
138      <table cellpadding="0" cellspacing="0" border="0">
139        <tr>
140          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
141          <td class="md" valign="top">(&nbsp;</td>
142          <td class="mdname1" valign="top" nowrap>          </td>
143          <td class="md" valign="top">&nbsp;)&nbsp;</td>
144          <td class="md" nowrap><code> [static]</code></td>
145        </tr>
146
147      </table>
148    </td>
149  </tr>
150</table>
151<table cellspacing=5 cellpadding=0 border=0>
152  <tr>
153    <td>
154      &nbsp;
155    </td>
156    <td>
157
158<p>
159Cleans 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.
160<p>
161<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
162  </tr>
163</table>
164<a class="anchor" name="Ogre_1_1Texturea51" doxytag="Ogre::StringInterface::copyParametersTo" ></a><p>
165<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
166  <tr>
167    <td class="mdRow">
168      <table cellpadding="0" cellspacing="0" border="0">
169        <tr>
170          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
171          <td class="md" valign="top">(&nbsp;</td>
172          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
173          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
174          <td class="md" valign="top">&nbsp;)&nbsp;</td>
175          <td class="md" nowrap> const<code> [virtual]</code></td>
176        </tr>
177
178      </table>
179    </td>
180  </tr>
181</table>
182<table cellspacing=5 cellpadding=0 border=0>
183  <tr>
184    <td>
185      &nbsp;
186    </td>
187    <td>
188
189<p>
190Method for copying this object's parameters to another object.
191<p>
192<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>
193<dl compact><dt><b></b></dt><dd><a class="el" href="classOgre_1_1Any.html">Any</a> unrecognised parameters will be ignored as with setParameter method. </dd></dl>
194<dl compact><dt><b>Parameters:</b></dt><dd>
195  <table border="0" cellspacing="2" cellpadding="0">
196    <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>
197  </table>
198</dl>
199
200<p>
201Definition 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>.
202<p>
203References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">setParameter()</a>.    </td>
204  </tr>
205</table>
206<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::StringInterface::createParamDictionary" ></a><p>
207<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
208  <tr>
209    <td class="mdRow">
210      <table cellpadding="0" cellspacing="0" border="0">
211        <tr>
212          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
213          <td class="md" valign="top">(&nbsp;</td>
214          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
215          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
216          <td class="md" valign="top">&nbsp;)&nbsp;</td>
217          <td class="md" nowrap><code> [protected]</code></td>
218        </tr>
219
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing=5 cellpadding=0 border=0>
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232Internal method for creating a parameter dictionary for the class, if it does not already exist.
233<p>
234<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>
235<dl compact><dt><b>Parameters:</b></dt><dd>
236  <table border="0" cellspacing="2" cellpadding="0">
237    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
238  </table>
239</dl>
240<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
241
242<p>
243Definition 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>.
244<p>
245References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
246  </tr>
247</table>
248<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::StringInterface::getParamDictionary" ></a><p>
249<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
250  <tr>
251    <td class="mdRow">
252      <table cellpadding="0" cellspacing="0" border="0">
253        <tr>
254          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
255          <td class="md" valign="top">(&nbsp;</td>
256          <td class="md" nowrap valign="top">void&nbsp;</td>
257          <td class="mdname1" valign="top" nowrap>          </td>
258          <td class="md" valign="top">&nbsp;)&nbsp;</td>
259          <td class="md" nowrap> const</td>
260        </tr>
261
262      </table>
263    </td>
264  </tr>
265</table>
266<table cellspacing=5 cellpadding=0 border=0>
267  <tr>
268    <td>
269      &nbsp;
270    </td>
271    <td>
272
273<p>
274
275<p>
276Definition 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>
277  </tr>
278</table>
279<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::StringInterface::getParamDictionary" ></a><p>
280<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
281  <tr>
282    <td class="mdRow">
283      <table cellpadding="0" cellspacing="0" border="0">
284        <tr>
285          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
286          <td class="md" valign="top">(&nbsp;</td>
287          <td class="md" nowrap valign="top">void&nbsp;</td>
288          <td class="mdname1" valign="top" nowrap>          </td>
289          <td class="md" valign="top">&nbsp;)&nbsp;</td>
290          <td class="md" nowrap></td>
291        </tr>
292
293      </table>
294    </td>
295  </tr>
296</table>
297<table cellspacing=5 cellpadding=0 border=0>
298  <tr>
299    <td>
300      &nbsp;
301    </td>
302    <td>
303
304<p>
305Retrieves the parameter dictionary for this class.
306<p>
307<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
308<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>
309
310<p>
311Definition 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>
312  </tr>
313</table>
314<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::StringInterface::getParameter" ></a><p>
315<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
316  <tr>
317    <td class="mdRow">
318      <table cellpadding="0" cellspacing="0" border="0">
319        <tr>
320          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::StringInterface::getParameter </td>
321          <td class="md" valign="top">(&nbsp;</td>
322          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
323          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
324          <td class="md" valign="top">&nbsp;)&nbsp;</td>
325          <td class="md" nowrap> const<code> [virtual]</code></td>
326        </tr>
327
328      </table>
329    </td>
330  </tr>
331</table>
332<table cellspacing=5 cellpadding=0 border=0>
333  <tr>
334    <td>
335      &nbsp;
336    </td>
337    <td>
338
339<p>
340Generic parameter retrieval method.
341<p>
342<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>
343<dl compact><dt><b>Parameters:</b></dt><dd>
344  <table border="0" cellspacing="2" cellpadding="0">
345    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
346  </table>
347</dl>
348<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
349
350<p>
351Definition 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>.
352<p>
353References <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#l00156">Ogre::String</a>.    </td>
354  </tr>
355</table>
356<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::StringInterface::getParameters" ></a><p>
357<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
358  <tr>
359    <td class="mdRow">
360      <table cellpadding="0" cellspacing="0" border="0">
361        <tr>
362          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a563">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
363          <td class="md" valign="top">(&nbsp;</td>
364          <td class="md" nowrap valign="top">void&nbsp;</td>
365          <td class="mdname1" valign="top" nowrap>          </td>
366          <td class="md" valign="top">&nbsp;)&nbsp;</td>
367          <td class="md" nowrap> const</td>
368        </tr>
369
370      </table>
371    </td>
372  </tr>
373</table>
374<table cellspacing=5 cellpadding=0 border=0>
375  <tr>
376    <td>
377      &nbsp;
378    </td>
379    <td>
380
381<p>
382Retrieves a list of parameters valid for this object.
383<p>
384<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>
385    </td>
386  </tr>
387</table>
388<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::StringInterface::setParameter" ></a><p>
389<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
390  <tr>
391    <td class="mdRow">
392      <table cellpadding="0" cellspacing="0" border="0">
393        <tr>
394          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
395          <td class="md" valign="top">(&nbsp;</td>
396          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
397          <td class="mdname" nowrap> <em>name</em>, </td>
398        </tr>
399        <tr>
400          <td class="md" nowrap align="right"></td>
401          <td></td>
402          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
403          <td class="mdname" nowrap> <em>value</em></td>
404        </tr>
405        <tr>
406          <td></td>
407          <td class="md">)&nbsp;</td>
408          <td class="md" colspan="2"><code> [virtual]</code></td>
409        </tr>
410
411      </table>
412    </td>
413  </tr>
414</table>
415<table cellspacing=5 cellpadding=0 border=0>
416  <tr>
417    <td>
418      &nbsp;
419    </td>
420    <td>
421
422<p>
423Generic parameter setting method.
424<p>
425<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
426<dl compact><dt><b>Parameters:</b></dt><dd>
427  <table border="0" cellspacing="2" cellpadding="0">
428    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
429    <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>
430  </table>
431</dl>
432<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
433
434<p>
435Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">copyParametersTo()</a>.    </td>
436  </tr>
437</table>
438<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::StringInterface::setParameterList" ></a><p>
439<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
440  <tr>
441    <td class="mdRow">
442      <table cellpadding="0" cellspacing="0" border="0">
443        <tr>
444          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
445          <td class="md" valign="top">(&nbsp;</td>
446          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;&nbsp;</td>
447          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
448          <td class="md" valign="top">&nbsp;)&nbsp;</td>
449          <td class="md" nowrap><code> [virtual]</code></td>
450        </tr>
451
452      </table>
453    </td>
454  </tr>
455</table>
456<table cellspacing=5 cellpadding=0 border=0>
457  <tr>
458    <td>
459      &nbsp;
460    </td>
461    <td>
462
463<p>
464Generic multiple parameter setting method.
465<p>
466<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
467<dl compact><dt><b>Parameters:</b></dt><dd>
468  <table border="0" cellspacing="2" cellpadding="0">
469    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
470  </table>
471</dl>
472    </td>
473  </tr>
474</table>
475<hr><h2>Member Data Documentation</h2>
476<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::StringInterface::mParamDictName" ></a><p>
477<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
478  <tr>
479    <td class="mdRow">
480      <table cellpadding="0" cellspacing="0" border="0">
481        <tr>
482          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected]</code>
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing=5 cellpadding=0 border=0>
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495Class name for this instance to be used as a lookup (must be initialised by subclasses).
496<p>
497
498<p>
499Definition 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>
500  </tr>
501</table>
502<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::StringInterface::msDictionary" ></a><p>
503<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
504  <tr>
505    <td class="mdRow">
506      <table cellpadding="0" cellspacing="0" border="0">
507        <tr>
508          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected]</code>
509      </table>
510    </td>
511  </tr>
512</table>
513<table cellspacing=5 cellpadding=0 border=0>
514  <tr>
515    <td>
516      &nbsp;
517    </td>
518    <td>
519
520<p>
521Dictionary of parameters.
522<p>
523
524<p>
525Definition 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>
526  </tr>
527</table>
528<hr>The documentation for this class was generated from the following file:<ul>
529<li><a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a></ul>
530<hr>
531<p>
532Copyright &copy; 2000-2005 by The OGRE Team<br />
533<!--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/>
534This 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/>
535                <!--/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#">
536                <Work rdf:about="">
537                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
538        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
539                </Work>
540                <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> -->
541
542Last modified Sun Mar 12 14:45:00 2006
543</p>
544</body>
545</html>
Note: See TracBrowser for help on using the repository browser.