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

Revision 692, 16.2 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title> TemplateOgre::Singleton&lt; T &gt; 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::Singleton&lt; T &gt; Class Template Reference</h1>Template class for creating single-instance global classes. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Singleton-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletona0">Singleton</a> (void)</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletona1">~Singleton</a> (void)</td></tr>
21
22<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>T &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">getSingleton</a> (void)</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>T *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">getSingletonPtr</a> (void)</td></tr>
26
27<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>T *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr>
29
30</table>
31<hr><a name="_details"></a><h2>Detailed Description</h2>
32<h3>template&lt;typename T&gt;<br>
33 class Ogre::Singleton&lt; T &gt;</h3>
34
35Template class for creating single-instance global classes.
36<p>
37
38<p>
39Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00050">50</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
40<a class="anchor" name="Ogre_1_1Singletona0" doxytag="Ogre::Singleton::Singleton" ></a><p>
41<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
42  <tr>
43    <td class="mdRow">
44      <table cellpadding="0" cellspacing="0" border="0">
45        <tr>
46          <td class="md" colspan="4">
47template&lt;typename T&gt; </td>
48        </tr>
49        <tr>
50          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Singleton.html">Singleton</a> </td>
51          <td class="md" valign="top">(&nbsp;</td>
52          <td class="md" nowrap valign="top">void&nbsp;</td>
53          <td class="mdname1" valign="top" nowrap>          </td>
54          <td class="md" valign="top">&nbsp;)&nbsp;</td>
55          <td class="md" nowrap></td>
56        </tr>
57
58      </table>
59    </td>
60  </tr>
61</table>
62<table cellspacing=5 cellpadding=0 border=0>
63  <tr>
64    <td>
65      &nbsp;
66    </td>
67    <td>
68
69<p>
70
71<p>
72Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00057">57</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
73  </tr>
74</table>
75<a class="anchor" name="Ogre_1_1Singletona1" doxytag="Ogre::Singleton::~Singleton" ></a><p>
76<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
77  <tr>
78    <td class="mdRow">
79      <table cellpadding="0" cellspacing="0" border="0">
80        <tr>
81          <td class="md" colspan="4">
82template&lt;typename T&gt; </td>
83        </tr>
84        <tr>
85          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; T &gt;::~<a class="el" href="classOgre_1_1Singleton.html">Singleton</a> </td>
86          <td class="md" valign="top">(&nbsp;</td>
87          <td class="md" nowrap valign="top">void&nbsp;</td>
88          <td class="mdname1" valign="top" nowrap>          </td>
89          <td class="md" valign="top">&nbsp;)&nbsp;</td>
90          <td class="md" nowrap></td>
91        </tr>
92
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105
106<p>
107Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00067">67</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
108  </tr>
109</table>
110<hr><h2>Member Function Documentation</h2>
111<a class="anchor" name="Ogre_1_1Singletone0" doxytag="Ogre::Singleton::getSingleton" ></a><p>
112<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" colspan="4">
118template&lt;typename T&gt; </td>
119        </tr>
120        <tr>
121          <td class="md" nowrap valign="top"> T&amp; <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; T &gt;::getSingleton </td>
122          <td class="md" valign="top">(&nbsp;</td>
123          <td class="md" nowrap valign="top">void&nbsp;</td>
124          <td class="mdname1" valign="top" nowrap>          </td>
125          <td class="md" valign="top">&nbsp;)&nbsp;</td>
126          <td class="md" nowrap><code> [static]</code></td>
127        </tr>
128
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing=5 cellpadding=0 border=0>
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141
142<p>
143Reimplemented in <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagere0">Ogre::ArchiveManager</a>, <a class="el" href="classOgre_1_1ControllerManager.html#Ogre_1_1ControllerManagere0">Ogre::ControllerManager</a>, <a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagere0">Ogre::DynLibManager</a>, <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessore0">Ogre::EventProcessor</a>, <a class="el" href="classOgre_1_1ExternalTextureSourceManager.html#Ogre_1_1ExternalTextureSourceManagere0">Ogre::ExternalTextureSourceManager</a>, <a class="el" href="classOgre_1_1FontManager.html#Ogre_1_1FontManagere0">Ogre::FontManager</a>, <a class="el" href="classOgre_1_1GpuProgramManager.html#Ogre_1_1GpuProgramManagere0">Ogre::GpuProgramManager</a>, <a class="el" href="classOgre_1_1HardwareBufferManager.html#Ogre_1_1HardwareBufferManagere0">Ogre::HardwareBufferManager</a>, <a class="el" href="classOgre_1_1HighLevelGpuProgramManager.html#Ogre_1_1HighLevelGpuProgramManagere0">Ogre::HighLevelGpuProgramManager</a>, <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagere0">Ogre::LogManager</a>, <a class="el" href="classOgre_1_1MaterialManager.html#Ogre_1_1MaterialManagere0">Ogre::MaterialManager</a>, <a class="el" href="classOgre_1_1MeshManager.html#Ogre_1_1MeshManagere0">Ogre::MeshManager</a>, <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagere0">Ogre::OverlayManager</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagere0">Ogre::ParticleSystemManager</a>, <a class="el" href="classOgre_1_1PlatformManager.html#Ogre_1_1PlatformManagere0">Ogre::PlatformManager</a>, <a class="el" href="classOgre_1_1Profiler.html#Ogre_1_1Profilere0">Ogre::Profiler</a>, <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuee0">Ogre::ResourceBackgroundQueue</a>, <a class="el" href="classOgre_1_1ResourceGroupManager.html#Ogre_1_1ResourceGroupManagere0">Ogre::ResourceGroupManager</a>, <a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roote1">Ogre::Root</a>, <a class="el" href="classOgre_1_1SceneManagerEnumerator.html#Ogre_1_1SceneManagerEnumeratore0">Ogre::SceneManagerEnumerator</a>, <a class="el" href="classOgre_1_1SkeletonManager.html#Ogre_1_1SkeletonManagere0">Ogre::SkeletonManager</a>, <a class="el" href="classOgre_1_1TextureManager.html#Ogre_1_1TextureManagere0">Ogre::TextureManager</a>, <a class="el" href="classOgre_1_1BspResourceManager.html#Ogre_1_1BspResourceManagere0">Ogre::BspResourceManager</a>, <a class="el" href="classOgre_1_1Quake3ShaderManager.html#Ogre_1_1Quake3ShaderManagere0">Ogre::Quake3ShaderManager</a>, <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagere0">Ogre::TerrainPageSourceListenerManager</a>, <a class="el" href="classOgre_1_1GTKGLSupport.html#Ogre_1_1GTKGLSupporte0">Ogre::GTKGLSupport</a>, <a class="el" href="classOgre_1_1GLSLLinkProgramManager.html#Ogre_1_1GLSLLinkProgramManagere0">Ogre::GLSLLinkProgramManager</a>, and <a class="el" href="classOgreRefApp_1_1World.html#OgreRefApp_1_1Worlde0">OgreRefApp::World</a>.
144<p>
145Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00069">69</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
146  </tr>
147</table>
148<a class="anchor" name="Ogre_1_1Singletone1" doxytag="Ogre::Singleton::getSingletonPtr" ></a><p>
149<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
150  <tr>
151    <td class="mdRow">
152      <table cellpadding="0" cellspacing="0" border="0">
153        <tr>
154          <td class="md" colspan="4">
155template&lt;typename T&gt; </td>
156        </tr>
157        <tr>
158          <td class="md" nowrap valign="top"> T* <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; T &gt;::getSingletonPtr </td>
159          <td class="md" valign="top">(&nbsp;</td>
160          <td class="md" nowrap valign="top">void&nbsp;</td>
161          <td class="mdname1" valign="top" nowrap>          </td>
162          <td class="md" valign="top">&nbsp;)&nbsp;</td>
163          <td class="md" nowrap><code> [static]</code></td>
164        </tr>
165
166      </table>
167    </td>
168  </tr>
169</table>
170<table cellspacing=5 cellpadding=0 border=0>
171  <tr>
172    <td>
173      &nbsp;
174    </td>
175    <td>
176
177<p>
178
179<p>
180Reimplemented in <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagere1">Ogre::ArchiveManager</a>, <a class="el" href="classOgre_1_1ControllerManager.html#Ogre_1_1ControllerManagere1">Ogre::ControllerManager</a>, <a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagere1">Ogre::DynLibManager</a>, <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessore1">Ogre::EventProcessor</a>, <a class="el" href="classOgre_1_1ExternalTextureSourceManager.html#Ogre_1_1ExternalTextureSourceManagere1">Ogre::ExternalTextureSourceManager</a>, <a class="el" href="classOgre_1_1FontManager.html#Ogre_1_1FontManagere1">Ogre::FontManager</a>, <a class="el" href="classOgre_1_1GpuProgramManager.html#Ogre_1_1GpuProgramManagere1">Ogre::GpuProgramManager</a>, <a class="el" href="classOgre_1_1HardwareBufferManager.html#Ogre_1_1HardwareBufferManagere1">Ogre::HardwareBufferManager</a>, <a class="el" href="classOgre_1_1HighLevelGpuProgramManager.html#Ogre_1_1HighLevelGpuProgramManagere1">Ogre::HighLevelGpuProgramManager</a>, <a class="el" href="classOgre_1_1LogManager.html#Ogre_1_1LogManagere1">Ogre::LogManager</a>, <a class="el" href="classOgre_1_1MaterialManager.html#Ogre_1_1MaterialManagere1">Ogre::MaterialManager</a>, <a class="el" href="classOgre_1_1MeshManager.html#Ogre_1_1MeshManagere1">Ogre::MeshManager</a>, <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagere1">Ogre::OverlayManager</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagere1">Ogre::ParticleSystemManager</a>, <a class="el" href="classOgre_1_1PlatformManager.html#Ogre_1_1PlatformManagere1">Ogre::PlatformManager</a>, <a class="el" href="classOgre_1_1Profiler.html#Ogre_1_1Profilere1">Ogre::Profiler</a>, <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuee1">Ogre::ResourceBackgroundQueue</a>, <a class="el" href="classOgre_1_1ResourceGroupManager.html#Ogre_1_1ResourceGroupManagere1">Ogre::ResourceGroupManager</a>, <a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roote2">Ogre::Root</a>, <a class="el" href="classOgre_1_1SceneManagerEnumerator.html#Ogre_1_1SceneManagerEnumeratore1">Ogre::SceneManagerEnumerator</a>, <a class="el" href="classOgre_1_1SkeletonManager.html#Ogre_1_1SkeletonManagere1">Ogre::SkeletonManager</a>, <a class="el" href="classOgre_1_1TextureManager.html#Ogre_1_1TextureManagere1">Ogre::TextureManager</a>, <a class="el" href="classOgre_1_1BspResourceManager.html#Ogre_1_1BspResourceManagere1">Ogre::BspResourceManager</a>, <a class="el" href="classOgre_1_1Quake3ShaderManager.html#Ogre_1_1Quake3ShaderManagere1">Ogre::Quake3ShaderManager</a>, <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagere1">Ogre::TerrainPageSourceListenerManager</a>, <a class="el" href="classOgre_1_1GTKGLSupport.html#Ogre_1_1GTKGLSupporte1">Ogre::GTKGLSupport</a>, <a class="el" href="classOgre_1_1GLSLLinkProgramManager.html#Ogre_1_1GLSLLinkProgramManagere1">Ogre::GLSLLinkProgramManager</a>, and <a class="el" href="classOgreRefApp_1_1World.html#OgreRefApp_1_1Worlde1">OgreRefApp::World</a>.
181<p>
182Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00071">71</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
183  </tr>
184</table>
185<hr><h2>Member Data Documentation</h2>
186<a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::Singleton::ms_Singleton" ></a><p>
187<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
188  <tr>
189    <td class="mdRow">
190      <table cellpadding="0" cellspacing="0" border="0">
191        <tr>
192          <td class="md" colspan="4">
193template&lt;typename T&gt; </td>
194        </tr>
195        <tr>
196          <td class="md" nowrap valign="top"> T* <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected]</code>
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing=5 cellpadding=0 border=0>
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209
210<p>
211Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
212  </tr>
213</table>
214<hr>The documentation for this class was generated from the following file:<ul>
215<li><a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a></ul>
216<hr>
217<p>
218Copyright &copy; 2000-2005 by The OGRE Team<br />
219<!--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/>
220This 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/>
221                <!--/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#">
222                <Work rdf:about="">
223                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
224        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
225                </Work>
226                <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> -->
227
228Last modified Sun Mar 12 14:44:18 2006
229</p>
230</body>
231</html>
Note: See TracBrowser for help on using the repository browser.