mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
85 lines
21 KiB
HTML
85 lines
21 KiB
HTML
<!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: /Users/will/dev/github/mcneel/rhino/src4/bin/opennurbs_public/opennurbs_function_list.h Source File</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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">opennurbs_function_list.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (c) 1993-2013 Robert McNeel & Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// McNeel & Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// For complete openNURBS copyright information see <http://www.opennurbs.org>.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#if !defined(OPENNURBS_FUNCTION_LIST_INC_)</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define OPENNURBS_FUNCTION_LIST_INC_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="class_o_n___function_list.html"> 21</a></span> <span class="keyword">class </span>ON_CLASS <a class="code" href="class_o_n___function_list.html">ON_FunctionList</a></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">/*</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> function_count_estimate - [in]</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> An estimate of the maximum number of functions that will</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> be in the list at any one time. Pass 0 if you don't know.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="class_o_n___function_list.html">ON_FunctionList</a>(</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">size_t</span> function_count_estimate</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  );</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  ~<a class="code" href="class_o_n___function_list.html">ON_FunctionList</a>();</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">/*</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> Unconditionally add a function to the list.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> function - [in]</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> A function that takes a single ON__UINT_PTR parameter.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> function_parameter - [in]</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> 0: list in use</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> 1: function added</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> 2: invalid input</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> AddFunction(</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> (*<span class="keyword">function</span>)(ON__UINT_PTR),</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  ON__UINT_PTR function_parameter</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  );</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">/*</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> 0: list in use</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> 1: function removed</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> 2: matching function not in the list</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RemoveFunction(</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> (*<span class="keyword">function</span>)(ON__UINT_PTR)</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  );</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">/*</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> 0: list in use</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> 1: function removed</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> 2: matching function not in the list</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RemoveFunction(</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> (*<span class="keyword">function</span>)(ON__UINT_PTR),</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ON__UINT_PTR function_parameter</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  );</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">/*</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> 0: Matching function and parameter are not in the list.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> 1: Matching function and parameter are in the list.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> 2: list in use</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> IsInList(</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> (*<span class="keyword">function</span>)(ON__UINT_PTR),</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  ON__UINT_PTR function_parameter</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">/*</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> 0: list in use</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> 1: Matching function is in the list.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> 2: Matching function is not in the list.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> IsInList(</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">void</span> (*<span class="keyword">function</span>)(ON__UINT_PTR)</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">/*</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> 0: list in use</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> 1: list was emptied</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> EmptyList();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">/*</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> Call all the functions in the function list.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> bFirstToLast - [in]</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> true - function are called in the order added</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> false - functions are called in the reverse order added </span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> True if the functions were called or the list is empty.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> False if the list is in use.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> CallFunctions(</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">bool</span> bFirstToLast</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  );</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">/*</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> True if the list is in use.</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">bool</span> InUse() <span class="keyword">const</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FunctionCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="class_o_n___fixed_size_pool.html">ON_FixedSizePool</a> m_fsp;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">void</span>* m_head = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span>* m_tail = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">mutable</span> <a class="code" href="class_o_n___lock.html">ON_Lock</a> m_lock;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_o_n___lock_html"><div class="ttname"><a href="class_o_n___lock.html">ON_Lock</a></div><div class="ttdef"><b>Definition:</b> opennurbs_lock.h:25</div></div>
|
|
<div class="ttc" id="class_o_n___fixed_size_pool_html"><div class="ttname"><a href="class_o_n___fixed_size_pool.html">ON_FixedSizePool</a></div><div class="ttdef"><b>Definition:</b> opennurbs_fsp.h:19</div></div>
|
|
<div class="ttc" id="class_o_n___function_list_html"><div class="ttname"><a href="class_o_n___function_list.html">ON_FunctionList</a></div><div class="ttdef"><b>Definition:</b> opennurbs_function_list.h:21</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jan 25 2018 17:01:08 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>
|