| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <title>gameplay: Main Page</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="custom.css" rel="stylesheet" type="text/css" />
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { searchBox.OnSelectItem(0); });
- </script>
- </head>
- <body>
- <div id="top"><!-- do not remove this div! -->
- <table class="header" border="0">
- <tbody>
- <tr>
- <td id="logo"><a href="http://gameplay3d.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
- <td width="100%"/>
- <td><a href="http://gameplay3d.org/"><span class="button">overview</span></a></td><td width="12px"/>
- <td><a href="https://github.com/blackberry/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
- <td><a href="http://blackberry.github.com/GamePlay/api/index.html"><span class="button">api reference</span></a></td><td width="12px"/>
- <td><a href="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
- <td><a href="https://github.com/blackberry/GamePlay"><span class="button">download</span></a></td>
- </tr>
- </tbody>
- </table>
- <!-- Generated by Doxygen 1.7.6.1 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><b>gameplay</b> </li>
- <li class="navelem"><b>ScriptUtil</b> </li>
- <li class="navelem"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </li>
- </ul>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">gameplay::ScriptUtil::LuaArray< T > Class Template Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <!-- doxytag: class="gameplay::ScriptUtil::LuaArray" -->
- <p><code>#include <ScriptController.h></code></p>
- <p><a href="classgameplay_1_1_script_util_1_1_lua_array-members.html">List of all members.</a></p>
- <table class="memberdecls">
- <tr><td colspan="2"><h2><a name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>Data</b></td></tr>
- <tr><td colspan="2"><h2><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </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>
- <tr><td class="memItemLeft" align="right" valign="top"> </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>
- <tr><td class="memItemLeft" align="right" valign="top"> </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>< T > &copy)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </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>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>< T > & </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>< T > &p)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">void </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>
- <tr><td class="memItemLeft" align="right" valign="top"> </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>
- <tr><td class="memItemLeft" align="right" valign="top">T & </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>
- </table>
- <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
- <div class="textblock"><h3>template<typename T><br/>
- class gameplay::ScriptUtil::LuaArray< T ></h3>
- <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>
- </div><hr/><h2>Constructor & Destructor Documentation</h2>
- <a class="anchor" id="abf308914d5cb39f3def2ca685d97e4e6"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="abf308914d5cb39f3def2ca685d97e4e6" args="(T *param)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
- <td>(</td>
- <td class="paramtype">T * </td>
- <td class="paramname"><em>param</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="add5c3e1e0c8c11e9459bf4b5851be06b"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="add5c3e1e0c8c11e9459bf4b5851be06b" args="(int count)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>count</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <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>
- <p>Individual items in the array can be set using the set(unsigned int, const T&) method.</p>
- <dl class="params"><dt><b>Parameters:</b></dt><dd>
- <table class="params">
- <tr><td class="paramname">count</td><td>Number of elements to store in the parameter. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ac550e0fee8f2b2f91d8fe6d600981b68"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::LuaArray" ref="ac550e0fee8f2b2f91d8fe6d600981b68" args="(const LuaArray< T > &copy)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>< T > & </td>
- <td class="paramname"><em>copy</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Copy constructor. </p>
- </div>
- </div>
- <a class="anchor" id="a788e406b49156f625ab861e2e7f7a3da"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::~LuaArray" ref="a788e406b49156f625ab861e2e7f7a3da" args="()" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::~<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Destructor. </p>
- </div>
- </div>
- <hr/><h2>Member Function Documentation</h2>
- <a class="anchor" id="ab4c35f3f1f8d4631757e2559b57a5cae"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator T *" ref="ab4c35f3f1f8d4631757e2559b57a5cae" args="() const " -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::operator T * </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Conversion operator from <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a> to T*. </p>
- </div>
- </div>
- <a class="anchor" id="ad59b6aa1162977e55b598244e4189f93"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator=" ref="ad59b6aa1162977e55b598244e4189f93" args="(const LuaArray< T > &p)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a><T>& <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::operator= </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">LuaArray</a>< T > & </td>
- <td class="paramname"><em>p</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Assignment operator. </p>
- </div>
- </div>
- <a class="anchor" id="ab303e0664cefd75ebe380a896d1dab1c"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::operator[]" ref="ab303e0664cefd75ebe380a896d1dab1c" args="(int index)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname">T& <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::operator[] </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Overloads [] operator to get/set item value at index. </p>
- </div>
- </div>
- <a class="anchor" id="a716770d010a4f8e87a2bdb7e9b9a18ef"></a><!-- doxytag: member="gameplay::ScriptUtil::LuaArray::set" ref="a716770d010a4f8e87a2bdb7e9b9a18ef" args="(unsigned int index, const T *itemPtr)" -->
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html">gameplay::ScriptUtil::LuaArray</a>< T >::<a class="el" href="classgameplay_1_1_script_util_1_1_lua_array.html#a716770d010a4f8e87a2bdb7e9b9a18ef">set</a> </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const T * </td>
- <td class="paramname"><em>itemPtr</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <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>
- </div>
- </div>
- </div><!-- contents -->
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed May 1 2013 12:09:55 for gameplay by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.7.6.1
- </small></address>
- </body>
- </html>
|