classgameplay_1_1_node_clone_context.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  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>NodeCloneContext Class Reference</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/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="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
  28. <td><a href="https://github.com/gameplay3d/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"><a class="el" href="classgameplay_1_1_node_clone_context.html">NodeCloneContext</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-methods">Public Member Functions</a> </div>
  88. <div class="headertitle">
  89. <div class="title">gameplay::NodeCloneContext Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <!-- doxytag: class="gameplay::NodeCloneContext" -->
  93. <p><code>#include &lt;Node.h&gt;</code></p>
  94. <p><a href="classgameplay_1_1_node_clone_context-members.html">List of all members.</a></p>
  95. <table class="memberdecls">
  96. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#a98e316d4905ca7d8d0d585300450d4b5">NodeCloneContext</a> ()</td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#a47bbbc68f29b7bf169099f80b26f1f36">~NodeCloneContext</a> ()</td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_animation.html">Animation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#afb8fad243e027061b906ca2f2b894aa1">findClonedAnimation</a> (const <a class="el" href="classgameplay_1_1_animation.html">Animation</a> *animation)</td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#a81e2f74240d6827fc671f9ea45b9fac8">registerClonedAnimation</a> (const <a class="el" href="classgameplay_1_1_animation.html">Animation</a> *original, <a class="el" href="classgameplay_1_1_animation.html">Animation</a> *clone)</td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#aff75fe25661d42095c629555ec15ae4b">findClonedNode</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *node)</td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_node_clone_context.html#a343fc161a33eb0c24fd94242fea60414">registerClonedNode</a> (const <a class="el" href="classgameplay_1_1_node.html">Node</a> *original, <a class="el" href="classgameplay_1_1_node.html">Node</a> *clone)</td></tr>
  104. </table>
  105. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  106. <div class="textblock"><p><a class="el" href="classgameplay_1_1_node_clone_context.html">NodeCloneContext</a> represents the context data that is kept when cloning a node. The <a class="el" href="classgameplay_1_1_node_clone_context.html">NodeCloneContext</a> is used to make sure objects don't get cloned twice. </p>
  107. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  108. <a class="anchor" id="a98e316d4905ca7d8d0d585300450d4b5"></a><!-- doxytag: member="gameplay::NodeCloneContext::NodeCloneContext" ref="a98e316d4905ca7d8d0d585300450d4b5" args="()" -->
  109. <div class="memitem">
  110. <div class="memproto">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname"><a class="el" href="classgameplay_1_1_node_clone_context.html#a98e316d4905ca7d8d0d585300450d4b5">gameplay::NodeCloneContext::NodeCloneContext</a> </td>
  114. <td>(</td>
  115. <td class="paramname"></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </div>
  120. <div class="memdoc">
  121. <p>Constructor. </p>
  122. </div>
  123. </div>
  124. <a class="anchor" id="a47bbbc68f29b7bf169099f80b26f1f36"></a><!-- doxytag: member="gameplay::NodeCloneContext::~NodeCloneContext" ref="a47bbbc68f29b7bf169099f80b26f1f36" args="()" -->
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname"><a class="el" href="classgameplay_1_1_node_clone_context.html#a47bbbc68f29b7bf169099f80b26f1f36">gameplay::NodeCloneContext::~NodeCloneContext</a> </td>
  130. <td>(</td>
  131. <td class="paramname"></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </div>
  136. <div class="memdoc">
  137. <p>Destructor. </p>
  138. </div>
  139. </div>
  140. <hr/><h2>Member Function Documentation</h2>
  141. <a class="anchor" id="afb8fad243e027061b906ca2f2b894aa1"></a><!-- doxytag: member="gameplay::NodeCloneContext::findClonedAnimation" ref="afb8fad243e027061b906ca2f2b894aa1" args="(const Animation *animation)" -->
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname"><a class="el" href="classgameplay_1_1_animation.html">Animation</a>* <a class="el" href="classgameplay_1_1_node_clone_context.html#afb8fad243e027061b906ca2f2b894aa1">gameplay::NodeCloneContext::findClonedAnimation</a> </td>
  147. <td>(</td>
  148. <td class="paramtype">const <a class="el" href="classgameplay_1_1_animation.html">Animation</a> *&#160;</td>
  149. <td class="paramname"><em>animation</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </div>
  154. <div class="memdoc">
  155. <p>Finds the cloned animation of the given animation or NULL if this animation was not registered with this context.</p>
  156. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  157. <table class="params">
  158. <tr><td class="paramname">animation</td><td>The animation to search for the cloned copy of.</td></tr>
  159. </table>
  160. </dd>
  161. </dl>
  162. <dl class="return"><dt><b>Returns:</b></dt><dd>The cloned animation or NULL if not found. </dd></dl>
  163. </div>
  164. </div>
  165. <a class="anchor" id="aff75fe25661d42095c629555ec15ae4b"></a><!-- doxytag: member="gameplay::NodeCloneContext::findClonedNode" ref="aff75fe25661d42095c629555ec15ae4b" args="(const Node *node)" -->
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="classgameplay_1_1_node.html">Node</a>* <a class="el" href="classgameplay_1_1_node_clone_context.html#aff75fe25661d42095c629555ec15ae4b">gameplay::NodeCloneContext::findClonedNode</a> </td>
  171. <td>(</td>
  172. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  173. <td class="paramname"><em>node</em></td><td>)</td>
  174. <td></td>
  175. </tr>
  176. </table>
  177. </div>
  178. <div class="memdoc">
  179. <p>Finds the cloned node of the given node or NULL if this node was not registered with this context.</p>
  180. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">node</td><td>The node to search for the cloned copy of.</td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <dl class="return"><dt><b>Returns:</b></dt><dd>The cloned node or NULL if not found. </dd></dl>
  187. </div>
  188. </div>
  189. <a class="anchor" id="a81e2f74240d6827fc671f9ea45b9fac8"></a><!-- doxytag: member="gameplay::NodeCloneContext::registerClonedAnimation" ref="a81e2f74240d6827fc671f9ea45b9fac8" args="(const Animation *original, Animation *clone)" -->
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">void <a class="el" href="classgameplay_1_1_node_clone_context.html#a81e2f74240d6827fc671f9ea45b9fac8">gameplay::NodeCloneContext::registerClonedAnimation</a> </td>
  195. <td>(</td>
  196. <td class="paramtype">const <a class="el" href="classgameplay_1_1_animation.html">Animation</a> *&#160;</td>
  197. <td class="paramname"><em>original</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype"><a class="el" href="classgameplay_1_1_animation.html">Animation</a> *&#160;</td>
  203. <td class="paramname"><em>clone</em>&#160;</td>
  204. </tr>
  205. <tr>
  206. <td></td>
  207. <td>)</td>
  208. <td></td><td></td>
  209. </tr>
  210. </table>
  211. </div>
  212. <div class="memdoc">
  213. <p>Registers the cloned animation with this context so that it doesn't get cloned twice.</p>
  214. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  215. <table class="params">
  216. <tr><td class="paramname">original</td><td>The pointer to the original animation. </td></tr>
  217. <tr><td class="paramname">clone</td><td>The pointer to the cloned animation. </td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. </div>
  222. </div>
  223. <a class="anchor" id="a343fc161a33eb0c24fd94242fea60414"></a><!-- doxytag: member="gameplay::NodeCloneContext::registerClonedNode" ref="a343fc161a33eb0c24fd94242fea60414" args="(const Node *original, Node *clone)" -->
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">void <a class="el" href="classgameplay_1_1_node_clone_context.html#a343fc161a33eb0c24fd94242fea60414">gameplay::NodeCloneContext::registerClonedNode</a> </td>
  229. <td>(</td>
  230. <td class="paramtype">const <a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  231. <td class="paramname"><em>original</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype"><a class="el" href="classgameplay_1_1_node.html">Node</a> *&#160;</td>
  237. <td class="paramname"><em>clone</em>&#160;</td>
  238. </tr>
  239. <tr>
  240. <td></td>
  241. <td>)</td>
  242. <td></td><td></td>
  243. </tr>
  244. </table>
  245. </div>
  246. <div class="memdoc">
  247. <p>Registers the cloned node with this context so that it doens't get cloned twice.</p>
  248. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  249. <table class="params">
  250. <tr><td class="paramname">original</td><td>The pointer to the original node. </td></tr>
  251. <tr><td class="paramname">clone</td><td>The pointer to the cloned node. </td></tr>
  252. </table>
  253. </dd>
  254. </dl>
  255. </div>
  256. </div>
  257. </div><!-- contents -->
  258. <!-- window showing the filter options -->
  259. <div id="MSearchSelectWindow"
  260. onmouseover="return searchBox.OnSearchSelectShow()"
  261. onmouseout="return searchBox.OnSearchSelectHide()"
  262. onkeydown="return searchBox.OnSearchSelectKey(event)">
  263. <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>
  264. <!-- iframe showing the search results (closed by default) -->
  265. <div id="MSearchResultsWindow">
  266. <iframe src="javascript:void(0)" frameborder="0"
  267. name="MSearchResults" id="MSearchResults">
  268. </iframe>
  269. </div>
  270. <hr class="footer"/><address class="footer"><small>
  271. Generated on Sat Jan 24 2015 15:29:43 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  272. <img class="footer" src="doxygen.png" alt="doxygen"/>
  273. </a> 1.7.6.1
  274. </small></address>
  275. </body>
  276. </html>