Skip to content

Commit f0c75b9

Browse files
committed
Update docs — 2026-03-28 10:59
1 parent 2850b83 commit f0c75b9

97 files changed

Lines changed: 1648 additions & 477 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
38.5 KB
Binary file not shown.

v2/.doctrees/environment.pickle

32.5 KB
Binary file not shown.
6.17 KB
Binary file not shown.
0 Bytes
Binary file not shown.

v2/cpp-api/libvcad-tree-composition.html

Lines changed: 100 additions & 3 deletions
Large diffs are not rendered by default.

v2/genindex.html

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -524,9 +524,11 @@ <h2 id="B">B</h2>
524524
</ul></li>
525525
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion8addChildENSt10shared_ptrI4NodeEE">BBoxUnion::addChild (C++ function)</a>
526526
</li>
527-
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionENSt6vectorINSt10shared_ptrI4NodeEEEE">BBoxUnion::BBoxUnion (C++ function)</a>, <a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionEv">[1]</a>
527+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionERKNSt6vectorINSt10shared_ptrI4NodeEEEE">BBoxUnion::BBoxUnion (C++ function)</a>, <a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionEd">[1]</a>, <a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionEdRKNSt6vectorINSt10shared_ptrI4NodeEEEE">[2]</a>, <a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion9BBoxUnionEv">[3]</a>
528528
</li>
529529
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion12bounding_boxEv">BBoxUnion::bounding_box (C++ function)</a>
530+
</li>
531+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion24cache_child_bounding_boxERKNSt10shared_ptrI4NodeEE">BBoxUnion::cache_child_bounding_box (C++ function)</a>
530532
</li>
531533
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion5cloneEv">BBoxUnion::clone (C++ function)</a>
532534
</li>
@@ -535,15 +537,39 @@ <h2 id="B">B</h2>
535537
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion8evaluateEddd">BBoxUnion::evaluate (C++ function)</a>
536538
</li>
537539
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion11m_aabb_treeE">BBoxUnion::m_aabb_tree (C++ member)</a>
540+
</li>
541+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion22m_child_bounding_boxesE">BBoxUnion::m_child_bounding_boxes (C++ member)</a>
542+
</li>
543+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion10m_smooth_kE">BBoxUnion::m_smooth_k (C++ member)</a>
538544
</li>
539545
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion13material_listEv">BBoxUnion::material_list (C++ function)</a>
546+
</li>
547+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion14sharp_evaluateEddd">BBoxUnion::sharp_evaluate (C++ function)</a>
548+
</li>
549+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion21SharpEvaluationResultE">BBoxUnion::SharpEvaluationResult (C++ struct)</a>
550+
</li>
551+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion21SharpEvaluationResult8min_nodeE">BBoxUnion::SharpEvaluationResult::min_node (C++ member)</a>
552+
</li>
553+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion21SharpEvaluationResult9min_valueE">BBoxUnion::SharpEvaluationResult::min_value (C++ member)</a>
554+
</li>
555+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion15smooth_evaluateEddd">BBoxUnion::smooth_evaluate (C++ function)</a>
556+
</li>
557+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion22SmoothEvaluationResultE">BBoxUnion::SmoothEvaluationResult (C++ struct)</a>
558+
</li>
559+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion22SmoothEvaluationResult8min_nodeE">BBoxUnion::SmoothEvaluationResult::min_node (C++ member)</a>
560+
</li>
561+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion22SmoothEvaluationResult9min_valueE">BBoxUnion::SmoothEvaluationResult::min_value (C++ member)</a>
562+
</li>
563+
<li><a href="cpp-api/libvcad-tree-composition.html#_CPPv4N9BBoxUnion22SmoothEvaluationResult12smooth_valueE">BBoxUnion::SmoothEvaluationResult::smooth_value (C++ member)</a>
540564
</li>
541565
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv46Binary">Binary (C++ class)</a>
542566

543567
<ul>
544568
<li><a href="python-api/pyvcad/tree.html#pyvcad.Binary">(class in pyvcad)</a>
545569
</li>
546570
</ul></li>
571+
</ul></td>
572+
<td style="width: 33%; vertical-align: top;"><ul>
547573
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv4N6Binary6BinaryERKNSt10shared_ptrI4NodeEERKNSt10shared_ptrI4NodeEE">Binary::Binary (C++ function)</a>, <a href="cpp-api/libvcad-tree-core.html#_CPPv4N6Binary6BinaryEv">[1]</a>
548574
</li>
549575
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv4NK6Binary9leftChildEv">Binary::leftChild (C++ function)</a>
@@ -556,8 +582,6 @@ <h2 id="B">B</h2>
556582
</li>
557583
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv4NK6Binary10rightChildEv">Binary::rightChild (C++ function)</a>
558584
</li>
559-
</ul></td>
560-
<td style="width: 33%; vertical-align: top;"><ul>
561585
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv4N6Binary12setLeftChildENSt10shared_ptrI4NodeEE">Binary::setLeftChild (C++ function)</a>
562586
</li>
563587
<li><a href="cpp-api/libvcad-tree-core.html#_CPPv4N6Binary13setRightChildENSt10shared_ptrI4NodeEE">Binary::setRightChild (C++ function)</a>

v2/objects.inv

478 Bytes
Binary file not shown.

v2/python-api/pyvcad/composition.html

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ <h1>Tree — composition nodes<a class="headerlink" href="#tree-composition-node
406406
</pre></div>
407407
</div>
408408
<ol class="arabic simple" start="2">
409-
<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 0x106f14330&gt;) -&gt; None</p></li>
409+
<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 0x108da3bf0&gt;) -&gt; None</p></li>
410410
</ol>
411411
<p>Constructor. Creates a Rotate with pitch, yaw, roll angles, and a point around which the rotation is performed.</p>
412412
<dl class="field-list simple">
@@ -993,7 +993,7 @@ <h1>Tree — composition nodes<a class="headerlink" href="#tree-composition-node
993993
<dl class="py class">
994994
<dt class="sig sig-object py" id="pyvcad.BBoxUnion">
995995
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">pyvcad.</span></span><span class="sig-name descname"><span class="pre">BBoxUnion</span></span><a class="headerlink" href="#pyvcad.BBoxUnion" title="Link to this definition">#</a></dt>
996-
<dd><p>An n-ary node that represents the union of bounding boxes.</p>
996+
<dd><p>An n-ary node that accelerates union queries with child bounding boxes. Supports optional smooth blending when k &gt; 0.</p>
997997
<dl class="py method">
998998
<dt class="sig sig-object py" id="pyvcad.BBoxUnion.__init__">
999999
<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.BBoxUnion.__init__" title="Link to this definition">#</a></dt>
@@ -1003,7 +1003,8 @@ <h1>Tree — composition nodes<a class="headerlink" href="#tree-composition-node
10031003
</ol>
10041004
<p>Default constructor for BBoxUnion.</p>
10051005
<p class="rubric">Example</p>
1006-
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">union_node</span> <span class="o">=</span> <span class="n">pv</span><span class="o">.</span><span class="n">BBoxUnion</span><span class="p">()</span>
1006+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">libvcad</span><span class="w"> </span><span class="kn">import</span> <span class="n">pyvcad</span> <span class="k">as</span> <span class="n">pv</span>
1007+
<span class="gp">&gt;&gt;&gt; </span><span class="n">union_node</span> <span class="o">=</span> <span class="n">pv</span><span class="o">.</span><span class="n">BBoxUnion</span><span class="p">()</span>
10071008
</pre></div>
10081009
</div>
10091010
<ol class="arabic simple" start="2">
@@ -1016,10 +1017,43 @@ <h1>Tree — composition nodes<a class="headerlink" href="#tree-composition-node
10161017
</dd>
10171018
</dl>
10181019
<p class="rubric">Example</p>
1019-
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">children</span> <span class="o">=</span> <span class="p">[</span><span class="n">child1</span><span class="p">,</span> <span class="n">child2</span><span class="p">]</span>
1020+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">libvcad</span><span class="w"> </span><span class="kn">import</span> <span class="n">pyvcad</span> <span class="k">as</span> <span class="n">pv</span>
1021+
<span class="gp">&gt;&gt;&gt; </span><span class="n">children</span> <span class="o">=</span> <span class="p">[</span><span class="n">child1</span><span class="p">,</span> <span class="n">child2</span><span class="p">]</span>
10201022
<span class="gp">&gt;&gt;&gt; </span><span class="n">union_node</span> <span class="o">=</span> <span class="n">pv</span><span class="o">.</span><span class="n">BBoxUnion</span><span class="p">(</span><span class="n">children</span><span class="p">)</span>
10211023
</pre></div>
10221024
</div>
1025+
<ol class="arabic simple" start="3">
1026+
<li><p>__init__(self: pyvcad.pyvcad.BBoxUnion, k: typing.SupportsFloat) -&gt; None</p></li>
1027+
</ol>
1028+
<p>Constructor for smooth BBoxUnion.</p>
1029+
<dl class="field-list simple">
1030+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1031+
<dd class="field-odd"><p><strong>k</strong> (<em>float</em>) – The smoothing radius. When k &gt; 0, enables smooth union behavior.</p>
1032+
</dd>
1033+
</dl>
1034+
<p class="rubric">Example</p>
1035+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">libvcad</span><span class="w"> </span><span class="kn">import</span> <span class="n">pyvcad</span> <span class="k">as</span> <span class="n">pv</span>
1036+
<span class="gp">&gt;&gt;&gt; </span><span class="n">union_node</span> <span class="o">=</span> <span class="n">pv</span><span class="o">.</span><span class="n">BBoxUnion</span><span class="p">(</span><span class="mf">1.0</span><span class="p">)</span>
1037+
</pre></div>
1038+
</div>
1039+
<ol class="arabic simple" start="4">
1040+
<li><p>__init__(self: pyvcad.pyvcad.BBoxUnion, k: typing.SupportsFloat, children: collections.abc.Sequence[pyvcad.pyvcad.Node]) -&gt; None</p></li>
1041+
</ol>
1042+
<p>Constructor for smooth BBoxUnion with children.</p>
1043+
<dl class="field-list simple">
1044+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1045+
<dd class="field-odd"><ul class="simple">
1046+
<li><p><strong>k</strong> (<em>float</em>) – The smoothing radius. When k &gt; 0, enables smooth union behavior.</p></li>
1047+
<li><p><strong>children</strong> (<em>list</em><em> of </em><a class="reference internal" href="tree.html#pyvcad.Node" title="pyvcad.Node"><em>Node</em></a>) – The list of child nodes.</p></li>
1048+
</ul>
1049+
</dd>
1050+
</dl>
1051+
<p class="rubric">Example</p>
1052+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">libvcad</span><span class="w"> </span><span class="kn">import</span> <span class="n">pyvcad</span> <span class="k">as</span> <span class="n">pv</span>
1053+
<span class="gp">&gt;&gt;&gt; </span><span class="n">children</span> <span class="o">=</span> <span class="p">[</span><span class="n">child1</span><span class="p">,</span> <span class="n">child2</span><span class="p">]</span>
1054+
<span class="gp">&gt;&gt;&gt; </span><span class="n">union_node</span> <span class="o">=</span> <span class="n">pv</span><span class="o">.</span><span class="n">BBoxUnion</span><span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">children</span><span class="p">)</span>
1055+
</pre></div>
1056+
</div>
10231057
</dd></dl>
10241058

10251059
</dd></dl>

v2/python-api/pyvcad/leaves.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ <h1>Tree — leaf nodes<a class="headerlink" href="#tree-leaf-nodes" title="Link
395395
<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>
396396
<dd><p>Overloaded function.</p>
397397
<ol class="arabic simple">
398-
<li><p>__init__(self: pyvcad.pyvcad.Function, function: str, material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x106ecbe70&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x106ecbe30&gt;) -&gt; None</p></li>
398+
<li><p>__init__(self: pyvcad.pyvcad.Function, function: str, material: typing.SupportsInt = 1, min: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x108d90130&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x108d900f0&gt;) -&gt; None</p></li>
399399
</ol>
400400
<p>Constructor that takes a function to evaluate, a material, and bounding box.</p>
401401
<dl class="field-list simple">
@@ -414,7 +414,7 @@ <h1>Tree — leaf nodes<a class="headerlink" href="#tree-leaf-nodes" title="Link
414414
</pre></div>
415415
</div>
416416
<ol class="arabic simple" start="2">
417-
<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 0x100c9a8f0&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x106ecba30&gt;) -&gt; None</p></li>
417+
<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 0x108d5e830&gt;, max: pyvcad.pyvcad.Vec3 = &lt;pyvcad.pyvcad.Vec3 object at 0x108d5e8f0&gt;) -&gt; None</p></li>
418418
</ol>
419419
<p>Constructor that takes a native python function to evaluate, a material id, and bounding box.</p>
420420
<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.

0 commit comments

Comments
 (0)