removed individual documentation
This commit is contained in:
FatalErr42O
parent
d9b010718b
commit
c97a2afaa1
@ -1,72 +0,0 @@
|
||||
<!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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="modules/b3d_reader.html">b3d_reader</a></li>
|
||||
<li><a href="modules/b3d_writer.html">b3d_writer</a></li>
|
||||
<li><a href="modules/b3d_nodes.html">b3d_nodes</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
|
||||
<h2>A library containing hopefully all you need to read, solve and navigate a b3d. Aswell as (eventually) write one.</h2>
|
||||
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/b3d_reader.html">b3d_reader</a></td>
|
||||
<td class="summary">parse .b3d files into a lua table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/b3d_writer.html">b3d_writer</a></td>
|
||||
<td class="summary">writes b3d models in the same format as outputted by the b3d reader module</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/b3d_nodes.html">b3d_nodes</a></td>
|
||||
<td class="summary">allows you to get information about nodes (bones or meshes) within a b3d table (generated with <code>b3d_reader</code>)
|
||||
located in <code>mtul.b3d_nodes</code>.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</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-08-03 16:24:48 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
304
docs/ldoc.css
304
docs/ldoc.css
@ -1,304 +0,0 @@
|
||||
/* BEGIN RESET
|
||||
|
||||
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||
Code licensed under the BSD License:
|
||||
http://developer.yahoo.com/yui/license.html
|
||||
version: 2.8.2r1
|
||||
*/
|
||||
html {
|
||||
color: #000;
|
||||
background: #FFF;
|
||||
}
|
||||
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
fieldset,img {
|
||||
border: 0;
|
||||
}
|
||||
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
del,ins {
|
||||
text-decoration: none;
|
||||
}
|
||||
li {
|
||||
margin-left: 20px;
|
||||
}
|
||||
caption,th {
|
||||
text-align: left;
|
||||
}
|
||||
h1,h2,h3,h4,h5,h6 {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
q:before,q:after {
|
||||
content: '';
|
||||
}
|
||||
abbr,acronym {
|
||||
border: 0;
|
||||
font-variant: normal;
|
||||
}
|
||||
sup {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
sub {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
legend {
|
||||
color: #000;
|
||||
}
|
||||
input,button,textarea,select,optgroup,option {
|
||||
font-family: inherit;
|
||||
font-size: inherit;
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
input,button,textarea,select {*font-size:100%;
|
||||
}
|
||||
/* END RESET */
|
||||
|
||||
body {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
font-family: arial, helvetica, geneva, sans-serif;
|
||||
background-color: #ffffff; margin: 0px;
|
||||
}
|
||||
|
||||
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||
span.parameter { font-family:monospace; }
|
||||
span.parameter:after { content:":"; }
|
||||
span.types:before { content:"("; }
|
||||
span.types:after { content:")"; }
|
||||
.type { font-weight: bold; font-style:italic }
|
||||
|
||||
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||
|
||||
p, ul { margin: 10px 0 0 0px;}
|
||||
|
||||
strong { font-weight: bold;}
|
||||
|
||||
em { font-style: italic;}
|
||||
|
||||
h1 {
|
||||
font-size: 1.5em;
|
||||
margin: 20px 0 20px 0;
|
||||
}
|
||||
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||
h2 { font-size: 1.25em; }
|
||||
h3 { font-size: 1.15em; }
|
||||
h4 { font-size: 1.06em; }
|
||||
|
||||
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||
a:link:hover { text-decoration: underline; }
|
||||
|
||||
hr {
|
||||
color:#cccccc;
|
||||
background: #00007f;
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
blockquote { margin-left: 3em; }
|
||||
|
||||
ul { list-style-type: disc; }
|
||||
|
||||
p.name {
|
||||
font-family: "Andale Mono", monospace;
|
||||
padding-top: 1em;
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: rgb(245, 245, 245);
|
||||
border: 1px solid #C0C0C0; /* silver */
|
||||
padding: 10px;
|
||||
margin: 10px 0 10px 0;
|
||||
overflow: auto;
|
||||
font-family: "Andale Mono", monospace;
|
||||
}
|
||||
|
||||
pre.example {
|
||||
font-size: .85em;
|
||||
}
|
||||
|
||||
table.index { border: 1px #00007f; }
|
||||
table.index td { text-align: left; vertical-align: top; }
|
||||
|
||||
#container {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
|
||||
#product {
|
||||
text-align: center;
|
||||
border-bottom: 1px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#product big {
|
||||
font-size: 2em;
|
||||
}
|
||||
|
||||
#main {
|
||||
background-color: #f0f0f0;
|
||||
border-left: 2px solid #cccccc;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
float: left;
|
||||
width: 14em;
|
||||
vertical-align: top;
|
||||
background-color: #f0f0f0;
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
#navigation h2 {
|
||||
background-color:#e7e7e7;
|
||||
font-size:1.1em;
|
||||
color:#000000;
|
||||
text-align: left;
|
||||
padding:0.2em;
|
||||
border-top:1px solid #dddddd;
|
||||
border-bottom:1px solid #dddddd;
|
||||
}
|
||||
|
||||
#navigation ul
|
||||
{
|
||||
font-size:1em;
|
||||
list-style-type: none;
|
||||
margin: 1px 1px 10px 1px;
|
||||
}
|
||||
|
||||
#navigation li {
|
||||
text-indent: -1em;
|
||||
display: block;
|
||||
margin: 3px 0px 0px 22px;
|
||||
}
|
||||
|
||||
#navigation li li a {
|
||||
margin: 0px 3px 0px -1em;
|
||||
}
|
||||
|
||||
#content {
|
||||
margin-left: 14em;
|
||||
padding: 1em;
|
||||
width: 700px;
|
||||
border-left: 2px solid #cccccc;
|
||||
border-right: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#about {
|
||||
clear: both;
|
||||
padding: 5px;
|
||||
border-top: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
@media print {
|
||||
body {
|
||||
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||
}
|
||||
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||
|
||||
#main {
|
||||
background-color: #ffffff;
|
||||
border-left: 0px;
|
||||
}
|
||||
|
||||
#container {
|
||||
margin-left: 2%;
|
||||
margin-right: 2%;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#content {
|
||||
padding: 1em;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
display: none;
|
||||
}
|
||||
pre.example {
|
||||
font-family: "Andale Mono", monospace;
|
||||
font-size: 10pt;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
}
|
||||
|
||||
table.module_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.module_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.module_list td.summary { width: 100%; }
|
||||
|
||||
|
||||
table.function_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.function_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.function_list td.summary { width: 100%; }
|
||||
|
||||
ul.nowrap {
|
||||
overflow:auto;
|
||||
white-space:nowrap;
|
||||
}
|
||||
|
||||
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||
|
||||
/* stop sublists from having initial vertical space */
|
||||
ul ul { margin-top: 0px; }
|
||||
ol ul { margin-top: 0px; }
|
||||
ol ol { margin-top: 0px; }
|
||||
ul ol { margin-top: 0px; }
|
||||
|
||||
/* make the target distinct; helps when we're navigating to a function */
|
||||
a:target + * {
|
||||
background-color: #FF9;
|
||||
}
|
||||
|
||||
|
||||
/* styles for prettification of source */
|
||||
pre .comment { color: #558817; }
|
||||
pre .constant { color: #a8660d; }
|
||||
pre .escape { color: #844631; }
|
||||
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||
pre .library { color: #0e7c6b; }
|
||||
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||
pre .string { color: #8080ff; }
|
||||
pre .number { color: #f8660d; }
|
||||
pre .function-name { color: #60447f; }
|
||||
pre .operator { color: #2239a8; font-weight: bold; }
|
||||
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||
pre .global { color: #800080; }
|
||||
pre .user-keyword { color: #800080; }
|
||||
pre .prompt { color: #558817; }
|
||||
pre .url { color: #272fc2; text-decoration: underline; }
|
||||
|
||||
@ -1,269 +0,0 @@
|
||||
<!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>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/b3d_reader.html">b3d_reader</a></li>
|
||||
<li><a href="../modules/b3d_writer.html">b3d_writer</a></li>
|
||||
<li><strong>b3d_nodes</strong></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>b3d_nodes</code></h1>
|
||||
<p>allows you to get information about nodes (bones or meshes) within a b3d table (generated with <code>b3d_reader</code>)
|
||||
located in <code>mtul.b3d_nodes</code>.</p>
|
||||
<p> WARNING! mtul-cpml must be present for this module to run!</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_nodes.get_node_by_name">mtul.b3d_nodes.get_node_by_name (self, node_name, is_bone)</a></td>
|
||||
<td class="summary">get a node by it's name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_nodes.get_animated_local_trs">mtul.b3d_nodes.get_animated_local_trs (node, target_frame)</a></td>
|
||||
<td class="summary">get the local "TRS" (translation, rotation, scale) of a bone in animation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_nodes.get_node_global_transform">mtul.b3d_nodes.get_node_global_transform (node, frame, outputs)</a></td>
|
||||
<td class="summary">get a node's global mat4 transform and rotation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_nodes.get_node_global_position">mtul.b3d_nodes.get_node_global_position (self, node, is_bone, frame)</a></td>
|
||||
<td class="summary">find the position of a node in global model space.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_nodes.get_node_rotation">mtul.b3d_nodes.get_node_rotation (self, node, is_bone, frame)</a></td>
|
||||
<td class="summary">find the global rotation of a node in model space.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "mtul.b3d_nodes.get_node_by_name"></a>
|
||||
<strong>mtul.b3d_nodes.get_node_by_name (self, node_name, is_bone)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
get a node by it's name
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
the b3d table (from b3d_reader)
|
||||
</li>
|
||||
<li><span class="parameter">node_name</span>
|
||||
the name of the node to fine
|
||||
</li>
|
||||
<li><span class="parameter">is_bone</span>
|
||||
(optional) bool to indicate wether the node is a bone or not (incase there's a mesh named the same thing). False will only return meshes and pivots, true will only return bones. Nil will return any.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
node (from b3d table, documentation needed)
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_nodes.get_animated_local_trs"></a>
|
||||
<strong>mtul.b3d_nodes.get_animated_local_trs (node, target_frame)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
get the local "TRS" (translation, rotation, scale) of a bone in animation. This is used for global transformation calculations.
|
||||
quaternion is returned as a string indexed table because it needs to be a cpml object to be interpolated, also has to be usable anyway.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">node</span>
|
||||
table, the node from within a b3d table to read (as outputed by b3d_reader).
|
||||
</li>
|
||||
<li><span class="parameter">target_frame</span>
|
||||
float, the frame to find the TRS in, can be inbetween frames/keyframes (of course).
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
<li>
|
||||
<code>position</code> ordered table: {x, y, z}</li>
|
||||
<li>
|
||||
<code>rotation</code> quat from <code>mtul_cpml</code>: (example) {w=0,x=0,y=0,z=1}</li>
|
||||
<li>
|
||||
<code>scale</code> ordered table: {x, y, z}
|
||||
outputs need cleaning up.</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_nodes.get_node_global_transform"></a>
|
||||
<strong>mtul.b3d_nodes.get_node_global_transform (node, frame, outputs)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
get a node's global mat4 transform and rotation.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">node</span>
|
||||
table, the node from within a b3d table to read (as outputed by <code>b3d_reader</code>).
|
||||
</li>
|
||||
<li><span class="parameter">frame</span>
|
||||
float, the frame to find the transform and rotation in.
|
||||
</li>
|
||||
<li><span class="parameter">outputs</span>
|
||||
(optional) string, either "rotation" or "transform". Set to nil to return both.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
<li>
|
||||
<code>global_transform</code>, a matrix 4x4, note that CPML's tranforms are column major (i.e. 1st column is 1, 2, 3, 4). (see <code>mtul_cpml</code> docs)</li>
|
||||
<li>
|
||||
<code>rotation quat</code>, the quaternion rotation in global space. (cannot be assumed to be normalized, this uses raw interpolated data from the b3d reader)</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_nodes.get_node_global_position"></a>
|
||||
<strong>mtul.b3d_nodes.get_node_global_position (self, node, is_bone, frame)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
find the position of a node in global model space.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
b3d table, (optional if node is a node table and not name)
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
string or table, either the node from b3d table or a the name of the node to find.
|
||||
</li>
|
||||
<li><span class="parameter">is_bone</span>
|
||||
(optional) if node is string, this is used to find it (see <code>get_node_by_name</code>)
|
||||
</li>
|
||||
<li><span class="parameter">frame</span>
|
||||
the frame to find the global position of the node at.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
<li>
|
||||
<code>x</code></li>
|
||||
<li>
|
||||
<code>y</code></li>
|
||||
<li>
|
||||
<code>z</code></li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_nodes.get_node_rotation"></a>
|
||||
<strong>mtul.b3d_nodes.get_node_rotation (self, node, is_bone, frame)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
find the global rotation of a node in model space.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
b3d table, (optional if node is a node table and not name)
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
string or table, either the node from b3d table or a the name of the node to find.
|
||||
</li>
|
||||
<li><span class="parameter">is_bone</span>
|
||||
(optional) if node is string, this is used to find it (see <code>get_node_by_name</code>)
|
||||
</li>
|
||||
<li><span class="parameter">frame</span>
|
||||
the frame to find the global rotation of the node at.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<code>rotation</code> quaternion rotation of the node (may not be normalized)
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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-08-03 16:24:48 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@ -1,594 +0,0 @@
|
||||
<!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>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>b3d_reader</strong></li>
|
||||
<li><a href="../modules/b3d_writer.html">b3d_writer</a></li>
|
||||
<li><a href="../modules/b3d_nodes.html">b3d_nodes</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>b3d_reader</code></h1>
|
||||
<p>parse .b3d files into a lua table.</p>
|
||||
<p> note: capitlization of name indicates a "chunk" defined by the blitz3d format (see b3d_specification.txt)</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_reader.read_model">mtul.b3d_reader.read_model (modelname, node_only)</a></td>
|
||||
<td class="summary">read b3d models by their name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_reader.read_from_stream">mtul.b3d_reader.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>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#TEXS">TEXS</a></td>
|
||||
<td class="summary">textures</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#BRUS">BRUS</a></td>
|
||||
<td class="summary">brushes (materials)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#VRTS">VRTS</a></td>
|
||||
<td class="summary">vertices</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#TRIS">TRIS</a></td>
|
||||
<td class="summary">triangle/poly sets</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#MESH">MESH</a></td>
|
||||
<td class="summary">the mesh chunk table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#BONE">BONE</a></td>
|
||||
<td class="summary">bone table
|
||||
a list of vertex weights indexed by their vertex_id</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#KEYS">KEYS</a></td>
|
||||
<td class="summary">keyframes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#keyframe">keyframe</a></td>
|
||||
<td class="summary">table which specifies a keyframe</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ANIM">ANIM</a></td>
|
||||
<td class="summary">defines the animation of a model</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#NODE">NODE</a></td>
|
||||
<td class="summary">a node chunk possibly containing the following chunks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#BB3D">BB3D</a></td>
|
||||
<td class="summary">note: in <code>b3d_writer</code> the node_paths field is ignored</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#node_paths">node_paths</a></td>
|
||||
<td class="summary">node paths
|
||||
a list of nodes indexed by a list which containing every related parent node aswell as itself.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "mtul.b3d_reader.read_model"></a>
|
||||
<strong>mtul.b3d_reader.read_model (modelname, node_only)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
read b3d models by their name. This simplifies read<em>from</em>stream.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">modelname</span>
|
||||
string, the name of model you are trying to read.
|
||||
</li>
|
||||
<li><span class="parameter">node_only</span>
|
||||
bool, specifies wether to ignore textures, meshes, or anything else. Use this if you're only trying to solve bone transforms.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
b3d table (documentation needed!)
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_reader.read_from_stream"></a>
|
||||
<strong>mtul.b3d_reader.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 <a href="../modules/b3d_reader.html#ignore_chunks">ignore_chunks</a> to be ignored
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<a href="../modules/b3d_reader.html#BB3D">BB3D</a>
|
||||
</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>
|
||||
<dt>
|
||||
<a name = "TEXS"></a>
|
||||
<strong>TEXS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
textures
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">file</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">flags</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">pos</span>
|
||||
table {float, float}
|
||||
</li>
|
||||
<li><span class="parameter">pos</span>
|
||||
table {float, float}
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "BRUS"></a>
|
||||
<strong>BRUS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
brushes (materials)
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">shininess</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">blend</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">fx</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">texture_id</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "VRTS"></a>
|
||||
<strong>VRTS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
vertices
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">flags</span>
|
||||
uknown
|
||||
</li>
|
||||
<li><span class="parameter">tex_coord_sets</span>
|
||||
the number of texture coordinate sets
|
||||
</li>
|
||||
<li><span class="parameter">tex_coord_set_size</span>
|
||||
unknown
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
a list of vertices, the integer index defines their vertex<em>ids { pos={x,y,z}, color={r, g, b, a}, tex</em>coords=... }
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "TRIS"></a>
|
||||
<strong>TRIS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
triangle/poly sets
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">brush_id</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">vertex_ids</span>
|
||||
a list of three vertex IDs {i, j, k} which make it up
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MESH"></a>
|
||||
<strong>MESH</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
the mesh chunk table
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">brush_id</span>
|
||||
(may not exist) brush from brush chunk to use
|
||||
</li>
|
||||
<li><span class="parameter">vertices</span>
|
||||
<a href="../modules/b3d_reader.html#VRTS">VRTS</a> vertices and indexed by their ID and additional info
|
||||
</li>
|
||||
<li><span class="parameter">triangle_sets</span>
|
||||
<a href="../modules/b3d_reader.html#TRIS">TRIS</a> a list of three vertices to be used in
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "BONE"></a>
|
||||
<strong>BONE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
bone table
|
||||
a list of vertex weights indexed by their vertex_id
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "KEYS"></a>
|
||||
<strong>KEYS</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
keyframes
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">flags</span>
|
||||
defines if position rotation and scale exists (further explanation needed)
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
a list of <a href="../modules/b3d_reader.html#keyframe">keyframe</a>s
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "keyframe"></a>
|
||||
<strong>keyframe</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
table which specifies a keyframe
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ANIM"></a>
|
||||
<strong>ANIM</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
defines the animation of a model
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">flags</span>
|
||||
unused?
|
||||
</li>
|
||||
<li><span class="parameter">frames</span>
|
||||
number of frames
|
||||
</li>
|
||||
<li><span class="parameter">fps</span>
|
||||
framerate of the model
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "NODE"></a>
|
||||
<strong>NODE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
a node chunk possibly containing the following chunks.
|
||||
there are three possible "types" of nodes. All bones will contain the following chunks:
|
||||
<code>position</code>, <code>rotation</code>, <code>scale</code>.
|
||||
Bones will have a bone field which will contain IDs from it's parent node's mesh chunk.
|
||||
Meshes will have a mesh field containing information about their mesh.
|
||||
Pivots will have neither of those and simply serve as parents to child nodes. <3
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">type</span>
|
||||
string which is either "pivot", "bone" or "mesh"
|
||||
</li>
|
||||
<li><span class="parameter">children</span>
|
||||
a list of child nodes, Transoformations (position, rotation, scale) will be applied to the children.
|
||||
</li>
|
||||
<li><span class="parameter">position</span>
|
||||
position {x, y, z} of the bone
|
||||
</li>
|
||||
<li><span class="parameter">rotation</span>
|
||||
quaternion {x, y, z, w} rotation of the bone at rest
|
||||
</li>
|
||||
<li><span class="parameter">scale</span>
|
||||
{x, y, z} scale of the bone at rest
|
||||
</li>
|
||||
<li><span class="parameter">mesh</span>
|
||||
<a href="../modules/b3d_reader.html#MESH">MESH</a> chunk. Found in <strong>mesh</strong> node
|
||||
</li>
|
||||
<li><span class="parameter">bone</span>
|
||||
<a href="../modules/b3d_reader.html#BONE">BONE</a> chunk. Found in <strong>bone</strong> node
|
||||
</li>
|
||||
<li><span class="parameter">keys</span>
|
||||
<a href="../modules/b3d_reader.html#KEYS">KEYS</a> chunk. Found in <strong>bone</strong> node
|
||||
</li>
|
||||
<li><span class="parameter">animation</span>
|
||||
<a href="../modules/b3d_reader.html#ANIM">ANIM</a> chunk. Typically found in root node (uknown wether it can be elsewhere.)
|
||||
</li>
|
||||
<li><span class="parameter">parent</span>
|
||||
the parent node. (The node in which this node is in the children table)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "BB3D"></a>
|
||||
<strong>BB3D</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
note: in <code>b3d_writer</code> the node_paths field is ignored
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">node_paths</span>
|
||||
all nodes in the model indexed by a table <a href="../modules/b3d_reader.html#node_paths">node_paths</a>
|
||||
</li>
|
||||
<li><span class="parameter">node</span>
|
||||
a table containing the root <a href="../modules/b3d_reader.html#NODE">NODE</a> of the model.
|
||||
</li>
|
||||
<li><span class="parameter">textures</span>
|
||||
a list of <a href="../modules/b3d_reader.html#TEXS">TEXS</a> chunks
|
||||
</li>
|
||||
<li><span class="parameter">brushes</span>
|
||||
a list of <a href="../modules/b3d_reader.html#BRUS">BRUS</a> chunks
|
||||
</li>
|
||||
<li><span class="parameter">version</span>
|
||||
<code>{major=float, minor=float}</code> this functionally means nothing, but it's version information.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "node_paths"></a>
|
||||
<strong>node_paths</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
node paths
|
||||
a list of nodes indexed by a list which containing every related parent node aswell as itself.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">...</span>
|
||||
) node
|
||||
</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-08-03 16:24:48 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@ -1,136 +0,0 @@
|
||||
<!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>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/b3d_reader.html">b3d_reader</a></li>
|
||||
<li><strong>b3d_writer</strong></li>
|
||||
<li><a href="../modules/b3d_nodes.html">b3d_nodes</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>b3d_writer</code></h1>
|
||||
<p>writes b3d models in the same format as outputted by the b3d reader module</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_writer.write_string">mtul.b3d_writer.write_string (self)</a></td>
|
||||
<td class="summary">output a string of binary in the blitz 3d format</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#mtul.b3d_writer.write_model_to_file">mtul.b3d_writer.write_model_to_file (self, stream)</a></td>
|
||||
<td class="summary">output in the blitz3d format file reference</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "mtul.b3d_writer.write_string"></a>
|
||||
<strong>mtul.b3d_writer.write_string (self)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
output a string of binary in the blitz 3d format
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<a href="../modules/b3d_reader.html#BB3D">BB3D chunk</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
string containing the binary file
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mtul.b3d_writer.write_model_to_file"></a>
|
||||
<strong>mtul.b3d_writer.write_model_to_file (self, stream)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
output in the blitz3d format file reference
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
<a href="../modules/b3d_reader.html#BB3D">BB3D chunk</a>
|
||||
</li>
|
||||
<li><span class="parameter">stream</span>
|
||||
io file object to write to
|
||||
</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-08-03 16:24:48 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@ -1,9 +0,0 @@
|
||||
project="LEEF b3d"
|
||||
title="LEEF b3d reader/writer documentation"
|
||||
description="A library containing hopefully all you need to read, solve and navigate a b3d. Aswell as (eventually) write one."
|
||||
format="markdown"
|
||||
backtick_references=false
|
||||
file = {
|
||||
"../",
|
||||
}
|
||||
dir='../docs'
|
||||
Binary file not shown.
@ -1,6 +0,0 @@
|
||||
[{000214A0-0000-0000-C000-000000000046}]
|
||||
Prop3=19,11
|
||||
[InternetShortcut]
|
||||
IDList=
|
||||
URL=https://stevedonovan.github.io/ldoc/manual/doc.md.html
|
||||
HotKey=0
|
||||
@ -1,3 +0,0 @@
|
||||
# literally just so I dont have to open powershell every time.
|
||||
@echo off
|
||||
ldoc .
|
||||
Loading…
x
Reference in New Issue
Block a user