TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
							<!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: TamlVisitor Class 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&amp;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&amp;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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_taml_visitor-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">TamlVisitor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__taml_group.html">TAML Reference</a></div></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;tamlVisitor.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TamlVisitor:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_taml_visitor.png" usemap="#TamlVisitor_map" alt=""/>
  <map id="TamlVisitor_map" name="TamlVisitor_map">
<area href="class_taml_asset_declared_update_visitor.html" alt="TamlAssetDeclaredUpdateVisitor" shape="rect" coords="0,56,210,80"/>
<area href="class_taml_asset_declared_visitor.html" alt="TamlAssetDeclaredVisitor" shape="rect" coords="220,56,430,80"/>
<area href="class_taml_asset_referenced_update_visitor.html" alt="TamlAssetReferencedUpdateVisitor" shape="rect" coords="440,56,650,80"/>
<area href="class_taml_asset_referenced_visitor.html" alt="TamlAssetReferencedVisitor" shape="rect" coords="660,56,870,80"/>
<area href="class_taml_module_id_update_visitor.html" alt="TamlModuleIdUpdateVisitor" shape="rect" coords="880,56,1090,80"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_taml_visitor_1_1_property_state.html">PropertyState</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visitor property state.  <a href="struct_taml_visitor_1_1_property_state.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3d668a87069b7b9cabe8006c6aeae74a" id="r_a3d668a87069b7b9cabe8006c6aeae74a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_visitor.html#a3d668a87069b7b9cabe8006c6aeae74a">TamlVisitor</a> ()</td></tr>
<tr class="separator:a3d668a87069b7b9cabe8006c6aeae74a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a989a2f6d646f310d1cfa49df68ada37b" id="r_a989a2f6d646f310d1cfa49df68ada37b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_visitor.html#a989a2f6d646f310d1cfa49df68ada37b">~TamlVisitor</a> ()</td></tr>
<tr class="separator:a989a2f6d646f310d1cfa49df68ada37b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33993499343640d37277934970b77044" id="r_a33993499343640d37277934970b77044"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_visitor.html#a33993499343640d37277934970b77044">wantsPropertyChanges</a> (void)=0</td></tr>
<tr class="separator:a33993499343640d37277934970b77044"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a531d4ecc16a2bca351d52fd7b4b787b7" id="r_a531d4ecc16a2bca351d52fd7b4b787b7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_visitor.html#a531d4ecc16a2bca351d52fd7b4b787b7">wantsRootOnly</a> (void)=0</td></tr>
<tr class="memdesc:a531d4ecc16a2bca351d52fd7b4b787b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the visitor wants to visit the root node only.  <br /></td></tr>
<tr class="separator:a531d4ecc16a2bca351d52fd7b4b787b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3568c224b31c1eb85179caa35dd87ef4" id="r_a3568c224b31c1eb85179caa35dd87ef4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_visitor.html#a3568c224b31c1eb85179caa35dd87ef4">visit</a> (const <a class="el" href="class_taml_parser.html">TamlParser</a> &amp;parser, <a class="el" href="struct_taml_visitor_1_1_property_state.html">PropertyState</a> &amp;propertyState)=0</td></tr>
<tr class="memdesc:a3568c224b31c1eb85179caa35dd87ef4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The state of the visited property.  <br /></td></tr>
<tr class="separator:a3568c224b31c1eb85179caa35dd87ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__taml_group.html">TAML Reference</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3d668a87069b7b9cabe8006c6aeae74a" name="a3d668a87069b7b9cabe8006c6aeae74a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d668a87069b7b9cabe8006c6aeae74a">&#9670;&#160;</a></span>TamlVisitor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_taml_visitor.html">TamlVisitor</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="a989a2f6d646f310d1cfa49df68ada37b" name="a989a2f6d646f310d1cfa49df68ada37b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989a2f6d646f310d1cfa49df68ada37b">&#9670;&#160;</a></span>~TamlVisitor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="class_taml_visitor.html">TamlVisitor</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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3568c224b31c1eb85179caa35dd87ef4" name="a3568c224b31c1eb85179caa35dd87ef4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3568c224b31c1eb85179caa35dd87ef4">&#9670;&#160;</a></span>visit()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool visit </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_taml_parser.html">TamlParser</a> &amp;&#160;</td>
          <td class="paramname"><em>parser</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_taml_visitor_1_1_property_state.html">PropertyState</a> &amp;&#160;</td>
          <td class="paramname"><em>propertyState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The state of the visited property. </p>

<p>Implemented in <a class="el" href="class_taml_asset_declared_update_visitor.html#a6cff3f9d838f79d6eb4904d804c5803b">TamlAssetDeclaredUpdateVisitor</a>, <a class="el" href="class_taml_asset_declared_visitor.html#a6cff3f9d838f79d6eb4904d804c5803b">TamlAssetDeclaredVisitor</a>, <a class="el" href="class_taml_asset_referenced_update_visitor.html#a6cff3f9d838f79d6eb4904d804c5803b">TamlAssetReferencedUpdateVisitor</a>, <a class="el" href="class_taml_asset_referenced_visitor.html#a6cff3f9d838f79d6eb4904d804c5803b">TamlAssetReferencedVisitor</a>, and <a class="el" href="class_taml_module_id_update_visitor.html#a6cff3f9d838f79d6eb4904d804c5803b">TamlModuleIdUpdateVisitor</a>.</p>

</div>
</div>
<a id="a33993499343640d37277934970b77044" name="a33993499343640d37277934970b77044"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33993499343640d37277934970b77044">&#9670;&#160;</a></span>wantsPropertyChanges()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool wantsPropertyChanges </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Whether the visitor wants to perform property changes. This allows a check against the parser which may not allow changes. </p>

<p>Implemented in <a class="el" href="class_taml_asset_declared_update_visitor.html#a714f5cbbcd4d92196ac0f1c9a5b15d8a">TamlAssetDeclaredUpdateVisitor</a>, <a class="el" href="class_taml_asset_declared_visitor.html#a714f5cbbcd4d92196ac0f1c9a5b15d8a">TamlAssetDeclaredVisitor</a>, <a class="el" href="class_taml_asset_referenced_update_visitor.html#a714f5cbbcd4d92196ac0f1c9a5b15d8a">TamlAssetReferencedUpdateVisitor</a>, <a class="el" href="class_taml_asset_referenced_visitor.html#a714f5cbbcd4d92196ac0f1c9a5b15d8a">TamlAssetReferencedVisitor</a>, and <a class="el" href="class_taml_module_id_update_visitor.html#a714f5cbbcd4d92196ac0f1c9a5b15d8a">TamlModuleIdUpdateVisitor</a>.</p>

</div>
</div>
<a id="a531d4ecc16a2bca351d52fd7b4b787b7" name="a531d4ecc16a2bca351d52fd7b4b787b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a531d4ecc16a2bca351d52fd7b4b787b7">&#9670;&#160;</a></span>wantsRootOnly()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool wantsRootOnly </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the visitor wants to visit the root node only. </p>

<p>Implemented in <a class="el" href="class_taml_asset_declared_update_visitor.html#a325c816a24fa36f419ab2aa6f12512c2">TamlAssetDeclaredUpdateVisitor</a>, <a class="el" href="class_taml_asset_declared_visitor.html#a325c816a24fa36f419ab2aa6f12512c2">TamlAssetDeclaredVisitor</a>, <a class="el" href="class_taml_asset_referenced_update_visitor.html#a325c816a24fa36f419ab2aa6f12512c2">TamlAssetReferencedUpdateVisitor</a>, <a class="el" href="class_taml_asset_referenced_visitor.html#a325c816a24fa36f419ab2aa6f12512c2">TamlAssetReferencedVisitor</a>, and <a class="el" href="class_taml_module_id_update_visitor.html#a325c816a24fa36f419ab2aa6f12512c2">TamlModuleIdUpdateVisitor</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>persistence/taml/<b>tamlVisitor.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>