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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreOverlayManager.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>OgreOverlayManager.h</h1><a href="OgreOverlayManager_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 __OverlayManager_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __OverlayManager_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="OgreSingleton_8h.html">OgreSingleton.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreStringVector_8h.html">OgreStringVector.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreOverlay_8h.html">OgreOverlay.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreScriptLoader_8h.html">OgreScriptLoader.h</a>"</span>
4200033
4300034 <span class="keyword">namespace </span>Ogre {
4400035
45<a name="l00041"></a><a class="code" href="classOgre_1_1OverlayManager.html">00041</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> OverlayManager : <span class="keyword">public</span> <a class="code" href="classOgre_1_1Singleton.html">Singleton</a>&lt;OverlayManager&gt;, <span class="keyword">public</span> <a class="code" href="classOgre_1_1ScriptLoader.html">ScriptLoader</a>
4600042     {
4700043     <span class="keyword">public</span>:
48<a name="l00044"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw0">00044</a>         <span class="keyword">typedef</span> std::map&lt;String, Overlay*&gt; <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw0">OverlayMap</a>;
49<a name="l00045"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">00045</a>         <span class="keyword">typedef</span> std::map&lt;String, OverlayElement*&gt; <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>;
5000046     <span class="keyword">protected</span>:
51<a name="l00047"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp0">00047</a>         <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw0">OverlayMap</a> mOverlayMap;
52<a name="l00048"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp1">00048</a>         <a class="code" href="namespaceOgre.html#a580">StringVector</a> mScriptPatterns;
5300049
5400050         <span class="keywordtype">void</span> parseNewElement( <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk, <a class="code" href="namespaceOgre.html#a471">String</a>&amp; elemType, <a class="code" href="namespaceOgre.html#a471">String</a>&amp; elemName,
5500051             <span class="keywordtype">bool</span> isContainer, <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* pOverlay, <span class="keywordtype">bool</span> isTemplate, <a class="code" href="namespaceOgre.html#a471">String</a> templateName = <a class="code" href="namespaceOgre.html#a471">String</a>(<span class="stringliteral">""</span>), <a class="code" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a>* container = 0);
5600052         <span class="keywordtype">void</span> parseAttrib( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line, <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* pOverlay);
5700053         <span class="keywordtype">void</span> parseElementAttrib( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line, <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* pOverlay, <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* pElement );
5800054         <span class="keywordtype">void</span> skipToNextCloseBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
5900055         <span class="keywordtype">void</span> skipToNextOpenBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
6000056         
61<a name="l00057"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp2">00057</a>         <span class="keywordtype">int</span> mLastViewportWidth, mLastViewportHeight;
62<a name="l00058"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp4">00058</a>         <span class="keywordtype">bool</span> mViewportDimensionsChanged;
6300059
6400060         <span class="keywordtype">bool</span> parseChildren( <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line,
6500061             <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* pOverlay, <span class="keywordtype">bool</span> isTemplate, <a class="code" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a>* parent = NULL);
6600062
67<a name="l00063"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerx0">00063</a>         <span class="keyword">typedef</span> std::map&lt;String, OverlayElementFactory*&gt; FactoryMap;
68<a name="l00064"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp5">00064</a>         FactoryMap mFactories;
6900065
70<a name="l00066"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp6">00066</a>         <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a> mInstances;
71<a name="l00067"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp7">00067</a>         <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a> mTemplates;
7200068
73<a name="l00069"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerx1">00069</a>         <span class="keyword">typedef</span> std::set&lt;String&gt; <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerx1">LoadedScripts</a>;
74<a name="l00070"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerp8">00070</a>         <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerx1">LoadedScripts</a> mLoadedScripts;
7500071
7600072
7700073
7800074
7900075         <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; getElementMap(<span class="keywordtype">bool</span> isTemplate);
8000076
8100077         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* createOverlayElementImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; typeName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName, <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; elementMap);
8200078
8300079         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* getOverlayElementImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; elementMap);
8400080
8500081         <span class="keywordtype">void</span> destroyOverlayElementImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName, <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; elementMap);
8600082
8700083         <span class="keywordtype">void</span> destroyOverlayElementImpl(<a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* pInstance, <a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; elementMap);
8800084
8900085         <span class="keywordtype">void</span> destroyAllOverlayElementsImpl(<a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw1">ElementMap</a>&amp; elementMap);
9000086
9100087     <span class="keyword">public</span>:
9200088         OverlayManager();
9300089         <span class="keyword">virtual</span> ~OverlayManager();
9400090
9500092         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a580">StringVector</a>&amp; getScriptPatterns(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9600094         <span class="keywordtype">void</span> parseScript(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; stream, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; groupName);
9700096         <a class="code" href="namespaceOgre.html#a465">Real</a> getLoadingOrder(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9800097
9900099         <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* create(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name);
10000103         <a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* getByName(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name);
10100105         <span class="keywordtype">void</span> destroy(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name);
10200107         <span class="keywordtype">void</span> destroy(<a class="code" href="classOgre_1_1Overlay.html">Overlay</a>* overlay);
10300109         <span class="keywordtype">void</span> destroyAll(<span class="keywordtype">void</span>);
104<a name="l00110"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw2">00110</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;OverlayMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">OverlayMapIterator</a>;
10500111         <a class="code" href="classOgre_1_1MapIterator.html">OverlayMapIterator</a> getOverlayIterator(<span class="keywordtype">void</span>);
10600112
10700114         <span class="keywordtype">void</span> _queueOverlaysForRendering(<a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam, <a class="code" href="classOgre_1_1RenderQueue.html">RenderQueue</a>* pQueue, <a class="code" href="classOgre_1_1Viewport.html">Viewport</a> *vp);
10800115
10900120         <span class="keywordtype">bool</span> hasViewportChanged(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11000121
11100123         <span class="keywordtype">int</span> getViewportHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11200124         
11300126         <span class="keywordtype">int</span> getViewportWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11400127         <a class="code" href="namespaceOgre.html#a465">Real</a> getViewportAspectRatio(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11500128
11600129
11700137         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* createOverlayElement(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; typeName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName, <span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
11800138
11900140         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* getOverlayElement(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
12000141
12100147         <span class="keywordtype">void</span> destroyOverlayElement(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName, <span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
12200148
12300154         <span class="keywordtype">void</span> destroyOverlayElement(<a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* pInstance, <span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
12400155
12500161         <span class="keywordtype">void</span> destroyAllOverlayElements(<span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
12600162
12700168         <span class="keywordtype">void</span> addOverlayElementFactory(<a class="code" href="classOgre_1_1OverlayElementFactory.html">OverlayElementFactory</a>* elemFactory);
12800169
12900170         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* createOverlayElementFromTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; templateName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; typeName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName, <span class="keywordtype">bool</span> isTemplate = <span class="keyword">false</span>);
13000176         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* cloneOverlayElementFromTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; templateName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName);
13100177
13200178         <a class="code" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* createOverlayElementFromFactory(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; typeName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; instanceName);
13300179
134<a name="l00180"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagerw3">00180</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ElementMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">TemplateIterator</a>;
135<a name="l00182"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera25">00182</a>         <a class="code" href="classOgre_1_1MapIterator.html">TemplateIterator</a> getTemplateIterator ()
13600183         {
13700184             <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1MapIterator.html">TemplateIterator</a> (mTemplates.begin (), mTemplates.end ()) ;
13800185         }
13900186         <span class="comment">/* Returns whether the Element with the given name is a Template */</span>
140<a name="l00187"></a><a class="code" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera26">00187</a>         <span class="keywordtype">bool</span> isTemplate (<a class="code" href="namespaceOgre.html#a471">String</a> strName)<span class="keyword"> const </span>{
14100188             <span class="keywordflow">return</span> (mTemplates.find (strName) != mTemplates.end()) ;
14200189         }
14300190
14400191
14500207         <span class="keyword">static</span> OverlayManager&amp; getSingleton(<span class="keywordtype">void</span>);
14600223         <span class="keyword">static</span> OverlayManager* getSingletonPtr(<span class="keywordtype">void</span>);
14700224     };
14800225
14900226
15000227
15100228 }
15200229
15300230
15400231 <span class="preprocessor">#endif </span>
155</pre></div><hr>
156<p>
157Copyright &copy; 2000-2005 by The OGRE Team<br />
158<!--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/>
159This 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/>
160                <!--/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#">
161                <Work rdf:about="">
162                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
163        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
164                </Work>
165                <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> -->
166
167Last modified Sun Mar 12 14:37:45 2006
168</p>
169</body>
170</html>
Note: See TracBrowser for help on using the repository browser.