216 lines
13 KiB
HTML
216 lines
13 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../../../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>kittycad.models.path_segment — kittycad v0.7.2 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d10597a4" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=fd3f3429" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/autoclasstoc.css?v=08871587" />
|
|
|
|
|
|
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="../../../_static/documentation_options.js?v=964918ec"></script>
|
|
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
|
|
<script src="../../../_static/copybutton.js?v=f281be69"></script>
|
|
<script src="../../../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home">
|
|
kittycad
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../index.html">kittycad</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
|
|
<li class="breadcrumb-item active">kittycad.models.path_segment</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for kittycad.models.path_segment</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Literal</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span><span class="p">,</span> <span class="n">ConfigDict</span><span class="p">,</span> <span class="n">Field</span><span class="p">,</span> <span class="n">RootModel</span>
|
|
<span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">Annotated</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">..models.angle</span> <span class="kn">import</span> <span class="n">Angle</span>
|
|
<span class="kn">from</span> <span class="nn">..models.length_unit</span> <span class="kn">import</span> <span class="n">LengthUnit</span>
|
|
<span class="kn">from</span> <span class="nn">..models.point2d</span> <span class="kn">import</span> <span class="n">Point2d</span>
|
|
<span class="kn">from</span> <span class="nn">..models.point3d</span> <span class="kn">import</span> <span class="n">Point3d</span>
|
|
|
|
|
|
<div class="viewcode-block" id="OptionLine">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.path_segment.OptionLine.html#kittycad.models.path_segment.OptionLine">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionLine</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A straight line segment. Goes from the current path \"pen\" to the given endpoint."""</span>
|
|
|
|
<span class="n">end</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">relative</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"line"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"line"</span>
|
|
|
|
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="OptionArc">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.path_segment.OptionArc.html#kittycad.models.path_segment.OptionArc">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionArc</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A circular arc segment. Arcs can be drawn clockwise when start > end."""</span>
|
|
|
|
<span class="n">center</span><span class="p">:</span> <span class="n">Point2d</span>
|
|
|
|
<span class="n">end</span><span class="p">:</span> <span class="n">Angle</span>
|
|
|
|
<span class="n">radius</span><span class="p">:</span> <span class="n">LengthUnit</span>
|
|
|
|
<span class="n">relative</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">start</span><span class="p">:</span> <span class="n">Angle</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"arc"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"arc"</span>
|
|
|
|
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="OptionBezier">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.path_segment.OptionBezier.html#kittycad.models.path_segment.OptionBezier">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionBezier</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A cubic bezier curve segment. Start at the end of the current line, go through control point 1 and 2, then end at a given point."""</span>
|
|
|
|
<span class="n">control1</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">control2</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">end</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">relative</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"bezier"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"bezier"</span>
|
|
|
|
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="OptionTangentialArc">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.path_segment.OptionTangentialArc.html#kittycad.models.path_segment.OptionTangentialArc">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionTangentialArc</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Adds a tangent arc from current pen position with the given radius and angle."""</span>
|
|
|
|
<span class="n">offset</span><span class="p">:</span> <span class="n">Angle</span>
|
|
|
|
<span class="n">radius</span><span class="p">:</span> <span class="n">LengthUnit</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"tangential_arc"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"tangential_arc"</span>
|
|
|
|
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="OptionTangentialArcTo">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.path_segment.OptionTangentialArcTo.html#kittycad.models.path_segment.OptionTangentialArcTo">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionTangentialArcTo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Adds a tangent arc from current pen position to the new position. Arcs will choose a clockwise or counter-clockwise direction based on the arc end position."""</span>
|
|
|
|
<span class="n">angle_snap_increment</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Angle</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">to</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"tangential_arc_to"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"tangential_arc_to"</span>
|
|
|
|
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
|
|
|
|
|
|
|
|
<span class="n">PathSegment</span> <span class="o">=</span> <span class="n">RootModel</span><span class="p">[</span>
|
|
<span class="n">Annotated</span><span class="p">[</span>
|
|
<span class="n">Union</span><span class="p">[</span>
|
|
<span class="n">OptionLine</span><span class="p">,</span>
|
|
<span class="n">OptionArc</span><span class="p">,</span>
|
|
<span class="n">OptionBezier</span><span class="p">,</span>
|
|
<span class="n">OptionTangentialArc</span><span class="p">,</span>
|
|
<span class="n">OptionTangentialArcTo</span><span class="p">,</span>
|
|
<span class="p">],</span>
|
|
<span class="n">Field</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2024, KittyCAD Team Members.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |