294 lines
18 KiB
HTML
294 lines
18 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/css/index.f658d18f9b420779cfdf24aa0a7e2d77.css">
|
||
|
||
|
||
<link rel="stylesheet"
|
||
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
|
||
<link rel="preload" as="font" type="font/woff2" crossorigin
|
||
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
|
||
<link rel="preload" as="font" type="font/woff2" crossorigin
|
||
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
|
||
|
||
|
||
|
||
<link rel="stylesheet"
|
||
href="_static/vendor/open-sans_all/1.44.1/index.css">
|
||
<link rel="stylesheet"
|
||
href="_static/vendor/lato_latin-ext/1.44.1/index.css">
|
||
|
||
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
|
||
|
||
<link rel="preload" as="script" href="_static/js/index.d3f166471bb80abb5163.js">
|
||
|
||
<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" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<meta name="docsearch:language" content="en" />
|
||
</head>
|
||
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
|
||
|
||
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
|
||
<div class="container-xl">
|
||
|
||
<a class="navbar-brand" href="index.html">
|
||
|
||
<p class="title">solidLib</p>
|
||
|
||
</a>
|
||
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
|
||
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
|
||
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
|
||
|
||
|
||
<li class="nav-item active">
|
||
<a class="nav-link" href="">solidLib package</a>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<ul class="navbar-nav">
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
<div class="container-xl">
|
||
<div class="row">
|
||
|
||
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="search.html" method="get">
|
||
<i class="icon fas fa-search"></i>
|
||
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
|
||
</form>
|
||
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
|
||
|
||
<div class="bd-toc-item active">
|
||
|
||
|
||
<ul class="nav bd-sidenav">
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="d-none d-xl-block col-xl-2 bd-toc">
|
||
|
||
<div class="tocsection onthispage pt-5 pb-3">
|
||
<i class="fas fa-list"></i> On this page
|
||
</div>
|
||
|
||
<nav id="bd-toc-nav">
|
||
<ul class="nav section-nav flex-column">
|
||
|
||
<li class="nav-item toc-entry toc-h2">
|
||
<a href="#submodules" class="nav-link">Submodules</a>
|
||
</li>
|
||
|
||
<li class="nav-item toc-entry toc-h2">
|
||
<a href="#module-solidLib.assortment" class="nav-link">solidLib.assortment module</a>
|
||
</li>
|
||
|
||
<li class="nav-item toc-entry toc-h2">
|
||
<a href="#module-solidLib.primitives" class="nav-link">solidLib.primitives module</a>
|
||
</li>
|
||
|
||
<li class="nav-item toc-entry toc-h2">
|
||
<a href="#module-solidLib" class="nav-link">Module contents</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
|
||
|
||
<div>
|
||
|
||
<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><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><p>standardized container</p>
|
||
<img alt="_images/bin.png" src="_images/bin.png" />
|
||
</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><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><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><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/toolinlay1.png" src="_images/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">wall</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">2</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/toolinlay2.png" src="_images/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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</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><p>create a pill around given points</p>
|
||
<img alt="_images/pill.png" src="_images/pill.png" />
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.primitives.rcube">
|
||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">rcube</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">Iterable<span class="p">[</span>float<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">radius</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#rcube"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.rcube" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>creates a cube with rounded corners</p>
|
||
<img alt="_images/rcube.png" src="_images/rcube.png" />
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dim</strong> – cube dimensions to base box on.</p></li>
|
||
<li><p><strong>radius</strong> – box radius.</p></li>
|
||
<li><p><strong>segments</strong> – circular object segments</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="solidLib.primitives.rfcube">
|
||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">rfcube</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">Iterable<span class="p">[</span>float<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">r</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#rfcube"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.rfcube" 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>
|
||
<dl class="py class">
|
||
<dt id="solidLib.settings">
|
||
<em class="property">class </em><code class="sig-prename descclassname">solidLib.</code><code class="sig-name descname">settings</code><a class="reference internal" href="_modules/solidLib.html#settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.settings" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>global dolidLib settings</p>
|
||
<dl class="py attribute">
|
||
<dt id="solidLib.settings.height">
|
||
<code class="sig-name descname">height</code><em class="property"> = 67</em><a class="headerlink" href="#solidLib.settings.height" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="solidLib.settings.raster">
|
||
<code class="sig-name descname">raster</code><em class="property"> = 59</em><a class="headerlink" href="#solidLib.settings.raster" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="solidLib.settings.segments">
|
||
<code class="sig-name descname">segments</code><em class="property"> = 36</em><a class="headerlink" href="#solidLib.settings.segments" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class='prev-next-bottom'>
|
||
|
||
<a class='left-prev' id="prev-link" href="index.html" title="previous page">Welcome to solidLib’s documentation!</a>
|
||
|
||
</div>
|
||
|
||
</main>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<script src="_static/js/index.d3f166471bb80abb5163.js"></script>
|
||
|
||
|
||
<footer class="footer mt-5 mt-md-0">
|
||
<div class="container">
|
||
<p>
|
||
© Copyright 2021, Patrick Nisble.<br/>
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.<br/>
|
||
</p>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html> |