199 lines
4.1 KiB
HTML
199 lines
4.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>MTUL b3d reader/writer documentation</title>
|
|
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>MTUL b3d</h1>
|
|
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
<li><a href="#Tables">Tables</a></li>
|
|
<li><a href="#Fields">Fields</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul class="nowrap">
|
|
<li><strong>modlib.read_b3d</strong></li>
|
|
<li><a href="../modules/b3d_nodes.html">b3d_nodes</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>modlib.read_b3d</code></h1>
|
|
<p>[[parse .b3d files into a lua table</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#read_from_stream">read_from_stream (stream, ignore_chunks)</a></td>
|
|
<td class="summary">read directly from file</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Tables">Tables</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#ignore_chunks">ignore_chunks</a></td>
|
|
<td class="summary">an unordered list of the following string chunks.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Fields">Fields</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#node_paths">node_paths</a></td>
|
|
<td class="summary">b3d table</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "read_from_stream"></a>
|
|
<strong>read_from_stream (stream, ignore_chunks)</strong>
|
|
</dt>
|
|
<dd>
|
|
read directly from file
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">stream</span>
|
|
the file object (from the io library) to read from. Make sure you open it as "rb" (read binary.)
|
|
</li>
|
|
<li><span class="parameter">ignore_chunks</span>
|
|
a list of chunks to be ignored (documentation needed)
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
b3d table (documentation needed!)
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "ignore_chunks"></a>
|
|
<strong>ignore_chunks</strong>
|
|
</dt>
|
|
<dd>
|
|
an unordered list of the following string chunks.
|
|
"NODE" and "BB3D" are ommitted as they are not allowed.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">1</span>
|
|
"TEXS" texture information
|
|
</li>
|
|
<li><span class="parameter">2</span>
|
|
"BRUS" brushes (materials)
|
|
</li>
|
|
<li><span class="parameter">3</span>
|
|
"MESH" (sub-chunks of "MESH" include "VERTS" & "TRIS")
|
|
</li>
|
|
<li><span class="parameter">4</span>
|
|
"TRIS" sets of triangles
|
|
</li>
|
|
<li><span class="parameter">5</span>
|
|
"VRTS" vertices
|
|
</li>
|
|
<li><span class="parameter">6</span>
|
|
"BONE" node vertex weights
|
|
</li>
|
|
<li><span class="parameter">7</span>
|
|
"ANIM" animation information
|
|
</li>
|
|
<li><span class="parameter">8</span>
|
|
"KEYS" keyframes
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "node_paths"></a>
|
|
<strong>node_paths</strong>
|
|
</dt>
|
|
<dd>
|
|
b3d table
|
|
|
|
|
|
<ul>
|
|
<li><span class="parameter">node_paths</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
|
<i style="float:right;">Last updated 2024-01-06 20:39:53 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|