<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GG: OgreGUI.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a8649c70aabfef076611d3be10291d33.html">GG</a></li><li class="navelem"><a class="el" href="dir_096edff39a3284d480c8588d05a24617.html">Ogre</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">OgreGUI.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="OgreGUI_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* GG is a GUI for SDL and OpenGL.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2007 T. Zachary Laine</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> as published by the Free Software Foundation; either version 2.1</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> License along with this library; if not, write to the Free</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> 02111-1307 USA</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> If you do not wish to comply with the terms of the LGPL please</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> contact the author as other terms are available for a fee.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> </span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Zach Laine</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> whatwasthataddress@gmail.com */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef _GG_OgreGUI_h_ </span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="preprocessor">#define _GG_OgreGUI_h_</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifdef __APPLE__</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="comment">/* prevents OpenTransportProviders.h (a system header in Mac SDKs)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> from trying to enum what's already defined by related headers */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#undef TCP_NODELAY</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_MAXSEG</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_NOTIFY_THRESHOLD</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_ABORT_THRESHOLD</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_CONN_NOTIFY_THRESHOLD</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_CONN_ABORT_THRESHOLD</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_OOBINLINE</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_URGENT_PTR_TYPE</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#undef TCP_KEEPALIVE</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#include <Carbon/Carbon.h></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include <OgreDataStream.h></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include <OgreRenderTargetListener.h></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include <OgreSharedPtr.h></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#include <OgreTimer.h></span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include <OgreWindowEventUtilities.h></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#include <<a class="code" href="GUI_8h.html" title="Contains GUI class, which encapsulates the state and behavior of the entire GG GUI.">GG/GUI.h</a>></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#ifdef _MSC_VER</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span><span class="preprocessor"># ifdef GiGiOgre_EXPORTS</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span><span class="preprocessor"># define GG_OGRE_API __declspec(dllexport)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"></span><span class="preprocessor"># else</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"></span><span class="preprocessor"># define GG_OGRE_API __declspec(dllimport)</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span><span class="preprocessor"># endif</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"></span><span class="preprocessor"># define GG_OGRE_API</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">namespace </span>Ogre {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">class </span>RenderWindow;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">namespace </span>GG {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="code" href="classGG_1_1OgreGUI.html"> 123</a></span> <span class="keyword">class </span>GG_OGRE_API <a class="code" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a> :</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">public</span> <a class="code" href="classGG_1_1GUI.html" title="An abstract base for an GUI framework class to drive the GG GUI.">GUI</a>,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">public</span> Ogre::RenderTargetListener,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">public</span> Ogre::WindowEventListener</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> {</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">explicit</span> <a class="code" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a>(Ogre::RenderWindow* window, <span class="keyword">const</span> std::string& config_filename = <span class="stringliteral">""</span>);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">virtual</span> ~<a class="code" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a>();</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">virtual</span> boost::shared_ptr<ModalEventPump> CreateModalEventPump(<span class="keywordtype">bool</span>& done);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Ticks() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">virtual</span> <a class="code" href="classGG_1_1X.html" title="The x-coordinate value type.">X</a> AppWidth() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> <a class="code" href="classGG_1_1Y.html" title="The y-coordinate value type.">Y</a> AppHeight() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">const</span> Ogre::SharedPtr<Ogre::DataStream>& ConfigFileStream() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Exit(<span class="keywordtype">int</span> code);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="code" href="classGG_1_1OgreGUI.html#a2dec3a7093525acb470d53ab026b86fa"> 153</a></span>  boost::signal<void ()> <a class="code" href="classGG_1_1OgreGUI.html#a2dec3a7093525acb470d53ab026b86fa">HandleSystemEventsSignal</a>;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="code" href="classGG_1_1OgreGUI.html#a61e85ebcaa9adaf82f2acbcbd2c6ce2b"> 156</a></span>  boost::signal<void (X, Y)> <a class="code" href="classGG_1_1OgreGUI.html#a61e85ebcaa9adaf82f2acbcbd2c6ce2b">WindowResizedSignal</a>;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="code" href="classGG_1_1OgreGUI.html#aed528ba8e6361e3c4cdd51b3ae611a31"> 160</a></span>  boost::signal<void ()> <a class="code" href="classGG_1_1OgreGUI.html#aed528ba8e6361e3c4cdd51b3ae611a31">WindowClosedSignal</a>;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">static</span> <a class="code" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a>* GetGUI();</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> RenderBegin();</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> RenderEnd();</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run();</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> HandleSystemEvents();</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Enter2DMode();</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Exit2DMode();</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> postRenderTargetUpdate(<span class="keyword">const</span> Ogre::RenderTargetEvent& event);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> windowResized(Ogre::RenderWindow* window);</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> windowClosed(Ogre::RenderWindow* window);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  Ogre::RenderWindow* m_window;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">mutable</span> Ogre::Timer m_timer;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  Ogre::SharedPtr<Ogre::DataStream> m_config_file_data;</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> };</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> } <span class="comment">// namespace GG</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:30 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
