gridfinity-rebuilt-openscad.../lite/index.html

299 lines
12 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Lite - Gridfinity Rebuilt</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Lite";
var mkdocs_page_input_path = "lite.md";
var mkdocs_page_url = null;
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Gridfinity Rebuilt
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bins/">Bins</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../baseplates/">Baseplates</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Lite</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#script-parameters">Script Parameters</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#modules">Modules</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#gridfinitylite">gridfinityLite</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../vase/">Vase</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../constants/">Constants</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Gridfinity Rebuilt</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Lite</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="gridfinity-rebuilt-lite">gridfinity-rebuilt-lite</h1>
<p>Generates stock bins, but with a twist: the bases are hollow. This is unable to be implemented directly into <code>gridfinity-rebuilt-bins</code> due to its surprisingly complex construction. It couldn't be a toggle without causing the structure of the script to fundamentally change (and become more complex) so it was moved to a separate file. Notably, there are some parameters missing, as they are incompatible with the lite variation. Additionally, the complex geometry means rendering is fairly slow, and currently causes many CSG errors. </p>
<p><img alt="Bin" src="../images/lite.gif" /></p>
<h2 id="script-parameters">Script Parameters</h2>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Range</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>gridx</td>
<td>{ n&gt;0 | n∈R }</td>
<td>number of bases along the x-axis</td>
</tr>
<tr>
<td>gridy</td>
<td>{ n&gt;0 | n∈R }</td>
<td>number of bases along the y-axis</td>
</tr>
<tr>
<td>gridz</td>
<td>{ n&gt;0 | n∈R }</td>
<td>bin height. See bin height information and "gridz_define" below.</td>
</tr>
<tr>
<td>length</td>
<td>{ n&gt;0 | n∈R }</td>
<td>length of one unit of the base. <br> default: 42 (The Answer to the Ultimate Question of Life, <br>the Universe, and Everything.)</td>
</tr>
<tr>
<td>divx</td>
<td>{ n&gt;0 | n∈Z }</td>
<td>number of compartments along X</td>
</tr>
<tr>
<td>divy</td>
<td>{ n&gt;0 | n∈Z }</td>
<td>number of compartments along Y</td>
</tr>
<tr>
<td>enable_zsnap</td>
<td>boolean</td>
<td>automatically snap the bin size to the nearest 7mm increment. <br> default: true</td>
</tr>
<tr>
<td>style_lip</td>
<td>{0, 1, 2}</td>
<td>if you are not stacking the bin, you can disable the top lip <br> to save space. <br> • (0) Regular lip <br> • (1) Subtract lip to save space <br> • (2) Disable lip while retaining height</td>
</tr>
<tr>
<td>gridz_define</td>
<td>{ n&gt;0 | n∈R }</td>
<td>determine what the variable "gridz" applies to based on <br> your use case. default: 0. <br> • (0) gridz is the height in # of 7mm increments (Zack) <br> • (1) gridz is the internal height in millimeters <br> • (2) gridz is the overall external height of the bin in millimeters</td>
</tr>
<tr>
<td>style_tab</td>
<td>{ 0, 1, 2, 3, 4, 5 }</td>
<td>how the tabs for labels are generated. <br> • (0) Full tabs across the entire compartment <br> • (1) automatic tabs <br> - left aligned tabs on the left edge<br> - right aligned tabs on right edge<br> - center tabs otherwise <br> • (2) left aligned tabs <br> • (3) center aligned tabs <br> • (4) right aligned tabs <br> • (5) no tabs</td>
</tr>
<tr>
<td>style_hole</td>
<td>{ 0, 1, 2, 3 }</td>
<td>the style of holes in the bases <br> • (0) No holes <br> • (1) Magnet holes only <br> • (2) Magnet and screw holes - no printable slit <br> • (3) Magnet and screw holes - with printable slit</td>
</tr>
<tr>
<td>div_base_x</td>
<td>{ n&gt;=0 | n∈Z }</td>
<td>number of divisions per 1 unit of base along the X axis. <br>(default 1, only use integers. <br>0 means automatically guess the division)</td>
</tr>
<tr>
<td>div_base_y</td>
<td>{ n&gt;=0 | n∈Z }</td>
<td>number of divisions per 1 unit of base along the Y axis. <br>(default 1, only use integers. <br>0 means automatically guess the division)</td>
</tr>
</tbody>
</table>
<p><br></p>
<h2 id="modules">Modules</h2>
<hr />
<h3 id="gridfinitylite">gridfinityLite</h3>
<p>Wrapper function that calls <a href="../bins/#gridfinityInit"><code>gridfinityInit</code></a> and <a href="../bins/#gridfinityBase"><code>gridfinityBase</code></a> functions (hence the sheer quantity of parameters). Like <a href="../bins/#gridfinityInit"><code>gridfinityInit</code></a>, it uses its children as cutters for the compartments. </p>
<p><strong><code>gridfinityLite(gridx, gridy, gridz, gridz_define, enable_lip, enable_zsnap, length, div_base_x, div_base_y, style_hole)</code></strong></p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Range</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>gridx</td>
<td>{ n&gt;0 | n∈R }</td>
<td>number of bases along the x-axis</td>
</tr>
<tr>
<td>gridy</td>
<td>{ n&gt;0 | n∈R }</td>
<td>number of bases along the y-axis</td>
</tr>
<tr>
<td>gridz</td>
<td>{ n&gt;0 | n∈R }</td>
<td>bin height. See bin height information and "gridz_define" below.</td>
</tr>
<tr>
<td>gridz_define</td>
<td>{ n&gt;0 | n∈R }</td>
<td>determine what the variable "gridz" applies to based on <br> your use case. default: 0. <br> • (0) gridz is the height in # of 7mm increments (Zack) <br> • (1) gridz is the internal height in millimeters <br> • (2) gridz is the overall external height of the bin in millimeters</td>
</tr>
<tr>
<td>style_lip</td>
<td>{0, 1, 2}</td>
<td>if you are not stacking the bin, you can disable the top lip <br> to save space. <br> • (0) Regular lip <br> • (1) Subtract lip to save space <br> • (2) Disable lip while retaining height</td>
</tr>
<tr>
<td>enable_zsnap</td>
<td>boolean</td>
<td>automatically snap the bin size to the nearest 7mm increment. <br> default: true</td>
</tr>
<tr>
<td>length</td>
<td>{ n&gt;0 | n∈R }</td>
<td>length of one unit of the base. <br> default: 42 (The Answer to the Ultimate Question of Life, <br>the Universe, and Everything.)</td>
</tr>
<tr>
<td>div_base_x</td>
<td>{ n&gt;=0 | n∈Z }</td>
<td>number of divisions per 1 unit of base along the X axis. <br>(default 1, only use integers. <br>0 means automatically guess the division)</td>
</tr>
<tr>
<td>div_base_y</td>
<td>{ n&gt;=0 | n∈Z }</td>
<td>number of divisions per 1 unit of base along the Y axis. <br>(default 1, only use integers. <br>0 means automatically guess the division)</td>
</tr>
<tr>
<td>style_hole</td>
<td>{ 0, 1, 2, 3 }</td>
<td>the style of holes in the bases <br> • (0) No holes <br> • (1) Magnet holes only <br> • (2) Magnet and screw holes - no printable slit <br> • (3) Magnet and screw holes - with printable slit</td>
</tr>
</tbody>
</table>
<pre><code>// Example: generate a 3x3x6 bin with 2x2 compartments, that is hollow
gridfinityLite(gridx=3, gridy=3, gridz=6, gridz_define=0, enable_lip=true, enable_zsnap=false, length=42, div_base_x=0, div_base_y=0, style_hole=1) {
cutEqual(n_divx=2, n_divy=2, style_tab=1, enable_scoop = false);
}
</code></pre>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../baseplates/" class="btn btn-neutral float-left" title="Baseplates"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../vase/" class="btn btn-neutral float-right" title="Vase">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="../baseplates/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../vase/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>