Files
opennurbs/6/d5/dab/opennurbs__group_8h_source.html
Bozo 832ccb5c1a Publish!
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

92 lines
19 KiB
HTML

<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_group.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="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- bootstrap -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- smartmenus -->
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
</head>
<body>
<!-- <div class="version-banner">
Go back to the <a href="/">main site</a>...
</div> -->
<div class="container">
<!-- navbar -->
<nav class="navbar navbar-default">
<div class="container-fluid">
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
<div class="navbar-collapse collapse" id="main-nav-placeholder">
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="#">Latest (6.x)</a></li>
<li class="disabled"><a href="#">WIP (7.x)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="page-content">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div 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_group.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright (c) 1993-2012 Robert McNeel &amp; Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<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>&#160;<span class="comment">// McNeel &amp; Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160;<span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// For complete openNURBS copyright information see &lt;http://www.opennurbs.org&gt;.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#if !defined(OPENNURBS_GROUP_INC_)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define OPENNURBS_GROUP_INC_</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../d0/d04/class_o_n___group.html"> 20</a></span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a> : <span class="keyword">public</span> <a class="code" href="../../dc/d5c/class_o_n___model_component.html">ON_ModelComponent</a></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; ON_OBJECT_DECLARE(<a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="../../d0/d04/class_o_n___group.html#a83b1d25e721406e724d4d8f3ed9bb0fc"> 25</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a> <a class="code" href="../../d0/d04/class_o_n___group.html#a83b1d25e721406e724d4d8f3ed9bb0fc">Unset</a>; <span class="comment">// nil id</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> model_component_reference - [in]</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> none_return_value - [in]</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> value to return if ON_Material::Cast(model_component_ref.ModelComponent())</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> is nullptr</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> If ON_Material::Cast(model_component_ref.ModelComponent()) is not nullptr,</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"> that pointer is returned. Otherwise, none_return_value is returned. </span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>* FromModelComponentRef(</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../df/de4/class_o_n___model_component_reference.html">ON_ModelComponentReference</a>&amp; model_component_reference,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">const</span> <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>* none_return_value</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; );</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>() ON_NOEXCEPT;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>(const <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>&amp; src);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; ~<a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>() = default;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>&amp; operator=(const <a class="code" href="../../d0/d04/class_o_n___group.html">ON_Group</a>&amp; src) = default;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;private:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> //////////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// ON_Object overrides</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">bool</span> IsValid( class <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>* text_log = <span class="keywordtype">nullptr</span> ) const override;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> Dump(</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a>&amp; text_log</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; ) const override;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> Write(</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; ) const override;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">bool</span> Read(</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; ) override;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;private:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> Internal_WriteV5(</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; ) const;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">bool</span> Internal_ReadV5(</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>&amp; archive</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; );</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;};</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#if defined(ON_DLL_TEMPLATE)</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;ON_DLL_TEMPLATE <span class="keyword">template</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray&lt;ON_Group*&gt;</a>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;ON_DLL_TEMPLATE <span class="keyword">template</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray&lt;const ON_Group*&gt;</a>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;ON_DLL_TEMPLATE <span class="keyword">template</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../da/d08/class_o_n___object_array.html">ON_ObjectArray&lt;ON_Group&gt;</a>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="class_o_n___group_html_a83b1d25e721406e724d4d8f3ed9bb0fc"><div class="ttname"><a href="../../d0/d04/class_o_n___group.html#a83b1d25e721406e724d4d8f3ed9bb0fc">ON_Group::Unset</a></div><div class="ttdeci">static const ON_Group Unset</div><div class="ttdef"><b>Definition:</b> opennurbs_group.h:25</div></div>
<div class="ttc" id="class_o_n___model_component_html"><div class="ttname"><a href="../../dc/d5c/class_o_n___model_component.html">ON_ModelComponent</a></div><div class="ttdoc">The ON_ModelComponent class is a base class for all components in a model and manages the index...</div><div class="ttdef"><b>Definition:</b> opennurbs_model_component.h:24</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___group_html"><div class="ttname"><a href="../../d0/d04/class_o_n___group.html">ON_Group</a></div><div class="ttdef"><b>Definition:</b> opennurbs_group.h:20</div></div>
<div class="ttc" id="class_o_n___object_array_html"><div class="ttname"><a href="../../da/d08/class_o_n___object_array.html">ON_ObjectArray</a></div><div class="ttdoc">ON_Object array is used to store lists of classes that are derived from ON_Object. It differs from ON_ClassArray in that the virtual ON_Object::MemoryRelocate function is called when growing the dynamic array requires changing the location of the memory buffer used to store the elements in the array. </div><div class="ttdef"><b>Definition:</b> opennurbs_array.h:725</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="ttdef"><b>Definition:</b> opennurbs_archive.h:1783</div></div>
<div class="ttc" id="class_o_n___model_component_reference_html"><div class="ttname"><a href="../../df/de4/class_o_n___model_component_reference.html">ON_ModelComponentReference</a></div><div class="ttdef"><b>Definition:</b> opennurbs_model_component.h:1622</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
</div> <!-- page-content -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 3 2018 11:08:27 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13
</small></address>
</div> <!-- container -->
<!-- doxy-boot -->
<script type="text/javascript" src="../../doxy-boot.js"></script>
</body>
</html>