mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-31 08:06:54 +08:00
Publish!
Generated from TESTING
This commit is contained in:
349
6/class_o_n___function_list.html
Normal file
349
6/class_o_n___function_list.html
Normal file
@@ -0,0 +1,349 @@
|
||||
<!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.14"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>openNURBS SDK Help: ON_FunctionList 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" />
|
||||
</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 style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">openNURBS SDK Help
|
||||
 <span id="projectnumber">6.0</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.14 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
$(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">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_o_n___function_list-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">ON_FunctionList Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><code>#include <<a class="el" href="opennurbs__function__list_8h_source.html">opennurbs_function_list.h</a>></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:a29cf2947727f8ea3db18e9f511d3dfd8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a29cf2947727f8ea3db18e9f511d3dfd8">ON_FunctionList</a> (size_t function_count_estimate)</td></tr>
|
||||
<tr class="separator:a29cf2947727f8ea3db18e9f511d3dfd8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a51283addbbf29144bdf713928e7515ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a51283addbbf29144bdf713928e7515ba">~ON_FunctionList</a> ()</td></tr>
|
||||
<tr class="separator:a51283addbbf29144bdf713928e7515ba"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad8fcc93fad22a5ce598954628f6b3748"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#ad8fcc93fad22a5ce598954628f6b3748">AddFunction</a> (void(*function)(ON__UINT_PTR), ON__UINT_PTR function_parameter)</td></tr>
|
||||
<tr class="separator:ad8fcc93fad22a5ce598954628f6b3748"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9ea0e219d3e0ddcd55e5ee110eaa9314"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a9ea0e219d3e0ddcd55e5ee110eaa9314">CallFunctions</a> (bool bFirstToLast)</td></tr>
|
||||
<tr class="separator:a9ea0e219d3e0ddcd55e5ee110eaa9314"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a57f782aa15ec10fd0360f19c08bdbe78"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a57f782aa15ec10fd0360f19c08bdbe78">EmptyList</a> ()</td></tr>
|
||||
<tr class="separator:a57f782aa15ec10fd0360f19c08bdbe78"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8333c35b126146103e1acb40310190f3"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a8333c35b126146103e1acb40310190f3">FunctionCount</a> () const</td></tr>
|
||||
<tr class="separator:a8333c35b126146103e1acb40310190f3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac1addd7f041aab0d4c24f9d35438796c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#ac1addd7f041aab0d4c24f9d35438796c">InUse</a> () const</td></tr>
|
||||
<tr class="separator:ac1addd7f041aab0d4c24f9d35438796c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac55d8d3620cb7214d418f8150e09ddcf"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#ac55d8d3620cb7214d418f8150e09ddcf">IsInList</a> (void(*function)(ON__UINT_PTR), ON__UINT_PTR function_parameter) const</td></tr>
|
||||
<tr class="separator:ac55d8d3620cb7214d418f8150e09ddcf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aea5d8b0473bf5dfaf162f50a77335e73"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#aea5d8b0473bf5dfaf162f50a77335e73">IsInList</a> (void(*function)(ON__UINT_PTR)) const</td></tr>
|
||||
<tr class="separator:aea5d8b0473bf5dfaf162f50a77335e73"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:acbe68600cc9d6a0e2c8222ec032ba08a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#acbe68600cc9d6a0e2c8222ec032ba08a">RemoveFunction</a> (void(*function)(ON__UINT_PTR))</td></tr>
|
||||
<tr class="separator:acbe68600cc9d6a0e2c8222ec032ba08a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9b52c03c1371172feacc16e380018b8d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___function_list.html#a9b52c03c1371172feacc16e380018b8d">RemoveFunction</a> (void(*function)(ON__UINT_PTR), ON__UINT_PTR function_parameter)</td></tr>
|
||||
<tr class="separator:a9b52c03c1371172feacc16e380018b8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><dl class="section rcs"><dt>NoKeywords</dt><dd></dd></dl>
|
||||
<p><br />
|
||||
/ / Copyright (c) 1993-2013 Robert McNeel & Associates. All rights reserved. / OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert / McNeel & Associates. / / THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. / ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF / MERCHANTABILITY ARE HEREBY DISCLAIMED. / <br />
|
||||
/ For complete openNURBS copyright information see <a href="http://www.opennurbs.org">http://www.opennurbs.org</a>. / ////////////////////////////////////////////////////////////// </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="a29cf2947727f8ea3db18e9f511d3dfd8"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a29cf2947727f8ea3db18e9f511d3dfd8">◆ </a></span>ON_FunctionList()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ON_FunctionList::ON_FunctionList </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>function_count_estimate</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Parameters: function_count_estimate - [in] An estimate of the maximum number of functions that will be in the list at any one time. Pass 0 if you don't know. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a51283addbbf29144bdf713928e7515ba"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a51283addbbf29144bdf713928e7515ba">◆ </a></span>~ON_FunctionList()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ON_FunctionList::~ON_FunctionList </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="ad8fcc93fad22a5ce598954628f6b3748"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad8fcc93fad22a5ce598954628f6b3748">◆ </a></span>AddFunction()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::AddFunction </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(ON__UINT_PTR) </td>
|
||||
<td class="paramname"><em>function</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ON__UINT_PTR </td>
|
||||
<td class="paramname"><em>function_parameter</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Description: Unconditionally add a function to the list. Parameters: function - [in] A function that takes a single ON__UINT_PTR parameter. function_parameter - [in] Returns: 0: list in use 1: function added 2: invalid input </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a9ea0e219d3e0ddcd55e5ee110eaa9314"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a9ea0e219d3e0ddcd55e5ee110eaa9314">◆ </a></span>CallFunctions()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool ON_FunctionList::CallFunctions </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>bFirstToLast</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Description: Call all the functions in the function list. Parameters: bFirstToLast - [in] true - function are called in the order added false - functions are called in the reverse order added <br />
|
||||
Returns: True if the functions were called or the list is empty. False if the list is in use. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a57f782aa15ec10fd0360f19c08bdbe78"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a57f782aa15ec10fd0360f19c08bdbe78">◆ </a></span>EmptyList()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool ON_FunctionList::EmptyList </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: 0: list in use 1: list was emptied </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a8333c35b126146103e1acb40310190f3"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a8333c35b126146103e1acb40310190f3">◆ </a></span>FunctionCount()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::FunctionCount </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac1addd7f041aab0d4c24f9d35438796c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac1addd7f041aab0d4c24f9d35438796c">◆ </a></span>InUse()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool ON_FunctionList::InUse </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: True if the list is in use. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac55d8d3620cb7214d418f8150e09ddcf"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac55d8d3620cb7214d418f8150e09ddcf">◆ </a></span>IsInList() <span class="overload">[1/2]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::IsInList </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(ON__UINT_PTR) </td>
|
||||
<td class="paramname"><em>function</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ON__UINT_PTR </td>
|
||||
<td class="paramname"><em>function_parameter</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: 0: Matching function and parameter are not in the list. 1: Matching function and parameter are in the list. 2: list in use </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aea5d8b0473bf5dfaf162f50a77335e73"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aea5d8b0473bf5dfaf162f50a77335e73">◆ </a></span>IsInList() <span class="overload">[2/2]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::IsInList </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(ON__UINT_PTR) </td>
|
||||
<td class="paramname"><em>function</em></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: 0: list in use 1: Matching function is in the list. 2: Matching function is not in the list. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="acbe68600cc9d6a0e2c8222ec032ba08a"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#acbe68600cc9d6a0e2c8222ec032ba08a">◆ </a></span>RemoveFunction() <span class="overload">[1/2]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::RemoveFunction </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(ON__UINT_PTR) </td>
|
||||
<td class="paramname"><em>function</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: 0: list in use 1: function removed 2: matching function not in the list </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a9b52c03c1371172feacc16e380018b8d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a9b52c03c1371172feacc16e380018b8d">◆ </a></span>RemoveFunction() <span class="overload">[2/2]</span></h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">unsigned int ON_FunctionList::RemoveFunction </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(ON__UINT_PTR) </td>
|
||||
<td class="paramname"><em>function</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ON__UINT_PTR </td>
|
||||
<td class="paramname"><em>function_parameter</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns: 0: list in use 1: function removed 2: matching function not in the list </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Thu Jan 25 2018 17:01:10 for openNURBS SDK Help by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.14
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user