mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
1402 lines
117 KiB
HTML
1402 lines
117 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: ON_Object Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">openNURBS SDK Help
|
|
 <span id="projectnumber">6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_o_n___object-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_Object Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="opennurbs__object_8h_source.html">opennurbs_object.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ON_Object:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_o_n___object.png" usemap="#ON_5FObject_map" alt=""/>
|
|
<map id="ON_5FObject_map" name="ON_5FObject_map">
|
|
<area href="class_o_n__3dm_object_attributes.html" alt="ON_3dmObjectAttributes" shape="rect" coords="182,56,354,80"/>
|
|
<area href="class_o_n__3dm_render_settings.html" alt="ON_3dmRenderSettings" shape="rect" coords="182,112,354,136"/>
|
|
<area href="class_o_n___brep_face_side.html" alt="ON_BrepFaceSide" shape="rect" coords="182,168,354,192"/>
|
|
<area href="class_o_n___brep_region.html" alt="ON_BrepRegion" shape="rect" coords="182,224,354,248"/>
|
|
<area href="class_o_n___document_user_string_list.html" alt="ON_DocumentUserStringList" shape="rect" coords="182,280,354,304"/>
|
|
<area href="class_o_n___geometry.html" alt="ON_Geometry" shape="rect" coords="182,336,354,360"/>
|
|
<area href="class_o_n___model_component.html" alt="ON_ModelComponent" shape="rect" coords="182,392,354,416"/>
|
|
<area href="class_o_n___texture.html" alt="ON_Texture" shape="rect" coords="182,448,354,472"/>
|
|
<area href="class_o_n___user_data.html" alt="ON_UserData" shape="rect" coords="182,504,354,528"/>
|
|
<area href="class_o_n___user_data_holder.html" alt="ON_UserDataHolder" shape="rect" coords="182,560,354,584"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a7f520e987ffa14e71b06493340f9956c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">UserDataConflictResolution</a> : unsigned char { <br />
|
|
  <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956caba9e24ac13ffcde7d2f6b554a33df7cd">UserDataConflictResolution::destination_object</a> = 0,
|
|
<a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956ca34f1a09f0cf6c7e702b6aad2260c6b0f">UserDataConflictResolution::source_object</a> = 1,
|
|
<a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956cad741a50b9ec9ac0de6491a83bc5b166f">UserDataConflictResolution::source_copycount_gt</a> = 2,
|
|
<a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956ca35055504b8fe7e98f97c2b2ea6168ad2">UserDataConflictResolution::source_copycount_ge</a> = 3,
|
|
<br />
|
|
  <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956ca6c944380c6bd502741a041a82ad00a5a">UserDataConflictResolution::destination_copycount_gt</a> = 4,
|
|
<a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956cadb77cee2050a09b500c679688e45a105">UserDataConflictResolution::destination_copycount_ge</a> = 5,
|
|
<a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956ca880ec7882afd9386e91140bf4f77e594">UserDataConflictResolution::delete_item</a> = 6
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a7f520e987ffa14e71b06493340f9956c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af580c6199f4469c49a4e09a117626c10"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#af580c6199f4469c49a4e09a117626c10">ON_Object</a> () ON_NOEXCEPT</td></tr>
|
|
<tr class="separator:af580c6199f4469c49a4e09a117626c10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a274166b34d06fc07a85997fd01b2dab1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a274166b34d06fc07a85997fd01b2dab1">ON_Object</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &)</td></tr>
|
|
<tr class="separator:a274166b34d06fc07a85997fd01b2dab1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad940aab7d51005c8732d76d1b188e332"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ad940aab7d51005c8732d76d1b188e332">~ON_Object</a> ()</td></tr>
|
|
<tr class="separator:ad940aab7d51005c8732d76d1b188e332"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a1cfab63437a2d03cc50fdc6734f2a5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_o_n___aggregate_component_status.html">ON_AggregateComponentStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a8a1cfab63437a2d03cc50fdc6734f2a5">AggregateComponentStatus</a> () const</td></tr>
|
|
<tr class="separator:a8a1cfab63437a2d03cc50fdc6734f2a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5432b341051664c185b10712a6e5b79"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ad5432b341051664c185b10712a6e5b79">AttachUserData</a> (class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> *pUserData)</td></tr>
|
|
<tr class="separator:ad5432b341051664c185b10712a6e5b79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27893ff72ca7abbe985f8b5f4ccd900e"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a27893ff72ca7abbe985f8b5f4ccd900e">ClearAllComponentStates</a> () const</td></tr>
|
|
<tr class="separator:a27893ff72ca7abbe985f8b5f4ccd900e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1af75ebe418edff4a11985f8fca7d83b"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a1af75ebe418edff4a11985f8fca7d83b">ClearComponentStates</a> (<a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> states_to_clear) const</td></tr>
|
|
<tr class="separator:a1af75ebe418edff4a11985f8fca7d83b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeadf76a46f3f1a661bbf41e1b754fe89"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#aeadf76a46f3f1a661bbf41e1b754fe89">ClearComponentStates</a> (ON_COMPONENT_INDEX component_index, <a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> states_to_clear) const</td></tr>
|
|
<tr class="separator:aeadf76a46f3f1a661bbf41e1b754fe89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad044157e5c1efde9fce1c6ccf6e81ff3"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ad044157e5c1efde9fce1c6ccf6e81ff3">CopyUserData</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &source_object, <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> source_userdata_item_id, <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> userdata_conflict_resolution)</td></tr>
|
|
<tr class="separator:ad044157e5c1efde9fce1c6ccf6e81ff3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58958333257eba5575a6a1b09c366c1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a58958333257eba5575a6a1b09c366c1b">CopyUserData</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &source_object)</td></tr>
|
|
<tr class="separator:a58958333257eba5575a6a1b09c366c1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af51d5fcec9379ad9b7a56ac4dfc9a8b2"><td class="memItemLeft" align="right" valign="top">virtual ON__UINT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#af51d5fcec9379ad9b7a56ac4dfc9a8b2">DataCRC</a> (ON__UINT32 current_remainder) const</td></tr>
|
|
<tr class="separator:af51d5fcec9379ad9b7a56ac4dfc9a8b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa67be7d8cc76ec82ae22a30093ecf98f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#aa67be7d8cc76ec82ae22a30093ecf98f">DeleteComponents</a> (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)</td></tr>
|
|
<tr class="separator:aa67be7d8cc76ec82ae22a30093ecf98f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8435c33ab53af41c22dac75e8917569"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#af8435c33ab53af41c22dac75e8917569">DestroyRuntimeCache</a> (bool bDelete=true)</td></tr>
|
|
<tr class="separator:af8435c33ab53af41c22dac75e8917569"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dbb0eff3b2287152b40991b3afca9ee"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a1dbb0eff3b2287152b40991b3afca9ee">DetachUserData</a> (class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> *pUserData)</td></tr>
|
|
<tr class="separator:a1dbb0eff3b2287152b40991b3afca9ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21c7b04a80f1806c3a45f72d7c491a44"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a21c7b04a80f1806c3a45f72d7c491a44">Dump</a> (<a class="el" href="class_o_n___text_log.html">ON_TextLog</a> &) const</td></tr>
|
|
<tr class="separator:a21c7b04a80f1806c3a45f72d7c491a44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad265ca0da2d751edaa9d2b5ab2540c6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ad265ca0da2d751edaa9d2b5ab2540c6a">EmergencyDestroy</a> ()</td></tr>
|
|
<tr class="separator:ad265ca0da2d751edaa9d2b5ab2540c6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb43bb324c44740c4bc2932e2f95c835"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#adb43bb324c44740c4bc2932e2f95c835">FirstUserData</a> () const</td></tr>
|
|
<tr class="separator:adb43bb324c44740c4bc2932e2f95c835"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a691de6470e814973858aa5c51eaffa77"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a691de6470e814973858aa5c51eaffa77">GetComponentsWithSetStates</a> (<a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> states_filter, bool bAllEqualStates, <a class="el" href="class_o_n___simple_array.html">ON_SimpleArray</a>< ON_COMPONENT_INDEX > &components) const</td></tr>
|
|
<tr class="separator:a691de6470e814973858aa5c51eaffa77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29f8d609e22008680581c6ca72ac47df"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a29f8d609e22008680581c6ca72ac47df">GetUserData</a> (const <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> &userdata_uuid) const</td></tr>
|
|
<tr class="separator:a29f8d609e22008680581c6ca72ac47df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab40b5e89b4766299e415593b31a3849c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ab40b5e89b4766299e415593b31a3849c">GetUserString</a> (const wchar_t *key, <a class="el" href="class_o_n__w_string.html">ON_wString</a> &string_value) const</td></tr>
|
|
<tr class="separator:ab40b5e89b4766299e415593b31a3849c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac285fba1506b2b9b821e3655582939c4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ac285fba1506b2b9b821e3655582939c4">GetUserStringKeys</a> (<a class="el" href="class_o_n___class_array.html">ON_ClassArray</a>< <a class="el" href="class_o_n__w_string.html">ON_wString</a> > &user_string_keys) const</td></tr>
|
|
<tr class="separator:ac285fba1506b2b9b821e3655582939c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004ab49490f69fcdc7681919c3837a33"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a004ab49490f69fcdc7681919c3837a33">GetUserStrings</a> (<a class="el" href="class_o_n___class_array.html">ON_ClassArray</a>< <a class="el" href="class_o_n___user_string.html">ON_UserString</a> > &user_strings) const</td></tr>
|
|
<tr class="separator:a004ab49490f69fcdc7681919c3837a33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe5367058a90545e81cd79b78103175d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#afe5367058a90545e81cd79b78103175d">IsKindOf</a> (const <a class="el" href="class_o_n___class_id.html">ON_ClassId</a> *pClassId) const</td></tr>
|
|
<tr class="separator:afe5367058a90545e81cd79b78103175d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7212696724553dc4d365479a10150c0d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a7212696724553dc4d365479a10150c0d">IsValid</a> (class <a class="el" href="class_o_n___text_log.html">ON_TextLog</a> *text_log=nullptr) const</td></tr>
|
|
<tr class="separator:a7212696724553dc4d365479a10150c0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a609192fbafecbe4be3136d8cb4dce882"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a609192fbafecbe4be3136d8cb4dce882">MarkAggregateComponentStatusAsNotCurrent</a> () const</td></tr>
|
|
<tr class="separator:a609192fbafecbe4be3136d8cb4dce882"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0674ccb79b6333e4b3c8e95ee10dd73"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ae0674ccb79b6333e4b3c8e95ee10dd73">MemoryRelocate</a> ()</td></tr>
|
|
<tr class="separator:ae0674ccb79b6333e4b3c8e95ee10dd73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21c508d3b53458e252adbcd29e62ed09"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a21c508d3b53458e252adbcd29e62ed09">ModelObjectId</a> () const</td></tr>
|
|
<tr class="separator:a21c508d3b53458e252adbcd29e62ed09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78b4ecb2eb36641e1ee6b4fc6129606e"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a78b4ecb2eb36641e1ee6b4fc6129606e">MoveUserData</a> (<a class="el" href="class_o_n___object.html">ON_Object</a> &source_object, <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> source_userdata_item_id, <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> userdata_conflict_resolution, bool bDeleteAllSourceItems)</td></tr>
|
|
<tr class="separator:a78b4ecb2eb36641e1ee6b4fc6129606e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54a891ae2cb2a25008a7a39cb19dfcea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a54a891ae2cb2a25008a7a39cb19dfcea">MoveUserData</a> (<a class="el" href="class_o_n___object.html">ON_Object</a> &source_object)</td></tr>
|
|
<tr class="separator:a54a891ae2cb2a25008a7a39cb19dfcea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa19aee4a411a8fda53aff00bd02d86e"><td class="memItemLeft" align="right" valign="top">virtual ON::object_type </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#afa19aee4a411a8fda53aff00bd02d86e">ObjectType</a> () const</td></tr>
|
|
<tr class="separator:afa19aee4a411a8fda53aff00bd02d86e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba6166c9aecef42639e684a2a3fda223"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_o_n___object.html">ON_Object</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#aba6166c9aecef42639e684a2a3fda223">operator=</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &)</td></tr>
|
|
<tr class="separator:aba6166c9aecef42639e684a2a3fda223"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88b61cafc0024ecb7a4bd22da2718680"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a88b61cafc0024ecb7a4bd22da2718680">PurgeUserData</a> ()</td></tr>
|
|
<tr class="separator:a88b61cafc0024ecb7a4bd22da2718680"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09ac9742ead91dd8f9cdd579bcbfed10"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a09ac9742ead91dd8f9cdd579bcbfed10">Read</a> (<a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> &binary_archive)</td></tr>
|
|
<tr class="separator:a09ac9742ead91dd8f9cdd579bcbfed10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab728c0576fd5913bc1575b74997bddb5"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ab728c0576fd5913bc1575b74997bddb5">SetComponentStates</a> (ON_COMPONENT_INDEX component_index, <a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> states_to_set) const</td></tr>
|
|
<tr class="separator:ab728c0576fd5913bc1575b74997bddb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a589f1fdc28f6259d1bd22bdedc9c4c76"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a589f1fdc28f6259d1bd22bdedc9c4c76">SetComponentStatus</a> (ON_COMPONENT_INDEX component_index, <a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> status_to_copy) const</td></tr>
|
|
<tr class="separator:a589f1fdc28f6259d1bd22bdedc9c4c76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a074dc9e9b919853919564793c37f5143"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a074dc9e9b919853919564793c37f5143">SetUserString</a> (const wchar_t *key, const wchar_t *string_value)</td></tr>
|
|
<tr class="separator:a074dc9e9b919853919564793c37f5143"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7234af898c307a2c2f7931db7e627592"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a7234af898c307a2c2f7931db7e627592">SetUserStrings</a> (int count, const <a class="el" href="class_o_n___user_string.html">ON_UserString</a> *user_strings, bool bReplace)</td></tr>
|
|
<tr class="separator:a7234af898c307a2c2f7931db7e627592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0299df21bfed90d7b5bfb24cdcf5e6c1"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a0299df21bfed90d7b5bfb24cdcf5e6c1">SizeOf</a> () const</td></tr>
|
|
<tr class="separator:a0299df21bfed90d7b5bfb24cdcf5e6c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a881bd2f0d8515adba1c42c578bcb7052"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a881bd2f0d8515adba1c42c578bcb7052">TransformUserData</a> (const class <a class="el" href="class_o_n___xform.html">ON_Xform</a> &xform)</td></tr>
|
|
<tr class="separator:a881bd2f0d8515adba1c42c578bcb7052"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82188bbf97bbd149ac6fcb7cd8e989d1"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a82188bbf97bbd149ac6fcb7cd8e989d1">UpdateReferencedComponents</a> (const class <a class="el" href="class_o_n___component_manifest.html">ON_ComponentManifest</a> &source_manifest, const class <a class="el" href="class_o_n___component_manifest.html">ON_ComponentManifest</a> &destination_manifest, const class <a class="el" href="class_o_n___manifest_map.html">ON_ManifestMap</a> &manifest_map)</td></tr>
|
|
<tr class="separator:a82188bbf97bbd149ac6fcb7cd8e989d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab648403ebf4592831809710f378e9ac2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#ab648403ebf4592831809710f378e9ac2">UserStringCount</a> () const</td></tr>
|
|
<tr class="separator:ab648403ebf4592831809710f378e9ac2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16eb9ab6bf0d0a614655cf9cd055871a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">Write</a> (<a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> &binary_archive) const</td></tr>
|
|
<tr class="separator:a16eb9ab6bf0d0a614655cf9cd055871a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Description: Pure virtual base class for all classes that must provide runtime class id or support object level 3DM serialization </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a7f520e987ffa14e71b06493340f9956c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f520e987ffa14e71b06493340f9956c">◆ </a></span>UserDataConflictResolution</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> : unsigned char</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: When a userdata item is copied or moved from a source object to a destination object, the <a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> enum values specify how conficts are resolved. Remark: A userdata item "conflict" occurs when both the destination and source object have a user data item with the same value of <a class="el" href="class_o_n___user_data.html#a9bc044ba84a529fe2195d8f8a817fda2">ON_UserData::m_userdata_uuid</a>. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956caba9e24ac13ffcde7d2f6b554a33df7cd"></a>destination_object </td><td class="fielddoc"><p>use destination item </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956ca34f1a09f0cf6c7e702b6aad2260c6b0f"></a>source_object </td><td class="fielddoc"><p>use source item </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956cad741a50b9ec9ac0de6491a83bc5b166f"></a>source_copycount_gt </td><td class="fielddoc"><p>use source item if source copycount > destination copy count </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956ca35055504b8fe7e98f97c2b2ea6168ad2"></a>source_copycount_ge </td><td class="fielddoc"><p>use source item if source copycount >= destination copy count </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956ca6c944380c6bd502741a041a82ad00a5a"></a>destination_copycount_gt </td><td class="fielddoc"><p>use destination item if destination copycount > source copy count </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956cadb77cee2050a09b500c679688e45a105"></a>destination_copycount_ge </td><td class="fielddoc"><p>use destination item if destination copycount >= source copy count </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a7f520e987ffa14e71b06493340f9956ca880ec7882afd9386e91140bf4f77e594"></a>delete_item </td><td class="fielddoc"><p>delete item from the destination object </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af580c6199f4469c49a4e09a117626c10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af580c6199f4469c49a4e09a117626c10">◆ </a></span>ON_Object() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_Object::ON_Object </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad940aab7d51005c8732d76d1b188e332"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad940aab7d51005c8732d76d1b188e332">◆ </a></span>~ON_Object()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ON_Object::~ON_Object </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a274166b34d06fc07a85997fd01b2dab1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a274166b34d06fc07a85997fd01b2dab1">◆ </a></span>ON_Object() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_Object::ON_Object </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a8a1cfab63437a2d03cc50fdc6734f2a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a1cfab63437a2d03cc50fdc6734f2a5">◆ </a></span>AggregateComponentStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="class_o_n___aggregate_component_status.html">ON_AggregateComponentStatus</a> ON_Object::AggregateComponentStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid.</p>
|
|
<p>Returns: Aggregate information about the object's component states. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#ae11df8a76b49c7f4c683ac9a2cddc34d">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5432b341051664c185b10712a6e5b79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5432b341051664c185b10712a6e5b79">◆ </a></span>AttachUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_Object::AttachUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> * </td>
|
|
<td class="paramname"><em>pUserData</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>END: User string support</p>
|
|
<p>User data provides a standard way for extra information to be attached to any class derived from <a class="el" href="class_o_n___object.html">ON_Object</a>. The attached information can persist and be transformed. If you use user data, please carefully read all the comments from here to the end of the file. <br />
|
|
Description: Attach user data to an object. Parameters: pUserData - [in] user data to attach to object. The <a class="el" href="class_o_n___user_data.html">ON_UserData</a> pointer passed to <a class="el" href="class_o_n___object.html#ad5432b341051664c185b10712a6e5b79">AttachUserData()</a> must be created with new. <br />
|
|
Returns: If true is returned, then <a class="el" href="class_o_n___object.html">ON_Object</a> will delete the user data when appropriate. If false is returned, then data could not be attached and caller must delete. <br />
|
|
Remarks: <a class="el" href="class_o_n___object.html#ad5432b341051664c185b10712a6e5b79">AttachUserData()</a> will fail if the user data's m_userdata_uuid field is nil or not unique. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27893ff72ca7abbe985f8b5f4ccd900e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27893ff72ca7abbe985f8b5f4ccd900e">◆ </a></span>ClearAllComponentStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_Object::ClearAllComponentStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Component status interface</p>
|
|
<p>Currently implemnented on ON_SubD and <a class="el" href="class_o_n___brep.html">ON_Brep</a> <br />
|
|
Description: Set all active level component states to <a class="el" href="class_o_n___component_status.html#ae267cd5d4088c8a033fa348d30227223">ON_ComponentStatus::NoneSet</a>. Returns: Number of components where a state setting chanaged. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1af75ebe418edff4a11985f8fca7d83b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1af75ebe418edff4a11985f8fca7d83b">◆ </a></span>ClearComponentStates() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::ClearComponentStates </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> </td>
|
|
<td class="paramname"><em>states_to_clear</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Clear the specified states on every component. Parameters: states_to_clear - [in] States to clear. Returns: Number of components where a state setting chanaged. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#a3e453036900222c04f07ffa1e8d6a1de">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeadf76a46f3f1a661bbf41e1b754fe89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeadf76a46f3f1a661bbf41e1b754fe89">◆ </a></span>ClearComponentStates() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::ClearComponentStates </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON_COMPONENT_INDEX </td>
|
|
<td class="paramname"><em>component_index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> </td>
|
|
<td class="paramname"><em>states_to_clear</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Clear states on an individual component. Parameters: component_index - [in] The states will be cleared on this component. states_to_clear - [in] If a state is set in the states_to_clear parameter, the same state will be cleared on the component. <br />
|
|
Returns: 0: no state settings changed on the component. 1: some state setting changed on the component. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#aad47a740758f748dfa30528d1d79e64c">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad044157e5c1efde9fce1c6ccf6e81ff3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad044157e5c1efde9fce1c6ccf6e81ff3">◆ </a></span>CopyUserData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_Object::CopyUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"><em>source_object</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> </td>
|
|
<td class="paramname"><em>source_userdata_item_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> </td>
|
|
<td class="paramname"><em>userdata_conflict_resolution</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Expert user tool that copies user data items with positive values of <a class="el" href="class_o_n___user_data.html#ac025400e9bff35c899ed85ba1b0a52e4">ON_UserData.m_userdata_copycount</a> from source_object to "this. Parameters: source_object - [in] source of user data to copy source_userdata_item_id - [in] If source_userdata_item_id is not nil, then only the user data item with a matching <a class="el" href="class_o_n___user_data.html#a9bc044ba84a529fe2195d8f8a817fda2">ON_UserData.m_userdata_uuid</a> value will be copied. userdata_conflict_resolution - [in] method to resolve userdata item conficts. Remarks: Generally speaking you don't need to use <a class="el" href="class_o_n___object.html#ad044157e5c1efde9fce1c6ccf6e81ff3">CopyUserData()</a>. Simply rely on <a class="el" href="class_o_n___object.html#aba6166c9aecef42639e684a2a3fda223">ON_Object::operator=()</a> or the copy constructor to do the right thing. Returns: Number of user data items that were copied. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58958333257eba5575a6a1b09c366c1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58958333257eba5575a6a1b09c366c1b">◆ </a></span>CopyUserData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Object::CopyUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"><em>source_object</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object). Parameters: source_object - [in] </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af51d5fcec9379ad9b7a56ac4dfc9a8b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af51d5fcec9379ad9b7a56ac4dfc9a8b2">◆ </a></span>DataCRC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ON__UINT32 ON_Object::DataCRC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON__UINT32 </td>
|
|
<td class="paramname"><em>current_remainder</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. Parameters: current_remainder - [in]; Returns: CRC of the information the defines the object. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#ad7f71b595855073034c29bd74c15305f">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#a9b9cf5a78381497a5a8c05cf6d3ab7e4">ON_Brep</a>, <a class="el" href="class_o_n___nurbs_cage.html#ac6b3702214ed760b12b5e2a1ddd8cab0">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#ae918926cff9ab87bccc75026a57a3d99">ON_BrepFace</a>, <a class="el" href="class_o_n___document_user_string_list.html#a350564552bb07640a1c7ab8a689b8699">ON_DocumentUserStringList</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#a0c938d4b0e6da88c71ebc0701b3f446d">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___user_string_list.html#a1ee8190ec4aca7a99b038269cd41bfdc">ON_UserStringList</a>, <a class="el" href="class_o_n___brep_edge.html#a078d4a051d0af65b807bbe11af947091">ON_BrepEdge</a>, <a class="el" href="class_o_n___sum_surface.html#ab81f384792b79934e55a72c0327b282f">ON_SumSurface</a>, <a class="el" href="class_o_n___nurbs_surface.html#ad2444ea0a1da7b92b69671e223a1cac9">ON_NurbsSurface</a>, <a class="el" href="class_o_n___rev_surface.html#a98012e2a3623cb9b65deee110c10651c">ON_RevSurface</a>, <a class="el" href="class_o_n___nurbs_curve.html#a795371d2c60abded397f23c517a3682a">ON_NurbsCurve</a>, <a class="el" href="class_o_n___brep_vertex.html#a73c722cf9a3d832f67bde1d4e5254ec8">ON_BrepVertex</a>, <a class="el" href="class_o_n___poly_curve.html#ab02e4992bff66c1d5d59ab99d8d75c80">ON_PolyCurve</a>, <a class="el" href="class_o_n___extrusion.html#a7c51e5c9f0f174f315e342bf60d96d36">ON_Extrusion</a>, <a class="el" href="class_o_n___curve_proxy.html#a54a5829dc1b5d1f7e397bd7b63231676">ON_CurveProxy</a>, <a class="el" href="class_o_n___surface_proxy.html#a4f43eb1bbb74d6309be3174595c53741">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___line_curve.html#a29afc43212218d75f87e9f5cb0f4dae4">ON_LineCurve</a>, <a class="el" href="class_o_n___polyline_curve.html#a99905265674520c86c6a2d1c1bdc6cac">ON_PolylineCurve</a>, <a class="el" href="class_o_n___arc_curve.html#aa9f012ebed16d4ac13c49579f654e750">ON_ArcCurve</a>, <a class="el" href="class_o_n___plane_surface.html#ac69131fead25ace5c27f3c979fb71e64">ON_PlaneSurface</a>, and <a class="el" href="class_o_n___model_component.html#aacc6c77d678662a84796ee0380ec55bc">ON_ModelComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa67be7d8cc76ec82ae22a30093ecf98f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa67be7d8cc76ec82ae22a30093ecf98f">◆ </a></span>DeleteComponents()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ON_Object::DeleteComponents </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const ON_COMPONENT_INDEX * </td>
|
|
<td class="paramname"><em>ci_list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>ci_count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Delete the portions of the object identified in ci_list[]. Parameters: ci_list - [in] List of components to delete. ci_list_count - [in] Number of elements in the ci_list[] array. Returns: True: succesful False: failure - no changes. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#a57ee1525a489f197b6a1a2cb9d0f439e">ON_Mesh</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8435c33ab53af41c22dac75e8917569"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8435c33ab53af41c22dac75e8917569">◆ </a></span>DestroyRuntimeCache()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ON_Object::DestroyRuntimeCache </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>bDelete</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Expert interface <br />
|
|
Description: Expert user function. If you are using openNURBS in its default configuration to read and write 3dm archives, you never need to call this function. Many objects employ lazy creation of (runtime) caches that save information to help speed geometric calculations. This function will destroy all runtime information. Parameters: bDelete - [in] if true, any cached information is properly deleted. If false, any cached information is simply discarded. This is useful when the cached information may be in alternate memory pools that are managed in nonstandard ways. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#ae7214a8028954b0a820e64e9b8a61854">ON_Mesh</a>, <a class="el" href="class_o_n___morph_control.html#affdc87fd309eb07259a8d52e36247241">ON_MorphControl</a>, <a class="el" href="class_o_n___brep.html#afe073d8c45fb82d4ba7197e2d958dd57">ON_Brep</a>, <a class="el" href="class_o_n___nurbs_cage.html#a14085930306251d54a559ebb435c41d0">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#aef440962549406700dec585a60e74d13">ON_BrepFace</a>, <a class="el" href="class_o_n___brep_loop.html#ab39d153de0f4215608479dc27a47cdaa">ON_BrepLoop</a>, <a class="el" href="class_o_n___brep_trim.html#aec64922f0ad2ef3f7f2bf9d72ec2b4f5">ON_BrepTrim</a>, <a class="el" href="class_o_n___poly_edge_segment.html#ac9c1c86bc1c548434c3a437448c3296f">ON_PolyEdgeSegment</a>, <a class="el" href="class_o_n___curve.html#a4ad9a73ad53707fbebfc904e772f605b">ON_Curve</a>, <a class="el" href="class_o_n___extrusion.html#abfd9e20874ccf446bfde16036d8bbfa2">ON_Extrusion</a>, <a class="el" href="class_o_n___surface.html#acfce039c891be4737a8710462b3336dc">ON_Surface</a>, <a class="el" href="class_o_n___curve_proxy.html#aa34313f708a47da03a20897c4d6beb9a">ON_CurveProxy</a>, <a class="el" href="class_o_n___poly_curve.html#a7e3d68e828a1ae33e7f9784bd48fc469">ON_PolyCurve</a>, <a class="el" href="class_o_n___poly_edge_curve.html#a76a58c1e7eae1c9e752746a9d584f4da">ON_PolyEdgeCurve</a>, <a class="el" href="class_o_n___surface_proxy.html#aa09cc4f51ffbe251a8da8853142bd57f">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___sum_surface.html#a6cb81bd906ac3d64c71791123f90bf87">ON_SumSurface</a>, and <a class="el" href="class_o_n___rev_surface.html#a1c021c963e1712825b8cf958b15043b2">ON_RevSurface</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1dbb0eff3b2287152b40991b3afca9ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1dbb0eff3b2287152b40991b3afca9ee">◆ </a></span>DetachUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_Object::DetachUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a> * </td>
|
|
<td class="paramname"><em>pUserData</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Remove user data from an object. Parameters: pUserData - [in] user data to attach to object. The <a class="el" href="class_o_n___user_data.html">ON_UserData</a> pointer passed to <a class="el" href="class_o_n___object.html#a1dbb0eff3b2287152b40991b3afca9ee">DetachUserData()</a> must have been previously attached using <a class="el" href="class_o_n___object.html#ad5432b341051664c185b10712a6e5b79">AttachUserData()</a>. <br />
|
|
Returns: If true is returned, then the user data was attached to this object and it was detached. If false is returned, then the user data was not attached to this object to begin with. In all cases, you can be assured that the user data is no longer attached to "this". Remarks: Call delete pUserData if you want to destroy the user data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21c7b04a80f1806c3a45f72d7c491a44"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21c7b04a80f1806c3a45f72d7c491a44">◆ </a></span>Dump()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ON_Object::Dump </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___text_log.html">ON_TextLog</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Creates a text dump of the object. Remarks: <a class="el" href="class_o_n___object.html#a21c7b04a80f1806c3a45f72d7c491a44">Dump()</a> is intended for debugging and is not suitable for creating high quality text descriptions of an object.</p>
|
|
<p>The default implementations of this virtual function prints the class's name. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh_component_ref.html#ad8dbda1fa8c9944a732043557c94d5c4">ON_MeshComponentRef</a>, <a class="el" href="class_o_n___mesh.html#a9621f32fa9123a6feae820085d14a02d">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#a8e042bf758b7df9978c5b3b04f8b07ca">ON_Brep</a>, <a class="el" href="class_o_n___morph_control.html#ae042142c95e710c65cd512d298f7cae5">ON_MorphControl</a>, <a class="el" href="class_o_n___nurbs_cage.html#a0f4193a42744b9300bdb653da84986d7">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#ae07f09ba6e788c9c6ef4f7af16cb7bbe">ON_BrepFace</a>, <a class="el" href="class_o_n___brep_loop.html#acd8c929f6362f52bf0640443aa11621f">ON_BrepLoop</a>, <a class="el" href="class_o_n___text_dot.html#acb93d6eed65d494a1f76f9c981624360">ON_TextDot</a>, <a class="el" href="class_o_n__3dm_render_settings.html#a9feb17ea4d3d5b83b40e584bcd1c2e44">ON_3dmRenderSettings</a>, <a class="el" href="class_o_n___hatch.html#ad895ec79e3072cbacf8267512fd62371">ON_Hatch</a>, <a class="el" href="class_o_n___document_user_string_list.html#ae0d48c97bb702f81322e1fbba50454c0">ON_DocumentUserStringList</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#acc749687d476cbab517d5a36b47960d6">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___brep_trim.html#a5a22733d4ae91dd5e703151fb3651dfc">ON_BrepTrim</a>, <a class="el" href="class_o_n___user_string_list.html#a415ed9e24d897b5c099b45c5a3154272">ON_UserStringList</a>, <a class="el" href="class_o_n___dim_style.html#a91b5c6fb1bf3e653c929c6df530159f7">ON_DimStyle</a>, <a class="el" href="class_o_n___hatch_pattern.html#a1302c7f801b6dc9882d04f56dc32b13d">ON_HatchPattern</a>, <a class="el" href="class_o_n___unknown_user_data.html#abcc720715407a7b964334097b4a904a0">ON_UnknownUserData</a>, <a class="el" href="class_o_n___brep_edge.html#a9376e109efd2397edfa51c2be63a2fd0">ON_BrepEdge</a>, <a class="el" href="class_o_n___instance_definition.html#a92a22f749002d479c23bed35f6a92d19">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___nurbs_surface.html#a74d364c467258afb3550ab265a3d8c50">ON_NurbsSurface</a>, <a class="el" href="class_o_n___text_content.html#ac2e4791756682de64b3958fcc1b2ae9d">ON_TextContent</a>, <a class="el" href="class_o_n___curve_proxy.html#ae8dbb8ed512eb1fae254374ff62a4518">ON_CurveProxy</a>, <a class="el" href="class_o_n___nurbs_curve.html#ab5cb1f453190f117cec0991ca910b54b">ON_NurbsCurve</a>, <a class="el" href="class_o_n___texture_mapping.html#af92b1a3e6bb57bd1cc93657ac9f2a468">ON_TextureMapping</a>, <a class="el" href="class_o_n___text_style.html#aee10904cd774f0bcb4f44ccf04c46fe8">ON_TextStyle</a>, <a class="el" href="class_o_n___texture.html#afca39ceb6c089d71564dc0bad3764fc8">ON_Texture</a>, <a class="el" href="class_o_n___sum_surface.html#a7ac3474d994b4dbb67effe7e37e97954">ON_SumSurface</a>, <a class="el" href="class_o_n___material.html#abd10615f531b165b0d2f86b44c6f3e72">ON_Material</a>, <a class="el" href="class_o_n___viewport.html#ad5f9a7a9c410e3a551a0ea1f72e023a9">ON_Viewport</a>, <a class="el" href="class_o_n___arc_curve.html#adebc103f483a74d201ea3c23f3b4f94e">ON_ArcCurve</a>, <a class="el" href="class_o_n___poly_curve.html#a27fdbfc0da365eca81baf766a9a83397">ON_PolyCurve</a>, <a class="el" href="class_o_n___rev_surface.html#ab522bc8deb00cf3feaabec29dcadc79e">ON_RevSurface</a>, <a class="el" href="class_o_n___history_record.html#a93d692afeed5dd4c069ac775e83f87ae">ON_HistoryRecord</a>, <a class="el" href="class_o_n___brep_vertex.html#ada99f4bfe3dc8c4a4dcd5d2ae996fe88">ON_BrepVertex</a>, <a class="el" href="class_o_n___linetype.html#a9fc5f20fe9d3f92381b98ebd5c55904a">ON_Linetype</a>, <a class="el" href="class_o_n___curve_on_surface.html#aadab7e3e387a3ea31d2e5f137463f657">ON_CurveOnSurface</a>, <a class="el" href="class_o_n___surface_proxy.html#a84bbeda812595dcb6ff99a9558afe985">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___extrusion.html#a881e2af9ee696333b300f22b688f1d97">ON_Extrusion</a>, <a class="el" href="class_o_n___model_geometry_component.html#a0aa8ad836340ddda12814ffe1d055d82">ON_ModelGeometryComponent</a>, <a class="el" href="class_o_n___point_cloud.html#a920f376439fabaee2c71e898e0ff56f0">ON_PointCloud</a>, <a class="el" href="class_o_n___polyline_curve.html#ad52e77ba83cdaa9f19d1a6c1089e09cc">ON_PolylineCurve</a>, <a class="el" href="class_o_n___leader.html#a0f6d379fa89c76862bc72a18a3079f8c">ON_Leader</a>, <a class="el" href="class_o_n___line_curve.html#a128844312bc6952dce00d5907efb29c3">ON_LineCurve</a>, <a class="el" href="class_o_n___layer.html#a132b06d265bc5546ac08fc9b6bbd4bfe">ON_Layer</a>, <a class="el" href="class_o_n___plane_surface.html#a660335bf3c88d9e654a184e93b6f94d4">ON_PlaneSurface</a>, <a class="el" href="class_o_n__3dm_object_attributes.html#a2b6e9371aa202f019b6f9b94d776c72e">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___bitmap.html#a5e880a9e6120ea036bc191686421893f">ON_Bitmap</a>, <a class="el" href="class_o_n___text.html#afeaa8f7bf46ae12c3e438f64fe8ee4fb">ON_Text</a>, <a class="el" href="class_o_n___point_grid.html#a1583eb7d1c72ae9f3b5431cc016dc707">ON_PointGrid</a>, <a class="el" href="class_o_n___point.html#af048c2272e27eb00bfa9b63df152bfd7">ON_Point</a>, <a class="el" href="class_o_n___user_data.html#a63fe722a03f7e436318e1ac90ef6629c">ON_UserData</a>, <a class="el" href="class_o_n___detail_view.html#a2413a2118eb8d8338a48a69b549af24a">ON_DetailView</a>, <a class="el" href="class_o_n___light.html#a1261015707bc1a2882750853f18ef8b0">ON_Light</a>, and <a class="el" href="class_o_n___model_component.html#aebee8c1655e072f442bd71d873240770">ON_ModelComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad265ca0da2d751edaa9d2b5ab2540c6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad265ca0da2d751edaa9d2b5ab2540c6a">◆ </a></span>EmergencyDestroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Object::EmergencyDestroy </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Sets m_user_data_list = 0. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb43bb324c44740c4bc2932e2f95c835"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb43bb324c44740c4bc2932e2f95c835">◆ </a></span>FirstUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a>* ON_Object::FirstUserData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: User data is stored as a linked list of <a class="el" href="class_o_n___user_data.html">ON_UserData</a> classes. FirstUserData gets the first item in the linked list. This is the most recent item attached using <a class="el" href="class_o_n___object.html#ad5432b341051664c185b10712a6e5b79">AttachUserData()</a>. Remark: To iterate through all the user data on an object, call <a class="el" href="class_o_n___object.html#adb43bb324c44740c4bc2932e2f95c835">FirstUserData()</a> and then use <a class="el" href="class_o_n___user_data.html#a5e5a0d01e000319e0b37b340752613d8">ON_UserData::Next()</a> to traverse the list. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a691de6470e814973858aa5c51eaffa77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a691de6470e814973858aa5c51eaffa77">◆ </a></span>GetComponentsWithSetStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::GetComponentsWithSetStates </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> </td>
|
|
<td class="paramname"><em>states_filter</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>bAllEqualStates</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___simple_array.html">ON_SimpleArray</a>< ON_COMPONENT_INDEX > & </td>
|
|
<td class="paramname"><em>components</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Parameters: states_filter - [in]</p>
|
|
<p>bAllEqualStates - [in] If a state is set in states_filter, all active level components with the same state set will be included in the components_with_set_states[] array. <br />
|
|
If bAllEqualStates is true, then <a class="el" href="class_o_n___component_status.html#a07a7df4fb56e8d9a0f894078e95800d5">ON_ComponentStatus::AllEqualStates()</a> is used to test for inclusion. <br />
|
|
If bAllEqualStates is false, then <a class="el" href="class_o_n___component_status.html#ae0fdd7626cf0af0eee9c1a6bb68768a2">ON_ComponentStatus::SomeEqualStates()</a> is used to test for inclusion.</p>
|
|
<p>components_with_set_states - [out] Returns: Number of returned components. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#a49725b5672fdaae8e02d03c43c509f11">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29f8d609e22008680581c6ca72ac47df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29f8d609e22008680581c6ca72ac47df">◆ </a></span>GetUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">class <a class="el" href="class_o_n___user_data.html">ON_UserData</a>* ON_Object::GetUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> & </td>
|
|
<td class="paramname"><em>userdata_uuid</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Get a pointer to user data. Parameters: userdata_uuid - [in] value of the user data's m_userdata_uuid field. Remarks: The returned user data is still attached to the object. Deleting the returned user data will automatically remove the user data from the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab40b5e89b4766299e415593b31a3849c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab40b5e89b4766299e415593b31a3849c">◆ </a></span>GetUserString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_Object::GetUserString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n__w_string.html">ON_wString</a> & </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Get user string from the object. Parameters: key - [in] id used to retrieve the string. string_value - [out] Returns: True if a string with id was found. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac285fba1506b2b9b821e3655582939c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac285fba1506b2b9b821e3655582939c4">◆ </a></span>GetUserStringKeys()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ON_Object::GetUserStringKeys </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___class_array.html">ON_ClassArray</a>< <a class="el" href="class_o_n__w_string.html">ON_wString</a> > & </td>
|
|
<td class="paramname"><em>user_string_keys</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Get a list of all user string keys on the object. Parameters: user_string_keys - [out] user string keys are appended to this list. Returns: Number of elements appended to the user_strings list. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a004ab49490f69fcdc7681919c3837a33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a004ab49490f69fcdc7681919c3837a33">◆ </a></span>GetUserStrings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ON_Object::GetUserStrings </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___class_array.html">ON_ClassArray</a>< <a class="el" href="class_o_n___user_string.html">ON_UserString</a> > & </td>
|
|
<td class="paramname"><em>user_strings</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Get a list of all user strings on the object. Parameters: user_strings - [out] user strings are appended to this list. Returns: Number of elements appended to the user_strings list. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afe5367058a90545e81cd79b78103175d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe5367058a90545e81cd79b78103175d">◆ </a></span>IsKindOf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_Object::IsKindOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___class_id.html">ON_ClassId</a> * </td>
|
|
<td class="paramname"><em>pClassId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Low level tool to test if an object is derived from a specified class. Parameters: pClassId - [in] use classname::ClassId() Returns: true if the instantiated object is derived from the class whose id is passed as the argument. Example: </p><pre class="fragment"> ON_Object* p = ....;
|
|
if ( p->IsKindOf( ON_NurbsCurve::ClassId() ) )
|
|
{
|
|
it's a NURBS curve
|
|
}
|
|
</pre><p>Remarks: The primary reason for <a class="el" href="class_o_n___object.html#afe5367058a90545e81cd79b78103175d">IsKindOf()</a> is to support the static Cast() members declared in the ON_OBJECT_DECLARE macro. If we determine that dynamic_cast is properly supported and implemented by all supported compilers, then <a class="el" href="class_o_n___object.html#afe5367058a90545e81cd79b78103175d">IsKindOf()</a> may dissappear. If an application needs to determine if a pointer points to a class derived from ON_SomeClassName, then call ON_SomeClassName::Cast(mystery pointer) and check for a non-null return. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7212696724553dc4d365479a10150c0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7212696724553dc4d365479a10150c0d">◆ </a></span>IsValid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ON_Object::IsValid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">class <a class="el" href="class_o_n___text_log.html">ON_TextLog</a> * </td>
|
|
<td class="paramname"><em>text_log</em> = <code>nullptr</code></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Tests an object to see if its data members are correctly initialized. Parameters: text_log - [in] if the object is not valid and text_log is not nullptr, then a brief englis description of the reason the object is not valid is appened to the log. The information appended to text_log is suitable for low-level debugging purposes by programmers and is not intended to be useful as a high level user interface tool. Returns: table true object is valid false object is invalid, uninitialized, etc. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh_component_ref.html#a4daec0aec8ca16589e3df58d99e914d3">ON_MeshComponentRef</a>, <a class="el" href="class_o_n___mesh.html#a08acfd86d40eb163156a7329fb3c52cc">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#ac538ff2fb9b8360fd5410fb0c66a1e54">ON_Brep</a>, <a class="el" href="class_o_n___morph_control.html#a0b3f9686ac35ededd42bcd8ee44d1f74">ON_MorphControl</a>, <a class="el" href="class_o_n___brep_region.html#add99b51bc0a5ee7fbaf998a10376f5d6">ON_BrepRegion</a>, <a class="el" href="class_o_n___brep_face_side.html#aabad1c3eebf81e44c32458283ee217ad">ON_BrepFaceSide</a>, <a class="el" href="class_o_n___nurbs_cage.html#a92f6166e55e981d8f699ec6833b44d5e">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#ac77b44e09f821eda5f617459d4def4b4">ON_BrepFace</a>, <a class="el" href="class_o_n___brep_loop.html#ad7953b495e8d6f250c222b7d2317fdea">ON_BrepLoop</a>, <a class="el" href="class_o_n___text_dot.html#a607946fbdc47c72db38acd8b32edeb38">ON_TextDot</a>, <a class="el" href="class_o_n___instance_ref.html#a1cded412156a3e52acf8227b8b5e9801">ON_InstanceRef</a>, <a class="el" href="class_o_n___hatch.html#a279017bfca4922b6a743dec0babff905">ON_Hatch</a>, <a class="el" href="class_o_n___document_user_string_list.html#a5261ea74d0abfa789d77ea8d3a0a8f01">ON_DocumentUserStringList</a>, <a class="el" href="class_o_n___user_data_holder.html#a400b9966aa1ba3b46d4e23fdf7e4f34d">ON_UserDataHolder</a>, <a class="el" href="class_o_n___brep_trim.html#ade75a2ccb593d868d126f415bd035615">ON_BrepTrim</a>, <a class="el" href="class_o_n___embedded_bitmap.html#a1e5fc1a7f8d2c9bd7df35f6050ce17c8">ON_EmbeddedBitmap</a>, <a class="el" href="class_o_n___dim_style.html#a0b5d7c3f9390db3c3da7d41c3a92f948">ON_DimStyle</a>, <a class="el" href="class_o_n___hatch_pattern.html#aa10c091c47f02f8891620bcacb25cb45">ON_HatchPattern</a>, <a class="el" href="class_o_n___unknown_user_data.html#a88118e622df8c2ba9d678b866b0422d4">ON_UnknownUserData</a>, <a class="el" href="class_o_n___brep_edge.html#af1181671e59dab6d99e3edfcd16e5b28">ON_BrepEdge</a>, <a class="el" href="class_o_n___windows_bitmap.html#a2f9351248bf7de5f69bc6c13b1bd9150">ON_WindowsBitmap</a>, <a class="el" href="class_o_n___instance_definition.html#ac03617e7c74fa8af0bc86d66ef33d1f1">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___nurbs_surface.html#afa03ebd61918b3018798008fec11b7bf">ON_NurbsSurface</a>, <a class="el" href="class_o_n___curve_proxy.html#ae7a460e0bea6dd662c164ce8809b7e9f">ON_CurveProxy</a>, <a class="el" href="class_o_n___nurbs_curve.html#ac5f832bbf39edcecc8ac527ce91e1880">ON_NurbsCurve</a>, <a class="el" href="class_o_n___texture_mapping.html#afc515aa18840926351300b333a13417a">ON_TextureMapping</a>, <a class="el" href="class_o_n___text_style.html#aefedb29b225a6aa9132d46584db39ac9">ON_TextStyle</a>, <a class="el" href="class_o_n___texture.html#a8d611ffe6affd1537aab1bb855fe1051">ON_Texture</a>, <a class="el" href="class_o_n___sum_surface.html#af9fe55fffb61628ea5d64e3e824b03b0">ON_SumSurface</a>, <a class="el" href="class_o_n___material.html#abe14a7feaafa717bcc7ceaa0422fda81">ON_Material</a>, <a class="el" href="class_o_n___viewport.html#af8d681aea278421cf973b2c2e2d67331">ON_Viewport</a>, <a class="el" href="class_o_n___arc_curve.html#af829ee4177429406ad0394a6ac9869d3">ON_ArcCurve</a>, <a class="el" href="class_o_n___rev_surface.html#aaa7b792554180bfa9b478368ac327d5c">ON_RevSurface</a>, <a class="el" href="class_o_n___history_record.html#a4c2646e0cb34761ac568448f7fa898d0">ON_HistoryRecord</a>, <a class="el" href="class_o_n___linetype.html#a95158134231660248d33d9417407a3c9">ON_Linetype</a>, <a class="el" href="class_o_n___brep_vertex.html#aa8bf5fb87c3ae3eddcfbfae4ed1eebd0">ON_BrepVertex</a>, <a class="el" href="class_o_n___dimension.html#aac2f86d6d47cf64fea911166f583e679">ON_Dimension</a>, <a class="el" href="class_o_n___poly_curve.html#a932ee89f2be7ebd06eb4cfdf464eeae1">ON_PolyCurve</a>, <a class="el" href="class_o_n___text_content.html#ae4074be131d265a757d4b26b9255d8f0">ON_TextContent</a>, <a class="el" href="class_o_n___curve_on_surface.html#a471e70165d699b02c790a153de322d9f">ON_CurveOnSurface</a>, <a class="el" href="class_o_n___surface_proxy.html#a00f48f9ca56e703db749521211c44462">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___annotation.html#a66f3f886c5f55024d24af7b1328e456f">ON_Annotation</a>, <a class="el" href="class_o_n___extrusion.html#a47d0690250a151f6f9669280d9cabed3">ON_Extrusion</a>, <a class="el" href="class_o_n___geometry.html#adf87e5ba0d9939dfabbb9f421b9d2b3b">ON_Geometry</a>, <a class="el" href="class_o_n___leader.html#a1ecc48aba49d71d7aa2cdebb846789c0">ON_Leader</a>, <a class="el" href="class_o_n___point_cloud.html#a5cfda54fc14c6bdee9a39e33841e419c">ON_PointCloud</a>, <a class="el" href="class_o_n___line_curve.html#afd4392691fe0578b61034ea80c055e7b">ON_LineCurve</a>, <a class="el" href="class_o_n___polyline_curve.html#acb658877b83662d4b2269f1147bde87a">ON_PolylineCurve</a>, <a class="el" href="class_o_n___layer.html#a7ee8ae0de4b0fb58deedbc97c5673a88">ON_Layer</a>, <a class="el" href="class_o_n___plane_surface.html#acbf99b2372edbb2c743dcd6f65d64dfb">ON_PlaneSurface</a>, <a class="el" href="class_o_n__3dm_object_attributes.html#abed6bc13691f367fbc82a9c02f41f300">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___point_grid.html#afe337221ab115e3512d159350d5d0f7b">ON_PointGrid</a>, <a class="el" href="class_o_n___point.html#ad91ede5199576543d3bc4fce66ab03ef">ON_Point</a>, <a class="el" href="class_o_n___detail_view.html#ad4812b865e8514b2efcce1f3df17725c">ON_DetailView</a>, <a class="el" href="class_o_n___light.html#a3be88ed7ac09d1ad666c4862069d9bb4">ON_Light</a>, <a class="el" href="class_o_n___text.html#a2f41c6a4ebed81f23d43cd4c2ce83a2c">ON_Text</a>, <a class="el" href="class_o_n___user_data.html#a1fc0cc7d050eb71a1e290acaceadf036">ON_UserData</a>, and <a class="el" href="class_o_n___model_component.html#adf05d4c839f242289c7b7a3ea607c242">ON_ModelComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a609192fbafecbe4be3136d8cb4dce882"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a609192fbafecbe4be3136d8cb4dce882">◆ </a></span>MarkAggregateComponentStatusAsNotCurrent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ON_Object::MarkAggregateComponentStatusAsNotCurrent </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid.</p>
|
|
<p>Remarks: The implementations of this function are nearly instant. and this function may be called as frequently as needed. The next time <a class="el" href="class_o_n___object.html#a8a1cfab63437a2d03cc50fdc6734f2a5">AggregateComponentStatus()</a> is called the information used to return the value will be updated. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#afc3a33c65952431528528e00b741ade5">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0674ccb79b6333e4b3c8e95ee10dd73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0674ccb79b6333e4b3c8e95ee10dd73">◆ </a></span>MemoryRelocate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ON_Object::MemoryRelocate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: The <a class="el" href="class_o_n___object.html#ae0674ccb79b6333e4b3c8e95ee10dd73">MemoryRelocate()</a> function is called when an object's location in memory is changed. For example, if an object resides in a chunk of memory that is grown by calling a realloc that has to allocate a new chunk and copy the contents of the old chunk to the new chunk, then the location of the object's memory changes. In practice this happens when classes derived from <a class="el" href="class_o_n___object.html">ON_Object</a> are stored in dynamic arrays, like the default implementation of ON_ObjectArray<>'s that use realloc to grow the dynamic array. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#a946263df140cb0a25931db03ed015759">ON_Mesh</a>, <a class="el" href="class_o_n___morph_control.html#abdf6c9a12c543b676d760946f6c41538">ON_MorphControl</a>, <a class="el" href="class_o_n___brep.html#a68391746e3eac8aab93b3ced47038061">ON_Brep</a>, and <a class="el" href="class_o_n___detail_view.html#aca59ebe193fa5e55b49ab32fd2f517ab">ON_DetailView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21c508d3b53458e252adbcd29e62ed09"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21c508d3b53458e252adbcd29e62ed09">◆ </a></span>ModelObjectId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_Object::ModelObjectId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: All objects in an opennurbs model have an id ( ON_Layer.m_layer_id, ON_Font.m_font_id, ON_Material.m_material_id, <a class="el" href="class_o_n__3dm_object_attributes.html#a806a85052b002c45021650e3b97e2018">ON_3dmObjectAttributes.m_uuid</a> ). Returns: The id used to identify the object in the openurbs model. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___light.html#a1c62fcef119977ad0314db9e4c05793c">ON_Light</a>, and <a class="el" href="class_o_n___model_component.html#afcdd748b7b44448d6d58f26f63141660">ON_ModelComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78b4ecb2eb36641e1ee6b4fc6129606e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78b4ecb2eb36641e1ee6b4fc6129606e">◆ </a></span>MoveUserData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_Object::MoveUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"><em>source_object</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> </td>
|
|
<td class="paramname"><em>source_userdata_item_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">ON_Object::UserDataConflictResolution</a> </td>
|
|
<td class="paramname"><em>userdata_conflict_resolution</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>bDeleteAllSourceItems</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Expert user tool that moves user data items from source_object to "this. Parameters: source_object - [in] source of user data to copy source_userdata_item_id - [in] If source_userdata_item_id is not nil, then only the user data item with a matching <a class="el" href="class_o_n___user_data.html#a9bc044ba84a529fe2195d8f8a817fda2">ON_UserData.m_userdata_uuid</a> value will be moved. userdata_conflict_resolution - [in] method to resolve userdata item conficts. bDeleteAllSourceItems - [in] If bDeleteAllSourceItems is true, then any userdata items that are not copied from source_object are deleted. Remarks: Generally speaking you don't need to use <a class="el" href="class_o_n___object.html#a78b4ecb2eb36641e1ee6b4fc6129606e">MoveUserData()</a>. Simply rely on <a class="el" href="class_o_n___object.html#aba6166c9aecef42639e684a2a3fda223">ON_Object::operator=()</a> or the copy constructor to do the right thing. Returns: Number of user data items that were moved. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a54a891ae2cb2a25008a7a39cb19dfcea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54a891ae2cb2a25008a7a39cb19dfcea">◆ </a></span>MoveUserData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Object::MoveUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"><em>source_object</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true). Parameters: source_object - [in] </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa19aee4a411a8fda53aff00bd02d86e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa19aee4a411a8fda53aff00bd02d86e">◆ </a></span>ObjectType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ON::object_type ON_Object::ObjectType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.</p>
|
|
<p>Returns: ON::object_type enum value.</p>
|
|
<p>Remarks: The default implementation of this virtual function returns ON::unknown_object_type </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh_component_ref.html#a34149d2ce62e8ea97e3c69f22b5acea2">ON_MeshComponentRef</a>, <a class="el" href="class_o_n___mesh.html#a061ab836e5be4150fb6501d0a0545d85">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#a7053bac2951282366b5627f3e074e767">ON_Brep</a>, <a class="el" href="class_o_n___morph_control.html#aa828f688794e960e17277492c041cd43">ON_MorphControl</a>, <a class="el" href="class_o_n___nurbs_cage.html#aaee66d13d9abde767671d8ce9c1e3659">ON_NurbsCage</a>, <a class="el" href="class_o_n___text_dot.html#a6136c7b41fbb0455b13cd842bfc584ad">ON_TextDot</a>, <a class="el" href="class_o_n___instance_ref.html#a528b4497f8b297bee6677dcd5b3ad8fb">ON_InstanceRef</a>, <a class="el" href="class_o_n___hatch.html#a15501f594f5fcfd5175328f2826493e4">ON_Hatch</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#a3da85e5e2de1216527f57e5d90a5c9af">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___instance_definition.html#a2ce678c7422c835ad4d6ce3243981af3">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___text_content.html#a943f3a702294ef8abf86df0cb82d030d">ON_TextContent</a>, <a class="el" href="class_o_n___brep_edge.html#adc1e71835bd2661548863b571b0c1e38">ON_BrepEdge</a>, <a class="el" href="class_o_n___curve.html#a825d22c88fd23b1d684234fd3bf11254">ON_Curve</a>, <a class="el" href="class_o_n___material.html#a75674551143e774a03dcdb3d7d6e9961">ON_Material</a>, <a class="el" href="class_o_n___surface.html#a2bd958c4af4819c1a4f1193c211d7b61">ON_Surface</a>, <a class="el" href="class_o_n___extrusion.html#a99b0692d2e680289868b4f298e4eaa4e">ON_Extrusion</a>, <a class="el" href="class_o_n___point_cloud.html#a598be63fc6002b0907b329a353d688cf">ON_PointCloud</a>, <a class="el" href="class_o_n___layer.html#adc9f54e68011c5604a6982893f93c5c2">ON_Layer</a>, <a class="el" href="class_o_n___annotation.html#a79a4fbdc666ebbf4b28674f297105835">ON_Annotation</a>, <a class="el" href="class_o_n___leader.html#af152f3694b74939b4b73822baa589871">ON_Leader</a>, <a class="el" href="class_o_n___point_grid.html#aa0d58e4e459776029ee634a5f4bad434">ON_PointGrid</a>, <a class="el" href="class_o_n___point.html#ac0ba584a05b7393c662fbcf7cc0a6a2f">ON_Point</a>, <a class="el" href="class_o_n___light.html#a5b425144ac7eaa29919067dab49ea8f3">ON_Light</a>, and <a class="el" href="class_o_n___detail_view.html#a9b35bf5143367d25d2c5f3c8d84a2a5f">ON_DetailView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba6166c9aecef42639e684a2a3fda223"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba6166c9aecef42639e684a2a3fda223">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_o_n___object.html">ON_Object</a>& ON_Object::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88b61cafc0024ecb7a4bd22da2718680"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88b61cafc0024ecb7a4bd22da2718680">◆ </a></span>PurgeUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Object::PurgeUserData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: <a class="el" href="class_o_n___object.html#a88b61cafc0024ecb7a4bd22da2718680">PurgeUserData()</a> removes all user data from object. <br />
|
|
Remarks: Use delete GetUserData(...) to destroy a single piece of user data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a09ac9742ead91dd8f9cdd579bcbfed10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09ac9742ead91dd8f9cdd579bcbfed10">◆ </a></span>Read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ON_Object::Read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>binary_archive</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Low level archive writing tool used by <a class="el" href="class_o_n___binary_archive.html#a025b86c1da38eb51f66d6260b1141ac3">ON_BinaryArchive::ReadObject()</a>. Parameters: binary_archive - archive to read from Returns: Returns true if the read is successful. Remarks: Use <a class="el" href="class_o_n___binary_archive.html#a025b86c1da38eb51f66d6260b1141ac3">ON_BinaryArchive::ReadObject()</a> to read objects. This <a class="el" href="class_o_n___object.html#a09ac9742ead91dd8f9cdd579bcbfed10">Read()</a> function should read the objects definition back into its data members.</p>
|
|
<p>The default implementation of this virtual function returns false and does nothing. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#abfed633bb6c0ef69b6e0dd585dffb6b2">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#a59d9ce80429fb3df537f905836e8e1ee">ON_Brep</a>, <a class="el" href="class_o_n___morph_control.html#accaa19e43fe88e4da5b1e2b1a6cfaff4">ON_MorphControl</a>, <a class="el" href="class_o_n___brep_region.html#a9ea8c5e66bac1496244a1c7096792f10">ON_BrepRegion</a>, <a class="el" href="class_o_n___brep_face_side.html#a611fa31d37d3a394f295ba3dd7a84a86">ON_BrepFaceSide</a>, <a class="el" href="class_o_n___nurbs_cage.html#a52cfd9156b0aee8bbe1253cc88fdc3a6">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#a3bed5d63aef0f2aea14e41702e7fc8d8">ON_BrepFace</a>, <a class="el" href="class_o_n___centermark.html#a76e587db46625142649a509771e8dcc3">ON_Centermark</a>, <a class="el" href="class_o_n___text_dot.html#aded2a39a5d9dc08510e89a7c4978df93">ON_TextDot</a>, <a class="el" href="class_o_n___brep_loop.html#a37ca337ceb63b62771bed2a393e5207d">ON_BrepLoop</a>, <a class="el" href="class_o_n___dim_ordinate.html#a5788297e3d926e5527ba09c5a89b3b17">ON_DimOrdinate</a>, <a class="el" href="class_o_n___dim_radial.html#a14ee565c5040a1411e8841eb64ac8b2c">ON_DimRadial</a>, <a class="el" href="class_o_n__3dm_render_settings.html#afb2f38afeb6c976dd784ed1b44556284">ON_3dmRenderSettings</a>, <a class="el" href="class_o_n___instance_ref.html#ae7327888b424aa89dd1ae2bcdea41f21">ON_InstanceRef</a>, <a class="el" href="class_o_n___hatch.html#a20f6a4af55073270f96b01d29a61a6fd">ON_Hatch</a>, <a class="el" href="class_o_n___document_user_string_list.html#a0ea0565a468c0b314e9a863bec2fa358">ON_DocumentUserStringList</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#a9274ea7d60dacae632affa1bbe13f052">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___brep_trim.html#ac2a5910e0e5a95fc1f5050dd4d217eaa">ON_BrepTrim</a>, <a class="el" href="class_o_n___embedded_bitmap.html#ac0ff97286ef9be999426b166ee8bc595">ON_EmbeddedBitmap</a>, <a class="el" href="class_o_n___windows_bitmap_ex.html#a261bf49fbb97f2400fe7eb2b38a2e5e5">ON_WindowsBitmapEx</a>, <a class="el" href="class_o_n___dim_angular.html#a6ae368256abbaa60e63422db1bf05932">ON_DimAngular</a>, <a class="el" href="class_o_n___user_string_list.html#a763cccc2c68d378982d5e3f91b0457ca">ON_UserStringList</a>, <a class="el" href="class_o_n___dim_style.html#ac50af048e15d54554d6415ea3db85ffd">ON_DimStyle</a>, <a class="el" href="class_o_n___hatch_pattern.html#afb2dfd520e14078e72144f7abe619646">ON_HatchPattern</a>, <a class="el" href="class_o_n___rdk_material_instance_id_obsolete_user_data.html#a709db64d6ccf61ab106c322d043f72e9">ON_RdkMaterialInstanceIdObsoleteUserData</a>, <a class="el" href="class_o_n___unknown_user_data.html#a6f24a8bb0ce8aef802dbaac95034386a">ON_UnknownUserData</a>, <a class="el" href="class_o_n___brep_edge.html#aea6a21741401d230c97ee21095329edb">ON_BrepEdge</a>, <a class="el" href="class_o_n___instance_definition.html#a992403be93e4d8c2cb94199c8b38bb1f">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___dim_linear.html#ad23a02387cbe9af4d2e2982120fc91c5">ON_DimLinear</a>, <a class="el" href="class_o_n___windows_bitmap.html#a6a14132f4607829e5002f3e9bd596acf">ON_WindowsBitmap</a>, <a class="el" href="class_o_n___nurbs_surface.html#a38284671127a33e47b114e398cdd4cef">ON_NurbsSurface</a>, <a class="el" href="class_o_n___text_content.html#a21d69e11dac92b9720976318fc6016a9">ON_TextContent</a>, <a class="el" href="class_o_n___curve_proxy.html#a6ae0fdc2cd9a6b1518777e7fc4e66661">ON_CurveProxy</a>, <a class="el" href="class_o_n___nurbs_curve.html#a20bbfd754a7120f47fa062625bcc8b3f">ON_NurbsCurve</a>, <a class="el" href="class_o_n___texture_mapping.html#a51951a8438dc7bad4f8b5c280316901c">ON_TextureMapping</a>, <a class="el" href="class_o_n___text_style.html#a9ecab5c5d4ac8fac0cf2eb4c2579d593">ON_TextStyle</a>, <a class="el" href="class_o_n___texture.html#a3326a65e380c9f807ccd75968bb358d0">ON_Texture</a>, <a class="el" href="class_o_n___poly_edge_segment.html#a4f2f5195ba9080417d09911a12f22a86">ON_PolyEdgeSegment</a>, <a class="el" href="class_o_n___viewport.html#a8a06417e923eab938b8d85662f46527b">ON_Viewport</a>, <a class="el" href="class_o_n___sum_surface.html#adbee9c5bdb4ffd23f01e1a1ac359592e">ON_SumSurface</a>, <a class="el" href="class_o_n___material.html#a77407f8b2361f6e1d286e571adcbed78">ON_Material</a>, <a class="el" href="class_o_n___arc_curve.html#aee27a7b34ca0fc0b0e24e620b8fcdb6f">ON_ArcCurve</a>, <a class="el" href="class_o_n___rev_surface.html#a23ae14e02fd7e5fc2eff7a6f124e7bbb">ON_RevSurface</a>, <a class="el" href="class_o_n___poly_curve.html#afddd3bcc932065e09836ba8d9da740fd">ON_PolyCurve</a>, <a class="el" href="class_o_n___linetype.html#aaaf5a5580daa88d1deec0231a426b2c0">ON_Linetype</a>, <a class="el" href="class_o_n___history_record.html#a58d57ad157045b9e86833539c915028b">ON_HistoryRecord</a>, <a class="el" href="class_o_n___brep_vertex.html#a1d3109720a666f88db20c6f2d205e0de">ON_BrepVertex</a>, <a class="el" href="class_o_n___curve_on_surface.html#ae93bff9b5f8fd4cb14d58a9bb818d33d">ON_CurveOnSurface</a>, <a class="el" href="class_o_n___surface_proxy.html#a82346774c98be3988f2e4c0f1fd3746f">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___polyline_curve.html#a28f7d0430b86227aa222aabf95a67fb9">ON_PolylineCurve</a>, <a class="el" href="class_o_n___extrusion.html#a298263370b7df126faa631b927610546">ON_Extrusion</a>, <a class="el" href="class_o_n___point_cloud.html#a59569e82832510b6ea1e46c4a3e8e101">ON_PointCloud</a>, <a class="el" href="class_o_n___line_curve.html#ab3c26f8efc4193bd15d87aeba5dfebfd">ON_LineCurve</a>, <a class="el" href="class_o_n___layer.html#ac3811a5484243f17df6e2db352065b86">ON_Layer</a>, <a class="el" href="class_o_n___leader.html#abaf4abf7d186c3fe731d6d97e7758bed">ON_Leader</a>, <a class="el" href="class_o_n___plane_surface.html#ab02a9b74306133519bb4e763f10db751">ON_PlaneSurface</a>, <a class="el" href="class_o_n__3dm_object_attributes.html#a9cd98a06569b9a350eecc0d7ac1e04af">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___text.html#a8f7780bf3db60ff150045f7ca922d062">ON_Text</a>, <a class="el" href="class_o_n___bitmap.html#a28a8c209412cf63d69357e079c5d9698">ON_Bitmap</a>, <a class="el" href="class_o_n___point_grid.html#abcd1fd7979d0df3553fb041c77d026bc">ON_PointGrid</a>, <a class="el" href="class_o_n___point.html#ad61fc098b41e795fe37fa4701f0ef3a8">ON_Point</a>, <a class="el" href="class_o_n___light.html#a41e5c4cc08eab7549fd72047f567e786">ON_Light</a>, and <a class="el" href="class_o_n___detail_view.html#ad797a5ba37d2c5ef8a4c5a59145aa13c">ON_DetailView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab728c0576fd5913bc1575b74997bddb5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab728c0576fd5913bc1575b74997bddb5">◆ </a></span>SetComponentStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::SetComponentStates </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON_COMPONENT_INDEX </td>
|
|
<td class="paramname"><em>component_index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> </td>
|
|
<td class="paramname"><em>states_to_set</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Set states on an individual component. Parameters: component_index - [in] The states will be set on this component. states_to_set - [in] If a state is set in the states_to_set parameter, the same state will be set on the component. <br />
|
|
Returns: 0: no state settings changed on the component. 1: some state setting changed on the component. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#a703f85321db5662984469699838b1a55">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a589f1fdc28f6259d1bd22bdedc9c4c76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a589f1fdc28f6259d1bd22bdedc9c4c76">◆ </a></span>SetComponentStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::SetComponentStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON_COMPONENT_INDEX </td>
|
|
<td class="paramname"><em>component_index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___component_status.html">ON_ComponentStatus</a> </td>
|
|
<td class="paramname"><em>status_to_copy</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Copy status settings to an individual component. Parameters: component_index - [in] The states will be copied to this component. status_to_copy - [in] Returns: 0: no state settings changed on the component. 1: some state setting changed on the component. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___brep.html#ab2e0a29061c67a33020fee98cf4880e5">ON_Brep</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a074dc9e9b919853919564793c37f5143"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a074dc9e9b919853919564793c37f5143">◆ </a></span>SetUserString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_Object::SetUserString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>BEGIN: User string support <br />
|
|
Description: Attach a user string to the object. This information will perisist through copy construction, operator=, and file IO. Parameters: key - [in] id used to retrieve this string. string_value - [in] If nullptr, the string with this id will be removed. Returns: True if successful. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7234af898c307a2c2f7931db7e627592"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7234af898c307a2c2f7931db7e627592">◆ </a></span>SetUserStrings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ON_Object::SetUserStrings </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___user_string.html">ON_UserString</a> * </td>
|
|
<td class="paramname"><em>user_strings</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>bReplace</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Append entries to the user string list Parameters: count - [in] number of element in us[] array user_strings - [in] entries to append. bReplace - [in] If bReplace is true, then existing entries with the same key are updated with the new entry's value. If bReplace is false, then existing entries are not updated. Returns: Number of entries added, deleted, or modified. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0299df21bfed90d7b5bfb24cdcf5e6c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0299df21bfed90d7b5bfb24cdcf5e6c1">◆ </a></span>SizeOf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual unsigned int ON_Object::SizeOf </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: An estimate of the amount of memory the class uses in bytes. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh_component_ref.html#ac8e97fcc75f82448c0ada393e1210b4c">ON_MeshComponentRef</a>, <a class="el" href="class_o_n___mesh.html#a795963e1da89ea2d8aed31fe5f79365c">ON_Mesh</a>, <a class="el" href="class_o_n___morph_control.html#a15df346bb909425765426c0f082c7bf2">ON_MorphControl</a>, <a class="el" href="class_o_n___brep.html#af190638468ee5f2cc813788d5a6156dd">ON_Brep</a>, <a class="el" href="class_o_n___nurbs_cage.html#aafd6ba72ecd772e6ea6c92c4281ed327">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#a149c2d00ec96a009b3d94fc7d71e88f0">ON_BrepFace</a>, <a class="el" href="class_o_n___brep_loop.html#a6695f6f4744dc183613fedd6e1a3ef80">ON_BrepLoop</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#a47e3e1dd3e01edf38bb4e331bc3b3b77">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___embedded_bitmap.html#af1805ebbdafac49bea06d3c202a03aa6">ON_EmbeddedBitmap</a>, <a class="el" href="class_o_n___user_string_list.html#ac9f59aa3f19d340b54ac0e027d406489">ON_UserStringList</a>, <a class="el" href="class_o_n___brep_trim.html#a1f28f7ed19868c36c6821fd559b38b55">ON_BrepTrim</a>, <a class="el" href="class_o_n___unknown_user_data.html#a51981ddfd19111300fb2579ce0fe6440">ON_UnknownUserData</a>, <a class="el" href="class_o_n___instance_definition.html#a07e2e3c36e256b216a3a4b1da20a8984">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___windows_bitmap.html#aa717ec45c04675b49c833ccd6297ba14">ON_WindowsBitmap</a>, <a class="el" href="class_o_n___brep_edge.html#ae60a760809743ec450d71017c35db331">ON_BrepEdge</a>, <a class="el" href="class_o_n___texture_mapping.html#a436f4f5076bb3e6ed1f261f50a8dad12">ON_TextureMapping</a>, <a class="el" href="class_o_n___texture.html#a1281f48c880344e5b8007e8a876c7f7b">ON_Texture</a>, <a class="el" href="class_o_n___sum_surface.html#a989350a4b5e6066beeed301ee218b8c3">ON_SumSurface</a>, <a class="el" href="class_o_n___curve.html#af13b163bb51b3972593f6ccf89d18950">ON_Curve</a>, <a class="el" href="class_o_n___nurbs_surface.html#a15201baa278c14beb628a68eb6685593">ON_NurbsSurface</a>, <a class="el" href="class_o_n___rev_surface.html#a8e0f752fe49bdac378e3423f2180cf53">ON_RevSurface</a>, <a class="el" href="class_o_n___surface.html#a2f753f161c711fb529aa98649757beee">ON_Surface</a>, <a class="el" href="class_o_n___nurbs_curve.html#a519796fb199145d307fd14579ebc0db3">ON_NurbsCurve</a>, <a class="el" href="class_o_n___brep_vertex.html#a37e959db01f17feb6a4c4c6c39c29ef5">ON_BrepVertex</a>, <a class="el" href="class_o_n___poly_curve.html#a1afa5ee6dd28cd871df014c487e787fc">ON_PolyCurve</a>, <a class="el" href="class_o_n___extrusion.html#a6f1a287bb48e7e4f93d38de2bf12e9c2">ON_Extrusion</a>, <a class="el" href="class_o_n___curve_proxy.html#afa7eaa521aa400bc4447ad136686c5d0">ON_CurveProxy</a>, <a class="el" href="class_o_n___surface_proxy.html#a262e0711c4a33aaa3d3cc5a53865ba6b">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___curve_on_surface.html#abf79215907936dbe20a8e5812385a68c">ON_CurveOnSurface</a>, <a class="el" href="class_o_n___bitmap.html#af48bdba89bf0d7bea023050f9496e44c">ON_Bitmap</a>, <a class="el" href="class_o_n__3dm_object_attributes.html#a99f0e35de70fd4094ad1cf3a4e3cc00e">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___line_curve.html#a8cd438d91bdfd442c1366722634bfe0b">ON_LineCurve</a>, <a class="el" href="class_o_n___polyline_curve.html#a6ce7960090187e209917c86b06198eb3">ON_PolylineCurve</a>, <a class="el" href="class_o_n___arc_curve.html#a796d146d8ed38375fcec02e855fdb08a">ON_ArcCurve</a>, <a class="el" href="class_o_n___plane_surface.html#a88b97dade249ae1c44467ae664a61a90">ON_PlaneSurface</a>, <a class="el" href="class_o_n___user_data.html#ad1a2a8978fac04ffe1d1c801598add0c">ON_UserData</a>, <a class="el" href="class_o_n___detail_view.html#acb10c561f8fb388c4448974512c9e39d">ON_DetailView</a>, and <a class="el" href="class_o_n___model_component.html#a61423322e2092534d438235969b22c99">ON_ModelComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a881bd2f0d8515adba1c42c578bcb7052"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a881bd2f0d8515adba1c42c578bcb7052">◆ </a></span>TransformUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_Object::TransformUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___xform.html">ON_Xform</a> & </td>
|
|
<td class="paramname"><em>xform</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Objects derived from <a class="el" href="class_o_n___geometry.html">ON_Geometry</a> must call <a class="el" href="class_o_n___object.html#a881bd2f0d8515adba1c42c578bcb7052">TransformUserData()</a> in their Transform() member function. Parameters: xform - [in] transformation to apply to user data </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82188bbf97bbd149ac6fcb7cd8e989d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82188bbf97bbd149ac6fcb7cd8e989d1">◆ </a></span>UpdateReferencedComponents()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ON_Object::UpdateReferencedComponents </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___component_manifest.html">ON_ComponentManifest</a> & </td>
|
|
<td class="paramname"><em>source_manifest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___component_manifest.html">ON_ComponentManifest</a> & </td>
|
|
<td class="paramname"><em>destination_manifest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___manifest_map.html">ON_ManifestMap</a> & </td>
|
|
<td class="paramname"><em>manifest_map</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Uses the destination_manifest to update references to other components. This is typically done when a component's references came from a "source" context and are being updated to the "destination" context. For example, inserting one model into another when index, id, and name conflicts need to be resolved at the time of insertion. Parameters: source_manifest - [in] A manifest of the source context with indices and ids corresponding to the current component references. If this manifest is not available, pass <a class="el" href="class_o_n___component_manifest.html#a7a838571207b4e5a8771c7aacffec086">ON_ComponentManifest::Empty</a>. destination_manifest - [in] A manifest of the destination context with indices and ids corresponding to the desired component references. If this manifest is not available, pass <a class="el" href="class_o_n___component_manifest.html#a7a838571207b4e5a8771c7aacffec086">ON_ComponentManifest::Empty</a>. manifest_map - [in] A map from the source (current) referenced component index/id values to the destination (desired) component index/id values. Returns: True if successful. False indicates a referenced component was not found in the manifest and the reference was changed to a default value. Example: If this object is an <a class="el" href="class_o_n___layer.html">ON_Layer</a>, the line pattern and render material references are updated. If this object is an <a class="el" href="class_o_n___dim_style.html">ON_DimStyle</a>, the text style reference is updated. If this object is an <a class="el" href="class_o_n__3dm_object_attributes.html">ON_3dmObjectAttributes</a>, the layer, material, line pattern, and group references are updated. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n__3dm_object_attributes.html#a963c44ce06dc827439e0bb2fcc69a423">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___layer.html#ac103e9d13ea3a0dfced466cfebe2fede">ON_Layer</a>, and <a class="el" href="class_o_n___model_geometry_component.html#a041313017d0628da4e7089750de91306">ON_ModelGeometryComponent</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab648403ebf4592831809710f378e9ac2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab648403ebf4592831809710f378e9ac2">◆ </a></span>UserStringCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ON_Object::UserStringCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: Number of user strings on the object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16eb9ab6bf0d0a614655cf9cd055871a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16eb9ab6bf0d0a614655cf9cd055871a">◆ </a></span>Write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ON_Object::Write </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>binary_archive</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Low level archive writing tool used by <a class="el" href="class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a>. Parameters: binary_archive - archive to write to Returns: Returns true if the write is successful. Remarks: Use <a class="el" href="class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a> to write objects. This <a class="el" href="class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">Write()</a> function should just write the specific definition of this object. It should not write and any chunk typecode or length information. <br />
|
|
The default implementation of this virtual function returns false and does nothing. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___mesh.html#ad4d8ee57465bcf4458dc5fbb55628423">ON_Mesh</a>, <a class="el" href="class_o_n___brep.html#aad0786db5f64f6c921b8ab4e595fc34a">ON_Brep</a>, <a class="el" href="class_o_n___morph_control.html#a8de5dd50abb1a15d6f83cf758c8bd71c">ON_MorphControl</a>, <a class="el" href="class_o_n___brep_region.html#afd1a26a64b5468dce1c0ba3d7b22e935">ON_BrepRegion</a>, <a class="el" href="class_o_n___brep_face_side.html#ad3dfb7c858abc8c1efcf9c67ed47d0ce">ON_BrepFaceSide</a>, <a class="el" href="class_o_n___nurbs_cage.html#aa106381e3deef0a9c2159a92a4e5cb69">ON_NurbsCage</a>, <a class="el" href="class_o_n___brep_face.html#a105bbad3e6b71f4cc7842bb50bb27e52">ON_BrepFace</a>, <a class="el" href="class_o_n___centermark.html#a8f86b8424c630625a3a777929cfeb711">ON_Centermark</a>, <a class="el" href="class_o_n___text_dot.html#a1604480c63cbc796ba356df3fc34c778">ON_TextDot</a>, <a class="el" href="class_o_n___brep_loop.html#a86b716bb133aa4718616b9970633d606">ON_BrepLoop</a>, <a class="el" href="class_o_n___dim_ordinate.html#a4eac3cee474f8398ddc2574c51295880">ON_DimOrdinate</a>, <a class="el" href="class_o_n___dim_radial.html#a1114b0fd3f6b8389cae99fe543037c20">ON_DimRadial</a>, <a class="el" href="class_o_n__3dm_render_settings.html#adc6e677218b22020d81a0c2d591ecc57">ON_3dmRenderSettings</a>, <a class="el" href="class_o_n___instance_ref.html#a1e41ccd0c848c92924f91b03355578d8">ON_InstanceRef</a>, <a class="el" href="class_o_n___hatch.html#a73e5a59c152cc5aa049cfe0d546deb18">ON_Hatch</a>, <a class="el" href="class_o_n___document_user_string_list.html#a7a57cd94b00011a6108df70507d3c839">ON_DocumentUserStringList</a>, <a class="el" href="class_o_n___clipping_plane_surface.html#a1a93074a42a7e29a210bae50d2b59c5e">ON_ClippingPlaneSurface</a>, <a class="el" href="class_o_n___brep_trim.html#a33826bfa338192531ea819a58d5305a4">ON_BrepTrim</a>, <a class="el" href="class_o_n___embedded_bitmap.html#afc8846c83b20f0c1455b49ef8bd0a975">ON_EmbeddedBitmap</a>, <a class="el" href="class_o_n___windows_bitmap_ex.html#ab1f100478c87ae1d093455f124f9984e">ON_WindowsBitmapEx</a>, <a class="el" href="class_o_n___dim_angular.html#a99a8bd8f7e61d069f0e5d2973ae8e6c6">ON_DimAngular</a>, <a class="el" href="class_o_n___user_string_list.html#a798cd70e4110292428d094399702a9a8">ON_UserStringList</a>, <a class="el" href="class_o_n___dim_style.html#ae0c1382a2e6be8e6ac666b89db861bbf">ON_DimStyle</a>, <a class="el" href="class_o_n___hatch_pattern.html#ae9546e6d25778313c96067627dba80d3">ON_HatchPattern</a>, <a class="el" href="class_o_n___rdk_material_instance_id_obsolete_user_data.html#af0915fe40a2ace950da1230841b32f70">ON_RdkMaterialInstanceIdObsoleteUserData</a>, <a class="el" href="class_o_n___unknown_user_data.html#a30479b2861385442a19ade3b3809773b">ON_UnknownUserData</a>, <a class="el" href="class_o_n___brep_edge.html#af8e31469541aeeafb368444b099dea64">ON_BrepEdge</a>, <a class="el" href="class_o_n___windows_bitmap.html#af5d128811cce6f8bca8c1035bd69e53d">ON_WindowsBitmap</a>, <a class="el" href="class_o_n___dim_linear.html#a5229dbe9f29d97b2e70f9e545d6026b2">ON_DimLinear</a>, <a class="el" href="class_o_n___instance_definition.html#ae6928f5c4f62a9bdf738aa050329dabf">ON_InstanceDefinition</a>, <a class="el" href="class_o_n___nurbs_surface.html#a33cdca32f2bb2e41d795e2a7d38a4b26">ON_NurbsSurface</a>, <a class="el" href="class_o_n___text_content.html#a0b71579459f7b46543ae5a1a500a6852">ON_TextContent</a>, <a class="el" href="class_o_n___curve_proxy.html#aaf1ec09354192fdcaad958b954aebe6f">ON_CurveProxy</a>, <a class="el" href="class_o_n___nurbs_curve.html#ad7c8d550cd0321d43d586d8de9e6ce28">ON_NurbsCurve</a>, <a class="el" href="class_o_n___texture_mapping.html#abf7c5fb8a77432d72dd4b02148e076c8">ON_TextureMapping</a>, <a class="el" href="class_o_n___text_style.html#a59315e8803e05e0750e0af66b6598f67">ON_TextStyle</a>, <a class="el" href="class_o_n___texture.html#abf8385e277851e7fd77a396fa3335de2">ON_Texture</a>, <a class="el" href="class_o_n___poly_edge_segment.html#a17a1470ad648e689deef903d8ea9a6a3">ON_PolyEdgeSegment</a>, <a class="el" href="class_o_n___viewport.html#a1f0830c05fa17fa557fbba83f8184df1">ON_Viewport</a>, <a class="el" href="class_o_n___sum_surface.html#a0d8491833f1590cf550dffcd05ed4b3f">ON_SumSurface</a>, <a class="el" href="class_o_n___material.html#ad9034ace9ef32a8be1fc6d45d5303f53">ON_Material</a>, <a class="el" href="class_o_n___arc_curve.html#a32ebf4073c59286c41bf1f59b2a8f7a6">ON_ArcCurve</a>, <a class="el" href="class_o_n___rev_surface.html#afc9c978c3182ac256e0ae7cb9b70240c">ON_RevSurface</a>, <a class="el" href="class_o_n___poly_curve.html#affd7018462a1960f2db6d721e7ba242a">ON_PolyCurve</a>, <a class="el" href="class_o_n___history_record.html#ace3ef47e5dabca5527af5b6a2b33f486">ON_HistoryRecord</a>, <a class="el" href="class_o_n___linetype.html#ac4fe808ccd6936bb095ca8ff0c228181">ON_Linetype</a>, <a class="el" href="class_o_n___brep_vertex.html#a4d0b51045033ed0353fda92f014a2524">ON_BrepVertex</a>, <a class="el" href="class_o_n___curve_on_surface.html#ad6d09b8d2b835b7f022a15743fb1f7c9">ON_CurveOnSurface</a>, <a class="el" href="class_o_n___surface_proxy.html#ae5b08dc1a0e9a7dd58f9ed59f3f6c286">ON_SurfaceProxy</a>, <a class="el" href="class_o_n___extrusion.html#a6dc8967b7fcb5f3c23b2fa0452f4712b">ON_Extrusion</a>, <a class="el" href="class_o_n___polyline_curve.html#affd49d10f587780ed149fbd3dd35f6e8">ON_PolylineCurve</a>, <a class="el" href="class_o_n___point_cloud.html#a76b20e54dbe62d88636aa52fff5d1f20">ON_PointCloud</a>, <a class="el" href="class_o_n___leader.html#a9556e880060f23e915264b52b6ef1aee">ON_Leader</a>, <a class="el" href="class_o_n___line_curve.html#a6523d3b5d4c717ca064332cef0270d7a">ON_LineCurve</a>, <a class="el" href="class_o_n___layer.html#aa69d126f27d6b164c00af7c499a93b8f">ON_Layer</a>, <a class="el" href="class_o_n___plane_surface.html#a2eb6ac597c0a8a82c5ff00b55c1753a8">ON_PlaneSurface</a>, <a class="el" href="class_o_n__3dm_object_attributes.html#a1ff9a435b0801d07d9f0b1d29563d00c">ON_3dmObjectAttributes</a>, <a class="el" href="class_o_n___bitmap.html#a58e8f1d7f42cea88e802e79866085b2b">ON_Bitmap</a>, <a class="el" href="class_o_n___text.html#ab7cc6214f9adcb5c5792c964d7fa4fe4">ON_Text</a>, <a class="el" href="class_o_n___point_grid.html#a876fc88c180d236c5ca8764ec060e4ed">ON_PointGrid</a>, <a class="el" href="class_o_n___point.html#ac3a0b34671b4428704d974176fd83b6c">ON_Point</a>, <a class="el" href="class_o_n___light.html#a3888efdfc3a39dc368b5d1b8111cbd34">ON_Light</a>, and <a class="el" href="class_o_n___detail_view.html#a8afded4a7b6cee1aff860dad78f1bd34">ON_DetailView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jan 25 2018 17:01:11 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>
|