structgameplay_1_1_physics_collision_shape_1_1_definition.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  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_physics_collision_shape.html">PhysicsCollisionShape</a> </li>
  81. <li class="navelem"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#nested-classes">Classes</a> &#124;
  88. <a href="#pub-methods">Public Member Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">gameplay::PhysicsCollisionShape::Definition Struct Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <!-- doxytag: class="gameplay::PhysicsCollisionShape::Definition" -->
  94. <p><code>#include &lt;PhysicsCollisionShape.h&gt;</code></p>
  95. <p><a href="structgameplay_1_1_physics_collision_shape_1_1_definition-members.html">List of all members.</a></p>
  96. <table class="memberdecls">
  97. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  98. Classes</h2></td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>BoxData</b></td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>CapsuleData</b></td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>SphereData</b></td></tr>
  102. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  103. Public Member Functions</h2></td></tr>
  104. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#ae12ee1ba52f17494cba4620d5536cd19">Definition</a> ()</td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#a6f3dc5a8516c4a452617cfaaed11f1a4">Definition</a> (const <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> &amp;definition)</td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#a2d523ec8eca9a0f90f3269fcca32dda7">operator=</a> (const <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> &amp;definition)</td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#ad4612eb0501c21d31842971bf64f5a8e">~Definition</a> ()</td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#aac648650ce0aeb269486466ed9ec2df2">isEmpty</a> () const </td></tr>
  109. </table>
  110. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  111. <div class="textblock"><p>Structure representing the definition of a collision shape, which is used during collision shape construction time.</p>
  112. <p>Use the static methods on the <a class="el" href="classgameplay_1_1_physics_collision_shape.html">PhysicsCollisionShape</a> class to return </p>
  113. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  114. <a class="anchor" id="ae12ee1ba52f17494cba4620d5536cd19"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::Definition" ref="ae12ee1ba52f17494cba4620d5536cd19" args="()" -->
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#ae12ee1ba52f17494cba4620d5536cd19">gameplay::PhysicsCollisionShape::Definition::Definition</a> </td>
  120. <td>(</td>
  121. <td class="paramname"></td><td>)</td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </div>
  126. <div class="memdoc">
  127. <p>Constructor. </p>
  128. </div>
  129. </div>
  130. <a class="anchor" id="a6f3dc5a8516c4a452617cfaaed11f1a4"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::Definition" ref="a6f3dc5a8516c4a452617cfaaed11f1a4" args="(const Definition &amp;definition)" -->
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#ae12ee1ba52f17494cba4620d5536cd19">gameplay::PhysicsCollisionShape::Definition::Definition</a> </td>
  136. <td>(</td>
  137. <td class="paramtype">const <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> &amp;&#160;</td>
  138. <td class="paramname"><em>definition</em></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </div>
  143. <div class="memdoc">
  144. <p>Constructs a new <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> that is a copy of the specified <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a>.</p>
  145. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  146. <table class="params">
  147. <tr><td class="paramname">definition</td><td>The <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> to copy. </td></tr>
  148. </table>
  149. </dd>
  150. </dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ad4612eb0501c21d31842971bf64f5a8e"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::~Definition" ref="ad4612eb0501c21d31842971bf64f5a8e" args="()" -->
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#ad4612eb0501c21d31842971bf64f5a8e">gameplay::PhysicsCollisionShape::Definition::~Definition</a> </td>
  159. <td>(</td>
  160. <td class="paramname"></td><td>)</td>
  161. <td></td>
  162. </tr>
  163. </table>
  164. </div>
  165. <div class="memdoc">
  166. <p>Destructor. </p>
  167. </div>
  168. </div>
  169. <hr/><h2>Member Function Documentation</h2>
  170. <a class="anchor" id="aac648650ce0aeb269486466ed9ec2df2"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::isEmpty" ref="aac648650ce0aeb269486466ed9ec2df2" args="() const " -->
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">bool <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#aac648650ce0aeb269486466ed9ec2df2">gameplay::PhysicsCollisionShape::Definition::isEmpty</a> </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td> const</td>
  179. </tr>
  180. </table>
  181. </div>
  182. <div class="memdoc">
  183. <p>Determines if this is an empty/undefined collision shape definition. </p>
  184. </div>
  185. </div>
  186. <a class="anchor" id="a2d523ec8eca9a0f90f3269fcca32dda7"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::operator=" ref="a2d523ec8eca9a0f90f3269fcca32dda7" args="(const Definition &amp;definition)" -->
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname"><a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a>&amp; gameplay::PhysicsCollisionShape::Definition::operator= </td>
  192. <td>(</td>
  193. <td class="paramtype">const <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> &amp;&#160;</td>
  194. <td class="paramname"><em>definition</em></td><td>)</td>
  195. <td></td>
  196. </tr>
  197. </table>
  198. </div>
  199. <div class="memdoc">
  200. <p>Assigns the specified <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> as the <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a>.</p>
  201. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  202. <table class="params">
  203. <tr><td class="paramname">definition</td><td>The <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a> to assign to the <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html">Definition</a>. </td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. </div>
  208. </div>
  209. <hr/><h2>Member Data Documentation</h2>
  210. <a class="anchor" id="a18f693b8ef012048f04a0f29c9aaec6a"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::box" ref="a18f693b8ef012048f04a0f29c9aaec6a" args="" -->
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">BoxData <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#a18f693b8ef012048f04a0f29c9aaec6a">gameplay::PhysicsCollisionShape::Definition::box</a></td>
  216. </tr>
  217. </table>
  218. </div>
  219. <div class="memdoc">
  220. </div>
  221. </div>
  222. <a class="anchor" id="a19ad0df9bb6db97a0fb7bfe4dd0c4a73"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::capsule" ref="a19ad0df9bb6db97a0fb7bfe4dd0c4a73" args="" -->
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">CapsuleData <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#a19ad0df9bb6db97a0fb7bfe4dd0c4a73">gameplay::PhysicsCollisionShape::Definition::capsule</a></td>
  228. </tr>
  229. </table>
  230. </div>
  231. <div class="memdoc">
  232. </div>
  233. </div>
  234. <a class="anchor" id="a523256b14201ff4a1b9283f0277124d5"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::heightfield" ref="a523256b14201ff4a1b9283f0277124d5" args="" -->
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname"><a class="el" href="classgameplay_1_1_height_field.html">HeightField</a>* <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#a523256b14201ff4a1b9283f0277124d5">gameplay::PhysicsCollisionShape::Definition::heightfield</a></td>
  240. </tr>
  241. </table>
  242. </div>
  243. <div class="memdoc">
  244. </div>
  245. </div>
  246. <a class="anchor" id="acfdcd80e175ab4af691fbdbf72e2ecd3"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::mesh" ref="acfdcd80e175ab4af691fbdbf72e2ecd3" args="" -->
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname"><a class="el" href="classgameplay_1_1_mesh.html">Mesh</a>* <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#acfdcd80e175ab4af691fbdbf72e2ecd3">gameplay::PhysicsCollisionShape::Definition::mesh</a></td>
  252. </tr>
  253. </table>
  254. </div>
  255. <div class="memdoc">
  256. </div>
  257. </div>
  258. <a class="anchor" id="afefdc941f14078d3a98d7d55c21cd969"></a><!-- doxytag: member="gameplay::PhysicsCollisionShape::Definition::sphere" ref="afefdc941f14078d3a98d7d55c21cd969" args="" -->
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">SphereData <a class="el" href="structgameplay_1_1_physics_collision_shape_1_1_definition.html#afefdc941f14078d3a98d7d55c21cd969">gameplay::PhysicsCollisionShape::Definition::sphere</a></td>
  264. </tr>
  265. </table>
  266. </div>
  267. <div class="memdoc">
  268. </div>
  269. </div>
  270. </div><!-- contents -->
  271. <!-- window showing the filter options -->
  272. <div id="MSearchSelectWindow"
  273. onmouseover="return searchBox.OnSearchSelectShow()"
  274. onmouseout="return searchBox.OnSearchSelectHide()"
  275. onkeydown="return searchBox.OnSearchSelectKey(event)">
  276. <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>
  277. <!-- iframe showing the search results (closed by default) -->
  278. <div id="MSearchResultsWindow">
  279. <iframe src="javascript:void(0)" frameborder="0"
  280. name="MSearchResults" id="MSearchResults">
  281. </iframe>
  282. </div>
  283. <hr class="footer"/><address class="footer"><small>
  284. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  285. <img class="footer" src="doxygen.png" alt="doxygen"/>
  286. </a> 1.7.6.1
  287. </small></address>
  288. </body>
  289. </html>