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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ScriptLoader 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::ScriptLoader Class Reference</h1>Abstract class defining the interface used by classes which wish to perform script loading to define instances of whatever they manage. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreScriptLoader_8h-source.html">OgreScriptLoader.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ScriptLoader:
16<p><center><img src="classOgre_1_1ScriptLoader.png" usemap="#Ogre::ScriptLoader_map" border="0" alt=""></center>
17<map name="Ogre::ScriptLoader_map">
18<area href="classOgre_1_1OverlayManager.html" alt="Ogre::OverlayManager" shape="rect" coords="0,56,226,80">
19<area href="classOgre_1_1ParticleSystemManager.html" alt="Ogre::ParticleSystemManager" shape="rect" coords="236,56,462,80">
20<area href="classOgre_1_1Quake3ShaderManager.html" alt="Ogre::Quake3ShaderManager" shape="rect" coords="472,56,698,80">
21<area href="classOgre_1_1ResourceManager.html" alt="Ogre::ResourceManager" shape="rect" coords="708,56,934,80">
22<area href="classOgre_1_1BspResourceManager.html" alt="Ogre::BspResourceManager" shape="rect" coords="944,112,1170,136">
23<area href="classOgre_1_1FontManager.html" alt="Ogre::FontManager" shape="rect" coords="944,168,1170,192">
24<area href="classOgre_1_1GpuProgramManager.html" alt="Ogre::GpuProgramManager" shape="rect" coords="944,224,1170,248">
25<area href="classOgre_1_1HighLevelGpuProgramManager.html" alt="Ogre::HighLevelGpuProgramManager" shape="rect" coords="944,280,1170,304">
26<area href="classOgre_1_1MaterialManager.html" alt="Ogre::MaterialManager" shape="rect" coords="944,336,1170,360">
27<area href="classOgre_1_1MeshManager.html" alt="Ogre::MeshManager" shape="rect" coords="944,392,1170,416">
28<area href="classOgre_1_1SkeletonManager.html" alt="Ogre::SkeletonManager" shape="rect" coords="944,448,1170,472">
29<area href="classOgre_1_1TextureManager.html" alt="Ogre::TextureManager" shape="rect" coords="944,504,1170,528">
30</map>
31<a href="classOgre_1_1ScriptLoader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
32<tr><td></td></tr>
33<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScriptLoader.html#Ogre_1_1ScriptLoadera0">~ScriptLoader</a> ()</td></tr>
35
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a535">StringVector</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScriptLoader.html#Ogre_1_1ScriptLoadera1">getScriptPatterns</a> (void) const=0</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the file patterns which should be used to find scripts for this class.  <a href="#Ogre_1_1ScriptLoadera1"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScriptLoader.html#Ogre_1_1ScriptLoadera2">parseScript</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;stream, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;groupName)=0</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse a script file.  <a href="#Ogre_1_1ScriptLoadera2"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScriptLoader.html#Ogre_1_1ScriptLoadera3">getLoadingOrder</a> (void) const=0</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the relative loading order of scripts of this type.  <a href="#Ogre_1_1ScriptLoadera3"></a><br><br></td></tr>
45</table>
46<hr><a name="_details"></a><h2>Detailed Description</h2>
47Abstract class defining the interface used by classes which wish to perform script loading to define instances of whatever they manage.
48<p>
49<dl compact><dt><b>Remarks:</b></dt><dd>Typically classes of this type wish to either parse individual script files on demand, or be called with a group of files matching a certain pattern at the appropriate time. Normally this will coincide with resource loading, although the script use does not necessarily have to be a <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> (which subclasses from this class), it may be simply a script loader which manages non-resources but needs to be synchronised at the same loading points. </dd></dl>
50<dl compact><dt><b></b></dt><dd>Subclasses should add themselves to the <a class="el" href="classOgre_1_1ResourceGroupManager.html">ResourceGroupManager</a> as a script loader if they wish to be called at the point a resource group is loaded, at which point the parseScript method will be called with each file which matches a the pattern returned from getScriptPatterns.</dd></dl>
51
52<p>
53
54<p>
55Definition at line <a class="el" href="OgreScriptLoader_8h-source.html#l00049">49</a> of file <a class="el" href="OgreScriptLoader_8h-source.html">OgreScriptLoader.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
56<a class="anchor" name="Ogre_1_1ScriptLoadera0" doxytag="Ogre::ScriptLoader::~ScriptLoader" ></a><p>
57<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
58  <tr>
59    <td class="mdRow">
60      <table cellpadding="0" cellspacing="0" border="0">
61        <tr>
62          <td class="md" nowrap valign="top"> virtual Ogre::ScriptLoader::~<a class="el" href="classOgre_1_1ScriptLoader.html">ScriptLoader</a> </td>
63          <td class="md" valign="top">(&nbsp;</td>
64          <td class="mdname1" valign="top" nowrap>          </td>
65          <td class="md" valign="top">&nbsp;)&nbsp;</td>
66          <td class="md" nowrap><code> [virtual]</code></td>
67        </tr>
68
69      </table>
70    </td>
71  </tr>
72</table>
73<table cellspacing=5 cellpadding=0 border=0>
74  <tr>
75    <td>
76      &nbsp;
77    </td>
78    <td>
79
80<p>
81    </td>
82  </tr>
83</table>
84<hr><h2>Member Function Documentation</h2>
85<a class="anchor" name="Ogre_1_1ScriptLoadera3" doxytag="Ogre::ScriptLoader::getLoadingOrder" ></a><p>
86<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
87  <tr>
88    <td class="mdRow">
89      <table cellpadding="0" cellspacing="0" border="0">
90        <tr>
91          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::ScriptLoader::getLoadingOrder </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="md" nowrap valign="top">void&nbsp;</td>
94          <td class="mdname1" valign="top" nowrap>          </td>
95          <td class="md" valign="top">&nbsp;)&nbsp;</td>
96          <td class="md" nowrap> const<code> [pure virtual]</code></td>
97        </tr>
98
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing=5 cellpadding=0 border=0>
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111Gets the relative loading order of scripts of this type.
112<p>
113<dl compact><dt><b>Remarks:</b></dt><dd>There are dependencies between some kinds of scripts, and to enforce this all implementors of this interface must define a loading order. </dd></dl>
114<dl compact><dt><b>Returns:</b></dt><dd>A value representing the relative loading order of these scripts compared to other script users, where higher values load later.</dd></dl>
115
116<p>
117Implemented in <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera4">Ogre::OverlayManager</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera24">Ogre::ParticleSystemManager</a>, <a class="el" href="classOgre_1_1ResourceManager.html#Ogre_1_1TextureManagera32">Ogre::ResourceManager</a>, and <a class="el" href="classOgre_1_1Quake3ShaderManager.html#Ogre_1_1Quake3ShaderManagera4">Ogre::Quake3ShaderManager</a>.    </td>
118  </tr>
119</table>
120<a class="anchor" name="Ogre_1_1ScriptLoadera1" doxytag="Ogre::ScriptLoader::getScriptPatterns" ></a><p>
121<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
122  <tr>
123    <td class="mdRow">
124      <table cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a535">StringVector</a>&amp; Ogre::ScriptLoader::getScriptPatterns </td>
127          <td class="md" valign="top">(&nbsp;</td>
128          <td class="md" nowrap valign="top">void&nbsp;</td>
129          <td class="mdname1" valign="top" nowrap>          </td>
130          <td class="md" valign="top">&nbsp;)&nbsp;</td>
131          <td class="md" nowrap> const<code> [pure virtual]</code></td>
132        </tr>
133
134      </table>
135    </td>
136  </tr>
137</table>
138<table cellspacing=5 cellpadding=0 border=0>
139  <tr>
140    <td>
141      &nbsp;
142    </td>
143    <td>
144
145<p>
146Gets the file patterns which should be used to find scripts for this class.
147<p>
148<dl compact><dt><b>Remarks:</b></dt><dd>This method is called when a resource group is loaded if you use <a class="el" href="classOgre_1_1ResourceGroupManager.html#Ogre_1_1ResourceGroupManagera29">ResourceGroupManager::_registerScriptLoader</a>. </dd></dl>
149<dl compact><dt><b>Returns:</b></dt><dd>A list of file patterns, in the order they should be searched in.</dd></dl>
150
151<p>
152Implemented in <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera2">Ogre::OverlayManager</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera22">Ogre::ParticleSystemManager</a>, <a class="el" href="classOgre_1_1ResourceManager.html#Ogre_1_1TextureManagera30">Ogre::ResourceManager</a>, and <a class="el" href="classOgre_1_1Quake3ShaderManager.html#Ogre_1_1Quake3ShaderManagera2">Ogre::Quake3ShaderManager</a>.    </td>
153  </tr>
154</table>
155<a class="anchor" name="Ogre_1_1ScriptLoadera2" doxytag="Ogre::ScriptLoader::parseScript" ></a><p>
156<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"> virtual void Ogre::ScriptLoader::parseScript </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
164          <td class="mdname" nowrap> <em>stream</em>, </td>
165        </tr>
166        <tr>
167          <td class="md" nowrap align="right"></td>
168          <td></td>
169          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
170          <td class="mdname" nowrap> <em>groupName</em></td>
171        </tr>
172        <tr>
173          <td></td>
174          <td class="md">)&nbsp;</td>
175          <td class="md" colspan="2"><code> [pure 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>
190Parse a script file.
191<p>
192<dl compact><dt><b>Parameters:</b></dt><dd>
193  <table border="0" cellspacing="2" cellpadding="0">
194    <tr><td valign=top><em>stream</em>&nbsp;</td><td>Weak reference to a data stream which is the source of the script </td></tr>
195    <tr><td valign=top><em>groupName</em>&nbsp;</td><td>The name of a resource group which should be used if any resources are created during the parse of this script.</td></tr>
196  </table>
197</dl>
198
199<p>
200Implemented in <a class="el" href="classOgre_1_1FontManager.html#Ogre_1_1FontManagera2">Ogre::FontManager</a>, <a class="el" href="classOgre_1_1MaterialManager.html#Ogre_1_1MaterialManagera3">Ogre::MaterialManager</a>, <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera3">Ogre::OverlayManager</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera23">Ogre::ParticleSystemManager</a>, <a class="el" href="classOgre_1_1ResourceManager.html#Ogre_1_1TextureManagera31">Ogre::ResourceManager</a>, and <a class="el" href="classOgre_1_1Quake3ShaderManager.html#Ogre_1_1Quake3ShaderManagera3">Ogre::Quake3ShaderManager</a>.    </td>
201  </tr>
202</table>
203<hr>The documentation for this class was generated from the following file:<ul>
204<li><a class="el" href="OgreScriptLoader_8h-source.html">OgreScriptLoader.h</a></ul>
205<hr>
206<p>
207Copyright &copy; 2000-2005 by The OGRE Team<br />
208<!--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/>
209This 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/>
210                <!--/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#">
211                <Work rdf:about="">
212                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
213        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
214                </Work>
215                <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> -->
216
217Last modified Sun Feb 12 13:03:29 2006
218</p>
219</body>
220</html>
Note: See TracBrowser for help on using the repository browser.