ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cf7e20536c87cfd3f8708ecd3850f6244803ba76
kittycad.py/docs/html/_modules/kittycad/models/output_format.html
github-actions[bot] fd5580b061 I HAVE GENERATED YOUR NEW DOCS!
2025-01-07 02:19:42 +00:00

230 lines
14 KiB
HTML
Raw Blame History

<!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.output_format &mdash; kittycad v0.7.4 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=f9b80c38"></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.output_format</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.output_format</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">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.fbx_storage</span> <span class="kn">import</span> <span class="n">FbxStorage</span>
<span class="kn">from</span> <span class="nn">..models.gltf_presentation</span> <span class="kn">import</span> <span class="n">GltfPresentation</span>
<span class="kn">from</span> <span class="nn">..models.gltf_storage</span> <span class="kn">import</span> <span class="n">GltfStorage</span>
<span class="kn">from</span> <span class="nn">..models.ply_storage</span> <span class="kn">import</span> <span class="n">PlyStorage</span>
<span class="kn">from</span> <span class="nn">..models.selection</span> <span class="kn">import</span> <span class="n">Selection</span>
<span class="kn">from</span> <span class="nn">..models.stl_storage</span> <span class="kn">import</span> <span class="n">StlStorage</span>
<span class="kn">from</span> <span class="nn">..models.system</span> <span class="kn">import</span> <span class="n">System</span>
<span class="kn">from</span> <span class="nn">..models.unit_length</span> <span class="kn">import</span> <span class="n">UnitLength</span>
<div class="viewcode-block" id="OptionFbx">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionFbx.html#kittycad.models.output_format.OptionFbx">[docs]</a>
<span class="k">class</span> <span class="nc">OptionFbx</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Autodesk Filmbox (FBX) format.&quot;&quot;&quot;</span>
<span class="n">storage</span><span class="p">:</span> <span class="n">FbxStorage</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;fbx&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;fbx&quot;</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="OptionGltf">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionGltf.html#kittycad.models.output_format.OptionGltf">[docs]</a>
<span class="k">class</span> <span class="nc">OptionGltf</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;glTF 2.0. We refer to this as glTF since that is how our customers refer to it, although by default it will be in binary format and thus technically (glb). If you prefer ASCII output, you can set that option for the export.&quot;&quot;&quot;</span>
<span class="n">presentation</span><span class="p">:</span> <span class="n">GltfPresentation</span>
<span class="n">storage</span><span class="p">:</span> <span class="n">GltfStorage</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;gltf&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;gltf&quot;</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="OptionObj">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionObj.html#kittycad.models.output_format.OptionObj">[docs]</a>
<span class="k">class</span> <span class="nc">OptionObj</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Wavefront OBJ format.&quot;&quot;&quot;</span>
<span class="n">coords</span><span class="p">:</span> <span class="n">System</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;obj&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;obj&quot;</span>
<span class="n">units</span><span class="p">:</span> <span class="n">UnitLength</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="OptionPly">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionPly.html#kittycad.models.output_format.OptionPly">[docs]</a>
<span class="k">class</span> <span class="nc">OptionPly</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The PLY Polygon File Format.&quot;&quot;&quot;</span>
<span class="n">coords</span><span class="p">:</span> <span class="n">System</span>
<span class="n">selection</span><span class="p">:</span> <span class="n">Selection</span>
<span class="n">storage</span><span class="p">:</span> <span class="n">PlyStorage</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;ply&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;ply&quot;</span>
<span class="n">units</span><span class="p">:</span> <span class="n">UnitLength</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="OptionStep">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionStep.html#kittycad.models.output_format.OptionStep">[docs]</a>
<span class="k">class</span> <span class="nc">OptionStep</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;ISO 10303-21 (STEP) format.&quot;&quot;&quot;</span>
<span class="n">coords</span><span class="p">:</span> <span class="n">System</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;step&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;step&quot;</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="OptionStl">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.output_format.OptionStl.html#kittycad.models.output_format.OptionStl">[docs]</a>
<span class="k">class</span> <span class="nc">OptionStl</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;*ST**ereo**L**ithography format.&quot;&quot;&quot;</span>
<span class="n">coords</span><span class="p">:</span> <span class="n">System</span>
<span class="n">selection</span><span class="p">:</span> <span class="n">Selection</span>
<span class="n">storage</span><span class="p">:</span> <span class="n">StlStorage</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;stl&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;stl&quot;</span>
<span class="n">units</span><span class="p">:</span> <span class="n">UnitLength</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">OutputFormat</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">OptionFbx</span><span class="p">,</span>
<span class="n">OptionGltf</span><span class="p">,</span>
<span class="n">OptionObj</span><span class="p">,</span>
<span class="n">OptionPly</span><span class="p">,</span>
<span class="n">OptionStep</span><span class="p">,</span>
<span class="n">OptionStl</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">&quot;type&quot;</span><span class="p">),</span>
<span class="p">]</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, 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>
Reference in New Issue View Git Blame Copy Permalink