mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 23:57:58 +08:00
550 lines
30 KiB
HTML
550 lines
30 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_ClassId 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
|
|
</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-static-methods">Static Public Member Functions</a> |
|
|
<a href="../../de/d88/class_o_n___class_id-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_ClassId Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>used for runtime class identification
|
|
<a href="../../d3/d3c/class_o_n___class_id.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="../../d6/d95/opennurbs__object_8h_source.html">opennurbs_object.h</a>></code></p>
|
|
<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:a54d44e5890083a7c0fd477759d1d43e9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a54d44e5890083a7c0fd477759d1d43e9">ON_ClassId</a> (const char *sClassName, const char *sBaseClassName, class <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> *(*create)(), const char *sUUID)</td></tr>
|
|
<tr class="separator:a54d44e5890083a7c0fd477759d1d43e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9118867ca2ca89f90d20c6b2746224cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a9118867ca2ca89f90d20c6b2746224cf">~ON_ClassId</a> ()</td></tr>
|
|
<tr class="separator:a9118867ca2ca89f90d20c6b2746224cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b5ace262e3fe33a154d59a34fcc9744"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a2b5ace262e3fe33a154d59a34fcc9744">BaseClass</a> () const</td></tr>
|
|
<tr class="separator:a2b5ace262e3fe33a154d59a34fcc9744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a213c017c6eb384425856c8fbcf6658e8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a213c017c6eb384425856c8fbcf6658e8">BaseClassName</a> () const</td></tr>
|
|
<tr class="separator:a213c017c6eb384425856c8fbcf6658e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06c2b9c1f70b797fdb586fc3d6768ef5"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a06c2b9c1f70b797fdb586fc3d6768ef5">ClassIdVersion</a> () const</td></tr>
|
|
<tr class="separator:a06c2b9c1f70b797fdb586fc3d6768ef5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e5486ffb5f4aa9c069808032875df10"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a7e5486ffb5f4aa9c069808032875df10">ClassName</a> () const</td></tr>
|
|
<tr class="separator:a7e5486ffb5f4aa9c069808032875df10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f29ec11f87ee922648c4cee3937d270"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a9f29ec11f87ee922648c4cee3937d270">Create</a> () const</td></tr>
|
|
<tr class="separator:a9f29ec11f87ee922648c4cee3937d270"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec97b48a16781f306ca2d9eb126722a2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#aec97b48a16781f306ca2d9eb126722a2">IsDerivedFrom</a> (const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> *potential_parent) const</td></tr>
|
|
<tr class="separator:aec97b48a16781f306ca2d9eb126722a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af522a7bce6100fca29e9161ffbcd8dc3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#af522a7bce6100fca29e9161ffbcd8dc3">Mark</a> () const</td></tr>
|
|
<tr class="separator:af522a7bce6100fca29e9161ffbcd8dc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48cc5db89ba692ec60d3e53b4ba8fc6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a48cc5db89ba692ec60d3e53b4ba8fc6b">Uuid</a> () const</td></tr>
|
|
<tr class="separator:a48cc5db89ba692ec60d3e53b4ba8fc6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aebdde874ae6c99f1f09fcc0d52ee01d4"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#aebdde874ae6c99f1f09fcc0d52ee01d4">ClassId</a> (const char *sClassName)</td></tr>
|
|
<tr class="separator:aebdde874ae6c99f1f09fcc0d52ee01d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab69d80706421aa3212dce90100d6be34"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#ab69d80706421aa3212dce90100d6be34">ClassId</a> (<a class="el" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> class_uuid)</td></tr>
|
|
<tr class="separator:ab69d80706421aa3212dce90100d6be34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac188318d4a8956db15f88bcaf7c44017"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#ac188318d4a8956db15f88bcaf7c44017">CurrentMark</a> ()</td></tr>
|
|
<tr class="separator:ac188318d4a8956db15f88bcaf7c44017"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ca575224586a8d6a7b82a0bbe13aa32"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a9ca575224586a8d6a7b82a0bbe13aa32">Dump</a> (<a class="el" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a> &dump)</td></tr>
|
|
<tr class="separator:a9ca575224586a8d6a7b82a0bbe13aa32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6388d6acfbfdc85fef591c09a7f1dfbf"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a6388d6acfbfdc85fef591c09a7f1dfbf">IncrementMark</a> ()</td></tr>
|
|
<tr class="separator:a6388d6acfbfdc85fef591c09a7f1dfbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ea9a03a2f5203ef9f42606cfa0ab0cb"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a6ea9a03a2f5203ef9f42606cfa0ab0cb">LastClassId</a> ()</td></tr>
|
|
<tr class="separator:a6ea9a03a2f5203ef9f42606cfa0ab0cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b01403171a9c6c88a9fe8fc15eaa969"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#a8b01403171a9c6c88a9fe8fc15eaa969">Purge</a> (int mark)</td></tr>
|
|
<tr class="separator:a8b01403171a9c6c88a9fe8fc15eaa969"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaed744675535eb780d4fd9311eae74cd"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d3c/class_o_n___class_id.html#aaed744675535eb780d4fd9311eae74cd">PurgeAfter</a> (const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> *pClassId)</td></tr>
|
|
<tr class="separator:aaed744675535eb780d4fd9311eae74cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>used for runtime class identification </p>
|
|
<p>Description: OpenNURBS classes derived from <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> use <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> to store run-time type information <br />
|
|
The ON_OBJECT_DECLARE and ON_OBJECT_IMPLEMENT macros generate the code that creates and initializes the <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> for each class.</p>
|
|
<p>The <a class="el" href="../../d9/d7b/class_o_n___object.html#afe5367058a90545e81cd79b78103175d">ON_Object::IsKindOf()</a> and ON_Object::Cast() functions use this run-time type information. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a54d44e5890083a7c0fd477759d1d43e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54d44e5890083a7c0fd477759d1d43e9">◆ </a></span>ON_ClassId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_ClassId::ON_ClassId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>sClassName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>sBaseClassName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">class <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> *(*)() </td>
|
|
<td class="paramname"><em>create</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>sUUID</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: This constructor is called to initialize each class id. The call is generated by the ON_OBJECT_IMPLEMENT macro.</p>
|
|
<p>Parameters: sClassName - [in] name of the class (like <a class="el" href="../../df/de0/class_o_n___geometry.html">ON_Geometry</a>) sBaseClassName - [in] name of baseclass (like <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>) create - [in] function to create a new object(like CreateNewON_Geometry()) sUUID - [in] UUID in registry format from Windows guidgen.exe </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9118867ca2ca89f90d20c6b2746224cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9118867ca2ca89f90d20c6b2746224cf">◆ </a></span>~ON_ClassId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_ClassId::~ON_ClassId </td>
|
|
<td>(</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="a2b5ace262e3fe33a154d59a34fcc9744"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b5ace262e3fe33a154d59a34fcc9744">◆ </a></span>BaseClass()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ON_ClassId::BaseClass </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: base class id </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a213c017c6eb384425856c8fbcf6658e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a213c017c6eb384425856c8fbcf6658e8">◆ </a></span>BaseClassName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ON_ClassId::BaseClassName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: base class name </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aebdde874ae6c99f1f09fcc0d52ee01d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebdde874ae6c99f1f09fcc0d52ee01d4">◆ </a></span>ClassId() <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">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ON_ClassId::ClassId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>sClassName</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Gets a class's <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> from the class's name. Parameters: sClassName - [in] name of class Returns: Pointer to the class's <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a>. Example: const ON_ClassId* brep_id = ON_CLassId::ClassId("ON_Brep"); </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab69d80706421aa3212dce90100d6be34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab69d80706421aa3212dce90100d6be34">◆ </a></span>ClassId() <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">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ON_ClassId::ClassId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> </td>
|
|
<td class="paramname"><em>class_uuid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Gets a class's <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> from the class's uuid. Parameters: class_uuid - [in] uuid for the class Returns: Pointer to the class's <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a>. Example: ON_UUID brep_uuid = ON_UuidFromString("60B5DBC5-E660-11d3-BFE4-0010830122F0"); const ON_ClassId* brep_id = ON_ClassId::ClassId(brep_uuid); </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06c2b9c1f70b797fdb586fc3d6768ef5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06c2b9c1f70b797fdb586fc3d6768ef5">◆ </a></span>ClassIdVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_ClassId::ClassIdVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e5486ffb5f4aa9c069808032875df10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e5486ffb5f4aa9c069808032875df10">◆ </a></span>ClassName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ON_ClassId::ClassName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: class name </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f29ec11f87ee922648c4cee3937d270"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f29ec11f87ee922648c4cee3937d270">◆ </a></span>Create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a>* ON_ClassId::Create </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Descrption: Use the default constructor to create an instance of the class on the heap. Returns: Null or a pointer to an instance of the class created using new and the class's default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac188318d4a8956db15f88bcaf7c44017"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac188318d4a8956db15f88bcaf7c44017">◆ </a></span>CurrentMark()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int ON_ClassId::CurrentMark </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ca575224586a8d6a7b82a0bbe13aa32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ca575224586a8d6a7b82a0bbe13aa32">◆ </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">static void ON_ClassId::Dump </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d2/da3/class_o_n___text_log.html">ON_TextLog</a> & </td>
|
|
<td class="paramname"><em>dump</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Dumps the <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> list Parameters: dump - [in] destination for the text dump. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6388d6acfbfdc85fef591c09a7f1dfbf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6388d6acfbfdc85fef591c09a7f1dfbf">◆ </a></span>IncrementMark()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int ON_ClassId::IncrementMark </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Each class derived from <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> has a corresponding <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> stored in a linked list and the class is marked with an integer value. <a class="el" href="../../d3/d3c/class_o_n___class_id.html#a6388d6acfbfdc85fef591c09a7f1dfbf">ON_ClassId::IncrementMark()</a> increments the value used to mark new classes and returns the new marking value. Returns: Value that will be used to mark all future ON_ClassIds. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aec97b48a16781f306ca2d9eb126722a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aec97b48a16781f306ca2d9eb126722a2">◆ </a></span>IsDerivedFrom()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_ClassId::IsDerivedFrom </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td>
|
|
<td class="paramname"><em>potential_parent</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Determine if the class associated with this <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> is derived from another class. Parameters: potential_parent - [in] Class to test as parent. Returns: true if this is derived from potential_parent. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ea9a03a2f5203ef9f42606cfa0ab0cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ea9a03a2f5203ef9f42606cfa0ab0cb">◆ </a></span>LastClassId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a>* ON_ClassId::LastClassId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af522a7bce6100fca29e9161ffbcd8dc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af522a7bce6100fca29e9161ffbcd8dc3">◆ </a></span>Mark()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ON_ClassId::Mark </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Opennurbs classes have a mark value of 0. Core Rhino classes have a mark value of 1. Rhino plug-in classes have a mark value of > 1. Returns: Class mark value </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b01403171a9c6c88a9fe8fc15eaa969"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b01403171a9c6c88a9fe8fc15eaa969">◆ </a></span>Purge()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int ON_ClassId::Purge </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>mark</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description: Each class derived from <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> has a corresponding <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> stored in a linked list. If a class definition is going to disappear (which happens when the derived object definition is in a DLL that uses openNURBS as a DLL and the DLL containing the derived object's definition is unloaded), then the class's <a class="el" href="../../d3/d3c/class_o_n___class_id.html" title="used for runtime class identification ">ON_ClassId</a> needs to be removed from the class list. ON_ClassId::Purge( mark ) removes all ON_ClassIds with a a prescribed mark and returns the number of classes that were purged. <br />
|
|
Parameters: mark - [in] All ON_ClassIds with this mark will be purged. Returns: Number of classes that were purged. Example: ///< Call <a class="el" href="../../d3/d3c/class_o_n___class_id.html#a6388d6acfbfdc85fef591c09a7f1dfbf">ON_ClassId::IncrementMark()</a> BEFORE loading MY.DLL. int my_dll_classid_mark = <a class="el" href="../../d3/d3c/class_o_n___class_id.html#a6388d6acfbfdc85fef591c09a7f1dfbf">ON_ClassId::IncrementMark()</a>; load MY.DLL with classes derived from <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a> ... ///< Call <a class="el" href="../../d3/d3c/class_o_n___class_id.html#a8b01403171a9c6c88a9fe8fc15eaa969">ON_ClassId::Purge()</a> BEFORE unloading MY.DLL. ON_ClassId::Purge( my_dll_classid_mark ); unload MY.DLL </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaed744675535eb780d4fd9311eae74cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaed744675535eb780d4fd9311eae74cd">◆ </a></span>PurgeAfter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool ON_ClassId::PurgeAfter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d3/d3c/class_o_n___class_id.html">ON_ClassId</a> * </td>
|
|
<td class="paramname"><em>pClassId</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a48cc5db89ba692ec60d3e53b4ba8fc6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48cc5db89ba692ec60d3e53b4ba8fc6b">◆ </a></span>Uuid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../d8/db4/struct_o_n___u_u_i_d__struct.html">ON_UUID</a> ON_ClassId::Uuid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: class uuid </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jan 26 2018 12:38:21 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>
|