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

Revision 692, 14.3 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreResource.h Source File - 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>OgreResource.h</h1><a href="OgreResource_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef _Resource_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define _Resource_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreSharedPtr_8h.html">OgreSharedPtr.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreStringInterface_8h.html">OgreStringInterface.h</a>"</span>
4100032
4200033 <span class="keyword">namespace </span>Ogre {
4300034
44<a name="l00035"></a><a class="code" href="namespaceOgre.html#a529">00035</a>     <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="namespaceOgre.html#a529">ResourceHandle</a>;
4500036
4600037
4700038     <span class="comment">// Forward declaration</span>
4800039     <span class="keyword">class </span><a class="code" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>;
4900040
50<a name="l00067"></a><a class="code" href="classOgre_1_1Resource.html">00067</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Resource : <span class="keyword">public</span> <a class="code" href="classOgre_1_1StringInterface.html">StringInterface</a>
5100068     {
5200069     <span class="keyword">public</span>:
5300070         <a class="code" href="OgrePrerequisites_8h.html#a12">OGRE_AUTO_MUTEX</a> <span class="comment">// public to allow external locking</span>
5400071     <span class="keyword">protected</span>:
55<a name="l00073"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep17">00073</a>         <a class="code" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* mCreator;
56<a name="l00075"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep18">00075</a>         <a class="code" href="namespaceOgre.html#a471">String</a> mName;
57<a name="l00077"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep19">00077</a>         <a class="code" href="namespaceOgre.html#a471">String</a> mGroup;
58<a name="l00079"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep20">00079</a>         <a class="code" href="namespaceOgre.html#a529">ResourceHandle</a> mHandle;
59<a name="l00081"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep21">00081</a>         <span class="keywordtype">bool</span> mIsLoaded;
60<a name="l00083"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep22">00083</a>         size_t mSize;
61<a name="l00085"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep23">00085</a>         <span class="keywordtype">bool</span> mIsManual;
62<a name="l00087"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep24">00087</a>         <a class="code" href="namespaceOgre.html#a471">String</a> mOrigin;
63<a name="l00089"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturep25">00089</a>         <a class="code" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>* mLoader;
6400090
65<a name="l00093"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Resourceb0">00093</a>         Resource()
6600094             : mCreator(0), mHandle(0), mIsLoaded(false), mSize(0), mIsManual(0), mLoader(0)
6700095         {
6800096         }
6900097
7000101         <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadImpl(<span class="keywordtype">void</span>) = 0;
7100105         <span class="keyword">virtual</span> <span class="keywordtype">void</span> unloadImpl(<span class="keywordtype">void</span>) = 0;
7200107         <span class="keyword">virtual</span> size_t calculateSize(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
7300108
7400109     <span class="keyword">public</span>:
7500124         Resource(<a class="code" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* creator, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <a class="code" href="namespaceOgre.html#a529">ResourceHandle</a> handle,
7600125             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; group, <span class="keywordtype">bool</span> isManual = <span class="keyword">false</span>, <a class="code" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>* loader = 0);
7700126
7800132         <span class="keyword">virtual</span> ~Resource();
7900133
8000142         <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(<span class="keywordtype">void</span>);
8100143
8200149         <span class="keyword">virtual</span> <span class="keywordtype">void</span> reload(<span class="keywordtype">void</span>);
8300150
84<a name="l00153"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea32">00153</a>         <span class="keywordtype">bool</span> isReloadable(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
8500154 <span class="keyword">        </span>{
8600155             <span class="keywordflow">return</span> !mIsManual || mLoader;
8700156         }
8800157
89<a name="l00160"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea33">00160</a>         <span class="keywordtype">bool</span> isManuallyLoaded(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
9000161 <span class="keyword">        </span>{
9100162             <span class="keywordflow">return</span> mIsManual;
9200163         }
9300164
9400168         <span class="keyword">virtual</span> <span class="keywordtype">void</span> unload(<span class="keywordtype">void</span>);
9500169
96<a name="l00172"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea35">00172</a>         size_t getSize(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
9700173 <span class="keyword">        </span>{
9800174             <span class="keywordflow">return</span> mSize;
9900175         }
10000176
10100179         <span class="keyword">virtual</span> <span class="keywordtype">void</span> touch(<span class="keywordtype">void</span>);
10200180
103<a name="l00183"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea37">00183</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getName(<span class="keywordtype">void</span>)<span class="keyword"> const </span>
10400184 <span class="keyword">        </span>{
10500185             <span class="keywordflow">return</span> mName;
10600186         }
10700187
108<a name="l00188"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea38">00188</a>         <a class="code" href="namespaceOgre.html#a529">ResourceHandle</a> getHandle(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
10900189 <span class="keyword">        </span>{
11000190             <span class="keywordflow">return</span> mHandle;
11100191         }
11200192
113<a name="l00195"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea39">00195</a>         <span class="keywordtype">bool</span> isLoaded(<span class="keywordtype">void</span>)<span class="keyword"> const </span>
11400196 <span class="keyword">        </span>{
11500197             <a class="code" href="OgrePrerequisites_8h.html#a13">OGRE_LOCK_AUTO_MUTEX</a>
11600198             <span class="keywordflow">return</span> mIsLoaded;
11700199         }
11800200
119<a name="l00202"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea40">00202</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getGroup(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mGroup; }
12000203
12100211         <span class="keywordtype">void</span> changeGroupOwnership(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; newGroup);
12200212
123<a name="l00214"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea42">00214</a>         <a class="code" href="classOgre_1_1ResourceManager.html">ResourceManager</a>* getCreator(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mCreator; }
124<a name="l00221"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea43">00221</a>         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getOrigin(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mOrigin; }
125<a name="l00223"></a><a class="code" href="classOgre_1_1Resource.html#Ogre_1_1Texturea44">00223</a>         <span class="keywordtype">void</span> _notifyOrigin(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; origin) { mOrigin = origin; }
12600224
12700225     };
12800226
129<a name="l00245"></a><a class="code" href="namespaceOgre.html#a530">00245</a>     <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;Resource&gt;</a> <a class="code" href="classOgre_1_1SharedPtr.html">ResourcePtr</a>;
13000246
131<a name="l00268"></a><a class="code" href="classOgre_1_1ManualResourceLoader.html">00268</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> ManualResourceLoader
13200269     {
13300270     <span class="keyword">public</span>:
134<a name="l00271"></a><a class="code" href="classOgre_1_1ManualResourceLoader.html#Ogre_1_1ManualResourceLoadera0">00271</a>         ManualResourceLoader() {}
135<a name="l00272"></a><a class="code" href="classOgre_1_1ManualResourceLoader.html#Ogre_1_1ManualResourceLoadera1">00272</a>         <span class="keyword">virtual</span> ~ManualResourceLoader() {}
13600273
13700277         <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadResource(Resource* resource) = 0;
13800278     };
13900279 }
14000280
14100281 <span class="preprocessor">#endif</span>
142</pre></div><hr>
143<p>
144Copyright &copy; 2000-2005 by The OGRE Team<br />
145<!--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/>
146This 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/>
147                <!--/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#">
148                <Work rdf:about="">
149                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
150        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
151                </Work>
152                <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> -->
153
154Last modified Sun Mar 12 14:37:48 2006
155</p>
156</body>
157</html>
Note: See TracBrowser for help on using the repository browser.