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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ManualResourceLoader 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::ManualResourceLoader Class Reference</h1>Interface describing a manual resource loader. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ManualResourceLoader:
16<p><center><img src="classOgre_1_1ManualResourceLoader.png" usemap="#Ogre::ManualResourceLoader_map" border="0" alt=""></center>
17<map name="Ogre::ManualResourceLoader_map">
18<area href="classOgre_1_1Font.html" alt="Ogre::Font" shape="rect" coords="0,56,183,80">
19<area href="classOgre_1_1MeshManager.html" alt="Ogre::MeshManager" shape="rect" coords="193,56,376,80">
20</map>
21<a href="classOgre_1_1ManualResourceLoader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ManualResourceLoader.html#Ogre_1_1ManualResourceLoadera0">ManualResourceLoader</a> ()</td></tr>
25
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ManualResourceLoader.html#Ogre_1_1ManualResourceLoadera1">~ManualResourceLoader</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ManualResourceLoader.html#Ogre_1_1ManualResourceLoadera2">loadResource</a> (<a class="el" href="classOgre_1_1Resource.html">Resource</a> *resource)=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a resource wishes to load.  <a href="#Ogre_1_1ManualResourceLoadera2"></a><br><br></td></tr>
31</table>
32<hr><a name="_details"></a><h2>Detailed Description</h2>
33Interface describing a manual resource loader.
34<p>
35<dl compact><dt><b>Remarks:</b></dt><dd>Resources are usually loaded from files; however in some cases you want to be able to set the data up manually instead. This provides some problems, such as how to reload a <a class="el" href="classOgre_1_1Resource.html">Resource</a> if it becomes unloaded for some reason, either because of memory constraints, or because a device fails and some or all of the data is lost. </dd></dl>
36<dl compact><dt><b></b></dt><dd>This interface should be implemented by all classes which wish to provide manual data to a resource. They provide a pointer to themselves when defining the resource (via the appropriate <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a>), and will be called when the <a class="el" href="classOgre_1_1Resource.html">Resource</a> tries to load. They should implement the loadResource method such that the <a class="el" href="classOgre_1_1Resource.html">Resource</a> is in the end set up exactly as if it had loaded from a file, although the implementations will likely differ between subclasses of <a class="el" href="classOgre_1_1Resource.html">Resource</a>, which is why no generic algorithm can be stated here. </dd></dl>
37<dl compact><dt><b>Note:</b></dt><dd>The loader must remain valid for the entire life of the resource, so that if need be it can be called upon to re-load the resource at any time.</dd></dl>
38
39<p>
40
41<p>
42Definition at line <a class="el" href="OgreResource_8h-source.html#l00259">259</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
43<a class="anchor" name="Ogre_1_1ManualResourceLoadera0" doxytag="Ogre::ManualResourceLoader::ManualResourceLoader" ></a><p>
44<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
45  <tr>
46    <td class="mdRow">
47      <table cellpadding="0" cellspacing="0" border="0">
48        <tr>
49          <td class="md" nowrap valign="top"> Ogre::ManualResourceLoader::ManualResourceLoader </td>
50          <td class="md" valign="top">(&nbsp;</td>
51          <td class="mdname1" valign="top" nowrap>          </td>
52          <td class="md" valign="top">&nbsp;)&nbsp;</td>
53          <td class="md" nowrap></td>
54        </tr>
55
56      </table>
57    </td>
58  </tr>
59</table>
60<table cellspacing=5 cellpadding=0 border=0>
61  <tr>
62    <td>
63      &nbsp;
64    </td>
65    <td>
66
67<p>
68
69<p>
70Definition at line <a class="el" href="OgreResource_8h-source.html#l00262">262</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
71  </tr>
72</table>
73<a class="anchor" name="Ogre_1_1ManualResourceLoadera1" doxytag="Ogre::ManualResourceLoader::~ManualResourceLoader" ></a><p>
74<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top"> virtual Ogre::ManualResourceLoader::~<a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="mdname1" valign="top" nowrap>          </td>
82          <td class="md" valign="top">&nbsp;)&nbsp;</td>
83          <td class="md" nowrap><code> [virtual]</code></td>
84        </tr>
85
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing=5 cellpadding=0 border=0>
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98
99<p>
100Definition at line <a class="el" href="OgreResource_8h-source.html#l00263">263</a> of file <a class="el" href="OgreResource_8h-source.html">OgreResource.h</a>.    </td>
101  </tr>
102</table>
103<hr><h2>Member Function Documentation</h2>
104<a class="anchor" name="Ogre_1_1ManualResourceLoadera2" doxytag="Ogre::ManualResourceLoader::loadResource" ></a><p>
105<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
106  <tr>
107    <td class="mdRow">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top"> virtual void Ogre::ManualResourceLoader::loadResource </td>
111          <td class="md" valign="top">(&nbsp;</td>
112          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Resource.html">Resource</a> *&nbsp;</td>
113          <td class="mdname1" valign="top" nowrap> <em>resource</em>          </td>
114          <td class="md" valign="top">&nbsp;)&nbsp;</td>
115          <td class="md" nowrap><code> [pure virtual]</code></td>
116        </tr>
117
118      </table>
119    </td>
120  </tr>
121</table>
122<table cellspacing=5 cellpadding=0 border=0>
123  <tr>
124    <td>
125      &nbsp;
126    </td>
127    <td>
128
129<p>
130Called when a resource wishes to load.
131<p>
132<dl compact><dt><b>Parameters:</b></dt><dd>
133  <table border="0" cellspacing="2" cellpadding="0">
134    <tr><td valign=top><em>resource</em>&nbsp;</td><td>The resource which wishes to load</td></tr>
135  </table>
136</dl>
137
138<p>
139Implemented in <a class="el" href="classOgre_1_1Font.html#Ogre_1_1Fonta19">Ogre::Font</a>, and <a class="el" href="classOgre_1_1MeshManager.html#Ogre_1_1MeshManagera13">Ogre::MeshManager</a>.    </td>
140  </tr>
141</table>
142<hr>The documentation for this class was generated from the following file:<ul>
143<li><a class="el" href="OgreResource_8h-source.html">OgreResource.h</a></ul>
144<hr>
145<p>
146Copyright &copy; 2000-2005 by The OGRE Team<br />
147<!--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/>
148This 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/>
149                <!--/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#">
150                <Work rdf:about="">
151                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
152        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
153                </Work>
154                <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> -->
155
156Last modified Sun Feb 12 13:02:47 2006
157</p>
158</body>
159</html>
Note: See TracBrowser for help on using the repository browser.