classgameplay_1_1_mesh_part.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  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>MeshPart Class Reference</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_mesh_part.html">MeshPart</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-methods">Public Member Functions</a> </div>
  87. <div class="headertitle">
  88. <div class="title">gameplay::MeshPart Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <!-- doxytag: class="gameplay::MeshPart" -->
  92. <p><code>#include &lt;MeshPart.h&gt;</code></p>
  93. <p><a href="classgameplay_1_1_mesh_part-members.html">List of all members.</a></p>
  94. <table class="memberdecls">
  95. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  96. Public Member Functions</h2></td></tr>
  97. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a40309a2f79f201b2d1ee92460817472e">~MeshPart</a> ()</td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#ae6319ff98748c3fcb41b9c57a219c1c8">getMeshIndex</a> () const </td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_mesh.html#acd5596a388ab216531d2b77aee0417c4">Mesh::PrimitiveType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#ad017fcb24b5a672c21a37a980c7688ad">getPrimitiveType</a> () const </td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a6510763a55c4c3127a614c411ff9a17c">getIndexCount</a> () const </td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_mesh.html#a865d9e14d59471e8773694faa8656db1">Mesh::IndexFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a3cfc279a6abb74c325a55d73df1b636e">getIndexFormat</a> () const </td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top">IndexBufferHandle&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a45da2fae501c00b46f252adb9a3e302d">getIndexBuffer</a> () const </td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a82060080735b7b513f0f731defebfdff">isDynamic</a> () const </td></tr>
  104. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_mesh_part.html#a27d4c999f011342e16a3e234a3f5deb1">setIndexData</a> (const void *indexData, unsigned int indexStart, unsigned int indexCount)</td></tr>
  105. </table>
  106. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  107. <div class="textblock"><p>Defines a part of a mesh describing the way the mesh's vertices are connected together. </p>
  108. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  109. <a class="anchor" id="a40309a2f79f201b2d1ee92460817472e"></a><!-- doxytag: member="gameplay::MeshPart::~MeshPart" ref="a40309a2f79f201b2d1ee92460817472e" args="()" -->
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname"><a class="el" href="classgameplay_1_1_mesh_part.html#a40309a2f79f201b2d1ee92460817472e">gameplay::MeshPart::~MeshPart</a> </td>
  115. <td>(</td>
  116. <td class="paramname"></td><td>)</td>
  117. <td></td>
  118. </tr>
  119. </table>
  120. </div>
  121. <div class="memdoc">
  122. <p>Destructor. </p>
  123. </div>
  124. </div>
  125. <hr/><h2>Member Function Documentation</h2>
  126. <a class="anchor" id="a45da2fae501c00b46f252adb9a3e302d"></a><!-- doxytag: member="gameplay::MeshPart::getIndexBuffer" ref="a45da2fae501c00b46f252adb9a3e302d" args="() const " -->
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">IndexBufferHandle <a class="el" href="classgameplay_1_1_mesh_part.html#a45da2fae501c00b46f252adb9a3e302d">gameplay::MeshPart::getIndexBuffer</a> </td>
  132. <td>(</td>
  133. <td class="paramname"></td><td>)</td>
  134. <td> const</td>
  135. </tr>
  136. </table>
  137. </div>
  138. <div class="memdoc">
  139. <p>Returns a handle to the index buffer for the mesh part.</p>
  140. <dl class="return"><dt><b>Returns:</b></dt><dd>The index buffer object handle. </dd></dl>
  141. </div>
  142. </div>
  143. <a class="anchor" id="a6510763a55c4c3127a614c411ff9a17c"></a><!-- doxytag: member="gameplay::MeshPart::getIndexCount" ref="a6510763a55c4c3127a614c411ff9a17c" args="() const " -->
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_mesh_part.html#a6510763a55c4c3127a614c411ff9a17c">gameplay::MeshPart::getIndexCount</a> </td>
  149. <td>(</td>
  150. <td class="paramname"></td><td>)</td>
  151. <td> const</td>
  152. </tr>
  153. </table>
  154. </div>
  155. <div class="memdoc">
  156. <p>Gets the number of indices in the part.</p>
  157. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of indices in the part. </dd></dl>
  158. </div>
  159. </div>
  160. <a class="anchor" id="a3cfc279a6abb74c325a55d73df1b636e"></a><!-- doxytag: member="gameplay::MeshPart::getIndexFormat" ref="a3cfc279a6abb74c325a55d73df1b636e" args="() const " -->
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname"><a class="el" href="classgameplay_1_1_mesh.html#a865d9e14d59471e8773694faa8656db1">Mesh::IndexFormat</a> <a class="el" href="classgameplay_1_1_mesh_part.html#a3cfc279a6abb74c325a55d73df1b636e">gameplay::MeshPart::getIndexFormat</a> </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td> const</td>
  169. </tr>
  170. </table>
  171. </div>
  172. <div class="memdoc">
  173. <p>Returns the format of the part indices.</p>
  174. <dl class="return"><dt><b>Returns:</b></dt><dd>The part index format. </dd></dl>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ae6319ff98748c3fcb41b9c57a219c1c8"></a><!-- doxytag: member="gameplay::MeshPart::getMeshIndex" ref="ae6319ff98748c3fcb41b9c57a219c1c8" args="() const " -->
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_mesh_part.html#ae6319ff98748c3fcb41b9c57a219c1c8">gameplay::MeshPart::getMeshIndex</a> </td>
  183. <td>(</td>
  184. <td class="paramname"></td><td>)</td>
  185. <td> const</td>
  186. </tr>
  187. </table>
  188. </div>
  189. <div class="memdoc">
  190. <p>Gets the part index in mesh.</p>
  191. <dl class="return"><dt><b>Returns:</b></dt><dd>The part offset index. </dd></dl>
  192. </div>
  193. </div>
  194. <a class="anchor" id="ad017fcb24b5a672c21a37a980c7688ad"></a><!-- doxytag: member="gameplay::MeshPart::getPrimitiveType" ref="ad017fcb24b5a672c21a37a980c7688ad" args="() const " -->
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname"><a class="el" href="classgameplay_1_1_mesh.html#acd5596a388ab216531d2b77aee0417c4">Mesh::PrimitiveType</a> <a class="el" href="classgameplay_1_1_mesh_part.html#ad017fcb24b5a672c21a37a980c7688ad">gameplay::MeshPart::getPrimitiveType</a> </td>
  200. <td>(</td>
  201. <td class="paramname"></td><td>)</td>
  202. <td> const</td>
  203. </tr>
  204. </table>
  205. </div>
  206. <div class="memdoc">
  207. <p>Gets the type of primitive to define how the indices are connected.</p>
  208. <dl class="return"><dt><b>Returns:</b></dt><dd>The type of primitive. </dd></dl>
  209. </div>
  210. </div>
  211. <a class="anchor" id="a82060080735b7b513f0f731defebfdff"></a><!-- doxytag: member="gameplay::MeshPart::isDynamic" ref="a82060080735b7b513f0f731defebfdff" args="() const " -->
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">bool <a class="el" href="classgameplay_1_1_mesh_part.html#a82060080735b7b513f0f731defebfdff">gameplay::MeshPart::isDynamic</a> </td>
  217. <td>(</td>
  218. <td class="paramname"></td><td>)</td>
  219. <td> const</td>
  220. </tr>
  221. </table>
  222. </div>
  223. <div class="memdoc">
  224. <p>Determines if the indices are dynamic.</p>
  225. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the part is dynamic; false otherwise. </dd></dl>
  226. </div>
  227. </div>
  228. <a class="anchor" id="a27d4c999f011342e16a3e234a3f5deb1"></a><!-- doxytag: member="gameplay::MeshPart::setIndexData" ref="a27d4c999f011342e16a3e234a3f5deb1" args="(const void *indexData, unsigned int indexStart, unsigned int indexCount)" -->
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void <a class="el" href="classgameplay_1_1_mesh_part.html#a27d4c999f011342e16a3e234a3f5deb1">gameplay::MeshPart::setIndexData</a> </td>
  234. <td>(</td>
  235. <td class="paramtype">const void *&#160;</td>
  236. <td class="paramname"><em>indexData</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">unsigned int&#160;</td>
  242. <td class="paramname"><em>indexStart</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype">unsigned int&#160;</td>
  248. <td class="paramname"><em>indexCount</em>&#160;</td>
  249. </tr>
  250. <tr>
  251. <td></td>
  252. <td>)</td>
  253. <td></td><td></td>
  254. </tr>
  255. </table>
  256. </div>
  257. <div class="memdoc">
  258. <p>Sets the specified index data into the mapped index buffer.</p>
  259. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  260. <table class="params">
  261. <tr><td class="paramname">indexData</td><td>The index data to be set. </td></tr>
  262. <tr><td class="paramname">indexStart</td><td>The index to start from. </td></tr>
  263. <tr><td class="paramname">indexCount</td><td>The number of indices to be set. </td></tr>
  264. </table>
  265. </dd>
  266. </dl>
  267. </div>
  268. </div>
  269. </div><!-- contents -->
  270. <!-- window showing the filter options -->
  271. <div id="MSearchSelectWindow"
  272. onmouseover="return searchBox.OnSearchSelectShow()"
  273. onmouseout="return searchBox.OnSearchSelectHide()"
  274. onkeydown="return searchBox.OnSearchSelectKey(event)">
  275. <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>
  276. <!-- iframe showing the search results (closed by default) -->
  277. <div id="MSearchResultsWindow">
  278. <iframe src="javascript:void(0)" frameborder="0"
  279. name="MSearchResults" id="MSearchResults">
  280. </iframe>
  281. </div>
  282. <hr class="footer"/><address class="footer"><small>
  283. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  284. <img class="footer" src="doxygen.png" alt="doxygen"/>
  285. </a> 1.7.6.1
  286. </small></address>
  287. </body>
  288. </html>