lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-27 09:06:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Publish!

Browse Source 
Generated from v6.0.11315.11111-test13
This commit is contained in:
Bozo
2018-02-02 07:57:49 -08:00
parent db96b72945
commit 9af473956f
957 changed files with 32952 additions and 16598 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
6/df/d05/class_o_n___buffer.html
View File

@@ -77,8 +77,10 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a774b8d06f510e12889725affe1e750bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a774b8d06f510e12889725affe1e750bc">ClearLastError</a> ()</td></tr>
<tr class="separator:a774b8d06f510e12889725affe1e750bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab419542485bc354732e11b6134c1de2b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b">Compact</a> ()</td></tr>
<tr class="memdesc:ab419542485bc354732e11b6134c1de2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return unused memory to heap. <a href="#ab419542485bc354732e11b6134c1de2b">More...</a><br /></td></tr>
<tr class="separator:ab419542485bc354732e11b6134c1de2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962c3308c3d85963642c0ca1242d0ac7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7">Compress</a> (<a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;compressed_buffer) const</td></tr>
<tr class="memdesc:a962c3308c3d85963642c0ca1242d0ac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress this buffer <a href="#a962c3308c3d85963642c0ca1242d0ac7">More...</a><br /></td></tr>
<tr class="separator:a962c3308c3d85963642c0ca1242d0ac7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d1193d7082b2272f46e63bc791871b"><td class="memItemLeft" align="right" valign="top">ON__UINT32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a63d1193d7082b2272f46e63bc791871b">CRC32</a> (ON__UINT32 current_remainder) const</td></tr>
<tr class="separator:a63d1193d7082b2272f46e63bc791871b"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -99,6 +101,7 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:ade07e24604407bc13946604493190852"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ade07e24604407bc13946604493190852">Read</a> (ON__UINT64 size, void *buffer)</td></tr>
<tr class="separator:ade07e24604407bc13946604493190852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2f22301086b369308341e48c2bc70bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd">ReadFromBinaryArchive</a> (<a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;)</td></tr>
<tr class="memdesc:aa2f22301086b369308341e48c2bc70bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that was written using <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a>. <a href="#aa2f22301086b369308341e48c2bc70bd">More...</a><br /></td></tr>
<tr class="separator:aa2f22301086b369308341e48c2bc70bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab21bb47895df1d9c1ac028d7e980ed95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ab21bb47895df1d9c1ac028d7e980ed95">Seek</a> (ON__INT64 offset, int origin)</td></tr>
<tr class="separator:ab21bb47895df1d9c1ac028d7e980ed95"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -113,15 +116,18 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:ad3b0f5eb7718c67ab6c741733ff520d2"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size</a> () const</td></tr>
<tr class="separator:ad3b0f5eb7718c67ab6c741733ff520d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aff04cf9629d75cd859d93f4f801cf8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a4aff04cf9629d75cd859d93f4f801cf8">Uncompress</a> (<a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;uncompressed_buffer) const</td></tr>
<tr class="memdesc:a4aff04cf9629d75cd859d93f4f801cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncompress this buffer which must have been compressed using <a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7" title="Compress this buffer ">ON_Buffer::Compress()</a>. <a href="#a4aff04cf9629d75cd859d93f4f801cf8">More...</a><br /></td></tr>
<tr class="separator:a4aff04cf9629d75cd859d93f4f801cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7484357266d9bb7546d27f24ac96fe2d"><td class="memItemLeft" align="right" valign="top">ON__UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a7484357266d9bb7546d27f24ac96fe2d">Write</a> (ON__UINT64 size, const void *buffer)</td></tr>
<tr class="separator:a7484357266d9bb7546d27f24ac96fe2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec84100d33a87ed3dc327166405717a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a">WriteToBinaryArchive</a> (<a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &amp;) const</td></tr>
<tr class="memdesc:a6ec84100d33a87ed3dc327166405717a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a> to save an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> inside a binary archive. Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> from the <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>. <a href="#a6ec84100d33a87ed3dc327166405717a">More...</a><br /></td></tr>
<tr class="separator:a6ec84100d33a87ed3dc327166405717a"><td class="memSeparator" colspan="2">&#160;</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:a168da7c4e4572c07a7ecc27006b92a28"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d05/class_o_n___buffer.html#a168da7c4e4572c07a7ecc27006b92a28">Compare</a> (const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;a, const <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> &amp;b)</td></tr>
<tr class="memdesc:a168da7c4e4572c07a7ecc27006b92a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare contents of buffers. Paramters: a - [in] b - [in] <a href="#a168da7c4e4572c07a7ecc27006b92a28">More...</a><br /></td></tr>
<tr class="separator:a168da7c4e4572c07a7ecc27006b92a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
@@ -212,7 +218,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: True if <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> == <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>. Remarks: It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#a399e0b3b25725f8b64e3d0113102fe4f">AtEnd()</a> will return false. </p>
<dl class="section return"><dt>Returns</dt><dd>True if <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> == <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#a399e0b3b25725f8b64e3d0113102fe4f">AtEnd()</a> will return false. </p>
</div>
</div>
@@ -231,7 +238,14 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: buffer_size - [in] new size of buffer. Returns: True if successful. Remarks: The current position is not changed and may be beyond the end of the file. Use Seek to set the current position after calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ac771b73243d8a308765a5d2e53f6a041">ChangeSize()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer_size</td><td>[in] new size of buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
<p>The current position is not changed and may be beyond the end of the file. Use Seek to set the current position after calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ac771b73243d8a308765a5d2e53f6a041">ChangeSize()</a>. </p>
</div>
</div>
@@ -266,7 +280,9 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Return unused memory to heap. Remarks: Call this function after creating an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that will persist for and extended amount of time. There are never more than 16 pages of unsued memory (16*4096 bytes on most computers) in an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a>. <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b">Compact()</a> can be called at any time, but calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b">Compact()</a> the then writing at the end of the buffer is not an efficient use of time or memory. </p>
<p>Return unused memory to heap. </p>
<p>Call this function after creating an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that will persist for and extended amount of time. There are never more than 16 pages of unsued memory (16*4096 bytes on most computers) in an <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a>. <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b" title="Return unused memory to heap. ">Compact()</a> can be called at any time, but calling <a class="el" href="../../df/d05/class_o_n___buffer.html#ab419542485bc354732e11b6134c1de2b" title="Return unused memory to heap. ">Compact()</a> the then writing at the end of the buffer is not an efficient use of time or memory. </p>
</div>
</div>
@@ -303,7 +319,9 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Compare contents of buffers. Paramters: a - [in] b - [in] Returns: -1: a &lt; b 0: a == b 1: a &gt; b </p>
<p>Compare contents of buffers. Paramters: a - [in] b - [in] </p>
<dl class="section return"><dt>Returns</dt><dd>-1: a &lt; b 0: a == b 1: a &gt; b </dd></dl>
</div>
</div>
@@ -322,12 +340,16 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Compress this buffer</p>
<p>Parameters: compressed_buffer - [out] (The reference can be *this)</p>
<p>Example:</p>
<p>/ compress a buffer in place <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer; buffer = ...; if ( !buffer.Compress(buffer) ) { / compression failed } else { / buffer is now compressed }</p>
<p>Returns: True if successful. False if failed. </p>
<p>Compress this buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">compressed_buffer</td><td>[out] (The reference can be *this) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if failed. </dd></dl>
<div class="fragment"><div class="line">@verbatim</div><div class="line"> <span class="comment">// compress a buffer in place</span></div><div class="line"> <a class="code" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer;</div><div class="line"> buffer = ...;</div><div class="line"> <span class="keywordflow">if</span> ( !buffer.Compress(buffer) )</div><div class="line"> {</div><div class="line"> <span class="comment">// compression failed</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> {</div><div class="line"> <span class="comment">// buffer is now compressed</span></div><div class="line"> }</div><div class="line"><span class="keyword">@end</span>verbatim</div></div><!-- fragment -->
</div>
</div>
<a id="a63d1193d7082b2272f46e63bc791871b"></a>
@@ -345,7 +367,7 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: 32-bit CRC of the buffer contents. Remarks: </p>
<dl class="section return"><dt>Returns</dt><dd>32-bit CRC of the buffer contents. </dd></dl>
</div>
</div>
@@ -363,7 +385,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Current position in the buffer. Remarks: It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>Current position in the buffer. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
</div>
</div>
@@ -433,7 +456,6 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns True if the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> is valid. </p>
</div>
</div>
@@ -451,7 +473,7 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Value that identifies most recent error. 0: no error 1: attempt to seek to a negative position </p>
<dl class="section return"><dt>Returns</dt><dd>Value that identifies most recent error. 0: no error 1: attempt to seek to a negative position </dd></dl>
</div>
</div>
@@ -498,7 +520,15 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: size - [in] number of bytes to read. buffer - [out] read values are returned in buffer. Returns: Number of bytes read into buffer. For example, if <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> and size &gt; (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) and buffer is not null, then the value (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) is returned. Remarks: If the size parameter is zero, then nothing is done. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, attempts to read more than (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) bytes do not generate an error. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &gt; <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, any attempt to read generates an error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>[in] number of bytes to read.</td></tr>
<tr><td class="paramname">buffer</td><td>[out] read values are returned in buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes read into buffer. For example, if <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> and size &gt; (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) and buffer is not null, then the value (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) is returned. </dd></dl>
<p>If the size parameter is zero, then nothing is done. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &lt;= <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, attempts to read more than (<a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a> - <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a>) bytes do not generate an error. When <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> &gt; <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>, any attempt to read generates an error. </p>
</div>
</div>
@@ -517,7 +547,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd">ReadFromBinaryArchive()</a> to retrieve an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that was written using <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a">WriteToBinaryArchive()</a>. </p>
<p>Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> that was written using <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a>. </p>
</div>
</div>
@@ -546,7 +577,15 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: offset - [in] number of bytes to seek from origin origin - [in] initial position. 0 (SEEK_SET) Seek from beginning of file. 1 (SEEK_CUR) Seek from current position. 2 (SEEK_END) Seek from end of file. Returns: True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. Remarks: Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from origin</td></tr>
<tr><td class="paramname">origin</td><td>[in] initial position. 0 (SEEK_SET) Seek from beginning of file. 1 (SEEK_CUR) Seek from current position. 2 (SEEK_END) Seek from end of file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
@@ -565,7 +604,14 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: offset - [in] number of bytes to seek from the current position. Returns: True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. Remarks: Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from the current position.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
@@ -584,7 +630,14 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: offset - [in] number of bytes to seek from the end fo the buffer. Returns: True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. Remarks: Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] number of bytes to seek from the end fo the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
@@ -603,7 +656,14 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: offset - [in] (&gt;= 0) number of bytes to seek from the start of the buffer. Returns: True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. Remarks: Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>[in] (&gt;= 0) number of bytes to seek from the start of the buffer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if the seek would result in a file position before the beginning of the file. If false is returned, the current position is not changed. </dd></dl>
<p>Seeking beyond the end of the buffer is succeeds. Seeking before the beginning of the buffer fails. </p>
</div>
</div>
@@ -639,7 +699,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Number of bytes currently in the buffer. Remarks: It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes currently in the buffer. </dd></dl>
<p>It is possible to seek beyond the end of the buffer. In this case, the current position will be past the end of the buffer and <a class="el" href="../../df/d05/class_o_n___buffer.html#aa5c119332f2df68db38bc7046db3cdb0">CurrentPosition()</a> will be greater than <a class="el" href="../../df/d05/class_o_n___buffer.html#ad3b0f5eb7718c67ab6c741733ff520d2">Size()</a>. </p>
</div>
</div>
@@ -658,11 +719,16 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Uncompress this buffer which must have been compressed using <a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7">ON_Buffer::Compress()</a>.</p>
<p>Parameters: uncompressed_buffer - [out] (The reference can be *this)</p>
<p>Example: / silly example that compresses and then uncompresses a buffer in place / to show how to call the functions. <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer; buffer = ...; ///&lt; buffer is in it uncompressed form if ( buffer.Compress(buffer) ) { / buffer is now compressed if ( buffer.Uncompress(buffer) ) { / buffer is uncompressed again. } }</p>
<p>Returns: True if successful. False if failed. </p>
<p>Uncompress this buffer which must have been compressed using <a class="el" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7" title="Compress this buffer ">ON_Buffer::Compress()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uncompressed_buffer</td><td>[out] (The reference can be *this) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. False if failed. </dd></dl>
<div class="fragment"><div class="line"><span class="comment">// silly example that compresses and then uncompresses a buffer in place</span></div><div class="line"><span class="comment">// to show how to call the functions.</span></div><div class="line"><a class="code" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> buffer;</div><div class="line">buffer = ...; <span class="comment">// buffer is in it uncompressed form</span></div><div class="line"><span class="keywordflow">if</span> ( buffer.<a class="code" href="../../df/d05/class_o_n___buffer.html#a962c3308c3d85963642c0ca1242d0ac7">Compress</a>(buffer) )</div><div class="line">{</div><div class="line"> <span class="comment">// buffer is now compressed</span></div><div class="line"> <span class="keywordflow">if</span> ( buffer.<a class="code" href="../../df/d05/class_o_n___buffer.html#a4aff04cf9629d75cd859d93f4f801cf8">Uncompress</a>(buffer) )</div><div class="line"> {</div><div class="line"> <span class="comment">// buffer is uncompressed again.</span></div><div class="line"> }</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a7484357266d9bb7546d27f24ac96fe2d"></a>
@@ -690,7 +756,14 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: size - [in] number of bytes to write. buffer - [in] values to write. Returns: Number of bytes written buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>[in] number of bytes to write.</td></tr>
<tr><td class="paramname">buffer</td><td>[in] values to write.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written buffer. </dd></dl>
</div>
</div>
@@ -709,7 +782,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Use <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a">WriteToBinaryArchive()</a> to save an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> inside a binary archive. Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd">ReadFromBinaryArchive()</a> to retrieve the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> from the <a class="el" href="../../db/d16/class_o_n___binary_archive.html" title="&lt; use for generic serialization of binary data ">ON_BinaryArchive</a>. </p>
<p>Use <a class="el" href="../../df/d05/class_o_n___buffer.html#a6ec84100d33a87ed3dc327166405717a" title="Use WriteToBinaryArchive() to save an entire ON_Buffer inside a binary archive. Use ReadFromBinaryArc...">WriteToBinaryArchive()</a> to save an entire <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> inside a binary archive. Use <a class="el" href="../../df/d05/class_o_n___buffer.html#aa2f22301086b369308341e48c2bc70bd" title="Use ReadFromBinaryArchive() to retrieve an entire ON_Buffer that was written using WriteToBinaryArchi...">ReadFromBinaryArchive()</a> to retrieve the <a class="el" href="../../df/d05/class_o_n___buffer.html">ON_Buffer</a> from the <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>. </p>
</div>
</div>
@@ -719,7 +793,7 @@ Static Public Member Functions</h2></td></tr>
</div> <!-- page-content -->
</div> <!-- container -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 31 2018 14:45:39 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
Generated on Fri Feb 2 2018 07:57:28 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13