Skip to content

Commit c67f6a3

Browse files
mr-gltmr-glt
committed
Update docs — 2026-03-19 14:25
1 parent e183409 commit c67f6a3

17 files changed

Lines changed: 750 additions & 13 deletions

File tree

‎v2/.doctrees/environment.pickle‎

0 Bytes
Binary file not shown.

‎v2/.doctrees/python-api/pyvcad.doctree‎

0 Bytes
Binary file not shown.

‎v2/python-api/pyvcad.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1035,7 +1035,7 @@
10351035
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyvcad.Function.__init__" title="Link to this definition"></a></dt>
10361036
<dd><p>Overloaded function.</p>
10371037
<ol class="arabic simple">
1038-
<li><p>__init__(self: pyvcad.pyvcad.Function, function: str, material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x10da6c2b0&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x10da6c3b0&gt;) -&gt; None</p></li>
1038+
<li><p>__init__(self: pyvcad.pyvcad.Function, function: str, material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x132b42370&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x1309ce170&gt;) -&gt; None</p></li>
10391039
</ol>
10401040
<p>Constructor that takes a function to evaluate, a material, and bounding box.</p>
10411041
<dl class="field-list simple">
@@ -1054,7 +1054,7 @@
10541054
</pre></div>
10551055
</div>
10561056
<ol class="arabic simple" start="2">
1057-
<li><p>__init__(self: pyvcad.pyvcad.Function, function: collections.abc.Callable[[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat], float], material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x10da6fbb0&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x10d9df5f0&gt;) -&gt; None</p></li>
1057+
<li><p>__init__(self: pyvcad.pyvcad.Function, function: collections.abc.Callable[[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat], float], material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x131986f30&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x131986ff0&gt;) -&gt; None</p></li>
10581058
</ol>
10591059
<p>Constructor that takes a native python function to evaluate, a material id, and bounding box.</p>
10601060
<dl class="field-list simple">
@@ -2339,7 +2339,7 @@
23392339
</pre></div>
23402340
</div>
23412341
<ol class="arabic simple" start="2">
2342-
<li><p>__init__(self: pyvcad.pyvcad.Rotate, pitch: typing.SupportsFloat, yaw: typing.SupportsFloat, roll: typing.SupportsFloat, around: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x10be3c8f0&gt;) -&gt; None</p></li>
2342+
<li><p>__init__(self: pyvcad.pyvcad.Rotate, pitch: typing.SupportsFloat, yaw: typing.SupportsFloat, roll: typing.SupportsFloat, around: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x1279cdcb0&gt;) -&gt; None</p></li>
23432343
</ol>
23442344
<p>Constructor. Creates a Rotate with pitch, yaw, roll angles, and a point around which the rotation is performed.</p>
23452345
<dl class="field-list simple">

‎v2/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎v3-dev/.doctrees/environment.pickle‎

15 KB
Binary file not shown.

‎v3-dev/.doctrees/python-api/pyvcad.doctree‎

0 Bytes
Binary file not shown.

‎v3-dev/.doctrees/python-api/pyvcad_rendering.doctree‎

37.4 KB
Binary file not shown.

‎v3-dev/_modules/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@
8888
<h1>All modules for which code is available</h1>
8989
<ul><li><a href="pyvcad/pyvcad.html">pyvcad.pyvcad</a></li>
9090
<li><a href="pyvcad_compilers/pyvcad_compilers.html">pyvcad_compilers.pyvcad_compilers</a></li>
91+
<li><a href="pyvcad_rendering/export.html">pyvcad_rendering.export</a></li>
92+
<li><a href="pyvcad_rendering/render.html">pyvcad_rendering.render</a></li>
93+
<li><a href="pyvcad_rendering/sdf_visualization.html">pyvcad_rendering.sdf_visualization</a></li>
9194
<li><a href="pyvcad_rendering/vtk_export.html">pyvcad_rendering.vtk_export</a></li>
9295
</ul>
9396

‎v3-dev/_modules/pyvcad_rendering/export.html‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../../">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>pyvcad_rendering.export &mdash; OpenVCAD 3.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
11+
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=4ae1632d" />
12+
13+
14+
<script src="../../_static/jquery.js?v=5d32c60e"></script>
15+
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="../../_static/documentation_options.js?v=110ea713"></script>
17+
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
18+
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
19+
<script src="../../_static/js/theme.js"></script>
20+
<link rel="index" title="Index" href="../../genindex.html" />
21+
<link rel="search" title="Search" href="../../search.html" />
22+
</head>
23+
24+
<body class="wy-body-for-nav">
25+
<div class="wy-grid-for-nav">
26+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
27+
<div class="wy-side-scroll">
28+
<div class="wy-side-nav-search" >
29+
30+
31+
32+
<a href="../../index.html" class="icon icon-home">
33+
OpenVCAD
34+
</a>
35+
<div role="search">
36+
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
37+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
38+
<input type="hidden" name="check_keywords" value="yes" />
39+
<input type="hidden" name="area" value="default" />
40+
</form>
41+
</div>
42+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
43+
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
44+
<ul>
45+
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Installation</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../getting-started.html">Getting Started with OpenVCAD</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../../guides/math-expressions.html">Math Expression Documentation</a></li>
48+
</ul>
49+
<p class="caption" role="heading"><span class="caption-text">Python API Reference</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../../python-api/pyvcad.html">pyvcad Module</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../../python-api/pyvcad_compilers.html">pyvcad_compilers Module</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../../python-api/pyvcad_rendering.html">pyvcad_rendering Module</a></li>
54+
</ul>
55+
<p class="caption" role="heading"><span class="caption-text">C++ API Reference</span></p>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="../../cpp-api/index.html">C++ API Reference</a></li>
58+
</ul>
59+
<p class="caption" role="heading"><span class="caption-text">Project</span></p>
60+
<ul>
61+
<li class="toctree-l1"><a class="reference internal" href="../../gallery.html">Gallery</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="../../papers.html">Publications</a></li>
63+
</ul>
64+
65+
</div>
66+
</div>
67+
</nav>
68+
69+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
70+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
71+
<a href="../../index.html">OpenVCAD</a>
72+
</nav>
73+
74+
<div class="wy-nav-content">
75+
<div class="rst-content">
76+
<div role="navigation" aria-label="Page navigation">
77+
<ul class="wy-breadcrumbs">
78+
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
79+
<li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
80+
<li class="breadcrumb-item active">pyvcad_rendering.export</li>
81+
<li class="wy-breadcrumbs-aside">
82+
</li>
83+
</ul>
84+
<hr/>
85+
</div>
86+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
87+
<div itemprop="articleBody">
88+
89+
<h1>Source code for pyvcad_rendering.export</h1><div class="highlight"><pre>
90+
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">wx</span>
91+
92+
<div class="viewcode-block" id="export">
93+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.export">[docs]</a>
94+
<span class="k">def</span><span class="w"> </span><span class="nf">export</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
95+
<span class="n">app</span> <span class="o">=</span> <span class="n">wx</span><span class="o">.</span><span class="n">GetApp</span><span class="p">()</span> <span class="ow">or</span> <span class="n">wx</span><span class="o">.</span><span class="n">App</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
96+
<span class="n">wx</span><span class="o">.</span><span class="n">MessageBox</span><span class="p">(</span><span class="s2">&quot;The export feature is temporarily disabled on the attribute-modeling branch until compilers are ported.&quot;</span><span class="p">,</span> <span class="s2">&quot;Export Disabled&quot;</span><span class="p">,</span> <span class="n">wx</span><span class="o">.</span><span class="n">OK</span> <span class="o">|</span> <span class="n">wx</span><span class="o">.</span><span class="n">ICON_INFORMATION</span><span class="p">)</span></div>
97+
98+
99+
<div class="viewcode-block" id="Export">
100+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.Export">[docs]</a>
101+
<span class="k">def</span><span class="w"> </span><span class="nf">Export</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
102+
<span class="n">export</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
103+
104+
105+
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;export&quot;</span><span class="p">,</span> <span class="s2">&quot;Export&quot;</span><span class="p">]</span>
106+
</pre></div>
107+
108+
</div>
109+
</div>
110+
<footer>
111+
112+
<hr/>
113+
114+
<div role="contentinfo">
115+
<p>&#169; Copyright 2024, Charles Wade and Robert MacCurdy.</p>
116+
</div>
117+
118+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
119+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
120+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
121+
122+
123+
</footer>
124+
</div>
125+
</div>
126+
</section>
127+
</div>
128+
129+
130+
131+
132+
133+
<div class="version-picker" style="padding: 12px; margin-bottom: 12px;">
134+
<label for="version-select" style="font-weight: bold; display: block; margin-bottom: 4px; font-size: 0.85em; color: #999;">
135+
Version
136+
</label>
137+
<select id="version-select"
138+
onchange="if(this.value) window.location.href=this.value;"
139+
style="width: 100%; padding: 4px; border-radius: 4px; border: 1px solid #555; background: #333; color: #eee;">
140+
141+
<option value="../v2/index.html"
142+
>
143+
v2
144+
</option>
145+
146+
<option value="../v3-dev/index.html"
147+
selected>
148+
v3-dev
149+
</option>
150+
151+
</select>
152+
</div>
153+
<script>
154+
jQuery(function () {
155+
SphinxRtdTheme.Navigation.enable(true);
156+
});
157+
</script>
158+
159+
</body>
160+
</html>

0 commit comments

Comments
 (0)