struct_world_query_result.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: WorldQueryResult Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-attribs">Public Attributes</a> &#124;
  74. <a href="struct_world_query_result-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">WorldQueryResult Struct Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;WorldQueryResult.h&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:a80840f288df72f3e5a6fa28ba7ede4d7" id="r_a80840f288df72f3e5a6fa28ba7ede4d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#a80840f288df72f3e5a6fa28ba7ede4d7">WorldQueryResult</a> ()</td></tr>
  83. <tr class="separator:a80840f288df72f3e5a6fa28ba7ede4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:acf31f65a542ae5829332b788b87b0ccc" id="r_acf31f65a542ae5829332b788b87b0ccc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#acf31f65a542ae5829332b788b87b0ccc">WorldQueryResult</a> (<a class="el" href="class_scene_object.html">SceneObject</a> *pSceneObject)</td></tr>
  85. <tr class="memdesc:acf31f65a542ae5829332b788b87b0ccc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a non-ray-cast result. <br /></td></tr>
  86. <tr class="separator:acf31f65a542ae5829332b788b87b0ccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ae7f283095ec1cfe237f9448009daf89f" id="r_ae7f283095ec1cfe237f9448009daf89f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#ae7f283095ec1cfe237f9448009daf89f">WorldQueryResult</a> (<a class="el" href="class_scene_object.html">SceneObject</a> *pSceneObject, const b2Vec2 &amp;point, const b2Vec2 &amp;normal, const F32 fraction, const U32 shapeIndex)</td></tr>
  88. <tr class="memdesc:ae7f283095ec1cfe237f9448009daf89f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a ray-cast result. <br />
  89. <br /></td></tr>
  90. <tr class="separator:ae7f283095ec1cfe237f9448009daf89f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  93. Public Attributes</h2></td></tr>
  94. <tr class="memitem:a8ba680723ace7609b171853c3bd14b77" id="r_a8ba680723ace7609b171853c3bd14b77"><td class="memItemLeft" align="right" valign="top">b2Vec2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#a8ba680723ace7609b171853c3bd14b77">mPoint</a></td></tr>
  95. <tr class="separator:a8ba680723ace7609b171853c3bd14b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ac258be57774901182bd16d6f2d6bcab3" id="r_ac258be57774901182bd16d6f2d6bcab3"><td class="memItemLeft" align="right" valign="top">b2Vec2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#ac258be57774901182bd16d6f2d6bcab3">mNormal</a></td></tr>
  97. <tr class="separator:ac258be57774901182bd16d6f2d6bcab3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ad5e06049e0bf8f0234f9995b6a6ab3aa" id="r_ad5e06049e0bf8f0234f9995b6a6ab3aa"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#ad5e06049e0bf8f0234f9995b6a6ab3aa">mFraction</a></td></tr>
  99. <tr class="separator:ad5e06049e0bf8f0234f9995b6a6ab3aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ab0c44b107702da115aaf2f85594a1acc" id="r_ab0c44b107702da115aaf2f85594a1acc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_scene_object.html">SceneObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#ab0c44b107702da115aaf2f85594a1acc">mpSceneObject</a></td></tr>
  101. <tr class="separator:ab0c44b107702da115aaf2f85594a1acc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aaf7d3346a957379161b16ddba49a50dd" id="r_aaf7d3346a957379161b16ddba49a50dd"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_world_query_result.html#aaf7d3346a957379161b16ddba49a50dd">mShapeIndex</a></td></tr>
  103. <tr class="separator:aaf7d3346a957379161b16ddba49a50dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table>
  105. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  106. <div class="textblock"><hr />
  107. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  108. <a id="a80840f288df72f3e5a6fa28ba7ede4d7" name="a80840f288df72f3e5a6fa28ba7ede4d7"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a80840f288df72f3e5a6fa28ba7ede4d7">&#9670;&#160;</a></span>WorldQueryResult() <span class="overload">[1/3]</span></h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname"><a class="el" href="struct_world_query_result.html">WorldQueryResult</a> </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. </div>
  130. </div>
  131. <a id="acf31f65a542ae5829332b788b87b0ccc" name="acf31f65a542ae5829332b788b87b0ccc"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#acf31f65a542ae5829332b788b87b0ccc">&#9670;&#160;</a></span>WorldQueryResult() <span class="overload">[2/3]</span></h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="mlabels">
  136. <tr>
  137. <td class="mlabels-left">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname"><a class="el" href="struct_world_query_result.html">WorldQueryResult</a> </td>
  141. <td>(</td>
  142. <td class="paramtype"><a class="el" href="class_scene_object.html">SceneObject</a> *&#160;</td>
  143. <td class="paramname"><em>pSceneObject</em></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Initialize a non-ray-cast result. </p>
  154. </div>
  155. </div>
  156. <a id="ae7f283095ec1cfe237f9448009daf89f" name="ae7f283095ec1cfe237f9448009daf89f"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#ae7f283095ec1cfe237f9448009daf89f">&#9670;&#160;</a></span>WorldQueryResult() <span class="overload">[3/3]</span></h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname"><a class="el" href="struct_world_query_result.html">WorldQueryResult</a> </td>
  166. <td>(</td>
  167. <td class="paramtype"><a class="el" href="class_scene_object.html">SceneObject</a> *&#160;</td>
  168. <td class="paramname"><em>pSceneObject</em>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype">const b2Vec2 &amp;&#160;</td>
  174. <td class="paramname"><em>point</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">const b2Vec2 &amp;&#160;</td>
  180. <td class="paramname"><em>normal</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">const F32&#160;</td>
  186. <td class="paramname"><em>fraction</em>, </td>
  187. </tr>
  188. <tr>
  189. <td class="paramkey"></td>
  190. <td></td>
  191. <td class="paramtype">const U32&#160;</td>
  192. <td class="paramname"><em>shapeIndex</em>&#160;</td>
  193. </tr>
  194. <tr>
  195. <td></td>
  196. <td>)</td>
  197. <td></td><td></td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Initialize a ray-cast result. <br />
  207. </p>
  208. </div>
  209. </div>
  210. <h2 class="groupheader">Member Data Documentation</h2>
  211. <a id="ad5e06049e0bf8f0234f9995b6a6ab3aa" name="ad5e06049e0bf8f0234f9995b6a6ab3aa"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#ad5e06049e0bf8f0234f9995b6a6ab3aa">&#9670;&#160;</a></span>mFraction</h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">F32 mFraction</td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <a id="ac258be57774901182bd16d6f2d6bcab3" name="ac258be57774901182bd16d6f2d6bcab3"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#ac258be57774901182bd16d6f2d6bcab3">&#9670;&#160;</a></span>mNormal</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">b2Vec2 mNormal</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. </div>
  234. </div>
  235. <a id="a8ba680723ace7609b171853c3bd14b77" name="a8ba680723ace7609b171853c3bd14b77"></a>
  236. <h2 class="memtitle"><span class="permalink"><a href="#a8ba680723ace7609b171853c3bd14b77">&#9670;&#160;</a></span>mPoint</h2>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">b2Vec2 mPoint</td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. </div>
  246. </div>
  247. <a id="ab0c44b107702da115aaf2f85594a1acc" name="ab0c44b107702da115aaf2f85594a1acc"></a>
  248. <h2 class="memtitle"><span class="permalink"><a href="#ab0c44b107702da115aaf2f85594a1acc">&#9670;&#160;</a></span>mpSceneObject</h2>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname"><a class="el" href="class_scene_object.html">SceneObject</a>* mpSceneObject</td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. </div>
  258. </div>
  259. <a id="aaf7d3346a957379161b16ddba49a50dd" name="aaf7d3346a957379161b16ddba49a50dd"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#aaf7d3346a957379161b16ddba49a50dd">&#9670;&#160;</a></span>mShapeIndex</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">U32 mShapeIndex</td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. </div>
  270. </div>
  271. <hr/>The documentation for this struct was generated from the following file:<ul>
  272. <li>2d/scene/<b>WorldQueryResult.h</b></li>
  273. </ul>
  274. </div><!-- contents -->
  275. <!-- start footer part -->
  276. <hr class="footer"/><address class="footer"><small>
  277. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  278. </small></address>
  279. </body>
  280. </html>