| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: SimObjectPtr< T > Class Template Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_sim_object_ptr-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">SimObjectPtr< T > Class Template Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <simObjectPtr.h></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a8f954f9d7067b980db407ea2b1808d55" id="r_a8f954f9d7067b980db407ea2b1808d55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a8f954f9d7067b980db407ea2b1808d55">SimObjectPtr</a> ()</td></tr>
- <tr class="separator:a8f954f9d7067b980db407ea2b1808d55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2b5aedf23c1afabdd2728b9d6613416" id="r_af2b5aedf23c1afabdd2728b9d6613416"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#af2b5aedf23c1afabdd2728b9d6613416">SimObjectPtr</a> (T *ptr)</td></tr>
- <tr class="separator:af2b5aedf23c1afabdd2728b9d6613416"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31c0eda5d99f4c0e482634ee72c54075" id="r_a31c0eda5d99f4c0e482634ee72c54075"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a31c0eda5d99f4c0e482634ee72c54075">SimObjectPtr</a> (const <a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > &rhs)</td></tr>
- <tr class="separator:a31c0eda5d99f4c0e482634ee72c54075"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acb623cd8c744e790bfe858c133ee179d" id="r_acb623cd8c744e790bfe858c133ee179d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#acb623cd8c744e790bfe858c133ee179d">operator=</a> (const <a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > &rhs)</td></tr>
- <tr class="separator:acb623cd8c744e790bfe858c133ee179d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9344968a2fec9611eb5a5d55a0052398" id="r_a9344968a2fec9611eb5a5d55a0052398"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a9344968a2fec9611eb5a5d55a0052398">~SimObjectPtr</a> ()</td></tr>
- <tr class="separator:a9344968a2fec9611eb5a5d55a0052398"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad30b11b87166dea7df7e5b870af9e4f9" id="r_ad30b11b87166dea7df7e5b870af9e4f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#ad30b11b87166dea7df7e5b870af9e4f9">operator=</a> (T *ptr)</td></tr>
- <tr class="separator:ad30b11b87166dea7df7e5b870af9e4f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abada6dfb33f4cbafe1e443a5cf8dc8d0" id="r_abada6dfb33f4cbafe1e443a5cf8dc8d0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#abada6dfb33f4cbafe1e443a5cf8dc8d0">isNull</a> () const</td></tr>
- <tr class="separator:abada6dfb33f4cbafe1e443a5cf8dc8d0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afecd672b9856ca49258c2e0014502e63" id="r_afecd672b9856ca49258c2e0014502e63"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#afecd672b9856ca49258c2e0014502e63">notNull</a> () const</td></tr>
- <tr class="separator:afecd672b9856ca49258c2e0014502e63"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a84e9959608997de8fe4355def47ff45a" id="r_a84e9959608997de8fe4355def47ff45a"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a84e9959608997de8fe4355def47ff45a">operator-></a> () const</td></tr>
- <tr class="separator:a84e9959608997de8fe4355def47ff45a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09eda862da843825d1849dd63af36a2a" id="r_a09eda862da843825d1849dd63af36a2a"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a09eda862da843825d1849dd63af36a2a">operator*</a> () const</td></tr>
- <tr class="separator:a09eda862da843825d1849dd63af36a2a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3efedfc79726ae494572af41183b3803" id="r_a3efedfc79726ae494572af41183b3803"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_ptr.html#a3efedfc79726ae494572af41183b3803">operator T*</a> () const</td></tr>
- <tr class="separator:a3efedfc79726ae494572af41183b3803"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><div class="compoundTemplParams">template<class T><br />
- class SimObjectPtr< T ></div><p>Smart <a class="el" href="class_sim_object.html">SimObject</a> pointer.</p>
- <p>This class keeps track of the book-keeping necessary to keep a registered reference to a <a class="el" href="class_sim_object.html">SimObject</a> or subclass thereof.</p>
- <p>Normally, if you want the <a class="el" href="class_sim_object.html">SimObject</a> to be aware that you have a reference to it, you must call <a class="el" href="class_sim_object.html#a5de000764497f99eac15f2fe1ff8d709">SimObject::registerReference()</a> when you create the reference, and <a class="el" href="class_sim_object.html#a9ab2d546d0ed6b4abc8dcf9e373d8bcb">SimObject::unregisterReference()</a> when you're done. If you change the reference, you must also register/unregister it. This is a big headache, so this class exists to automatically keep track of things for you.</p>
- <div class="fragment"><div class="line"><span class="comment">// Assign an object to the</span></div>
- <div class="line"><a class="code hl_class" href="class_sim_object_ptr.html">SimObjectPtr<GameBase></a> mOrbitObject = <a class="code hl_function" href="namespace_sim.html#a3e94a217b10a43c58030035d7efa5ea4">Sim::findObject</a>(<span class="stringliteral">"anObject"</span>);</div>
- <div class="line"> </div>
- <div class="line"><span class="comment">// Use it as a GameBase*.</span></div>
- <div class="line">mOrbitObject->getWorldBox().getCenter(&mPosition);</div>
- <div class="line"> </div>
- <div class="line"><span class="comment">// And reassign it - it will automatically update the references.</span></div>
- <div class="line">mOrbitObject = <a class="code hl_function" href="namespace_sim.html#a3e94a217b10a43c58030035d7efa5ea4">Sim::findObject</a>(<span class="stringliteral">"anotherObject"</span>);</div>
- <div class="ttc" id="aclass_sim_object_ptr_html"><div class="ttname"><a href="class_sim_object_ptr.html">SimObjectPtr</a></div><div class="ttdef"><b>Definition</b> simObjectPtr.h:56</div></div>
- <div class="ttc" id="anamespace_sim_html_a3e94a217b10a43c58030035d7efa5ea4"><div class="ttname"><a href="namespace_sim.html#a3e94a217b10a43c58030035d7efa5ea4">Sim::findObject</a></div><div class="ttdeci">SimObject * findObject(SimObjectId)</div><div class="ttdef"><b>Definition</b> simManager.cc:384</div></div>
- </div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a8f954f9d7067b980db407ea2b1808d55" name="a8f954f9d7067b980db407ea2b1808d55"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8f954f9d7067b980db407ea2b1808d55">◆ </a></span>SimObjectPtr() <span class="overload">[1/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="af2b5aedf23c1afabdd2728b9d6613416" name="af2b5aedf23c1afabdd2728b9d6613416"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af2b5aedf23c1afabdd2728b9d6613416">◆ </a></span>SimObjectPtr() <span class="overload">[2/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a> </td>
- <td>(</td>
- <td class="paramtype">T * </td>
- <td class="paramname"><em>ptr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a31c0eda5d99f4c0e482634ee72c54075" name="a31c0eda5d99f4c0e482634ee72c54075"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a31c0eda5d99f4c0e482634ee72c54075">◆ </a></span>SimObjectPtr() <span class="overload">[3/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a> </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & </td>
- <td class="paramname"><em>rhs</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9344968a2fec9611eb5a5d55a0052398" name="a9344968a2fec9611eb5a5d55a0052398"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9344968a2fec9611eb5a5d55a0052398">◆ </a></span>~SimObjectPtr()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="abada6dfb33f4cbafe1e443a5cf8dc8d0" name="abada6dfb33f4cbafe1e443a5cf8dc8d0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abada6dfb33f4cbafe1e443a5cf8dc8d0">◆ </a></span>isNull()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isNull </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="afecd672b9856ca49258c2e0014502e63" name="afecd672b9856ca49258c2e0014502e63"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afecd672b9856ca49258c2e0014502e63">◆ </a></span>notNull()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool notNull </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a3efedfc79726ae494572af41183b3803" name="a3efedfc79726ae494572af41183b3803"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3efedfc79726ae494572af41183b3803">◆ </a></span>operator T*()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">operator T* </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a09eda862da843825d1849dd63af36a2a" name="a09eda862da843825d1849dd63af36a2a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a09eda862da843825d1849dd63af36a2a">◆ </a></span>operator*()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T & operator* </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a84e9959608997de8fe4355def47ff45a" name="a84e9959608997de8fe4355def47ff45a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a84e9959608997de8fe4355def47ff45a">◆ </a></span>operator->()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T * operator-> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="acb623cd8c744e790bfe858c133ee179d" name="acb623cd8c744e790bfe858c133ee179d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acb623cd8c744e790bfe858c133ee179d">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & operator= </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & </td>
- <td class="paramname"><em>rhs</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ad30b11b87166dea7df7e5b870af9e4f9" name="ad30b11b87166dea7df7e5b870af9e4f9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad30b11b87166dea7df7e5b870af9e4f9">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object_ptr.html">SimObjectPtr</a>< T > & operator= </td>
- <td>(</td>
- <td class="paramtype">T * </td>
- <td class="paramname"><em>ptr</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>sim/<b>simObjectPtr.h</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|