201 lines
17 KiB
HTML
201 lines
17 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>solidLib package — solidLib documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="prev" title="Welcome to solidLib’s documentation!" href="index.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="solidlib-package">
|
||
<h1>solidLib package<a class="headerlink" href="#solidlib-package" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-solidLib.assortment">
|
||
<span id="solidlib-assortment-module"></span><h2>solidLib.assortment module<a class="headerlink" href="#module-solidLib.assortment" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py function">
|
||
<dt id="solidLib.assortment.bin">
|
||
<code class="sig-prename descclassname">solidLib.assortment.</code><code class="sig-name descname">bin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">h</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">67</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em>, <em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">59</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/assortment.html#bin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.assortment.bin" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.assortment.grid">
|
||
<code class="sig-prename descclassname">solidLib.assortment.</code><code class="sig-name descname">grid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x_dim</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">int</span></em>, <em class="sig-param"><span class="n">w</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">3</span></em>, <em class="sig-param"><span class="n">h</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">1.5</span></em>, <em class="sig-param"><span class="n">fillet</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">59</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/assortment.html#grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.assortment.grid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>generate a grid of (flattened) triangles with or without fillet</p>
|
||
<p>the generated grid is x by y in size with a gridspace of size dim,
|
||
the triangles used for the base structure is given by their height and width</p>
|
||
<img alt="2x3 grid with defaults" src="_images/grid.png" />
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.assortment.grid_inv">
|
||
<code class="sig-prename descclassname">solidLib.assortment.</code><code class="sig-name descname">grid_inv</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">w</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">3</span></em>, <em class="sig-param"><span class="n">h</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">1.5</span></em>, <em class="sig-param"><span class="n">fillet</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">59</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/assortment.html#grid_inv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.assortment.grid_inv" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.assortment.toolinlay1">
|
||
<code class="sig-prename descclassname">solidLib.assortment.</code><code class="sig-name descname">toolinlay1</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">height</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">r_tool</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">7</span></em>, <em class="sig-param"><span class="n">inset</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">4</span></em>, <em class="sig-param"><span class="n">maxh</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">67</span></em>, <em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">59</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/assortment.html#toolinlay1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.assortment.toolinlay1" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>creates a tooltray for alex container bins (2x3)</p>
|
||
<img alt="_images/bin_toolinlay1.png" src="_images/bin_toolinlay1.png" />
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>height</strong> – height of inset above lower bin</p></li>
|
||
<li><p><strong>inset</strong> – depth of inset</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.assortment.toolinlay2">
|
||
<code class="sig-prename descclassname">solidLib.assortment.</code><code class="sig-name descname">toolinlay2</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">height</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">r_tool</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>float<span class="p">, </span>Iterable<span class="p">[</span>float<span class="p">]</span><span class="p">]</span></span> <span class="o">=</span> <span class="default_value">7</span></em>, <em class="sig-param"><span class="n">inset</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">4</span></em>, <em class="sig-param"><span class="n">inset_tool</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">3</span></em>, <em class="sig-param"><span class="n">maxh</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">67</span></em>, <em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">59</span></em>, <em class="sig-param"><span class="n">wall</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">2</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/assortment.html#toolinlay2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.assortment.toolinlay2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>creates a tooltray for alex container bins (2x3)</p>
|
||
<img alt="_images/bin_toolinlay2.png" src="_images/bin_toolinlay2.png" />
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>height</strong> – height of inset above lower bin</p></li>
|
||
<li><p><strong>r_tool</strong> – toolspace radius as float or list of floats</p></li>
|
||
<li><p><strong>inset</strong> – depth of toolinlay inset</p></li>
|
||
<li><p><strong>inset_tool</strong> – depth of additional toolspace inset</p></li>
|
||
<li><p><strong>maxh</strong> – system height restriction</p></li>
|
||
<li><p><strong>dim</strong> – system raster dimension</p></li>
|
||
<li><p><strong>segments</strong> – circular object segments</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-solidLib.globals">
|
||
<span id="solidlib-globals-module"></span><h2>solidLib.globals module<a class="headerlink" href="#module-solidLib.globals" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-solidLib.primitives">
|
||
<span id="solidlib-primitives-module"></span><h2>solidLib.primitives module<a class="headerlink" href="#module-solidLib.primitives" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py function">
|
||
<dt id="solidLib.primitives.pill">
|
||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">pill</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ps</span><span class="p">:</span> <span class="n">List<span class="p">[</span>List<span class="p">[</span>float<span class="p">]</span><span class="p">]</span></span></em>, <em class="sig-param"><span class="n">r</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">36</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#pill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.pill" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.primitives.round_box">
|
||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">round_box</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">z_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">radius</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">32</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#round_box"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.round_box" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>creates a round box with radius r</p>
|
||
<img alt="_images/round_box.png" src="_images/round_box.png" />
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.primitives.round_flat_box">
|
||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">round_flat_box</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">z</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">r</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">32</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#round_flat_box"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.round_flat_box" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>creates a round box with radius r and flat top/bottom</p>
|
||
<img alt="_images/round_flat_box.png" src="_images/round_flat_box.png" />
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-solidLib">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-solidLib" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">solidLib</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">solidLib package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.assortment">solidLib.assortment module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.globals">solidLib.globals module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.primitives">solidLib.primitives module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="index.html" title="previous chapter">Welcome to solidLib’s documentation!</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2021, Patrick Nisble.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.3</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/solidLib.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |