mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
901 lines
71 KiB
HTML
901 lines
71 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_UserData Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">openNURBS SDK Help
|
|
 <span id="projectnumber">6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="class_o_n___user_data-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_UserData Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="opennurbs__userdata_8h_source.html">opennurbs_userdata.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ON_UserData:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_o_n___user_data.png" usemap="#ON_5FUserData_map" alt=""/>
|
|
<map id="ON_5FUserData_map" name="ON_5FUserData_map">
|
|
<area href="class_o_n___object.html" alt="ON_Object" shape="rect" coords="274,0,538,24"/>
|
|
<area href="class_o_n___obsolete_user_data.html" alt="ON_ObsoleteUserData" shape="rect" coords="0,112,264,136"/>
|
|
<area href="class_o_n___unknown_user_data.html" alt="ON_UnknownUserData" shape="rect" coords="274,112,538,136"/>
|
|
<area href="class_o_n___user_string_list.html" alt="ON_UserStringList" shape="rect" coords="548,112,812,136"/>
|
|
<area href="class_o_n___rdk_material_instance_id_obsolete_user_data.html" alt="ON_RdkMaterialInstanceIdObsoleteUserData" shape="rect" coords="0,168,264,192"/>
|
|
</map>
|
|
</div></div>
|
|
<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:af84978b48b525d91a7dacd7c79a946a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#af84978b48b525d91a7dacd7c79a946a0">ON_UserData</a> ()</td></tr>
|
|
<tr class="separator:af84978b48b525d91a7dacd7c79a946a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7bde9b2a277291e400cd404b5aa719f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#ae7bde9b2a277291e400cd404b5aa719f">ON_UserData</a> (const <a class="el" href="class_o_n___user_data.html">ON_UserData</a> &)</td></tr>
|
|
<tr class="separator:ae7bde9b2a277291e400cd404b5aa719f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea16cf84e3e8d130429fbad6a89d8afb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#aea16cf84e3e8d130429fbad6a89d8afb">~ON_UserData</a> ()</td></tr>
|
|
<tr class="separator:aea16cf84e3e8d130429fbad6a89d8afb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a696c161022b62755144071fa2e524471"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a696c161022b62755144071fa2e524471">Archive</a> () const</td></tr>
|
|
<tr class="separator:a696c161022b62755144071fa2e524471"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6402122c4eca34f611d799467b1085c0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a6402122c4eca34f611d799467b1085c0">DeleteAfterRead</a> (const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive, class <a class="el" href="class_o_n___object.html">ON_Object</a> *parent_object) const</td></tr>
|
|
<tr class="separator:a6402122c4eca34f611d799467b1085c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b3841446e0e618da58009ba6cb23c38"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a7b3841446e0e618da58009ba6cb23c38">DeleteAfterWrite</a> (const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive, const class <a class="el" href="class_o_n___object.html">ON_Object</a> *parent_object) const</td></tr>
|
|
<tr class="separator:a7b3841446e0e618da58009ba6cb23c38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63fe722a03f7e436318e1ac90ef6629c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a63fe722a03f7e436318e1ac90ef6629c">Dump</a> (<a class="el" href="class_o_n___text_log.html">ON_TextLog</a> &text_log) const override</td></tr>
|
|
<tr class="separator:a63fe722a03f7e436318e1ac90ef6629c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad15c20abc80a6e84042659f92466d252"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#ad15c20abc80a6e84042659f92466d252">GetDescription</a> (<a class="el" href="class_o_n__w_string.html">ON_wString</a> &description)</td></tr>
|
|
<tr class="separator:ad15c20abc80a6e84042659f92466d252"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd0e8c02a6fc9d55124e69d6b7a4a848"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#abd0e8c02a6fc9d55124e69d6b7a4a848">IsUnknownUserData</a> () const</td></tr>
|
|
<tr class="separator:abd0e8c02a6fc9d55124e69d6b7a4a848"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fc0cc7d050eb71a1e290acaceadf036"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a1fc0cc7d050eb71a1e290acaceadf036">IsValid</a> (class <a class="el" href="class_o_n___text_log.html">ON_TextLog</a> *text_log=nullptr) const override</td></tr>
|
|
<tr class="separator:a1fc0cc7d050eb71a1e290acaceadf036"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e5a0d01e000319e0b37b340752613d8"><td class="memItemLeft" align="right" valign="top"><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___user_data.html#a5e5a0d01e000319e0b37b340752613d8">Next</a> () const</td></tr>
|
|
<tr class="separator:a5e5a0d01e000319e0b37b340752613d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade73a474aee256f4f0bd16a36453e7e3"><td class="memItemLeft" align="right" valign="top"><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___user_data.html#ade73a474aee256f4f0bd16a36453e7e3">operator=</a> (const <a class="el" href="class_o_n___user_data.html">ON_UserData</a> &)</td></tr>
|
|
<tr class="separator:ade73a474aee256f4f0bd16a36453e7e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8be601c28a29d212cf9e6807795a9e3"><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___user_data.html#ab8be601c28a29d212cf9e6807795a9e3">Owner</a> () const</td></tr>
|
|
<tr class="memdesc:ab8be601c28a29d212cf9e6807795a9e3"><td class="mdescLeft"> </td><td class="mdescRight">Returns object that owns the user data. <a href="#ab8be601c28a29d212cf9e6807795a9e3">More...</a><br /></td></tr>
|
|
<tr class="separator:ab8be601c28a29d212cf9e6807795a9e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1a2a8978fac04ffe1d1c801598add0c"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#ad1a2a8978fac04ffe1d1c801598add0c">SizeOf</a> () const override</td></tr>
|
|
<tr class="separator:ad1a2a8978fac04ffe1d1c801598add0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab18bd52ff384d3a8bf4a45f52e9a2a52"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">Transform</a> (const <a class="el" href="class_o_n___xform.html">ON_Xform</a> &)</td></tr>
|
|
<tr class="separator:ab18bd52ff384d3a8bf4a45f52e9a2a52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb5b2c6d59f627eda5c12f80ca3ad0a9"><td class="memItemLeft" align="right" valign="top"><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___user_data.html#afb5b2c6d59f627eda5c12f80ca3ad0a9">UserDataClassUuid</a> () const</td></tr>
|
|
<tr class="separator:afb5b2c6d59f627eda5c12f80ca3ad0a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8be4ec33db51b21abc267fd505af01c2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a8be4ec33db51b21abc267fd505af01c2">WriteToArchive</a> (const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive, const class <a class="el" href="class_o_n___object.html">ON_Object</a> *parent_object) const</td></tr>
|
|
<tr class="separator:a8be4ec33db51b21abc267fd505af01c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_o_n___object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_o_n___object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_o_n___object.html">ON_Object</a></td></tr>
|
|
<tr class="memitem:af580c6199f4469c49a4e09a117626c10 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a274166b34d06fc07a85997fd01b2dab1 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad940aab7d51005c8732d76d1b188e332 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a1cfab63437a2d03cc50fdc6734f2a5 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5432b341051664c185b10712a6e5b79 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27893ff72ca7abbe985f8b5f4ccd900e inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1af75ebe418edff4a11985f8fca7d83b inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeadf76a46f3f1a661bbf41e1b754fe89 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad044157e5c1efde9fce1c6ccf6e81ff3 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58958333257eba5575a6a1b09c366c1b inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af51d5fcec9379ad9b7a56ac4dfc9a8b2 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa67be7d8cc76ec82ae22a30093ecf98f inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8435c33ab53af41c22dac75e8917569 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dbb0eff3b2287152b40991b3afca9ee inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad265ca0da2d751edaa9d2b5ab2540c6a inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb43bb324c44740c4bc2932e2f95c835 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a691de6470e814973858aa5c51eaffa77 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29f8d609e22008680581c6ca72ac47df inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab40b5e89b4766299e415593b31a3849c inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac285fba1506b2b9b821e3655582939c4 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004ab49490f69fcdc7681919c3837a33 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe5367058a90545e81cd79b78103175d inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a609192fbafecbe4be3136d8cb4dce882 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0674ccb79b6333e4b3c8e95ee10dd73 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21c508d3b53458e252adbcd29e62ed09 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78b4ecb2eb36641e1ee6b4fc6129606e inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54a891ae2cb2a25008a7a39cb19dfcea inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa19aee4a411a8fda53aff00bd02d86e inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba6166c9aecef42639e684a2a3fda223 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88b61cafc0024ecb7a4bd22da2718680 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09ac9742ead91dd8f9cdd579bcbfed10 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab728c0576fd5913bc1575b74997bddb5 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a589f1fdc28f6259d1bd22bdedc9c4c76 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a074dc9e9b919853919564793c37f5143 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7234af898c307a2c2f7931db7e627592 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a881bd2f0d8515adba1c42c578bcb7052 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82188bbf97bbd149ac6fcb7cd8e989d1 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab648403ebf4592831809710f378e9ac2 inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16eb9ab6bf0d0a614655cf9cd055871a inherit pub_methods_class_o_n___object"><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 inherit pub_methods_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a35de7701c976903efed96e0839175a79"><td class="memItemLeft" align="right" valign="top"><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___user_data.html#a35de7701c976903efed96e0839175a79">m_application_uuid</a></td></tr>
|
|
<tr class="separator:a35de7701c976903efed96e0839175a79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac025400e9bff35c899ed85ba1b0a52e4"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#ac025400e9bff35c899ed85ba1b0a52e4">m_userdata_copycount</a></td></tr>
|
|
<tr class="separator:ac025400e9bff35c899ed85ba1b0a52e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9bc044ba84a529fe2195d8f8a817fda2"><td class="memItemLeft" align="right" valign="top"><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___user_data.html#a9bc044ba84a529fe2195d8f8a817fda2">m_userdata_uuid</a></td></tr>
|
|
<tr class="separator:a9bc044ba84a529fe2195d8f8a817fda2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42a4c08cd237304ded7a66175484e773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_o_n___xform.html">ON_Xform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a42a4c08cd237304ded7a66175484e773">m_userdata_xform</a></td></tr>
|
|
<tr class="separator:a42a4c08cd237304ded7a66175484e773"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a388c1bb17a1958935b83aa90bdb81597"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a388c1bb17a1958935b83aa90bdb81597">ON_BinaryArchive::ReadObject</a> (<a class="el" href="class_o_n___object.html">ON_Object</a> **)</td></tr>
|
|
<tr class="separator:a388c1bb17a1958935b83aa90bdb81597"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a929bc4bfb74b631aad84d72d8dfa52bc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a929bc4bfb74b631aad84d72d8dfa52bc">ON_BinaryArchive::ReadObjectUserData</a> (<a class="el" href="class_o_n___object.html">ON_Object</a> &)</td></tr>
|
|
<tr class="separator:a929bc4bfb74b631aad84d72d8dfa52bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78e80f926947c21f2f7494146325514f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a78e80f926947c21f2f7494146325514f">ON_BinaryArchive::WriteObject</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &)</td></tr>
|
|
<tr class="separator:a78e80f926947c21f2f7494146325514f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaef580befd8f9cb134ec2d62a41aca4c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#aaef580befd8f9cb134ec2d62a41aca4c">ON_BinaryArchive::WriteObjectUserData</a> (const <a class="el" href="class_o_n___object.html">ON_Object</a> &)</td></tr>
|
|
<tr class="separator:aaef580befd8f9cb134ec2d62a41aca4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74d2407f4d1e26bb80d3a5b69feb24db"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___user_data.html#a74d2407f4d1e26bb80d3a5b69feb24db">ON_Object</a></td></tr>
|
|
<tr class="memdesc:a74d2407f4d1e26bb80d3a5b69feb24db"><td class="mdescLeft"> </td><td class="mdescRight">< don't look and don't touch - these may change <a href="#a74d2407f4d1e26bb80d3a5b69feb24db">More...</a><br /></td></tr>
|
|
<tr class="separator:a74d2407f4d1e26bb80d3a5b69feb24db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_class_o_n___object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_o_n___object')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_o_n___object.html">ON_Object</a></td></tr>
|
|
<tr class="memitem:a7f520e987ffa14e71b06493340f9956c inherit pub_types_class_o_n___object"><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 inherit pub_types_class_o_n___object"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section rcs"><dt>NoKeywords</dt><dd></dd></dl>
|
|
<p><br />
|
|
/ / Copyright (c) 1993-2012 Robert McNeel & Associates. All rights reserved. / OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert / McNeel & Associates. / / THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. / ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF / MERCHANTABILITY ARE HEREBY DISCLAIMED. / <br />
|
|
/ For complete openNURBS copyright information see <a href="http://www.opennurbs.org">http://www.opennurbs.org</a>. / ////////////////////////////////////////////////////////////// </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af84978b48b525d91a7dacd7c79a946a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af84978b48b525d91a7dacd7c79a946a0">◆ </a></span>ON_UserData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_UserData::ON_UserData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7bde9b2a277291e400cd404b5aa719f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7bde9b2a277291e400cd404b5aa719f">◆ </a></span>ON_UserData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_UserData::ON_UserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___user_data.html">ON_UserData</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea16cf84e3e8d130429fbad6a89d8afb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea16cf84e3e8d130429fbad6a89d8afb">◆ </a></span>~ON_UserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_UserData::~ON_UserData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The destructor automatically removes the user data from ON_Object::m_userdata_list. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a696c161022b62755144071fa2e524471"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a696c161022b62755144071fa2e524471">◆ </a></span>Archive()</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_UserData::Archive </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: If <a class="el" href="class_o_n___user_data.html#a696c161022b62755144071fa2e524471">Archive()</a> returns true, m_application_uuid is not nil, and the virtual <a class="el" href="class_o_n___object.html#a09ac9742ead91dd8f9cdd579bcbfed10">Read()</a> and <a class="el" href="class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">Write()</a> are functions are overridden, then this user data will be written to and read from 3dm archives.</p>
|
|
<p>Returns: true if user data should be saved in binary archives. false if the user data should not be saved in binary archives.</p>
|
|
<p>Remarks: The default implementation returns false. If you override <a class="el" href="class_o_n___user_data.html#a696c161022b62755144071fa2e524471">ON_UserData::Archive</a> so that it returns true, then your constructor must set m_application_uuid, you must override the virtual <a class="el" href="class_o_n___object.html#a09ac9742ead91dd8f9cdd579bcbfed10">ON_Object::Read</a> and <a class="el" href="class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">ON_Object::Write</a> functions and you must CAREFULLY TEST your code.</p>
|
|
<p><a class="el" href="class_o_n___user_data.html">ON_UserData</a> requires expert programming and testing skills.</p>
|
|
<p>If you need to know more details about the archive or parent object to determine if the userdata should be saved, then override <a class="el" href="class_o_n___user_data.html#a8be4ec33db51b21abc267fd505af01c2">WriteToArchive()</a>.</p>
|
|
<p>YOU SHOULD READ AND UNDERSTAND EVERY COMMENT IN THIS HEADER FILE IN BEFORE ATTEMPTING TO USE <a class="el" href="class_o_n___user_data.html">ON_UserData</a>. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___user_string_list.html#afb6304711747d938bc31cc98cb8a05ff">ON_UserStringList</a>, and <a class="el" href="class_o_n___unknown_user_data.html#a8874aaf005c8fd52b64f3e4fd184772a">ON_UnknownUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6402122c4eca34f611d799467b1085c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6402122c4eca34f611d799467b1085c0">◆ </a></span>DeleteAfterRead()</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_UserData::DeleteAfterRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>archive</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">class <a class="el" href="class_o_n___object.html">ON_Object</a> * </td>
|
|
<td class="paramname"><em>parent_object</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: <a class="el" href="class_o_n___user_data.html#a6402122c4eca34f611d799467b1085c0">DeleteAfterRead()</a> is used when opennurbs is reading earlier versions of 3dm archives that used some type of user data that has since become obsolete.</p>
|
|
<p>Parameters: archive - [in] archive that was read from. If needed, you can inspect the version of 3dm archive this is being saved and other information that you may need to determine the approprite return value. parent_object - [in] If needed, you can inspect the parent object to determine the approprite return value.</p>
|
|
<p>Returns: True if the user data should be deleted because the information it contains has been added to the parent object using the methods that are current. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b3841446e0e618da58009ba6cb23c38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b3841446e0e618da58009ba6cb23c38">◆ </a></span>DeleteAfterWrite()</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_UserData::DeleteAfterWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>archive</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___object.html">ON_Object</a> * </td>
|
|
<td class="paramname"><em>parent_object</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: <a class="el" href="class_o_n___user_data.html#a7b3841446e0e618da58009ba6cb23c38">DeleteAfterWrite()</a> is used when opennurbs is writing earlier versions of 3dm archives that used some type of user data that has since become obsolete.</p>
|
|
<p>Parameters: archive - [in] archive that will be written to. <br />
|
|
If needed, you can inspect the version of 3dm archive this is being saved and other information that you may need to determine the approprite return value. parent_object - [in] If needed, you can inspect the parent object to determine the approprite return value.</p>
|
|
<p>Returns: True if the user data should be written the next time the parent object is saved to a 3dm archive and then deleted.</p>
|
|
<p>Remarks: Typically, <a class="el" href="class_o_n___user_data.html#a7b3841446e0e618da58009ba6cb23c38">DeleteAfterWrite()</a> is used in the situation where 1) User data was used to add information to an opennurbs class whose data fields could not be modified because the SDK was fixed at the time. 2) Once the class data fields could be modified, the new data fields were added to the class and the user data from step 1 became obsolete. 3) The class's Write function is called and the value of <a class="el" href="class_o_n___binary_archive.html#ae80a449e465462b4e70cb9031347bf39">ON_BinaryArchive::Archive3dmVersion()</a> corresponds to the version of the 3dm archive that was being saved in step 1. The write function fills in and attaches the obsolete user data to the class. When <a class="el" href="class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a> writes the obsolete user data to the earlier version file, it then deletes it. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63fe722a03f7e436318e1ac90ef6629c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63fe722a03f7e436318e1ac90ef6629c">◆ </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">void ON_UserData::Dump </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___text_log.html">ON_TextLog</a> & </td>
|
|
<td class="paramname"><em>text_log</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Overrides virtual <a class="el" href="class_o_n___object.html#a21c7b04a80f1806c3a45f72d7c491a44">ON_Object::Dump()</a>. Prints class name, description, and uuid. Parameters: text_log - [in] Information is sent to this text log. Remarks: </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_o_n___object.html#a21c7b04a80f1806c3a45f72d7c491a44">ON_Object</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___user_string_list.html#a415ed9e24d897b5c099b45c5a3154272">ON_UserStringList</a>, and <a class="el" href="class_o_n___unknown_user_data.html#abcc720715407a7b964334097b4a904a0">ON_UnknownUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad15c20abc80a6e84042659f92466d252"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad15c20abc80a6e84042659f92466d252">◆ </a></span>GetDescription()</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_UserData::GetDescription </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n__w_string.html">ON_wString</a> & </td>
|
|
<td class="paramname"><em>description</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>Parameters: description - [out] description of user data shown in object properties dump. Returns: True if user data class is ready. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___user_string_list.html#a5960039c2dd4f602eef7b166ccb25c01">ON_UserStringList</a>, <a class="el" href="class_o_n___rdk_material_instance_id_obsolete_user_data.html#a28017d9c70cdfa0dbb8d5bca8c8d0e01">ON_RdkMaterialInstanceIdObsoleteUserData</a>, and <a class="el" href="class_o_n___unknown_user_data.html#a34cd850b6c900a5c3c3bc6094cfbdd40">ON_UnknownUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd0e8c02a6fc9d55124e69d6b7a4a848"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd0e8c02a6fc9d55124e69d6b7a4a848">◆ </a></span>IsUnknownUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_UserData::IsUnknownUserData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns true if the user data is anonymous. This happens when the user data class is not defined at the time the user data is read from an archive. For example, if a class derived from <a class="el" href="class_o_n___user_data.html">ON_UserData</a> is defined in application A but is not defined in application B, then the class can be defined when an archive is written by A but not exist when an archive is read by B. In this case, the user data is not lost, it is just read as <a class="el" href="class_o_n___unknown_user_data.html">ON_UnknownUserData</a> by application B. If application B saves the parent object in an archive, the unknown user data is resaved in a form that can be read by application A. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1fc0cc7d050eb71a1e290acaceadf036"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1fc0cc7d050eb71a1e290acaceadf036">◆ </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">bool ON_UserData::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">override</span><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 from <a class="el" href="class_o_n___object.html#a7212696724553dc4d365479a10150c0d">ON_Object</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___unknown_user_data.html#a88118e622df8c2ba9d678b866b0422d4">ON_UnknownUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e5a0d01e000319e0b37b340752613d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e5a0d01e000319e0b37b340752613d8">◆ </a></span>Next()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_o_n___user_data.html">ON_UserData</a>* ON_UserData::Next </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used for traversing list of user data attached to an object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade73a474aee256f4f0bd16a36453e7e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade73a474aee256f4f0bd16a36453e7e3">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_o_n___user_data.html">ON_UserData</a>& ON_UserData::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___user_data.html">ON_UserData</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8be601c28a29d212cf9e6807795a9e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8be601c28a29d212cf9e6807795a9e3">◆ </a></span>Owner()</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_UserData::Owner </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns object that owns the user data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1a2a8978fac04ffe1d1c801598add0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1a2a8978fac04ffe1d1c801598add0c">◆ </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">unsigned int ON_UserData::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Overrides virtual <a class="el" href="class_o_n___object.html#a0299df21bfed90d7b5bfb24cdcf5e6c1">ON_Object::SizeOf()</a>. Returns: Approximate number of bytes this class uses. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_o_n___object.html#a0299df21bfed90d7b5bfb24cdcf5e6c1">ON_Object</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___user_string_list.html#ac9f59aa3f19d340b54ac0e027d406489">ON_UserStringList</a>, and <a class="el" href="class_o_n___unknown_user_data.html#a51981ddfd19111300fb2579ce0fe6440">ON_UnknownUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab18bd52ff384d3a8bf4a45f52e9a2a52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab18bd52ff384d3a8bf4a45f52e9a2a52">◆ </a></span>Transform()</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_UserData::Transform </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_o_n___xform.html">ON_Xform</a> & </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: If <a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">Transform()</a> return false, then the userdata is destroyed when its parent object is transformed. The default <a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">Transform()</a> updates m_userdata_xform and returns true. Carefully read the comments above m_userdata_xform </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb5b2c6d59f627eda5c12f80ca3ad0a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb5b2c6d59f627eda5c12f80ca3ad0a9">◆ </a></span>UserDataClassUuid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_UserData::UserDataClassUuid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns the class id which is not necessarily the same as m_userdata_uuid. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8be4ec33db51b21abc267fd505af01c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8be4ec33db51b21abc267fd505af01c2">◆ </a></span>WriteToArchive()</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_UserData::WriteToArchive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>archive</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="class_o_n___object.html">ON_Object</a> * </td>
|
|
<td class="paramname"><em>parent_object</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: If <a class="el" href="class_o_n___user_data.html#a8be4ec33db51b21abc267fd505af01c2">WriteToArchive()</a> returns true, m_application_uuid is not nil, and the virtual <a class="el" href="class_o_n___object.html#a09ac9742ead91dd8f9cdd579bcbfed10">Read()</a> and <a class="el" href="class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">Write()</a> are functions are overridden, then this user data will be written to and read from the identified archive.</p>
|
|
<p>Parameters: archive - [in] The archive being written to. Typically, you will test archive.Archive3dmVersion() to deterime if your userdata should be saved. parent_object - [in] The object managing this userdata. Returns: true if user data should be saved in the binary archives. false if the user data should not be saved in binary archives.</p>
|
|
<p>Remarks: The default implementation calls the legacy <a class="el" href="class_o_n___user_data.html#a696c161022b62755144071fa2e524471">Archive()</a> function. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_o_n___rdk_material_instance_id_obsolete_user_data.html#a3fbdaff52bb1d870300878cb8006c903">ON_RdkMaterialInstanceIdObsoleteUserData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="a388c1bb17a1958935b83aa90bdb81597"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a388c1bb17a1958935b83aa90bdb81597">◆ </a></span>ON_BinaryArchive::ReadObject</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int <a class="el" href="class_o_n___binary_archive.html#a025b86c1da38eb51f66d6260b1141ac3">ON_BinaryArchive::ReadObject</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html">ON_Object</a> ** </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a929bc4bfb74b631aad84d72d8dfa52bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a929bc4bfb74b631aad84d72d8dfa52bc">◆ </a></span>ON_BinaryArchive::ReadObjectUserData</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="class_o_n___binary_archive.html#a825cbf5578079c948c4c0d3038221828">ON_BinaryArchive::ReadObjectUserData</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_o_n___object.html">ON_Object</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78e80f926947c21f2f7494146325514f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78e80f926947c21f2f7494146325514f">◆ </a></span>ON_BinaryArchive::WriteObject</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b">ON_BinaryArchive::WriteObject</a> </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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaef580befd8f9cb134ec2d62a41aca4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaef580befd8f9cb134ec2d62a41aca4c">◆ </a></span>ON_BinaryArchive::WriteObjectUserData</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="class_o_n___binary_archive.html#a8aea3fda7a970d69323f151e3ab40382">ON_BinaryArchive::WriteObjectUserData</a> </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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74d2407f4d1e26bb80d3a5b69feb24db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74d2407f4d1e26bb80d3a5b69feb24db">◆ </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">friend class <a class="el" href="class_o_n___object.html">ON_Object</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>< don't look and don't touch - these may change </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a35de7701c976903efed96e0839175a79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35de7701c976903efed96e0839175a79">◆ </a></span>m_application_uuid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_UserData::m_application_uuid</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: This uuid is used to identify the application that created this piece of user data. In the case of Rhino, this is the id of the plug-in that created the user data. User data with a nil application id will not be saved in 3dm archives. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac025400e9bff35c899ed85ba1b0a52e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac025400e9bff35c899ed85ba1b0a52e4">◆ </a></span>m_userdata_copycount</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_UserData::m_userdata_copycount</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If m_userdata_copycount is 0, user data is not copied when object is copied. If > 0, user data is copied and m_copycount is incremented when parent object is copied. The user data's <a class="el" href="class_o_n___user_data.html#ade73a474aee256f4f0bd16a36453e7e3">operator=()</a> is used to copy. <br />
|
|
The default <a class="el" href="class_o_n___user_data.html#af84978b48b525d91a7dacd7c79a946a0">ON_UserData::ON_UserData()</a> constructor sets m_userdata_copycount to zero. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9bc044ba84a529fe2195d8f8a817fda2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9bc044ba84a529fe2195d8f8a817fda2">◆ </a></span>m_userdata_uuid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_UserData::m_userdata_uuid</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: This uuid is the value that must be passed to <a class="el" href="class_o_n___object.html#a29f8d609e22008680581c6ca72ac47df">ON_Object::GetUserData()</a> to retrieve this piece of user data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42a4c08cd237304ded7a66175484e773"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42a4c08cd237304ded7a66175484e773">◆ </a></span>m_userdata_xform</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_o_n___xform.html">ON_Xform</a> ON_UserData::m_userdata_xform</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Updated if user data is attached to a piece of geometry that is transformed and the virtual <a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">ON_UserData::Transform()</a> is not overridden. If you override <a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">ON_UserData::Transform()</a> and want m_userdata_xform to be updated, then call the <a class="el" href="class_o_n___user_data.html#ab18bd52ff384d3a8bf4a45f52e9a2a52">ON_UserData::Transform()</a> in your override. The default constructor sets m_userdata_xform to the identity. </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>
|