lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-01 17:08:57 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
05ca20eaf4faacef2aba407d3d0ce037e9ed1e16
opennurbs/6/d8/d13/class_o_n___progress_reporter.html
Bozo 832ccb5c1a Publish! 
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

373 lines
28 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_ProgressReporter 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="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- bootstrap -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- smartmenus -->
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
</head>
<body>
<!-- <div class="version-banner">
Go back to the <a href="/">main site</a>...
</div> -->
<div class="container">
<!-- navbar -->
<nav class="navbar navbar-default">
<div class="container-fluid">
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
<div class="navbar-collapse collapse" id="main-nav-placeholder">
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="#">Latest (6.x)</a></li>
<li class="disabled"><a href="#">WIP (7.x)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="page-content">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../d0/d5f/class_o_n___progress_reporter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_ProgressReporter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d5/d6c/opennurbs__progress__reporter_8h_source.html">opennurbs_progress_reporter.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8f262c3526a41ec2be515435b9e4cbec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#a8f262c3526a41ec2be515435b9e4cbec">ON_ProgressReporter</a> ()</td></tr>
<tr class="separator:a8f262c3526a41ec2be515435b9e4cbec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad7920048a1d2c5f6894824c81edbf98"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#aad7920048a1d2c5f6894824c81edbf98">~ON_ProgressReporter</a> ()</td></tr>
<tr class="separator:aad7920048a1d2c5f6894824c81edbf98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae121a10fbcd1d3f17b8ce169d0384d6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ae121a10fbcd1d3f17b8ce169d0384d6d">SetSynchronousProgressCallbackFunction</a> (void(*callback_function)(ON__UINT_PTR context, double fraction_complete), ON__UINT_PTR callback_context)</td></tr>
<tr class="memdesc:ae121a10fbcd1d3f17b8ce169d0384d6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the function that is called when a calculation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ReportProgress()</a>. <a href="#ae121a10fbcd1d3f17b8ce169d0384d6d">More...</a><br /></td></tr>
<tr class="separator:ae121a10fbcd1d3f17b8ce169d0384d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6020b6202bcd94a27ed458a7404ab81e"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#a6020b6202bcd94a27ed458a7404ab81e">FractionComplete</a> (<a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter)</td></tr>
<tr class="memdesc:a6020b6202bcd94a27ed458a7404ab81e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The calculation may call <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#a6020b6202bcd94a27ed458a7404ab81e" title="The calculation may call ON_ProgressReporter::FractionComplete to get the current fraction completed...">ON_ProgressReporter::FractionComplete</a> to get the current fraction completed. <a href="#a6020b6202bcd94a27ed458a7404ab81e">More...</a><br /></td></tr>
<tr class="separator:a6020b6202bcd94a27ed458a7404ab81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f89acab0ff9a81c3cabb4d7ce5935e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ReportProgress</a> (<a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter, double fraction_complete)</td></tr>
<tr class="memdesc:ab9f89acab0ff9a81c3cabb4d7ce5935e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. <a href="#ab9f89acab0ff9a81c3cabb4d7ce5935e">More...</a><br /></td></tr>
<tr class="separator:ab9f89acab0ff9a81c3cabb4d7ce5935e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5de9621156b60cf94b9e254b441c45c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#aa5de9621156b60cf94b9e254b441c45c">ReportProgress</a> (<a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter, int i, int max_i)</td></tr>
<tr class="memdesc:aa5de9621156b60cf94b9e254b441c45c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. <a href="#aa5de9621156b60cf94b9e254b441c45c">More...</a><br /></td></tr>
<tr class="separator:aa5de9621156b60cf94b9e254b441c45c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2085229a43ee82b28179423b87d2a6d7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#a2085229a43ee82b28179423b87d2a6d7">ReportProgress</a> (<a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *progress_reporter, unsigned int i, unsigned int max_i)</td></tr>
<tr class="memdesc:a2085229a43ee82b28179423b87d2a6d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. <a href="#a2085229a43ee82b28179423b87d2a6d7">More...</a><br /></td></tr>
<tr class="separator:a2085229a43ee82b28179423b87d2a6d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8f262c3526a41ec2be515435b9e4cbec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f262c3526a41ec2be515435b9e4cbec">&#9670;&nbsp;</a></span>ON_ProgressReporter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_ProgressReporter::ON_ProgressReporter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aad7920048a1d2c5f6894824c81edbf98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad7920048a1d2c5f6894824c81edbf98">&#9670;&nbsp;</a></span>~ON_ProgressReporter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_ProgressReporter::~ON_ProgressReporter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6020b6202bcd94a27ed458a7404ab81e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6020b6202bcd94a27ed458a7404ab81e">&#9670;&nbsp;</a></span>FractionComplete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static double ON_ProgressReporter::FractionComplete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The calculation may call <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#a6020b6202bcd94a27ed458a7404ab81e" title="The calculation may call ON_ProgressReporter::FractionComplete to get the current fraction completed...">ON_ProgressReporter::FractionComplete</a> to get the current fraction completed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress_reporter</td><td>[in] A pointer to an <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> or null pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ON_UNSET_VALUE is returned when progress_reporter is nullptr. Otherwise, a value between 0.0 and 1.0 is returned where 0.0 indicates the calcuation is beginning and 1.0 indicates the calculation is complete. </dd></dl>
</div>
</div>
<a id="ab9f89acab0ff9a81c3cabb4d7ce5935e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f89acab0ff9a81c3cabb4d7ce5935e">&#9670;&nbsp;</a></span>ReportProgress() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ON_ProgressReporter::ReportProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>fraction_complete</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress_reporter</td><td>[in] A pointer to an <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> or null pointer.</td></tr>
<tr><td class="paramname">fraction_complete</td><td>[in] a value between 0.0 and 1.0 where 0.0 indicates the calcuation is beginning and 1.0 indicates the calculation is complete.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> MyLongCalculation( ..., <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a>* pr, ...)</div><div class="line">{</div><div class="line"> ...</div><div class="line"> <span class="keywordflow">for</span> ( i = 0; i &lt; count; i++ )</div><div class="line"> {</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,i/((<span class="keywordtype">double</span>)count));</div><div class="line"> ...</div><div class="line"> }</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,1.0); <span class="comment">// finished</span></div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="aa5de9621156b60cf94b9e254b441c45c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5de9621156b60cf94b9e254b441c45c">&#9670;&nbsp;</a></span>ReportProgress() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ON_ProgressReporter::ReportProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_i</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress_reporter</td><td>[in] A pointer to an <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> or null pointer.</td></tr>
<tr><td class="paramname">fraction_complete</td><td>[in] a value between 0.0 and 1.0 where 0.0 indicates the calcuation is beginning and 1.0 indicates the calculation is complete.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> MyLongCalculation( ..., <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a>* pr, ...)</div><div class="line">{</div><div class="line"> ...</div><div class="line"> <span class="keywordflow">for</span> ( i = 0; i &lt; count; i++ )</div><div class="line"> {</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,i,count);</div><div class="line"> ...</div><div class="line"> }</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,1.0); <span class="comment">// finished</span></div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a2085229a43ee82b28179423b87d2a6d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2085229a43ee82b28179423b87d2a6d7">&#9670;&nbsp;</a></span>ReportProgress() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ON_ProgressReporter::ReportProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> *&#160;</td>
<td class="paramname"><em>progress_reporter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>max_i</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The caclulation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ON_ProgressReporter::ReportProgress</a> to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">progress_reporter</td><td>[in] A pointer to an <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> or null pointer.</td></tr>
<tr><td class="paramname">fraction_complete</td><td>[in] a value between 0.0 and 1.0 where 0.0 indicates the calcuation is beginning and 1.0 indicates the calculation is complete.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> MyLongCalculation( ..., <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a>* pr, ...)</div><div class="line">{</div><div class="line"> ...</div><div class="line"> <span class="keywordflow">for</span> ( i = 0; i &lt; count; i++ )</div><div class="line"> {</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,i,count);</div><div class="line"> ...</div><div class="line"> }</div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e">ON_ProgressReporter::ReportProgress</a>(pr,1.0); <span class="comment">// finished</span></div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="ae121a10fbcd1d3f17b8ce169d0384d6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae121a10fbcd1d3f17b8ce169d0384d6d">&#9670;&nbsp;</a></span>SetSynchronousProgressCallbackFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_ProgressReporter::SetSynchronousProgressCallbackFunction </td>
<td>(</td>
<td class="paramtype">void(*)(ON__UINT_PTR context, double fraction_complete)&#160;</td>
<td class="paramname"><em>callback_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ON__UINT_PTR&#160;</td>
<td class="paramname"><em>callback_context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the function that is called when a calculation calls <a class="el" href="../../d8/d13/class_o_n___progress_reporter.html#ab9f89acab0ff9a81c3cabb4d7ce5935e" title="The caclulation calls ON_ProgressReporter::ReportProgress to report its current progress. If it is the first call to ReportProgress, or the faction_complete is 1.0, or the fraction_complete has increased a reasonable amount, then the callback function is called. ">ReportProgress()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback_function</td><td>[in]<ul>
<li>This function is called when the calculation reports progress.</li>
<li>The calculation thread calls in this callback function.</li>
<li>The callback function should do something that is fast and simple, like post a message to a user interface control and return immediately. Paramters passed to the callback function:</li>
</ul>
</td></tr>
<tr><td class="paramname">context</td><td>[in] the value of callback_context.</td></tr>
<tr><td class="paramname">fraction_complete</td><td>[in] A value between 0.0 and 1.0 indicating how much of the calculation is compete.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line">@verbatim</div><div class="line"> <span class="keyword">struct </span>MyWindowsMessage</div><div class="line"> {</div><div class="line"> HWND m_hWnd;</div><div class="line"> UINT m_Msg,</div><div class="line"> WPARAM m_wParam</div><div class="line"> };</div><div class="line"></div><div class="line"> ...</div><div class="line"></div><div class="line"> <span class="keywordtype">void</span> MyProgressCallback(</div><div class="line"> ON__UINT_PTR context,</div><div class="line"> <span class="keywordtype">double</span> fraction_complete</div><div class="line"> )</div><div class="line"> {</div><div class="line"> <span class="keywordflow">if</span> ( 0 != context )</div><div class="line"> {</div><div class="line"> MyWindowsMessage* msg = (MyWindowsMessage*)context;</div><div class="line"> LPARAM lParam = (UINT)ceil(100.0*fraction_complete); <span class="comment">// 0 to 100.</span></div><div class="line"> PostWindowsMessage(msg.m_hWnd,msg.m_Msg,msg.m_wParam,lParam);</div><div class="line"> }</div><div class="line"> }</div><div class="line"></div><div class="line"> ...</div><div class="line"></div><div class="line"> <span class="keyword">struct </span>MyWindowsMessage my_msg;</div><div class="line"> my_msg.m_hWnd = my progress bar window</div><div class="line"> my_msg.m_Msg = RegisterWindowMessage(L<span class="stringliteral">&quot;MyProgressBarWindowsMessage&quot;</span>);</div><div class="line"> my_msg.m_wParam = ...;</div><div class="line"></div><div class="line"> <a class="code" href="../../d8/d13/class_o_n___progress_reporter.html">ON_ProgressReporter</a> pr;</div><div class="line"> pr.<a class="code" href="../../d8/d13/class_o_n___progress_reporter.html#ae121a10fbcd1d3f17b8ce169d0384d6d">SetSynchronousProgressCallbackFunction</a>(MyProgressCallback,&amp;my_msg);</div><div class="line"> ...</div><div class="line"> Pass &amp;pr to a calculation <span class="keyword">function</span>. The calcuation will generally be running</div><div class="line"> in a different thread or allowing Windows messages to be pumped.</div><div class="line">@endverbatim</div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
</div> <!-- page-content -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 3 2018 11:08:32 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13
</small></address>
</div> <!-- container -->
<!-- doxy-boot -->
<script type="text/javascript" src="../../doxy-boot.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink