classgameplay_1_1_theme_1_1_theme_image.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>gameplay: Main Page</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_theme.html">Theme</a> </li>
  81. <li class="navelem"><a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html">ThemeImage</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-methods">Public Member Functions</a> </div>
  88. <div class="headertitle">
  89. <div class="title">gameplay::Theme::ThemeImage Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <!-- doxytag: class="gameplay::Theme::ThemeImage" --><!-- doxytag: inherits="gameplay::Ref" -->
  93. <p><code>#include &lt;Theme.h&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for gameplay::Theme::ThemeImage:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="classgameplay_1_1_theme_1_1_theme_image.png" usemap="#gameplay::Theme::ThemeImage_map" alt=""/>
  99. <map id="gameplay::Theme::ThemeImage_map" name="gameplay::Theme::ThemeImage_map">
  100. <area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,185,24"/>
  101. </map>
  102. </div></div>
  103. <p><a href="classgameplay_1_1_theme_1_1_theme_image-members.html">List of all members.</a></p>
  104. <table class="memberdecls">
  105. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  106. Public Member Functions</h2></td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a3a7726604ed5929240faffcd356d94f5">getId</a> () const </td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgameplay_1_1_theme_1_1_u_vs.html">UVs</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#afa2001c075a276046e51b4ec6cb6c65c">getUVs</a> () const </td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_rectangle.html">Rectangle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a84a085b591699b1f20d4e4ea9d32b401">getRegion</a> () const </td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_vector4.html">Vector4</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a860151bf6ff030b5f9396f5ef589bf2a">getColor</a> () const </td></tr>
  111. </table>
  112. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  113. <div class="textblock"><p>Class representing an image within the theme's texture atlas. An image has a region and a blend color in addition to an ID. UV coordinates are calculated from the region and can be retrieved. </p>
  114. </div><hr/><h2>Member Function Documentation</h2>
  115. <a class="anchor" id="a860151bf6ff030b5f9396f5ef589bf2a"></a><!-- doxytag: member="gameplay::Theme::ThemeImage::getColor" ref="a860151bf6ff030b5f9396f5ef589bf2a" args="() const " -->
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">const <a class="el" href="classgameplay_1_1_vector4.html">Vector4</a>&amp; <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a860151bf6ff030b5f9396f5ef589bf2a">gameplay::Theme::ThemeImage::getColor</a> </td>
  121. <td>(</td>
  122. <td class="paramname"></td><td>)</td>
  123. <td> const</td>
  124. </tr>
  125. </table>
  126. </div>
  127. <div class="memdoc">
  128. <p>Gets the color of the <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html">ThemeImage</a> in a <a class="el" href="classgameplay_1_1_vector4.html">Vector4</a>. </p>
  129. </div>
  130. </div>
  131. <a class="anchor" id="a3a7726604ed5929240faffcd356d94f5"></a><!-- doxytag: member="gameplay::Theme::ThemeImage::getId" ref="a3a7726604ed5929240faffcd356d94f5" args="() const " -->
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">const char* <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a3a7726604ed5929240faffcd356d94f5">gameplay::Theme::ThemeImage::getId</a> </td>
  137. <td>(</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td> const</td>
  140. </tr>
  141. </table>
  142. </div>
  143. <div class="memdoc">
  144. <p>Gets the ID of the <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html">ThemeImage</a>. </p>
  145. </div>
  146. </div>
  147. <a class="anchor" id="a84a085b591699b1f20d4e4ea9d32b401"></a><!-- doxytag: member="gameplay::Theme::ThemeImage::getRegion" ref="a84a085b591699b1f20d4e4ea9d32b401" args="() const " -->
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">const <a class="el" href="classgameplay_1_1_rectangle.html">Rectangle</a>&amp; <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#a84a085b591699b1f20d4e4ea9d32b401">gameplay::Theme::ThemeImage::getRegion</a> </td>
  153. <td>(</td>
  154. <td class="paramname"></td><td>)</td>
  155. <td> const</td>
  156. </tr>
  157. </table>
  158. </div>
  159. <div class="memdoc">
  160. <p>Gets the <a class="el" href="classgameplay_1_1_rectangle.html">Rectangle</a> region of the <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html">ThemeImage</a>. </p>
  161. </div>
  162. </div>
  163. <a class="anchor" id="afa2001c075a276046e51b4ec6cb6c65c"></a><!-- doxytag: member="gameplay::Theme::ThemeImage::getUVs" ref="afa2001c075a276046e51b4ec6cb6c65c" args="() const " -->
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">const <a class="el" href="structgameplay_1_1_theme_1_1_u_vs.html">UVs</a>&amp; <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html#afa2001c075a276046e51b4ec6cb6c65c">gameplay::Theme::ThemeImage::getUVs</a> </td>
  169. <td>(</td>
  170. <td class="paramname"></td><td>)</td>
  171. <td> const</td>
  172. </tr>
  173. </table>
  174. </div>
  175. <div class="memdoc">
  176. <p>Gets the UV coordinates for the <a class="el" href="classgameplay_1_1_theme_1_1_theme_image.html">ThemeImage</a>. </p>
  177. </div>
  178. </div>
  179. </div><!-- contents -->
  180. <!-- window showing the filter options -->
  181. <div id="MSearchSelectWindow"
  182. onmouseover="return searchBox.OnSearchSelectShow()"
  183. onmouseout="return searchBox.OnSearchSelectHide()"
  184. onkeydown="return searchBox.OnSearchSelectKey(event)">
  185. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  186. <!-- iframe showing the search results (closed by default) -->
  187. <div id="MSearchResultsWindow">
  188. <iframe src="javascript:void(0)" frameborder="0"
  189. name="MSearchResults" id="MSearchResults">
  190. </iframe>
  191. </div>
  192. <hr class="footer"/><address class="footer"><small>
  193. Generated on Sat Jan 24 2015 15:29:44 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  194. <img class="footer" src="doxygen.png" alt="doxygen"/>
  195. </a> 1.7.6.1
  196. </small></address>
  197. </body>
  198. </html>