Skip to content

Commit

Permalink
expand documentation for b3d I/O, verified, enabled and fixed b3d wri…
Browse files Browse the repository at this point in the history
…ter (output) module
  • Loading branch information
FatalistError committed Jul 14, 2024
1 parent 0ff4bce commit 9c20bea
Show file tree
Hide file tree
Showing 10 changed files with 570 additions and 286 deletions.
7 changes: 2 additions & 5 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
"/modlib/" sub directory: Copright (c) respective owner(s), see the directory
for it's respective license (License.txt). Once again note that the "/modlib/"
directory in this case is explicitly exempt from the following MIT License.

for all other files outside of "/modlib/" directory:
"/modlib/" directory: Copright (c) respective owners, see License.txt within the "/modlib/" directory.
All files outside of the modlib directory fall under the following license:

MIT License

Expand Down
7 changes: 6 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ <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>

Expand All @@ -49,6 +50,10 @@ <h2>Modules</h2>
<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>)
Expand All @@ -60,7 +65,7 @@ <h2>Modules</h2>
</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:41:04 </i>
<i style="float:right;">Last updated 2024-07-12 19:17:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
33 changes: 17 additions & 16 deletions docs/modules/b3d_nodes.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ <h2>Contents</h2>
<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>

Expand All @@ -56,23 +57,23 @@ <h1>Module <code>b3d_nodes</code></h1>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#get_node_by_name">get_node_by_name (self, node_name, is_bone)</a></td>
<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="#get_animated_local_trs">get_animated_local_trs (node, target_frame)</a></td>
<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="#get_node_global_transform">get_node_global_transform (node, frame, outputs)</a></td>
<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="#get_node_global_position">get_node_global_position (self, node, is_bone, frame)</a></td>
<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="#get_node_rotation">get_node_rotation (self, node, is_bone, frame)</a></td>
<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>
Expand All @@ -85,8 +86,8 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "get_node_by_name"></a>
<strong>get_node_by_name (self, node_name, is_bone)</strong>
<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
Expand Down Expand Up @@ -116,8 +117,8 @@ <h3>Returns:</h3>

</dd>
<dt>
<a name = "get_animated_local_trs"></a>
<strong>get_animated_local_trs (node, target_frame)</strong>
<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.
Expand Down Expand Up @@ -150,8 +151,8 @@ <h3>Returns:</h3>

</dd>
<dt>
<a name = "get_node_global_transform"></a>
<strong>get_node_global_transform (node, frame, outputs)</strong>
<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.
Expand Down Expand Up @@ -183,8 +184,8 @@ <h3>Returns:</h3>

</dd>
<dt>
<a name = "get_node_global_position"></a>
<strong>get_node_global_position (self, node, is_bone, frame)</strong>
<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.
Expand Down Expand Up @@ -221,8 +222,8 @@ <h3>Returns:</h3>

</dd>
<dt>
<a name = "get_node_rotation"></a>
<strong>get_node_rotation (self, node, is_bone, frame)</strong>
<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.
Expand Down Expand Up @@ -261,7 +262,7 @@ <h3>Returns:</h3>
</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:41:04 </i>
<i style="float:right;">Last updated 2024-07-12 19:17:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
Loading

0 comments on commit 9c20bea

Please sign in to comment.