茂之钳
317 lines
17 KiB
HTML
317 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ViewDesignEngine: vde::foundation::BinarySerializer类 参考</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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">ViewDesignEngine
|
|
 <span id="projectnumber">3.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">高性能 CAD 计算几何引擎</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- 制作者 Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'搜索','.html');
|
|
/* @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','搜索');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classvde_1_1foundation_1_1BinarySerializer.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">静态 Public 成员函数</a> |
|
|
<a href="classvde_1_1foundation_1_1BinarySerializer-members.html">所有成员列表</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">vde::foundation::BinarySerializer类 参考<div class="ingroups"><a class="el" href="group__foundation.html">基础模块</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>二进制序列化器
|
|
<a href="classvde_1_1foundation_1_1BinarySerializer.html#details">更多...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="serializer_8h_source.html">serializer.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
静态 Public 成员函数</h2></td></tr>
|
|
<tr class="memitem:a5474a51bc19b4d97dea3de1f791a524f"><td class="memItemLeft" align="right" valign="top">static std::vector< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f">serialize</a> (const <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> &mesh)</td></tr>
|
|
<tr class="memdesc:a5474a51bc19b4d97dea3de1f791a524f"><td class="mdescLeft"> </td><td class="mdescRight">序列化网格到二进制缓冲区 <a href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f">更多...</a><br /></td></tr>
|
|
<tr class="separator:a5474a51bc19b4d97dea3de1f791a524f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed0a1c25630168cc39c847f715283152"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#aed0a1c25630168cc39c847f715283152">deserialize</a> (const std::vector< uint8_t > &data)</td></tr>
|
|
<tr class="memdesc:aed0a1c25630168cc39c847f715283152"><td class="mdescLeft"> </td><td class="mdescRight">从二进制缓冲区反序列化网格 <a href="classvde_1_1foundation_1_1BinarySerializer.html#aed0a1c25630168cc39c847f715283152">更多...</a><br /></td></tr>
|
|
<tr class="separator:aed0a1c25630168cc39c847f715283152"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d266b8d1803cfa76f8cc05d931756be"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a4d266b8d1803cfa76f8cc05d931756be">write_file</a> (const std::string &path, const <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> &mesh)</td></tr>
|
|
<tr class="memdesc:a4d266b8d1803cfa76f8cc05d931756be"><td class="mdescLeft"> </td><td class="mdescRight">序列化并写入文件 <a href="classvde_1_1foundation_1_1BinarySerializer.html#a4d266b8d1803cfa76f8cc05d931756be">更多...</a><br /></td></tr>
|
|
<tr class="separator:a4d266b8d1803cfa76f8cc05d931756be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11fd2ce12b21c3229301d6e4a9b2715a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a11fd2ce12b21c3229301d6e4a9b2715a">read_file</a> (const std::string &path)</td></tr>
|
|
<tr class="memdesc:a11fd2ce12b21c3229301d6e4a9b2715a"><td class="mdescLeft"> </td><td class="mdescRight">从文件读取并反序列化 <a href="classvde_1_1foundation_1_1BinarySerializer.html#a11fd2ce12b21c3229301d6e4a9b2715a">更多...</a><br /></td></tr>
|
|
<tr class="separator:a11fd2ce12b21c3229301d6e4a9b2715a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
|
|
<div class="textblock"><p>二进制序列化器 </p>
|
|
<p>提供网格的快速二进制序列化/反序列化，用于 VDE 本地格式（VDE 二进制格式）。</p>
|
|
<p>文件格式：</p><ul>
|
|
<li>8 字节魔数 "VDEGEOM\0" (0x56444547454F4D00)</li>
|
|
<li>4 字节格式版本号</li>
|
|
<li>4 字节标志位</li>
|
|
<li>序列化的网格数据</li>
|
|
</ul>
|
|
<dl class="section note"><dt>注解</dt><dd>该格式专为 VDE 内部快速读写设计，不适用于跨平台数据交换 </dd>
|
|
<dd>
|
|
使用 glTF/OBJ/STL 进行外部交换，此格式用于本地缓存 </dd></dl>
|
|
|
|
<p class="definition">在文件 <a class="el" href="serializer_8h_source.html">serializer.h</a> 第 <a class="el" href="serializer_8h_source.html#l00046">46</a> 行定义.</p>
|
|
</div><h2 class="groupheader">成员函数说明</h2>
|
|
<a id="aed0a1c25630168cc39c847f715283152"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed0a1c25630168cc39c847f715283152">◆ </a></span>deserialize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> vde::foundation::BinarySerializer::deserialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </td>
|
|
<td class="paramname"><em>data</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>从二进制缓冲区反序列化网格 </p>
|
|
<dl class="params"><dt>参数</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>之前由 <a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f" title="序列化网格到二进制缓冲区">serialize()</a> 生成的二进制数据 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>返回</dt><dd>恢复的半边网格</dd></dl>
|
|
<dl class="exception"><dt>异常</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>若数据校验失败（魔数/版本不匹配）</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> mesh = <a class="code" href="classvde_1_1foundation_1_1BinarySerializer.html#aed0a1c25630168cc39c847f715283152">BinarySerializer::deserialize</a>(data);</div>
|
|
<div class="ttc" id="aclassvde_1_1foundation_1_1BinarySerializer_html_aed0a1c25630168cc39c847f715283152"><div class="ttname"><a href="classvde_1_1foundation_1_1BinarySerializer.html#aed0a1c25630168cc39c847f715283152">vde::foundation::BinarySerializer::deserialize</a></div><div class="ttdeci">static mesh::HalfedgeMesh deserialize(const std::vector< uint8_t > &data)</div><div class="ttdoc">从二进制缓冲区反序列化网格</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a11fd2ce12b21c3229301d6e4a9b2715a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11fd2ce12b21c3229301d6e4a9b2715a">◆ </a></span>read_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> vde::foundation::BinarySerializer::read_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>path</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>从文件读取并反序列化 </p>
|
|
<p>等价于文件读取 + <a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#aed0a1c25630168cc39c847f715283152" title="从二进制缓冲区反序列化网格">deserialize()</a>，一步完成。</p>
|
|
<dl class="params"><dt>参数</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>VDE 二进制格式文件路径 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>返回</dt><dd>恢复的半边网格</dd></dl>
|
|
<dl class="exception"><dt>异常</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>若文件无法打开或格式无效</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>参见</dt><dd><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a4d266b8d1803cfa76f8cc05d931756be" title="序列化并写入文件">write_file</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5474a51bc19b4d97dea3de1f791a524f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5474a51bc19b4d97dea3de1f791a524f">◆ </a></span>serialize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::vector<uint8_t> vde::foundation::BinarySerializer::serialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> & </td>
|
|
<td class="paramname"><em>mesh</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>序列化网格到二进制缓冲区 </p>
|
|
<dl class="params"><dt>参数</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mesh</td><td>要序列化的半边网格 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>返回</dt><dd>压缩后的二进制数据（含文件头）</dd></dl>
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> data = <a class="code" href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f">BinarySerializer::serialize</a>(mesh);</div>
|
|
<div class="line"><span class="comment">// data 可直接写入文件或通过网络传输</span></div>
|
|
<div class="ttc" id="aclassvde_1_1foundation_1_1BinarySerializer_html_a5474a51bc19b4d97dea3de1f791a524f"><div class="ttname"><a href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f">vde::foundation::BinarySerializer::serialize</a></div><div class="ttdeci">static std::vector< uint8_t > serialize(const mesh::HalfedgeMesh &mesh)</div><div class="ttdoc">序列化网格到二进制缓冲区</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a4d266b8d1803cfa76f8cc05d931756be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d266b8d1803cfa76f8cc05d931756be">◆ </a></span>write_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool vde::foundation::BinarySerializer::write_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classvde_1_1mesh_1_1HalfedgeMesh.html">mesh::HalfedgeMesh</a> & </td>
|
|
<td class="paramname"><em>mesh</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>序列化并写入文件 </p>
|
|
<p>等价于 <a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a5474a51bc19b4d97dea3de1f791a524f" title="序列化网格到二进制缓冲区">serialize()</a> + 文件写入，一步完成。</p>
|
|
<dl class="params"><dt>参数</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>输出文件路径 </td></tr>
|
|
<tr><td class="paramname">mesh</td><td>要保存的半边网格 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>返回</dt><dd>true 写入成功 </dd>
|
|
<dd>
|
|
false 文件创建失败</dd></dl>
|
|
<dl class="section see"><dt>参见</dt><dd><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html#a11fd2ce12b21c3229301d6e4a9b2715a" title="从文件读取并反序列化">read_file</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>该类的文档由以下文件生成:<ul>
|
|
<li>include/vde/foundation/<a class="el" href="serializer_8h_source.html">serializer.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacevde.html">vde</a></li><li class="navelem"><a class="el" href="namespacevde_1_1foundation.html">foundation</a></li><li class="navelem"><a class="el" href="classvde_1_1foundation_1_1BinarySerializer.html">BinarySerializer</a></li>
|
|
<li class="footer">生成于 2026年 七月 24日 星期五 11:21:23 , 为 ViewDesignEngine使用 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|