mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
99 lines
180 KiB
HTML
99 lines
180 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_object.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
|
|
</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_object.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-2012 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> <span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span><span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// virtual base class for all openNURBS objects</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#if !defined(OPENNURBS_OBJECT_INC_)</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define OPENNURBS_OBJECT_INC_</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span><a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>; <span class="comment">// used for runtime class identification</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></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> <span class="comment"></span><span class="comment">//</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/*</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> OpenNURBS classes derived from ON_Object use ON_ClassId to</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> store run-time type information </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"> The ON_OBJECT_DECLARE and ON_OBJECT_IMPLEMENT macros generate</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> the code that creates and initializes the ON_ClassId for each</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> class.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> The ON_Object::IsKindOf() and ON_Object::Cast() functions</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> use this run-time type information.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">*/</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="../../d3/d3c/class_o_n___class_id.html"> 44</a></span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Description:</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// This constructor is called to initialize each class id.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// The call is generated by the ON_OBJECT_IMPLEMENT macro.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">//</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// sClassName - [in] name of the class (like ON_Geometry)</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// sBaseClassName - [in] name of baseclass (like ON_Object)</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// create - [in] function to create a new object(like CreateNewON_Geometry())</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// sUUID - [in] UUID in registry format from Windows guidgen.exe</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>( </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sClassName,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sBaseClassName,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">class</span> <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>* (*create)(),</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sUUID</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> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ~<a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// Description: </span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Gets a class's ON_ClassId from the class's name.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// sClassName - [in] name of class</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Returns: </span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// Pointer to the class's ON_ClassId.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// Example:</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// const ON_ClassId* brep_id = ON_CLassId::ClassId("ON_Brep");</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ClassId( </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sClassName</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  );</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// Description: </span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Gets a class's ON_ClassId from the class's uuid.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// class_uuid - [in] uuid for the class</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Returns: </span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Pointer to the class's ON_ClassId.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// Example:</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// ON_UUID brep_uuid = ON_UuidFromString("60B5DBC5-E660-11d3-BFE4-0010830122F0");</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// const ON_ClassId* brep_id = ON_ClassId::ClassId(brep_uuid);</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ClassId( </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> class_uuid</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  );</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// Description:</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// Each class derived from ON_Object has a corresponding ON_ClassId</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// stored in a linked list and the class is marked with an integer</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// value. ON_ClassId::IncrementMark() increments the value used to</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// mark new classes and returns the new marking value.</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">// Value that will be used to mark all future ON_ClassIds.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> IncrementMark();</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> CurrentMark();</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* LastClassId();</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">// Description:</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// Each class derived from ON_Object has a corresponding</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">// ON_ClassId stored in a linked list. If a class definition</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// is going to disappear (which happens when the derived object</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// definition is in a DLL that uses openNURBS as a DLL and the </span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// DLL containing the derived object's definition is unloaded),</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// then the class's ON_ClassId needs to be removed from the class </span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// list. ON_ClassId::Purge( mark ) removes all ON_ClassIds with a</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// a prescribed mark and returns the number of classes that</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// were purged. </span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// mark - [in] All ON_ClassIds with this mark will be purged.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// Number of classes that were purged.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// Example:</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// // Call ON_ClassId::IncrementMark() BEFORE loading MY.DLL.</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="comment">// int my_dll_classid_mark = ON_ClassId::IncrementMark();</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="comment">// load MY.DLL with classes derived from ON_Object</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="comment">// // Call ON_ClassId::Purge() BEFORE unloading MY.DLL.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="comment">// ON_ClassId::Purge( my_dll_classid_mark );</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">// unload MY.DLL</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> Purge(<span class="keywordtype">int</span> mark);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> PurgeAfter(<span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* pClassId);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// Description:</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// Dumps the ON_ClassId list</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// dump - [in] destination for the text dump.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> Dump( </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>& dump</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  );</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">// class name</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* ClassName() <span class="keyword">const</span>;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// base class name</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* BaseClassName() <span class="keyword">const</span>;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// base class id</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* BaseClass() <span class="keyword">const</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// Description:</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// Determine if the class associated with this ON_ClassId</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// is derived from another class.</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// Parameters:</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// potential_parent - [in] Class to test as parent.</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">// true if this is derived from potential_parent.</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">bool</span> IsDerivedFrom( </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* potential_parent</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// Descrption:</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// Use the default constructor to create an instance of the</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// class on the heap.</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="comment">// Null or a pointer to an instance of the class created</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// using new and the class's default constructor.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>* Create() <span class="keyword">const</span>;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">// Returns:</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// class uuid</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> Uuid() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment">/*</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> Opennurbs classes have a mark value of 0. Core Rhino</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> classes have a mark value of 1. Rhino plug-in classes</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> have a mark value of > 1.</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> Class mark value</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">int</span> Mark() <span class="keyword">const</span>;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ClassIdVersion() <span class="keyword">const</span>;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">static</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* m_p0; <span class="comment">// first id in the linked list of class ids</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keyword">static</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* m_p1; <span class="comment">// last id in the linked list of class ids</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> m_mark0; <span class="comment">// current mark value</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* m_pNext; <span class="comment">// next in the linked list of class ids</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* m_pBaseClassId; <span class="comment">// base class id</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">char</span> m_sClassName[80]; </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordtype">char</span> m_sBaseClassName[80];</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="comment">// m_create points to a function that calls the default constuctor.</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="comment">// m_create() is used to create classes from uuids when reading files.</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>* (*m_create)(); </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> m_uuid;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">int</span> m_mark; <span class="comment">// bit 0x80000000 is used to indicate new extensions</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="comment">// There are no implementaions of the default constructor, copy constructor</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="comment">// or operator=() to prohibit use.</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>();</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>( <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>&);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>& operator=( <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>&);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">void</span> ConstructorHelper( </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sClassName, </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sBaseClassName, </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* sUUID</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  );</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="comment">// The m_f[] pointers provide a way add a "virtual" function to</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="comment">// a class derived from ON_Object without breaking the SDK.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="comment">// At each SDK breaking relase, any functions that use this</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="comment">// mechanism are made into C++ virtual functions on the appropriate</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="comment">// classes. Currently, none of these are in use.</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_class_id_version; </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordtype">void</span>* m_f1;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">void</span>* m_f2;</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">void</span>* m_f3;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">void</span>* m_f4;</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">void</span>* m_f5;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordtype">void</span>* m_f6;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordtype">void</span>* m_f7;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordtype">void</span>* m_f8;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> };</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/*</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment">Description:</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> ON_CLASS_RTTI is a macro to get the class's run-time type</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> information from class name.</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">Example:</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> // Get the ON_Brep class's run-time type information.</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> const ON_ClassId& brep_rtti = ON_CLASS_RTTI(ON_Brep);</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment">*/</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#define ON_CLASS_RTTI( cls ) cls::m_##cls##_class_rtti</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">/*</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment">Description:</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> ON_CLASS_ID is a macro to get the class's uuid from</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> a class name.</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">Example:</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> // Get the class id for ON_Brep.</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> ON_UUID brep_class_id = ON_CLASS_ID(ON_Brep);</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">*/</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor">#define ON_CLASS_ID( cls ) ON_CLASS_RTTI( cls ).Uuid()</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">/*</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">Description:</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> Expert user function to get the value of ON_ClassId::m_uuid</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> of the last instance of ON_ClassId to call ON_ClassId::Create().</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> This function was created to support Rhino's .NET SDK.</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> This function returns the value of a static id in</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> opennurbs_object.cpp and is NOT thread safe.</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment">Returns:</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> Value of ON_ClassId::m_uuid of the instance of ON_ClassId that</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> most recently called ON_ClassId::Create().</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">*/</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> ON_DECL</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_GetMostRecentClassIdCreateUuid();</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_VIRTUAL</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_OVERRIDE override</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">/*</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment">All classes derived from ON_Object must have the declaration macro</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> ON_OBJECT_DECLARE( <classname> );</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">as the first line in their class definition, must have a robust</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">operator=(), should have a robust copy constructory, and must</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">have exactly one of the following implementation macros in </span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">a .cpp file.</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> Classes with a pure virtual function:</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> ON_VIRTUAL_OBJECT_IMPLEMENT( <classname>, <basclassname>, <classuuid> )</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> Classes with an operator= and copy constructor.</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> ON_OBJECT_IMPLEMENT( <classname>, <basclassname>, <classuuid> )</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> Classes with an operator=, but no copy constructor.</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> ON_OBJECT_IMPLEMENT_NO_COPYCTOR( <classname>, <basclassname>, <classuuid> )</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">*/</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="preprocessor">#define ON_OBJECT_DECLARE( cls ) \</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="preprocessor"> protected: \</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor"> static void* m_s_##cls##_ptr; \</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="preprocessor"> public: \</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="preprocessor"> </span><span class="comment">/* OpenNURBS class run-time type information */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="preprocessor"> static const ON_ClassId m_##cls##_class_rtti; \</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="preprocessor"> </span><span class="comment">/*OpenNURBS platfrom independent dynamic cast*/</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="preprocessor"> static cls * Cast( ON_Object* ); \</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor"> </span><span class="comment">/*OpenNURBS platfrom independent dynamic cast*/</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor"> static const cls * Cast( const ON_Object* ); \</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor"> </span><span class="comment">/*Returns: OpenNURBS run-time type information.*/</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor"> ON_OBJECT_DECLARE_VIRTUAL const ON_ClassId* ClassId() const ON_OBJECT_DECLARE_OVERRIDE; \</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor"> public: \</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="preprocessor"> </span><span class="comment">/*Description: */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="preprocessor"> </span><span class="comment">/* Uses a virtual function to create a deep copy. */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="preprocessor"> </span><span class="comment">/*Returns: */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="preprocessor"> </span><span class="comment">/* null or a deep copy with type this->ClassId(). */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor"> </span><span class="comment">/*See Also: */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="preprocessor"> </span><span class="comment">/* ON_Curve::DuplicateCurve() */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor"> </span><span class="comment">/* ON_Surface::DuplicateSurface() */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="preprocessor"> </span><span class="comment">/* CRhinoObject::DuplicateRhinoObject() */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="preprocessor"> cls * Duplicate() const; \</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="preprocessor"> </span><span class="comment">/*Description: */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="preprocessor"> </span><span class="comment">/* Uses operator= to copy src to this. */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="preprocessor"> </span><span class="comment">/*Returns: */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="preprocessor"> </span><span class="comment">/* True if successful. */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="preprocessor"> </span><span class="comment">/* False if src is null or an incompatible type. */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="preprocessor"> ON_OBJECT_DECLARE_VIRTUAL bool CopyFrom(const ON_Object*) ON_OBJECT_DECLARE_OVERRIDE; \</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="preprocessor"> \</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="preprocessor"> private: \</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="preprocessor"> </span><span class="comment">/* Duplicate() uses this virtual helper function. */</span><span class="preprocessor"> \</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="preprocessor"> ON_OBJECT_DECLARE_VIRTUAL ON_Object* Internal_DeepCopy() const ON_OBJECT_DECLARE_OVERRIDE \</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="preprocessor"> </span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment">/*</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment">Classes derived from ON_Object that are pure virtual classes,</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment">or do not have a valid default constructor, valid operator new</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment">or valid operator= must use ON_VIRTUAL_OBJECT_IMPLEMENT in their</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">implementation. Classes implemented with ON_VIRTUAL_OBJECT_IMPLEMENT</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment">cannot be serialized using ON_BinaryArchive::ReadObject()/WriteObject()</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment">or duplicated using ON_Object::Duplicate().</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment">The Cast() and ClassId() members work on classes implemented with</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">ON_VIRTUAL_OBJECT_IMPLEMENT, ON_OBJECT_IMPLEMENT or</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment">ON_OBJECT_IMPLEMENT_NO_COPYCTOR</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">*/</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#define ON_VIRTUAL_OBJECT_IMPLEMENT( cls, basecls, uuid ) \</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor"> void* cls::m_s_##cls##_ptr = nullptr; \</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor"> const ON_ClassId cls::m_##cls##_class_rtti(#cls,#basecls,0,uuid);\</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="preprocessor"> cls * cls::Cast( ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast< cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="preprocessor"> const cls * cls::Cast( const ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast<const cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor"> const ON_ClassId* cls::ClassId() const {return &cls::m_##cls##_class_rtti;} \</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="preprocessor"> bool cls::CopyFrom(const ON_Object*) {return false;} \</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor"> cls * cls::Duplicate() const {return static_cast< cls *>(this->Internal_DeepCopy());} \</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor"> ON_Object* cls::Internal_DeepCopy() const {return nullptr;}</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> </div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment">/*</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment">Classes derived from ON_Object that have a valid default constructor,</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment">valid copy constructor, operator new and operator= can use</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment">ON_OBJECT_IMPLEMENT in their implementation. Classes implemented</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment">with ON_OBJECT_IMPLEMENT can be created from their run-time type</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment">information id and their Duplicate() function will use the class's</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment">copy constructor to create a deep copy.</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">*/</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor">#define ON_OBJECT_IMPLEMENT( cls, basecls, uuid ) \</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="preprocessor"> void* cls::m_s_##cls##_ptr = nullptr; \</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor"> static ON_Object* CreateNew##cls() {return new cls();} \</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor"> const ON_ClassId cls::m_##cls##_class_rtti(#cls,#basecls,CreateNew##cls,uuid);\</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="preprocessor"> cls * cls::Cast( ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast< cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor"> const cls * cls::Cast( const ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast<const cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="preprocessor"> const ON_ClassId* cls::ClassId() const {return &cls::m_##cls##_class_rtti;} \</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor"> bool cls::CopyFrom( const ON_Object* src){const cls * s=cls::Cast(src); if ( nullptr != this && nullptr != s) {*this = *s; return true;}return false;} \</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="preprocessor"> cls * cls::Duplicate() const {return static_cast< cls *>(this->Internal_DeepCopy());} \</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="preprocessor"> ON_Object* cls::Internal_DeepCopy() const {return new cls (*this);}</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> </div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment">/*</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment">Classes derived from ON_Object that have a valid default constructor,</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment">operator new and operator=, but do not have a valid copy constructor,</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment">can use ON_OBJECT_IMPLEMENT_NO_COPYCTOR in their implementation.</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment">Classes implemented with ON_OBJECT_IMPLEMENT_NO_COPYCTOR can be created </span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment">from their run-time type information id and their Duplicate() function</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment">will use the class's default constructor and operator= to create a</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment">deep copy.</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment">*/</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor">#define ON_OBJECT_IMPLEMENT_NO_COPYCTOR( cls, basecls, uuid ) \</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="preprocessor"> void* cls::m_s_##cls##_ptr = nullptr; \</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="preprocessor"> static ON_Object* CreateNew##cls() {return new cls();} \</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="preprocessor"> const ON_ClassId cls::m_##cls##_class_rtti(#cls,#basecls,CreateNew##cls,uuid);\</span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="preprocessor"> cls * cls::Cast( ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast< cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="preprocessor"> const cls * cls::Cast( const ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast<const cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="preprocessor"> const ON_ClassId* cls::ClassId() const {return &cls::m_##cls##_class_rtti;} \</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="preprocessor"> bool cls::CopyFrom( const ON_Object* src){const cls* s=cls::Cast(src); if ( 0 != this && 0 != s) {*this = *s; return true;}return false;} \</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="preprocessor"> cls * cls::Duplicate() const {return static_cast< cls *>(this->Internal_DeepCopy());} \</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="preprocessor"> ON_Object* cls::Internal_DeepCopy() const { cls* p = new cls();if (p) {*p = *this; return p;}return nullptr;}</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> </div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment">/*</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment">Classes derived from ON_Object that have a valid default constructor,</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment">operator new and operator=, but do not have a valid copy constructor or assignment operator,</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment">can use ON_OBJECT_IMPLEMENT_NO_COPY in their implementation.</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment">Classes implemented with ON_OBJECT_IMPLEMENT_NO_COPY can be created</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment">from their run-time type information id and their Duplicate() function</span></div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment">will silently return a nullptr. CopyFrom will return false.</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment">*/</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="preprocessor">#define ON_OBJECT_IMPLEMENT_NO_COPY( cls, basecls, uuid ) \</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor"> void* cls::m_s_##cls##_ptr = nullptr; \</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="preprocessor"> static ON_Object* CreateNew##cls() {return new cls();} \</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor"> const ON_ClassId cls::m_##cls##_class_rtti(#cls,#basecls,CreateNew##cls,uuid);\</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"> cls * cls::Cast( ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast< cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="preprocessor"> const cls * cls::Cast( const ON_Object* p) {return(p&&p->IsKindOf(&cls::m_##cls##_class_rtti))?static_cast<const cls *>(p):nullptr;} \</span></div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="preprocessor"> const ON_ClassId* cls::ClassId() const {return &cls::m_##cls##_class_rtti;} \</span></div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor"> bool cls::CopyFrom( const ON_Object* src){return false;} \</span></div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="preprocessor"> cls * cls::Duplicate() const {return nullptr;} \</span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="preprocessor"> ON_Object* cls::Internal_DeepCopy() const { return nullptr;}</span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span> </div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="preprocessor">#define ON__SET__THIS__PTR(ptr) if (ptr) *((void**)this) = ptr</span></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span> </div><div class="line"><a name="l00399"></a><span class="lineno"><a class="line" href="../../d0/d82/class_o_n___user_string.html"> 399</a></span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d0/d82/class_o_n___user_string.html">ON_UserString</a></div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> {</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <a class="code" href="../../d0/d82/class_o_n___user_string.html">ON_UserString</a>();</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  ~<a class="code" href="../../d0/d82/class_o_n___user_string.html">ON_UserString</a>();</div><div class="line"><a name="l00404"></a><span class="lineno"><a class="line" href="../../d0/d82/class_o_n___user_string.html#ae31832d3326d65e5236caeb291eb5c06"> 404</a></span>  <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> <a class="code" href="../../d0/d82/class_o_n___user_string.html#ae31832d3326d65e5236caeb291eb5c06">m_key</a>;</div><div class="line"><a name="l00405"></a><span class="lineno"><a class="line" href="../../d0/d82/class_o_n___user_string.html#a058be62bac0ef2619c40a8d85a9ea89c"> 405</a></span>  <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> <a class="code" href="../../d0/d82/class_o_n___user_string.html#a058be62bac0ef2619c40a8d85a9ea89c">m_string_value</a>;</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> </div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  <span class="keywordtype">void</span> Dump(<a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>& text_log) <span class="keyword">const</span>;</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  <span class="keywordtype">bool</span> Write(<a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&) <span class="keyword">const</span>;</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  <span class="keywordtype">bool</span> Read(<a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&);</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> };</div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span> </div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="preprocessor">#if defined(ON_DLL_TEMPLATE)</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span> ON_DLL_TEMPLATE <span class="keyword">template</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../dd/d40/class_o_n___class_array.html">ON_ClassArray<ON_UserString></a>;</div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> </div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment">/*</span></div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment">Description:</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> When ON_Object::IsValid() fails and returns false, ON_IsNotValid()</span></div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> is called. This way, a developer can put a breakpoint in</span></div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> ON_IsNotValid() and stop execution at the exact place IsValid()</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> fails.</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment">Returns:</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> false;</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">*/</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span> ON_DECL</div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="keywordtype">bool</span> ON_IsNotValid();</div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"></span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"></span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment">// Description:</span></div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment">// Pure virtual base class for all classes that must provide</span></div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">// runtime class id or support object level 3DM serialization</span></div><div class="line"><a name="l00433"></a><span class="lineno"><a class="line" href="../../d9/d7b/class_o_n___object.html"> 433</a></span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a></div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span> {</div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="preprocessor">#undef ON_OBJECT_DECLARE_VIRTUAL</span></div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="preprocessor">#undef ON_OBJECT_DECLARE_OVERRIDE</span></div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_VIRTUAL virtual</span></div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_OVERRIDE</span></div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  <span class="comment">// This is the base class</span></div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  ON_OBJECT_DECLARE(<a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>);</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  <span class="comment">// Every other use of ON_OBJECT_DECLARE() is in derived class</span></div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="preprocessor">#undef ON_OBJECT_DECLARE_VIRTUAL</span></div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor">#undef ON_OBJECT_DECLARE_OVERRIDE</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_VIRTUAL</span></div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="preprocessor">#define ON_OBJECT_DECLARE_OVERRIDE override</span></div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span> </div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>() ON_NOEXCEPT;</div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>();</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>( <span class="keyword">const</span> <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& );</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& operator=( <span class="keyword">const</span> <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& );</div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span> </div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor">#if defined(ON_HAS_RVALUEREF)</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  <span class="comment">// rvalue copy constructor</span></div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>( <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>&& ) ON_NOEXCEPT;</div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span> </div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  <span class="comment">// The rvalue assignment operator calls this->PurgeUserData()</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="comment">// which calls unknown destructors that could throw exceptions.</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& operator=( <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>&& );</div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> </div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span> </div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span> </div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span> </div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span> </div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  <span class="comment">/*</span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> Sets m_user_data_list = 0.</span></div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> */</span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keywordtype">void</span> EmergencyDestroy();</div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span> </div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  <span class="comment">/*</span></div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> The MemoryRelocate() function is called when an </span></div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> object's location in memory is changed. For </span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> example, if an object resides in a chunk of </span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> memory that is grown by calling a realloc</span></div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> that has to allocate a new chunk and</span></div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> copy the contents of the old chunk to the</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> new chunk, then the location of the object's</span></div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> memory changes. In practice this happens when</span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> classes derived from ON_Object are stored</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> in dynamic arrays, like the default implementation</span></div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> of ON_ObjectArray<>'s that use realloc to grow</span></div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> the dynamic array.</span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> */</span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="keyword">virtual</span> </div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordtype">void</span> MemoryRelocate();</div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span> </div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="comment">/*</span></div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> Low level tool to test if an object is derived</span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> from a specified class.</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> pClassId - [in] use classname::ClassId()</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> true if the instantiated object is derived from the</span></div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> class whose id is passed as the argument.</span></div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> Example:</span></div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"></span></div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> ON_Object* p = ....;</span></div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> if ( p->IsKindOf( ON_NurbsCurve::ClassId() ) )</span></div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> {</span></div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> it's a NURBS curve</span></div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> }</span></div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"></span></div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> The primary reason for IsKindOf() is to support the</span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> static Cast() members declared in the ON_OBJECT_DECLARE</span></div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> macro. If we determine that dynamic_cast is properly </span></div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> supported and implemented by all supported compilers, </span></div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> then IsKindOf() may dissappear. If an application needs</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> to determine if a pointer points to a class derived from</span></div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> ON_SomeClassName, then call </span></div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> ON_SomeClassName::Cast(mystery pointer) and check for </span></div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> a non-null return.</span></div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> */</span></div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  <span class="keywordtype">bool</span> IsKindOf( </div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="keyword">const</span> <a class="code" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* pClassId</div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span> </div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <span class="comment">/*</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> Tests an object to see if its data members are correctly</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> initialized.</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> text_log - [in] if the object is not valid and text_log</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> is not nullptr, then a brief englis description of the</span></div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> reason the object is not valid is appened to the log.</span></div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> The information appended to text_log is suitable for </span></div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> low-level debugging purposes by programmers and is </span></div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> not intended to be useful as a high level user </span></div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> interface tool.</span></div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> @untitled table</span></div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> true object is valid</span></div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> false object is invalid, uninitialized, etc.</span></div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> */</span></div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsValid( <span class="keyword">class</span> <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>* text_log = <span class="keyword">nullptr</span> ) <span class="keyword">const</span>;</div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span> </div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  <span class="comment">/*</span></div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> Creates a text dump of the object.</span></div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> Dump() is intended for debugging and is not suitable</span></div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> for creating high quality text descriptions of an</span></div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> object.</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"></span></div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> The default implementations of this virtual function </span></div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> prints the class's name.</span></div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> */</span></div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  <span class="keywordtype">void</span> Dump( <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>& ) <span class="keyword">const</span>;</div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span> </div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  <span class="comment">/*</span></div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> An estimate of the amount of memory the class uses in bytes.</span></div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> */</span></div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SizeOf() <span class="keyword">const</span>;</div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span> </div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  <span class="comment">/*</span></div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> Returns a CRC calculated from the information that defines</span></div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> the object. This CRC can be used as a quick way to see</span></div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"> if two objects are not identical.</span></div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> current_remainder - [in];</span></div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> CRC of the information the defines the object.</span></div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> */</span></div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  ON__UINT32 DataCRC(ON__UINT32 current_remainder) <span class="keyword">const</span>;</div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span> </div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  <span class="comment">/*</span></div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> Low level archive writing tool used by ON_BinaryArchive::WriteObject().</span></div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> binary_archive - archive to write to</span></div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> Returns true if the write is successful.</span></div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> Use ON_BinaryArchive::WriteObject() to write objects.</span></div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> This Write() function should just write the specific definition of</span></div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> this object. It should not write and any chunk typecode or length</span></div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> information. </span></div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"></span></div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment"> The default implementation of this virtual function returns </span></div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment"> false and does nothing.</span></div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> */</span></div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span>  <span class="keywordtype">bool</span> Write(</div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>& binary_archive</div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span> </div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  <span class="comment">/*</span></div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> Low level archive writing tool used by ON_BinaryArchive::ReadObject().</span></div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"> binary_archive - archive to read from</span></div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> Returns true if the read is successful.</span></div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> Use ON_BinaryArchive::ReadObject() to read objects.</span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> This Read() function should read the objects definition back into</span></div><div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> its data members.</span></div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"></span></div><div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> The default implementation of this virtual function returns </span></div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> false and does nothing.</span></div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> */</span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  <span class="keywordtype">bool</span> Read(</div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span>  <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>& binary_archive</div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span>  );</div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span> </div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span>  <span class="comment">/*</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> Useful for switch statements that need to differentiate</span></div><div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> between basic object types like points, curves, surfaces,</span></div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> and so on.</span></div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"></span></div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> Returns: </span></div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> ON::object_type enum value.</span></div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"></span></div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> The default implementation of this virtual function returns</span></div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> ON::unknown_object_type</span></div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> */</span></div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  ON::object_type ObjectType() <span class="keyword">const</span>;</div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span> </div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span> </div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span> </div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  <span class="comment">/*</span></div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> All objects in an opennurbs model have an id</span></div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> ( ON_Layer.m_layer_id, ON_Font.m_font_id, </span></div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> ON_Material.m_material_id, ON_3dmObjectAttributes.m_uuid</span></div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> ).</span></div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> The id used to identify the object in the openurbs model.</span></div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> */</span></div><div class="line"><a name="l00644"></a><span class="lineno"> 644</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ModelObjectId() <span class="keyword">const</span>;</div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"></span></div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> //////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  <span class="comment">// BEGIN: User string support</span></div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span>  <span class="comment">//</span></div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span> </div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span>  <span class="comment">/*</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> Attach a user string to the object. This information will</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> perisist through copy construction, operator=, and file IO.</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> key - [in] id used to retrieve this string.</span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> string_value - [in] </span></div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> If nullptr, the string with this id will be removed.</span></div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> True if successful.</span></div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> */</span></div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span>  <span class="keywordtype">bool</span> SetUserString( </div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span>  <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* key, </div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span>  <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* string_value </div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span>  );</div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span> </div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span>  <span class="comment">/*</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> Append entries to the user string list</span></div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> count - [in]</span></div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> number of element in us[] array</span></div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> user_strings - [in]</span></div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> entries to append.</span></div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> bReplace - [in]</span></div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> If bReplace is true, then existing entries with the same key are</span></div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> updated with the new entry's value. If bReplace is false, then</span></div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"> existing entries are not updated.</span></div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment"> Number of entries added, deleted, or modified.</span></div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment"> */</span></div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span>  <span class="keywordtype">int</span> SetUserStrings( <span class="keywordtype">int</span> count, <span class="keyword">const</span> <a class="code" href="../../d0/d82/class_o_n___user_string.html">ON_UserString</a>* user_strings, <span class="keywordtype">bool</span> bReplace );</div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span> </div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span>  <span class="comment">/*</span></div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> Get user string from the object.</span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> key - [in] id used to retrieve the string.</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> string_value - [out]</span></div><div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> True if a string with id was found.</span></div><div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> */</span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span>  <span class="keywordtype">bool</span> GetUserString( </div><div class="line"><a name="l00695"></a><span class="lineno"> 695</span>  <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* key, </div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span>  <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>& string_value </div><div class="line"><a name="l00697"></a><span class="lineno"> 697</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span> </div><div class="line"><a name="l00699"></a><span class="lineno"> 699</span>  <span class="comment">/*</span></div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> Get a list of all user strings on the object.</span></div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"> user_strings - [out]</span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> user strings are appended to this list.</span></div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> Number of elements appended to the user_strings list.</span></div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> */</span></div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span>  <span class="keywordtype">int</span> GetUserStrings( </div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span>  <a class="code" href="../../dd/d40/class_o_n___class_array.html">ON_ClassArray<ON_UserString></a>& user_strings </div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span> </div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span>  <span class="comment">/*</span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> Get a list of all user string keys on the object.</span></div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"> user_string_keys - [out]</span></div><div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment"> user string keys are appended to this list.</span></div><div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"> Number of elements appended to the user_strings list.</span></div><div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> */</span></div><div class="line"><a name="l00721"></a><span class="lineno"> 721</span>  <span class="keywordtype">int</span> GetUserStringKeys( </div><div class="line"><a name="l00722"></a><span class="lineno"> 722</span>  <a class="code" href="../../dd/d40/class_o_n___class_array.html">ON_ClassArray<ON_wString></a>& user_string_keys </div><div class="line"><a name="l00723"></a><span class="lineno"> 723</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00724"></a><span class="lineno"> 724</span> </div><div class="line"><a name="l00725"></a><span class="lineno"> 725</span>  <span class="comment">/*</span></div><div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> Number of user strings on the object.</span></div><div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> */</span></div><div class="line"><a name="l00729"></a><span class="lineno"> 729</span>  <span class="keywordtype">int</span> UserStringCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00730"></a><span class="lineno"> 730</span> </div><div class="line"><a name="l00731"></a><span class="lineno"> 731</span>  <span class="comment">//</span></div><div class="line"><a name="l00732"></a><span class="lineno"> 732</span>  <span class="comment">// END: User string support</span></div><div class="line"><a name="l00733"></a><span class="lineno"> 733</span>  <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> //////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> /////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span>  <span class="comment">// User data provides a standard way for extra information to</span></div><div class="line"><a name="l00739"></a><span class="lineno"> 739</span>  <span class="comment">// be attached to any class derived from ON_Object. The attached</span></div><div class="line"><a name="l00740"></a><span class="lineno"> 740</span>  <span class="comment">// information can persist and be transformed. If you use user</span></div><div class="line"><a name="l00741"></a><span class="lineno"> 741</span>  <span class="comment">// data, please carefully read all the comments from here to the</span></div><div class="line"><a name="l00742"></a><span class="lineno"> 742</span>  <span class="comment">// end of the file.</span></div><div class="line"><a name="l00743"></a><span class="lineno"> 743</span>  <span class="comment">//</span></div><div class="line"><a name="l00744"></a><span class="lineno"> 744</span> </div><div class="line"><a name="l00745"></a><span class="lineno"> 745</span>  <span class="comment">/*</span></div><div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> Attach user data to an object.</span></div><div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> pUserData - [in] user data to attach to object.</span></div><div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> The ON_UserData pointer passed to AttachUserData()</span></div><div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> must be created with new. </span></div><div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment"> If true is returned, then ON_Object will delete the user</span></div><div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="comment"> data when appropriate. If false is returned, then data </span></div><div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment"> could not be attached and caller must delete. </span></div><div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment"> AttachUserData() will fail if the user data's m_userdata_uuid</span></div><div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> field is nil or not unique.</span></div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> */</span></div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span>  <span class="keywordtype">bool</span> AttachUserData( </div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span>  <span class="keyword">class</span> <a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* pUserData </div><div class="line"><a name="l00762"></a><span class="lineno"> 762</span>  );</div><div class="line"><a name="l00763"></a><span class="lineno"> 763</span> </div><div class="line"><a name="l00764"></a><span class="lineno"> 764</span>  <span class="comment">/*</span></div><div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> Remove user data from an object.</span></div><div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> pUserData - [in] user data to attach to object.</span></div><div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"> The ON_UserData pointer passed to DetachUserData()</span></div><div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"> must have been previously attached using </span></div><div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment"> AttachUserData(). </span></div><div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> If true is returned, then the user data was</span></div><div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> attached to this object and it was detached. If false</span></div><div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> is returned, then the user data was not attached to this</span></div><div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment"> object to begin with. In all cases, you can be assured</span></div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment"> that the user data is no longer attached to "this".</span></div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment"> Call delete pUserData if you want to destroy the user data.</span></div><div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> */</span></div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  <span class="keywordtype">bool</span> DetachUserData(</div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  <span class="keyword">class</span> <a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* pUserData </div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span>  );</div><div class="line"><a name="l00784"></a><span class="lineno"> 784</span> </div><div class="line"><a name="l00785"></a><span class="lineno"> 785</span> </div><div class="line"><a name="l00786"></a><span class="lineno"> 786</span>  <span class="comment">/*</span></div><div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> Get a pointer to user data.</span></div><div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment"> userdata_uuid - [in] value of the user data's </span></div><div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> m_userdata_uuid field.</span></div><div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> The returned user data is still attached to the object.</span></div><div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment"> Deleting the returned user data will automatically remove</span></div><div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> the user data from the object.</span></div><div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="comment"> */</span></div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span>  <span class="keyword">class </span><a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* GetUserData( </div><div class="line"><a name="l00798"></a><span class="lineno"> 798</span>  <span class="keyword">const</span> <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a>& userdata_uuid</div><div class="line"><a name="l00799"></a><span class="lineno"> 799</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00800"></a><span class="lineno"> 800</span> </div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  <span class="comment">/*</span></div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> PurgeUserData() removes all user data from object. </span></div><div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> Use delete GetUserData(...) to destroy a single piece</span></div><div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> of user data.</span></div><div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> */</span></div><div class="line"><a name="l00808"></a><span class="lineno"> 808</span>  <span class="keywordtype">void</span> PurgeUserData();</div><div class="line"><a name="l00809"></a><span class="lineno"> 809</span> </div><div class="line"><a name="l00810"></a><span class="lineno"> 810</span>  <span class="comment">/*</span></div><div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment"> User data is stored as a linked list of ON_UserData</span></div><div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment"> classes. FirstUserData gets the first item in the</span></div><div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> linked list. This is the most recent item attached</span></div><div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> using AttachUserData().</span></div><div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> Remark:</span></div><div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> To iterate through all the user data on an object, </span></div><div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> call FirstUserData() and then use ON_UserData::Next()</span></div><div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> to traverse the list.</span></div><div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"> */</span></div><div class="line"><a name="l00821"></a><span class="lineno"> 821</span>  <span class="keyword">class </span><a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* FirstUserData() <span class="keyword">const</span>;</div><div class="line"><a name="l00822"></a><span class="lineno"> 822</span> </div><div class="line"><a name="l00823"></a><span class="lineno"> 823</span>  <span class="comment">/*</span></div><div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment"> Objects derived from ON_Geometry must call</span></div><div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="comment"> TransformUserData() in their Transform() member function.</span></div><div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment"> xform - [in] transformation to apply to user data</span></div><div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="comment"> */</span></div><div class="line"><a name="l00830"></a><span class="lineno"> 830</span>  <span class="keywordtype">void</span> TransformUserData( </div><div class="line"><a name="l00831"></a><span class="lineno"> 831</span>  <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d3/d13/class_o_n___xform.html">ON_Xform</a>& xform</div><div class="line"><a name="l00832"></a><span class="lineno"> 832</span>  );</div><div class="line"><a name="l00833"></a><span class="lineno"> 833</span> </div><div class="line"><a name="l00834"></a><span class="lineno"> 834</span>  <span class="comment">/*</span></div><div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment"> When a userdata item is copied or moved from a source object to</span></div><div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"> a destination object, the ON_Object::UserDataConflictResolution</span></div><div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment"> enum values specify how conficts are resolved.</span></div><div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"> Remark:</span></div><div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"> A userdata item "conflict" occurs when both the destination</span></div><div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"> and source object have a user data item with the same</span></div><div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> value of ON_UserData::m_userdata_uuid.</span></div><div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment"> */</span></div><div class="line"><a name="l00844"></a><span class="lineno"><a class="line" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c"> 844</a></span>  <span class="keyword">enum</span> <span class="keyword">class </span><a class="code" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">UserDataConflictResolution</a> : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span></div><div class="line"><a name="l00845"></a><span class="lineno"> 845</span>  {</div><div class="line"><a name="l00846"></a><span class="lineno"> 846</span>  destination_object = 0, <span class="comment">// use destination item</span></div><div class="line"><a name="l00847"></a><span class="lineno"> 847</span>  source_object = 1, <span class="comment">// use source item</span></div><div class="line"><a name="l00848"></a><span class="lineno"> 848</span>  source_copycount_gt = 2, <span class="comment">// use source item if source copycount > destination copy count</span></div><div class="line"><a name="l00849"></a><span class="lineno"> 849</span>  source_copycount_ge = 3, <span class="comment">// use source item if source copycount >= destination copy count</span></div><div class="line"><a name="l00850"></a><span class="lineno"> 850</span>  destination_copycount_gt = 4, <span class="comment">// use destination item if destination copycount > source copy count</span></div><div class="line"><a name="l00851"></a><span class="lineno"> 851</span>  destination_copycount_ge = 5, <span class="comment">// use destination item if destination copycount >= source copy count</span></div><div class="line"><a name="l00852"></a><span class="lineno"> 852</span>  delete_item = 6 <span class="comment">// delete item from the destination object</span></div><div class="line"><a name="l00853"></a><span class="lineno"> 853</span>  };</div><div class="line"><a name="l00854"></a><span class="lineno"> 854</span> </div><div class="line"><a name="l00855"></a><span class="lineno"> 855</span>  <span class="comment">/*</span></div><div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> Expert user tool that copies user data items with positive values of</span></div><div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"> ON_UserData.m_userdata_copycount from source_object to "this.</span></div><div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00860"></a><span class="lineno"> 860</span> <span class="comment"> source_object - [in] </span></div><div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"> source of user data to copy</span></div><div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment"> source_userdata_item_id - [in]</span></div><div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"> If source_userdata_item_id is not nil, then only the user data item</span></div><div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"> with a matching ON_UserData.m_userdata_uuid value will be copied.</span></div><div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"> userdata_conflict_resolution - [in]</span></div><div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment"> method to resolve userdata item conficts.</span></div><div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"> Generally speaking you don't need to use CopyUserData().</span></div><div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment"> Simply rely on ON_Object::operator=() or the copy constructor</span></div><div class="line"><a name="l00870"></a><span class="lineno"> 870</span> <span class="comment"> to do the right thing.</span></div><div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00872"></a><span class="lineno"> 872</span> <span class="comment"> Number of user data items that were copied.</span></div><div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="comment"> */</span></div><div class="line"><a name="l00874"></a><span class="lineno"> 874</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> CopyUserData( </div><div class="line"><a name="l00875"></a><span class="lineno"> 875</span>  <span class="keyword">const</span> <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& source_object,</div><div class="line"><a name="l00876"></a><span class="lineno"> 876</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> source_userdata_item_id,</div><div class="line"><a name="l00877"></a><span class="lineno"> 877</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> userdata_conflict_resolution</div><div class="line"><a name="l00878"></a><span class="lineno"> 878</span>  );</div><div class="line"><a name="l00879"></a><span class="lineno"> 879</span> </div><div class="line"><a name="l00880"></a><span class="lineno"> 880</span>  <span class="comment">/*</span></div><div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"> Expert user tool that moves user data items from source_object to "this.</span></div><div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment"> source_object - [in] </span></div><div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment"> source of user data to copy</span></div><div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="comment"> source_userdata_item_id - [in]</span></div><div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="comment"> If source_userdata_item_id is not nil, then only the user data item</span></div><div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment"> with a matching ON_UserData.m_userdata_uuid value will be moved.</span></div><div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment"> userdata_conflict_resolution - [in]</span></div><div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment"> method to resolve userdata item conficts.</span></div><div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment"> bDeleteAllSourceItems - [in]</span></div><div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment"> If bDeleteAllSourceItems is true, then any userdata items</span></div><div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment"> that are not copied from source_object are deleted.</span></div><div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="comment"> Generally speaking you don't need to use MoveUserData().</span></div><div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment"> Simply rely on ON_Object::operator=() or the copy constructor</span></div><div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment"> to do the right thing.</span></div><div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment"> Number of user data items that were moved.</span></div><div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="comment"> */</span></div><div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MoveUserData( </div><div class="line"><a name="l00902"></a><span class="lineno"> 902</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& source_object,</div><div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  <a class="code" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> source_userdata_item_id,</div><div class="line"><a name="l00904"></a><span class="lineno"> 904</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> userdata_conflict_resolution,</div><div class="line"><a name="l00905"></a><span class="lineno"> 905</span>  <span class="keywordtype">bool</span> bDeleteAllSourceItems</div><div class="line"><a name="l00906"></a><span class="lineno"> 906</span>  );</div><div class="line"><a name="l00907"></a><span class="lineno"> 907</span> </div><div class="line"><a name="l00908"></a><span class="lineno"> 908</span>  <span class="comment">/*</span></div><div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment"> Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object).</span></div><div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment"> source_object - [in] </span></div><div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment"> */</span></div><div class="line"><a name="l00914"></a><span class="lineno"> 914</span>  <span class="keywordtype">void</span> CopyUserData( </div><div class="line"><a name="l00915"></a><span class="lineno"> 915</span>  <span class="keyword">const</span> <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& source_object </div><div class="line"><a name="l00916"></a><span class="lineno"> 916</span>  );</div><div class="line"><a name="l00917"></a><span class="lineno"> 917</span> </div><div class="line"><a name="l00918"></a><span class="lineno"> 918</span>  <span class="comment">/*</span></div><div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="comment"> Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true).</span></div><div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment"> source_object - [in] </span></div><div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment"> */</span></div><div class="line"><a name="l00924"></a><span class="lineno"> 924</span>  <span class="keywordtype">void</span> MoveUserData( </div><div class="line"><a name="l00925"></a><span class="lineno"> 925</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>& source_object </div><div class="line"><a name="l00926"></a><span class="lineno"> 926</span>  );</div><div class="line"><a name="l00927"></a><span class="lineno"> 927</span>  </div><div class="line"><a name="l00928"></a><span class="lineno"> 928</span>  <span class="comment">/*</span></div><div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment"> Uses the destination_manifest to update references to other components.</span></div><div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment"> This is typically done when a component's references came from a "source" </span></div><div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"> context and are being updated to the "destination" context. For example,</span></div><div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"> inserting one model into another when index, id, and name conflicts </span></div><div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment"> need to be resolved at the time of insertion.</span></div><div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment"> source_manifest - [in]</span></div><div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"> A manifest of the source context with indices and ids </span></div><div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"> corresponding to the current component references.</span></div><div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> If this manifest is not available, pass ON_ComponentManifest::Empty.</span></div><div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment"> destination_manifest - [in]</span></div><div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"> A manifest of the destination context with indices and ids </span></div><div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"> corresponding to the desired component references.</span></div><div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment"> If this manifest is not available, pass ON_ComponentManifest::Empty.</span></div><div class="line"><a name="l00944"></a><span class="lineno"> 944</span> <span class="comment"> manifest_map - [in]</span></div><div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment"> A map from the source (current) referenced component index/id values </span></div><div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment"> to the destination (desired) component index/id values.</span></div><div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"> True if successful.</span></div><div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"> False indicates a referenced component was not found in the manifest</span></div><div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"> and the reference was changed to a default value.</span></div><div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"> Example:</span></div><div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"> If this object is an ON_Layer, the line pattern and render material references</span></div><div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment"> are updated. </span></div><div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment"> If this object is an ON_DimStyle, the text style reference is updated. </span></div><div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment"> If this object is an ON_3dmObjectAttributes, the layer,</span></div><div class="line"><a name="l00956"></a><span class="lineno"> 956</span> <span class="comment"> material, line pattern, and group references are updated. </span></div><div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment"> */</span></div><div class="line"><a name="l00958"></a><span class="lineno"> 958</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UpdateReferencedComponents(</div><div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d8/d72/class_o_n___component_manifest.html">ON_ComponentManifest</a>& source_manifest,</div><div class="line"><a name="l00960"></a><span class="lineno"> 960</span>  <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d8/d72/class_o_n___component_manifest.html">ON_ComponentManifest</a>& destination_manifest,</div><div class="line"><a name="l00961"></a><span class="lineno"> 961</span>  <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d9/df6/class_o_n___manifest_map.html">ON_ManifestMap</a>& manifest_map</div><div class="line"><a name="l00962"></a><span class="lineno"> 962</span>  );</div><div class="line"><a name="l00963"></a><span class="lineno"> 963</span>  <span class="comment"></span></div><div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"> /////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00966"></a><span class="lineno"> 966</span>  <span class="comment">// Component status interface</span></div><div class="line"><a name="l00967"></a><span class="lineno"> 967</span>  <span class="comment">//</span></div><div class="line"><a name="l00968"></a><span class="lineno"> 968</span>  <span class="comment">// Currently implemnented on ON_SubD and ON_Brep</span></div><div class="line"><a name="l00969"></a><span class="lineno"> 969</span>  <span class="comment">//</span></div><div class="line"><a name="l00970"></a><span class="lineno"> 970</span> </div><div class="line"><a name="l00971"></a><span class="lineno"> 971</span>  <span class="comment">/*</span></div><div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"> Set all active level component states to ON_ComponentStatus::NoneSet.</span></div><div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> Number of components where a state setting chanaged.</span></div><div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"> */</span></div><div class="line"><a name="l00977"></a><span class="lineno"> 977</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ClearAllComponentStates() <span class="keyword">const</span>;</div><div class="line"><a name="l00978"></a><span class="lineno"> 978</span> </div><div class="line"><a name="l00979"></a><span class="lineno"> 979</span>  <span class="comment">/*</span></div><div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> Clear the specified states on every component.</span></div><div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> states_to_clear - [in]</span></div><div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment"> States to clear.</span></div><div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment"> Number of components where a state setting chanaged.</span></div><div class="line"><a name="l00987"></a><span class="lineno"> 987</span> <span class="comment"> */</span></div><div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l00989"></a><span class="lineno"> 989</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ClearComponentStates(</div><div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  <a class="code" href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a> states_to_clear</div><div class="line"><a name="l00991"></a><span class="lineno"> 991</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00992"></a><span class="lineno"> 992</span> </div><div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  <span class="comment">/*</span></div><div class="line"><a name="l00994"></a><span class="lineno"> 994</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00995"></a><span class="lineno"> 995</span> <span class="comment"> states_filter - [in]</span></div><div class="line"><a name="l00996"></a><span class="lineno"> 996</span> <span class="comment"></span></div><div class="line"><a name="l00997"></a><span class="lineno"> 997</span> <span class="comment"> bAllEqualStates - [in]</span></div><div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment"> If a state is set in states_filter, all active level components</span></div><div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment"> with the same state set will be included in the </span></div><div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment"> components_with_set_states[] array. </span></div><div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment"></span></div><div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> <span class="comment"> If bAllEqualStates is true, then ON_ComponentStatus::AllEqualStates()</span></div><div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> <span class="comment"> is used to test for inclusion. </span></div><div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment"></span></div><div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> If bAllEqualStates is false, then ON_ComponentStatus::SomeEqualStates()</span></div><div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment"> is used to test for inclusion.</span></div><div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment"></span></div><div class="line"><a name="l01008"></a><span class="lineno"> 1008</span> <span class="comment"> components_with_set_states - [out]</span></div><div class="line"><a name="l01009"></a><span class="lineno"> 1009</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> <span class="comment"> Number of returned components.</span></div><div class="line"><a name="l01011"></a><span class="lineno"> 1011</span> <span class="comment"> */</span></div><div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetComponentsWithSetStates(</div><div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>  <a class="code" href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a> states_filter,</div><div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>  <span class="keywordtype">bool</span> bAllEqualStates,</div><div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>  <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray< ON_COMPONENT_INDEX ></a>& components</div><div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>  </div><div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>  <span class="comment">/*</span></div><div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment"> Set states on an individual component.</span></div><div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> component_index - [in]</span></div><div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> <span class="comment"> The states will be set on this component.</span></div><div class="line"><a name="l01025"></a><span class="lineno"> 1025</span> <span class="comment"> states_to_set - [in]</span></div><div class="line"><a name="l01026"></a><span class="lineno"> 1026</span> <span class="comment"> If a state is set in the states_to_set parameter, the same</span></div><div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> <span class="comment"> state will be set on the component. </span></div><div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> <span class="comment"> 0: no state settings changed on the component.</span></div><div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment"> 1: some state setting changed on the component.</span></div><div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment"> */</span></div><div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SetComponentStates(</div><div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>  ON_COMPONENT_INDEX component_index,</div><div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>  <a class="code" href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a> states_to_set</div><div class="line"><a name="l01036"></a><span class="lineno"> 1036</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> </div><div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>  <span class="comment">/*</span></div><div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01040"></a><span class="lineno"> 1040</span> <span class="comment"> Clear states on an individual component.</span></div><div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"> component_index - [in]</span></div><div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment"> The states will be cleared on this component.</span></div><div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment"> states_to_clear - [in]</span></div><div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment"> If a state is set in the states_to_clear parameter, the same</span></div><div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment"> state will be cleared on the component. </span></div><div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> <span class="comment"> 0: no state settings changed on the component.</span></div><div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="comment"> 1: some state setting changed on the component.</span></div><div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment"> */</span></div><div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01052"></a><span class="lineno"> 1052</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ClearComponentStates(</div><div class="line"><a name="l01053"></a><span class="lineno"> 1053</span>  ON_COMPONENT_INDEX component_index,</div><div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>  <a class="code" href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a> states_to_clear</div><div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l01056"></a><span class="lineno"> 1056</span>  </div><div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>  <span class="comment">/*</span></div><div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="comment"> Copy status settings to an individual component.</span></div><div class="line"><a name="l01060"></a><span class="lineno"> 1060</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l01061"></a><span class="lineno"> 1061</span> <span class="comment"> component_index - [in]</span></div><div class="line"><a name="l01062"></a><span class="lineno"> 1062</span> <span class="comment"> The states will be copied to this component.</span></div><div class="line"><a name="l01063"></a><span class="lineno"> 1063</span> <span class="comment"> status_to_copy - [in]</span></div><div class="line"><a name="l01064"></a><span class="lineno"> 1064</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01065"></a><span class="lineno"> 1065</span> <span class="comment"> 0: no state settings changed on the component.</span></div><div class="line"><a name="l01066"></a><span class="lineno"> 1066</span> <span class="comment"> 1: some state setting changed on the component.</span></div><div class="line"><a name="l01067"></a><span class="lineno"> 1067</span> <span class="comment"> */</span></div><div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SetComponentStatus(</div><div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>  ON_COMPONENT_INDEX component_index,</div><div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>  <a class="code" href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a> status_to_copy</div><div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l01073"></a><span class="lineno"> 1073</span> </div><div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>  <span class="comment">/*</span></div><div class="line"><a name="l01075"></a><span class="lineno"> 1075</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01076"></a><span class="lineno"> 1076</span> <span class="comment"> Call whenever a component status setting is modifed </span></div><div class="line"><a name="l01077"></a><span class="lineno"> 1077</span> <span class="comment"> by directly changing it on a component in a way that</span></div><div class="line"><a name="l01078"></a><span class="lineno"> 1078</span> <span class="comment"> will result in any saved information about the parent</span></div><div class="line"><a name="l01079"></a><span class="lineno"> 1079</span> <span class="comment"> object's aggretate component status becoming invalid.</span></div><div class="line"><a name="l01080"></a><span class="lineno"> 1080</span> <span class="comment"></span></div><div class="line"><a name="l01081"></a><span class="lineno"> 1081</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01082"></a><span class="lineno"> 1082</span> <span class="comment"> Aggregate information about the object's component states.</span></div><div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> <span class="comment"> */</span></div><div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>  <a class="code" href="../../d1/df0/class_o_n___aggregate_component_status.html">ON_AggregateComponentStatus</a> AggregateComponentStatus() <span class="keyword">const</span>;</div><div class="line"><a name="l01086"></a><span class="lineno"> 1086</span> </div><div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>  <span class="comment">/*</span></div><div class="line"><a name="l01088"></a><span class="lineno"> 1088</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01089"></a><span class="lineno"> 1089</span> <span class="comment"> Call whenever a component status setting is modifed </span></div><div class="line"><a name="l01090"></a><span class="lineno"> 1090</span> <span class="comment"> by directly changing it on a component in a way that</span></div><div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="comment"> will result in any saved information about the parent</span></div><div class="line"><a name="l01092"></a><span class="lineno"> 1092</span> <span class="comment"> object's aggretate component status becoming invalid.</span></div><div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> <span class="comment"></span></div><div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="comment"> The implementations of this function are nearly instant.</span></div><div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="comment"> and this function may be called as frequently as needed. </span></div><div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="comment"> The next time AggregateComponentStatus()</span></div><div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="comment"> is called the information used to return the value</span></div><div class="line"><a name="l01099"></a><span class="lineno"> 1099</span> <span class="comment"> will be updated.</span></div><div class="line"><a name="l01100"></a><span class="lineno"> 1100</span> <span class="comment"> */</span></div><div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>  <span class="keywordtype">void</span> MarkAggregateComponentStatusAsNotCurrent() <span class="keyword">const</span>;</div><div class="line"><a name="l01103"></a><span class="lineno"> 1103</span> </div><div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>  <span class="comment">/*</span></div><div class="line"><a name="l01105"></a><span class="lineno"> 1105</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> <span class="comment"> Delete the portions of the object identified in ci_list[].</span></div><div class="line"><a name="l01107"></a><span class="lineno"> 1107</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="comment"> ci_list - [in]</span></div><div class="line"><a name="l01109"></a><span class="lineno"> 1109</span> <span class="comment"> List of components to delete.</span></div><div class="line"><a name="l01110"></a><span class="lineno"> 1110</span> <span class="comment"> ci_list_count - [in]</span></div><div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="comment"> Number of elements in the ci_list[] array.</span></div><div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> <span class="comment"> True: succesful</span></div><div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="comment"> False: failure - no changes.</span></div><div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> <span class="comment"> */</span></div><div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>  <span class="keyword">virtual</span></div><div class="line"><a name="l01117"></a><span class="lineno"> 1117</span>  <span class="keywordtype">bool</span> DeleteComponents(</div><div class="line"><a name="l01118"></a><span class="lineno"> 1118</span>  <span class="keyword">const</span> ON_COMPONENT_INDEX* ci_list,</div><div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>  <span class="keywordtype">size_t</span> ci_count</div><div class="line"><a name="l01120"></a><span class="lineno"> 1120</span>  );</div><div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="comment"></span></div><div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="comment"> /////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l01124"></a><span class="lineno"> 1124</span>  <span class="comment">// Expert interface</span></div><div class="line"><a name="l01125"></a><span class="lineno"> 1125</span>  <span class="comment">//</span></div><div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> </div><div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>  <span class="comment">/*</span></div><div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> <span class="comment"> Description:</span></div><div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> <span class="comment"> Expert user function. If you are using openNURBS in its</span></div><div class="line"><a name="l01130"></a><span class="lineno"> 1130</span> <span class="comment"> default configuration to read and write 3dm archives,</span></div><div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="comment"> you never need to call this function.</span></div><div class="line"><a name="l01132"></a><span class="lineno"> 1132</span> <span class="comment"> Many objects employ lazy creation of (runtime) caches</span></div><div class="line"><a name="l01133"></a><span class="lineno"> 1133</span> <span class="comment"> that save information to help speed geometric calculations.</span></div><div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> <span class="comment"> This function will destroy all runtime information.</span></div><div class="line"><a name="l01135"></a><span class="lineno"> 1135</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l01136"></a><span class="lineno"> 1136</span> <span class="comment"> bDelete - [in] if true, any cached information is properly</span></div><div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> <span class="comment"> deleted. If false, any cached information</span></div><div class="line"><a name="l01138"></a><span class="lineno"> 1138</span> <span class="comment"> is simply discarded. This is useful when</span></div><div class="line"><a name="l01139"></a><span class="lineno"> 1139</span> <span class="comment"> the cached information may be in alternate</span></div><div class="line"><a name="l01140"></a><span class="lineno"> 1140</span> <span class="comment"> memory pools that are managed in nonstandard</span></div><div class="line"><a name="l01141"></a><span class="lineno"> 1141</span> <span class="comment"> ways.</span></div><div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="comment"> */</span></div><div class="line"><a name="l01143"></a><span class="lineno"> 1143</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> DestroyRuntimeCache( <span class="keywordtype">bool</span> bDelete = <span class="keyword">true</span> );</div><div class="line"><a name="l01144"></a><span class="lineno"> 1144</span> </div><div class="line"><a name="l01145"></a><span class="lineno"> 1145</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01146"></a><span class="lineno"> 1146</span>  <span class="keyword">class </span><a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* m_userdata_list;</div><div class="line"><a name="l01147"></a><span class="lineno"> 1147</span>  <span class="keyword">class </span><a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* TransferUserDataItem(</div><div class="line"><a name="l01148"></a><span class="lineno"> 1148</span>  <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* source_ud_copy_this,</div><div class="line"><a name="l01149"></a><span class="lineno"> 1149</span>  <span class="keyword">class</span> <a class="code" href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a>* source_ud_move_this,</div><div class="line"><a name="l01150"></a><span class="lineno"> 1150</span>  <span class="keywordtype">bool</span> bPerformConflictCheck,</div><div class="line"><a name="l01151"></a><span class="lineno"> 1151</span>  <a class="code" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> userdata_conflict_resolution</div><div class="line"><a name="l01152"></a><span class="lineno"> 1152</span>  );</div><div class="line"><a name="l01153"></a><span class="lineno"> 1153</span> };</div><div class="line"><a name="l01154"></a><span class="lineno"> 1154</span> </div><div class="line"><a name="l01155"></a><span class="lineno"> 1155</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l01156"></a><span class="lineno"> 1156</span> </div><div class="ttc" id="class_o_n___user_string_html"><div class="ttname"><a href="../../d0/d82/class_o_n___user_string.html">ON_UserString</a></div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:399</div></div>
|
|
<div class="ttc" id="struct_o_n___u_u_i_d__struct_html"><div class="ttname"><a href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID_struct</a></div><div class="ttdoc">ON_UUID is a 16 byte universally unique identifier. </div><div class="ttdef"><b>Definition:</b> opennurbs_uuid.h:32</div></div>
|
|
<div class="ttc" id="class_o_n___manifest_map_html"><div class="ttname"><a href="../../d9/df6/class_o_n___manifest_map.html">ON_ManifestMap</a></div><div class="ttdef"><b>Definition:</b> opennurbs_archive.h:1520</div></div>
|
|
<div class="ttc" id="class_o_n___simple_array_html"><div class="ttname"><a href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray</a></div><div class="ttdef"><b>Definition:</b> opennurbs_array.h:36</div></div>
|
|
<div class="ttc" id="class_o_n__w_string_html"><div class="ttname"><a href="../../d1/d11/class_o_n__w_string.html">ON_wString</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:2089</div></div>
|
|
<div class="ttc" id="class_o_n___user_string_html_a058be62bac0ef2619c40a8d85a9ea89c"><div class="ttname"><a href="../../d0/d82/class_o_n___user_string.html#a058be62bac0ef2619c40a8d85a9ea89c">ON_UserString::m_string_value</a></div><div class="ttdeci">ON_wString m_string_value</div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:405</div></div>
|
|
<div class="ttc" id="class_o_n___object_html_a7f520e987ffa14e71b06493340f9956c"><div class="ttname"><a href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a></div><div class="ttdeci">UserDataConflictResolution</div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:844</div></div>
|
|
<div class="ttc" id="class_o_n___aggregate_component_status_html"><div class="ttname"><a href="../../d1/df0/class_o_n___aggregate_component_status.html">ON_AggregateComponentStatus</a></div><div class="ttdef"><b>Definition:</b> opennurbs_compstat.h:413</div></div>
|
|
<div class="ttc" id="class_o_n___class_id_html"><div class="ttname"><a href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a></div><div class="ttdoc">used for runtime class identification </div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:44</div></div>
|
|
<div class="ttc" id="class_o_n___xform_html"><div class="ttname"><a href="../../d3/d13/class_o_n___xform.html">ON_Xform</a></div><div class="ttdef"><b>Definition:</b> opennurbs_xform.h:28</div></div>
|
|
<div class="ttc" id="class_o_n___component_manifest_html"><div class="ttname"><a href="../../d8/d72/class_o_n___component_manifest.html">ON_ComponentManifest</a></div><div class="ttdef"><b>Definition:</b> opennurbs_archive.h:487</div></div>
|
|
<div class="ttc" id="class_o_n___component_status_html"><div class="ttname"><a href="../../d9/d12/class_o_n___component_status.html">ON_ComponentStatus</a></div><div class="ttdef"><b>Definition:</b> opennurbs_compstat.h:88</div></div>
|
|
<div class="ttc" id="class_o_n___object_html"><div class="ttname"><a href="../../d9/d7b/class_o_n___object.html">ON_Object</a></div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:433</div></div>
|
|
<div class="ttc" id="class_o_n___class_array_html"><div class="ttname"><a href="../../dd/d40/class_o_n___class_array.html">ON_ClassArray< ON_UserString ></a></div></div>
|
|
<div class="ttc" id="class_o_n___text_log_html"><div class="ttname"><a href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a></div><div class="ttdef"><b>Definition:</b> opennurbs_textlog.h:20</div></div>
|
|
<div class="ttc" id="class_o_n___binary_archive_html"><div class="ttname"><a href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a></div><div class="ttdoc">< use for generic serialization of binary data </div><div class="ttdef"><b>Definition:</b> opennurbs_archive.h:1866</div></div>
|
|
<div class="ttc" id="class_o_n___user_data_html"><div class="ttname"><a href="../../d5/d55/class_o_n___user_data.html">ON_UserData</a></div><div class="ttdef"><b>Definition:</b> opennurbs_userdata.h:20</div></div>
|
|
<div class="ttc" id="class_o_n___user_string_html_ae31832d3326d65e5236caeb291eb5c06"><div class="ttname"><a href="../../d0/d82/class_o_n___user_string.html#ae31832d3326d65e5236caeb291eb5c06">ON_UserString::m_key</a></div><div class="ttdeci">ON_wString m_key</div><div class="ttdef"><b>Definition:</b> opennurbs_object.h:404</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jan 26 2018 12:38:19 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>
|