Skip to content

Commit e183409

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

33 files changed

Lines changed: 921 additions & 27 deletions

‎.gitattributes‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
*.png filter=lfs diff=lfs merge=lfs -text
2+
*.stl filter=lfs diff=lfs merge=lfs -text
3+
*.3mf filter=lfs diff=lfs merge=lfs -text
4+
*.3MF filter=lfs diff=lfs merge=lfs -text
5+
*.STL filter=lfs diff=lfs merge=lfs -text
6+
*.obj filter=lfs diff=lfs merge=lfs -text
7+
*.vdb filter=lfs diff=lfs merge=lfs -text
8+
*.VDB filter=lfs diff=lfs merge=lfs -text
9+
*.igs filter=lfs diff=lfs merge=lfs -text
10+
*.iges filter=lfs diff=lfs merge=lfs -text
11+
*.step filter=lfs diff=lfs merge=lfs -text
12+
*.stp filter=lfs diff=lfs merge=lfs -text
13+
*.dcm filter=lfs diff=lfs merge=lfs -text
14+
*.DCM filter=lfs diff=lfs merge=lfs -text
15+
*.icc filter=lfs diff=lfs merge=lfs -text
16+
*.ICC filter=lfs diff=lfs merge=lfs -text
17+
*.zip filter=lfs diff=lfs merge=lfs -text
18+
*.ZIP filter=lfs diff=lfs merge=lfs -text
19+
*.7z filter=lfs diff=lfs merge=lfs -text
20+
*.7Z filter=lfs diff=lfs merge=lfs -text

‎v2/.doctrees/environment.pickle‎

3.59 KB
Binary file not shown.

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

0 Bytes
Binary file not shown.

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

5.91 KB
Binary file not shown.

‎v2/_modules/index.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@
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>
9193
</ul>
9294

9395
</div>

‎v2/_modules/pyvcad_rendering/export.html‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
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 2.3 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=57236720"></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+
<span class="kn">from</span><span class="w"> </span><span class="nn">.export_frame</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExportFrame</span>
93+
94+
<div class="viewcode-block" id="export">
95+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.export">[docs]</a>
96+
<span class="k">def</span><span class="w"> </span><span class="nf">export</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">):</span>
97+
<span class="n">app</span> <span class="o">=</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>
98+
<span class="n">app</span><span class="o">.</span><span class="n">frame</span> <span class="o">=</span> <span class="n">ExportFrame</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">)</span>
99+
<span class="n">app</span><span class="o">.</span><span class="n">MainLoop</span><span class="p">()</span></div>
100+
101+
102+
<div class="viewcode-block" id="Export">
103+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.Export">[docs]</a>
104+
<span class="k">def</span><span class="w"> </span><span class="nf">Export</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">):</span>
105+
<span class="n">export</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">)</span></div>
106+
107+
108+
<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>
109+
110+
</pre></div>
111+
112+
</div>
113+
</div>
114+
<footer>
115+
116+
<hr/>
117+
118+
<div role="contentinfo">
119+
<p>&#169; Copyright 2024, Charles Wade and Robert MacCurdy.</p>
120+
</div>
121+
122+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
123+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
124+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
125+
126+
127+
</footer>
128+
</div>
129+
</div>
130+
</section>
131+
</div>
132+
133+
134+
135+
136+
137+
<div class="version-picker" style="padding: 12px; margin-bottom: 12px;">
138+
<label for="version-select" style="font-weight: bold; display: block; margin-bottom: 4px; font-size: 0.85em; color: #999;">
139+
Version
140+
</label>
141+
<select id="version-select"
142+
onchange="if(this.value) window.location.href=this.value;"
143+
style="width: 100%; padding: 4px; border-radius: 4px; border: 1px solid #555; background: #333; color: #eee;">
144+
145+
<option value="../v2/index.html"
146+
selected>
147+
v2
148+
</option>
149+
150+
<option value="../v3-dev/index.html"
151+
>
152+
v3-dev
153+
</option>
154+
155+
</select>
156+
</div>
157+
<script>
158+
jQuery(function () {
159+
SphinxRtdTheme.Navigation.enable(true);
160+
});
161+
</script>
162+
163+
</body>
164+
</html>

‎v2/_modules/pyvcad_rendering/render.html‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
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.render &mdash; OpenVCAD 2.3 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=57236720"></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.render</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.render</h1><div class="highlight"><pre>
90+
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
91+
<span class="kn">import</span><span class="w"> </span><span class="nn">wx</span>
92+
93+
<span class="kn">from</span><span class="w"> </span><span class="nn">.render_frame</span><span class="w"> </span><span class="kn">import</span> <span class="n">RenderFrame</span>
94+
95+
<div class="viewcode-block" id="render">
96+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.render">[docs]</a>
97+
<span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">):</span>
98+
<span class="n">app</span> <span class="o">=</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>
99+
<span class="n">app</span><span class="o">.</span><span class="n">frame</span> <span class="o">=</span> <span class="n">RenderFrame</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">)</span>
100+
<span class="n">app</span><span class="o">.</span><span class="n">MainLoop</span><span class="p">()</span></div>
101+
102+
103+
<div class="viewcode-block" id="Render">
104+
<a class="viewcode-back" href="../../python-api/pyvcad_rendering.html#pyvcad_rendering.Render">[docs]</a>
105+
<span class="k">def</span><span class="w"> </span><span class="nf">Render</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">):</span>
106+
<span class="n">render</span><span class="p">(</span><span class="n">vcad_object</span><span class="p">,</span> <span class="n">materials</span><span class="p">)</span></div>
107+
108+
109+
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;render&quot;</span><span class="p">,</span> <span class="s2">&quot;Render&quot;</span><span class="p">]</span>
110+
</pre></div>
111+
112+
</div>
113+
</div>
114+
<footer>
115+
116+
<hr/>
117+
118+
<div role="contentinfo">
119+
<p>&#169; Copyright 2024, Charles Wade and Robert MacCurdy.</p>
120+
</div>
121+
122+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
123+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
124+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
125+
126+
127+
</footer>
128+
</div>
129+
</div>
130+
</section>
131+
</div>
132+
133+
134+
135+
136+
137+
<div class="version-picker" style="padding: 12px; margin-bottom: 12px;">
138+
<label for="version-select" style="font-weight: bold; display: block; margin-bottom: 4px; font-size: 0.85em; color: #999;">
139+
Version
140+
</label>
141+
<select id="version-select"
142+
onchange="if(this.value) window.location.href=this.value;"
143+
style="width: 100%; padding: 4px; border-radius: 4px; border: 1px solid #555; background: #333; color: #eee;">
144+
145+
<option value="../v2/index.html"
146+
selected>
147+
v2
148+
</option>
149+
150+
<option value="../v3-dev/index.html"
151+
>
152+
v3-dev
153+
</option>
154+
155+
</select>
156+
</div>
157+
<script>
158+
jQuery(function () {
159+
SphinxRtdTheme.Navigation.enable(true);
160+
});
161+
</script>
162+
163+
</body>
164+
</html>

‎v2/_static/file.png‎

-158 Bytes
Loading

‎v2/_static/minus.png‎

37 Bytes
Loading

‎v2/_static/plus.png‎

37 Bytes
Loading

0 commit comments

Comments
 (0)