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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreResourceBackgroundQueue.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>OgreResourceBackgroundQueue.h</h1><a href="OgreResourceBackgroundQueue_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 __ResourceBackgroundQueue_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __ResourceBackgroundQueue_H__</span>
3600027 <span class="preprocessor"></span>
3700028
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreCommon_8h.html">OgreCommon.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreSingleton_8h.html">OgreSingleton.h</a>"</span>
4100032
4200033 <span class="preprocessor">#if OGRE_THREAD_SUPPORT</span>
4300034 <span class="preprocessor"></span><span class="preprocessor">#   include &lt;boost/thread/thread.hpp&gt;</span>
4400035 <span class="preprocessor">#   include &lt;boost/thread/condition.hpp&gt;</span>
4500036 <span class="preprocessor">#endif</span>
4600037 <span class="preprocessor"></span>
4700038 <span class="keyword">namespace </span>Ogre {
4800039
49<a name="l00041"></a><a class="code" href="namespaceOgre.html#a487">00041</a>     <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a>;
5000042
51<a name="l00055"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueueListener.html">00055</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> ResourceBackgroundQueueListener
5200056     {
5300057     <span class="keyword">public</span>:
5400062         <span class="keyword">virtual</span> <span class="keywordtype">void</span> operationCompleted(<a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> ticket) = 0;
5500063     };
5600064     
57<a name="l00090"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html">00090</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> ResourceBackgroundQueue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1Singleton.html">Singleton</a>&lt;ResourceBackgroundQueue&gt;
5800091     {
5900092     <span class="keyword">protected</span>:
60<a name="l00094"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7">00094</a>         <span class="keyword">enum</span> RequestType
6100095         {
6200096             RT_INITIALISE_GROUP,
6300097             RT_INITIALISE_ALL_GROUPS,
6400098             RT_LOAD_GROUP,
6500099             RT_LOAD_RESOURCE,
6600100             RT_SHUTDOWN
6700101         };
68<a name="l00103"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">00103</a>         <span class="keyword">struct </span><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a>
6900104         {
70<a name="l00105"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto0">00105</a>             <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> ticketID;
71<a name="l00106"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto1">00106</a>             RequestType type;
72<a name="l00107"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto2">00107</a>             <a class="code" href="namespaceOgre.html#a426">String</a> resourceName;
73<a name="l00108"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto3">00108</a>             <a class="code" href="namespaceOgre.html#a426">String</a> resourceType;
74<a name="l00109"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto4">00109</a>             <a class="code" href="namespaceOgre.html#a426">String</a> groupName;
75<a name="l00110"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto5">00110</a>             <span class="keywordtype">bool</span> isManual;
76<a name="l00111"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto6">00111</a>             <a class="code" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>* loader;
77<a name="l00112"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto7">00112</a>             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a62">NameValuePairList</a>* loadParams;
78<a name="l00113"></a><a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html#Ogre_1_1ResourceBackgroundQueue_1_1Requesto8">00113</a>             ResourceBackgroundQueueListener* listener;
7900114         };
80<a name="l00115"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">00115</a>         <span class="keyword">typedef</span> std::list&lt;Request&gt; <a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">RequestQueue</a>;
81<a name="l00116"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">00116</a>         <span class="keyword">typedef</span> std::map&lt;BackgroundProcessTicket, Request*&gt; <a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">RequestTicketMap</a>;
8200117         
83<a name="l00119"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep0">00119</a>         <a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">RequestQueue</a> mRequestQueue;
8400120         
85<a name="l00122"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep1">00122</a>         <a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">RequestTicketMap</a> mRequestTicketMap;
8600123
87<a name="l00125"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep2">00125</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> mNextTicketID;
8800126
8900127 <span class="preprocessor">#if OGRE_THREAD_SUPPORT</span>
9000128 <span class="preprocessor"></span>
9100129         boost::thread* mThread;
9200131         boost::condition mCondition;
9300133         <span class="keyword">static</span> <span class="keywordtype">void</span> threadFunc(<span class="keywordtype">void</span>);
9400135         <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> addRequest(<a class="code" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a>&amp; req);
9500136 <span class="preprocessor">#else</span>
9600137 <span class="preprocessor"></span>
97<a name="l00138"></a><a class="code" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep3">00138</a>         <span class="keywordtype">void</span>* mThread;
9800139 <span class="preprocessor">#endif</span>
9900140 <span class="preprocessor"></span>
10000142         <a class="code" href="OgrePrerequisites_8h.html#a11">OGRE_AUTO_MUTEX</a>
10100143
10200144     <span class="keyword">public</span>:
10300145         ResourceBackgroundQueue();
10400146         <span class="keyword">virtual</span> ~ResourceBackgroundQueue();
10500147
10600149         <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialise(<span class="keywordtype">void</span>);
10700150         
10800152         <span class="keyword">virtual</span> <span class="keywordtype">void</span> shutdown(<span class="keywordtype">void</span>);
10900153
11000162         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> initialiseResourceGroup(
11100163             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, ResourceBackgroundQueueListener* listener = 0);
11200164
11300173         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> initialiseAllResourceGroups(
11400174             ResourceBackgroundQueueListener* listener = 0);
11500182         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> loadResourceGroup(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name,
11600183             ResourceBackgroundQueueListener* listener = 0);
11700184
11800185
11900201         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> load(
12000202             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; resType, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name,
12100203             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; group, <span class="keywordtype">bool</span> isManual = <span class="keyword">false</span>,
12200204             <a class="code" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a>* loader = 0,
12300205             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a62">NameValuePairList</a>* loadParams = 0,
12400206             ResourceBackgroundQueueListener* listener = 0);
12500207
12600216         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isProcessComplete(<a class="code" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> ticket);
12700217
12800233         <span class="keyword">static</span> ResourceBackgroundQueue&amp; getSingleton(<span class="keywordtype">void</span>);
12900249         <span class="keyword">static</span> ResourceBackgroundQueue* getSingletonPtr(<span class="keywordtype">void</span>);
13000250         
13100251
13200252     };
13300253
13400254
13500255 }
13600256
13700257 <span class="preprocessor">#endif</span>
13800258 <span class="preprocessor"></span>
139</pre></div><hr>
140<p>
141Copyright &copy; 2000-2005 by The OGRE Team<br />
142<!--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/>
143This 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/>
144                <!--/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#">
145                <Work rdf:about="">
146                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
147        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
148                </Work>
149                <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> -->
150
151Last modified Sun Feb 12 12:59:51 2006
152</p>
153</body>
154</html>
Note: See TracBrowser for help on using the repository browser.