mirror of
https://github.com/csirmaz/openscad-py.git
synced 2025-06-22 02:38:57 +02:00
257 lines
20 KiB
HTML
257 lines
20 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
|
||
<meta name="generator" content="pdoc3 0.11.3">
|
||
<title>openscad_py.union API documentation</title>
|
||
<meta name="description" content="">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
|
||
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
|
||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
|
||
<script>window.addEventListener('DOMContentLoaded', () => {
|
||
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
|
||
hljs.highlightAll();
|
||
})</script>
|
||
</head>
|
||
<body>
|
||
<main>
|
||
<article id="content">
|
||
<header>
|
||
<h1 class="title">Module <code>openscad_py.union</code></h1>
|
||
</header>
|
||
<section id="section-intro">
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
<h2 class="section-title" id="header-classes">Classes</h2>
|
||
<dl>
|
||
<dt id="openscad_py.union.Union"><code class="flex name class">
|
||
<span>class <span class="ident">Union</span></span>
|
||
<span>(</span><span>child: list | <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a>)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<div class="desc"><p>Represents a union applied to an object (usually a collection of objects).
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union</a></p></div>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class Union(Object):
|
||
"""Represents a union applied to an object (usually a collection of objects).
|
||
See https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/CSG_Modelling#union
|
||
"""
|
||
|
||
def __init__(self, child: TUnion[Object, list]):
|
||
self.child = Collection.c(child)
|
||
|
||
def render(self) -> str:
|
||
"""Render the object into OpenSCAD code"""
|
||
return f"union(){{ {self.child.render()} }}"
|
||
|
||
def union(self, objects: TUnion[list, Object]) -> Object:
|
||
return self.__class__(self.child._add(objects))</code></pre>
|
||
</details>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></li>
|
||
</ul>
|
||
<h3>Methods</h3>
|
||
<dl>
|
||
<dt id="openscad_py.union.Union.color"><code class="name flex">
|
||
<span>def <span class="ident">color</span></span>(<span>self, r, g, b, a=1.0) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.color" href="object_.html#openscad_py.object_.Object.color">color</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a color and return a new object.
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color</a></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.delta_offset"><code class="name flex">
|
||
<span>def <span class="ident">delta_offset</span></span>(<span>self, delta, chamfer=False)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.delta_offset" href="object_.html#openscad_py.object_.Object.delta_offset">delta_offset</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Return a new 2D interior or exterior outline from an existing outline.
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset</a></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.diff"><code class="name flex">
|
||
<span>def <span class="ident">diff</span></span>(<span>self,<br>tool: list | ForwardRef('<a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a>')) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.diff" href="object_.html#openscad_py.object_.Object.diff">diff</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Remove from the object using a difference operator, and return a new object.
|
||
See …</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.extrude"><code class="name flex">
|
||
<span>def <span class="ident">extrude</span></span>(<span>self, height, convexity=10, center: bool = False) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.extrude" href="object_.html#openscad_py.object_.Object.extrude">extrude</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a linear extrusion and return a new object.
|
||
If <code>center</code> is false, the linear extrusion Z range is from 0 to height;
|
||
if it is true, the range is …</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.intersection"><code class="name flex">
|
||
<span>def <span class="ident">intersection</span></span>(<span>self,<br>objects: list | ForwardRef('<a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a>')) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.intersection" href="object_.html#openscad_py.object_.Object.intersection">intersection</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Get the intersection of self and an object of list of objects, and return a new object.
|
||
See …</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.move"><code class="name flex">
|
||
<span>def <span class="ident">move</span></span>(<span>self,<br>v: list | <a title="openscad_py.point.Point" href="point.html#openscad_py.point.Point">Point</a>) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.move" href="object_.html#openscad_py.object_.Object.move">move</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a translation and return a new object. Synonym of <code>translate()</code></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.radial_offset"><code class="name flex">
|
||
<span>def <span class="ident">radial_offset</span></span>(<span>self, r)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.radial_offset" href="object_.html#openscad_py.object_.Object.radial_offset">radial_offset</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Return a new 2D interior or exterior outline from an existing outline.
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#offset</a></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.render"><code class="name flex">
|
||
<span>def <span class="ident">render</span></span>(<span>self) ‑> str</span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.render" href="object_.html#openscad_py.object_.Object.render">render</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Render the object into OpenSCAD code</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.rotate"><code class="name flex">
|
||
<span>def <span class="ident">rotate</span></span>(<span>self,<br>a,<br>v: list | <a title="openscad_py.point.Point" href="point.html#openscad_py.point.Point">Point</a>) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.rotate" href="object_.html#openscad_py.object_.Object.rotate">rotate</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a rotation and return a new object.
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#rotate</a></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.rotate_extrude"><code class="name flex">
|
||
<span>def <span class="ident">rotate_extrude</span></span>(<span>self, angle, convexity=10) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.rotate_extrude" href="object_.html#openscad_py.object_.Object.rotate_extrude">rotate_extrude</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a rotational extrusion and return a new object. For all points x >= 0 must be true.
|
||
See …</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.scale"><code class="name flex">
|
||
<span>def <span class="ident">scale</span></span>(<span>self,<br>v: list | <a title="openscad_py.point.Point" href="point.html#openscad_py.point.Point">Point</a> | float) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.scale" href="object_.html#openscad_py.object_.Object.scale">scale</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply scaling and return a new object. Accepts a vector (a Point object or a list of floats)
|
||
or a single float for uniform scaling.
|
||
See …</p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.translate"><code class="name flex">
|
||
<span>def <span class="ident">translate</span></span>(<span>self,<br>v: list | <a title="openscad_py.point.Point" href="point.html#openscad_py.point.Point">Point</a>) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.translate" href="object_.html#openscad_py.object_.Object.translate">translate</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Apply a translation and return a new object.
|
||
See <a href="https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate">https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#translate</a></p></div>
|
||
</dd>
|
||
<dt id="openscad_py.union.Union.union"><code class="name flex">
|
||
<span>def <span class="ident">union</span></span>(<span>self,<br>objects: list | <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a>) ‑> <a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></span>
|
||
</code></dt>
|
||
<dd>
|
||
<p class="inheritance">
|
||
<em>Inherited from:</em>
|
||
<code><a title="openscad_py.object_.Object" href="object_.html#openscad_py.object_.Object">Object</a></code>.<code><a title="openscad_py.object_.Object.union" href="object_.html#openscad_py.object_.Object.union">union</a></code>
|
||
</p>
|
||
<div class="desc inherited"><p>Form the union of self and an object or list of objects, and return a new object.
|
||
See …</p></div>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</article>
|
||
<nav id="sidebar">
|
||
<div class="toc">
|
||
<ul></ul>
|
||
</div>
|
||
<ul id="index">
|
||
<li><h3>Super-module</h3>
|
||
<ul>
|
||
<li><code><a title="openscad_py" href="index.html">openscad_py</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li><h3><a href="#header-classes">Classes</a></h3>
|
||
<ul>
|
||
<li>
|
||
<h4><code><a title="openscad_py.union.Union" href="#openscad_py.union.Union">Union</a></code></h4>
|
||
<ul class="two-column">
|
||
<li><code><a title="openscad_py.union.Union.color" href="object_.html#openscad_py.union.Union.color">color</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.delta_offset" href="object_.html#openscad_py.union.Union.delta_offset">delta_offset</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.diff" href="object_.html#openscad_py.union.Union.diff">diff</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.extrude" href="object_.html#openscad_py.union.Union.extrude">extrude</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.intersection" href="object_.html#openscad_py.union.Union.intersection">intersection</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.move" href="object_.html#openscad_py.union.Union.move">move</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.radial_offset" href="object_.html#openscad_py.union.Union.radial_offset">radial_offset</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.render" href="#openscad_py.union.Union.render">render</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.rotate" href="object_.html#openscad_py.union.Union.rotate">rotate</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.rotate_extrude" href="object_.html#openscad_py.union.Union.rotate_extrude">rotate_extrude</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.scale" href="object_.html#openscad_py.union.Union.scale">scale</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.translate" href="object_.html#openscad_py.union.Union.translate">translate</a></code></li>
|
||
<li><code><a title="openscad_py.union.Union.union" href="#openscad_py.union.Union.union">union</a></code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</main>
|
||
<footer id="footer">
|
||
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.3</a>.</p>
|
||
</footer>
|
||
</body>
|
||
</html>
|