Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-30 15:08:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
recastnavigation/classrcContext.html

805 lines
38 KiB
HTML
Raw Permalink Blame History

<!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>Recast Navigation: rcContext 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">Recast Navigation
</div>
<div id="projectbrief">Navigation-mesh Toolset for Games</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classrcContext.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classrcContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">rcContext Class Reference<div class="ingroups"><a class="el" href="group__recast.html">Recast</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Provides an interface for optional logging and performance tracking of the Recast build process.
<a href="classrcContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Recast_8h_source.html">Recast.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for rcContext:</div>
<div class="dyncontent">
<div class="center">
<img src="classrcContext.png" usemap="#rcContext_map" alt=""/>
<map id="rcContext_map" name="rcContext_map">
<area href="classBuildContext.html" title="Recast build context." alt="BuildContext" shape="rect" coords="0,56,82,80"/>
</map>
</div></div>
<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:ae405295998d6c1db0ceb60d0f64559bc" id="r_ae405295998d6c1db0ceb60d0f64559bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#ae405295998d6c1db0ceb60d0f64559bc">rcContext</a> (bool state=true)</td></tr>
<tr class="memdesc:ae405295998d6c1db0ceb60d0f64559bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:ae405295998d6c1db0ceb60d0f64559bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02204e324a8ebcf81f489681e80bc61c" id="r_a02204e324a8ebcf81f489681e80bc61c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a02204e324a8ebcf81f489681e80bc61c">~rcContext</a> ()</td></tr>
<tr class="separator:a02204e324a8ebcf81f489681e80bc61c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03dcf9240dc69a7c329c15e32be12d8e" id="r_a03dcf9240dc69a7c329c15e32be12d8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a03dcf9240dc69a7c329c15e32be12d8e">enableLog</a> (bool state)</td></tr>
<tr class="memdesc:a03dcf9240dc69a7c329c15e32be12d8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables logging. <br /></td></tr>
<tr class="separator:a03dcf9240dc69a7c329c15e32be12d8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68403737730ee112c523890a9fdc237d" id="r_a68403737730ee112c523890a9fdc237d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a68403737730ee112c523890a9fdc237d">resetLog</a> ()</td></tr>
<tr class="memdesc:a68403737730ee112c523890a9fdc237d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all log entries. <br /></td></tr>
<tr class="separator:a68403737730ee112c523890a9fdc237d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3cc278477b1b923d03ea50e3ae96013" id="r_ae3cc278477b1b923d03ea50e3ae96013"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#ae3cc278477b1b923d03ea50e3ae96013">log</a> (const <a class="el" href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410b">rcLogCategory</a> category, const char *format,...)</td></tr>
<tr class="memdesc:ae3cc278477b1b923d03ea50e3ae96013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logs a message. <br /></td></tr>
<tr class="separator:ae3cc278477b1b923d03ea50e3ae96013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4680430d751824f83634ac753df9669" id="r_aa4680430d751824f83634ac753df9669"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#aa4680430d751824f83634ac753df9669">enableTimer</a> (bool state)</td></tr>
<tr class="memdesc:aa4680430d751824f83634ac753df9669"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables or disables the performance timers. <br /></td></tr>
<tr class="separator:aa4680430d751824f83634ac753df9669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fcc58bb1e29bbb9a7dfb834efff4a6d" id="r_a2fcc58bb1e29bbb9a7dfb834efff4a6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a2fcc58bb1e29bbb9a7dfb834efff4a6d">resetTimers</a> ()</td></tr>
<tr class="memdesc:a2fcc58bb1e29bbb9a7dfb834efff4a6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all performance timers. (Resets all to unused.) <br /></td></tr>
<tr class="separator:a2fcc58bb1e29bbb9a7dfb834efff4a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c8d3035e1046dd8907b10b7d9c8de57" id="r_a3c8d3035e1046dd8907b10b7d9c8de57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a3c8d3035e1046dd8907b10b7d9c8de57">startTimer</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label)</td></tr>
<tr class="memdesc:a3c8d3035e1046dd8907b10b7d9c8de57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the specified performance timer. <br /></td></tr>
<tr class="separator:a3c8d3035e1046dd8907b10b7d9c8de57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7042723b8d99d486575eb3d592af25" id="r_a3f7042723b8d99d486575eb3d592af25"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a3f7042723b8d99d486575eb3d592af25">stopTimer</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label)</td></tr>
<tr class="memdesc:a3f7042723b8d99d486575eb3d592af25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the specified performance timer. <br /></td></tr>
<tr class="separator:a3f7042723b8d99d486575eb3d592af25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17e7b79afff2f042961698aa1c818c3d" id="r_a17e7b79afff2f042961698aa1c818c3d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a17e7b79afff2f042961698aa1c818c3d">getAccumulatedTime</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label) const</td></tr>
<tr class="memdesc:a17e7b79afff2f042961698aa1c818c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total accumulated time of the specified performance timer. <br /></td></tr>
<tr class="separator:a17e7b79afff2f042961698aa1c818c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae1e5eb9146a011c1f51de76b849d9ec2" id="r_ae1e5eb9146a011c1f51de76b849d9ec2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#ae1e5eb9146a011c1f51de76b849d9ec2">doResetLog</a> ()</td></tr>
<tr class="memdesc:ae1e5eb9146a011c1f51de76b849d9ec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all log entries. <br /></td></tr>
<tr class="separator:ae1e5eb9146a011c1f51de76b849d9ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82cccfe74cb76b021acdca506df224e0" id="r_a82cccfe74cb76b021acdca506df224e0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a82cccfe74cb76b021acdca506df224e0">doLog</a> (const <a class="el" href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410b">rcLogCategory</a> category, const char *msg, const int len)</td></tr>
<tr class="memdesc:a82cccfe74cb76b021acdca506df224e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logs a message. <br /></td></tr>
<tr class="separator:a82cccfe74cb76b021acdca506df224e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57a97f408dac1438d6eae0993fa68570" id="r_a57a97f408dac1438d6eae0993fa68570"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a57a97f408dac1438d6eae0993fa68570">doResetTimers</a> ()</td></tr>
<tr class="memdesc:a57a97f408dac1438d6eae0993fa68570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all timers. (Resets all to unused.) <br /></td></tr>
<tr class="separator:a57a97f408dac1438d6eae0993fa68570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff09f57cc5db39be3cf80c7c0a1457a2" id="r_aff09f57cc5db39be3cf80c7c0a1457a2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#aff09f57cc5db39be3cf80c7c0a1457a2">doStartTimer</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label)</td></tr>
<tr class="memdesc:aff09f57cc5db39be3cf80c7c0a1457a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the specified performance timer. <br /></td></tr>
<tr class="separator:aff09f57cc5db39be3cf80c7c0a1457a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3510678ae74a930e6d4e492d44fe80c0" id="r_a3510678ae74a930e6d4e492d44fe80c0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a3510678ae74a930e6d4e492d44fe80c0">doStopTimer</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label)</td></tr>
<tr class="memdesc:a3510678ae74a930e6d4e492d44fe80c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the specified performance timer. <br /></td></tr>
<tr class="separator:a3510678ae74a930e6d4e492d44fe80c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa974806b3533f3ce7bcd8c42715e8d93" id="r_aa974806b3533f3ce7bcd8c42715e8d93"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#aa974806b3533f3ce7bcd8c42715e8d93">doGetAccumulatedTime</a> (const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a> label) const</td></tr>
<tr class="memdesc:aa974806b3533f3ce7bcd8c42715e8d93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total accumulated time of the specified performance timer. <br /></td></tr>
<tr class="separator:aa974806b3533f3ce7bcd8c42715e8d93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af3690c070989bc399cd39e2da2b0fbad" id="r_af3690c070989bc399cd39e2da2b0fbad"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#af3690c070989bc399cd39e2da2b0fbad">m_logEnabled</a></td></tr>
<tr class="memdesc:af3690c070989bc399cd39e2da2b0fbad"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if logging is enabled. <br /></td></tr>
<tr class="separator:af3690c070989bc399cd39e2da2b0fbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a851ba8cc41ee2185be82fe11e847c846" id="r_a851ba8cc41ee2185be82fe11e847c846"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrcContext.html#a851ba8cc41ee2185be82fe11e847c846">m_timerEnabled</a></td></tr>
<tr class="memdesc:a851ba8cc41ee2185be82fe11e847c846"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the performance timers are enabled. <br /></td></tr>
<tr class="separator:a851ba8cc41ee2185be82fe11e847c846"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Provides an interface for optional logging and performance tracking of the Recast build process. </p>
<p>This class does not provide logging or timer functionality on its own. Both must be provided by a concrete implementation by overriding the protected member functions. Also, this class does not provide an interface for extracting log messages. (Only adding them.) So concrete implementations must provide one.</p>
<p>If no logging or timers are required, just pass an instance of this class through the Recast build process. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae405295998d6c1db0ceb60d0f64559bc" name="ae405295998d6c1db0ceb60d0f64559bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae405295998d6c1db0ceb60d0f64559bc">&#9670;&#160;</a></span>rcContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rcContext::rcContext </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>state</em> = <code>true</code></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">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>TRUE if the logging and performance timers should be enabled. [Default: true] </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a02204e324a8ebcf81f489681e80bc61c" name="a02204e324a8ebcf81f489681e80bc61c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02204e324a8ebcf81f489681e80bc61c">&#9670;&#160;</a></span>~rcContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual rcContext::~rcContext </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="aa974806b3533f3ce7bcd8c42715e8d93" name="aa974806b3533f3ce7bcd8c42715e8d93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa974806b3533f3ce7bcd8c42715e8d93">&#9670;&#160;</a></span>doGetAccumulatedTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int rcContext::doGetAccumulatedTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the total accumulated time of the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The category of the timer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The accumulated time of the timer, or -1 if timers are disabled or the timer has never been started. </dd></dl>
<p>Reimplemented in <a class="el" href="classBuildContext.html#adbeab3805bca4fe27f42f04874b007a9">BuildContext</a>.</p>
</div>
</div>
<a id="a82cccfe74cb76b021acdca506df224e0" name="a82cccfe74cb76b021acdca506df224e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82cccfe74cb76b021acdca506df224e0">&#9670;&#160;</a></span>doLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void rcContext::doLog </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410b">rcLogCategory</a>&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>len</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">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">category</td><td>The category of the message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The formatted message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length of the formatted message. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classBuildContext.html#aac93235d9a987dd702172270910dda66">BuildContext</a>.</p>
</div>
</div>
<a id="ae1e5eb9146a011c1f51de76b849d9ec2" name="ae1e5eb9146a011c1f51de76b849d9ec2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1e5eb9146a011c1f51de76b849d9ec2">&#9670;&#160;</a></span>doResetLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::doResetLog </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears all log entries. </p>
<p>Reimplemented in <a class="el" href="classBuildContext.html#ad6c02487f6a5795ed2d5351f7ae84572">BuildContext</a>.</p>
</div>
</div>
<a id="a57a97f408dac1438d6eae0993fa68570" name="a57a97f408dac1438d6eae0993fa68570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57a97f408dac1438d6eae0993fa68570">&#9670;&#160;</a></span>doResetTimers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void rcContext::doResetTimers </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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears all timers. (Resets all to unused.) </p>
<p>Reimplemented in <a class="el" href="classBuildContext.html#ad2ef30593451022119f7aab34e0814af">BuildContext</a>.</p>
</div>
</div>
<a id="aff09f57cc5db39be3cf80c7c0a1457a2" name="aff09f57cc5db39be3cf80c7c0a1457a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff09f57cc5db39be3cf80c7c0a1457a2">&#9670;&#160;</a></span>doStartTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void rcContext::doStartTimer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The category of timer. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classBuildContext.html#a69b445bd78177cd139fe4e1d142af1ca">BuildContext</a>.</p>
</div>
</div>
<a id="a3510678ae74a930e6d4e492d44fe80c0" name="a3510678ae74a930e6d4e492d44fe80c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3510678ae74a930e6d4e492d44fe80c0">&#9670;&#160;</a></span>doStopTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void rcContext::doStopTimer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The category of the timer. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classBuildContext.html#aeb39b1dae27dca7fce8885d019bd4c28">BuildContext</a>.</p>
</div>
</div>
<a id="a03dcf9240dc69a7c329c15e32be12d8e" name="a03dcf9240dc69a7c329c15e32be12d8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03dcf9240dc69a7c329c15e32be12d8e">&#9670;&#160;</a></span>enableLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::enableLog </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>state</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">
<p>Enables or disables logging. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>TRUE if logging should be enabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa4680430d751824f83634ac753df9669" name="aa4680430d751824f83634ac753df9669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4680430d751824f83634ac753df9669">&#9670;&#160;</a></span>enableTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::enableTimer </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>state</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">
<p>Enables or disables the performance timers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>TRUE if timers should be enabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17e7b79afff2f042961698aa1c818c3d" name="a17e7b79afff2f042961698aa1c818c3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e7b79afff2f042961698aa1c818c3d">&#9670;&#160;</a></span>getAccumulatedTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int rcContext::getAccumulatedTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</em></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">
<p>Returns the total accumulated time of the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">label</td><td>The category of the timer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The accumulated time of the timer, or -1 if timers are disabled or the timer has never been started. </dd></dl>
</div>
</div>
<a id="ae3cc278477b1b923d03ea50e3ae96013" name="ae3cc278477b1b923d03ea50e3ae96013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3cc278477b1b923d03ea50e3ae96013">&#9670;&#160;</a></span>log()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rcContext::log </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410b">rcLogCategory</a>&#160;</td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message. </p>
<p>Example: </p><div class="fragment"><div class="line"><span class="comment">// Where ctx is an instance of rcContext and filepath is a char array.</span></div>
<div class="line">ctx-&gt;log(<a class="code hl_enumvalue" href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410ba50cefdab02ef964b5f5ba6093752eea9">RC_LOG_ERROR</a>, <span class="stringliteral">&quot;buildTiledNavigation: Could not load &#39;%s&#39;&quot;</span>, filepath);</div>
<div class="ttc" id="aRecast_8h_html_a82cf824a1948a8442785a7ea184f410ba50cefdab02ef964b5f5ba6093752eea9"><div class="ttname"><a href="Recast_8h.html#a82cf824a1948a8442785a7ea184f410ba50cefdab02ef964b5f5ba6093752eea9">RC_LOG_ERROR</a></div><div class="ttdeci">@ RC_LOG_ERROR</div><div class="ttdoc">An error log entry.</div><div class="ttdef"><b>Definition</b> Recast.h:34</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">category</td><td>The category of the message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a68403737730ee112c523890a9fdc237d" name="a68403737730ee112c523890a9fdc237d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68403737730ee112c523890a9fdc237d">&#9670;&#160;</a></span>resetLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::resetLog </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">
<p>Clears all log entries. </p>
</div>
</div>
<a id="a2fcc58bb1e29bbb9a7dfb834efff4a6d" name="a2fcc58bb1e29bbb9a7dfb834efff4a6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fcc58bb1e29bbb9a7dfb834efff4a6d">&#9670;&#160;</a></span>resetTimers()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::resetTimers </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">
<p>Clears all performance timers. (Resets all to unused.) </p>
</div>
</div>
<a id="a3c8d3035e1046dd8907b10b7d9c8de57" name="a3c8d3035e1046dd8907b10b7d9c8de57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c8d3035e1046dd8907b10b7d9c8de57">&#9670;&#160;</a></span>startTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::startTimer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</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">
<p>Starts the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">label</td><td>The category of the timer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3f7042723b8d99d486575eb3d592af25" name="a3f7042723b8d99d486575eb3d592af25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f7042723b8d99d486575eb3d592af25">&#9670;&#160;</a></span>stopTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rcContext::stopTimer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Recast_8h.html#a0d44e82cf0c9a0df344aaff8654ea18d">rcTimerLabel</a>&#160;</td>
<td class="paramname"><em>label</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">
<p>Stops the specified performance timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">label</td><td>The category of the timer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af3690c070989bc399cd39e2da2b0fbad" name="af3690c070989bc399cd39e2da2b0fbad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3690c070989bc399cd39e2da2b0fbad">&#9670;&#160;</a></span>m_logEnabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rcContext::m_logEnabled</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if logging is enabled. </p>
</div>
</div>
<a id="a851ba8cc41ee2185be82fe11e847c846" name="a851ba8cc41ee2185be82fe11e847c846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a851ba8cc41ee2185be82fe11e847c846">&#9670;&#160;</a></span>m_timerEnabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rcContext::m_timerEnabled</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the performance timers are enabled. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Recast_8h_source.html">Recast.h</a></li>
<li><a class="el" href="Recast_8cpp.html">Recast.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classrcContext.html">rcContext</a></li>
&nbsp;&nbsp;<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
| <a href="./License.txt">Licence (ZLib)</a>
| Copyright 2009 Mikko Mononen
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink