classgameplay_1_1_script_util_1_1_lua_array.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.org/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/blackberry/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://blackberry.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
  28. <td><a href="https://github.com/blackberry/GamePlay"><span class="button">download</span></a></td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. <!-- Generated by Doxygen 1.7.6.1 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <div id="navrow1" class="tabs">
  37. <ul class="tablist">
  38. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  39. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  40. <li>
  41. <div id="MSearchBox" class="MSearchBoxInactive">
  42. <span class="left">
  43. <img id="MSearchSelect" src="search/mag_sel.png"
  44. onmouseover="return searchBox.OnSearchSelectShow()"
  45. onmouseout="return searchBox.OnSearchSelectHide()"
  46. alt=""/>
  47. <input type="text" id="MSearchField" value="Search" accesskey="S"
  48. onfocus="searchBox.OnSearchFieldFocus(true)"
  49. onblur="searchBox.OnSearchFieldFocus(false)"
  50. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  51. </span><span class="right">
  52. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  53. </span>
  54. </div>
  55. </li>
  56. </ul>
  57. </div>
  58. <div id="navrow2" class="tabs2">
  59. <ul class="tablist">
  60. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  61. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  62. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  63. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  64. </ul>
  65. </div>
  66. <!-- window showing the filter options -->
  67. <div id="MSearchSelectWindow"
  68. onmouseover="return searchBox.OnSearchSelectShow()"
  69. onmouseout="return searchBox.OnSearchSelectHide()"
  70. onkeydown="return searchBox.OnSearchSelectKey(event)">
  71. <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>
  72. <!-- iframe showing the search results (closed by default) -->
  73. <div id="MSearchResultsWindow">
  74. <iframe src="javascript:void(0)" frameborder="0"
  75. name="MSearchResults" id="MSearchResults">
  76. </iframe>
  77. </div>
  78. <div id="nav-path" class="navpath">
  79. <ul>
  80. <li class="navelem"><b>gameplay</b> </li>
  81. <li class="navelem"><b>ScriptUtil</b> </li>
  82. <li class="navelem"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </li>
  83. </ul>
  84. </div>
  85. </div>
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#nested-classes">Classes</a> &#124;
  89. <a href="#pub-methods">Public Member Functions</a> </div>
  90. <div class="headertitle">
  91. <div class="title">gameplay::ScriptUtil::LuaArray&lt; T &gt; Class Template Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <!-- doxytag: class="gameplay::ScriptUtil::LuaArray" -->
  95. <p><code>#include &lt;ScriptController.h&gt;</code></p>
  96. <p><a href="classgameplay_1_1_script_util_1_1_lua_array-members.html">List of all members.</a></p>
  97. <table class="memberdecls">
  98. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  99. Classes</h2></td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>Data</b></td></tr>
  101. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#abf308914d5cb39f3def2ca685d97e4e6">LuaArray</a> (T *param)</td></tr>
  104. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#add5c3e1e0c8c11e9459bf4b5851be06b">LuaArray</a> (int count)</td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#ac550e0fee8f2b2f91d8fe6d600981b68">LuaArray</a> (const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt; T &gt; &amp;copy)</td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#a788e406b49156f625ab861e2e7f7a3da">~LuaArray</a> ()</td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt; T &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#ad59b6aa1162977e55b598244e4189f93">operator=</a> (const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt; T &gt; &amp;p)</td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#a716770d010a4f8e87a2bdb7e9b9a18ef">set</a> (unsigned int index, const T *itemPtr)</td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#ab4c35f3f1f8d4631757e2559b57a5cae">operator T *</a> () const </td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#ab303e0664cefd75ebe380a896d1dab1c">operator[]</a> (int index)</td></tr>
  111. </table>
  112. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  113. <div class="textblock"><h3>template&lt;typename T&gt;<br/>
  114. class gameplay::ScriptUtil::LuaArray&lt; T &gt;</h3>
  115. <p>Stores a Lua parameter of an array/pointer type that is passed from Lua to C. Handles automatic cleanup of any temporary memory associated with the array.</p>
  116. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  117. <a class="anchor" id="abf308914d5cb39f3def2ca685d97e4e6"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="abf308914d5cb39f3def2ca685d97e4e6" args="(T *param)" -->
  118. <div class="memitem">
  119. <div class="memproto">
  120. <div class="memtemplate">
  121. template&lt;typename T &gt; </div>
  122. <table class="memname">
  123. <tr>
  124. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
  125. <td>(</td>
  126. <td class="paramtype">T *&#160;</td>
  127. <td class="paramname"><em>param</em></td><td>)</td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <div class="memdoc">
  133. <p>Creates a <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> to store a single pointer value. </p>
  134. </div>
  135. </div>
  136. <a class="anchor" id="add5c3e1e0c8c11e9459bf4b5851be06b"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="add5c3e1e0c8c11e9459bf4b5851be06b" args="(int count)" -->
  137. <div class="memitem">
  138. <div class="memproto">
  139. <div class="memtemplate">
  140. template&lt;typename T &gt; </div>
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
  144. <td>(</td>
  145. <td class="paramtype">int&#160;</td>
  146. <td class="paramname"><em>count</em></td><td>)</td>
  147. <td></td>
  148. </tr>
  149. </table>
  150. </div>
  151. <div class="memdoc">
  152. <p>Allocates a <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> to store an array of values.</p>
  153. <p>Individual items in the array can be set using the set(unsigned int, const T&amp;) method.</p>
  154. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  155. <table class="params">
  156. <tr><td class="paramname">count</td><td>Number of elements to store in the parameter. </td></tr>
  157. </table>
  158. </dd>
  159. </dl>
  160. </div>
  161. </div>
  162. <a class="anchor" id="ac550e0fee8f2b2f91d8fe6d600981b68"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="ac550e0fee8f2b2f91d8fe6d600981b68" args="(const LuaArray&lt; T &gt; &amp;copy)" -->
  163. <div class="memitem">
  164. <div class="memproto">
  165. <div class="memtemplate">
  166. template&lt;typename T &gt; </div>
  167. <table class="memname">
  168. <tr>
  169. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
  170. <td>(</td>
  171. <td class="paramtype">const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt; T &gt; &amp;&#160;</td>
  172. <td class="paramname"><em>copy</em></td><td>)</td>
  173. <td></td>
  174. </tr>
  175. </table>
  176. </div>
  177. <div class="memdoc">
  178. <p>Copy constructor. </p>
  179. </div>
  180. </div>
  181. <a class="anchor" id="a788e406b49156f625ab861e2e7f7a3da"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::~LuaArray" ref="a788e406b49156f625ab861e2e7f7a3da" args="()" -->
  182. <div class="memitem">
  183. <div class="memproto">
  184. <div class="memtemplate">
  185. template&lt;typename T &gt; </div>
  186. <table class="memname">
  187. <tr>
  188. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::~<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
  189. <td>(</td>
  190. <td class="paramname"></td><td>)</td>
  191. <td></td>
  192. </tr>
  193. </table>
  194. </div>
  195. <div class="memdoc">
  196. <p>Destructor. </p>
  197. </div>
  198. </div>
  199. <hr/><h2>Member Function Documentation</h2>
  200. <a class="anchor" id="ab4c35f3f1f8d4631757e2559b57a5cae"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator T *" ref="ab4c35f3f1f8d4631757e2559b57a5cae" args="() const " -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <div class="memtemplate">
  204. template&lt;typename T &gt; </div>
  205. <table class="memname">
  206. <tr>
  207. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::operator T * </td>
  208. <td>(</td>
  209. <td class="paramname"></td><td>)</td>
  210. <td> const</td>
  211. </tr>
  212. </table>
  213. </div>
  214. <div class="memdoc">
  215. <p>Conversion operator from <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> to T*. </p>
  216. </div>
  217. </div>
  218. <a class="anchor" id="ad59b6aa1162977e55b598244e4189f93"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator=" ref="ad59b6aa1162977e55b598244e4189f93" args="(const LuaArray&lt; T &gt; &amp;p)" -->
  219. <div class="memitem">
  220. <div class="memproto">
  221. <div class="memtemplate">
  222. template&lt;typename T &gt; </div>
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt;T&gt;&amp; <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::operator= </td>
  226. <td>(</td>
  227. <td class="paramtype">const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>&lt; T &gt; &amp;&#160;</td>
  228. <td class="paramname"><em>p</em></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </div>
  233. <div class="memdoc">
  234. <p>Assignment operator. </p>
  235. </div>
  236. </div>
  237. <a class="anchor" id="ab303e0664cefd75ebe380a896d1dab1c"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator[]" ref="ab303e0664cefd75ebe380a896d1dab1c" args="(int index)" -->
  238. <div class="memitem">
  239. <div class="memproto">
  240. <div class="memtemplate">
  241. template&lt;typename T &gt; </div>
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">T&amp; <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::operator[] </td>
  245. <td>(</td>
  246. <td class="paramtype">int&#160;</td>
  247. <td class="paramname"><em>index</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div>
  252. <div class="memdoc">
  253. <p>Overloads [] operator to get/set item value at index. </p>
  254. </div>
  255. </div>
  256. <a class="anchor" id="a716770d010a4f8e87a2bdb7e9b9a18ef"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::set" ref="a716770d010a4f8e87a2bdb7e9b9a18ef" args="(unsigned int index, const T *itemPtr)" -->
  257. <div class="memitem">
  258. <div class="memproto">
  259. <div class="memtemplate">
  260. template&lt;typename T &gt; </div>
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">void <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>&lt; T &gt;::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#a716770d010a4f8e87a2bdb7e9b9a18ef">set</a> </td>
  264. <td>(</td>
  265. <td class="paramtype">unsigned int&#160;</td>
  266. <td class="paramname"><em>index</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">const T *&#160;</td>
  272. <td class="paramname"><em>itemPtr</em>&#160;</td>
  273. </tr>
  274. <tr>
  275. <td></td>
  276. <td>)</td>
  277. <td></td><td></td>
  278. </tr>
  279. </table>
  280. </div>
  281. <div class="memdoc">
  282. <p>Copies the value of the object pointed to by itemPtr into the specified index of this <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>'s array. </p>
  283. </div>
  284. </div>
  285. </div><!-- contents -->
  286. <!-- window showing the filter options -->
  287. <div id="MSearchSelectWindow"
  288. onmouseover="return searchBox.OnSearchSelectShow()"
  289. onmouseout="return searchBox.OnSearchSelectHide()"
  290. onkeydown="return searchBox.OnSearchSelectKey(event)">
  291. <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>
  292. <!-- iframe showing the search results (closed by default) -->
  293. <div id="MSearchResultsWindow">
  294. <iframe src="javascript:void(0)" frameborder="0"
  295. name="MSearchResults" id="MSearchResults">
  296. </iframe>
  297. </div>
  298. <hr class="footer"/><address class="footer"><small>
  299. Generated on Wed May 1 2013 12:09:55 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  300. <img class="footer" src="doxygen.png" alt="doxygen"/>
  301. </a> 1.7.6.1
  302. </small></address>
  303. </body>
  304. </html>