/OreWar/docs/html/_gorilla_8h_source.html

https://github.com/MikeShire/OreWar · HTML · 3034 lines · 3033 code · 0 blank · 1 comment · 0 complexity · 352e4ae3e3c19d0b51a840d39767aab8 MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>OreWar: C:/Programming/Personal/OreWar/OreWar/Gorilla.h Source File</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.6.3 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul>
    14. 

  14.       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li><a href="annotated.html"><span>Classes</span></a></li>
    16. 

  16.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    17. 

  17.     </ul>
    18. 

  18.   </div>
    19. 

  19.   <div class="tabs">
    20. 

  20.     <ul>
    21. 

  21.       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    22. 

  22.     </ul>
    23. 

  23.   </div>
    24. 

  24. <h1>C:/Programming/Personal/OreWar/OreWar/Gorilla.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
    25. 

  25. <a name="l00002"></a>00002 <span class="comment">    Gorilla</span>
    26. 

  26. <a name="l00003"></a>00003 <span class="comment">    -------</span>
    27. 

  27. <a name="l00004"></a>00004 <span class="comment">    </span>
    28. 

  28. <a name="l00005"></a>00005 <span class="comment">    Copyright (c) 2010 Robin Southern</span>
    29. 

  29. <a name="l00006"></a>00006 <span class="comment"></span>
    30. 

  30. <a name="l00007"></a>00007 <span class="comment">    Additional contributions by:</span>
    31. 

  31. <a name="l00008"></a>00008 <span class="comment"></span>
    32. 

  32. <a name="l00009"></a>00009 <span class="comment">    - Murat Sari</span>
    33. 

  33. <a name="l00010"></a>00010 <span class="comment">    - Nigel Atkinson</span>
    34. 

  34. <a name="l00011"></a>00011 <span class="comment">                                                                                  </span>
    35. 

  35. <a name="l00012"></a>00012 <span class="comment">    Permission is hereby granted, free of charge, to any person obtaining a copy</span>
    36. 

  36. <a name="l00013"></a>00013 <span class="comment">    of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
    37. 

  37. <a name="l00014"></a>00014 <span class="comment">    in the Software without restriction, including without limitation the rights</span>
    38. 

  38. <a name="l00015"></a>00015 <span class="comment">    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
    39. 

  39. <a name="l00016"></a>00016 <span class="comment">    copies of the Software, and to permit persons to whom the Software is</span>
    40. 

  40. <a name="l00017"></a>00017 <span class="comment">    furnished to do so, subject to the following conditions:</span>
    41. 

  41. <a name="l00018"></a>00018 <span class="comment">                                                                                  </span>
    42. 

  42. <a name="l00019"></a>00019 <span class="comment">    The above copyright notice and this permission notice shall be included in</span>
    43. 

  43. <a name="l00020"></a>00020 <span class="comment">    all copies or substantial portions of the Software.</span>
    44. 

  44. <a name="l00021"></a>00021 <span class="comment">                                                                                  </span>
    45. 

  45. <a name="l00022"></a>00022 <span class="comment">    THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
    46. 

  46. <a name="l00023"></a>00023 <span class="comment">    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
    47. 

  47. <a name="l00024"></a>00024 <span class="comment">    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
    48. 

  48. <a name="l00025"></a>00025 <span class="comment">    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
    49. 

  49. <a name="l00026"></a>00026 <span class="comment">    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
    50. 

  50. <a name="l00027"></a>00027 <span class="comment">    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
    51. 

  51. <a name="l00028"></a>00028 <span class="comment">    THE SOFTWARE. </span>
    52. 

  52. <a name="l00029"></a>00029 <span class="comment">    </span>
    53. 

  53. <a name="l00030"></a>00030 <span class="comment">*/</span>
    54. 

  54. <a name="l00031"></a>00031 
    55. 

  55. <a name="l00032"></a>00032 <span class="preprocessor">#ifndef GORILLA_H</span>
    56. 

  56. <a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define GORILLA_H</span>
    57. 

  57. <a name="l00034"></a>00034 <span class="preprocessor"></span>
    58. 

  58. <a name="l00035"></a>00035 <span class="preprocessor">#include &quot;Ogre.h&quot;</span>
    59. 

  59. <a name="l00036"></a>00036 
    60. 

  60. <a name="l00037"></a>00037 <span class="preprocessor">#ifndef GORILLA_USES_EXCEPTIONS</span>
    61. 

  61. <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#  define GORILLA_USES_EXCEPTIONS 0</span>
    62. 

  62. <a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    63. 

  63. <a name="l00040"></a>00040 <span class="preprocessor"></span>
    64. 

  64. <a name="l00041"></a>00041 <span class="preprocessor">#if OGRE_COMP == OGRE_COMPILER_GNUC</span>
    65. 

  65. <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#   define __FUNC__ __PRETTY_FUNCTION__</span>
    66. 

  66. <a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#elif OGRE_COMP != OGRE_COMPILER_BORL</span>
    67. 

  67. <a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#   define __FUNC__ &quot;No function name info&quot;</span>
    68. 

  68. <a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
    69. 

  69. <a name="l00046"></a>00046 <span class="preprocessor"></span>
    70. 

  70. <a name="l00047"></a>00047 <span class="keyword">namespace </span>Gorilla
    71. 

  71. <a name="l00048"></a>00048 {
    72. 

  72. <a name="l00049"></a>00049  
    73. 

  73. <a name="l00050"></a>00050  <span class="keyword">class </span>Silverback;
    74. 

  74. <a name="l00051"></a>00051  <span class="keyword">class </span>TextureAtlas;
    75. 

  75. <a name="l00052"></a>00052  <span class="keyword">class </span>LayerContainer;
    76. 

  76. <a name="l00053"></a>00053  <span class="keyword">class </span>Screen;
    77. 

  77. <a name="l00054"></a>00054  <span class="keyword">class </span>ScreenRenderable;
    78. 

  78. <a name="l00055"></a>00055  <span class="keyword">class </span>Layer;
    79. 

  79. <a name="l00056"></a>00056  <span class="keyword">class </span>Rectangle;
    80. 

  80. <a name="l00057"></a>00057  <span class="keyword">class </span>Polygon;
    81. 

  81. <a name="l00058"></a>00058  <span class="keyword">class </span>LineList;
    82. 

  82. <a name="l00059"></a>00059  <span class="keyword">class </span>QuadList;
    83. 

  83. <a name="l00060"></a>00060  <span class="keyword">class </span>Caption;
    84. 

  84. <a name="l00061"></a>00061  <span class="keyword">class </span>MarkupText;
    85. 

  85. <a name="l00062"></a>00062  
    86. 

  86. <a name="l00063"></a><a class="code" href="struct_gorilla_1_1_vector_type.html">00063</a>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span><a class="code" href="struct_gorilla_1_1_vector_type.html">VectorType</a>
    87. 

  87. <a name="l00064"></a>00064  {
    88. 

  88. <a name="l00065"></a>00065 <span class="preprocessor">#if OGRE_VERSION &lt;= 67077 // If the version is less than or equal to 1.6.5</span>
    89. 

  89. <a name="l00066"></a>00066 <span class="preprocessor"></span>  <span class="keyword">typedef</span> std::vector&lt;T&gt; type;
    90. 

  90. <a name="l00067"></a>00067 <span class="preprocessor">#else</span>
    91. 

  91. <a name="l00068"></a>00068 <span class="preprocessor"></span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> Ogre::vector&lt;T&gt;::type type;
    92. 

  92. <a name="l00069"></a>00069 <span class="preprocessor">#endif</span>
    93. 

  93. <a name="l00070"></a>00070 <span class="preprocessor"></span> };
    94. 

  94. <a name="l00071"></a>00071  
    95. 

  95. <a name="l00072"></a>00072  <span class="keyword">namespace </span>Colours
    96. 

  96. <a name="l00073"></a>00073  {
    97. 

  97. <a name="l00074"></a>00074   <span class="keyword">enum</span> Colour
    98. 

  98. <a name="l00075"></a>00075   {
    99. 

  99. <a name="l00076"></a>00076    None = 0, <span class="comment">// No Colour.</span>
    100. 

  100. <a name="l00077"></a>00077    AliceBlue=0xf0f8ff,      Gainsboro=0xdcdcdc,            MistyRose=0xffe4e1,
    101. 

  101. <a name="l00078"></a>00078    AntiqueWhite=0xfaebd7,   GhostWhite=0xf8f8ff,           Moccasin=0xffe4b5,
    102. 

  102. <a name="l00079"></a>00079    Aqua=0x00ffff,           Gold=0xffd700,                 NavajoWhite=0xffdead,
    103. 

  103. <a name="l00080"></a>00080    Aquamarine=0x7fffd4,     Goldenrod=0xdaa520,            Navy=0x000080,
    104. 

  104. <a name="l00081"></a>00081    Azure=0xf0ffff,          Gray=0x808080,                 OldLace=0xfdf5e6,
    105. 

  105. <a name="l00082"></a>00082    Beige=0xf5f5dc,          Green=0x008000,                Olive=0x808000,
    106. 

  106. <a name="l00083"></a>00083    Bisque=0xffe4c4,         GreenYellow=0xadff2f,          OliveDrab=0x6b8e23,
    107. 

  107. <a name="l00084"></a>00084    Black=0x000000,          Grey=0x808080,                 Orange=0xffa500,
    108. 

  108. <a name="l00085"></a>00085    BlanchedAlmond=0xffebcd, Honeydew=0xf0fff0,             OrangeRed=0xff4500,
    109. 

  109. <a name="l00086"></a>00086    Blue=0x0000ff,           HotPink=0xff69b4,              Orchid=0xda70d6,
    110. 

  110. <a name="l00087"></a>00087    BlueViolet=0x8a2be2,     IndianRed=0xcd5c5c,            PaleGoldenrod=0xeee8aa,
    111. 

  111. <a name="l00088"></a>00088    Brown=0xa52a2a,          Indigo=0x4b0082,               PaleGreen=0x98fb98,
    112. 

  112. <a name="l00089"></a>00089    Burlywood=0xdeb887,      Ivory=0xfffff0,                PaleTurquoise=0xafeeee,
    113. 

  113. <a name="l00090"></a>00090    CadetBlue=0x5f9ea0,      Khaki=0xf0e68c,                PaleVioletRed=0xdb7093,
    114. 

  114. <a name="l00091"></a>00091    Chartreuse=0x7fff00,     Lavender=0xe6e6fa,             PapayaWhip=0xffefd5,
    115. 

  115. <a name="l00092"></a>00092    Chocolate=0xd2691e,      LavenderBlush=0xfff0f5,        PeachPuff=0xffdab9,
    116. 

  116. <a name="l00093"></a>00093    Coral=0xff7f50,          LawnGreen=0x7cfc00,            Peru=0xcd853f,
    117. 

  117. <a name="l00094"></a>00094    CornflowerBlue=0x6495ed, LemonChiffon=0xfffacd,         Pink=0xffc0cb,
    118. 

  118. <a name="l00095"></a>00095    Cornsilk=0xfff8dc,       LightBlue=0xadd8e6,            Plum=0xdda0dd,
    119. 

  119. <a name="l00096"></a>00096    Crimson=0xdc143c,        LightCoral=0xf08080,           PowderBlue=0xb0e0e6,
    120. 

  120. <a name="l00097"></a>00097    Cyan=0x00ffff,           LightCyan=0xe0ffff,            Purple=0x800080,
    121. 

  121. <a name="l00098"></a>00098    DarkBlue=0x00008b,       LightGoldenrodyellow=0xfafad2, Red=0xff0000,
    122. 

  122. <a name="l00099"></a>00099    DarkCyan=0x008b8b,       LightGray=0xd3d3d3,            RosyBrown=0xbc8f8f,
    123. 

  123. <a name="l00100"></a>00100    DarkGoldenrod=0xb8860b,  LightGreen=0x90ee90,           RoyalBlue=0x4169e1,
    124. 

  124. <a name="l00101"></a>00101    DarkGray=0xa9a9a9,       LightGrey=0xd3d3d3,            SaddleBrown=0x8b4513,
    125. 

  125. <a name="l00102"></a>00102    DarkGreen=0x006400,      LightPink=0xffb6c1,            Salmon=0xfa8072,
    126. 

  126. <a name="l00103"></a>00103    DarkGrey=0xa9a9a9,       LightSalmon=0xffa07a,          SandyBrown=0xf4a460,
    127. 

  127. <a name="l00104"></a>00104    DarkKhaki=0xbdb76b,      LightSeagreen=0x20b2aa,        SeaGreen=0x2e8b57,
    128. 

  128. <a name="l00105"></a>00105    DarkMagenta=0x8b008b,    LightSkyblue=0x87cefa,         SeaShell=0xfff5ee,
    129. 

  129. <a name="l00106"></a>00106    DarkOlivegreen=0x556b2f, LightSlategray=0x778899,       Sienna=0xa0522d,
    130. 

  130. <a name="l00107"></a>00107    DarkOrange=0xff8c00,     LightSlategrey=0x778899,       Silver=0xc0c0c0,
    131. 

  131. <a name="l00108"></a>00108    DarkOrchid=0x9932cc,     LightSteelblue=0xb0c4de,       SkyBlue=0x87ceeb,
    132. 

  132. <a name="l00109"></a>00109    DarkRed=0x8b0000,        LightYellow=0xffffe0,          SlateBlue=0x6a5acd,
    133. 

  133. <a name="l00110"></a>00110    DarkSalmon=0xe9967a,     Lime=0x00ff00,                 SlateGray=0x708090,
    134. 

  134. <a name="l00111"></a>00111    DarkSeagreen=0x8fbc8f,   LimeGreen=0x32cd32,            SlateGrey=0x708090,
    135. 

  135. <a name="l00112"></a>00112    DarkSlateblue=0x483d8b,  Linen=0xfaf0e6,                Snow=0xfffafa,
    136. 

  136. <a name="l00113"></a>00113    DarkSlategray=0x2f4f4f,  Magenta=0xff00ff,              SpringGreen=0x00ff7f,
    137. 

  137. <a name="l00114"></a>00114    DarkSlategrey=0x2f4f4f,  Maroon=0x800000,               SteelBlue=0x4682b4,
    138. 

  138. <a name="l00115"></a>00115    DarkTurquoise=0x00ced1,  MediumAquamarine=0x66cdaa,     Tan=0xd2b48c,
    139. 

  139. <a name="l00116"></a>00116    DarkViolet=0x9400d3,     MediumBlue=0x0000cd,           Teal=0x008080,
    140. 

  140. <a name="l00117"></a>00117    DeepPink=0xff1493,       MediumOrchid=0xba55d3,         Thistle=0xd8bfd8,
    141. 

  141. <a name="l00118"></a>00118    DeepSkyblue=0x00bfff,    MediumPurple=0x9370db,         Tomato=0xff6347,
    142. 

  142. <a name="l00119"></a>00119    DimGray=0x696969,        MediumSeaGreen=0x3cb371,       Turquoise=0x40e0d0,
    143. 

  143. <a name="l00120"></a>00120    DimGrey=0x696969,        MediumSlateBlue=0x7b68ee,      Violet=0xee82ee,
    144. 

  144. <a name="l00121"></a>00121    DodgerBlue=0x1e90ff,     MediumSpringGreen=0x00fa9a,    Wheat=0xf5deb3,
    145. 

  145. <a name="l00122"></a>00122    FireBrick=0xb22222,      MediumTurquoise=0x48d1cc,      White=0xffffff,
    146. 

  146. <a name="l00123"></a>00123    FloralWhite=0xfffaf0,    MediumBioletRed=0xc71585,      WhiteSmoke=0xf5f5f5,
    147. 

  147. <a name="l00124"></a>00124    ForestGreen=0x228b22,    MidnightBlue=0x191970,         Yellow=0xffff00,
    148. 

  148. <a name="l00125"></a>00125    Fuchsia=0xff00ff,        MintCream=0xf5fffa,            YellowGreen=0x9acd32
    149. 

  149. <a name="l00126"></a>00126   }; <span class="comment">// Colour</span>
    150. 

  150. <a name="l00127"></a>00127  } <span class="comment">// namespace Colours</span>
    151. 

  151. <a name="l00128"></a>00128 <span class="comment"></span>
    152. 

  152. <a name="l00129"></a>00129 <span class="comment"> /*! function. rgb</span>
    153. 

  153. <a name="l00130"></a>00130 <span class="comment">     desc.</span>
    154. 

  154. <a name="l00131"></a>00131 <span class="comment">         Convert three/four RGBA values into an Ogre::ColourValue</span>
    155. 

  155. <a name="l00132"></a>00132 <span class="comment"> */</span>
    156. 

  156. <a name="l00133"></a>00133  Ogre::ColourValue rgb(Ogre::uchar r, Ogre::uchar g, Ogre::uchar b, Ogre::uchar a = 255);
    157. 

  157. <a name="l00134"></a>00134  <span class="comment"></span>
    158. 

  158. <a name="l00135"></a>00135 <span class="comment"> /*! function. webcolour</span>
    159. 

  159. <a name="l00136"></a>00136 <span class="comment">     desc.</span>
    160. 

  160. <a name="l00137"></a>00137 <span class="comment">         Turn a webcolour from the Gorilla::Colours::Colour enum into an Ogre::ColourValue</span>
    161. 

  161. <a name="l00138"></a>00138 <span class="comment"> */</span>
    162. 

  162. <a name="l00139"></a>00139  Ogre::ColourValue webcolour(Colours::Colour, Ogre::Real alpha = 1.0);
    163. 

  163. <a name="l00140"></a>00140  <span class="comment"></span>
    164. 

  164. <a name="l00141"></a>00141 <span class="comment"> /*! enum. Gradient</span>
    165. 

  165. <a name="l00142"></a>00142 <span class="comment">     desc.</span>
    166. 

  166. <a name="l00143"></a>00143 <span class="comment">         Directions for background gradients</span>
    167. 

  167. <a name="l00144"></a>00144 <span class="comment"> */</span>
    168. 

  168. <a name="l00145"></a>00145  <span class="keyword">enum</span> Gradient
    169. 

  169. <a name="l00146"></a>00146  {
    170. 

  170. <a name="l00147"></a>00147   Gradient_NorthSouth,
    171. 

  171. <a name="l00148"></a>00148   Gradient_WestEast,
    172. 

  172. <a name="l00149"></a>00149   Gradient_Diagonal
    173. 

  173. <a name="l00150"></a>00150  };
    174. 

  174. <a name="l00151"></a>00151 <span class="comment"></span>
    175. 

  175. <a name="l00152"></a>00152 <span class="comment"> /*! enum. Border</span>
    176. 

  176. <a name="l00153"></a>00153 <span class="comment">     desc.</span>
    177. 

  177. <a name="l00154"></a>00154 <span class="comment">         Border Directions</span>
    178. 

  178. <a name="l00155"></a>00155 <span class="comment">         </span>
    179. 

  179. <a name="l00156"></a>00156 <span class="comment">         </span>
    180. 

  180. <a name="l00157"></a>00157 <span class="comment">         +---------------------+</span>
    181. 

  181. <a name="l00158"></a>00158 <span class="comment">         |\       NORTH       /|</span>
    182. 

  182. <a name="l00159"></a>00159 <span class="comment">         | \                 / |</span>
    183. 

  183. <a name="l00160"></a>00160 <span class="comment">         |  +---------------+  |</span>
    184. 

  184. <a name="l00161"></a>00161 <span class="comment">         |  |               |  |</span>
    185. 

  185. <a name="l00162"></a>00162 <span class="comment">         | W|               |E |</span>
    186. 

  186. <a name="l00163"></a>00163 <span class="comment">         | E|               |A |</span>
    187. 

  187. <a name="l00164"></a>00164 <span class="comment">         | S|               |S |</span>
    188. 

  188. <a name="l00165"></a>00165 <span class="comment">         | T|               |T |</span>
    189. 

  189. <a name="l00166"></a>00166 <span class="comment">         |  |               |  |</span>
    190. 

  190. <a name="l00167"></a>00167 <span class="comment">         |  +---------------+  |</span>
    191. 

  191. <a name="l00168"></a>00168 <span class="comment">         | /      SOUTH      \ |</span>
    192. 

  192. <a name="l00169"></a>00169 <span class="comment">         |/                   \|</span>
    193. 

  193. <a name="l00170"></a>00170 <span class="comment">         +---------------------+</span>
    194. 

  194. <a name="l00171"></a>00171 <span class="comment"> */</span>
    195. 

  195. <a name="l00172"></a>00172  <span class="keyword">enum</span> Border
    196. 

  196. <a name="l00173"></a>00173  {
    197. 

  197. <a name="l00174"></a>00174   Border_North = 0,
    198. 

  198. <a name="l00175"></a>00175   Border_South = 1,
    199. 

  199. <a name="l00176"></a>00176   Border_East  = 2,
    200. 

  200. <a name="l00177"></a>00177   Border_West  = 3
    201. 

  201. <a name="l00178"></a>00178  };
    202. 

  202. <a name="l00179"></a>00179  <span class="comment"></span>
    203. 

  203. <a name="l00180"></a>00180 <span class="comment"> /*! enum. QuadCorner</span>
    204. 

  204. <a name="l00181"></a>00181 <span class="comment">     desc.</span>
    205. 

  205. <a name="l00182"></a>00182 <span class="comment">         Names of each corner/vertex of a Quad</span>
    206. 

  206. <a name="l00183"></a>00183 <span class="comment"> */</span>
    207. 

  207. <a name="l00184"></a>00184  <span class="keyword">enum</span> QuadCorner
    208. 

  208. <a name="l00185"></a>00185  {
    209. 

  209. <a name="l00186"></a>00186   TopLeft     = 0,
    210. 

  210. <a name="l00187"></a>00187   TopRight    = 1,
    211. 

  211. <a name="l00188"></a>00188   BottomRight = 2,
    212. 

  212. <a name="l00189"></a>00189   BottomLeft  = 3
    213. 

  213. <a name="l00190"></a>00190  };
    214. 

  214. <a name="l00191"></a>00191  <span class="comment"></span>
    215. 

  215. <a name="l00192"></a>00192 <span class="comment"> /*! enum. TextAlignment</span>
    216. 

  216. <a name="l00193"></a>00193 <span class="comment">     desc.</span>
    217. 

  217. <a name="l00194"></a>00194 <span class="comment">         Horizontal text alignment for captions.</span>
    218. 

  218. <a name="l00195"></a>00195 <span class="comment"> */</span>
    219. 

  219. <a name="l00196"></a>00196  <span class="keyword">enum</span> TextAlignment
    220. 

  220. <a name="l00197"></a>00197  {
    221. 

  221. <a name="l00198"></a>00198   TextAlign_Left,   <span class="comment">// Place the text to where left is (X = left)</span>
    222. 

  222. <a name="l00199"></a>00199   TextAlign_Right,  <span class="comment">// Place the text to the right of left (X = left - text_width)</span>
    223. 

  223. <a name="l00200"></a>00200   TextAlign_Centre, <span class="comment">// Place the text centered at left (X = left - (text_width / 2 ) )</span>
    224. 

  224. <a name="l00201"></a>00201  };
    225. 

  225. <a name="l00202"></a>00202  <span class="comment"></span>
    226. 

  226. <a name="l00203"></a>00203 <span class="comment"> /*! enum. VerticalAlignment</span>
    227. 

  227. <a name="l00204"></a>00204 <span class="comment">     desc.</span>
    228. 

  228. <a name="l00205"></a>00205 <span class="comment">         Vertical text alignment for captions.</span>
    229. 

  229. <a name="l00206"></a>00206 <span class="comment"> */</span>
    230. 

  230. <a name="l00207"></a>00207  <span class="keyword">enum</span> VerticalAlignment
    231. 

  231. <a name="l00208"></a>00208  {
    232. 

  232. <a name="l00209"></a>00209   VerticalAlign_Top,
    233. 

  233. <a name="l00210"></a>00210   VerticalAlign_Middle,
    234. 

  234. <a name="l00211"></a>00211   VerticalAlign_Bottom
    235. 

  235. <a name="l00212"></a>00212  };
    236. 

  236. <a name="l00213"></a>00213  <span class="comment"></span>
    237. 

  237. <a name="l00214"></a>00214 <span class="comment"> /*! enum. buffer&lt;T&gt;</span>
    238. 

  238. <a name="l00215"></a>00215 <span class="comment">     desc.</span>
    239. 

  239. <a name="l00216"></a>00216 <span class="comment">         Internal container class that is similar to std::vector</span>
    240. 

  240. <a name="l00217"></a>00217 <span class="comment"> */</span>
    241. 

  241. <a name="l00218"></a><a class="code" href="class_gorilla_1_1buffer.html">00218</a>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keyword">class </span><a class="code" href="class_gorilla_1_1buffer.html">buffer</a>
    242. 

  242. <a name="l00219"></a>00219  {
    243. 

  243. <a name="l00220"></a>00220    
    244. 

  244. <a name="l00221"></a>00221   <span class="keyword">public</span>:
    245. 

  245. <a name="l00222"></a>00222    
    246. 

  246. <a name="l00223"></a>00223    <span class="keyword">inline</span> <a class="code" href="class_gorilla_1_1buffer.html">buffer</a>() : mBuffer(0), mUsed(0), mCapacity(0)
    247. 

  247. <a name="l00224"></a>00224    { <span class="comment">// no code.</span>
    248. 

  248. <a name="l00225"></a>00225    }
    249. 

  249. <a name="l00226"></a>00226   
    250. 

  250. <a name="l00227"></a>00227    <span class="keyword">inline</span> ~<a class="code" href="class_gorilla_1_1buffer.html">buffer</a>()
    251. 

  251. <a name="l00228"></a>00228    {
    252. 

  252. <a name="l00229"></a>00229     <span class="keywordflow">if</span> (mBuffer &amp;&amp; mCapacity)
    253. 

  253. <a name="l00230"></a>00230      OGRE_FREE(mBuffer, Ogre::MEMCATEGORY_GEOMETRY);
    254. 

  254. <a name="l00231"></a>00231    }
    255. 

  255. <a name="l00232"></a>00232    
    256. 

  256. <a name="l00233"></a>00233    <span class="keyword">inline</span> <span class="keywordtype">size_t</span> size()<span class="keyword"> const</span>
    257. 

  257. <a name="l00234"></a>00234 <span class="keyword">   </span>{
    258. 

  258. <a name="l00235"></a>00235     <span class="keywordflow">return</span> mUsed;
    259. 

  259. <a name="l00236"></a>00236    }
    260. 

  260. <a name="l00237"></a>00237    
    261. 

  261. <a name="l00238"></a>00238    <span class="keyword">inline</span> <span class="keywordtype">size_t</span> capacity()<span class="keyword"> const</span>
    262. 

  262. <a name="l00239"></a>00239 <span class="keyword">   </span>{
    263. 

  263. <a name="l00240"></a>00240     <span class="keywordflow">return</span> mCapacity;
    264. 

  264. <a name="l00241"></a>00241    }
    265. 

  265. <a name="l00242"></a>00242    
    266. 

  266. <a name="l00243"></a>00243    <span class="keyword">inline</span> T&amp; operator[](<span class="keywordtype">size_t</span> index)
    267. 

  267. <a name="l00244"></a>00244    {
    268. 

  268. <a name="l00245"></a>00245     <span class="keywordflow">return</span> *(mBuffer + index);
    269. 

  269. <a name="l00246"></a>00246    }
    270. 

  270. <a name="l00247"></a>00247 
    271. 

  271. <a name="l00248"></a>00248    <span class="keyword">inline</span> <span class="keyword">const</span> T&amp; operator[](<span class="keywordtype">size_t</span> index)<span class="keyword"> const</span>
    272. 

  272. <a name="l00249"></a>00249 <span class="keyword">   </span>{
    273. 

  273. <a name="l00250"></a>00250     <span class="keywordflow">return</span> *(mBuffer + index);
    274. 

  274. <a name="l00251"></a>00251    }
    275. 

  275. <a name="l00252"></a>00252 
    276. 

  276. <a name="l00253"></a>00253    <span class="keyword">inline</span> T&amp; at(<span class="keywordtype">size_t</span> index)
    277. 

  277. <a name="l00254"></a>00254    {
    278. 

  278. <a name="l00255"></a>00255     <span class="keywordflow">return</span> *(mBuffer + index);
    279. 

  279. <a name="l00256"></a>00256    }
    280. 

  280. <a name="l00257"></a>00257 
    281. 

  281. <a name="l00258"></a>00258    <span class="keyword">inline</span> <span class="keyword">const</span> T&amp; at(<span class="keywordtype">size_t</span> index)<span class="keyword"> const</span>
    282. 

  282. <a name="l00259"></a>00259 <span class="keyword">   </span>{
    283. 

  283. <a name="l00260"></a>00260     <span class="keywordflow">return</span> *(mBuffer + index);
    284. 

  284. <a name="l00261"></a>00261    }
    285. 

  285. <a name="l00262"></a>00262    
    286. 

  286. <a name="l00263"></a>00263    <span class="keyword">inline</span> <span class="keywordtype">void</span> remove_all()
    287. 

  287. <a name="l00264"></a>00264    {
    288. 

  288. <a name="l00265"></a>00265     mUsed = 0;
    289. 

  289. <a name="l00266"></a>00266    }
    290. 

  290. <a name="l00267"></a>00267     
    291. 

  291. <a name="l00268"></a>00268    <span class="keyword">inline</span> <span class="keywordtype">void</span> resize(<span class="keywordtype">size_t</span> new_capacity)
    292. 

  292. <a name="l00269"></a>00269    {
    293. 

  293. <a name="l00270"></a>00270     T* new_buffer = (T*) OGRE_MALLOC(<span class="keyword">sizeof</span>(T) * new_capacity, Ogre::MEMCATEGORY_GEOMETRY);
    294. 

  294. <a name="l00271"></a>00271     
    295. 

  295. <a name="l00272"></a>00272     <span class="keywordflow">if</span> (mUsed != 0)
    296. 

  296. <a name="l00273"></a>00273     {
    297. 

  297. <a name="l00274"></a>00274      <span class="keywordflow">if</span> (mUsed &lt; new_capacity)  <span class="comment">// Copy all</span>
    298. 

  298. <a name="l00275"></a>00275       std::copy(mBuffer, mBuffer + mUsed, new_buffer);
    299. 

  299. <a name="l00276"></a>00276      <span class="keywordflow">else</span> <span class="keywordflow">if</span> (mUsed &gt;= new_capacity) <span class="comment">// Copy some</span>
    300. 

  300. <a name="l00277"></a>00277       std::copy(mBuffer, mBuffer + new_capacity, new_buffer);
    301. 

  301. <a name="l00278"></a>00278     }
    302. 

  302. <a name="l00279"></a>00279     
    303. 

  303. <a name="l00280"></a>00280     OGRE_FREE(mBuffer, Ogre::MEMCATEGORY_GEOMETRY);
    304. 

  304. <a name="l00281"></a>00281     mCapacity = new_capacity;
    305. 

  305. <a name="l00282"></a>00282     mBuffer = new_buffer;
    306. 

  306. <a name="l00283"></a>00283    }
    307. 

  307. <a name="l00284"></a>00284    
    308. 

  308. <a name="l00285"></a>00285    <span class="keyword">inline</span> <span class="keywordtype">void</span> push_back(<span class="keyword">const</span> T&amp; value)
    309. 

  309. <a name="l00286"></a>00286    {
    310. 

  310. <a name="l00287"></a>00287     <span class="keywordflow">if</span> (mUsed == mCapacity)
    311. 

  311. <a name="l00288"></a>00288      resize(mUsed == 0 ? 1 : mUsed * 2);
    312. 

  312. <a name="l00289"></a>00289     *(mBuffer + mUsed) = value;
    313. 

  313. <a name="l00290"></a>00290     mUsed++;
    314. 

  314. <a name="l00291"></a>00291    }
    315. 

  315. <a name="l00292"></a>00292    
    316. 

  316. <a name="l00293"></a>00293    <span class="keyword">inline</span> <span class="keywordtype">void</span> pop_back()
    317. 

  317. <a name="l00294"></a>00294    {
    318. 

  318. <a name="l00295"></a>00295     <span class="keywordflow">if</span> (mUsed != 0)
    319. 

  319. <a name="l00296"></a>00296      mUsed--;
    320. 

  320. <a name="l00297"></a>00297    }
    321. 

  321. <a name="l00298"></a>00298    
    322. 

  322. <a name="l00299"></a>00299    <span class="keyword">inline</span> <span class="keywordtype">void</span> erase(<span class="keywordtype">size_t</span> index)
    323. 

  323. <a name="l00300"></a>00300    {
    324. 

  324. <a name="l00301"></a>00301     *(mBuffer + index) = *(mBuffer + mUsed - 1);
    325. 

  325. <a name="l00302"></a>00302     mUsed--;
    326. 

  326. <a name="l00303"></a>00303    }
    327. 

  327. <a name="l00304"></a>00304    
    328. 

  328. <a name="l00305"></a>00305    <span class="keyword">inline</span>  T* first()
    329. 

  329. <a name="l00306"></a>00306    {
    330. 

  330. <a name="l00307"></a>00307     <span class="keywordflow">return</span> mBuffer;
    331. 

  331. <a name="l00308"></a>00308    }
    332. 

  332. <a name="l00309"></a>00309    
    333. 

  333. <a name="l00310"></a>00310    <span class="keyword">inline</span> T* last()
    334. 

  334. <a name="l00311"></a>00311    {
    335. 

  335. <a name="l00312"></a>00312     <span class="keywordflow">return</span> mBuffer + mUsed;
    336. 

  336. <a name="l00313"></a>00313    }
    337. 

  337. <a name="l00314"></a>00314    
    338. 

  338. <a name="l00315"></a>00315   <span class="keyword">protected</span>:
    339. 

  339. <a name="l00316"></a>00316    
    340. 

  340. <a name="l00317"></a>00317    T*     mBuffer;
    341. 

  341. <a name="l00318"></a>00318    <span class="keywordtype">size_t</span> mUsed, mCapacity;
    342. 

  342. <a name="l00319"></a>00319  };
    343. 

  343. <a name="l00320"></a>00320  <span class="comment"></span>
    344. 

  344. <a name="l00321"></a>00321 <span class="comment"> /*! struct. Vertex</span>
    345. 

  345. <a name="l00322"></a>00322 <span class="comment">     desc.</span>
    346. 

  346. <a name="l00323"></a>00323 <span class="comment">         Structure for a single vertex.</span>
    347. 

  347. <a name="l00324"></a>00324 <span class="comment"> */</span>
    348. 

  348. <a name="l00325"></a><a class="code" href="struct_gorilla_1_1_vertex.html">00325</a>  <span class="keyword">struct </span><a class="code" href="struct_gorilla_1_1_vertex.html">Vertex</a>
    349. 

  349. <a name="l00326"></a>00326  {
    350. 

  350. <a name="l00327"></a>00327   Ogre::Vector3 position;
    351. 

  351. <a name="l00328"></a>00328   Ogre::ColourValue colour;
    352. 

  352. <a name="l00329"></a>00329   Ogre::Vector2 uv;
    353. 

  353. <a name="l00330"></a>00330  };
    354. 

  354. <a name="l00331"></a>00331  <span class="comment"></span>
    355. 

  355. <a name="l00332"></a>00332 <span class="comment"> /*! struct. Kerning</span>
    356. 

  356. <a name="l00333"></a>00333 <span class="comment">     desc.</span>
    357. 

  357. <a name="l00334"></a>00334 <span class="comment">         Distances between two characters next to each other.</span>
    358. 

  358. <a name="l00335"></a>00335 <span class="comment"> */</span>
    359. 

  359. <a name="l00336"></a><a class="code" href="struct_gorilla_1_1_kerning.html">00336</a>  <span class="keyword">struct </span><a class="code" href="struct_gorilla_1_1_kerning.html">Kerning</a>
    360. 

  360. <a name="l00337"></a>00337  {
    361. 

  361. <a name="l00338"></a>00338   <a class="code" href="struct_gorilla_1_1_kerning.html">Kerning</a>(Ogre::uint c, Ogre::Real k) : character(c), kerning(k) {}
    362. 

  362. <a name="l00339"></a>00339   Ogre::uint character;
    363. 

  363. <a name="l00340"></a>00340   Ogre::Real kerning;
    364. 

  364. <a name="l00341"></a>00341  };
    365. 

  365. <a name="l00342"></a>00342  <span class="comment"></span>
    366. 

  366. <a name="l00343"></a>00343 <span class="comment"> /*! struct. Glyph</span>
    367. 

  367. <a name="l00344"></a>00344 <span class="comment">     desc.</span>
    368. 

  368. <a name="l00345"></a>00345 <span class="comment">         Texture and size information about a single character loaded from a TextureAtlas.</span>
    369. 

  369. <a name="l00346"></a>00346 <span class="comment"> */</span>
    370. 

  370. <a name="l00347"></a><a class="code" href="class_gorilla_1_1_glyph.html">00347</a>  <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_glyph.html">Glyph</a> : <span class="keyword">public</span> Ogre::GeneralAllocatedObject
    371. 

  371. <a name="l00348"></a>00348  {
    372. 

  372. <a name="l00349"></a>00349    
    373. 

  373. <a name="l00350"></a>00350   <span class="keyword">public</span>:
    374. 

  374. <a name="l00351"></a>00351    
    375. 

  375. <a name="l00352"></a>00352    <a class="code" href="class_gorilla_1_1_glyph.html">Glyph</a>() : uvTop(0), uvBottom(0), uvWidth(0), uvHeight(0), uvLeft(0), uvRight(0), glyphWidth(0), glyphHeight(0), glyphAdvance(0), verticalOffset(0) {}
    376. 

  376. <a name="l00353"></a>00353    
    377. 

  377. <a name="l00354"></a>00354   ~<a class="code" href="class_gorilla_1_1_glyph.html">Glyph</a>() {}
    378. 

  378. <a name="l00355"></a>00355    
    379. 

  379. <a name="l00356"></a>00356    Ogre::Vector2    texCoords[4];
    380. 

  380. <a name="l00357"></a>00357    Ogre::Real uvTop, uvBottom, uvWidth, uvHeight, uvLeft, uvRight,
    381. 

  381. <a name="l00358"></a>00358                        glyphWidth, glyphHeight, glyphAdvance, verticalOffset;
    382. 

  382. <a name="l00359"></a>00359    <a class="code" href="class_gorilla_1_1buffer.html">buffer&lt;Kerning&gt;</a> kerning;
    383. 

  383. <a name="l00360"></a>00360    
    384. 

  384. <a name="l00361"></a>00361    <span class="comment">// Get kerning value of a character to the right of another.</span>
    385. 

  385. <a name="l00362"></a>00362    <span class="comment">// Ab -- get the kerning value of b, pass on A.</span>
    386. 

  386. <a name="l00363"></a>00363    <span class="keyword">inline</span> <span class="keyword">const</span> Ogre::Real getKerning(<span class="keywordtype">char</span> left_of)<span class="keyword"> const</span>
    387. 

  387. <a name="l00364"></a>00364 <span class="keyword">   </span>{
    388. 

  388. <a name="l00365"></a>00365     <span class="keywordflow">if</span> (kerning.size() == 0)
    389. 

  389. <a name="l00366"></a>00366      <span class="keywordflow">return</span> 0;
    390. 

  390. <a name="l00367"></a>00367     <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i=0;i &lt; kerning.size();i++)
    391. 

  391. <a name="l00368"></a>00368     {
    392. 

  392. <a name="l00369"></a>00369      <span class="keywordflow">if</span> (kerning[i].character == left_of)
    393. 

  393. <a name="l00370"></a>00370       <span class="keywordflow">return</span> kerning[i].kerning;
    394. 

  394. <a name="l00371"></a>00371     }
    395. 

  395. <a name="l00372"></a>00372     <span class="keywordflow">return</span> 0;
    396. 

  396. <a name="l00373"></a>00373    }
    397. 

  397. <a name="l00374"></a>00374    
    398. 

  398. <a name="l00375"></a>00375  };
    399. 

  399. <a name="l00376"></a>00376 <span class="comment"></span>
    400. 

  400. <a name="l00377"></a>00377 <span class="comment"> /*! class. Sprite</span>
    401. 

  401. <a name="l00378"></a>00378 <span class="comment">     desc.</span>
    402. 

  402. <a name="l00379"></a>00379 <span class="comment">         Portions of a texture from a TextureAtlas.</span>
    403. 

  403. <a name="l00380"></a>00380 <span class="comment"> */</span>
    404. 

  404. <a name="l00381"></a><a class="code" href="class_gorilla_1_1_sprite.html">00381</a>  <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_sprite.html">Sprite</a> : <span class="keyword">public</span> Ogre::GeneralAllocatedObject
    405. 

  405. <a name="l00382"></a>00382  {
    406. 

  406. <a name="l00383"></a>00383    
    407. 

  407. <a name="l00384"></a>00384   <span class="keyword">public</span>:
    408. 

  408. <a name="l00385"></a>00385 
    409. 

  409. <a name="l00386"></a>00386    <a class="code" href="class_gorilla_1_1_sprite.html">Sprite</a>() {}
    410. 

  410. <a name="l00387"></a>00387    
    411. 

  411. <a name="l00388"></a>00388   ~<a class="code" href="class_gorilla_1_1_sprite.html">Sprite</a>() {}
    412. 

  412. <a name="l00389"></a>00389    
    413. 

  413. <a name="l00390"></a>00390    Ogre::Real uvTop, uvLeft, uvRight, uvBottom, spriteWidth, spriteHeight;
    414. 

  414. <a name="l00391"></a>00391    Ogre::Vector2    texCoords[4];
    415. 

  415. <a name="l00392"></a>00392    
    416. 

  416. <a name="l00393"></a>00393  };
    417. 

  417. <a name="l00394"></a>00394  
    418. 

  418. <a name="l00395"></a>00395  <span class="comment">/* class. Silverback</span>
    419. 

  419. <a name="l00396"></a>00396 <span class="comment">    desc.</span>
    420. 

  420. <a name="l00397"></a>00397 <span class="comment">        Main singleton class for Gorilla</span>
    421. 

  421. <a name="l00398"></a>00398 <span class="comment"> */</span>
    422. 

  422. <a name="l00399"></a><a class="code" href="class_gorilla_1_1_silverback.html">00399</a>  <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_silverback.html">Silverback</a> : <span class="keyword">public</span> Ogre::Singleton&lt;Silverback&gt;, <span class="keyword">public</span> Ogre::GeneralAllocatedObject, <span class="keyword">public</span> Ogre::FrameListener
    423. 

  423. <a name="l00400"></a>00400  {
    424. 

  424. <a name="l00401"></a>00401    
    425. 

  425. <a name="l00402"></a>00402   <span class="keyword">public</span>:
    426. 

  426. <a name="l00403"></a>00403    <span class="comment"></span>
    427. 

  427. <a name="l00404"></a>00404 <span class="comment">   /*! constructor. Silverback</span>
    428. 

  428. <a name="l00405"></a>00405 <span class="comment">       desc.</span>
    429. 

  429. <a name="l00406"></a>00406 <span class="comment">           Silverback constructor.</span>
    430. 

  430. <a name="l00407"></a>00407 <span class="comment">   */</span>
    431. 

  431. <a name="l00408"></a>00408    <a class="code" href="class_gorilla_1_1_silverback.html#aed881ea7ac9874db9539922ece58632f">Silverback</a>();
    432. 

  432. <a name="l00409"></a>00409    <span class="comment"></span>
    433. 

  433. <a name="l00410"></a>00410 <span class="comment">   /*! destructor. Silverback</span>
    434. 

  434. <a name="l00411"></a>00411 <span class="comment">       desc.</span>
    435. 

  435. <a name="l00412"></a>00412 <span class="comment">           Silverback destructor.</span>
    436. 

  436. <a name="l00413"></a>00413 <span class="comment">   */</span>
    437. 

  437. <a name="l00414"></a>00414   <a class="code" href="class_gorilla_1_1_silverback.html#ab1596997b9b9c384f52395fb0b3324c6">~Silverback</a>();
    438. 

  438. <a name="l00415"></a>00415    <span class="comment"></span>
    439. 

  439. <a name="l00416"></a>00416 <span class="comment">   /*! function. loadAtlas</span>
    440. 

  440. <a name="l00417"></a>00417 <span class="comment">       desc.</span>
    441. 

  441. <a name="l00418"></a>00418 <span class="comment">           Create a TextureAtlas from a &quot;.gorilla&quot; file. </span>
    442. 

  442. <a name="l00419"></a>00419 <span class="comment">           </span>
    443. 

  443. <a name="l00420"></a>00420 <span class="comment">           Name is the name of the TextureAtlas, as well as the first part of the filename</span>
    444. 

  444. <a name="l00421"></a>00421 <span class="comment">           of the gorilla file; i.e. name.gorilla, the gorilla file can be loaded from a different</span>
    445. 

  445. <a name="l00422"></a>00422 <span class="comment">           resource group if you give that name as the second argument, otherwise it will assume </span>
    446. 

  446. <a name="l00423"></a>00423 <span class="comment">           to be &quot;General&quot;.</span>
    447. 

  447. <a name="l00424"></a>00424 <span class="comment">   */</span>
    448. 

  448. <a name="l00425"></a>00425    <span class="keywordtype">void</span> <a class="code" href="class_gorilla_1_1_silverback.html#a702ca7f5a82ea99e7467bba54e6aa3e7">loadAtlas</a>(<span class="keyword">const</span> Ogre::String&amp; name, <span class="keyword">const</span> Ogre::String&amp; group = Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
    449. 

  449. <a name="l00426"></a>00426    <span class="comment"></span>
    450. 

  450. <a name="l00427"></a>00427 <span class="comment">   /*! function. createScreen</span>
    451. 

  451. <a name="l00428"></a>00428 <span class="comment">       desc.</span>
    452. 

  452. <a name="l00429"></a>00429 <span class="comment">           Create a Screen using a Viewport and a name of a previously loaded TextureAtlas.</span>
    453. 

  453. <a name="l00430"></a>00430 <span class="comment">           Both must exist. The screen will register itself as a RenderQueueListener to the</span>
    454. 

  454. <a name="l00431"></a>00431 <span class="comment">           SceneManager that has the Camera which is tied to the Viewport.</span>
    455. 

  455. <a name="l00432"></a>00432 <span class="comment">       note.</span>
    456. 

  456. <a name="l00433"></a>00433 <span class="comment">           Each screen is considered a new batch. To reduce your batch count in Gorilla, </span>
    457. 

  457. <a name="l00434"></a>00434 <span class="comment">           reduce the number of screens you use.</span>
    458. 

  458. <a name="l00435"></a>00435 <span class="comment">   */</span>
    459. 

  459. <a name="l00436"></a>00436    <a class="code" href="class_gorilla_1_1_screen.html">Screen</a>* <a class="code" href="class_gorilla_1_1_silverback.html#aea736c34b584dce837c55d550c11d030">createScreen</a>(Ogre::Viewport*, <span class="keyword">const</span> Ogre::String&amp; atlas);
    460. 

  460. <a name="l00437"></a>00437    <span class="comment"></span>
    461. 

  461. <a name="l00438"></a>00438 <span class="comment">   /*! function. destroyScreen</span>
    462. 

  462. <a name="l00439"></a>00439 <span class="comment">       desc.</span>
    463. 

  463. <a name="l00440"></a>00440 <span class="comment">           Destroy an existing screen, its layers and the contents of those layers.</span>
    464. 

  464. <a name="l00441"></a>00441 <span class="comment">   */</span>
    465. 

  465. <a name="l00442"></a>00442    <span class="keywordtype">void</span> <a class="code" href="class_gorilla_1_1_silverback.html#a212af4606fd8439b8b32a1af6164fbe8">destroyScreen</a>(<a class="code" href="class_gorilla_1_1_screen.html">Screen</a>*);
    466. 

  466. <a name="l00443"></a>00443    <span class="comment"></span>
    467. 

  467. <a name="l00444"></a>00444 <span class="comment">   /*! function. createScreenRenderable</span>
    468. 

  468. <a name="l00445"></a>00445 <span class="comment">   */</span>
    469. 

  469. <a name="l00446"></a>00446    <a class="code" href="class_gorilla_1_1_screen_renderable.html">ScreenRenderable</a>* <a class="code" href="class_gorilla_1_1_silverback.html#a644be17e6fd266d21edd1ec959c2baa9">createScreenRenderable</a>(<span class="keyword">const</span> Ogre::Vector2&amp; maxSize, <span class="keyword">const</span> Ogre::String&amp; atlas);
    470. 

  470. <a name="l00447"></a>00447    <span class="comment"></span>
    471. 

  471. <a name="l00448"></a>00448 <span class="comment">   /*! function. destroyScreen</span>
    472. 

  472. <a name="l00449"></a>00449 <span class="comment">       desc.</span>
    473. 

  473. <a name="l00450"></a>00450 <span class="comment">           Destroy an existing screen, its layers and the contents of those layers.</span>
    474. 

  474. <a name="l00451"></a>00451 <span class="comment">   */</span>
    475. 

  475. <a name="l00452"></a>00452    <span class="keywordtype">void</span> <a class="code" href="class_gorilla_1_1_silverback.html#a292cdecbfc3ce8cf5d7b35fda45af855">destroyScreenRenderable</a>(<a class="code" href="class_gorilla_1_1_screen_renderable.html">ScreenRenderable</a>*);
    476. 

  476. <a name="l00453"></a>00453    <span class="comment"></span>
    477. 

  477. <a name="l00454"></a>00454 <span class="comment">   /*! function. frameStarted</span>
    478. 

  478. <a name="l00455"></a>00455 <span class="comment">       desc.</span>
    479. 

  479. <a name="l00456"></a>00456 <span class="comment">           Call ScreenRenderable draw</span>
    480. 

  480. <a name="l00457"></a>00457 <span class="comment">   */</span>
    481. 

  481. <a name="l00458"></a>00458    <span class="keywordtype">bool</span> <a class="code" href="class_gorilla_1_1_silverback.html#a953980f1e28a2b9940c7186b51586b2b">frameStarted</a>(<span class="keyword">const</span> Ogre::FrameEvent&amp; evt);
    482. 

  482. <a name="l00459"></a>00459    
    483. 

  483. <a name="l00460"></a>00460   <span class="keyword">protected</span>:
    484. 

  484. <a name="l00461"></a>00461    
    485. 

  485. <a name="l00462"></a>00462    std::map&lt;Ogre::String, TextureAtlas*&gt;  mAtlases;
    486. 

  486. <a name="l00463"></a>00463    std::vector&lt;Screen*&gt;                   mScreens;
    487. 

  487. <a name="l00464"></a>00464    std::vector&lt;ScreenRenderable*&gt;         mScreenRenderables;
    488. 

  488. <a name="l00465"></a>00465    
    489. 

  489. <a name="l00466"></a>00466  };
    490. 

  490. <a name="l00467"></a>00467  <span class="comment"></span>
    491. 

  491. <a name="l00468"></a>00468 <span class="comment"> /*! class. GlyphData</span>
    492. 

  492. <a name="l00469"></a>00469 <span class="comment">     desc.</span>
    493. 

  493. <a name="l00470"></a>00470 <span class="comment">         Collection of glyphs of the same size.</span>
    494. 

  494. <a name="l00471"></a>00471 <span class="comment"> */</span>
    495. 

  495. <a name="l00472"></a><a class="code" href="class_gorilla_1_1_glyph_data.html">00472</a>  <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_glyph_data.html">GlyphData</a> : <span class="keyword">public</span> Ogre::GeneralAllocatedObject
    496. 

  496. <a name="l00473"></a>00473  {
    497. 

  497. <a name="l00474"></a>00474    
    498. 

  498. <a name="l00475"></a>00475   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_texture_atlas.html">TextureAtlas</a>;
    499. 

  499. <a name="l00476"></a>00476    
    500. 

  500. <a name="l00477"></a>00477    <span class="keyword">public</span>:
    501. 

  501. <a name="l00478"></a>00478     
    502. 

  502. <a name="l00479"></a>00479     <a class="code" href="class_gorilla_1_1_glyph_data.html">GlyphData</a>();
    503. 

  503. <a name="l00480"></a>00480     
    504. 

  504. <a name="l00481"></a>00481    ~<a class="code" href="class_gorilla_1_1_glyph_data.html">GlyphData</a>();
    505. 

  505. <a name="l00482"></a>00482     <span class="comment"></span>
    506. 

  506. <a name="l00483"></a>00483 <span class="comment">    /*! function. getGlyph</span>
    507. 

  507. <a name="l00484"></a>00484 <span class="comment">        desc.</span>
    508. 

  508. <a name="l00485"></a>00485 <span class="comment">            Get a glyph (character information) from a specific character.</span>
    509. 

  509. <a name="l00486"></a>00486 <span class="comment">        note.</span>
    510. 

  510. <a name="l00487"></a>00487 <span class="comment">            If the character doesn&#39;t exist then a null pointer is returned.</span>
    511. 

  511. <a name="l00488"></a>00488 <span class="comment">            Do not delete the Glyph pointer.</span>
    512. 

  512. <a name="l00489"></a>00489 <span class="comment">    */</span>
    513. 

  513. <a name="l00490"></a><a class="code" href="class_gorilla_1_1_glyph_data.html#a17fb2c3de5ad1b62e2e3b89b8677cbf9">00490</a>     <span class="keyword">inline</span> <a class="code" href="class_gorilla_1_1_glyph.html">Glyph</a>* <a class="code" href="class_gorilla_1_1_glyph_data.html#a17fb2c3de5ad1b62e2e3b89b8677cbf9">getGlyph</a>(Ogre::uint character)<span class="keyword"> const</span>
    514. 

  514. <a name="l00491"></a>00491 <span class="keyword">    </span>{
    515. 

  515. <a name="l00492"></a>00492      Ogre::uint safe_character = character - mRangeBegin;
    516. 

  516. <a name="l00493"></a>00493      <span class="keywordflow">if</span> (safe_character &gt;= 0 &amp;&amp; safe_character &lt;= mGlyphs.size())
    517. 

  517. <a name="l00494"></a>00494       <span class="keywordflow">return</span> mGlyphs[safe_character];
    518. 

  518. <a name="l00495"></a>00495      <span class="keywordflow">return</span> 0;
    519. 

  519. <a name="l00496"></a>00496     }
    520. 

  520. <a name="l00497"></a>00497     
    521. 

  521. <a name="l00498"></a>00498     std::vector&lt;Glyph*&gt;  mGlyphs;
    522. 

  522. <a name="l00499"></a>00499     Ogre::uint           mRangeBegin, mRangeEnd;
    523. 

  523. <a name="l00500"></a>00500     Ogre::Real           mSpaceLength,
    524. 

  524. <a name="l00501"></a>00501                          mLineHeight,
    525. 

  525. <a name="l00502"></a>00502                          mBaseline,
    526. 

  526. <a name="l00503"></a>00503                          mLetterSpacing,
    527. 

  527. <a name="l00504"></a>00504                          mMonoWidth;
    528. 

  528. <a name="l00505"></a>00505    
    529. 

  529. <a name="l00506"></a>00506  };
    530. 

  530. <a name="l00507"></a>00507  <span class="comment"></span>
    531. 

  531. <a name="l00508"></a>00508 <span class="comment"> /*! class. TextureAtlas</span>
    532. 

  532. <a name="l00509"></a>00509 <span class="comment">     desc.</span>
    533. 

  533. <a name="l00510"></a>00510 <span class="comment">          The TextureAtlas file represents a .gorilla file which contains all the needed information that</span>
    534. 

  534. <a name="l00511"></a>00511 <span class="comment">          describes the portions of a single texture. Such as Glyph and Sprite information, text kerning,</span>
    535. 

  535. <a name="l00512"></a>00512 <span class="comment">          line heights and so on. It isn&#39;t typically used by the end-user.</span>
    536. 

  536. <a name="l00513"></a>00513 <span class="comment"> */</span>
    537. 

  537. <a name="l00514"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html">00514</a>  <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_texture_atlas.html">TextureAtlas</a> : <span class="keyword">public</span> Ogre::GeneralAllocatedObject
    538. 

  538. <a name="l00515"></a>00515  {
    539. 

  539. <a name="l00516"></a>00516    
    540. 

  540. <a name="l00517"></a>00517    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_gorilla_1_1_silverback.html">Silverback</a>;
    541. 

  541. <a name="l00518"></a>00518    
    542. 

  542. <a name="l00519"></a>00519    <span class="keyword">public</span>:
    543. 

  543. <a name="l00520"></a>00520     
    544. 

  544. <a name="l00521"></a>00521     Ogre::MaterialPtr createOrGet2DMasterMaterial();
    545. 

  545. <a name="l00522"></a>00522     
    546. 

  546. <a name="l00523"></a>00523     Ogre::MaterialPtr createOrGet3DMasterMaterial();
    547. 

  547. <a name="l00524"></a>00524     <span class="comment"></span>
    548. 

  548. <a name="l00525"></a>00525 <span class="comment">    /*! function. getTexture</span>
    549. 

  549. <a name="l00526"></a>00526 <span class="comment">        desc.</span>
    550. 

  550. <a name="l00527"></a>00527 <span class="comment">            Get the texture assigned to this TextureAtlas</span>
    551. 

  551. <a name="l00528"></a>00528 <span class="comment">    */</span>
    552. 

  552. <a name="l00529"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html#a7d9490e8e4bbb60c653e1eceb799cf94">00529</a>     <span class="keyword">inline</span> Ogre::TexturePtr <a class="code" href="class_gorilla_1_1_texture_atlas.html#a7d9490e8e4bbb60c653e1eceb799cf94">getTexture</a>()<span class="keyword"> const</span>
    553. 

  553. <a name="l00530"></a>00530 <span class="keyword">    </span>{
    554. 

  554. <a name="l00531"></a>00531      <span class="keywordflow">return</span> mTexture;
    555. 

  555. <a name="l00532"></a>00532     }
    556. 

  556. <a name="l00533"></a>00533     <span class="comment"></span>
    557. 

  557. <a name="l00534"></a>00534 <span class="comment">    /*! function. getMaterial</span>
    558. 

  558. <a name="l00535"></a>00535 <span class="comment">        desc.</span>
    559. 

  559. <a name="l00536"></a>00536 <span class="comment">            Get the material assigned to this TextureAtlas</span>
    560. 

  560. <a name="l00537"></a>00537 <span class="comment">    */</span>
    561. 

  561. <a name="l00538"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html#af67234bb5b5b3a9fec1bf368779c62c6">00538</a>     <span class="keyword">inline</span> Ogre::MaterialPtr <a class="code" href="class_gorilla_1_1_texture_atlas.html#af67234bb5b5b3a9fec1bf368779c62c6">get2DMaterial</a>()<span class="keyword"> const</span>
    562. 

  562. <a name="l00539"></a>00539 <span class="keyword">    </span>{
    563. 

  563. <a name="l00540"></a>00540      <span class="keywordflow">return</span> m2DMaterial;
    564. 

  564. <a name="l00541"></a>00541     }
    565. 

  565. <a name="l00542"></a>00542     <span class="comment"></span>
    566. 

  566. <a name="l00543"></a>00543 <span class="comment">    /*! function. getMaterial</span>
    567. 

  567. <a name="l00544"></a>00544 <span class="comment">        desc.</span>
    568. 

  568. <a name="l00545"></a>00545 <span class="comment">            Get the material assigned to this TextureAtlas</span>
    569. 

  569. <a name="l00546"></a>00546 <span class="comment">    */</span>
    570. 

  570. <a name="l00547"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html#a68428b96bce8bdfff0aaba16f5d9bd95">00547</a>     <span class="keyword">inline</span> Ogre::MaterialPtr <a class="code" href="class_gorilla_1_1_texture_atlas.html#a68428b96bce8bdfff0aaba16f5d9bd95">get3DMaterial</a>()<span class="keyword"> const</span>
    571. 

  571. <a name="l00548"></a>00548 <span class="keyword">    </span>{
    572. 

  572. <a name="l00549"></a>00549      <span class="keywordflow">return</span> m3DMaterial;
    573. 

  573. <a name="l00550"></a>00550     }<span class="comment"></span>
    574. 

  574. <a name="l00551"></a>00551 <span class="comment">    /*! function. getMaterialName</span>
    575. 

  575. <a name="l00552"></a>00552 <span class="comment">        desc.</span>
    576. 

  576. <a name="l00553"></a>00553 <span class="comment">            Get the name of the material assigned to this TextureAtlas</span>
    577. 

  577. <a name="l00554"></a>00554 <span class="comment">    */</span>
    578. 

  578. <a name="l00555"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html#a95f0df6a8938ccd8179c617eea279358">00555</a>     <span class="keyword">inline</span> Ogre::String <a class="code" href="class_gorilla_1_1_texture_atlas.html#a95f0df6a8938ccd8179c617eea279358">get2DMaterialName</a>()<span class="keyword"> const</span>
    579. 

  579. <a name="l00556"></a>00556 <span class="keyword">    </span>{
    580. 

  580. <a name="l00557"></a>00557      <span class="keywordflow">return</span> m2DMaterial-&gt;getName();
    581. 

  581. <a name="l00558"></a>00558     }<span class="comment"></span>
    582. 

  582. <a name="l00559"></a>00559 <span class="comment">    /*! function. getMaterialName</span>
    583. 

  583. <a name="l00560"></a>00560 <span class="comment">        desc.</span>
    584. 

  584. <a name="l00561"></a>00561 <span class="comment">            Get the name of the material assigned to this TextureAtlas</span>
    585. 

  585. <a name="l00562"></a>00562 <span class="comment">    */</span>
    586. 

  586. <a name="l00563"></a><a class="code" href="class_gorilla_1_1_texture_atlas.html#aab96a0207c86a817dca70d84798fd4fc">00563</a>     <span class="keyword">inline</span> Ogre::String <a class="code" href="class_gorilla_1_1_texture_atlas.html#aab96a0207c86a817dca70d84798fd4fc">get3DMaterialName</a>()<span class="keyword"> const</span>
    587. 

  587. <a name="l00564"></a>00564 <span class="keyword">    </span>{
    588. 

  588. <a name="l00565"></a>00565      <span class="keywordflow">return</span> m3DMaterial-&gt;getName();
    589. 

  589. <a name="l00566"></a>00566     }
    590. 

  590. <a name="l00567"></a>00567     
    591. 

  591. <a name="l00568"></a>00568     <span class="keyword">inline</span> <a class="code" href="class_gorilla_1_1_glyph_data.html">GlyphData</a>* getGlyphData(Ogre::uint index)<span class="keyword"> const</span>
    592. 

  592. <a name="l00569"></a>00569 <span class="keyword">    </span>{
    593. 

  593. <a name="l00570"></a>00570      std::map&lt;Ogre::uint, GlyphData*&gt;::const_iterator it = mGlyphData.find(index);
    594. 

  594. <a name="l00571"></a>00571      <span class="keywordflow">if</span> (it == mGlyphData.end())
    595. 

  595. <a name="l00572"></a>00572       <span class="keywordflow">return</span> 0;
    596. 

  596. <a name="l00573"></a>00573      <span class="keywordflow">return</span> (*it).second;
    597. 

  597. <a name="l00574"></a>00574     }
    598. 

  598. <a name="l00575"></a>00575     <span class="comment"></span>
    599. 

  599. <a name="l00576"></a>00576 <span class="comment">    /*! function. getSprite</span>
    600. 

  600. <a name=…
    601.