Deployed b2791e3 to 0.2.x with MkDocs 1.6.0 and mike 2.1.1

This commit is contained in:
2024-07-15 14:30:46 +08:00
parent 319c497f35
commit 9c622173ae
32 changed files with 13403 additions and 842 deletions

View File

@@ -15,18 +15,18 @@
<link rel="canonical" href="https://omoolab.github.io/BioxelNodes/0.2.x/nodes/">
<link rel="prev" href="../features/">
<link rel="prev" href="../terms/">
<link rel="next" href="../misc/">
<link rel="next" href="../benchmark/">
<link rel="icon" href="../assets/images/favicon.png">
<link rel="icon" href="../assets/logo.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.22">
<title>Nodes - Bioxel Nodes Docs</title>
<title>Nodes - Bioxel Nodes Handbook</title>
@@ -102,7 +102,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Bioxel Nodes Docs" class="md-header__button md-logo" aria-label="Bioxel Nodes Docs" data-md-component="logo">
<a href=".." title="Bioxel Nodes Handbook" class="md-header__button md-logo" aria-label="Bioxel Nodes Handbook" data-md-component="logo">
<img src="../assets/logo.png" alt="logo">
@@ -115,7 +115,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Bioxel Nodes Docs
Bioxel Nodes Handbook
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -230,18 +230,75 @@
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Bioxel Nodes
</a>
</li>
<li class="md-tabs__item">
<a href="../installation/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../import/" class="md-tabs__link">
Visualizating any Bio-structure
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href=".." class="md-tabs__link">
<a href="../terms/" class="md-tabs__link">
BioxelNodes
Reference
</a>
</li>
@@ -277,12 +334,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Bioxel Nodes Docs" class="md-nav__button md-logo" aria-label="Bioxel Nodes Docs" data-md-component="logo">
<a href=".." title="Bioxel Nodes Handbook" class="md-nav__button md-logo" aria-label="Bioxel Nodes Handbook" data-md-component="logo">
<img src="../assets/logo.png" alt="logo">
</a>
Bioxel Nodes Docs
Bioxel Nodes Handbook
</label>
<div class="md-nav__source">
@@ -303,7 +360,25 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Bioxel Nodes
</span>
</a>
</li>
@@ -311,7 +386,146 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../prepare_data/" class="md-nav__link">
<span class="md-ellipsis">
Prepare Your Data
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../step_by_step/" class="md-nav__link">
<span class="md-ellipsis">
Step by Step
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../concept/" class="md-nav__link">
<span class="md-ellipsis">
Concepts & Pipeline
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -320,6 +534,214 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Visualizating any Bio-structure
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Visualizating any Bio-structure
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../import/" class="md-nav__link">
<span class="md-ellipsis">
Import & Preprocess
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../mask/" class="md-nav__link">
<span class="md-ellipsis">
Mask Methods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../shader/" class="md-nav__link">
<span class="md-ellipsis">
Assgin a Shader
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cut/" class="md-nav__link">
<span class="md-ellipsis">
Cut the Component
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../color/" class="md-nav__link">
<span class="md-ellipsis">
Set Colors
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../intergration/" class="md-nav__link">
<span class="md-ellipsis">
Integration into Other Pipeline
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../render/" class="md-nav__link">
<span class="md-ellipsis">
Render Tips
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -337,70 +759,39 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<div class="md-nav__link md-nav__container">
<a href=".." class="md-nav__link ">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
BioxelNodes
Reference
</span>
</a>
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
BioxelNodes
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../getting-started/" class="md-nav__link">
<a href="../terms/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../features/" class="md-nav__link">
<span class="md-ellipsis">
Features & Options
Terms
</span>
@@ -462,15 +853,6 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#nodes-design-concept" class="md-nav__link">
<span class="md-ellipsis">
Nodes Design Concept
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mask-methods" class="md-nav__link">
<span class="md-ellipsis">
@@ -581,15 +963,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plane-cutter" class="md-nav__link">
<span class="md-ellipsis">
🧀 Plane Cutter
</span>
</a>
</li>
<li class="md-nav__item">
@@ -706,11 +1079,11 @@
<li class="md-nav__item">
<a href="../misc/" class="md-nav__link">
<a href="../benchmark/" class="md-nav__link">
<span class="md-ellipsis">
Future Features
Benchmark
</span>
@@ -753,15 +1126,6 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#nodes-design-concept" class="md-nav__link">
<span class="md-ellipsis">
Nodes Design Concept
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mask-methods" class="md-nav__link">
<span class="md-ellipsis">
@@ -872,15 +1236,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#plane-cutter" class="md-nav__link">
<span class="md-ellipsis">
🧀 Plane Cutter
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1000,15 +1355,7 @@
<h1 id="nodes">Nodes</h1>
<h2 id="nodes-design-concept">Nodes Design Concept</h2>
<p>In order to build a component, the general process is to first use a "Mask Method" node to build the surface of the component based on its layers, and then connect to a "Assign Shader" node to add the material physical properties. Finally, if you need to cut the cross-section, then connect to a "Cut" node. The whole process is shown in the following diagram</p>
<p><img alt="alt text" src="../assets/nodes_concept.png" /></p>
<p>A typical example looks like this:</p>
<p><img alt="alt text" src="../assets/nodes_example.png" /></p>
<p>The "Mask Method" node tends to be very computationally intensive, and if it consumes too much time, then you can bake it with a "Bake" node after it (but you need to save the Blender file first).</p>
<p><img alt="alt text" src="../assets/nodes_bake.png" /></p>
<h2 id="mask-methods">Mask Methods</h2>
<p>This type of node is responsible for culling out the extent of the component that does not need to be rendered, forming the interface between the object and the object, or the surface of the object (i.e., the interface between the object and the air)</p>
<h3 id="mask-by-threshold">⬆️ Mask by Threshold</h3>
<div class="grid cards">
<ul>
@@ -1097,7 +1444,6 @@
</ul>
</div>
<h2 id="shaders">Shaders</h2>
<p>This type of node is responsible for setting material physical properties to the component to reflect the differences in rendering effects of different components.</p>
<h3 id="solid-shader">🥚 Solid Shader</h3>
<div class="grid cards">
<ul>
@@ -1218,7 +1564,6 @@
</ul>
</div>
<h2 id="cutters">Cutters</h2>
<p>This type of node is responsible for cutting components to present cross-section</p>
<h3 id="cut">🪚 Cut</h3>
<div class="grid cards">
<ul>
@@ -1237,28 +1582,6 @@
</li>
</ul>
</div>
<h3 id="plane-cutter">🧀 Plane Cutter</h3>
<div class="grid cards">
<ul>
<li>
<p><img alt="alt text" src="../assets/nodes_plane-cutter.png" /></p>
</li>
<li>
<p>Flat plane cutter, cuts off above Z-axis in local.</p>
<hr />
<p>Node Parameter:</p>
<ul>
<li><strong>Origin</strong>, <em>plane cutter position</em></li>
<li><strong>Direction</strong>, <em>plane cutter orientation</em></li>
<li>Guide<ul>
<li><strong>Show</strong>, <em>show the cutter guide</em></li>
<li><strong>Scale</strong>, <em>scale the cutter guide</em></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<h3 id="plane-object-cutter">🧀 Plane Object Cutter</h3>
<div class="grid cards">
<ul>
@@ -1281,7 +1604,6 @@
</ul>
</div>
<h2 id="colors">Colors</h2>
<p>This type of node is responsible for setting the color properties of the shader</p>
<h3 id="color-presents">🎨 Color Presents</h3>
<div class="grid cards">
<ul>
@@ -1453,7 +1775,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../features/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Features &amp; Options">
<a href="../terms/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Terms">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
@@ -1463,20 +1785,20 @@
Previous
</span>
<div class="md-ellipsis">
Features & Options
Terms
</div>
</div>
</a>
<a href="../misc/" class="md-footer__link md-footer__link--next" aria-label="Next: Future Features">
<a href="../benchmark/" class="md-footer__link md-footer__link--next" aria-label="Next: Benchmark">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Future Features
Benchmark
</div>
</div>
<div class="md-footer__button md-icon">